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.10.0\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-04-12 20:14+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-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-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-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1087 ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100 ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135 ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165 ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177 ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668 ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778 ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027 ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395 ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412 ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885 ../src/guestfs.pod:2889 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620 ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628 ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859 ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868 ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
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:1280 ../src/guestfs.pod:1411 ../src/guestfs.pod:2440
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:1284 ../src/guestfs.pod:1415 ../src/guestfs.pod:2465
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:1421
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:765
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1279 "L</guestfs_inspect_get_drive_mappings>)"
1283 #: ../src/guestfs.pod:647
1285 "Dealing with separator characters (backslash vs forward slash) is outside "
1286 "the scope of libguestfs, but usually a simple character replacement will "
1291 #: ../src/guestfs.pod:651
1293 "To resolve the case insensitivity of paths, call "
1294 "L</guestfs_case_sensitive_path>."
1298 #: ../src/guestfs.pod:654
1299 msgid "ACCESSING THE WINDOWS REGISTRY"
1303 #: ../src/guestfs.pod:656
1305 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1306 "files, through the library C<hivex> which is part of the libguestfs project "
1307 "although ships as a separate tarball. You have to locate and download the "
1308 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1309 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1310 "L<virt-win-reg(1)> for more help on this issue."
1314 #: ../src/guestfs.pod:664
1315 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1319 #: ../src/guestfs.pod:666
1321 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1322 "provide something which looks like a Linux symlink. The way it tries to do "
1323 "the rewriting is described here:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1332 #: ../src/guestfs.pod:672
1334 "The essential problem is that ntfs-3g simply does not have enough "
1335 "information to do a correct job. NTFS links can contain drive letters and "
1336 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1337 "It is almost certainly the case that libguestfs callers should ignore what "
1338 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1342 #: ../src/guestfs.pod:679
1344 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1345 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1346 "attribute, and read the raw reparse data from that (you can find the format "
1347 "documented in various places around the web)."
1351 #: ../src/guestfs.pod:684
1352 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1356 #: ../src/guestfs.pod:686
1358 "There are other useful extended attributes that can be read from ntfs-3g "
1359 "filesystems (using L</guestfs_getxattr>). See:"
1363 #: ../src/guestfs.pod:689
1364 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1368 #: ../src/guestfs.pod:691
1369 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1373 #: ../src/guestfs.pod:693
1375 "Although we don't want to discourage you from using the C API, we will "
1376 "mention here that the same API is also available in other languages."
1380 #: ../src/guestfs.pod:696
1382 "The API is broadly identical in all supported languages. This means that "
1383 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1384 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1385 "OCaml. In other words, a straightforward, predictable isomorphism between "
1390 #: ../src/guestfs.pod:702
1392 "Error messages are automatically transformed into exceptions if the language "
1397 #: ../src/guestfs.pod:705
1399 "We don't try to \"object orientify\" parts of the API in OO languages, "
1400 "although contributors are welcome to write higher level APIs above what we "
1401 "provide in their favourite languages if they wish."
1405 #: ../src/guestfs.pod:711
1410 #: ../src/guestfs.pod:713
1412 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1413 "identical to the C API. C++ classes and exceptions are not used."
1417 #: ../src/guestfs.pod:717
1422 #: ../src/guestfs.pod:719
1424 "The C# bindings are highly experimental. Please read the warnings at the "
1425 "top of C<csharp/Libguestfs.cs>."
1429 #: ../src/guestfs.pod:722
1434 #: ../src/guestfs.pod:724
1436 "This is the only language binding that is working but incomplete. Only "
1437 "calls which return simple integers have been bound in Haskell, and we are "
1438 "looking for help to complete this binding."
1442 #: ../src/guestfs.pod:728
1447 #: ../src/guestfs.pod:730
1449 "Full documentation is contained in the Javadoc which is distributed with "
1454 #: ../src/guestfs.pod:733
1459 #: ../src/guestfs.pod:735
1460 msgid "See L<guestfs-ocaml(3)>."
1464 #: ../src/guestfs.pod:737
1469 #: ../src/guestfs.pod:739
1470 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1474 #: ../src/guestfs.pod:741
1479 #: ../src/guestfs.pod:743
1481 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1482 "the php-libguestfs package for your distribution."
1486 #: ../src/guestfs.pod:746
1487 msgid "The PHP binding only works correctly on 64 bit machines."
1491 #: ../src/guestfs.pod:748
1496 #: ../src/guestfs.pod:750
1497 msgid "See L<guestfs-python(3)>."
1501 #: ../src/guestfs.pod:752
1506 #: ../src/guestfs.pod:754
1507 msgid "See L<guestfs-ruby(3)>."
1511 #: ../src/guestfs.pod:756
1512 msgid "B<shell scripts>"
1516 #: ../src/guestfs.pod:758
1517 msgid "See L<guestfish(1)>."
1521 #: ../src/guestfs.pod:762
1522 msgid "LIBGUESTFS GOTCHAS"
1526 #: ../src/guestfs.pod:764
1528 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1529 "system [...] that works in the way it is documented but is counterintuitive "
1530 "and almost invites mistakes.\""
1534 #: ../src/guestfs.pod:768
1536 "Since we developed libguestfs and the associated tools, there are several "
1537 "things we would have designed differently, but are now stuck with for "
1538 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1539 "release, you can expect these to change. Beware of them."
1543 #: ../src/guestfs.pod:776
1544 msgid "Autosync / forgetting to sync."
1548 #: ../src/guestfs.pod:778
1550 "When modifying a filesystem from C or another language, you B<must> unmount "
1551 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1552 "libguestfs handle. You can also call:"
1556 #: ../src/guestfs.pod:782
1559 " guestfs_set_autosync (g, 1);\n"
1564 #: ../src/guestfs.pod:784
1566 "to have the unmount/sync done automatically for you when the handle 'g' is "
1567 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1572 #: ../src/guestfs.pod:788
1574 "If you forget to do this, then it is entirely possible that your changes "
1575 "won't be written out, or will be partially written, or (very rarely) that "
1576 "you'll get disk corruption."
1580 #: ../src/guestfs.pod:792
1582 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1583 "guestfish scripts that forget to sync will work just fine, which can make "
1584 "this very puzzling if you are trying to debug a problem."
1588 #: ../src/guestfs.pod:796
1590 "Update: Autosync is enabled by default for all API users starting from "
1591 "libguestfs 1.5.24."
1595 #: ../src/guestfs.pod:799
1596 msgid "Mount option C<-o sync> should not be the default."
1600 #: ../src/guestfs.pod:801
1602 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1603 "However C<-o sync> does not add any reliability benefit, but does have a "
1604 "very large performance impact."
1608 #: ../src/guestfs.pod:805
1610 "The work around is to use L</guestfs_mount_options> and set the mount "
1611 "options that you actually want to use."
1615 #: ../src/guestfs.pod:808
1616 msgid "Read-only should be the default."
1620 #: ../src/guestfs.pod:810
1622 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1623 "specify I<--rw> if you want to make changes to the image."
1627 #: ../src/guestfs.pod:813
1628 msgid "This would reduce the potential to corrupt live VM images."
1632 #: ../src/guestfs.pod:815
1634 "Note that many filesystems change the disk when you just mount and unmount, "
1635 "even if you didn't perform any writes. You need to use "
1636 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1640 #: ../src/guestfs.pod:819
1641 msgid "guestfish command line is hard to use."
1645 #: ../src/guestfs.pod:821
1647 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1648 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1649 "exist, so it fails. In earlier versions of guestfish the error message was "
1650 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1651 "we should have used C<guestfish -c command> to run commands."
1655 #: ../src/guestfs.pod:828
1656 msgid "guestfish megabyte modifiers don't work right on all commands"
1660 #: ../src/guestfs.pod:830
1662 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1663 "other modifiers). What guestfish actually does is to multiply the number "
1664 "part by the modifier part and pass the result to the C API. However this "
1665 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1666 "expecting some other unit (eg. megabytes)."
1670 #: ../src/guestfs.pod:837
1671 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1675 #: ../src/guestfs.pod:839
1678 " lvcreate LV VG 100M\n"
1683 #: ../src/guestfs.pod:841
1685 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1686 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1687 "megabytes * megabytes) logical volume. The error message you get from this "
1688 "is also a little obscure."
1692 #: ../src/guestfs.pod:846
1694 "This could be fixed in the generator by specially marking parameters and "
1695 "return values which take bytes or other units."
1699 #: ../src/guestfs.pod:849
1700 msgid "Ambiguity between devices and paths"
1704 #: ../src/guestfs.pod:851
1706 "There is a subtle ambiguity in the API between a device name "
1707 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1708 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1712 #: ../src/guestfs.pod:856
1714 "In the current API we usually resolve this ambiguity by having two separate "
1715 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1716 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1717 "detecting if the path supplied begins with C</dev/>."
1721 #: ../src/guestfs.pod:862
1723 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1724 "make paths/devices into structured names. One way to do this would be to "
1725 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1726 "aspect of grub. Another way would be to use a structured type, equivalent "
1727 "to this OCaml type:"
1731 #: ../src/guestfs.pod:868
1734 " type path = Path of string | Device of int | Partition of int * int\n"
1739 #: ../src/guestfs.pod:870
1740 msgid "which would allow you to pass arguments like:"
1744 #: ../src/guestfs.pod:872
1747 " Path \"/foo/bar\"\n"
1748 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1749 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1750 " Path \"/dev/sdb2\" (* not a device *)\n"
1755 #: ../src/guestfs.pod:877
1757 "As you can see there are still problems to resolve even with this "
1758 "representation. Also consider how it might work in guestfish."
1762 #: ../src/guestfs.pod:882
1763 msgid "PROTOCOL LIMITS"
1767 #: ../src/guestfs.pod:884
1769 "Internally libguestfs uses a message-based protocol to pass API calls and "
1770 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1771 "plenty more detail about this). The maximum message size used by the "
1772 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1773 "aware of this limit. The API calls which may be affected are individually "
1774 "documented, with a link back to this section of the documentation."
1778 #: ../src/guestfs.pod:892
1780 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1781 "a simple string. Because this string is at some point internally encoded as "
1782 "a message, the maximum size that it can return is slightly under 4 MB. If "
1783 "the requested file is larger than this then you will get an error."
1787 #: ../src/guestfs.pod:898
1789 "In order to transfer large files into and out of the guest filesystem, you "
1790 "need to use particular calls that support this. The sections L</UPLOADING> "
1791 "and L</DOWNLOADING> document how to do this."
1795 #: ../src/guestfs.pod:902
1797 "You might also consider mounting the disk image using our FUSE filesystem "
1798 "support (L<guestmount(1)>)."
1802 #: ../src/guestfs.pod:905
1803 msgid "KEYS AND PASSPHRASES"
1807 #: ../src/guestfs.pod:907
1809 "Certain libguestfs calls take a parameter that contains sensitive key "
1810 "material, passed in as a C string."
1814 #: ../src/guestfs.pod:910
1816 "In the future we would hope to change the libguestfs implementation so that "
1817 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1818 "swap. However this is I<not> done at the moment, because of the complexity "
1819 "of such an implementation."
1823 #: ../src/guestfs.pod:915
1825 "Therefore you should be aware that any key parameter you pass to libguestfs "
1826 "might end up being written out to the swap partition. If this is a concern, "
1827 "scrub the swap partition or don't use libguestfs on encrypted devices."
1831 #: ../src/guestfs.pod:920
1832 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1836 #: ../src/guestfs.pod:922
1838 "All high-level libguestfs actions are synchronous. If you want to use "
1839 "libguestfs asynchronously then you must create a thread."
1843 #: ../src/guestfs.pod:925
1845 "Only use the handle from a single thread. Either use the handle exclusively "
1846 "from one thread, or provide your own mutex so that two threads cannot issue "
1847 "calls on the same handle at the same time."
1851 #: ../src/guestfs.pod:929
1853 "See the graphical program guestfs-browser for one possible architecture for "
1854 "multithreaded programs using libvirt and libguestfs."
1858 #: ../src/guestfs.pod:932
1863 #: ../src/guestfs.pod:934
1865 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1870 #: ../src/guestfs.pod:937
1872 "By default it looks for these in the directory C<$libdir/guestfs> "
1873 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1877 #: ../src/guestfs.pod:940
1879 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1880 "to change the directories that libguestfs will search in. The value is a "
1881 "colon-separated list of paths. The current directory is I<not> searched "
1882 "unless the path contains an empty element or C<.>. For example "
1883 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1884 "then C</usr/lib/guestfs>."
1888 #: ../src/guestfs.pod:947
1889 msgid "QEMU WRAPPERS"
1893 #: ../src/guestfs.pod:949
1895 "If you want to compile your own qemu, run qemu from a non-standard location, "
1896 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1901 #: ../src/guestfs.pod:953
1903 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1904 "last command in the shell script (so that qemu replaces the shell and "
1905 "becomes the direct child of the libguestfs-using program). If you don't do "
1906 "this, then the qemu process won't be cleaned up correctly."
1910 #: ../src/guestfs.pod:958
1912 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1917 #: ../src/guestfs.pod:961
1921 " qemudir=/home/rjones/d/qemu\n"
1922 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1928 #: ../src/guestfs.pod:965
1930 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1931 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1936 #: ../src/guestfs.pod:969
1939 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1944 #: ../src/guestfs.pod:971
1946 "Note that libguestfs also calls qemu with the -help and -version options in "
1947 "order to determine features."
1951 #: ../src/guestfs.pod:974
1952 msgid "ATTACHING TO RUNNING DAEMONS"
1956 #: ../src/guestfs.pod:976
1958 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1959 "babies. Use with caution."
1963 #: ../src/guestfs.pod:979
1965 "I<Note (2):> This section explains how to attach to a running daemon from a "
1966 "low level perspective. For most users, simply using virt tools such as "
1967 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1971 #: ../src/guestfs.pod:983
1972 msgid "Using guestfs_set_attach_method"
1976 #: ../src/guestfs.pod:985
1978 "By calling L</guestfs_set_attach_method> you can change how the library "
1979 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1980 "L</ARCHITECTURE> for some background)."
1984 #: ../src/guestfs.pod:989
1986 "The normal attach method is C<appliance>, where a small appliance is created "
1987 "containing the daemon, and then the library connects to this."
1991 #: ../src/guestfs.pod:992
1993 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1994 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1995 "daemon over the Unix domain socket."
1999 #: ../src/guestfs.pod:996
2001 "The normal use for this is to connect to a running virtual machine that "
2002 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2003 "files inside the live virtual machine."
2007 #: ../src/guestfs.pod:1000
2008 msgid "Using guestfs_add_domain with live flag"
2012 #: ../src/guestfs.pod:1002
2014 "L</guestfs_add_domain> provides some help for getting the correct attach "
2015 "method. If you pass the C<live> option to this function, then (if the "
2016 "virtual machine is running) it will examine the libvirt XML looking for a "
2017 "virtio-serial channel to connect to:"
2021 #: ../src/guestfs.pod:1008
2028 " <channel type='unix'>\n"
2029 " <source mode='bind' path='/path/to/socket'/>\n"
2030 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2039 #: ../src/guestfs.pod:1020
2041 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2042 "method to C<unix:/path/to/socket>."
2046 #: ../src/guestfs.pod:1023
2048 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2049 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2050 "to attach to and modify live virtual machines."
2054 #: ../src/guestfs.pod:1027
2056 "The virtual machine needs to have been set up beforehand so that it has the "
2057 "virtio-serial channel and so that guestfsd is running inside it."
2061 #: ../src/guestfs.pod:1031
2062 msgid "ABI GUARANTEE"
2066 #: ../src/guestfs.pod:1033
2068 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2069 "actions as outlined in this section. Although we will deprecate some "
2070 "actions, for example if they get replaced by newer calls, we will keep the "
2071 "old actions forever. This allows you the developer to program in confidence "
2072 "against the libguestfs API."
2076 #: ../src/guestfs.pod:1039
2077 msgid "BLOCK DEVICE NAMING"
2081 #: ../src/guestfs.pod:1041
2083 "In the kernel there is now quite a profusion of schemata for naming block "
2084 "devices (in this context, by I<block device> I mean a physical or virtual "
2085 "hard drive). The original Linux IDE driver used names starting with "
2086 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2087 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2088 "replacement for the old IDE driver (particularly for SATA devices) those "
2089 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2090 "machines with paravirtualized drivers. This has created several different "
2091 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2096 #: ../src/guestfs.pod:1053
2098 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2099 "Linux kernel to access block devices. We can run a variety of appliances "
2100 "based on a variety of Linux kernels."
2104 #: ../src/guestfs.pod:1057
2106 "This causes a problem for libguestfs because many API calls use device or "
2107 "partition names. Working scripts and the recipe (example) scripts that we "
2108 "make available over the internet could fail if the naming scheme changes."
2112 #: ../src/guestfs.pod:1062
2114 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2115 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2116 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2117 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2121 #: ../src/guestfs.pod:1068
2123 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2124 "L</guestfs_list_partitions> and similar calls return the true names of the "
2125 "devices and partitions as known to the appliance."
2129 #: ../src/guestfs.pod:1073
2130 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2134 #: ../src/guestfs.pod:1075
2136 "Usually this translation is transparent. However in some (very rare) cases "
2137 "you may need to know the exact algorithm. Such cases include where you use "
2138 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2139 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2144 #: ../src/guestfs.pod:1081
2146 "The algorithm is applied only to I<parameters> which are known to be either "
2147 "device or partition names. Return values from functions such as "
2148 "L</guestfs_list_devices> are never changed."
2152 #: ../src/guestfs.pod:1089
2153 msgid "Is the string a parameter which is a device or partition name?"
2157 #: ../src/guestfs.pod:1093
2158 msgid "Does the string begin with C</dev/sd>?"
2162 #: ../src/guestfs.pod:1097
2164 "Does the named device exist? If so, we use that device. However if I<not> "
2165 "then we continue with this algorithm."
2169 #: ../src/guestfs.pod:1102
2170 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2174 #: ../src/guestfs.pod:1104
2175 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2179 #: ../src/guestfs.pod:1106
2180 msgid "If that named device exists, use it. If not, continue."
2184 #: ../src/guestfs.pod:1110
2185 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2189 #: ../src/guestfs.pod:1112
2190 msgid "If that named device exists, use it. If not, return an error."
2194 #: ../src/guestfs.pod:1116
2195 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2199 #: ../src/guestfs.pod:1118
2201 "Although the standard naming scheme and automatic translation is useful for "
2202 "simple programs and guestfish scripts, for larger programs it is best not to "
2203 "rely on this mechanism."
2207 #: ../src/guestfs.pod:1122
2209 "Where possible for maximum future portability programs using libguestfs "
2210 "should use these future-proof techniques:"
2214 #: ../src/guestfs.pod:1129
2216 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2217 "device names, and then use those names directly."
2221 #: ../src/guestfs.pod:1132
2222 msgid "Since those device names exist by definition, they will never be translated."
2226 #: ../src/guestfs.pod:1137
2228 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2229 "filesystem labels."
2233 #: ../src/guestfs.pod:1142
2238 #: ../src/guestfs.pod:1144
2240 "This section discusses security implications of using libguestfs, "
2241 "particularly with untrusted or malicious guests or disk images."
2245 #: ../src/guestfs.pod:1147
2246 msgid "GENERAL SECURITY CONSIDERATIONS"
2250 #: ../src/guestfs.pod:1149
2252 "Be careful with any files or data that you download from a guest (by "
2253 "\"download\" we mean not just the L</guestfs_download> command but any "
2254 "command that reads files, filenames, directories or anything else from a "
2255 "disk image). An attacker could manipulate the data to fool your program "
2256 "into doing the wrong thing. Consider cases such as:"
2260 #: ../src/guestfs.pod:1159
2261 msgid "the data (file etc) not being present"
2265 #: ../src/guestfs.pod:1163
2266 msgid "being present but empty"
2270 #: ../src/guestfs.pod:1167
2271 msgid "being much larger than normal"
2275 #: ../src/guestfs.pod:1171
2276 msgid "containing arbitrary 8 bit data"
2280 #: ../src/guestfs.pod:1175
2281 msgid "being in an unexpected character encoding"
2285 #: ../src/guestfs.pod:1179
2286 msgid "containing homoglyphs."
2290 #: ../src/guestfs.pod:1183
2291 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2295 #: ../src/guestfs.pod:1185
2297 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2298 "(VFS) module can sometimes be escalated into exploits by deliberately "
2299 "creating a malicious, malformed filesystem. These exploits are very severe "
2300 "for two reasons. Firstly there are very many filesystem drivers in the "
2301 "kernel, and many of them are infrequently used and not much developer "
2302 "attention has been paid to the code. Linux userspace helps potential "
2303 "crackers by detecting the filesystem type and automatically choosing the "
2304 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2305 "the administrator. Secondly, a kernel-level exploit is like a local root "
2306 "exploit (worse in some ways), giving immediate and total access to the "
2307 "system right down to the hardware level."
2311 #: ../src/guestfs.pod:1198
2313 "That explains why you should never mount a filesystem from an untrusted "
2314 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2315 "inside a qemu virtual machine, usually running as a non-root user. The "
2316 "attacker would need to write a filesystem which first exploited the kernel, "
2317 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2318 "the libguestfs protocol, and finally to be as serious as the host kernel "
2319 "exploit it would need to escalate its privileges to root. This multi-step "
2320 "escalation, performed by a static piece of data, is thought to be extremely "
2321 "hard to do, although we never say 'never' about security issues."
2325 #: ../src/guestfs.pod:1209
2327 "In any case callers can reduce the attack surface by forcing the filesystem "
2328 "type when mounting (use L</guestfs_mount_vfs>)."
2332 #: ../src/guestfs.pod:1212
2333 msgid "PROTOCOL SECURITY"
2337 #: ../src/guestfs.pod:1214
2339 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2340 "defined upper message size. However a program that uses libguestfs must "
2341 "also take care - for example you can write a program that downloads a binary "
2342 "from a disk image and executes it locally, and no amount of protocol "
2343 "security will save you from the consequences."
2347 #: ../src/guestfs.pod:1220
2348 msgid "INSPECTION SECURITY"
2352 #: ../src/guestfs.pod:1222
2354 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2355 "directly from the guest, and these could contain any 8 bit data. Callers "
2356 "should be careful to escape these before printing them to a structured file "
2357 "(for example, use HTML escaping if creating a web page)."
2361 #: ../src/guestfs.pod:1228
2363 "Guest configuration may be altered in unusual ways by the administrator of "
2364 "the virtual machine, and may not reflect reality (particularly for untrusted "
2365 "or actively malicious guests). For example we parse the hostname from "
2366 "configuration files like C</etc/sysconfig/network> that we find in the "
2367 "guest, but the guest administrator can easily manipulate these files to "
2368 "provide the wrong hostname."
2372 #: ../src/guestfs.pod:1236
2374 "The inspection API parses guest configuration using two external libraries: "
2375 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2376 "designed to be robust in the face of malicious data, although denial of "
2377 "service attacks are still possible, for example with oversized configuration "
2382 #: ../src/guestfs.pod:1242
2383 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2387 #: ../src/guestfs.pod:1244
2389 "Be very cautious about running commands from the guest. By running a "
2390 "command in the guest, you are giving CPU time to a binary that you do not "
2391 "control, under the same user account as the library, albeit wrapped in qemu "
2392 "virtualization. More information and alternatives can be found in the "
2393 "section L</RUNNING COMMANDS>."
2397 #: ../src/guestfs.pod:1250
2398 msgid "CVE-2010-3851"
2402 #: ../src/guestfs.pod:1252
2403 msgid "https://bugzilla.redhat.com/642934"
2407 #: ../src/guestfs.pod:1254
2409 "This security bug concerns the automatic disk format detection that qemu "
2410 "does on disk images."
2414 #: ../src/guestfs.pod:1257
2416 "A raw disk image is just the raw bytes, there is no header. Other disk "
2417 "images like qcow2 contain a special header. Qemu deals with this by looking "
2418 "for one of the known headers, and if none is found then assuming the disk "
2419 "image must be raw."
2423 #: ../src/guestfs.pod:1262
2425 "This allows a guest which has been given a raw disk image to write some "
2426 "other header. At next boot (or when the disk image is accessed by "
2427 "libguestfs) qemu would do autodetection and think the disk image format was, "
2428 "say, qcow2 based on the header written by the guest."
2432 #: ../src/guestfs.pod:1267
2434 "This in itself would not be a problem, but qcow2 offers many features, one "
2435 "of which is to allow a disk image to refer to another image (called the "
2436 "\"backing disk\"). It does this by placing the path to the backing disk "
2437 "into the qcow2 header. This path is not validated and could point to any "
2438 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2439 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2440 "control of the attacker."
2444 #: ../src/guestfs.pod:1275
2445 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2449 #: ../src/guestfs.pod:1282
2450 msgid "You have enabled the network or have opened the disk in write mode."
2454 #: ../src/guestfs.pod:1286
2456 "You are also running untrusted code from the guest (see L</RUNNING "
2461 #: ../src/guestfs.pod:1291
2463 "The way to avoid this is to specify the expected disk format when adding "
2464 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2465 "should always do this if the disk is raw format, and it's a good idea for "
2470 #: ../src/guestfs.pod:1296
2472 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2473 "format is fetched from libvirt and passed through."
2477 #: ../src/guestfs.pod:1299
2479 "For libguestfs tools, use the I<--format> command line parameter as "
2484 #: ../src/guestfs.pod:1302
2485 msgid "CONNECTION MANAGEMENT"
2489 #: ../src/guestfs.pod:1304
2494 #: ../src/guestfs.pod:1306
2496 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2497 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2498 "handle and release all resources used."
2502 #: ../src/guestfs.pod:1310
2504 "For information on using multiple handles and threads, see the section "
2505 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2509 #: ../src/guestfs.pod:1313
2510 msgid "guestfs_create"
2514 #: ../src/guestfs.pod:1315
2517 " guestfs_h *guestfs_create (void);\n"
2522 #: ../src/guestfs.pod:1317
2523 msgid "Create a connection handle."
2527 #: ../src/guestfs.pod:1319
2529 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2530 "on the handle at least once."
2534 #: ../src/guestfs.pod:1322
2536 "This function returns a non-NULL pointer to a handle on success or NULL on "
2541 #: ../src/guestfs.pod:1325
2542 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2546 #: ../src/guestfs.pod:1327
2548 "You may also want to configure error handling for the handle. See L</ERROR "
2549 "HANDLING> section below."
2553 #: ../src/guestfs.pod:1330
2554 msgid "guestfs_close"
2558 #: ../src/guestfs.pod:1332
2561 " void guestfs_close (guestfs_h *g);\n"
2566 #: ../src/guestfs.pod:1334
2567 msgid "This closes the connection handle and frees up all resources used."
2571 #: ../src/guestfs.pod:1336
2572 msgid "ERROR HANDLING"
2576 #: ../src/guestfs.pod:1338
2578 "API functions can return errors. For example, almost all functions that "
2579 "return C<int> will return C<-1> to indicate an error."
2583 #: ../src/guestfs.pod:1341
2585 "Additional information is available for errors: an error message string and "
2586 "optionally an error number (errno) if the thing that failed was a system "
2591 #: ../src/guestfs.pod:1345
2593 "You can get at the additional information about the last error on the handle "
2594 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2595 "up an error handler with L</guestfs_set_error_handler>."
2599 #: ../src/guestfs.pod:1350
2601 "When the handle is created, a default error handler is installed which "
2602 "prints the error message string to C<stderr>. For small short-running "
2603 "command line programs it is sufficient to do:"
2607 #: ../src/guestfs.pod:1354
2610 " if (guestfs_launch (g) == -1)\n"
2611 " exit (EXIT_FAILURE);\n"
2616 #: ../src/guestfs.pod:1357
2618 "since the default error handler will ensure that an error message has been "
2619 "printed to C<stderr> before the program exits."
2623 #: ../src/guestfs.pod:1360
2625 "For other programs the caller will almost certainly want to install an "
2626 "alternate error handler or do error handling in-line like this:"
2630 #: ../src/guestfs.pod:1363
2633 " g = guestfs_create ();\n"
2638 #: ../src/guestfs.pod:1365
2641 " /* This disables the default behaviour of printing errors\n"
2643 " guestfs_set_error_handler (g, NULL, NULL);\n"
2648 #: ../src/guestfs.pod:1369
2651 " if (guestfs_launch (g) == -1) {\n"
2652 " /* Examine the error message and print it etc. */\n"
2653 " char *msg = guestfs_last_error (g);\n"
2654 " int errnum = guestfs_last_errno (g);\n"
2655 " fprintf (stderr, \"%s\\n\", msg);\n"
2662 #: ../src/guestfs.pod:1377
2664 "Out of memory errors are handled differently. The default action is to call "
2665 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2666 "L</guestfs_set_out_of_memory_handler>."
2670 #: ../src/guestfs.pod:1381
2672 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2673 "because there is no handle if this happens there is no way to get additional "
2674 "error information. However L</guestfs_create> is supposed to be a "
2675 "lightweight operation which can only fail because of insufficient memory (it "
2676 "returns NULL in this case)."
2680 #: ../src/guestfs.pod:1387
2681 msgid "guestfs_last_error"
2685 #: ../src/guestfs.pod:1389
2688 " const char *guestfs_last_error (guestfs_h *g);\n"
2693 #: ../src/guestfs.pod:1391
2695 "This returns the last error message that happened on C<g>. If there has not "
2696 "been an error since the handle was created, then this returns C<NULL>."
2700 #: ../src/guestfs.pod:1395
2702 "The lifetime of the returned string is until the next error occurs, or "
2703 "L</guestfs_close> is called."
2707 #: ../src/guestfs.pod:1398
2708 msgid "guestfs_last_errno"
2712 #: ../src/guestfs.pod:1400
2715 " int guestfs_last_errno (guestfs_h *g);\n"
2720 #: ../src/guestfs.pod:1402
2721 msgid "This returns the last error number (errno) that happened on C<g>."
2725 #: ../src/guestfs.pod:1404
2726 msgid "If successful, an errno integer not equal to zero is returned."
2730 #: ../src/guestfs.pod:1406
2731 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2735 #: ../src/guestfs.pod:1413
2736 msgid "There has not been any error on the handle."
2740 #: ../src/guestfs.pod:1417
2742 "There has been an error but the errno was meaningless. This corresponds to "
2743 "the case where the error did not come from a failed system call, but for "
2744 "some other reason."
2748 #: ../src/guestfs.pod:1423
2750 "There was an error from a failed system call, but for some reason the errno "
2751 "was not captured and returned. This usually indicates a bug in libguestfs."
2755 #: ../src/guestfs.pod:1429
2757 "Libguestfs tries to convert the errno from inside the applicance into a "
2758 "corresponding errno for the caller (not entirely trivial: the appliance "
2759 "might be running a completely different operating system from the library "
2760 "and error numbers are not standardized across Un*xen). If this could not be "
2761 "done, then the error is translated to C<EINVAL>. In practice this should "
2762 "only happen in very rare circumstances."
2766 #: ../src/guestfs.pod:1437
2767 msgid "guestfs_set_error_handler"
2771 #: ../src/guestfs.pod:1439
2774 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2776 " const char *msg);\n"
2777 " void guestfs_set_error_handler (guestfs_h *g,\n"
2778 " guestfs_error_handler_cb cb,\n"
2784 #: ../src/guestfs.pod:1446
2786 "The callback C<cb> will be called if there is an error. The parameters "
2787 "passed to the callback are an opaque data pointer and the error message "
2792 #: ../src/guestfs.pod:1450
2794 "C<errno> is not passed to the callback. To get that the callback must call "
2795 "L</guestfs_last_errno>."
2799 #: ../src/guestfs.pod:1453
2801 "Note that the message string C<msg> is freed as soon as the callback "
2802 "function returns, so if you want to stash it somewhere you must make your "
2807 #: ../src/guestfs.pod:1457
2808 msgid "The default handler prints messages on C<stderr>."
2812 #: ../src/guestfs.pod:1459
2813 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2817 #: ../src/guestfs.pod:1461
2818 msgid "guestfs_get_error_handler"
2822 #: ../src/guestfs.pod:1463
2825 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2826 " void **opaque_rtn);\n"
2831 #: ../src/guestfs.pod:1466
2832 msgid "Returns the current error handler callback."
2836 #: ../src/guestfs.pod:1468
2837 msgid "guestfs_set_out_of_memory_handler"
2841 #: ../src/guestfs.pod:1470
2844 " typedef void (*guestfs_abort_cb) (void);\n"
2845 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2846 " guestfs_abort_cb);\n"
2851 #: ../src/guestfs.pod:1474
2853 "The callback C<cb> will be called if there is an out of memory situation. "
2854 "I<Note this callback must not return>."
2858 #: ../src/guestfs.pod:1477
2859 msgid "The default is to call L<abort(3)>."
2863 #: ../src/guestfs.pod:1479
2864 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2868 #: ../src/guestfs.pod:1482
2869 msgid "guestfs_get_out_of_memory_handler"
2873 #: ../src/guestfs.pod:1484
2876 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2881 #: ../src/guestfs.pod:1486
2882 msgid "This returns the current out of memory handler."
2886 #: ../src/guestfs.pod:1488
2891 #: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008
2896 #: ../src/guestfs.pod:1492
2901 #: ../src/guestfs.pod:1494
2906 #: ../src/guestfs.pod:1496
2907 msgid "AVAILABILITY"
2911 #: ../src/guestfs.pod:1498
2912 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2916 #: ../src/guestfs.pod:1500
2918 "Using L</guestfs_available> you can test availability of the following "
2919 "groups of functions. This test queries the appliance to see if the "
2920 "appliance you are currently using supports the functionality."
2924 #: ../src/guestfs.pod:1505
2925 msgid "@AVAILABILITY@"
2929 #: ../src/guestfs.pod:1507
2930 msgid "GUESTFISH supported COMMAND"
2934 #: ../src/guestfs.pod:1509
2936 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2937 "prints out the available groups and whether they are supported by this build "
2938 "of libguestfs. Note however that you have to do C<run> first."
2942 #: ../src/guestfs.pod:1514
2943 msgid "SINGLE CALLS AT COMPILE TIME"
2947 #: ../src/guestfs.pod:1516
2949 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2950 "function, such as:"
2954 #: ../src/guestfs.pod:1519
2957 " #define LIBGUESTFS_HAVE_DD 1\n"
2962 #: ../src/guestfs.pod:1521
2963 msgid "if L</guestfs_dd> is available."
2967 #: ../src/guestfs.pod:1523
2969 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2970 "function is available at compile time, we recommended using build tools such "
2971 "as autoconf or cmake. For example in autotools you could use:"
2975 #: ../src/guestfs.pod:1528
2978 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2979 " AC_CHECK_FUNCS([guestfs_dd])\n"
2984 #: ../src/guestfs.pod:1531
2986 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2991 #: ../src/guestfs.pod:1534
2992 msgid "SINGLE CALLS AT RUN TIME"
2996 #: ../src/guestfs.pod:1536
2998 "Testing at compile time doesn't guarantee that a function really exists in "
2999 "the library. The reason is that you might be dynamically linked against a "
3000 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3001 "This situation unfortunately results in a segmentation fault, which is a "
3002 "shortcoming of the C dynamic linking system itself."
3006 #: ../src/guestfs.pod:1543
3008 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3009 "in this example program (note that you still need the compile time check as "
3014 #: ../src/guestfs.pod:1547
3017 " #include <stdio.h>\n"
3018 " #include <stdlib.h>\n"
3019 " #include <unistd.h>\n"
3020 " #include <dlfcn.h>\n"
3021 " #include <guestfs.h>\n"
3026 #: ../src/guestfs.pod:1553
3031 " #ifdef LIBGUESTFS_HAVE_DD\n"
3033 " int has_function;\n"
3038 #: ../src/guestfs.pod:1559
3041 " /* Test if the function guestfs_dd is really available. */\n"
3042 " dl = dlopen (NULL, RTLD_LAZY);\n"
3044 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3045 " exit (EXIT_FAILURE);\n"
3047 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3053 #: ../src/guestfs.pod:1568
3056 " if (!has_function)\n"
3057 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3059 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3060 " /* Now it's safe to call\n"
3061 " guestfs_dd (g, \"foo\", \"bar\");\n"
3065 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3072 #: ../src/guestfs.pod:1581
3074 "You may think the above is an awful lot of hassle, and it is. There are "
3075 "other ways outside of the C linking system to ensure that this kind of "
3076 "incompatibility never arises, such as using package versioning:"
3080 #: ../src/guestfs.pod:1586
3083 " Requires: libguestfs >= 1.0.80\n"
3088 #: ../src/guestfs.pod:1588
3089 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3093 #: ../src/guestfs.pod:1590
3095 "A recent feature of the API is the introduction of calls which take optional "
3096 "arguments. In C these are declared 3 ways. The main way is as a call which "
3097 "takes variable arguments (ie. C<...>), as in this example:"
3101 #: ../src/guestfs.pod:1595
3104 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3109 #: ../src/guestfs.pod:1597
3111 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3112 "call with no optional arguments specified:"
3116 #: ../src/guestfs.pod:1600
3119 " guestfs_add_drive_opts (g, filename, -1);\n"
3124 #: ../src/guestfs.pod:1602
3125 msgid "With a single optional argument:"
3129 #: ../src/guestfs.pod:1604
3132 " guestfs_add_drive_opts (g, filename,\n"
3133 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3139 #: ../src/guestfs.pod:1608
3144 #: ../src/guestfs.pod:1610
3147 " guestfs_add_drive_opts (g, filename,\n"
3148 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3149 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3155 #: ../src/guestfs.pod:1615
3157 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3162 #: ../src/guestfs.pod:1618
3163 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3167 #: ../src/guestfs.pod:1620
3169 "The second variant has the same name with the suffix C<_va>, which works the "
3170 "same way but takes a C<va_list>. See the C manual for details. For the "
3171 "example function, this is declared:"
3175 #: ../src/guestfs.pod:1624
3178 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3184 #: ../src/guestfs.pod:1627
3185 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3189 #: ../src/guestfs.pod:1629
3191 "The third variant is useful where you need to construct these calls. You "
3192 "pass in a structure where you fill in the optional fields. The structure "
3193 "has a bitmask as the first element which you must set to indicate which "
3194 "fields you have filled in. For our example function the structure and call "
3199 #: ../src/guestfs.pod:1635
3202 " struct guestfs_add_drive_opts_argv {\n"
3203 " uint64_t bitmask;\n"
3205 " const char *format;\n"
3208 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3209 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3214 #: ../src/guestfs.pod:1644
3215 msgid "You could call it like this:"
3219 #: ../src/guestfs.pod:1646
3222 " struct guestfs_add_drive_opts_argv optargs = {\n"
3223 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3224 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3226 " .format = \"qcow2\"\n"
3232 #: ../src/guestfs.pod:1653
3235 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3240 #: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3245 #: ../src/guestfs.pod:1661
3246 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3250 #: ../src/guestfs.pod:1666
3251 msgid "You do not need to fill in all fields of the structure."
3255 #: ../src/guestfs.pod:1670
3257 "There must be a one-to-one correspondence between fields of the structure "
3258 "that are filled in, and bits set in the bitmask."
3262 #: ../src/guestfs.pod:1675
3263 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3267 #: ../src/guestfs.pod:1677
3269 "In other languages, optional arguments are expressed in the way that is "
3270 "natural for that language. We refer you to the language-specific "
3271 "documentation for more details on that."
3275 #: ../src/guestfs.pod:1681
3276 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3280 #: ../src/guestfs.pod:1683
3281 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3285 #: ../src/guestfs.pod:1685
3287 "B<Note:> This section documents the generic event mechanism introduced in "
3288 "libguestfs 1.10, which you should use in new code if possible. The old "
3289 "functions C<guestfs_set_log_message_callback>, "
3290 "C<guestfs_set_subprocess_quit_callback>, "
3291 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3292 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3297 #: ../src/guestfs.pod:1693
3299 "Handles generate events when certain things happen, such as log messages "
3300 "being generated, progress messages during long-running operations, or the "
3301 "handle being closed. The API calls described below let you register a "
3302 "callback to be called when events happen. You can register multiple "
3303 "callbacks (for the same, different or overlapping sets of events), and "
3304 "individually remove callbacks. If callbacks are not removed, then they "
3305 "remain in force until the handle is closed."
3309 #: ../src/guestfs.pod:1701
3311 "In the current implementation, events are only generated synchronously: that "
3312 "means that events (and hence callbacks) can only happen while you are in the "
3313 "middle of making another libguestfs call. The callback is called in the "
3318 #: ../src/guestfs.pod:1706
3320 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3321 "unsigned integers, or a message buffer. Payloads are discussed later on."
3325 #: ../src/guestfs.pod:1710
3326 msgid "CLASSES OF EVENTS"
3330 #: ../src/guestfs.pod:1714
3331 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3335 #: ../src/guestfs.pod:1717
3337 "The callback function will be called while the handle is being closed "
3338 "(synchronously from L</guestfs_close>)."
3342 #: ../src/guestfs.pod:1720
3344 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3345 "handles that are open when the program exits. This means that this callback "
3346 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3347 "problems in higher-level languages (eg. if your HLL interpreter has already "
3348 "been cleaned up by the time this is called, and if your callback then jumps "
3349 "into some HLL function)."
3353 #: ../src/guestfs.pod:1727
3355 "If no callback is registered: the handle is closed without any callback "
3360 #: ../src/guestfs.pod:1730
3361 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3365 #: ../src/guestfs.pod:1733
3367 "The callback function will be called when the child process quits, either "
3368 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3369 "corresponds to a transition from any state to the CONFIG state)."
3373 #: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746
3374 msgid "If no callback is registered: the event is ignored."
3378 #: ../src/guestfs.pod:1739
3379 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3383 #: ../src/guestfs.pod:1742
3385 "The callback function will be called when the child process becomes ready "
3386 "first time after it has been launched. (This corresponds to a transition "
3387 "from LAUNCHING to the READY state)."
3391 #: ../src/guestfs.pod:1748
3392 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3396 #: ../src/guestfs.pod:1751
3398 "Some long-running operations can generate progress messages. If this "
3399 "callback is registered, then it will be called each time a progress message "
3400 "is generated (usually two seconds after the operation started, and three "
3401 "times per second thereafter until it completes, although the frequency may "
3402 "change in future versions)."
3406 #: ../src/guestfs.pod:1757
3408 "The callback receives in the payload four unsigned 64 bit numbers which are "
3409 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3413 #: ../src/guestfs.pod:1760
3415 "The units of C<total> are not defined, although for some operations C<total> "
3416 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3417 "or megabytes), and C<position> may be the portion which has been "
3422 #: ../src/guestfs.pod:1765
3423 msgid "The only defined and stable parts of the API are:"
3427 #: ../src/guestfs.pod:1771
3429 "The callback can display to the user some type of progress bar or indicator "
3430 "which shows the ratio of C<position>:C<total>."
3434 #: ../src/guestfs.pod:1776
3435 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3439 #: ../src/guestfs.pod:1780
3441 "If any progress notification is sent during a call, then a final progress "
3442 "notification is always sent when C<position> = C<total> (I<unless> the call "
3443 "fails with an error)."
3447 #: ../src/guestfs.pod:1784
3449 "This is to simplify caller code, so callers can easily set the progress "
3450 "indicator to \"100%\" at the end of the operation, without requiring special "
3451 "code to detect this case."
3455 #: ../src/guestfs.pod:1790
3457 "For some calls we are unable to estimate the progress of the call, but we "
3458 "can still generate progress messages to indicate activity. This is known as "
3459 "\"pulse mode\", and is directly supported by certain progress bar "
3460 "implementations (eg. GtkProgressBar)."
3464 #: ../src/guestfs.pod:1795
3466 "For these calls, zero or more progress messages are generated with "
3467 "C<position = 0> and C<total = 1>, followed by a final message with "
3468 "C<position = total = 1>."
3472 #: ../src/guestfs.pod:1799
3474 "As noted above, if the call fails with an error then the final message may "
3479 #: ../src/guestfs.pod:1804
3481 "The callback also receives the procedure number (C<proc_nr>) and serial "
3482 "number (C<serial>) of the call. These are only useful for debugging "
3483 "protocol issues, and the callback can normally ignore them. The callback "
3484 "may want to print these numbers in error messages or debugging messages."
3488 #: ../src/guestfs.pod:1810
3489 msgid "If no callback is registered: progress messages are discarded."
3493 #: ../src/guestfs.pod:1812
3494 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3498 #: ../src/guestfs.pod:1815
3500 "The callback function is called whenever a log message is generated by qemu, "
3501 "the appliance kernel, guestfsd (daemon), or utility programs."
3505 #: ../src/guestfs.pod:1818
3507 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3508 "(L</guestfs_launch>) then additional debug messages are generated."
3512 #: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835
3514 "If no callback is registered: the messages are discarded unless the verbose "
3515 "flag is set in which case they are sent to stderr. You can override the "
3516 "printing of verbose messages to stderr by setting up a callback."
3520 #: ../src/guestfs.pod:1826
3521 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3525 #: ../src/guestfs.pod:1829
3527 "The callback function is called whenever a log message is generated by the "
3528 "library part of libguestfs."
3532 #: ../src/guestfs.pod:1832
3534 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3535 "messages are generated."
3539 #: ../src/guestfs.pod:1840
3540 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3544 #: ../src/guestfs.pod:1843
3546 "The callback function is called whenever a trace message is generated. This "
3547 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3551 #: ../src/guestfs.pod:1846
3553 "If no callback is registered: the messages are sent to stderr. You can "
3554 "override the printing of trace messages to stderr by setting up a callback."
3558 #: ../src/guestfs.pod:1852
3559 msgid "guestfs_set_event_callback"
3563 #: ../src/guestfs.pod:1854
3566 " int guestfs_set_event_callback (guestfs_h *g,\n"
3567 " guestfs_event_callback cb,\n"
3568 " uint64_t event_bitmask,\n"
3575 #: ../src/guestfs.pod:1860
3577 "This function registers a callback (C<cb>) for all event classes in the "
3582 #: ../src/guestfs.pod:1863
3584 "For example, to register for all log message events, you could call this "
3585 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3586 "To register a single callback for all possible classes of events, use "
3587 "C<GUESTFS_EVENT_ALL>."
3591 #: ../src/guestfs.pod:1869
3592 msgid "C<flags> should always be passed as 0."
3596 #: ../src/guestfs.pod:1871
3598 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3599 "it for any purpose."
3603 #: ../src/guestfs.pod:1874
3605 "The return value is the event handle (an integer) which you can use to "
3606 "delete the callback (see below)."
3610 #: ../src/guestfs.pod:1877
3612 "If there is an error, this function returns C<-1>, and sets the error in the "
3613 "handle in the usual way (see L</guestfs_last_error> etc.)"
3617 #: ../src/guestfs.pod:1880
3619 "Callbacks remain in effect until they are deleted, or until the handle is "
3624 #: ../src/guestfs.pod:1883
3626 "In the case where multiple callbacks are registered for a particular event "
3627 "class, all of the callbacks are called. The order in which multiple "
3628 "callbacks are called is not defined."
3632 #: ../src/guestfs.pod:1887
3633 msgid "guestfs_delete_event_callback"
3637 #: ../src/guestfs.pod:1889
3640 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3645 #: ../src/guestfs.pod:1891
3647 "Delete a callback that was previously registered. C<event_handle> should be "
3648 "the integer that was returned by a previous call to "
3649 "C<guestfs_set_event_callback> on the same handle."
3653 #: ../src/guestfs.pod:1895
3654 msgid "guestfs_event_callback"
3658 #: ../src/guestfs.pod:1897
3661 " typedef void (*guestfs_event_callback) (\n"
3664 " uint64_t event,\n"
3665 " int event_handle,\n"
3667 " const char *buf, size_t buf_len,\n"
3668 " const uint64_t *array, size_t array_len);\n"
3673 #: ../src/guestfs.pod:1906
3674 msgid "This is the type of the event callback function that you have to provide."
3678 #: ../src/guestfs.pod:1909
3680 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3681 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3682 "handle, and C<flags> which in the current API you should ignore."
3686 #: ../src/guestfs.pod:1913
3688 "The remaining parameters contain the event payload (if any). Each event may "
3689 "contain a payload, which usually relates to the event class, but for future "
3690 "proofing your code should be written to handle any payload for any event "
3695 #: ../src/guestfs.pod:1918
3697 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3698 "there is no message buffer). Note that this message buffer can contain "
3699 "arbitrary 8 bit data, including NUL bytes."
3703 #: ../src/guestfs.pod:1922
3705 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3706 "moment this is only used for progress messages."
3710 #: ../src/guestfs.pod:1925
3711 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3715 #: ../src/guestfs.pod:1927
3717 "One motivation for the generic event API was to allow GUI programs to "
3718 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3719 "unconditionally to C<stderr>."
3723 #: ../src/guestfs.pod:1931
3725 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3726 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3727 "messages are not events; you must capture error messages separately)."
3731 #: ../src/guestfs.pod:1936
3733 "Programs have to set up a callback to capture the classes of events of "
3738 #: ../src/guestfs.pod:1939
3742 " guestfs_set_event_callback\n"
3743 " (g, message_callback,\n"
3744 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3745 " GUESTFS_EVENT_TRACE,\n"
3746 " 0, NULL) == -1)\n"
3747 " if (eh == -1) {\n"
3748 " // handle error in the usual way\n"
3754 #: ../src/guestfs.pod:1949
3756 "The callback can then direct messages to the appropriate place. In this "
3757 "example, messages are directed to syslog:"
3761 #: ../src/guestfs.pod:1952
3765 " message_callback (\n"
3768 " uint64_t event,\n"
3769 " int event_handle,\n"
3771 " const char *buf, size_t buf_len,\n"
3772 " const uint64_t *array, size_t array_len)\n"
3774 " const int priority = LOG_USER|LOG_INFO;\n"
3775 " if (buf_len > 0)\n"
3776 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3782 #: ../src/guestfs.pod:1967
3783 msgid "PRIVATE DATA AREA"
3787 #: ../src/guestfs.pod:1969
3789 "You can attach named pieces of private data to the libguestfs handle, fetch "
3790 "them by name, and walk over them, for the lifetime of the handle. This is "
3791 "called the private data area and is only available from the C API."
3795 #: ../src/guestfs.pod:1974
3796 msgid "To attach a named piece of data, use the following call:"
3800 #: ../src/guestfs.pod:1976
3803 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3808 #: ../src/guestfs.pod:1978
3810 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3811 "pointer (which can be C<NULL>). Any previous item with the same name is "
3816 #: ../src/guestfs.pod:1982
3818 "You can use any C<key> you want, but names beginning with an underscore "
3819 "character are reserved for internal libguestfs purposes (for implementing "
3820 "language bindings). It is recommended to prefix the name with some unique "
3821 "string to avoid collisions with other users."
3825 #: ../src/guestfs.pod:1987
3826 msgid "To retrieve the pointer, use:"
3830 #: ../src/guestfs.pod:1989
3833 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3838 #: ../src/guestfs.pod:1991
3840 "This function returns C<NULL> if either no data is found associated with "
3841 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3846 #: ../src/guestfs.pod:1995
3848 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3849 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3850 "all. In particular, libguestfs does I<not> try to free the data when the "
3851 "handle is closed. If the data must be freed, then the caller must either "
3852 "free it before calling L</guestfs_close> or must set up a close callback to "
3853 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3857 #: ../src/guestfs.pod:2002
3858 msgid "To walk over all entries, use these two functions:"
3862 #: ../src/guestfs.pod:2004
3865 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3870 #: ../src/guestfs.pod:2006
3873 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3878 #: ../src/guestfs.pod:2008
3880 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3881 "not have any particular meaning -- keys are not returned in any defined "
3882 "order). A pointer to the key is returned in C<*key_rtn> and the "
3883 "corresponding data pointer is returned from the function. C<NULL> is "
3884 "returned if there are no keys stored in the handle."
3888 #: ../src/guestfs.pod:2014
3890 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3891 "value of this function is also C<NULL> is there are no further entries to "
3896 #: ../src/guestfs.pod:2018
3897 msgid "Notes about walking over entries:"
3901 #: ../src/guestfs.pod:2024
3902 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3906 #: ../src/guestfs.pod:2029
3908 "The handle maintains an internal iterator which is reset when you call "
3909 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3910 "call C<guestfs_set_private>."
3914 #: ../src/guestfs.pod:2035
3915 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3919 #: ../src/guestfs.pod:2037
3922 " guestfs_set_private (g, key, NULL);\n"
3927 #: ../src/guestfs.pod:2039
3928 msgid "then that C<key> is not returned when walking."
3932 #: ../src/guestfs.pod:2043
3934 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3935 "C<guestfs_next_private> or C<guestfs_set_private>."
3939 #: ../src/guestfs.pod:2049
3941 "The following example code shows how to print all keys and data pointers "
3942 "that are associated with the handle C<g>:"
3946 #: ../src/guestfs.pod:2052
3949 " const char *key;\n"
3950 " void *data = guestfs_first_private (g, &key);\n"
3951 " while (data != NULL)\n"
3953 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3954 " data = guestfs_next_private (g, &key);\n"
3960 #: ../src/guestfs.pod:2060
3962 "More commonly you are only interested in keys that begin with an "
3963 "application-specific prefix C<foo_>. Modify the loop like so:"
3967 #: ../src/guestfs.pod:2063
3970 " const char *key;\n"
3971 " void *data = guestfs_first_private (g, &key);\n"
3972 " while (data != NULL)\n"
3974 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3975 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3976 " data = guestfs_next_private (g, &key);\n"
3982 #: ../src/guestfs.pod:2072
3984 "If you need to modify keys while walking, then you have to jump back to the "
3985 "beginning of the loop. For example, to delete all keys prefixed with "
3990 #: ../src/guestfs.pod:2076
3993 " const char *key;\n"
3996 " data = guestfs_first_private (g, &key);\n"
3997 " while (data != NULL)\n"
3999 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4001 " guestfs_set_private (g, key, NULL);\n"
4002 " /* note that 'key' pointer is now invalid, and so is\n"
4003 " the internal iterator */\n"
4006 " data = guestfs_next_private (g, &key);\n"
4012 #: ../src/guestfs.pod:2092
4014 "Note that the above loop is guaranteed to terminate because the keys are "
4015 "being deleted, but other manipulations of keys within the loop might not "
4016 "terminate unless you also maintain an indication of which keys have been "
4021 #: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102
4026 #: ../src/guestfs.pod:2099
4028 "<!-- old anchor for the next section --> <a "
4029 "name=\"state_machine_and_low_level_event_api\"/>"
4033 #: ../src/guestfs.pod:2104
4034 msgid "ARCHITECTURE"
4038 #: ../src/guestfs.pod:2106
4040 "Internally, libguestfs is implemented by running an appliance (a special "
4041 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4042 "process of the main program."
4046 #: ../src/guestfs.pod:2110
4049 " ___________________\n"
4051 " | main program |\n"
4053 " | | child process / appliance\n"
4054 " | | __________________________\n"
4056 " +-------------------+ RPC | +-----------------+ |\n"
4057 " | libguestfs <--------------------> guestfsd | |\n"
4058 " | | | +-----------------+ |\n"
4059 " \\___________________/ | | Linux kernel | |\n"
4060 " | +--^--------------+ |\n"
4061 " \\_________|________________/\n"
4067 " \\______________/\n"
4072 #: ../src/guestfs.pod:2130
4074 "The library, linked to the main program, creates the child process and hence "
4075 "the appliance in the L</guestfs_launch> function."
4079 #: ../src/guestfs.pod:2133
4081 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4082 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4083 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4084 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4085 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4086 "attached to the qemu process which translates device access by the "
4087 "appliance's Linux kernel into accesses to the image."
4091 #: ../src/guestfs.pod:2142
4093 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4094 "Although the disk image you are attached to might also be used by some "
4095 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4096 "care if both libguestfs's qemu process and your virtual machine are trying "
4097 "to update the disk image at the same time, since these usually results in "
4098 "massive disk corruption)."
4102 #: ../src/guestfs.pod:2149
4103 msgid "STATE MACHINE"
4107 #: ../src/guestfs.pod:2151
4108 msgid "libguestfs uses a state machine to model the child process:"
4112 #: ../src/guestfs.pod:2153
4124 " / | \\ \\ guestfs_launch\n"
4125 " / | _\\__V______\n"
4127 " / | | LAUNCHING |\n"
4128 " / | \\___________/\n"
4130 " / | guestfs_launch\n"
4132 " ______ / __|____V\n"
4133 " / \\ ------> / \\\n"
4134 " | BUSY | | READY |\n"
4135 " \\______/ <------ \\________/\n"
4140 #: ../src/guestfs.pod:2175
4142 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4143 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4144 "(3) alternating between READY and BUSY as commands are issued to, and "
4145 "carried out by, the child process."
4149 #: ../src/guestfs.pod:2180
4151 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4152 "asynchronously at any time (eg. due to some internal error), and that causes "
4153 "the state to transition back to CONFIG."
4157 #: ../src/guestfs.pod:2184
4159 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4160 "issued when in the CONFIG state."
4164 #: ../src/guestfs.pod:2187
4166 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4167 "L</guestfs_launch> blocks until the child process is READY to accept "
4168 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4169 "moves the state from CONFIG to LAUNCHING while it is running."
4173 #: ../src/guestfs.pod:2193
4175 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4176 "state. These API calls block waiting for the command to be carried out "
4177 "(ie. the state to transition to BUSY and then back to READY). There are no "
4178 "non-blocking versions, and no way to issue more than one command per handle "
4183 #: ../src/guestfs.pod:2199
4185 "Finally, the child process sends asynchronous messages back to the main "
4186 "program, such as kernel log messages. You can register a callback to "
4187 "receive these messages."
4191 #: ../src/guestfs.pod:2203
4196 #: ../src/guestfs.pod:2205
4197 msgid "COMMUNICATION PROTOCOL"
4201 #: ../src/guestfs.pod:2207
4203 "Don't rely on using this protocol directly. This section documents how it "
4204 "currently works, but it may change at any time."
4208 #: ../src/guestfs.pod:2210
4210 "The protocol used to talk between the library and the daemon running inside "
4211 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4212 "1014, RFC 1832, RFC 4506)."
4216 #: ../src/guestfs.pod:2214
4218 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4219 "this file is automatically generated)."
4223 #: ../src/guestfs.pod:2217
4225 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4226 "and C<FileOut> parameters, which are handled with very simple request/reply "
4227 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4228 "parameters, which use the same request and reply messages, but they may also "
4229 "be followed by files sent using a chunked encoding."
4233 #: ../src/guestfs.pod:2224
4234 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4238 #: ../src/guestfs.pod:2226
4239 msgid "For ordinary functions, the request message is:"
4243 #: ../src/guestfs.pod:2228
4246 " total length (header + arguments,\n"
4247 " but not including the length word itself)\n"
4248 " struct guestfs_message_header (encoded as XDR)\n"
4249 " struct guestfs_<foo>_args (encoded as XDR)\n"
4254 #: ../src/guestfs.pod:2233
4256 "The total length field allows the daemon to allocate a fixed size buffer "
4257 "into which it slurps the rest of the message. As a result, the total length "
4258 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4259 "effective size of any request is limited to somewhere under this size."
4263 #: ../src/guestfs.pod:2239
4265 "Note also that many functions don't take any arguments, in which case the "
4266 "C<guestfs_I<foo>_args> is completely omitted."
4270 #: ../src/guestfs.pod:2242
4272 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4273 "receiver knows what type of args structure to expect, or none at all."
4277 #: ../src/guestfs.pod:2246
4279 "For functions that take optional arguments, the optional arguments are "
4280 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4281 "arguments. A bitmask in the header indicates which optional arguments are "
4282 "meaningful. The bitmask is also checked to see if it contains bits set "
4283 "which the daemon does not know about (eg. if more optional arguments were "
4284 "added in a later version of the library), and this causes the call to be "
4289 #: ../src/guestfs.pod:2254
4290 msgid "The reply message for ordinary functions is:"
4294 #: ../src/guestfs.pod:2256
4297 " total length (header + ret,\n"
4298 " but not including the length word itself)\n"
4299 " struct guestfs_message_header (encoded as XDR)\n"
4300 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4305 #: ../src/guestfs.pod:2261
4307 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4308 "functions that return no formal return values."
4312 #: ../src/guestfs.pod:2264
4313 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4317 #: ../src/guestfs.pod:2267
4319 "In the case of an error, a flag is set in the header, and the reply message "
4320 "is slightly changed:"
4324 #: ../src/guestfs.pod:2270
4327 " total length (header + error,\n"
4328 " but not including the length word itself)\n"
4329 " struct guestfs_message_header (encoded as XDR)\n"
4330 " struct guestfs_message_error (encoded as XDR)\n"
4335 #: ../src/guestfs.pod:2275
4337 "The C<guestfs_message_error> structure contains the error message as a "
4342 #: ../src/guestfs.pod:2278
4343 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4347 #: ../src/guestfs.pod:2280
4349 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4350 "The normal request message is sent (see above). However this is followed by "
4351 "a sequence of file chunks."
4355 #: ../src/guestfs.pod:2284
4358 " total length (header + arguments,\n"
4359 " but not including the length word itself,\n"
4360 " and not including the chunks)\n"
4361 " struct guestfs_message_header (encoded as XDR)\n"
4362 " struct guestfs_<foo>_args (encoded as XDR)\n"
4363 " sequence of chunks for FileIn param #0\n"
4364 " sequence of chunks for FileIn param #1 etc.\n"
4369 #: ../src/guestfs.pod:2292
4370 msgid "The \"sequence of chunks\" is:"
4374 #: ../src/guestfs.pod:2294
4377 " length of chunk (not including length word itself)\n"
4378 " struct guestfs_chunk (encoded as XDR)\n"
4379 " length of chunk\n"
4380 " struct guestfs_chunk (encoded as XDR)\n"
4382 " length of chunk\n"
4383 " struct guestfs_chunk (with data.data_len == 0)\n"
4388 #: ../src/guestfs.pod:2302
4390 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4391 "is set in the final chunk to indicate either successful completion or early "
4396 #: ../src/guestfs.pod:2306
4398 "At time of writing there are no functions that have more than one FileIn "
4399 "parameter. However this is (theoretically) supported, by sending the "
4400 "sequence of chunks for each FileIn parameter one after another (from left to "
4405 #: ../src/guestfs.pod:2311
4407 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4408 "transfer. The library does this by sending a chunk with a special flag set "
4409 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4410 "RPC, does I<not> send any reply, and goes back to reading the next request."
4414 #: ../src/guestfs.pod:2317
4416 "The daemon may also cancel. It does this by writing a special word "
4417 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4418 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4419 "cancel chunk). The special word is chosen so that even if cancellation "
4420 "happens right at the end of the transfer (after the library has finished "
4421 "writing and has started listening for the reply), the \"spurious\" cancel "
4422 "flag will not be confused with the reply message."
4426 #: ../src/guestfs.pod:2326
4428 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4429 "limit), and also files where the size is not known in advance (eg. from "
4430 "pipes or sockets). However the chunks are rather small "
4431 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4432 "to keep much in memory."
4436 #: ../src/guestfs.pod:2332
4437 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4441 #: ../src/guestfs.pod:2334
4443 "The protocol for FileOut parameters is exactly the same as for FileIn "
4444 "parameters, but with the roles of daemon and library reversed."
4448 #: ../src/guestfs.pod:2337
4451 " total length (header + ret,\n"
4452 " but not including the length word itself,\n"
4453 " and not including the chunks)\n"
4454 " struct guestfs_message_header (encoded as XDR)\n"
4455 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4456 " sequence of chunks for FileOut param #0\n"
4457 " sequence of chunks for FileOut param #1 etc.\n"
4462 #: ../src/guestfs.pod:2345
4463 msgid "INITIAL MESSAGE"
4467 #: ../src/guestfs.pod:2347
4469 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4470 "which indicates that the guest and daemon is alive. This is what "
4471 "L</guestfs_launch> waits for."
4475 #: ../src/guestfs.pod:2351
4476 msgid "PROGRESS NOTIFICATION MESSAGES"
4480 #: ../src/guestfs.pod:2353
4482 "The daemon may send progress notification messages at any time. These are "
4483 "distinguished by the normal length word being replaced by "
4484 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4488 #: ../src/guestfs.pod:2357
4490 "The library turns them into progress callbacks (see "
4491 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4496 #: ../src/guestfs.pod:2361
4498 "The daemon self-limits the frequency of progress messages it sends (see "
4499 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4504 #: ../src/guestfs.pod:2365
4505 msgid "LIBGUESTFS VERSION NUMBERS"
4509 #: ../src/guestfs.pod:2367
4511 "Since April 2010, libguestfs has started to make separate development and "
4512 "stable releases, along with corresponding branches in our git repository. "
4513 "These separate releases can be identified by version number:"
4517 #: ../src/guestfs.pod:2372
4520 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4521 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4527 " | `-------- sub-version\n"
4529 " `------ always '1' because we don't change the ABI\n"
4534 #: ../src/guestfs.pod:2383
4535 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4539 #: ../src/guestfs.pod:2385
4541 "As time passes we cherry pick fixes from the development branch and backport "
4542 "those into the stable branch, the effect being that the stable branch should "
4543 "get more stable and less buggy over time. So the stable releases are ideal "
4544 "for people who don't need new features but would just like the software to "
4549 #: ../src/guestfs.pod:2391
4550 msgid "Our criteria for backporting changes are:"
4554 #: ../src/guestfs.pod:2397
4556 "Documentation changes which don't affect any code are backported unless the "
4557 "documentation refers to a future feature which is not in stable."
4561 #: ../src/guestfs.pod:2403
4563 "Bug fixes which are not controversial, fix obvious problems, and have been "
4564 "well tested are backported."
4568 #: ../src/guestfs.pod:2408
4570 "Simple rearrangements of code which shouldn't affect how it works get "
4571 "backported. This is so that the code in the two branches doesn't get too "
4572 "far out of step, allowing us to backport future fixes more easily."
4576 #: ../src/guestfs.pod:2414
4578 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4579 "exceptional case: the new feature is required in order to implement an "
4580 "important bug fix."
4584 #: ../src/guestfs.pod:2420
4586 "A new stable branch starts when we think the new features in development are "
4587 "substantial and compelling enough over the current stable branch to warrant "
4588 "it. When that happens we create new stable and development versions 1.N.0 "
4589 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4590 "stable at this point, but by backporting fixes from development, that branch "
4591 "will stabilize over time."
4595 #: ../src/guestfs.pod:2428
4596 msgid "EXTENDING LIBGUESTFS"
4600 #: ../src/guestfs.pod:2430
4601 msgid "ADDING A NEW API ACTION"
4605 #: ../src/guestfs.pod:2432
4607 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4608 "documentation) are generated, and this makes it easy to extend the "
4613 #: ../src/guestfs.pod:2436
4614 msgid "To add a new API action there are two changes:"
4618 #: ../src/guestfs.pod:2442
4620 "You need to add a description of the call (name, parameters, return type, "
4621 "tests, documentation) to C<generator/generator_actions.ml>."
4625 #: ../src/guestfs.pod:2445
4627 "There are two sorts of API action, depending on whether the call goes "
4628 "through to the daemon in the appliance, or is serviced entirely by the "
4629 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4630 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4631 "an example of the latter, since a trace flag is maintained in the handle and "
4632 "all tracing is done on the library side."
4636 #: ../src/guestfs.pod:2453
4638 "Most new actions are of the first type, and get added to the "
4639 "C<daemon_functions> list. Each function has a unique procedure number used "
4640 "in the RPC protocol which is assigned to that action when we publish "
4641 "libguestfs and cannot be reused. Take the latest procedure number and "
4646 #: ../src/guestfs.pod:2459
4648 "For library-only actions of the second type, add to the "
4649 "C<non_daemon_functions> list. Since these functions are serviced by the "
4650 "library and do not travel over the RPC mechanism to the daemon, these "
4651 "functions do not need a procedure number, and so the procedure number is set "
4656 #: ../src/guestfs.pod:2467
4657 msgid "Implement the action (in C):"
4661 #: ../src/guestfs.pod:2469
4663 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4664 "C<daemon/> directory."
4668 #: ../src/guestfs.pod:2472
4670 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4671 "(note: double underscore) in the C<src/> directory."
4675 #: ../src/guestfs.pod:2475
4676 msgid "In either case, use another function as an example of what to do."
4680 #: ../src/guestfs.pod:2479
4681 msgid "After making these changes, use C<make> to compile."
4685 #: ../src/guestfs.pod:2481
4687 "Note that you don't need to implement the RPC, language bindings, manual "
4688 "pages or anything else. It's all automatically generated from the OCaml "
4693 #: ../src/guestfs.pod:2485
4694 msgid "ADDING TESTS FOR AN API ACTION"
4698 #: ../src/guestfs.pod:2487
4700 "You can supply zero or as many tests as you want per API call. The tests "
4701 "can either be added as part of the API description "
4702 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4703 "drop a script into C<regressions/>. Note that adding a script to "
4704 "C<regressions/> is slower, so if possible use the first method."
4708 #: ../src/guestfs.pod:2493
4710 "The following describes the test environment used when you add an API test "
4711 "in C<generator_actions.ml>."
4715 #: ../src/guestfs.pod:2496
4716 msgid "The test environment has 4 block devices:"
4720 #: ../src/guestfs.pod:2500
4721 msgid "C</dev/sda> 500MB"
4725 #: ../src/guestfs.pod:2502
4726 msgid "General block device for testing."
4730 #: ../src/guestfs.pod:2504
4731 msgid "C</dev/sdb> 50MB"
4735 #: ../src/guestfs.pod:2506
4737 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4742 #: ../src/guestfs.pod:2509
4743 msgid "C</dev/sdc> 10MB"
4747 #: ../src/guestfs.pod:2511
4748 msgid "Used in a few tests where two block devices are needed."
4752 #: ../src/guestfs.pod:2513
4757 #: ../src/guestfs.pod:2515
4758 msgid "ISO with fixed content (see C<images/test.iso>)."
4762 #: ../src/guestfs.pod:2519
4764 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4765 "appliance and block devices are reused between tests. So don't try testing "
4766 "L</guestfs_kill_subprocess> :-x"
4770 #: ../src/guestfs.pod:2523
4772 "Each test starts with an initial scenario, selected using one of the "
4773 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4774 "initialize the disks mentioned above in a particular way as documented in "
4775 "C<generator_types.ml>. You should not assume anything about the previous "
4776 "contents of other disks that are not initialized."
4780 #: ../src/guestfs.pod:2529
4782 "You can add a prerequisite clause to any individual test. This is a "
4783 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4784 "if testing a command which might not work on all variations of libguestfs "
4785 "builds. A test that has prerequisite of C<Always> means to run "
4790 #: ../src/guestfs.pod:2535
4792 "In addition, packagers can skip individual tests by setting environment "
4793 "variables before running C<make check>."
4797 #: ../src/guestfs.pod:2538
4800 " SKIP_TEST_<CMD>_<NUM>=1\n"
4805 #: ../src/guestfs.pod:2540
4806 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4810 #: ../src/guestfs.pod:2542
4815 #: ../src/guestfs.pod:2544
4818 " SKIP_TEST_<CMD>=1\n"
4823 #: ../src/guestfs.pod:2546
4824 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4828 #: ../src/guestfs.pod:2548
4829 msgid "Packagers can run only certain tests by setting for example:"
4833 #: ../src/guestfs.pod:2550
4836 " TEST_ONLY=\"vfs_type zerofree\"\n"
4841 #: ../src/guestfs.pod:2552
4843 "See C<capitests/tests.c> for more details of how these environment variables "
4848 #: ../src/guestfs.pod:2555
4849 msgid "DEBUGGING NEW API ACTIONS"
4853 #: ../src/guestfs.pod:2557
4854 msgid "Test new actions work before submitting them."
4858 #: ../src/guestfs.pod:2559
4859 msgid "You can use guestfish to try out new commands."
4863 #: ../src/guestfs.pod:2561
4865 "Debugging the daemon is a problem because it runs inside a minimal "
4866 "environment. However you can fprintf messages in the daemon to stderr, and "
4867 "they will show up if you use C<guestfish -v>."
4871 #: ../src/guestfs.pod:2565
4872 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4876 #: ../src/guestfs.pod:2567
4878 "Our C source code generally adheres to some basic code-formatting "
4879 "conventions. The existing code base is not totally consistent on this "
4880 "front, but we do prefer that contributed code be formatted similarly. In "
4881 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4882 "indentation level, and other than that, follow the K&R style."
4886 #: ../src/guestfs.pod:2573
4888 "If you use Emacs, add the following to one of one of your start-up files "
4889 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4893 #: ../src/guestfs.pod:2576
4896 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4897 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4898 " (add-hook 'find-file-hook\n"
4899 " '(lambda () (if (and buffer-file-name\n"
4900 " (string-match \"/libguestfs\\\\>\"\n"
4901 " (buffer-file-name))\n"
4902 " (not (string-equal mode-name \"Change Log\"))\n"
4903 " (not (string-equal mode-name \"Makefile\")))\n"
4904 " (setq indent-tabs-mode nil))))\n"
4909 #: ../src/guestfs.pod:2586
4912 " ;;; When editing C sources in libguestfs, use this style.\n"
4913 " (defun libguestfs-c-mode ()\n"
4914 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4916 " (c-set-style \"K&R\")\n"
4917 " (setq c-indent-level 2)\n"
4918 " (setq c-basic-offset 2))\n"
4919 " (add-hook 'c-mode-hook\n"
4920 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4921 " (buffer-file-name))\n"
4922 " (libguestfs-c-mode))))\n"
4927 #: ../src/guestfs.pod:2598
4928 msgid "Enable warnings when compiling (and fix any problems this finds):"
4932 #: ../src/guestfs.pod:2601
4935 " ./configure --enable-gcc-warnings\n"
4940 #: ../src/guestfs.pod:2603
4941 msgid "Useful targets are:"
4945 #: ../src/guestfs.pod:2605
4948 " make syntax-check # checks the syntax of the C code\n"
4949 " make check # runs the test suite\n"
4954 #: ../src/guestfs.pod:2608
4955 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4959 #: ../src/guestfs.pod:2610
4961 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4962 "which are used to do shell quoting."
4966 #: ../src/guestfs.pod:2615
4971 #: ../src/guestfs.pod:2617
4973 "Simple shell quoted string. Any spaces or other shell characters are "
4978 #: ../src/guestfs.pod:2620
4983 #: ../src/guestfs.pod:2622
4985 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4990 #: ../src/guestfs.pod:2627 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
4991 msgid "For example:"
4995 #: ../src/guestfs.pod:2629
4998 " asprintf (&cmd, \"cat %R\", path);\n"
5003 #: ../src/guestfs.pod:2631
5004 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5008 #: ../src/guestfs.pod:2633
5010 "I<Note:> Do I<not> use these when you are passing parameters to the "
5011 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
5012 "because they are not passed via the shell (instead, straight to exec). You "
5013 "probably want to use the C<sysroot_path()> function however."
5017 #: ../src/guestfs.pod:2639
5018 msgid "SUBMITTING YOUR NEW API ACTIONS"
5022 #: ../src/guestfs.pod:2641
5024 "Submit patches to the mailing list: "
5025 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5026 "L<rjones@redhat.com>."
5030 #: ../src/guestfs.pod:2645
5031 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5035 #: ../src/guestfs.pod:2647
5036 msgid "We support i18n (gettext anyhow) in the library."
5040 #: ../src/guestfs.pod:2649
5042 "However many messages come from the daemon, and we don't translate those at "
5043 "the moment. One reason is that the appliance generally has all locale files "
5044 "removed from it, because they take up a lot of space. So we'd have to readd "
5045 "some of those, as well as copying our PO files into the appliance."
5049 #: ../src/guestfs.pod:2655
5051 "Debugging messages are never translated, since they are intended for the "
5056 #: ../src/guestfs.pod:2658
5057 msgid "SOURCE CODE SUBDIRECTORIES"
5061 #: ../src/guestfs.pod:2662 ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3900
5062 msgid "C<appliance>"
5066 #: ../src/guestfs.pod:2664
5067 msgid "The libguestfs appliance, build scripts and so on."
5071 #: ../src/guestfs.pod:2666
5072 msgid "C<capitests>"
5076 #: ../src/guestfs.pod:2668
5077 msgid "Automated tests of the C API."
5081 #: ../src/guestfs.pod:2670
5086 #: ../src/guestfs.pod:2672
5088 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5093 #: ../src/guestfs.pod:2675
5098 #: ../src/guestfs.pod:2677
5099 msgid "Outside contributions, experimental parts."
5103 #: ../src/guestfs.pod:2679
5108 #: ../src/guestfs.pod:2681
5110 "The daemon that runs inside the libguestfs appliance and carries out "
5115 #: ../src/guestfs.pod:2684
5120 #: ../src/guestfs.pod:2686
5121 msgid "L<virt-df(1)> command and documentation."
5125 #: ../src/guestfs.pod:2688
5130 #: ../src/guestfs.pod:2690
5131 msgid "C API example code."
5135 #: ../src/guestfs.pod:2692
5140 #: ../src/guestfs.pod:2694
5142 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5143 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5144 "L<virt-tar-out(1)>."
5148 #: ../src/guestfs.pod:2698
5153 #: ../src/guestfs.pod:2700
5154 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5158 #: ../src/guestfs.pod:2702
5159 msgid "C<generator>"
5163 #: ../src/guestfs.pod:2704
5165 "The crucially important generator, used to automatically generate large "
5166 "amounts of boilerplate C code for things like RPC and bindings."
5170 #: ../src/guestfs.pod:2707
5175 #: ../src/guestfs.pod:2709
5176 msgid "Files used by the test suite."
5180 #: ../src/guestfs.pod:2711
5181 msgid "Some \"phony\" guest images which we test against."
5185 #: ../src/guestfs.pod:2713
5186 msgid "C<inspector>"
5190 #: ../src/guestfs.pod:2715
5191 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5195 #: ../src/guestfs.pod:2717
5200 #: ../src/guestfs.pod:2719
5201 msgid "Logo used on the website. The fish is called Arthur by the way."
5205 #: ../src/guestfs.pod:2721
5210 #: ../src/guestfs.pod:2723
5211 msgid "M4 macros used by autoconf."
5215 #: ../src/guestfs.pod:2725
5220 #: ../src/guestfs.pod:2727
5221 msgid "Translations of simple gettext strings."
5225 #: ../src/guestfs.pod:2729
5230 #: ../src/guestfs.pod:2731
5232 "The build infrastructure and PO files for translations of manpages and POD "
5233 "files. Eventually this will be combined with the C<po> directory, but that "
5234 "is rather complicated."
5238 #: ../src/guestfs.pod:2735
5239 msgid "C<regressions>"
5243 #: ../src/guestfs.pod:2737
5244 msgid "Regression tests."
5248 #: ../src/guestfs.pod:2739
5253 #: ../src/guestfs.pod:2741
5254 msgid "L<virt-rescue(1)> command and documentation."
5258 #: ../src/guestfs.pod:2743
5263 #: ../src/guestfs.pod:2745
5264 msgid "Source code to the C library."
5268 #: ../src/guestfs.pod:2747
5273 #: ../src/guestfs.pod:2749
5274 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5278 #: ../src/guestfs.pod:2751
5279 msgid "C<test-tool>"
5283 #: ../src/guestfs.pod:2753
5285 "Test tool for end users to test if their qemu/kernel combination will work "
5290 #: ../src/guestfs.pod:2756
5295 #: ../src/guestfs.pod:2758
5300 #: ../src/guestfs.pod:2760
5305 #: ../src/guestfs.pod:2762
5310 #: ../src/guestfs.pod:2764
5315 #: ../src/guestfs.pod:2766
5320 #: ../src/guestfs.pod:2768
5325 #: ../src/guestfs.pod:2770
5330 #: ../src/guestfs.pod:2772
5331 msgid "Language bindings."
5335 #: ../src/guestfs.pod:2776 ../fish/guestfish.pod:1015 ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5336 msgid "ENVIRONMENT VARIABLES"
5340 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1041
5341 msgid "LIBGUESTFS_APPEND"
5345 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1043
5346 msgid "Pass additional options to the guest kernel."
5350 #: ../src/guestfs.pod:2784 ../fish/guestfish.pod:1045
5351 msgid "LIBGUESTFS_DEBUG"
5355 #: ../src/guestfs.pod:2786
5357 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5358 "effect as calling C<guestfs_set_verbose (g, 1)>."
5362 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1050
5363 msgid "LIBGUESTFS_MEMSIZE"
5367 #: ../src/guestfs.pod:2791 ../fish/guestfish.pod:1052
5368 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5372 #: ../src/guestfs.pod:2794 ../fish/guestfish.pod:1055
5375 " LIBGUESTFS_MEMSIZE=700\n"
5380 #: ../src/guestfs.pod:2796 ../fish/guestfish.pod:1057
5381 msgid "LIBGUESTFS_PATH"
5385 #: ../src/guestfs.pod:2798
5387 "Set the path that libguestfs uses to search for a supermin appliance. See "
5388 "the discussion of paths in section L</PATH> above."
5392 #: ../src/guestfs.pod:2801 ../fish/guestfish.pod:1062
5393 msgid "LIBGUESTFS_QEMU"
5397 #: ../src/guestfs.pod:2803 ../fish/guestfish.pod:1064
5399 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5400 "which was found at compile time by the configure script is used."
5404 #: ../src/guestfs.pod:2807
5405 msgid "See also L</QEMU WRAPPERS> above."
5409 #: ../src/guestfs.pod:2809 ../fish/guestfish.pod:1068
5410 msgid "LIBGUESTFS_TRACE"
5414 #: ../src/guestfs.pod:2811
5416 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5417 "effect as calling C<guestfs_set_trace (g, 1)>."
5421 #: ../src/guestfs.pod:2814 ../fish/guestfish.pod:1077
5426 #: ../src/guestfs.pod:2816 ../fish/guestfish.pod:1079
5428 "Location of temporary directory, defaults to C</tmp> except for the cached "
5429 "supermin appliance which defaults to C</var/tmp>."
5433 #: ../src/guestfs.pod:2819 ../fish/guestfish.pod:1082
5435 "If libguestfs was compiled to use the supermin appliance then the real "
5436 "appliance is cached in this directory, shared between all handles belonging "
5437 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5438 "use in case C</var/tmp> is not large enough."
5442 #: ../src/guestfs.pod:2827 ../fish/guestfish.pod:1149 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267 ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5447 #: ../src/guestfs.pod:2829
5449 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5450 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5451 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5452 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5453 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5454 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5455 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5456 "L<http://libguestfs.org/>."
5460 #: ../src/guestfs.pod:2856
5462 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5463 "L<lvm(8)>, L<disktype(1)>."
5467 #: ../src/guestfs.pod:2863 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5472 #: ../src/guestfs.pod:2865
5473 msgid "To get a list of bugs against libguestfs use this link:"
5477 #: ../src/guestfs.pod:2867
5478 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5482 #: ../src/guestfs.pod:2869
5483 msgid "To report a new bug against libguestfs use this link:"
5487 #: ../src/guestfs.pod:2871
5488 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5492 #: ../src/guestfs.pod:2873
5493 msgid "When reporting a bug, please check:"
5497 #: ../src/guestfs.pod:2879
5498 msgid "That the bug hasn't been reported already."
5502 #: ../src/guestfs.pod:2883
5503 msgid "That you are testing a recent version."
5507 #: ../src/guestfs.pod:2887
5508 msgid "Describe the bug accurately, and give a way to reproduce it."
5512 #: ../src/guestfs.pod:2891
5514 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5519 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1172 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5524 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1174 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5525 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5529 #: ../src/guestfs.pod:2900 ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282 ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5534 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1178 ../test-tool/libguestfs-test-tool.pod:99
5535 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5539 #: ../src/guestfs.pod:2905
5541 "This library is free software; you can redistribute it and/or modify it "
5542 "under the terms of the GNU Lesser General Public License as published by the "
5543 "Free Software Foundation; either version 2 of the License, or (at your "
5544 "option) any later version."
5548 #: ../src/guestfs.pod:2910
5550 "This library is distributed in the hope that it will be useful, but WITHOUT "
5551 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5552 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5557 #: ../src/guestfs.pod:2915
5559 "You should have received a copy of the GNU Lesser General Public License "
5560 "along with this library; if not, write to the Free Software Foundation, "
5561 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5565 #: ../src/guestfs-actions.pod:1
5566 msgid "guestfs_add_cdrom"
5570 #: ../src/guestfs-actions.pod:3
5574 " guestfs_add_cdrom (guestfs_h *g,\n"
5575 " const char *filename);\n"
5580 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5581 msgid "This function adds a virtual CD-ROM disk image to the guest."
5585 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5586 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5590 #: ../src/guestfs-actions.pod:17
5592 "This call checks for the existence of C<filename>. This stops you from "
5593 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5594 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5599 #: ../src/guestfs-actions.pod:24
5601 "If you just want to add an ISO file (often you use this as an efficient way "
5602 "to transfer large files into the guest), then you should probably use "
5603 "C<guestfs_add_drive_ro> instead."
5607 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436 ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541 ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670 ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266 ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471 ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474 ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183 ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281 ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772 ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100 ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258 ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343 ../src/guestfs-actions.pod:7372
5608 msgid "This function returns 0 on success or -1 on error."
5612 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5614 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5619 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266 ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319 ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000 ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
5621 "Deprecated functions will not be removed from the API, but the fact that "
5622 "they are deprecated indicates that there are problems with correct use of "
5627 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839 ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:7180
5628 msgid "(Added in 0.3)"
5632 #: ../src/guestfs-actions.pod:41
5633 msgid "guestfs_add_domain"
5637 #: ../src/guestfs-actions.pod:43
5641 " guestfs_add_domain (guestfs_h *g,\n"
5642 " const char *dom,\n"
5648 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4435
5650 "You may supply a list of optional arguments to this call. Use zero or more "
5651 "of the following pairs of parameters, and terminate the list with C<-1> on "
5652 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5656 #: ../src/guestfs-actions.pod:53
5659 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5660 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5661 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5662 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5667 #: ../src/guestfs-actions.pod:58
5669 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5670 "It works by connecting to libvirt, requesting the domain and domain XML from "
5671 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5676 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5678 "The number of disks added is returned. This operation is atomic: if an "
5679 "error is returned, then no disks are added."
5683 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5685 "This function does some minimal checks to make sure the libvirt domain is "
5686 "not running (unless C<readonly> is true). In a future version we will try "
5687 "to acquire the libvirt lock on each disk."
5691 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5693 "Disks must be accessible locally. This often means that adding disks from a "
5694 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5695 "unless those disks are accessible via the same device path locally too."
5699 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5701 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5702 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5703 "default libvirt URI (or one set through an environment variable, see the "
5704 "libvirt documentation for full details)."
5708 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5710 "The optional C<live> flag controls whether this call will try to connect to "
5711 "a running virtual machine C<guestfsd> process if it sees a suitable "
5712 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5713 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5714 "DAEMONS> for more information."
5718 #: ../src/guestfs-actions.pod:88
5720 "The other optional parameters are passed directly through to "
5721 "C<guestfs_add_drive_opts>."
5725 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772 ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861 ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7217
5726 msgid "On error this function returns -1."
5730 #: ../src/guestfs-actions.pod:93
5731 msgid "(Added in 1.7.4)"
5735 #: ../src/guestfs-actions.pod:95
5736 msgid "guestfs_add_domain_va"
5740 #: ../src/guestfs-actions.pod:97
5744 " guestfs_add_domain_va (guestfs_h *g,\n"
5745 " const char *dom,\n"
5751 #: ../src/guestfs-actions.pod:102
5752 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5756 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
5757 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5761 #: ../src/guestfs-actions.pod:106
5762 msgid "guestfs_add_domain_argv"
5766 #: ../src/guestfs-actions.pod:108
5770 " guestfs_add_domain_argv (guestfs_h *g,\n"
5771 " const char *dom,\n"
5772 " const struct guestfs_add_domain_argv *optargs);\n"
5777 #: ../src/guestfs-actions.pod:113
5778 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5782 #: ../src/guestfs-actions.pod:117
5783 msgid "guestfs_add_drive"
5787 #: ../src/guestfs-actions.pod:119
5791 " guestfs_add_drive (guestfs_h *g,\n"
5792 " const char *filename);\n"
5797 #: ../src/guestfs-actions.pod:123
5799 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5800 "optional parameters, so the disk is added writable, with the format being "
5801 "detected automatically."
5805 #: ../src/guestfs-actions.pod:127
5807 "Automatic detection of the format opens you up to a potential security hole "
5808 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5809 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5810 "you should think about replacing calls to this function with calls to "
5811 "C<guestfs_add_drive_opts>, and specifying the format."
5815 #: ../src/guestfs-actions.pod:138
5816 msgid "guestfs_add_drive_opts"
5820 #: ../src/guestfs-actions.pod:140
5824 " guestfs_add_drive_opts (guestfs_h *g,\n"
5825 " const char *filename,\n"
5831 #: ../src/guestfs-actions.pod:150
5834 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5835 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5836 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5841 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
5843 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5844 "The first time you call this function, the disk appears as C</dev/sda>, the "
5845 "second time as C</dev/sdb>, and so on."
5849 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
5851 "You don't necessarily need to be root when using libguestfs. However you "
5852 "obviously do need sufficient permissions to access the filename for whatever "
5853 "operations you want to perform (ie. read access if you just want to read the "
5854 "image or write access if you want to modify the image)."
5858 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
5859 msgid "This call checks that C<filename> exists."
5863 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
5864 msgid "The optional arguments are:"
5868 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
5873 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
5875 "If true then the image is treated as read-only. Writes are still allowed, "
5876 "but they are stored in a temporary snapshot overlay which is discarded at "
5877 "the end. The disk that you add is not modified."
5881 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
5886 #: ../src/guestfs-actions.pod:179
5888 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5889 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5890 "Possible formats include C<raw> and C<qcow2>."
5894 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
5896 "Automatic detection of the format opens you up to a potential security hole "
5897 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5898 "RHBZ#642934. Specifying the format closes this security hole."
5902 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
5907 #: ../src/guestfs-actions.pod:190
5909 "This rarely-used option lets you emulate the behaviour of the deprecated "
5910 "C<guestfs_add_drive_with_if> call (q.v.)"
5914 #: ../src/guestfs-actions.pod:197
5915 msgid "(Added in 1.5.23)"
5919 #: ../src/guestfs-actions.pod:199
5920 msgid "guestfs_add_drive_opts_va"
5924 #: ../src/guestfs-actions.pod:201
5928 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5929 " const char *filename,\n"
5935 #: ../src/guestfs-actions.pod:206
5936 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5940 #: ../src/guestfs-actions.pod:210
5941 msgid "guestfs_add_drive_opts_argv"
5945 #: ../src/guestfs-actions.pod:212
5949 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5950 " const char *filename,\n"
5951 " const struct guestfs_add_drive_opts_argv "
5957 #: ../src/guestfs-actions.pod:217
5958 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5962 #: ../src/guestfs-actions.pod:221
5963 msgid "guestfs_add_drive_ro"
5967 #: ../src/guestfs-actions.pod:223
5971 " guestfs_add_drive_ro (guestfs_h *g,\n"
5972 " const char *filename);\n"
5977 #: ../src/guestfs-actions.pod:227
5979 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5980 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5981 "disk is added read-only, with the format being detected automatically."
5985 #: ../src/guestfs-actions.pod:234
5986 msgid "(Added in 1.0.38)"
5990 #: ../src/guestfs-actions.pod:236
5991 msgid "guestfs_add_drive_ro_with_if"
5995 #: ../src/guestfs-actions.pod:238
5999 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6000 " const char *filename,\n"
6001 " const char *iface);\n"
6006 #: ../src/guestfs-actions.pod:243
6008 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6009 "QEMU interface emulation to use at run time."
6013 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2356
6014 msgid "(Added in 1.0.84)"
6018 #: ../src/guestfs-actions.pod:257
6019 msgid "guestfs_add_drive_with_if"
6023 #: ../src/guestfs-actions.pod:259
6027 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6028 " const char *filename,\n"
6029 " const char *iface);\n"
6034 #: ../src/guestfs-actions.pod:264
6036 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6037 "QEMU interface emulation to use at run time."
6041 #: ../src/guestfs-actions.pod:278
6042 msgid "guestfs_aug_clear"
6046 #: ../src/guestfs-actions.pod:280
6050 " guestfs_aug_clear (guestfs_h *g,\n"
6051 " const char *augpath);\n"
6056 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6058 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6059 "L<augtool(1)> C<clear> command."
6063 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6064 msgid "(Added in 1.3.4)"
6068 #: ../src/guestfs-actions.pod:291
6069 msgid "guestfs_aug_close"
6073 #: ../src/guestfs-actions.pod:293
6077 " guestfs_aug_close (guestfs_h *g);\n"
6082 #: ../src/guestfs-actions.pod:296
6084 "Close the current Augeas handle and free up any resources used by it. After "
6085 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6086 "any other Augeas functions."
6090 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511 ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:5472
6091 msgid "(Added in 0.7)"
6095 #: ../src/guestfs-actions.pod:305
6096 msgid "guestfs_aug_defnode"
6100 #: ../src/guestfs-actions.pod:307
6103 " struct guestfs_int_bool *\n"
6104 " guestfs_aug_defnode (guestfs_h *g,\n"
6105 " const char *name,\n"
6106 " const char *expr,\n"
6107 " const char *val);\n"
6112 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6113 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6117 #: ../src/guestfs-actions.pod:316
6119 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6120 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6121 "containing that single node."
6125 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6127 "On success this returns a pair containing the number of nodes in the "
6128 "nodeset, and a boolean flag if a node was created."
6132 #: ../src/guestfs-actions.pod:324
6134 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6135 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6139 #: ../src/guestfs-actions.pod:330
6140 msgid "guestfs_aug_defvar"
6144 #: ../src/guestfs-actions.pod:332
6148 " guestfs_aug_defvar (guestfs_h *g,\n"
6149 " const char *name,\n"
6150 " const char *expr);\n"
6155 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6157 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6158 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6162 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6164 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6165 "evaluates to something which is not a nodeset."
6169 #: ../src/guestfs-actions.pod:348
6170 msgid "guestfs_aug_get"
6174 #: ../src/guestfs-actions.pod:350
6178 " guestfs_aug_get (guestfs_h *g,\n"
6179 " const char *augpath);\n"
6184 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6186 "Look up the value associated with C<path>. If C<path> matches exactly one "
6187 "node, the C<value> is returned."
6191 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354 ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919 ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016 ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262 ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940 ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
6193 "This function returns a string, or NULL on error. I<The caller must free "
6194 "the returned string after use>."
6198 #: ../src/guestfs-actions.pod:362
6199 msgid "guestfs_aug_init"
6203 #: ../src/guestfs-actions.pod:364
6207 " guestfs_aug_init (guestfs_h *g,\n"
6208 " const char *root,\n"
6214 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6216 "Create a new Augeas handle for editing configuration files. If there was "
6217 "any previous Augeas handle associated with this guestfs session, then it is "
6222 #: ../src/guestfs-actions.pod:373
6223 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6227 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6228 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6232 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6234 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6235 "logical I<or> of the following integers:"
6239 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6240 msgid "C<AUG_SAVE_BACKUP> = 1"
6244 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6245 msgid "Keep the original file with a C<.augsave> extension."
6249 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6250 msgid "C<AUG_SAVE_NEWFILE> = 2"
6254 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6256 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6257 "original. Overrides C<AUG_SAVE_BACKUP>."
6261 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6262 msgid "C<AUG_TYPE_CHECK> = 4"
6266 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6267 msgid "Typecheck lenses (can be expensive)."
6271 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6272 msgid "C<AUG_NO_STDINC> = 8"
6276 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6277 msgid "Do not use standard load path for modules."
6281 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6282 msgid "C<AUG_SAVE_NOOP> = 16"
6286 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6287 msgid "Make save a no-op, just record what would have been changed."
6291 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6292 msgid "C<AUG_NO_LOAD> = 32"
6296 #: ../src/guestfs-actions.pod:408
6297 msgid "Do not load the tree in C<guestfs_aug_init>."
6301 #: ../src/guestfs-actions.pod:412
6302 msgid "To close the handle, you can call C<guestfs_aug_close>."
6306 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6307 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6311 #: ../src/guestfs-actions.pod:420
6312 msgid "guestfs_aug_insert"
6316 #: ../src/guestfs-actions.pod:422
6320 " guestfs_aug_insert (guestfs_h *g,\n"
6321 " const char *augpath,\n"
6322 " const char *label,\n"
6328 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6330 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6331 "or after C<path> (depending on the boolean flag C<before>)."
6335 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6337 "C<path> must match exactly one existing node in the tree, and C<label> must "
6338 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6342 #: ../src/guestfs-actions.pod:440
6343 msgid "guestfs_aug_load"
6347 #: ../src/guestfs-actions.pod:442
6351 " guestfs_aug_load (guestfs_h *g);\n"
6356 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6357 msgid "Load files into the tree."
6361 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6362 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6366 #: ../src/guestfs-actions.pod:454
6367 msgid "guestfs_aug_ls"
6371 #: ../src/guestfs-actions.pod:456
6375 " guestfs_aug_ls (guestfs_h *g,\n"
6376 " const char *augpath);\n"
6381 #: ../src/guestfs-actions.pod:460
6383 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6384 "sorting the resulting nodes into alphabetical order."
6388 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388 ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070 ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282 ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7470
6390 "This function returns a NULL-terminated array of strings (like "
6391 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6392 "strings and the array after use>."
6396 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782 ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7270
6397 msgid "(Added in 0.8)"
6401 #: ../src/guestfs-actions.pod:469
6402 msgid "guestfs_aug_match"
6406 #: ../src/guestfs-actions.pod:471
6410 " guestfs_aug_match (guestfs_h *g,\n"
6411 " const char *augpath);\n"
6416 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6418 "Returns a list of paths which match the path expression C<path>. The "
6419 "returned paths are sufficiently qualified so that they match exactly one "
6420 "node in the current tree."
6424 #: ../src/guestfs-actions.pod:485
6425 msgid "guestfs_aug_mv"
6429 #: ../src/guestfs-actions.pod:487
6433 " guestfs_aug_mv (guestfs_h *g,\n"
6434 " const char *src,\n"
6435 " const char *dest);\n"
6440 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6442 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6443 "C<dest> is overwritten if it exists."
6447 #: ../src/guestfs-actions.pod:499
6448 msgid "guestfs_aug_rm"
6452 #: ../src/guestfs-actions.pod:501
6456 " guestfs_aug_rm (guestfs_h *g,\n"
6457 " const char *augpath);\n"
6462 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6463 msgid "Remove C<path> and all of its children."
6467 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6468 msgid "On success this returns the number of entries which were removed."
6472 #: ../src/guestfs-actions.pod:513
6473 msgid "guestfs_aug_save"
6477 #: ../src/guestfs-actions.pod:515
6481 " guestfs_aug_save (guestfs_h *g);\n"
6486 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6487 msgid "This writes all pending changes to disk."
6491 #: ../src/guestfs-actions.pod:520
6493 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6498 #: ../src/guestfs-actions.pod:527
6499 msgid "guestfs_aug_set"
6503 #: ../src/guestfs-actions.pod:529
6507 " guestfs_aug_set (guestfs_h *g,\n"
6508 " const char *augpath,\n"
6509 " const char *val);\n"
6514 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6515 msgid "Set the value associated with C<path> to C<val>."
6519 #: ../src/guestfs-actions.pod:536
6521 "In the Augeas API, it is possible to clear a node by setting the value to "
6522 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6523 "this call. Instead you must use the C<guestfs_aug_clear> call."
6527 #: ../src/guestfs-actions.pod:545
6528 msgid "guestfs_available"
6532 #: ../src/guestfs-actions.pod:547
6536 " guestfs_available (guestfs_h *g,\n"
6537 " char *const *groups);\n"
6542 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6544 "This command is used to check the availability of some groups of "
6545 "functionality in the appliance, which not all builds of the libguestfs "
6546 "appliance will be able to provide."
6550 #: ../src/guestfs-actions.pod:555
6552 "The libguestfs groups, and the functions that those groups correspond to, "
6553 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6554 "runtime by calling C<guestfs_available_all_groups>."
6558 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6560 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6561 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6562 "and Augeas (configuration file editing) functions."
6566 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6567 msgid "The command returns no error if I<all> requested groups are available."
6571 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6573 "It fails with an error if one or more of the requested groups is unavailable "
6578 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6580 "If an unknown group name is included in the list of groups then an error is "
6585 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6590 #: ../src/guestfs-actions.pod:579
6591 msgid "You must call C<guestfs_launch> before calling this function."
6595 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6597 "The reason is because we don't know what groups are supported by the "
6598 "appliance/daemon until it is running and can be queried."
6602 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6604 "If a group of functions is available, this does not necessarily mean that "
6605 "they will work. You still have to check for errors when calling individual "
6606 "API functions even if they are available."
6610 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6612 "It is usually the job of distro packagers to build complete functionality "
6613 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6614 "with all requirements satisfied, will support everything."
6618 #: ../src/guestfs-actions.pod:601
6620 "This call was added in version C<1.0.80>. In previous versions of "
6621 "libguestfs all you could do would be to speculatively execute a command to "
6622 "find out if the daemon implemented it. See also C<guestfs_version>."
6626 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6627 msgid "(Added in 1.0.80)"
6631 #: ../src/guestfs-actions.pod:612
6632 msgid "guestfs_available_all_groups"
6636 #: ../src/guestfs-actions.pod:614
6640 " guestfs_available_all_groups (guestfs_h *g);\n"
6645 #: ../src/guestfs-actions.pod:617
6647 "This command returns a list of all optional groups that this daemon knows "
6648 "about. Note this returns both supported and unsupported groups. To find "
6649 "out which ones the daemon can actually support you have to call "
6650 "C<guestfs_available> on each member of the returned list."
6654 #: ../src/guestfs-actions.pod:623
6655 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6659 #: ../src/guestfs-actions.pod:629
6660 msgid "(Added in 1.3.15)"
6664 #: ../src/guestfs-actions.pod:631
6665 msgid "guestfs_base64_in"
6669 #: ../src/guestfs-actions.pod:633
6673 " guestfs_base64_in (guestfs_h *g,\n"
6674 " const char *base64file,\n"
6675 " const char *filename);\n"
6680 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6681 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6685 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6686 msgid "(Added in 1.3.5)"
6690 #: ../src/guestfs-actions.pod:645
6691 msgid "guestfs_base64_out"
6695 #: ../src/guestfs-actions.pod:647
6699 " guestfs_base64_out (guestfs_h *g,\n"
6700 " const char *filename,\n"
6701 " const char *base64file);\n"
6706 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6708 "This command downloads the contents of C<filename>, writing it out to local "
6709 "file C<base64file> encoded as base64."
6713 #: ../src/guestfs-actions.pod:659
6714 msgid "guestfs_blockdev_flushbufs"
6718 #: ../src/guestfs-actions.pod:661
6722 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6723 " const char *device);\n"
6728 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6729 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6733 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813 ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459 ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503 ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522 ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
6734 msgid "This uses the L<blockdev(8)> command."
6738 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720 ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757 ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789 ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
6739 msgid "(Added in 0.9.3)"
6743 #: ../src/guestfs-actions.pod:674
6744 msgid "guestfs_blockdev_getbsz"
6748 #: ../src/guestfs-actions.pod:676
6752 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6753 " const char *device);\n"
6758 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6759 msgid "This returns the block size of a device."
6763 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6765 "(Note this is different from both I<size in blocks> and I<filesystem block "
6770 #: ../src/guestfs-actions.pod:691
6771 msgid "guestfs_blockdev_getro"
6775 #: ../src/guestfs-actions.pod:693
6779 " guestfs_blockdev_getro (guestfs_h *g,\n"
6780 " const char *device);\n"
6785 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6787 "Returns a boolean indicating if the block device is read-only (true if "
6788 "read-only, false if not)."
6792 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914 ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
6793 msgid "This function returns a C truth value on success or -1 on error."
6797 #: ../src/guestfs-actions.pod:706
6798 msgid "guestfs_blockdev_getsize64"
6802 #: ../src/guestfs-actions.pod:708
6806 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6807 " const char *device);\n"
6812 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
6813 msgid "This returns the size of the device in bytes."
6817 #: ../src/guestfs-actions.pod:714
6818 msgid "See also C<guestfs_blockdev_getsz>."
6822 #: ../src/guestfs-actions.pod:722
6823 msgid "guestfs_blockdev_getss"
6827 #: ../src/guestfs-actions.pod:724
6831 " guestfs_blockdev_getss (guestfs_h *g,\n"
6832 " const char *device);\n"
6837 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
6839 "This returns the size of sectors on a block device. Usually 512, but can be "
6840 "larger for modern devices."
6844 #: ../src/guestfs-actions.pod:731
6846 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6851 #: ../src/guestfs-actions.pod:740
6852 msgid "guestfs_blockdev_getsz"
6856 #: ../src/guestfs-actions.pod:742
6860 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6861 " const char *device);\n"
6866 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
6868 "This returns the size of the device in units of 512-byte sectors (even if "
6869 "the sectorsize isn't 512 bytes ... weird)."
6873 #: ../src/guestfs-actions.pod:749
6875 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6876 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6880 #: ../src/guestfs-actions.pod:759
6881 msgid "guestfs_blockdev_rereadpt"
6885 #: ../src/guestfs-actions.pod:761
6889 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6890 " const char *device);\n"
6895 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
6896 msgid "Reread the partition table on C<device>."
6900 #: ../src/guestfs-actions.pod:773
6901 msgid "guestfs_blockdev_setbsz"
6905 #: ../src/guestfs-actions.pod:775
6909 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6910 " const char *device,\n"
6911 " int blocksize);\n"
6916 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
6917 msgid "This sets the block size of a device."
6921 #: ../src/guestfs-actions.pod:791
6922 msgid "guestfs_blockdev_setro"
6926 #: ../src/guestfs-actions.pod:793
6930 " guestfs_blockdev_setro (guestfs_h *g,\n"
6931 " const char *device);\n"
6936 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
6937 msgid "Sets the block device named C<device> to read-only."
6941 #: ../src/guestfs-actions.pod:805
6942 msgid "guestfs_blockdev_setrw"
6946 #: ../src/guestfs-actions.pod:807
6950 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6951 " const char *device);\n"
6956 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
6957 msgid "Sets the block device named C<device> to read-write."
6961 #: ../src/guestfs-actions.pod:819
6962 msgid "guestfs_case_sensitive_path"
6966 #: ../src/guestfs-actions.pod:821
6970 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6971 " const char *path);\n"
6976 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
6978 "This can be used to resolve case insensitive paths on a filesystem which is "
6979 "case sensitive. The use case is to resolve paths which you have read from "
6980 "Windows configuration files or the Windows Registry, to the true path."
6984 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
6986 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6987 "(and probably others), which is that although the underlying filesystem is "
6988 "case-insensitive, the driver exports the filesystem to Linux as "
6993 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
6995 "One consequence of this is that special directories such as C<c:\\windows> "
6996 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6997 "precise details of how they were created. In Windows itself this would not "
7002 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7004 "Bug or feature? You decide: "
7005 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7009 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7011 "This function resolves the true case of each element in the path and returns "
7012 "the case-sensitive path."
7016 #: ../src/guestfs-actions.pod:847
7018 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7019 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7020 "how the directories were originally created under Windows)."
7024 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7025 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7029 #: ../src/guestfs-actions.pod:855
7030 msgid "See also C<guestfs_realpath>."
7034 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
7035 msgid "(Added in 1.0.75)"
7039 #: ../src/guestfs-actions.pod:862
7044 #: ../src/guestfs-actions.pod:864
7048 " guestfs_cat (guestfs_h *g,\n"
7049 " const char *path);\n"
7054 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
7055 msgid "Return the contents of the file named C<path>."
7059 #: ../src/guestfs-actions.pod:870
7061 "Note that this function cannot correctly handle binary files (specifically, "
7062 "files containing C<\\0> character which is treated as end of string). For "
7063 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7064 "functions which have a more complex interface."
7068 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495 ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286 ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390 ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587 ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734 ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920 ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493 ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556 ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529 ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620 ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652 ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324 ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424 ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852 ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879 ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937 ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
7070 "Because of the message protocol, there is a transfer limit of somewhere "
7071 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7075 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7135
7076 msgid "(Added in 0.4)"
7080 #: ../src/guestfs-actions.pod:883
7081 msgid "guestfs_checksum"
7085 #: ../src/guestfs-actions.pod:885
7089 " guestfs_checksum (guestfs_h *g,\n"
7090 " const char *csumtype,\n"
7091 " const char *path);\n"
7096 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7097 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7101 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7103 "The type of checksum to compute is given by the C<csumtype> parameter which "
7104 "must have one of the following values:"
7108 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7113 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7115 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7120 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7125 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7126 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7130 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7135 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7136 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7140 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7145 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7146 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7150 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7155 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7156 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7160 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7165 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7166 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7170 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7175 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7176 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7180 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7181 msgid "The checksum is returned as a printable string."
7185 #: ../src/guestfs-actions.pod:931
7186 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7190 #: ../src/guestfs-actions.pod:933
7191 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7195 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
7196 msgid "(Added in 1.0.2)"
7200 #: ../src/guestfs-actions.pod:940
7201 msgid "guestfs_checksum_device"
7205 #: ../src/guestfs-actions.pod:942
7209 " guestfs_checksum_device (guestfs_h *g,\n"
7210 " const char *csumtype,\n"
7211 " const char *device);\n"
7216 #: ../src/guestfs-actions.pod:947
7218 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7219 "device named C<device>. For the types of checksums supported see the "
7220 "C<guestfs_checksum> command."
7224 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:7147
7225 msgid "(Added in 1.3.2)"
7229 #: ../src/guestfs-actions.pod:956
7230 msgid "guestfs_checksums_out"
7234 #: ../src/guestfs-actions.pod:958
7238 " guestfs_checksums_out (guestfs_h *g,\n"
7239 " const char *csumtype,\n"
7240 " const char *directory,\n"
7241 " const char *sumsfile);\n"
7246 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7248 "This command computes the checksums of all regular files in C<directory> and "
7249 "then emits a list of those checksums to the local output file C<sumsfile>."
7253 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7255 "This can be used for verifying the integrity of a virtual machine. However "
7256 "to be properly secure you should pay attention to the output of the checksum "
7257 "command (it uses the ones from GNU coreutils). In particular when the "
7258 "filename is not printable, coreutils uses a special backslash syntax. For "
7259 "more information, see the GNU coreutils info file."
7263 #: ../src/guestfs-actions.pod:978
7264 msgid "(Added in 1.3.7)"
7268 #: ../src/guestfs-actions.pod:980
7269 msgid "guestfs_chmod"
7273 #: ../src/guestfs-actions.pod:982
7277 " guestfs_chmod (guestfs_h *g,\n"
7279 " const char *path);\n"
7284 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7286 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7291 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7293 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7294 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7299 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104 ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
7300 msgid "The mode actually set is affected by the umask."
7304 #: ../src/guestfs-actions.pod:1000
7305 msgid "guestfs_chown"
7309 #: ../src/guestfs-actions.pod:1002
7313 " guestfs_chown (guestfs_h *g,\n"
7316 " const char *path);\n"
7321 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7322 msgid "Change the file owner to C<owner> and group to C<group>."
7326 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
7328 "Only numeric uid and gid are supported. If you want to use names, you will "
7329 "need to locate and parse the password file yourself (Augeas support makes "
7330 "this relatively easy)."
7334 #: ../src/guestfs-actions.pod:1018
7335 msgid "guestfs_command"
7339 #: ../src/guestfs-actions.pod:1020
7343 " guestfs_command (guestfs_h *g,\n"
7344 " char *const *arguments);\n"
7349 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7351 "This call runs a command from the guest filesystem. The filesystem must be "
7352 "mounted, and must contain a compatible operating system (ie. something "
7353 "Linux, with the same or compatible processor architecture)."
7357 #: ../src/guestfs-actions.pod:1029
7359 "The single parameter is an argv-style list of arguments. The first element "
7360 "is the name of the program to run. Subsequent elements are parameters. The "
7361 "list must be non-empty (ie. must contain a program name). Note that the "
7362 "command runs directly, and is I<not> invoked via the shell (see "
7367 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7368 msgid "The return value is anything printed to I<stdout> by the command."
7372 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7374 "If the command returns a non-zero exit status, then this function returns an "
7375 "error message. The error message string is the content of I<stderr> from "
7380 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7382 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7383 "C</bin>. If you require a program from another location, you should provide "
7384 "the full path in the first parameter."
7388 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7390 "Shared libraries and data files required by the program must be available on "
7391 "filesystems which are mounted in the correct places. It is the caller's "
7392 "responsibility to ensure all filesystems that are needed are mounted at the "
7397 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1548
7398 msgid "(Added in 0.9.1)"
7402 #: ../src/guestfs-actions.pod:1062
7403 msgid "guestfs_command_lines"
7407 #: ../src/guestfs-actions.pod:1064
7411 " guestfs_command_lines (guestfs_h *g,\n"
7412 " char *const *arguments);\n"
7417 #: ../src/guestfs-actions.pod:1068
7419 "This is the same as C<guestfs_command>, but splits the result into a list of "
7424 #: ../src/guestfs-actions.pod:1071
7425 msgid "See also: C<guestfs_sh_lines>"
7429 #: ../src/guestfs-actions.pod:1082
7430 msgid "guestfs_config"
7434 #: ../src/guestfs-actions.pod:1084
7438 " guestfs_config (guestfs_h *g,\n"
7439 " const char *qemuparam,\n"
7440 " const char *qemuvalue);\n"
7445 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7447 "This can be used to add arbitrary qemu command line parameters of the form "
7448 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7449 "setting some parameters which would interfere with parameters that we use."
7453 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7454 msgid "The first character of C<param> string must be a C<-> (dash)."
7458 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7459 msgid "C<value> can be NULL."
7463 #: ../src/guestfs-actions.pod:1102
7464 msgid "guestfs_copy_size"
7468 #: ../src/guestfs-actions.pod:1104
7472 " guestfs_copy_size (guestfs_h *g,\n"
7473 " const char *src,\n"
7474 " const char *dest,\n"
7480 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7482 "This command copies exactly C<size> bytes from one source device or file "
7483 "C<src> to another destination device or file C<dest>."
7487 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7489 "Note this will fail if the source is too short or if the destination is not "
7494 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326 ../src/guestfs-actions.pod:7345
7496 "This long-running command can generate progress notification messages so "
7497 "that the caller can display a progress bar or indicator. To receive these "
7498 "messages, the caller must register a progress event callback. See "
7499 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7503 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
7504 msgid "(Added in 1.0.87)"
7508 #: ../src/guestfs-actions.pod:1125
7513 #: ../src/guestfs-actions.pod:1127
7517 " guestfs_cp (guestfs_h *g,\n"
7518 " const char *src,\n"
7519 " const char *dest);\n"
7524 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7526 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7527 "destination filename or destination directory."
7531 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151 ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:5217
7532 msgid "(Added in 1.0.18)"
7536 #: ../src/guestfs-actions.pod:1139
7537 msgid "guestfs_cp_a"
7541 #: ../src/guestfs-actions.pod:1141
7545 " guestfs_cp_a (guestfs_h *g,\n"
7546 " const char *src,\n"
7547 " const char *dest);\n"
7552 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7554 "This copies a file or directory from C<src> to C<dest> recursively using the "
7559 #: ../src/guestfs-actions.pod:1153
7564 #: ../src/guestfs-actions.pod:1155
7568 " guestfs_dd (guestfs_h *g,\n"
7569 " const char *src,\n"
7570 " const char *dest);\n"
7575 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7577 "This command copies from one source device or file C<src> to another "
7578 "destination device or file C<dest>. Normally you would use this to copy to "
7579 "or from a device or partition, for example to duplicate a filesystem."
7583 #: ../src/guestfs-actions.pod:1165
7585 "If the destination is a device, it must be as large or larger than the "
7586 "source file or device, otherwise the copy will fail. This command cannot do "
7587 "partial copies (see C<guestfs_copy_size>)."
7591 #: ../src/guestfs-actions.pod:1173
7596 #: ../src/guestfs-actions.pod:1175
7600 " guestfs_df (guestfs_h *g);\n"
7605 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7606 msgid "This command runs the C<df> command to report disk space used."
7610 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7612 "This command is mostly useful for interactive sessions. It is I<not> "
7613 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7618 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7219
7619 msgid "(Added in 1.0.54)"
7623 #: ../src/guestfs-actions.pod:1189
7624 msgid "guestfs_df_h"
7628 #: ../src/guestfs-actions.pod:1191
7632 " guestfs_df_h (guestfs_h *g);\n"
7637 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7639 "This command runs the C<df -h> command to report disk space used in "
7640 "human-readable format."
7644 #: ../src/guestfs-actions.pod:1206
7645 msgid "guestfs_dmesg"
7649 #: ../src/guestfs-actions.pod:1208
7653 " guestfs_dmesg (guestfs_h *g);\n"
7658 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7660 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7661 "This is sometimes useful for extended debugging of problems."
7665 #: ../src/guestfs-actions.pod:1215
7667 "Another way to get the same information is to enable verbose messages with "
7668 "C<guestfs_set_verbose> or by setting the environment variable "
7669 "C<LIBGUESTFS_DEBUG=1> before running the program."
7673 #: ../src/guestfs-actions.pod:1225
7674 msgid "guestfs_download"
7678 #: ../src/guestfs-actions.pod:1227
7682 " guestfs_download (guestfs_h *g,\n"
7683 " const char *remotefilename,\n"
7684 " const char *filename);\n"
7689 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7691 "Download file C<remotefilename> and save it as C<filename> on the local "
7696 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
7697 msgid "C<filename> can also be a named pipe."
7701 #: ../src/guestfs-actions.pod:1237
7702 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7706 #: ../src/guestfs-actions.pod:1248
7707 msgid "guestfs_download_offset"
7711 #: ../src/guestfs-actions.pod:1250
7715 " guestfs_download_offset (guestfs_h *g,\n"
7716 " const char *remotefilename,\n"
7717 " const char *filename,\n"
7718 " int64_t offset,\n"
7724 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7726 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7727 "region must be within the file or device)."
7731 #: ../src/guestfs-actions.pod:1263
7733 "Note that there is no limit on the amount of data that can be downloaded "
7734 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7735 "full amount unless an error occurs."
7739 #: ../src/guestfs-actions.pod:1268
7740 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7744 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
7745 msgid "(Added in 1.5.17)"
7749 #: ../src/guestfs-actions.pod:1279
7750 msgid "guestfs_drop_caches"
7754 #: ../src/guestfs-actions.pod:1281
7758 " guestfs_drop_caches (guestfs_h *g,\n"
7759 " int whattodrop);\n"
7764 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7766 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7767 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7768 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7772 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7773 msgid "Setting C<whattodrop> to 3 should drop everything."
7777 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7779 "This automatically calls L<sync(2)> before the operation, so that the "
7780 "maximum guest memory is freed."
7784 #: ../src/guestfs-actions.pod:1299
7789 #: ../src/guestfs-actions.pod:1301
7793 " guestfs_du (guestfs_h *g,\n"
7794 " const char *path);\n"
7799 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7801 "This command runs the C<du -s> command to estimate file space usage for "
7806 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7808 "C<path> can be a file or a directory. If C<path> is a directory then the "
7809 "estimate includes the contents of the directory and all subdirectories "
7814 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
7815 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7819 #: ../src/guestfs-actions.pod:1324
7820 msgid "guestfs_e2fsck_f"
7824 #: ../src/guestfs-actions.pod:1326
7828 " guestfs_e2fsck_f (guestfs_h *g,\n"
7829 " const char *device);\n"
7834 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
7836 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7837 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7842 #: ../src/guestfs-actions.pod:1334
7844 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7845 "Normally you should use C<guestfs_fsck>."
7849 #: ../src/guestfs-actions.pod:1339
7850 msgid "(Added in 1.0.29)"
7854 #: ../src/guestfs-actions.pod:1341
7855 msgid "guestfs_echo_daemon"
7859 #: ../src/guestfs-actions.pod:1343
7863 " guestfs_echo_daemon (guestfs_h *g,\n"
7864 " char *const *words);\n"
7869 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
7871 "This command concatenates the list of C<words> passed with single spaces "
7872 "between them and returns the resulting string."
7876 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
7877 msgid "You can use this command to test the connection through to the daemon."
7881 #: ../src/guestfs-actions.pod:1352
7882 msgid "See also C<guestfs_ping_daemon>."
7886 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6051
7887 msgid "(Added in 1.0.69)"
7891 #: ../src/guestfs-actions.pod:1359
7892 msgid "guestfs_egrep"
7896 #: ../src/guestfs-actions.pod:1361
7900 " guestfs_egrep (guestfs_h *g,\n"
7901 " const char *regex,\n"
7902 " const char *path);\n"
7907 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
7908 msgid "This calls the external C<egrep> program and returns the matching lines."
7912 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395 ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427 ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308 ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
7913 msgid "(Added in 1.0.66)"
7917 #: ../src/guestfs-actions.pod:1378
7918 msgid "guestfs_egrepi"
7922 #: ../src/guestfs-actions.pod:1380
7926 " guestfs_egrepi (guestfs_h *g,\n"
7927 " const char *regex,\n"
7928 " const char *path);\n"
7933 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
7934 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7938 #: ../src/guestfs-actions.pod:1397
7939 msgid "guestfs_equal"
7943 #: ../src/guestfs-actions.pod:1399
7947 " guestfs_equal (guestfs_h *g,\n"
7948 " const char *file1,\n"
7949 " const char *file2);\n"
7954 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
7956 "This compares the two files C<file1> and C<file2> and returns true if their "
7957 "content is exactly equal, or false otherwise."
7961 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
7962 msgid "The external L<cmp(1)> program is used for the comparison."
7966 #: ../src/guestfs-actions.pod:1413
7967 msgid "guestfs_exists"
7971 #: ../src/guestfs-actions.pod:1415
7975 " guestfs_exists (guestfs_h *g,\n"
7976 " const char *path);\n"
7981 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
7983 "This returns C<true> if and only if there is a file, directory (or anything) "
7984 "with the given C<path> name."
7988 #: ../src/guestfs-actions.pod:1422
7989 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7993 #: ../src/guestfs-actions.pod:1428
7994 msgid "guestfs_fallocate"
7998 #: ../src/guestfs-actions.pod:1430
8002 " guestfs_fallocate (guestfs_h *g,\n"
8003 " const char *path,\n"
8009 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8011 "This command preallocates a file (containing zero bytes) named C<path> of "
8012 "size C<len> bytes. If the file exists already, it is overwritten."
8016 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8018 "Do not confuse this with the guestfish-specific C<alloc> command which "
8019 "allocates a file in the host and attaches it as a device."
8023 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8025 "This function is deprecated. In new code, use the C<fallocate64> call "
8030 #: ../src/guestfs-actions.pod:1454
8031 msgid "guestfs_fallocate64"
8035 #: ../src/guestfs-actions.pod:1456
8039 " guestfs_fallocate64 (guestfs_h *g,\n"
8040 " const char *path,\n"
8046 #: ../src/guestfs-actions.pod:1465
8048 "Note that this call allocates disk blocks for the file. To create a sparse "
8049 "file use C<guestfs_truncate_size> instead."
8053 #: ../src/guestfs-actions.pod:1468
8055 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8056 "oversight it only allowed 30 bit lengths to be specified, effectively "
8057 "limiting the maximum size of files created through that call to 1GB."
8061 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8063 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8064 "commands which create a file in the host and attach it as a device."
8068 #: ../src/guestfs-actions.pod:1479
8069 msgid "(Added in 1.3.17)"
8073 #: ../src/guestfs-actions.pod:1481
8074 msgid "guestfs_fgrep"
8078 #: ../src/guestfs-actions.pod:1483
8082 " guestfs_fgrep (guestfs_h *g,\n"
8083 " const char *pattern,\n"
8084 " const char *path);\n"
8089 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8090 msgid "This calls the external C<fgrep> program and returns the matching lines."
8094 #: ../src/guestfs-actions.pod:1500
8095 msgid "guestfs_fgrepi"
8099 #: ../src/guestfs-actions.pod:1502
8103 " guestfs_fgrepi (guestfs_h *g,\n"
8104 " const char *pattern,\n"
8105 " const char *path);\n"
8110 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8111 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8115 #: ../src/guestfs-actions.pod:1519
8116 msgid "guestfs_file"
8120 #: ../src/guestfs-actions.pod:1521
8124 " guestfs_file (guestfs_h *g,\n"
8125 " const char *path);\n"
8130 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8132 "This call uses the standard L<file(1)> command to determine the type or "
8133 "contents of the file."
8137 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8139 "This call will also transparently look inside various types of compressed "
8144 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8146 "The exact command which runs is C<file -zb path>. Note in particular that "
8147 "the filename is not prepended to the output (the C<-b> option)."
8151 #: ../src/guestfs-actions.pod:1535
8153 "This command can also be used on C</dev/> devices (and partitions, LV "
8154 "names). You can for example use this to determine if a device contains a "
8155 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8159 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8161 "If the C<path> does not begin with C</dev/> then this command only works for "
8162 "the content of regular files. For other file types (directory, symbolic "
8163 "link etc) it will just return the string C<directory> etc."
8167 #: ../src/guestfs-actions.pod:1550
8168 msgid "guestfs_file_architecture"
8172 #: ../src/guestfs-actions.pod:1552
8176 " guestfs_file_architecture (guestfs_h *g,\n"
8177 " const char *filename);\n"
8182 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8184 "This detects the architecture of the binary C<filename>, and returns it if "
8189 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8190 msgid "Currently defined architectures are:"
8194 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8199 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8201 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8202 "irrespective of the precise processor requirements of the binary."
8206 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8211 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8212 msgid "64 bit x86-64."
8216 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8221 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8222 msgid "32 bit SPARC."
8226 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8231 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8232 msgid "64 bit SPARC V9 and above."
8236 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8241 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8242 msgid "Intel Itanium."
8246 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8251 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8252 msgid "32 bit Power PC."
8256 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8261 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8262 msgid "64 bit Power PC."
8266 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8267 msgid "Libguestfs may return other architecture strings in future."
8271 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8272 msgid "The function works on at least the following types of files:"
8276 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8277 msgid "many types of Un*x and Linux binary"
8281 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8282 msgid "many types of Un*x and Linux shared library"
8286 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8287 msgid "Windows Win32 and Win64 binaries"
8291 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8292 msgid "Windows Win32 and Win64 DLLs"
8296 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8297 msgid "Win32 binaries and DLLs return C<i386>."
8301 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8302 msgid "Win64 binaries and DLLs return C<x86_64>."
8306 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8307 msgid "Linux kernel modules"
8311 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8312 msgid "Linux new-style initrd images"
8316 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8317 msgid "some non-x86 Linux vmlinuz kernels"
8321 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8322 msgid "What it can't do currently:"
8326 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8327 msgid "static libraries (libfoo.a)"
8331 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8332 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8336 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8337 msgid "x86 Linux vmlinuz kernels"
8341 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8343 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8344 "compressed code, and are horribly hard to unpack. If you want to find the "
8345 "architecture of a kernel, use the architecture of the associated initrd or "
8346 "kernel module(s) instead."
8350 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266 ../src/guestfs-actions.pod:3398
8351 msgid "(Added in 1.5.3)"
8355 #: ../src/guestfs-actions.pod:1662
8356 msgid "guestfs_filesize"
8360 #: ../src/guestfs-actions.pod:1664
8364 " guestfs_filesize (guestfs_h *g,\n"
8365 " const char *file);\n"
8370 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8371 msgid "This command returns the size of C<file> in bytes."
8375 #: ../src/guestfs-actions.pod:1670
8377 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8378 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8379 "devices, use C<guestfs_blockdev_getsize64>."
8383 #: ../src/guestfs-actions.pod:1676
8384 msgid "(Added in 1.0.82)"
8388 #: ../src/guestfs-actions.pod:1678
8389 msgid "guestfs_fill"
8393 #: ../src/guestfs-actions.pod:1680
8397 " guestfs_fill (guestfs_h *g,\n"
8400 " const char *path);\n"
8405 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8407 "This command creates a new file called C<path>. The initial content of the "
8408 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8413 #: ../src/guestfs-actions.pod:1690
8415 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8416 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8417 "bytes use C<guestfs_fill_pattern>."
8421 #: ../src/guestfs-actions.pod:1702
8422 msgid "(Added in 1.0.79)"
8426 #: ../src/guestfs-actions.pod:1704
8427 msgid "guestfs_fill_pattern"
8431 #: ../src/guestfs-actions.pod:1706
8435 " guestfs_fill_pattern (guestfs_h *g,\n"
8436 " const char *pattern,\n"
8438 " const char *path);\n"
8443 #: ../src/guestfs-actions.pod:1712
8445 "This function is like C<guestfs_fill> except that it creates a new file of "
8446 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8447 "pattern is truncated if necessary to ensure the length of the file is "
8448 "exactly C<len> bytes."
8452 #: ../src/guestfs-actions.pod:1724
8453 msgid "(Added in 1.3.12)"
8457 #: ../src/guestfs-actions.pod:1726
8458 msgid "guestfs_find"
8462 #: ../src/guestfs-actions.pod:1728
8466 " guestfs_find (guestfs_h *g,\n"
8467 " const char *directory);\n"
8472 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8474 "This command lists out all files and directories, recursively, starting at "
8475 "C<directory>. It is essentially equivalent to running the shell command "
8476 "C<find directory -print> but some post-processing happens on the output, "
8481 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8483 "This returns a list of strings I<without any prefix>. Thus if the directory "
8488 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8498 #: ../src/guestfs-actions.pod:1744
8499 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8503 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8514 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8515 msgid "If C<directory> is not a directory, then this command returns an error."
8519 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8520 msgid "The returned list is sorted."
8524 #: ../src/guestfs-actions.pod:1757
8525 msgid "See also C<guestfs_find0>."
8529 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:5635
8530 msgid "(Added in 1.0.27)"
8534 #: ../src/guestfs-actions.pod:1768
8535 msgid "guestfs_find0"
8539 #: ../src/guestfs-actions.pod:1770
8543 " guestfs_find0 (guestfs_h *g,\n"
8544 " const char *directory,\n"
8545 " const char *files);\n"
8550 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8552 "This command lists out all files and directories, recursively, starting at "
8553 "C<directory>, placing the resulting list in the external file called "
8558 #: ../src/guestfs-actions.pod:1779
8560 "This command works the same way as C<guestfs_find> with the following "
8565 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8566 msgid "The resulting list is written to an external file."
8570 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
8572 "Items (filenames) in the result are separated by C<\\0> characters. See "
8573 "L<find(1)> option I<-print0>."
8577 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
8578 msgid "This command is not limited in the number of names that it can return."
8582 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
8583 msgid "The result list is not sorted."
8587 #: ../src/guestfs-actions.pod:1806
8588 msgid "(Added in 1.0.74)"
8592 #: ../src/guestfs-actions.pod:1808
8593 msgid "guestfs_findfs_label"
8597 #: ../src/guestfs-actions.pod:1810
8601 " guestfs_findfs_label (guestfs_h *g,\n"
8602 " const char *label);\n"
8607 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
8609 "This command searches the filesystems and returns the one which has the "
8610 "given label. An error is returned if no such filesystem can be found."
8614 #: ../src/guestfs-actions.pod:1818
8615 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8619 #: ../src/guestfs-actions.pod:1825
8620 msgid "guestfs_findfs_uuid"
8624 #: ../src/guestfs-actions.pod:1827
8628 " guestfs_findfs_uuid (guestfs_h *g,\n"
8629 " const char *uuid);\n"
8634 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
8636 "This command searches the filesystems and returns the one which has the "
8637 "given UUID. An error is returned if no such filesystem can be found."
8641 #: ../src/guestfs-actions.pod:1835
8642 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8646 #: ../src/guestfs-actions.pod:1842
8647 msgid "guestfs_fsck"
8651 #: ../src/guestfs-actions.pod:1844
8655 " guestfs_fsck (guestfs_h *g,\n"
8656 " const char *fstype,\n"
8657 " const char *device);\n"
8662 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
8664 "This runs the filesystem checker (fsck) on C<device> which should have "
8665 "filesystem type C<fstype>."
8669 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
8671 "The returned integer is the status. See L<fsck(8)> for the list of status "
8672 "codes from C<fsck>."
8676 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
8677 msgid "Multiple status codes can be summed together."
8681 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
8683 "A non-zero return code can mean \"success\", for example if errors have been "
8684 "corrected on the filesystem."
8688 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
8689 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8693 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
8694 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8698 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
8699 msgid "(Added in 1.0.16)"
8703 #: ../src/guestfs-actions.pod:1881
8704 msgid "guestfs_get_append"
8708 #: ../src/guestfs-actions.pod:1883
8712 " guestfs_get_append (guestfs_h *g);\n"
8717 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
8719 "Return the additional kernel options which are added to the guest kernel "
8724 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
8725 msgid "If C<NULL> then no options are added."
8729 #: ../src/guestfs-actions.pod:1891
8731 "This function returns a string which may be NULL. There is no way to return "
8732 "an error from this function. The string is owned by the guest handle and "
8733 "must I<not> be freed."
8737 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
8738 msgid "(Added in 1.0.26)"
8742 #: ../src/guestfs-actions.pod:1897
8743 msgid "guestfs_get_attach_method"
8747 #: ../src/guestfs-actions.pod:1899
8751 " guestfs_get_attach_method (guestfs_h *g);\n"
8756 #: ../src/guestfs-actions.pod:1902
8757 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8761 #: ../src/guestfs-actions.pod:1907
8762 msgid "guestfs_get_autosync"
8766 #: ../src/guestfs-actions.pod:1909
8770 " guestfs_get_autosync (guestfs_h *g);\n"
8775 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
8776 msgid "Get the autosync flag."
8780 #: ../src/guestfs-actions.pod:1918
8781 msgid "guestfs_get_direct"
8785 #: ../src/guestfs-actions.pod:1920
8789 " guestfs_get_direct (guestfs_h *g);\n"
8794 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
8795 msgid "Return the direct appliance mode flag."
8799 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
8800 msgid "(Added in 1.0.72)"
8804 #: ../src/guestfs-actions.pod:1929
8805 msgid "guestfs_get_e2label"
8809 #: ../src/guestfs-actions.pod:1931
8813 " guestfs_get_e2label (guestfs_h *g,\n"
8814 " const char *device);\n"
8819 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
8820 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8824 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
8826 "This function is deprecated. In new code, use the C<vfs_label> call "
8831 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
8832 msgid "(Added in 1.0.15)"
8836 #: ../src/guestfs-actions.pod:1950
8837 msgid "guestfs_get_e2uuid"
8841 #: ../src/guestfs-actions.pod:1952
8845 " guestfs_get_e2uuid (guestfs_h *g,\n"
8846 " const char *device);\n"
8851 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
8852 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8856 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
8857 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8861 #: ../src/guestfs-actions.pod:1971
8862 msgid "guestfs_get_memsize"
8866 #: ../src/guestfs-actions.pod:1973
8870 " guestfs_get_memsize (guestfs_h *g);\n"
8875 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
8876 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8880 #: ../src/guestfs-actions.pod:1979
8882 "If C<guestfs_set_memsize> was not called on this handle, and if "
8883 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8884 "value for memsize."
8888 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022 ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
8889 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8893 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
8894 msgid "(Added in 1.0.55)"
8898 #: ../src/guestfs-actions.pod:1990
8899 msgid "guestfs_get_network"
8903 #: ../src/guestfs-actions.pod:1992
8907 " guestfs_get_network (guestfs_h *g);\n"
8912 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
8913 msgid "This returns the enable network flag."
8917 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
8918 msgid "(Added in 1.5.4)"
8922 #: ../src/guestfs-actions.pod:2001
8923 msgid "guestfs_get_path"
8927 #: ../src/guestfs-actions.pod:2003
8931 " guestfs_get_path (guestfs_h *g);\n"
8936 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
8937 msgid "Return the current search path."
8941 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
8943 "This is always non-NULL. If it wasn't set already, then this will return "
8948 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
8950 "This function returns a string, or NULL on error. The string is owned by "
8951 "the guest handle and must I<not> be freed."
8955 #: ../src/guestfs-actions.pod:2016
8956 msgid "guestfs_get_pid"
8960 #: ../src/guestfs-actions.pod:2018
8964 " guestfs_get_pid (guestfs_h *g);\n"
8969 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
8971 "Return the process ID of the qemu subprocess. If there is no qemu "
8972 "subprocess, then this will return an error."
8976 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
8977 msgid "This is an internal call used for debugging and testing."
8981 #: ../src/guestfs-actions.pod:2028
8982 msgid "(Added in 1.0.56)"
8986 #: ../src/guestfs-actions.pod:2030
8987 msgid "guestfs_get_qemu"
8991 #: ../src/guestfs-actions.pod:2032
8995 " guestfs_get_qemu (guestfs_h *g);\n"
9000 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9001 msgid "Return the current qemu binary."
9005 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9007 "This is always non-NULL. If it wasn't set already, then this will return "
9008 "the default qemu binary name."
9012 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
9013 msgid "(Added in 1.0.6)"
9017 #: ../src/guestfs-actions.pod:2045
9018 msgid "guestfs_get_recovery_proc"
9022 #: ../src/guestfs-actions.pod:2047
9026 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9031 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9032 msgid "Return the recovery process enabled flag."
9036 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:6883
9037 msgid "(Added in 1.0.77)"
9041 #: ../src/guestfs-actions.pod:2056
9042 msgid "guestfs_get_selinux"
9046 #: ../src/guestfs-actions.pod:2058
9050 " guestfs_get_selinux (guestfs_h *g);\n"
9055 #: ../src/guestfs-actions.pod:2061
9057 "This returns the current setting of the selinux flag which is passed to the "
9058 "appliance at boot time. See C<guestfs_set_selinux>."
9062 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
9063 msgid "(Added in 1.0.67)"
9067 #: ../src/guestfs-actions.pod:2071
9068 msgid "guestfs_get_state"
9072 #: ../src/guestfs-actions.pod:2073
9076 " guestfs_get_state (guestfs_h *g);\n"
9081 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9083 "This returns the current state as an opaque integer. This is only useful "
9084 "for printing debug and internal error messages."
9088 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409 ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333 ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
9089 msgid "For more information on states, see L<guestfs(3)>."
9093 #: ../src/guestfs-actions.pod:2085
9094 msgid "guestfs_get_trace"
9098 #: ../src/guestfs-actions.pod:2087
9102 " guestfs_get_trace (guestfs_h *g);\n"
9107 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9108 msgid "Return the command trace flag."
9112 #: ../src/guestfs-actions.pod:2096
9113 msgid "guestfs_get_umask"
9117 #: ../src/guestfs-actions.pod:2098
9121 " guestfs_get_umask (guestfs_h *g);\n"
9126 #: ../src/guestfs-actions.pod:2101
9128 "Return the current umask. By default the umask is C<022> unless it has been "
9129 "set by calling C<guestfs_umask>."
9133 #: ../src/guestfs-actions.pod:2108
9134 msgid "guestfs_get_verbose"
9138 #: ../src/guestfs-actions.pod:2110
9142 " guestfs_get_verbose (guestfs_h *g);\n"
9147 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9148 msgid "This returns the verbose messages flag."
9152 #: ../src/guestfs-actions.pod:2119
9153 msgid "guestfs_getcon"
9157 #: ../src/guestfs-actions.pod:2121
9161 " guestfs_getcon (guestfs_h *g);\n"
9166 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9167 msgid "This gets the SELinux security context of the daemon."
9171 #: ../src/guestfs-actions.pod:2126
9172 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9176 #: ../src/guestfs-actions.pod:2134
9177 msgid "guestfs_getxattr"
9181 #: ../src/guestfs-actions.pod:2136
9185 " guestfs_getxattr (guestfs_h *g,\n"
9186 " const char *path,\n"
9187 " const char *name,\n"
9188 " size_t *size_r);\n"
9193 #: ../src/guestfs-actions.pod:2142
9195 "Get a single extended attribute from file C<path> named C<name>. This call "
9196 "follows symlinks. If you want to lookup an extended attribute for the "
9197 "symlink itself, use C<guestfs_lgetxattr>."
9201 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
9203 "Normally it is better to get all extended attributes from a file in one go "
9204 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9205 "implementations are buggy and do not provide a way to list out attributes. "
9206 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9207 "extended attributes you want in advance and call this function."
9211 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
9213 "Extended attribute values are blobs of binary data. If there is no extended "
9214 "attribute named C<name>, this returns an error."
9218 #: ../src/guestfs-actions.pod:2156
9219 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9223 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
9225 "This function returns a buffer, or NULL on error. The size of the returned "
9226 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9231 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
9232 msgid "(Added in 1.7.24)"
9236 #: ../src/guestfs-actions.pod:2164
9237 msgid "guestfs_getxattrs"
9241 #: ../src/guestfs-actions.pod:2166
9244 " struct guestfs_xattr_list *\n"
9245 " guestfs_getxattrs (guestfs_h *g,\n"
9246 " const char *path);\n"
9251 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9252 msgid "This call lists the extended attributes of the file or directory C<path>."
9256 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9258 "At the system call level, this is a combination of the L<listxattr(2)> and "
9259 "L<getxattr(2)> calls."
9263 #: ../src/guestfs-actions.pod:2176
9264 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9268 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:4186
9270 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9271 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9275 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740 ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:7439
9276 msgid "(Added in 1.0.59)"
9280 #: ../src/guestfs-actions.pod:2184
9281 msgid "guestfs_glob_expand"
9285 #: ../src/guestfs-actions.pod:2186
9289 " guestfs_glob_expand (guestfs_h *g,\n"
9290 " const char *pattern);\n"
9295 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9297 "This command searches for all the pathnames matching C<pattern> according to "
9298 "the wildcard expansion rules used by the shell."
9302 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9303 msgid "If no paths match, then this returns an empty list (note: not an error)."
9307 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9309 "It is just a wrapper around the C L<glob(3)> function with flags "
9310 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9314 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269 ../src/guestfs-actions.pod:6286
9315 msgid "(Added in 1.0.50)"
9319 #: ../src/guestfs-actions.pod:2207
9320 msgid "guestfs_grep"
9324 #: ../src/guestfs-actions.pod:2209
9328 " guestfs_grep (guestfs_h *g,\n"
9329 " const char *regex,\n"
9330 " const char *path);\n"
9335 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9336 msgid "This calls the external C<grep> program and returns the matching lines."
9340 #: ../src/guestfs-actions.pod:2226
9341 msgid "guestfs_grepi"
9345 #: ../src/guestfs-actions.pod:2228
9349 " guestfs_grepi (guestfs_h *g,\n"
9350 " const char *regex,\n"
9351 " const char *path);\n"
9356 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9357 msgid "This calls the external C<grep -i> program and returns the matching lines."
9361 #: ../src/guestfs-actions.pod:2245
9362 msgid "guestfs_grub_install"
9366 #: ../src/guestfs-actions.pod:2247
9370 " guestfs_grub_install (guestfs_h *g,\n"
9371 " const char *root,\n"
9372 " const char *device);\n"
9377 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9379 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9380 "the root directory being C<root>."
9384 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9386 "Note: If grub-install reports the error \"No suitable drive was found in the "
9387 "generated device map.\" it may be that you need to create a "
9388 "C</boot/grub/device.map> file first that contains the mapping between grub "
9389 "device names and Linux device names. It is usually sufficient to create a "
9394 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9402 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9403 msgid "replacing C</dev/vda> with the name of the installation device."
9407 #: ../src/guestfs-actions.pod:2268
9408 msgid "(Added in 1.0.17)"
9412 #: ../src/guestfs-actions.pod:2270
9413 msgid "guestfs_head"
9417 #: ../src/guestfs-actions.pod:2272
9421 " guestfs_head (guestfs_h *g,\n"
9422 " const char *path);\n"
9427 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9429 "This command returns up to the first 10 lines of a file as a list of "
9434 #: ../src/guestfs-actions.pod:2288
9435 msgid "guestfs_head_n"
9439 #: ../src/guestfs-actions.pod:2290
9443 " guestfs_head_n (guestfs_h *g,\n"
9445 " const char *path);\n"
9450 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9452 "If the parameter C<nrlines> is a positive number, this returns the first "
9453 "C<nrlines> lines of the file C<path>."
9457 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9459 "If the parameter C<nrlines> is a negative number, this returns lines from "
9460 "the file C<path>, excluding the last C<nrlines> lines."
9464 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
9465 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9469 #: ../src/guestfs-actions.pod:2312
9470 msgid "guestfs_hexdump"
9474 #: ../src/guestfs-actions.pod:2314
9478 " guestfs_hexdump (guestfs_h *g,\n"
9479 " const char *path);\n"
9484 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9486 "This runs C<hexdump -C> on the given C<path>. The result is the "
9487 "human-readable, canonical hex dump of the file."
9491 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350 ../src/guestfs-actions.pod:6405
9492 msgid "(Added in 1.0.22)"
9496 #: ../src/guestfs-actions.pod:2329
9497 msgid "guestfs_initrd_cat"
9501 #: ../src/guestfs-actions.pod:2331
9505 " guestfs_initrd_cat (guestfs_h *g,\n"
9506 " const char *initrdpath,\n"
9507 " const char *filename,\n"
9508 " size_t *size_r);\n"
9513 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9515 "This command unpacks the file C<filename> from the initrd file called "
9516 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9521 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9523 "For example, in guestfish you could use the following command to examine the "
9524 "boot script (usually called C</init>) contained in a Linux initrd or "
9529 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
9532 " initrd-cat /boot/initrd-<version>.img init\n"
9537 #: ../src/guestfs-actions.pod:2347
9538 msgid "See also C<guestfs_initrd_list>."
9542 #: ../src/guestfs-actions.pod:2358
9543 msgid "guestfs_initrd_list"
9547 #: ../src/guestfs-actions.pod:2360
9551 " guestfs_initrd_list (guestfs_h *g,\n"
9552 " const char *path);\n"
9557 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
9558 msgid "This command lists out files contained in an initrd."
9562 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
9564 "The files are listed without any initial C</> character. The files are "
9565 "listed in the order they appear (not necessarily alphabetical). Directory "
9566 "names are listed as separate items."
9570 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
9572 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9573 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9578 #: ../src/guestfs-actions.pod:2380
9579 msgid "guestfs_inotify_add_watch"
9583 #: ../src/guestfs-actions.pod:2382
9587 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9588 " const char *path,\n"
9594 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
9595 msgid "Watch C<path> for the events listed in C<mask>."
9599 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
9601 "Note that if C<path> is a directory then events within that directory are "
9602 "watched, but this does I<not> happen recursively (in subdirectories)."
9606 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
9608 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9609 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9613 #: ../src/guestfs-actions.pod:2401
9614 msgid "guestfs_inotify_close"
9618 #: ../src/guestfs-actions.pod:2403
9622 " guestfs_inotify_close (guestfs_h *g);\n"
9627 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
9629 "This closes the inotify handle which was previously opened by inotify_init. "
9630 "It removes all watches, throws away any pending events, and deallocates all "
9635 #: ../src/guestfs-actions.pod:2414
9636 msgid "guestfs_inotify_files"
9640 #: ../src/guestfs-actions.pod:2416
9644 " guestfs_inotify_files (guestfs_h *g);\n"
9649 #: ../src/guestfs-actions.pod:2419
9651 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9652 "returns a list of pathnames of objects that were touched. The returned "
9653 "pathnames are sorted and deduplicated."
9657 #: ../src/guestfs-actions.pod:2429
9658 msgid "guestfs_inotify_init"
9662 #: ../src/guestfs-actions.pod:2431
9666 " guestfs_inotify_init (guestfs_h *g,\n"
9667 " int maxevents);\n"
9672 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
9674 "This command creates a new inotify handle. The inotify subsystem can be "
9675 "used to notify events which happen to objects in the guest filesystem."
9679 #: ../src/guestfs-actions.pod:2439
9681 "C<maxevents> is the maximum number of events which will be queued up between "
9682 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9683 "passed as C<0>, then the kernel (or previously set) default is used. For "
9684 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9685 "throws away events, but records the fact that it threw them away by setting "
9686 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9687 "C<guestfs_inotify_read>)."
9691 #: ../src/guestfs-actions.pod:2449
9693 "Before any events are generated, you have to add some watches to the "
9694 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9695 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9699 #: ../src/guestfs-actions.pod:2455
9701 "Queued up events should be read periodically by calling "
9702 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9703 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9704 "often enough then you risk the internal queue overflowing."
9708 #: ../src/guestfs-actions.pod:2462
9710 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9711 "This also removes any watches automatically."
9715 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
9717 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9718 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9719 "that there is one global inotify handle per libguestfs instance."
9723 #: ../src/guestfs-actions.pod:2475
9724 msgid "guestfs_inotify_read"
9728 #: ../src/guestfs-actions.pod:2477
9731 " struct guestfs_inotify_event_list *\n"
9732 " guestfs_inotify_read (guestfs_h *g);\n"
9737 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
9739 "Return the complete queue of events that have happened since the previous "
9744 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
9745 msgid "If no events have happened, this returns an empty list."
9749 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
9751 "I<Note>: In order to make sure that all events have been read, you must call "
9752 "this function repeatedly until it returns an empty list. The reason is that "
9753 "the call will read events up to the maximum appliance-to-host message size "
9754 "and leave remaining events in the queue."
9758 #: ../src/guestfs-actions.pod:2491
9760 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9761 "there was an error. I<The caller must call "
9762 "C<guestfs_free_inotify_event_list> after use>."
9766 #: ../src/guestfs-actions.pod:2497
9767 msgid "guestfs_inotify_rm_watch"
9771 #: ../src/guestfs-actions.pod:2499
9775 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9781 #: ../src/guestfs-actions.pod:2503
9783 "Remove a previously defined inotify watch. See "
9784 "C<guestfs_inotify_add_watch>."
9788 #: ../src/guestfs-actions.pod:2510
9789 msgid "guestfs_inspect_get_arch"
9793 #: ../src/guestfs-actions.pod:2512
9797 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9798 " const char *root);\n"
9803 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539 ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
9805 "This function should only be called with a root device string as returned by "
9806 "C<guestfs_inspect_os>."
9810 #: ../src/guestfs-actions.pod:2519
9812 "This returns the architecture of the inspected operating system. The "
9813 "possible return values are listed under C<guestfs_file_architecture>."
9817 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
9819 "If the architecture could not be determined, then the string C<unknown> is "
9824 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917 ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900 ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994 ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054 ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162 ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
9825 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9829 #: ../src/guestfs-actions.pod:2533
9830 msgid "guestfs_inspect_get_distro"
9834 #: ../src/guestfs-actions.pod:2535
9838 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9839 " const char *root);\n"
9844 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
9845 msgid "This returns the distro (distribution) of the inspected operating system."
9849 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
9850 msgid "Currently defined distros are:"
9854 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
9855 msgid "\"archlinux\""
9859 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
9864 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
9869 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
9874 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
9879 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
9884 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
9889 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
9894 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
9895 msgid "\"linuxmint\""
9899 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
9904 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
9905 msgid "\"mandriva\""
9909 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
9914 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
9919 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
9924 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
9929 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
9934 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
9935 msgid "\"redhat-based\""
9939 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
9940 msgid "Some Red Hat-derived distro."
9944 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
9949 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
9950 msgid "Red Hat Enterprise Linux and some derivatives."
9954 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
9955 msgid "\"slackware\""
9959 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
9964 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
9969 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
9974 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
9979 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
9980 msgid "The distro could not be determined."
9984 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
9989 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
9991 "Windows does not have distributions. This string is returned if the OS type "
9996 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773 ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
9998 "Future versions of libguestfs may return other strings here. The caller "
9999 "should be prepared to handle any string."
10003 #: ../src/guestfs-actions.pod:2618
10004 msgid "guestfs_inspect_get_drive_mappings"
10008 #: ../src/guestfs-actions.pod:2620
10012 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10013 " const char *root);\n"
10018 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10020 "This call is useful for Windows which uses a primitive system of assigning "
10021 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10022 "Windows Registry to find out how disks/partitions are mapped to drive "
10023 "letters, and returns a hash table as in the example below:"
10027 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
10030 " C => /dev/vda2\n"
10031 " E => /dev/vdb1\n"
10032 " F => /dev/vdc1\n"
10037 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10039 "Note that keys are drive letters. For Windows, the key is case insensitive "
10040 "and just contains the drive letter, without the customary colon separator "
10045 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10047 "In future we may support other operating systems that also used drive "
10048 "letters, but the keys for those might not be case insensitive and might be "
10049 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10054 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10056 "For Windows guests, currently only hard drive mappings are returned. "
10057 "Removable disks (eg. DVD-ROMs) are ignored."
10061 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10063 "For guests that do not use drive mappings, or if the drive mappings could "
10064 "not be determined, this returns an empty hash table."
10068 #: ../src/guestfs-actions.pod:2652
10070 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10071 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10075 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:6707
10077 "This function returns a NULL-terminated array of strings, or NULL if there "
10078 "was an error. The array of strings will always have length C<2n+1>, where "
10079 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10080 "caller must free the strings and the array after use>."
10084 #: ../src/guestfs-actions.pod:2662
10085 msgid "guestfs_inspect_get_filesystems"
10089 #: ../src/guestfs-actions.pod:2664
10093 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10094 " const char *root);\n"
10099 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10101 "This returns a list of all the filesystems that we think are associated with "
10102 "this operating system. This includes the root filesystem, other ordinary "
10103 "filesystems, and non-mounted devices like swap partitions."
10107 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10109 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10110 "to be shared between operating systems."
10114 #: ../src/guestfs-actions.pod:2679
10116 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10117 "C<guestfs_inspect_get_mountpoints>."
10121 #: ../src/guestfs-actions.pod:2688
10122 msgid "guestfs_inspect_get_format"
10126 #: ../src/guestfs-actions.pod:2690
10130 " guestfs_inspect_get_format (guestfs_h *g,\n"
10131 " const char *root);\n"
10136 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
10138 "This returns the format of the inspected operating system. You can use it "
10139 "to detect install images, live CDs and similar."
10143 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
10144 msgid "Currently defined formats are:"
10148 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
10149 msgid "\"installed\""
10153 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
10154 msgid "This is an installed operating system."
10158 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10159 msgid "\"installer\""
10163 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10165 "The disk image being inspected is not an installed operating system, but a "
10166 "I<bootable> install disk, live CD, or similar."
10170 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10171 msgid "The format of this disk image is not known."
10175 #: ../src/guestfs-actions.pod:2727
10176 msgid "guestfs_inspect_get_hostname"
10180 #: ../src/guestfs-actions.pod:2729
10184 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10185 " const char *root);\n"
10190 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
10192 "This function returns the hostname of the operating system as found by "
10193 "inspection of the guest's configuration files."
10197 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
10199 "If the hostname could not be determined, then the string C<unknown> is "
10204 #: ../src/guestfs-actions.pod:2747
10205 msgid "(Added in 1.7.9)"
10209 #: ../src/guestfs-actions.pod:2749
10210 msgid "guestfs_inspect_get_major_version"
10214 #: ../src/guestfs-actions.pod:2751
10218 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10219 " const char *root);\n"
10224 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
10225 msgid "This returns the major version number of the inspected operating system."
10229 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
10231 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10232 "popular public names used by the operating system. Notably the operating "
10233 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10234 "1). You can find out the real versions corresponding to releases of Windows "
10235 "by consulting Wikipedia or MSDN."
10239 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788 ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
10240 msgid "If the version could not be determined, then C<0> is returned."
10244 #: ../src/guestfs-actions.pod:2776
10245 msgid "guestfs_inspect_get_minor_version"
10249 #: ../src/guestfs-actions.pod:2778
10253 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10254 " const char *root);\n"
10259 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
10260 msgid "This returns the minor version number of the inspected operating system."
10264 #: ../src/guestfs-actions.pod:2790
10266 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10267 "C<guestfs_inspect_get_major_version>."
10271 #: ../src/guestfs-actions.pod:2797
10272 msgid "guestfs_inspect_get_mountpoints"
10276 #: ../src/guestfs-actions.pod:2799
10280 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10281 " const char *root);\n"
10286 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
10288 "This returns a hash of where we think the filesystems associated with this "
10289 "operating system should be mounted. Callers should note that this is at "
10290 "best an educated guess made by reading configuration files such as "
10291 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10292 "are non-existent or not mountable and callers should be prepared to handle "
10293 "or ignore failures if they try to mount them."
10297 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
10299 "Each element in the returned hashtable has a key which is the path of the "
10300 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10301 "mounted there (eg. C</dev/sda1>)."
10305 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10306 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10310 #: ../src/guestfs-actions.pod:2823
10312 "For operating systems like Windows which still use drive letters, this call "
10313 "will only return an entry for the first drive \"mounted on\" C</>. For "
10314 "information about the mapping of drive letters to partitions, see "
10315 "C<guestfs_inspect_get_drive_mappings>."
10319 #: ../src/guestfs-actions.pod:2829
10321 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10322 "C<guestfs_inspect_get_filesystems>."
10326 #: ../src/guestfs-actions.pod:2840
10327 msgid "guestfs_inspect_get_package_format"
10331 #: ../src/guestfs-actions.pod:2842
10335 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10336 " const char *root);\n"
10341 #: ../src/guestfs-actions.pod:2849
10343 "This function and C<guestfs_inspect_get_package_management> return the "
10344 "package format and package management tool used by the inspected operating "
10345 "system. For example for Fedora these functions would return C<rpm> (package "
10346 "format) and C<yum> (package management)."
10350 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
10352 "This returns the string C<unknown> if we could not determine the package "
10353 "format I<or> if the operating system does not have a real packaging system "
10358 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
10360 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10361 "Future versions of libguestfs may return other strings."
10365 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
10366 msgid "(Added in 1.7.5)"
10370 #: ../src/guestfs-actions.pod:2869
10371 msgid "guestfs_inspect_get_package_management"
10375 #: ../src/guestfs-actions.pod:2871
10379 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10380 " const char *root);\n"
10385 #: ../src/guestfs-actions.pod:2878
10387 "C<guestfs_inspect_get_package_format> and this function return the package "
10388 "format and package management tool used by the inspected operating system. "
10389 "For example for Fedora these functions would return C<rpm> (package format) "
10390 "and C<yum> (package management)."
10394 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
10396 "This returns the string C<unknown> if we could not determine the package "
10397 "management tool I<or> if the operating system does not have a real packaging "
10398 "system (eg. Windows)."
10402 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
10404 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10405 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10406 "libguestfs may return other strings."
10410 #: ../src/guestfs-actions.pod:2900
10411 msgid "guestfs_inspect_get_product_name"
10415 #: ../src/guestfs-actions.pod:2902
10419 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10420 " const char *root);\n"
10425 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
10427 "This returns the product name of the inspected operating system. The "
10428 "product name is generally some freeform string which can be displayed to the "
10429 "user, but should not be parsed by programs."
10433 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10435 "If the product name could not be determined, then the string C<unknown> is "
10440 #: ../src/guestfs-actions.pod:2924
10441 msgid "guestfs_inspect_get_product_variant"
10445 #: ../src/guestfs-actions.pod:2926
10449 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10450 " const char *root);\n"
10455 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
10456 msgid "This returns the product variant of the inspected operating system."
10460 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
10462 "For Windows guests, this returns the contents of the Registry key "
10463 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10464 "which is usually a string such as C<Client> or C<Server> (other values are "
10465 "possible). This can be used to distinguish consumer and enterprise versions "
10466 "of Windows that have the same version number (for example, Windows 7 and "
10467 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10468 "the latter is C<Server>)."
10472 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
10474 "For enterprise Linux guests, in future we intend this to return the product "
10475 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10476 "implemented at present."
10480 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
10482 "If the product variant could not be determined, then the string C<unknown> "
10487 #: ../src/guestfs-actions.pod:2952
10489 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10490 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10494 #: ../src/guestfs-actions.pod:2959
10495 msgid "guestfs_inspect_get_roots"
10499 #: ../src/guestfs-actions.pod:2961
10503 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10508 #: ../src/guestfs-actions.pod:2964
10510 "This function is a convenient way to get the list of root devices, as "
10511 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10512 "the whole inspection process."
10516 #: ../src/guestfs-actions.pod:2968
10518 "This returns an empty list if either no root devices were found or the "
10519 "caller has not called C<guestfs_inspect_os>."
10523 #: ../src/guestfs-actions.pod:2977
10524 msgid "(Added in 1.7.3)"
10528 #: ../src/guestfs-actions.pod:2979
10529 msgid "guestfs_inspect_get_type"
10533 #: ../src/guestfs-actions.pod:2981
10537 " guestfs_inspect_get_type (guestfs_h *g,\n"
10538 " const char *root);\n"
10543 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
10545 "This returns the type of the inspected operating system. Currently defined "
10550 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
10555 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
10556 msgid "Any Linux-based operating system."
10560 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
10561 msgid "Any Microsoft Windows operating system."
10565 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
10566 msgid "\"freebsd\""
10570 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
10575 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
10576 msgid "The operating system type could not be determined."
10580 #: ../src/guestfs-actions.pod:3021
10581 msgid "guestfs_inspect_get_windows_current_control_set"
10585 #: ../src/guestfs-actions.pod:3023
10589 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10590 " const char *root);\n"
10595 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
10597 "This returns the Windows CurrentControlSet of the inspected guest. The "
10598 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10602 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
10604 "This call assumes that the guest is Windows and that the Registry could be "
10605 "examined by inspection. If this is not the case then an error is returned."
10609 #: ../src/guestfs-actions.pod:3042
10610 msgid "guestfs_inspect_get_windows_systemroot"
10614 #: ../src/guestfs-actions.pod:3044
10618 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10619 " const char *root);\n"
10624 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
10626 "This returns the Windows systemroot of the inspected guest. The systemroot "
10627 "is a directory path such as C</WINDOWS>."
10631 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
10633 "This call assumes that the guest is Windows and that the systemroot could be "
10634 "determined by inspection. If this is not the case then an error is "
10639 #: ../src/guestfs-actions.pod:3063
10640 msgid "(Added in 1.5.25)"
10644 #: ../src/guestfs-actions.pod:3065
10645 msgid "guestfs_inspect_is_live"
10649 #: ../src/guestfs-actions.pod:3067
10653 " guestfs_inspect_is_live (guestfs_h *g,\n"
10654 " const char *root);\n"
10659 #: ../src/guestfs-actions.pod:3074
10661 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10662 "disk), then this returns true if a live image was detected on the disk."
10666 #: ../src/guestfs-actions.pod:3082
10667 msgid "guestfs_inspect_is_multipart"
10671 #: ../src/guestfs-actions.pod:3084
10675 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10676 " const char *root);\n"
10681 #: ../src/guestfs-actions.pod:3091
10683 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10684 "disk), then this returns true if the disk is part of a set."
10688 #: ../src/guestfs-actions.pod:3099
10689 msgid "guestfs_inspect_is_netinst"
10693 #: ../src/guestfs-actions.pod:3101
10697 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10698 " const char *root);\n"
10703 #: ../src/guestfs-actions.pod:3108
10705 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10706 "disk), then this returns true if the disk is a network installer, ie. not a "
10707 "self-contained install CD but one which is likely to require network access "
10708 "to complete the install."
10712 #: ../src/guestfs-actions.pod:3118
10713 msgid "guestfs_inspect_list_applications"
10717 #: ../src/guestfs-actions.pod:3120
10720 " struct guestfs_application_list *\n"
10721 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10722 " const char *root);\n"
10727 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
10728 msgid "Return the list of applications installed in the operating system."
10732 #: ../src/guestfs-actions.pod:3129
10734 "I<Note:> This call works differently from other parts of the inspection "
10735 "API. You have to call C<guestfs_inspect_os>, then "
10736 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10737 "this. Listing applications is a significantly more difficult operation "
10738 "which requires access to the full filesystem. Also note that unlike the "
10739 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10740 "the libguestfs handle, this call actually reads parts of the mounted "
10741 "filesystems during the call."
10745 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
10747 "This returns an empty list if the inspection code was not able to determine "
10748 "the list of applications."
10752 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
10753 msgid "The application structure contains the following fields:"
10757 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
10758 msgid "C<app_name>"
10762 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
10764 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10765 "guests, this is the package name."
10769 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
10770 msgid "C<app_display_name>"
10774 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
10776 "The display name of the application, sometimes localized to the install "
10777 "language of the guest operating system."
10781 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
10783 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10784 "to display something can use C<app_name> instead."
10788 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
10789 msgid "C<app_epoch>"
10793 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
10795 "For package managers which use epochs, this contains the epoch of the "
10796 "package (an integer). If unavailable, this is returned as C<0>."
10800 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
10801 msgid "C<app_version>"
10805 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
10807 "The version string of the application or package. If unavailable this is "
10808 "returned as an empty string C<\"\">."
10812 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
10813 msgid "C<app_release>"
10817 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
10819 "The release string of the application or package, for package managers that "
10820 "use this. If unavailable this is returned as an empty string C<\"\">."
10824 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
10825 msgid "C<app_install_path>"
10829 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
10831 "The installation path of the application (on operating systems such as "
10832 "Windows which use installation paths). This path is in the format used by "
10833 "the guest operating system, it is not a libguestfs path."
10837 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
10838 msgid "If unavailable this is returned as an empty string C<\"\">."
10842 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
10843 msgid "C<app_trans_path>"
10847 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
10849 "The install path translated into a libguestfs path. If unavailable this is "
10850 "returned as an empty string C<\"\">."
10854 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
10855 msgid "C<app_publisher>"
10859 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
10861 "The name of the publisher of the application, for package managers that use "
10862 "this. If unavailable this is returned as an empty string C<\"\">."
10866 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
10871 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
10873 "The URL (eg. upstream URL) of the application. If unavailable this is "
10874 "returned as an empty string C<\"\">."
10878 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
10879 msgid "C<app_source_package>"
10883 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
10885 "For packaging systems which support this, the name of the source package. "
10886 "If unavailable this is returned as an empty string C<\"\">."
10890 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
10891 msgid "C<app_summary>"
10895 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
10897 "A short (usually one line) description of the application or package. If "
10898 "unavailable this is returned as an empty string C<\"\">."
10902 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
10903 msgid "C<app_description>"
10907 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
10909 "A longer description of the application or package. If unavailable this is "
10910 "returned as an empty string C<\"\">."
10914 #: ../src/guestfs-actions.pod:3219
10916 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10917 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10922 #: ../src/guestfs-actions.pod:3223
10923 msgid "(Added in 1.7.8)"
10927 #: ../src/guestfs-actions.pod:3225
10928 msgid "guestfs_inspect_os"
10932 #: ../src/guestfs-actions.pod:3227
10936 " guestfs_inspect_os (guestfs_h *g);\n"
10941 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
10943 "This function uses other libguestfs functions and certain heuristics to "
10944 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10945 "for operating systems."
10949 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
10950 msgid "The list returned is empty if no operating systems were found."
10954 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
10956 "If one operating system was found, then this returns a list with a single "
10957 "element, which is the name of the root filesystem of this operating system. "
10958 "It is also possible for this function to return a list containing more than "
10959 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10960 "element being the root filesystem of one of the operating systems."
10964 #: ../src/guestfs-actions.pod:3243
10966 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10967 "functions in order to query further information about each operating system, "
10968 "such as the name and version."
10972 #: ../src/guestfs-actions.pod:3248
10974 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10975 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10976 "the contents. This should be called with no disks currently mounted. The "
10977 "function may also use Augeas, so any existing Augeas handle will be closed."
10981 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
10983 "This function cannot decrypt encrypted disks. The caller must do that first "
10984 "(supplying the necessary keys) if the disk is encrypted."
10988 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3612
10989 msgid "See also C<guestfs_list_filesystems>."
10993 #: ../src/guestfs-actions.pod:3268
10994 msgid "guestfs_is_blockdev"
10998 #: ../src/guestfs-actions.pod:3270
11002 " guestfs_is_blockdev (guestfs_h *g,\n"
11003 " const char *path);\n"
11008 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
11010 "This returns C<true> if and only if there is a block device with the given "
11015 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3438
11016 msgid "See also C<guestfs_stat>."
11020 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3442
11021 msgid "(Added in 1.5.10)"
11025 #: ../src/guestfs-actions.pod:3283
11026 msgid "guestfs_is_busy"
11030 #: ../src/guestfs-actions.pod:3285
11034 " guestfs_is_busy (guestfs_h *g);\n"
11039 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
11041 "This returns true iff this handle is busy processing a command (in the "
11046 #: ../src/guestfs-actions.pod:3297
11047 msgid "guestfs_is_chardev"
11051 #: ../src/guestfs-actions.pod:3299
11055 " guestfs_is_chardev (guestfs_h *g,\n"
11056 " const char *path);\n"
11061 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
11063 "This returns C<true> if and only if there is a character device with the "
11064 "given C<path> name."
11068 #: ../src/guestfs-actions.pod:3312
11069 msgid "guestfs_is_config"
11073 #: ../src/guestfs-actions.pod:3314
11077 " guestfs_is_config (guestfs_h *g);\n"
11082 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
11084 "This returns true iff this handle is being configured (in the C<CONFIG> "
11089 #: ../src/guestfs-actions.pod:3326
11090 msgid "guestfs_is_dir"
11094 #: ../src/guestfs-actions.pod:3328
11098 " guestfs_is_dir (guestfs_h *g,\n"
11099 " const char *path);\n"
11104 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
11106 "This returns C<true> if and only if there is a directory with the given "
11107 "C<path> name. Note that it returns false for other objects like files."
11111 #: ../src/guestfs-actions.pod:3342
11112 msgid "guestfs_is_fifo"
11116 #: ../src/guestfs-actions.pod:3344
11120 " guestfs_is_fifo (guestfs_h *g,\n"
11121 " const char *path);\n"
11126 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
11128 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11129 "given C<path> name."
11133 #: ../src/guestfs-actions.pod:3357
11134 msgid "guestfs_is_file"
11138 #: ../src/guestfs-actions.pod:3359
11142 " guestfs_is_file (guestfs_h *g,\n"
11143 " const char *path);\n"
11148 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
11150 "This returns C<true> if and only if there is a regular file with the given "
11151 "C<path> name. Note that it returns false for other objects like "
11156 #: ../src/guestfs-actions.pod:3373
11157 msgid "guestfs_is_launching"
11161 #: ../src/guestfs-actions.pod:3375
11165 " guestfs_is_launching (guestfs_h *g);\n"
11170 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
11172 "This returns true iff this handle is launching the subprocess (in the "
11173 "C<LAUNCHING> state)."
11177 #: ../src/guestfs-actions.pod:3387
11178 msgid "guestfs_is_lv"
11182 #: ../src/guestfs-actions.pod:3389
11186 " guestfs_is_lv (guestfs_h *g,\n"
11187 " const char *device);\n"
11192 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
11194 "This command tests whether C<device> is a logical volume, and returns true "
11195 "iff this is the case."
11199 #: ../src/guestfs-actions.pod:3400
11200 msgid "guestfs_is_ready"
11204 #: ../src/guestfs-actions.pod:3402
11208 " guestfs_is_ready (guestfs_h *g);\n"
11213 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
11215 "This returns true iff this handle is ready to accept commands (in the "
11220 #: ../src/guestfs-actions.pod:3414
11221 msgid "guestfs_is_socket"
11225 #: ../src/guestfs-actions.pod:3416
11229 " guestfs_is_socket (guestfs_h *g,\n"
11230 " const char *path);\n"
11235 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
11237 "This returns C<true> if and only if there is a Unix domain socket with the "
11238 "given C<path> name."
11242 #: ../src/guestfs-actions.pod:3429
11243 msgid "guestfs_is_symlink"
11247 #: ../src/guestfs-actions.pod:3431
11251 " guestfs_is_symlink (guestfs_h *g,\n"
11252 " const char *path);\n"
11257 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
11259 "This returns C<true> if and only if there is a symbolic link with the given "
11264 #: ../src/guestfs-actions.pod:3444
11265 msgid "guestfs_kill_subprocess"
11269 #: ../src/guestfs-actions.pod:3446
11273 " guestfs_kill_subprocess (guestfs_h *g);\n"
11278 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
11279 msgid "This kills the qemu subprocess. You should never need to call this."
11283 #: ../src/guestfs-actions.pod:3455
11284 msgid "guestfs_launch"
11288 #: ../src/guestfs-actions.pod:3457
11292 " guestfs_launch (guestfs_h *g);\n"
11297 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
11299 "Internally libguestfs is implemented by running a virtual machine using "
11304 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
11306 "You should call this after configuring the handle (eg. adding drives) but "
11307 "before performing any actions."
11311 #: ../src/guestfs-actions.pod:3475
11312 msgid "guestfs_lchown"
11316 #: ../src/guestfs-actions.pod:3477
11320 " guestfs_lchown (guestfs_h *g,\n"
11323 " const char *path);\n"
11328 #: ../src/guestfs-actions.pod:3483
11330 "Change the file owner to C<owner> and group to C<group>. This is like "
11331 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11332 "changed, not the target."
11336 #: ../src/guestfs-actions.pod:3495
11337 msgid "guestfs_lgetxattr"
11341 #: ../src/guestfs-actions.pod:3497
11345 " guestfs_lgetxattr (guestfs_h *g,\n"
11346 " const char *path,\n"
11347 " const char *name,\n"
11348 " size_t *size_r);\n"
11353 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
11355 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11356 "is a symlink, then this call returns an extended attribute from the symlink."
11360 #: ../src/guestfs-actions.pod:3517
11361 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11365 #: ../src/guestfs-actions.pod:3525
11366 msgid "guestfs_lgetxattrs"
11370 #: ../src/guestfs-actions.pod:3527
11373 " struct guestfs_xattr_list *\n"
11374 " guestfs_lgetxattrs (guestfs_h *g,\n"
11375 " const char *path);\n"
11380 #: ../src/guestfs-actions.pod:3531
11382 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11383 "then it returns the extended attributes of the link itself."
11387 #: ../src/guestfs-actions.pod:3541
11388 msgid "guestfs_list_devices"
11392 #: ../src/guestfs-actions.pod:3543
11396 " guestfs_list_devices (guestfs_h *g);\n"
11401 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
11402 msgid "List all the block devices."
11406 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
11407 msgid "The full block device names are returned, eg. C</dev/sda>."
11411 #: ../src/guestfs-actions.pod:3558
11412 msgid "guestfs_list_filesystems"
11416 #: ../src/guestfs-actions.pod:3560
11420 " guestfs_list_filesystems (guestfs_h *g);\n"
11425 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
11427 "This inspection command looks for filesystems on partitions, block devices "
11428 "and logical volumes, returning a list of devices containing filesystems and "
11433 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
11435 "The return value is a hash, where the keys are the devices containing "
11436 "filesystems, and the values are the filesystem types. For example:"
11440 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11443 " \"/dev/sda1\" => \"ntfs\"\n"
11444 " \"/dev/sda2\" => \"ext2\"\n"
11445 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11446 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11451 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11453 "The value can have the special value \"unknown\", meaning the content of the "
11454 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11458 #: ../src/guestfs-actions.pod:3580
11460 "This command runs other libguestfs commands, which might include "
11461 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11462 "soon after launch and only when nothing is mounted."
11466 #: ../src/guestfs-actions.pod:3584
11468 "Not all of the filesystems returned will be mountable. In particular, swap "
11469 "partitions are returned in the list. Also this command does not check that "
11470 "each filesystem found is valid and mountable, and some filesystems might be "
11471 "mountable but require special options. Filesystems may not all belong to a "
11472 "single logical operating system (use C<guestfs_inspect_os> to look for "
11477 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
11478 msgid "(Added in 1.5.15)"
11482 #: ../src/guestfs-actions.pod:3600
11483 msgid "guestfs_list_partitions"
11487 #: ../src/guestfs-actions.pod:3602
11491 " guestfs_list_partitions (guestfs_h *g);\n"
11496 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
11497 msgid "List all the partitions detected on all block devices."
11501 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
11502 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11506 #: ../src/guestfs-actions.pod:3609
11508 "This does not return logical volumes. For that you will need to call "
11513 #: ../src/guestfs-actions.pod:3620
11518 #: ../src/guestfs-actions.pod:3622
11522 " guestfs_ll (guestfs_h *g,\n"
11523 " const char *directory);\n"
11528 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
11530 "List the files in C<directory> (relative to the root directory, there is no "
11531 "cwd) in the format of 'ls -la'."
11535 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
11537 "This command is mostly useful for interactive sessions. It is I<not> "
11538 "intended that you try to parse the output string."
11542 #: ../src/guestfs-actions.pod:3637
11547 #: ../src/guestfs-actions.pod:3639
11551 " guestfs_ln (guestfs_h *g,\n"
11552 " const char *target,\n"
11553 " const char *linkname);\n"
11558 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
11559 msgid "This command creates a hard link using the C<ln> command."
11563 #: ../src/guestfs-actions.pod:3650
11564 msgid "guestfs_ln_f"
11568 #: ../src/guestfs-actions.pod:3652
11572 " guestfs_ln_f (guestfs_h *g,\n"
11573 " const char *target,\n"
11574 " const char *linkname);\n"
11579 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
11581 "This command creates a hard link using the C<ln -f> command. The C<-f> "
11582 "option removes the link (C<linkname>) if it exists already."
11586 #: ../src/guestfs-actions.pod:3664
11587 msgid "guestfs_ln_s"
11591 #: ../src/guestfs-actions.pod:3666
11595 " guestfs_ln_s (guestfs_h *g,\n"
11596 " const char *target,\n"
11597 " const char *linkname);\n"
11602 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
11603 msgid "This command creates a symbolic link using the C<ln -s> command."
11607 #: ../src/guestfs-actions.pod:3677
11608 msgid "guestfs_ln_sf"
11612 #: ../src/guestfs-actions.pod:3679
11616 " guestfs_ln_sf (guestfs_h *g,\n"
11617 " const char *target,\n"
11618 " const char *linkname);\n"
11623 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
11625 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
11626 "option removes the link (C<linkname>) if it exists already."
11630 #: ../src/guestfs-actions.pod:3691
11631 msgid "guestfs_lremovexattr"
11635 #: ../src/guestfs-actions.pod:3693
11639 " guestfs_lremovexattr (guestfs_h *g,\n"
11640 " const char *xattr,\n"
11641 " const char *path);\n"
11646 #: ../src/guestfs-actions.pod:3698
11648 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11649 "link, then it removes an extended attribute of the link itself."
11653 #: ../src/guestfs-actions.pod:3706
11658 #: ../src/guestfs-actions.pod:3708
11662 " guestfs_ls (guestfs_h *g,\n"
11663 " const char *directory);\n"
11668 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
11670 "List the files in C<directory> (relative to the root directory, there is no "
11671 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11676 #: ../src/guestfs-actions.pod:3716
11678 "This command is mostly useful for interactive sessions. Programs should "
11679 "probably use C<guestfs_readdir> instead."
11683 #: ../src/guestfs-actions.pod:3725
11684 msgid "guestfs_lsetxattr"
11688 #: ../src/guestfs-actions.pod:3727
11692 " guestfs_lsetxattr (guestfs_h *g,\n"
11693 " const char *xattr,\n"
11694 " const char *val,\n"
11696 " const char *path);\n"
11701 #: ../src/guestfs-actions.pod:3734
11703 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11704 "then it sets an extended attribute of the link itself."
11708 #: ../src/guestfs-actions.pod:3742
11709 msgid "guestfs_lstat"
11713 #: ../src/guestfs-actions.pod:3744
11716 " struct guestfs_stat *\n"
11717 " guestfs_lstat (guestfs_h *g,\n"
11718 " const char *path);\n"
11723 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
11724 msgid "Returns file information for the given C<path>."
11728 #: ../src/guestfs-actions.pod:3750
11730 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11731 "link, then the link is stat-ed, not the file it refers to."
11735 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
11736 msgid "This is the same as the C<lstat(2)> system call."
11740 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
11742 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11743 "error. I<The caller must call C<guestfs_free_stat> after use>."
11747 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
11748 msgid "(Added in 0.9.2)"
11752 #: ../src/guestfs-actions.pod:3762
11753 msgid "guestfs_lstatlist"
11757 #: ../src/guestfs-actions.pod:3764
11760 " struct guestfs_stat_list *\n"
11761 " guestfs_lstatlist (guestfs_h *g,\n"
11762 " const char *path,\n"
11763 " char *const *names);\n"
11768 #: ../src/guestfs-actions.pod:3769
11770 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11771 "files, where all files are in the directory C<path>. C<names> is the list "
11772 "of files from this directory."
11776 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
11778 "On return you get a list of stat structs, with a one-to-one correspondence "
11779 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11780 "then the C<ino> field of that structure is set to C<-1>."
11784 #: ../src/guestfs-actions.pod:3778
11786 "This call is intended for programs that want to efficiently list a directory "
11787 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11788 "for a similarly efficient call for getting extended attributes. Very long "
11789 "directory listings might cause the protocol message size to be exceeded, "
11790 "causing this call to fail. The caller must split up such requests into "
11791 "smaller groups of names."
11795 #: ../src/guestfs-actions.pod:3786
11797 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11798 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11802 #: ../src/guestfs-actions.pod:3792
11803 msgid "guestfs_luks_add_key"
11807 #: ../src/guestfs-actions.pod:3794
11811 " guestfs_luks_add_key (guestfs_h *g,\n"
11812 " const char *device,\n"
11813 " const char *key,\n"
11814 " const char *newkey,\n"
11820 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
11822 "This command adds a new key on LUKS device C<device>. C<key> is any "
11823 "existing key, and is used to access the device. C<newkey> is the new key to "
11824 "add. C<keyslot> is the key slot that will be replaced."
11828 #: ../src/guestfs-actions.pod:3806
11830 "Note that if C<keyslot> already contains a key, then this command will "
11831 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
11835 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
11837 "This function takes a key or passphrase parameter which could contain "
11838 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
11843 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
11844 msgid "(Added in 1.5.2)"
11848 #: ../src/guestfs-actions.pod:3818
11849 msgid "guestfs_luks_close"
11853 #: ../src/guestfs-actions.pod:3820
11857 " guestfs_luks_close (guestfs_h *g,\n"
11858 " const char *device);\n"
11863 #: ../src/guestfs-actions.pod:3824
11865 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
11866 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
11867 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11868 "underlying block device."
11872 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4048
11873 msgid "(Added in 1.5.1)"
11877 #: ../src/guestfs-actions.pod:3834
11878 msgid "guestfs_luks_format"
11882 #: ../src/guestfs-actions.pod:3836
11886 " guestfs_luks_format (guestfs_h *g,\n"
11887 " const char *device,\n"
11888 " const char *key,\n"
11894 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
11896 "This command erases existing data on C<device> and formats the device as a "
11897 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11898 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11902 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655 ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846 ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172 ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
11904 "B<This command is dangerous. Without careful use you can easily destroy all "
11909 #: ../src/guestfs-actions.pod:3858
11910 msgid "guestfs_luks_format_cipher"
11914 #: ../src/guestfs-actions.pod:3860
11918 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11919 " const char *device,\n"
11920 " const char *key,\n"
11922 " const char *cipher);\n"
11927 #: ../src/guestfs-actions.pod:3867
11929 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11930 "set the C<cipher> used."
11934 #: ../src/guestfs-actions.pod:3881
11935 msgid "guestfs_luks_kill_slot"
11939 #: ../src/guestfs-actions.pod:3883
11943 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11944 " const char *device,\n"
11945 " const char *key,\n"
11951 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
11953 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11954 "device C<device>. C<key> must be one of the I<other> keys."
11958 #: ../src/guestfs-actions.pod:3901
11959 msgid "guestfs_luks_open"
11963 #: ../src/guestfs-actions.pod:3903
11967 " guestfs_luks_open (guestfs_h *g,\n"
11968 " const char *device,\n"
11969 " const char *key,\n"
11970 " const char *mapname);\n"
11975 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
11977 "This command opens a block device which has been encrypted according to the "
11978 "Linux Unified Key Setup (LUKS) standard."
11982 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
11983 msgid "C<device> is the encrypted block device or partition."
11987 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
11989 "The caller must supply one of the keys associated with the LUKS block "
11990 "device, in the C<key> parameter."
11994 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
11996 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11997 "writes to this block device are decrypted from and encrypted to the "
11998 "underlying C<device> respectively."
12002 #: ../src/guestfs-actions.pod:3921
12004 "If this block device contains LVM volume groups, then calling "
12005 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12010 #: ../src/guestfs-actions.pod:3933
12011 msgid "guestfs_luks_open_ro"
12015 #: ../src/guestfs-actions.pod:3935
12019 " guestfs_luks_open_ro (guestfs_h *g,\n"
12020 " const char *device,\n"
12021 " const char *key,\n"
12022 " const char *mapname);\n"
12027 #: ../src/guestfs-actions.pod:3941
12029 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12034 #: ../src/guestfs-actions.pod:3952
12035 msgid "guestfs_lvcreate"
12039 #: ../src/guestfs-actions.pod:3954
12043 " guestfs_lvcreate (guestfs_h *g,\n"
12044 " const char *logvol,\n"
12045 " const char *volgroup,\n"
12051 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
12053 "This creates an LVM logical volume called C<logvol> on the volume group "
12054 "C<volgroup>, with C<size> megabytes."
12058 #: ../src/guestfs-actions.pod:3967
12059 msgid "guestfs_lvm_canonical_lv_name"
12063 #: ../src/guestfs-actions.pod:3969
12067 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12068 " const char *lvname);\n"
12073 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
12075 "This converts alternative naming schemes for LVs that you might find to the "
12076 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12081 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
12083 "This command returns an error if the C<lvname> parameter does not refer to a "
12088 #: ../src/guestfs-actions.pod:3980
12089 msgid "See also C<guestfs_is_lv>."
12093 #: ../src/guestfs-actions.pod:3985
12094 msgid "(Added in 1.5.24)"
12098 #: ../src/guestfs-actions.pod:3987
12099 msgid "guestfs_lvm_clear_filter"
12103 #: ../src/guestfs-actions.pod:3989
12107 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12112 #: ../src/guestfs-actions.pod:3992
12114 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12115 "see every block device."
12119 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
12120 msgid "This command also clears the LVM cache and performs a volume group scan."
12124 #: ../src/guestfs-actions.pod:4002
12125 msgid "guestfs_lvm_remove_all"
12129 #: ../src/guestfs-actions.pod:4004
12133 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12138 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
12140 "This command removes all LVM logical volumes, volume groups and physical "
12145 #: ../src/guestfs-actions.pod:4017
12146 msgid "guestfs_lvm_set_filter"
12150 #: ../src/guestfs-actions.pod:4019
12154 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12155 " char *const *devices);\n"
12160 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
12162 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12163 "block devices in the list C<devices>, and will ignore all other attached "
12168 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
12170 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12171 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12172 "there are two types of duplication possible: either cloned PVs/VGs which "
12173 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12174 "same name. In normal operation you cannot create this situation, but you "
12175 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12176 "inside the LVM metadata."
12180 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
12181 msgid "You can filter whole block devices or individual partitions."
12185 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
12187 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12188 "filesystem), even if you are not filtering out that VG."
12192 #: ../src/guestfs-actions.pod:4050
12193 msgid "guestfs_lvremove"
12197 #: ../src/guestfs-actions.pod:4052
12201 " guestfs_lvremove (guestfs_h *g,\n"
12202 " const char *device);\n"
12207 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
12209 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12210 "LV, such as C</dev/VG/LV>."
12214 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
12216 "You can also remove all LVs in a volume group by specifying the VG name, "
12221 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300 ../src/guestfs-actions.pod:7089
12222 msgid "(Added in 1.0.13)"
12226 #: ../src/guestfs-actions.pod:4066
12227 msgid "guestfs_lvrename"
12231 #: ../src/guestfs-actions.pod:4068
12235 " guestfs_lvrename (guestfs_h *g,\n"
12236 " const char *logvol,\n"
12237 " const char *newlogvol);\n"
12242 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
12243 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12247 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
12248 msgid "(Added in 1.0.83)"
12252 #: ../src/guestfs-actions.pod:4079
12253 msgid "guestfs_lvresize"
12257 #: ../src/guestfs-actions.pod:4081
12261 " guestfs_lvresize (guestfs_h *g,\n"
12262 " const char *device,\n"
12268 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
12270 "This resizes (expands or shrinks) an existing LVM logical volume to "
12271 "C<mbytes>. When reducing, data in the reduced part is lost."
12275 #: ../src/guestfs-actions.pod:4094
12276 msgid "guestfs_lvresize_free"
12280 #: ../src/guestfs-actions.pod:4096
12284 " guestfs_lvresize_free (guestfs_h *g,\n"
12285 " const char *lv,\n"
12291 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
12293 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12294 "remaining free space in the volume group. Commonly you would call this with "
12295 "pc = 100 which expands the logical volume as much as possible, using all "
12296 "remaining free space in the volume group."
12300 #: ../src/guestfs-actions.pod:4109
12301 msgid "(Added in 1.3.3)"
12305 #: ../src/guestfs-actions.pod:4111
12306 msgid "guestfs_lvs"
12310 #: ../src/guestfs-actions.pod:4113
12314 " guestfs_lvs (guestfs_h *g);\n"
12319 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
12321 "List all the logical volumes detected. This is the equivalent of the "
12322 "L<lvs(8)> command."
12326 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
12328 "This returns a list of the logical volume device names "
12329 "(eg. C</dev/VolGroup00/LogVol00>)."
12333 #: ../src/guestfs-actions.pod:4122
12334 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12338 #: ../src/guestfs-actions.pod:4130
12339 msgid "guestfs_lvs_full"
12343 #: ../src/guestfs-actions.pod:4132
12346 " struct guestfs_lvm_lv_list *\n"
12347 " guestfs_lvs_full (guestfs_h *g);\n"
12352 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
12354 "List all the logical volumes detected. This is the equivalent of the "
12355 "L<lvs(8)> command. The \"full\" version includes all fields."
12359 #: ../src/guestfs-actions.pod:4138
12361 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12362 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12367 #: ../src/guestfs-actions.pod:4144
12368 msgid "guestfs_lvuuid"
12372 #: ../src/guestfs-actions.pod:4146
12376 " guestfs_lvuuid (guestfs_h *g,\n"
12377 " const char *device);\n"
12382 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
12383 msgid "This command returns the UUID of the LVM LV C<device>."
12387 #: ../src/guestfs-actions.pod:4157
12388 msgid "guestfs_lxattrlist"
12392 #: ../src/guestfs-actions.pod:4159
12395 " struct guestfs_xattr_list *\n"
12396 " guestfs_lxattrlist (guestfs_h *g,\n"
12397 " const char *path,\n"
12398 " char *const *names);\n"
12403 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
12405 "This call allows you to get the extended attributes of multiple files, where "
12406 "all files are in the directory C<path>. C<names> is the list of files from "
12411 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
12413 "On return you get a flat list of xattr structs which must be interpreted "
12414 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12415 "C<attrval> in this struct is zero-length to indicate there was an error "
12416 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12417 "number (the number of following attributes for this file, which could be "
12418 "C<\"0\">). Then after the first xattr struct are the zero or more "
12419 "attributes for the first named file. This repeats for the second and "
12420 "subsequent files."
12424 #: ../src/guestfs-actions.pod:4178
12426 "This call is intended for programs that want to efficiently list a directory "
12427 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12428 "a similarly efficient call for getting standard stats. Very long directory "
12429 "listings might cause the protocol message size to be exceeded, causing this "
12430 "call to fail. The caller must split up such requests into smaller groups of "
12435 #: ../src/guestfs-actions.pod:4192
12436 msgid "guestfs_mkdir"
12440 #: ../src/guestfs-actions.pod:4194
12444 " guestfs_mkdir (guestfs_h *g,\n"
12445 " const char *path);\n"
12450 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
12451 msgid "Create a directory named C<path>."
12455 #: ../src/guestfs-actions.pod:4204
12456 msgid "guestfs_mkdir_mode"
12460 #: ../src/guestfs-actions.pod:4206
12464 " guestfs_mkdir_mode (guestfs_h *g,\n"
12465 " const char *path,\n"
12471 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
12473 "This command creates a directory, setting the initial permissions of the "
12474 "directory to C<mode>."
12478 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
12480 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12481 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12486 #: ../src/guestfs-actions.pod:4218
12487 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12491 #: ../src/guestfs-actions.pod:4224
12492 msgid "guestfs_mkdir_p"
12496 #: ../src/guestfs-actions.pod:4226
12500 " guestfs_mkdir_p (guestfs_h *g,\n"
12501 " const char *path);\n"
12506 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
12508 "Create a directory named C<path>, creating any parent directories as "
12509 "necessary. This is like the C<mkdir -p> shell command."
12513 #: ../src/guestfs-actions.pod:4237
12514 msgid "guestfs_mkdtemp"
12518 #: ../src/guestfs-actions.pod:4239
12522 " guestfs_mkdtemp (guestfs_h *g,\n"
12523 " const char *template);\n"
12528 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
12530 "This command creates a temporary directory. The C<template> parameter "
12531 "should be a full pathname for the temporary directory name with the final "
12532 "six characters being \"XXXXXX\"."
12536 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
12538 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12539 "being suitable for Windows filesystems."
12543 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
12544 msgid "The name of the temporary directory that was created is returned."
12548 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
12549 msgid "The temporary directory is created with mode 0700 and is owned by root."
12553 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
12555 "The caller is responsible for deleting the temporary directory and its "
12556 "contents after use."
12560 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
12561 msgid "See also: L<mkdtemp(3)>"
12565 #: ../src/guestfs-actions.pod:4267
12566 msgid "guestfs_mke2fs_J"
12570 #: ../src/guestfs-actions.pod:4269
12574 " guestfs_mke2fs_J (guestfs_h *g,\n"
12575 " const char *fstype,\n"
12576 " int blocksize,\n"
12577 " const char *device,\n"
12578 " const char *journal);\n"
12583 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
12585 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12586 "C<journal>. It is equivalent to the command:"
12590 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
12593 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12598 #: ../src/guestfs-actions.pod:4282
12599 msgid "See also C<guestfs_mke2journal>."
12603 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
12604 msgid "(Added in 1.0.68)"
12608 #: ../src/guestfs-actions.pod:4288
12609 msgid "guestfs_mke2fs_JL"
12613 #: ../src/guestfs-actions.pod:4290
12617 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12618 " const char *fstype,\n"
12619 " int blocksize,\n"
12620 " const char *device,\n"
12621 " const char *label);\n"
12626 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
12628 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12629 "the journal labeled C<label>."
12633 #: ../src/guestfs-actions.pod:4300
12634 msgid "See also C<guestfs_mke2journal_L>."
12638 #: ../src/guestfs-actions.pod:4306
12639 msgid "guestfs_mke2fs_JU"
12643 #: ../src/guestfs-actions.pod:4308
12647 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12648 " const char *fstype,\n"
12649 " int blocksize,\n"
12650 " const char *device,\n"
12651 " const char *uuid);\n"
12656 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
12658 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12659 "the journal with UUID C<uuid>."
12663 #: ../src/guestfs-actions.pod:4318
12664 msgid "See also C<guestfs_mke2journal_U>."
12668 #: ../src/guestfs-actions.pod:4324
12669 msgid "guestfs_mke2journal"
12673 #: ../src/guestfs-actions.pod:4326
12677 " guestfs_mke2journal (guestfs_h *g,\n"
12678 " int blocksize,\n"
12679 " const char *device);\n"
12684 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
12686 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12691 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
12694 " mke2fs -O journal_dev -b blocksize device\n"
12699 #: ../src/guestfs-actions.pod:4340
12700 msgid "guestfs_mke2journal_L"
12704 #: ../src/guestfs-actions.pod:4342
12708 " guestfs_mke2journal_L (guestfs_h *g,\n"
12709 " int blocksize,\n"
12710 " const char *label,\n"
12711 " const char *device);\n"
12716 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
12717 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12721 #: ../src/guestfs-actions.pod:4354
12722 msgid "guestfs_mke2journal_U"
12726 #: ../src/guestfs-actions.pod:4356
12730 " guestfs_mke2journal_U (guestfs_h *g,\n"
12731 " int blocksize,\n"
12732 " const char *uuid,\n"
12733 " const char *device);\n"
12738 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
12739 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12743 #: ../src/guestfs-actions.pod:4368
12744 msgid "guestfs_mkfifo"
12748 #: ../src/guestfs-actions.pod:4370
12752 " guestfs_mkfifo (guestfs_h *g,\n"
12754 " const char *path);\n"
12759 #: ../src/guestfs-actions.pod:4375
12761 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12762 "is just a convenient wrapper around C<guestfs_mknod>."
12766 #: ../src/guestfs-actions.pod:4385
12767 msgid "guestfs_mkfs"
12771 #: ../src/guestfs-actions.pod:4387
12775 " guestfs_mkfs (guestfs_h *g,\n"
12776 " const char *fstype,\n"
12777 " const char *device);\n"
12782 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
12784 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12785 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12789 #: ../src/guestfs-actions.pod:4400
12790 msgid "guestfs_mkfs_b"
12794 #: ../src/guestfs-actions.pod:4402
12798 " guestfs_mkfs_b (guestfs_h *g,\n"
12799 " const char *fstype,\n"
12800 " int blocksize,\n"
12801 " const char *device);\n"
12806 #: ../src/guestfs-actions.pod:4408
12808 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
12809 "block size of the resulting filesystem. Supported block sizes depend on the "
12810 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12814 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
12816 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12821 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
12823 "This function is deprecated. In new code, use the C<mkfs_opts> call "
12828 #: ../src/guestfs-actions.pod:4427
12829 msgid "guestfs_mkfs_opts"
12833 #: ../src/guestfs-actions.pod:4429
12837 " guestfs_mkfs_opts (guestfs_h *g,\n"
12838 " const char *fstype,\n"
12839 " const char *device,\n"
12845 #: ../src/guestfs-actions.pod:4440
12848 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
12849 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
12854 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
12856 "This function creates a filesystem on C<device>. The filesystem type is "
12857 "C<fstype>, for example C<ext3>."
12861 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
12862 msgid "C<blocksize>"
12866 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
12868 "The filesystem block size. Supported block sizes depend on the filesystem "
12869 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12874 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
12875 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12879 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
12880 msgid "C<features>"
12884 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
12885 msgid "This passes the C<-O> parameter to the external mkfs program."
12889 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
12891 "For certain filesystem types, this allows extra filesystem features to be "
12892 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12896 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
12898 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12903 #: ../src/guestfs-actions.pod:4476
12904 msgid "(Added in 1.7.19)"
12908 #: ../src/guestfs-actions.pod:4478
12909 msgid "guestfs_mkfs_opts_va"
12913 #: ../src/guestfs-actions.pod:4480
12917 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12918 " const char *fstype,\n"
12919 " const char *device,\n"
12920 " va_list args);\n"
12925 #: ../src/guestfs-actions.pod:4486
12926 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12930 #: ../src/guestfs-actions.pod:4490
12931 msgid "guestfs_mkfs_opts_argv"
12935 #: ../src/guestfs-actions.pod:4492
12939 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12940 " const char *fstype,\n"
12941 " const char *device,\n"
12942 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12947 #: ../src/guestfs-actions.pod:4498
12948 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12952 #: ../src/guestfs-actions.pod:4502
12953 msgid "guestfs_mkmountpoint"
12957 #: ../src/guestfs-actions.pod:4504
12961 " guestfs_mkmountpoint (guestfs_h *g,\n"
12962 " const char *exemptpath);\n"
12967 #: ../src/guestfs-actions.pod:4508
12969 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12970 "that can be used to create extra mountpoints before mounting the first "
12975 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
12977 "These calls are I<only> necessary in some very limited circumstances, mainly "
12978 "the case where you want to mount a mix of unrelated and/or read-only "
12979 "filesystems together."
12983 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
12985 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12986 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12987 "inside that. You can unpack this as follows in guestfish:"
12991 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
12994 " add-ro Fedora-11-i686-Live.iso\n"
12996 " mkmountpoint /cd\n"
12997 " mkmountpoint /sqsh\n"
12998 " mkmountpoint /ext3fs\n"
12999 " mount /dev/sda /cd\n"
13000 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13001 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13006 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
13007 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13011 #: ../src/guestfs-actions.pod:4532
13013 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13014 "may get unexpected errors if you try to mix these calls. It is safest to "
13015 "manually unmount filesystems and remove mountpoints after use."
13019 #: ../src/guestfs-actions.pod:4536
13021 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13022 "first, so for this to work for manual mountpoints, you must ensure that the "
13023 "innermost mountpoints have the longest pathnames, as in the example code "
13028 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
13029 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13033 #: ../src/guestfs-actions.pod:4543
13035 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13036 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13037 "can also trigger these issues."
13041 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:5718
13042 msgid "(Added in 1.0.62)"
13046 #: ../src/guestfs-actions.pod:4551
13047 msgid "guestfs_mknod"
13051 #: ../src/guestfs-actions.pod:4553
13055 " guestfs_mknod (guestfs_h *g,\n"
13059 " const char *path);\n"
13064 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
13066 "This call creates block or character special devices, or named pipes "
13071 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
13073 "The C<mode> parameter should be the mode, using the standard constants. "
13074 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13075 "used when creating block and character special devices."
13079 #: ../src/guestfs-actions.pod:4568
13081 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13082 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13083 "regular file). These constants are available in the standard Linux header "
13084 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13085 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13086 "the appropriate constant for you."
13090 #: ../src/guestfs-actions.pod:4582
13091 msgid "guestfs_mknod_b"
13095 #: ../src/guestfs-actions.pod:4584
13099 " guestfs_mknod_b (guestfs_h *g,\n"
13103 " const char *path);\n"
13108 #: ../src/guestfs-actions.pod:4591
13110 "This call creates a block device node called C<path> with mode C<mode> and "
13111 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13112 "wrapper around C<guestfs_mknod>."
13116 #: ../src/guestfs-actions.pod:4601
13117 msgid "guestfs_mknod_c"
13121 #: ../src/guestfs-actions.pod:4603
13125 " guestfs_mknod_c (guestfs_h *g,\n"
13129 " const char *path);\n"
13134 #: ../src/guestfs-actions.pod:4610
13136 "This call creates a char device node called C<path> with mode C<mode> and "
13137 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13138 "wrapper around C<guestfs_mknod>."
13142 #: ../src/guestfs-actions.pod:4620
13143 msgid "guestfs_mkswap"
13147 #: ../src/guestfs-actions.pod:4622
13151 " guestfs_mkswap (guestfs_h *g,\n"
13152 " const char *device);\n"
13157 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
13158 msgid "Create a swap partition on C<device>."
13162 #: ../src/guestfs-actions.pod:4632
13163 msgid "guestfs_mkswap_L"
13167 #: ../src/guestfs-actions.pod:4634
13171 " guestfs_mkswap_L (guestfs_h *g,\n"
13172 " const char *label,\n"
13173 " const char *device);\n"
13178 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
13179 msgid "Create a swap partition on C<device> with label C<label>."
13183 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
13185 "Note that you cannot attach a swap label to a block device "
13186 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13187 "the kernel or swap tools."
13191 #: ../src/guestfs-actions.pod:4649
13192 msgid "guestfs_mkswap_U"
13196 #: ../src/guestfs-actions.pod:4651
13200 " guestfs_mkswap_U (guestfs_h *g,\n"
13201 " const char *uuid,\n"
13202 " const char *device);\n"
13207 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
13208 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13212 #: ../src/guestfs-actions.pod:4662
13213 msgid "guestfs_mkswap_file"
13217 #: ../src/guestfs-actions.pod:4664
13221 " guestfs_mkswap_file (guestfs_h *g,\n"
13222 " const char *path);\n"
13227 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
13228 msgid "Create a swap file."
13232 #: ../src/guestfs-actions.pod:4670
13234 "This command just writes a swap file signature to an existing file. To "
13235 "create the file itself, use something like C<guestfs_fallocate>."
13239 #: ../src/guestfs-actions.pod:4677
13240 msgid "guestfs_modprobe"
13244 #: ../src/guestfs-actions.pod:4679
13248 " guestfs_modprobe (guestfs_h *g,\n"
13249 " const char *modulename);\n"
13254 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
13255 msgid "This loads a kernel module in the appliance."
13259 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
13261 "The kernel module must have been whitelisted when libguestfs was built (see "
13262 "C<appliance/kmod.whitelist.in> in the source)."
13266 #: ../src/guestfs-actions.pod:4692
13267 msgid "guestfs_mount"
13271 #: ../src/guestfs-actions.pod:4694
13275 " guestfs_mount (guestfs_h *g,\n"
13276 " const char *device,\n"
13277 " const char *mountpoint);\n"
13282 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
13284 "Mount a guest disk at a position in the filesystem. Block devices are named "
13285 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13286 "those block devices contain partitions, they will have the usual names "
13287 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13291 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
13293 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13294 "mounted on C</> before others can be mounted. Other filesystems can only be "
13295 "mounted on directories which already exist."
13299 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13301 "The mounted filesystem is writable, if we have sufficient permissions on the "
13302 "underlying device."
13306 #: ../src/guestfs-actions.pod:4713
13308 "B<Important note:> When you use this call, the filesystem options C<sync> "
13309 "and C<noatime> are set implicitly. This was originally done because we "
13310 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13311 "very large negative performance impact and negligible effect on "
13312 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13313 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13314 "(use an empty string for the first parameter if you don't want any options)."
13318 #: ../src/guestfs-actions.pod:4727
13319 msgid "guestfs_mount_loop"
13323 #: ../src/guestfs-actions.pod:4729
13327 " guestfs_mount_loop (guestfs_h *g,\n"
13328 " const char *file,\n"
13329 " const char *mountpoint);\n"
13334 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
13336 "This command lets you mount C<file> (a filesystem image in a file) on a "
13337 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13342 #: ../src/guestfs-actions.pod:4742
13343 msgid "guestfs_mount_options"
13347 #: ../src/guestfs-actions.pod:4744
13351 " guestfs_mount_options (guestfs_h *g,\n"
13352 " const char *options,\n"
13353 " const char *device,\n"
13354 " const char *mountpoint);\n"
13359 #: ../src/guestfs-actions.pod:4750
13361 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13362 "the mount options as for the L<mount(8)> I<-o> flag."
13366 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
13368 "If the C<options> parameter is an empty string, then no options are passed "
13369 "(all options default to whatever the filesystem uses)."
13373 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4791
13374 msgid "(Added in 1.0.10)"
13378 #: ../src/guestfs-actions.pod:4762
13379 msgid "guestfs_mount_ro"
13383 #: ../src/guestfs-actions.pod:4764
13387 " guestfs_mount_ro (guestfs_h *g,\n"
13388 " const char *device,\n"
13389 " const char *mountpoint);\n"
13394 #: ../src/guestfs-actions.pod:4769
13396 "This is the same as the C<guestfs_mount> command, but it mounts the "
13397 "filesystem with the read-only (I<-o ro>) flag."
13401 #: ../src/guestfs-actions.pod:4776
13402 msgid "guestfs_mount_vfs"
13406 #: ../src/guestfs-actions.pod:4778
13410 " guestfs_mount_vfs (guestfs_h *g,\n"
13411 " const char *options,\n"
13412 " const char *vfstype,\n"
13413 " const char *device,\n"
13414 " const char *mountpoint);\n"
13419 #: ../src/guestfs-actions.pod:4785
13421 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13422 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13427 #: ../src/guestfs-actions.pod:4793
13428 msgid "guestfs_mountpoints"
13432 #: ../src/guestfs-actions.pod:4795
13436 " guestfs_mountpoints (guestfs_h *g);\n"
13441 #: ../src/guestfs-actions.pod:4798
13443 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13444 "devices. This one returns a hash table (map) of device name to directory "
13445 "where the device is mounted."
13449 #: ../src/guestfs-actions.pod:4810
13450 msgid "guestfs_mounts"
13454 #: ../src/guestfs-actions.pod:4812
13458 " guestfs_mounts (guestfs_h *g);\n"
13463 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
13465 "This returns the list of currently mounted filesystems. It returns the list "
13466 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13470 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
13471 msgid "Some internal mounts are not shown."
13475 #: ../src/guestfs-actions.pod:4820
13476 msgid "See also: C<guestfs_mountpoints>"
13480 #: ../src/guestfs-actions.pod:4828
13485 #: ../src/guestfs-actions.pod:4830
13489 " guestfs_mv (guestfs_h *g,\n"
13490 " const char *src,\n"
13491 " const char *dest);\n"
13496 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
13498 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13499 "destination filename or destination directory."
13503 #: ../src/guestfs-actions.pod:4842
13504 msgid "guestfs_ntfs_3g_probe"
13508 #: ../src/guestfs-actions.pod:4844
13512 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13514 " const char *device);\n"
13519 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
13521 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13522 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13523 "read-write, and some cannot be mounted at all)."
13527 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
13529 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13530 "can be mounted read-write. Set it to false if you want to test if the "
13531 "volume can be mounted read-only."
13535 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
13537 "The return value is an integer which C<0> if the operation would succeed, or "
13538 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13542 #: ../src/guestfs-actions.pod:4863
13543 msgid "(Added in 1.0.43)"
13547 #: ../src/guestfs-actions.pod:4865
13548 msgid "guestfs_ntfsresize"
13552 #: ../src/guestfs-actions.pod:4867
13556 " guestfs_ntfsresize (guestfs_h *g,\n"
13557 " const char *device);\n"
13562 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
13564 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13565 "size of the underlying device. See also L<ntfsresize(8)>."
13569 #: ../src/guestfs-actions.pod:4879
13570 msgid "guestfs_ntfsresize_size"
13574 #: ../src/guestfs-actions.pod:4881
13578 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13579 " const char *device,\n"
13580 " int64_t size);\n"
13585 #: ../src/guestfs-actions.pod:4886
13587 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13588 "to specify the new size (in bytes) explicitly."
13592 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:7237
13593 msgid "(Added in 1.3.14)"
13597 #: ../src/guestfs-actions.pod:4893
13598 msgid "guestfs_part_add"
13602 #: ../src/guestfs-actions.pod:4895
13606 " guestfs_part_add (guestfs_h *g,\n"
13607 " const char *device,\n"
13608 " const char *prlogex,\n"
13609 " int64_t startsect,\n"
13610 " int64_t endsect);\n"
13615 #: ../src/guestfs-actions.pod:4902
13617 "This command adds a partition to C<device>. If there is no partition table "
13618 "on the device, call C<guestfs_part_init> first."
13622 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
13624 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13625 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13626 "C<logical>) and C<e> (or C<extended>) partition types."
13630 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
13632 "C<startsect> and C<endsect> are the start and end of the partition in "
13633 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13634 "from the end of the disk (C<-1> is the last sector)."
13638 #: ../src/guestfs-actions.pod:4914
13640 "Creating a partition which covers the whole disk is not so easy. Use "
13641 "C<guestfs_part_disk> to do that."
13645 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5185
13646 msgid "(Added in 1.0.78)"
13650 #: ../src/guestfs-actions.pod:4921
13651 msgid "guestfs_part_del"
13655 #: ../src/guestfs-actions.pod:4923
13659 " guestfs_part_del (guestfs_h *g,\n"
13660 " const char *device,\n"
13666 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
13667 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13671 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
13673 "Note that in the case of MBR partitioning, deleting an extended partition "
13674 "also deletes any logical partitions it contains."
13678 #: ../src/guestfs-actions.pod:4938
13679 msgid "guestfs_part_disk"
13683 #: ../src/guestfs-actions.pod:4940
13687 " guestfs_part_disk (guestfs_h *g,\n"
13688 " const char *device,\n"
13689 " const char *parttype);\n"
13694 #: ../src/guestfs-actions.pod:4945
13696 "This command is simply a combination of C<guestfs_part_init> followed by "
13697 "C<guestfs_part_add> to create a single primary partition covering the whole "
13702 #: ../src/guestfs-actions.pod:4949
13704 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13705 "possible values are described in C<guestfs_part_init>."
13709 #: ../src/guestfs-actions.pod:4959
13710 msgid "guestfs_part_get_bootable"
13714 #: ../src/guestfs-actions.pod:4961
13718 " guestfs_part_get_bootable (guestfs_h *g,\n"
13719 " const char *device,\n"
13725 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
13727 "This command returns true if the partition C<partnum> on C<device> has the "
13728 "bootable flag set."
13732 #: ../src/guestfs-actions.pod:4969
13733 msgid "See also C<guestfs_part_set_bootable>."
13737 #: ../src/guestfs-actions.pod:4975
13738 msgid "guestfs_part_get_mbr_id"
13742 #: ../src/guestfs-actions.pod:4977
13746 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13747 " const char *device,\n"
13753 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
13755 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13756 "partition C<partnum>."
13760 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
13762 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13763 "undefined results for other partition table types (see "
13764 "C<guestfs_part_get_parttype>)."
13768 #: ../src/guestfs-actions.pod:4993
13769 msgid "guestfs_part_get_parttype"
13773 #: ../src/guestfs-actions.pod:4995
13777 " guestfs_part_get_parttype (guestfs_h *g,\n"
13778 " const char *device);\n"
13783 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
13785 "This command examines the partition table on C<device> and returns the "
13786 "partition table type (format) being used."
13790 #: ../src/guestfs-actions.pod:5002
13792 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13793 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13794 "possible, although unusual. See C<guestfs_part_init> for a full list."
13798 #: ../src/guestfs-actions.pod:5012
13799 msgid "guestfs_part_init"
13803 #: ../src/guestfs-actions.pod:5014
13807 " guestfs_part_init (guestfs_h *g,\n"
13808 " const char *device,\n"
13809 " const char *parttype);\n"
13814 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
13816 "This creates an empty partition table on C<device> of one of the partition "
13817 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13818 "(for large disks)."
13822 #: ../src/guestfs-actions.pod:5023
13824 "Initially there are no partitions. Following this, you should call "
13825 "C<guestfs_part_add> for each partition required."
13829 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
13830 msgid "Possible values for C<parttype> are:"
13834 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
13835 msgid "B<efi> | B<gpt>"
13839 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
13840 msgid "Intel EFI / GPT partition table."
13844 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
13846 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13847 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13848 "the C<mbr> format."
13852 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
13853 msgid "B<mbr> | B<msdos>"
13857 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
13859 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13860 "Windows. This partition type will B<only> work for device sizes up to 2 "
13861 "TB. For large disks we recommend using C<gpt>."
13865 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
13866 msgid "Other partition table types that may work but are not supported include:"
13870 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
13875 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
13876 msgid "AIX disk labels."
13880 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
13881 msgid "B<amiga> | B<rdb>"
13885 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
13886 msgid "Amiga \"Rigid Disk Block\" format."
13890 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
13895 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
13896 msgid "BSD disk labels."
13900 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
13905 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
13906 msgid "DASD, used on IBM mainframes."
13910 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
13915 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
13916 msgid "MIPS/SGI volumes."
13920 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
13925 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
13926 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13930 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
13935 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
13936 msgid "NEC PC-98 format, common in Japan apparently."
13940 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
13945 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
13946 msgid "Sun disk labels."
13950 #: ../src/guestfs-actions.pod:5090
13951 msgid "guestfs_part_list"
13955 #: ../src/guestfs-actions.pod:5092
13958 " struct guestfs_partition_list *\n"
13959 " guestfs_part_list (guestfs_h *g,\n"
13960 " const char *device);\n"
13965 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
13967 "This command parses the partition table on C<device> and returns the list of "
13968 "partitions found."
13972 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
13973 msgid "The fields in the returned structure are:"
13977 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
13978 msgid "B<part_num>"
13982 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
13983 msgid "Partition number, counting from 1."
13987 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
13988 msgid "B<part_start>"
13992 #: ../src/guestfs-actions.pod:5109
13994 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13995 "the device's sector size, see C<guestfs_blockdev_getss>."
13999 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
14000 msgid "B<part_end>"
14004 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
14005 msgid "End of the partition in bytes."
14009 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
14010 msgid "B<part_size>"
14014 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
14015 msgid "Size of the partition in bytes."
14019 #: ../src/guestfs-actions.pod:5122
14021 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14022 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14027 #: ../src/guestfs-actions.pod:5128
14028 msgid "guestfs_part_set_bootable"
14032 #: ../src/guestfs-actions.pod:5130
14036 " guestfs_part_set_bootable (guestfs_h *g,\n"
14037 " const char *device,\n"
14039 " int bootable);\n"
14044 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
14046 "This sets the bootable flag on partition numbered C<partnum> on device "
14047 "C<device>. Note that partitions are numbered from 1."
14051 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
14053 "The bootable flag is used by some operating systems (notably Windows) to "
14054 "determine which partition to boot from. It is by no means universally "
14059 #: ../src/guestfs-actions.pod:5147
14060 msgid "guestfs_part_set_mbr_id"
14064 #: ../src/guestfs-actions.pod:5149
14068 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14069 " const char *device,\n"
14076 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
14078 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14079 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14080 "documentation are in fact hexadecimal numbers, but usually documented "
14081 "without any leading \"0x\" which might be confusing."
14085 #: ../src/guestfs-actions.pod:5169
14086 msgid "guestfs_part_set_name"
14090 #: ../src/guestfs-actions.pod:5171
14094 " guestfs_part_set_name (guestfs_h *g,\n"
14095 " const char *device,\n"
14097 " const char *name);\n"
14102 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
14104 "This sets the partition name on partition numbered C<partnum> on device "
14105 "C<device>. Note that partitions are numbered from 1."
14109 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
14111 "The partition name can only be set on certain types of partition table. "
14112 "This works on C<gpt> but not on C<mbr> partitions."
14116 #: ../src/guestfs-actions.pod:5187
14117 msgid "guestfs_part_to_dev"
14121 #: ../src/guestfs-actions.pod:5189
14125 " guestfs_part_to_dev (guestfs_h *g,\n"
14126 " const char *partition);\n"
14131 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
14133 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14134 "partition number, returning the device name (eg. \"/dev/sdb\")."
14138 #: ../src/guestfs-actions.pod:5197
14140 "The named partition must exist, for example as a string returned from "
14141 "C<guestfs_list_partitions>."
14145 #: ../src/guestfs-actions.pod:5205
14146 msgid "guestfs_ping_daemon"
14150 #: ../src/guestfs-actions.pod:5207
14154 " guestfs_ping_daemon (guestfs_h *g);\n"
14159 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
14161 "This is a test probe into the guestfs daemon running inside the qemu "
14162 "subprocess. Calling this function checks that the daemon responds to the "
14163 "ping message, without affecting the daemon or attached block device(s) in "
14168 #: ../src/guestfs-actions.pod:5219
14169 msgid "guestfs_pread"
14173 #: ../src/guestfs-actions.pod:5221
14177 " guestfs_pread (guestfs_h *g,\n"
14178 " const char *path,\n"
14180 " int64_t offset,\n"
14181 " size_t *size_r);\n"
14186 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
14188 "This command lets you read part of a file. It reads C<count> bytes of the "
14189 "file, starting at C<offset>, from file C<path>."
14193 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
14195 "This may read fewer bytes than requested. For further details see the "
14196 "L<pread(2)> system call."
14200 #: ../src/guestfs-actions.pod:5234
14201 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14205 #: ../src/guestfs-actions.pod:5245
14206 msgid "guestfs_pread_device"
14210 #: ../src/guestfs-actions.pod:5247
14214 " guestfs_pread_device (guestfs_h *g,\n"
14215 " const char *device,\n"
14217 " int64_t offset,\n"
14218 " size_t *size_r);\n"
14223 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
14225 "This command lets you read part of a file. It reads C<count> bytes of "
14226 "C<device>, starting at C<offset>."
14230 #: ../src/guestfs-actions.pod:5260
14231 msgid "See also C<guestfs_pread>."
14235 #: ../src/guestfs-actions.pod:5269
14236 msgid "(Added in 1.5.21)"
14240 #: ../src/guestfs-actions.pod:5271
14241 msgid "guestfs_pvcreate"
14245 #: ../src/guestfs-actions.pod:5273
14249 " guestfs_pvcreate (guestfs_h *g,\n"
14250 " const char *device);\n"
14255 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
14257 "This creates an LVM physical volume on the named C<device>, where C<device> "
14258 "should usually be a partition name such as C</dev/sda1>."
14262 #: ../src/guestfs-actions.pod:5285
14263 msgid "guestfs_pvremove"
14267 #: ../src/guestfs-actions.pod:5287
14271 " guestfs_pvremove (guestfs_h *g,\n"
14272 " const char *device);\n"
14277 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
14279 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14284 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
14286 "The implementation uses the C<pvremove> command which refuses to wipe "
14287 "physical volumes that contain any volume groups, so you have to remove those "
14292 #: ../src/guestfs-actions.pod:5302
14293 msgid "guestfs_pvresize"
14297 #: ../src/guestfs-actions.pod:5304
14301 " guestfs_pvresize (guestfs_h *g,\n"
14302 " const char *device);\n"
14307 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
14309 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14310 "the new size of the underlying device."
14314 #: ../src/guestfs-actions.pod:5315
14315 msgid "guestfs_pvresize_size"
14319 #: ../src/guestfs-actions.pod:5317
14323 " guestfs_pvresize_size (guestfs_h *g,\n"
14324 " const char *device,\n"
14325 " int64_t size);\n"
14330 #: ../src/guestfs-actions.pod:5322
14332 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14333 "specify the new size (in bytes) explicitly."
14337 #: ../src/guestfs-actions.pod:5329
14338 msgid "guestfs_pvs"
14342 #: ../src/guestfs-actions.pod:5331
14346 " guestfs_pvs (guestfs_h *g);\n"
14351 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
14353 "List all the physical volumes detected. This is the equivalent of the "
14354 "L<pvs(8)> command."
14358 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
14360 "This returns a list of just the device names that contain PVs "
14361 "(eg. C</dev/sda2>)."
14365 #: ../src/guestfs-actions.pod:5340
14366 msgid "See also C<guestfs_pvs_full>."
14370 #: ../src/guestfs-actions.pod:5348
14371 msgid "guestfs_pvs_full"
14375 #: ../src/guestfs-actions.pod:5350
14378 " struct guestfs_lvm_pv_list *\n"
14379 " guestfs_pvs_full (guestfs_h *g);\n"
14384 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
14386 "List all the physical volumes detected. This is the equivalent of the "
14387 "L<pvs(8)> command. The \"full\" version includes all fields."
14391 #: ../src/guestfs-actions.pod:5356
14393 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14394 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14399 #: ../src/guestfs-actions.pod:5362
14400 msgid "guestfs_pvuuid"
14404 #: ../src/guestfs-actions.pod:5364
14408 " guestfs_pvuuid (guestfs_h *g,\n"
14409 " const char *device);\n"
14414 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
14415 msgid "This command returns the UUID of the LVM PV C<device>."
14419 #: ../src/guestfs-actions.pod:5375
14420 msgid "guestfs_pwrite"
14424 #: ../src/guestfs-actions.pod:5377
14428 " guestfs_pwrite (guestfs_h *g,\n"
14429 " const char *path,\n"
14430 " const char *content,\n"
14431 " size_t content_size,\n"
14432 " int64_t offset);\n"
14437 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
14439 "This command writes to part of a file. It writes the data buffer C<content> "
14440 "to the file C<path> starting at offset C<offset>."
14444 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
14446 "This command implements the L<pwrite(2)> system call, and like that system "
14447 "call it may not write the full data requested. The return value is the "
14448 "number of bytes that were actually written to the file. This could even be "
14449 "0, although short writes are unlikely for regular files in ordinary "
14454 #: ../src/guestfs-actions.pod:5393
14455 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14459 #: ../src/guestfs-actions.pod:5402
14460 msgid "guestfs_pwrite_device"
14464 #: ../src/guestfs-actions.pod:5404
14468 " guestfs_pwrite_device (guestfs_h *g,\n"
14469 " const char *device,\n"
14470 " const char *content,\n"
14471 " size_t content_size,\n"
14472 " int64_t offset);\n"
14477 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
14479 "This command writes to part of a device. It writes the data buffer "
14480 "C<content> to C<device> starting at offset C<offset>."
14484 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
14486 "This command implements the L<pwrite(2)> system call, and like that system "
14487 "call it may not write the full data requested (although short writes to disk "
14488 "devices and partitions are probably impossible with standard Linux kernels)."
14492 #: ../src/guestfs-actions.pod:5419
14493 msgid "See also C<guestfs_pwrite>."
14497 #: ../src/guestfs-actions.pod:5426
14498 msgid "(Added in 1.5.20)"
14502 #: ../src/guestfs-actions.pod:5428
14503 msgid "guestfs_read_file"
14507 #: ../src/guestfs-actions.pod:5430
14511 " guestfs_read_file (guestfs_h *g,\n"
14512 " const char *path,\n"
14513 " size_t *size_r);\n"
14518 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
14519 msgid "This calls returns the contents of the file C<path> as a buffer."
14523 #: ../src/guestfs-actions.pod:5438
14525 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14526 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14527 "function is limited in the total size of file that can be handled."
14531 #: ../src/guestfs-actions.pod:5450
14532 msgid "(Added in 1.0.63)"
14536 #: ../src/guestfs-actions.pod:5452
14537 msgid "guestfs_read_lines"
14541 #: ../src/guestfs-actions.pod:5454
14545 " guestfs_read_lines (guestfs_h *g,\n"
14546 " const char *path);\n"
14551 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
14553 "The file contents are returned as a list of lines. Trailing C<LF> and "
14554 "C<CRLF> character sequences are I<not> returned."
14558 #: ../src/guestfs-actions.pod:5463
14560 "Note that this function cannot correctly handle binary files (specifically, "
14561 "files containing C<\\0> character which is treated as end of line). For "
14562 "those you need to use the C<guestfs_read_file> function which has a more "
14563 "complex interface."
14567 #: ../src/guestfs-actions.pod:5474
14568 msgid "guestfs_readdir"
14572 #: ../src/guestfs-actions.pod:5476
14575 " struct guestfs_dirent_list *\n"
14576 " guestfs_readdir (guestfs_h *g,\n"
14577 " const char *dir);\n"
14582 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
14583 msgid "This returns the list of directory entries in directory C<dir>."
14587 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
14589 "All entries in the directory are returned, including C<.> and C<..>. The "
14590 "entries are I<not> sorted, but returned in the same order as the underlying "
14595 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
14597 "Also this call returns basic file type information about each file. The "
14598 "C<ftyp> field will contain one of the following characters:"
14602 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
14607 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
14608 msgid "Block special"
14612 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
14617 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
14618 msgid "Char special"
14622 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
14627 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
14632 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
14637 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
14638 msgid "FIFO (named pipe)"
14642 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
14647 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
14648 msgid "Symbolic link"
14652 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
14657 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
14658 msgid "Regular file"
14662 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
14667 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
14672 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
14677 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
14678 msgid "Unknown file type"
14682 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
14687 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
14688 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14692 #: ../src/guestfs-actions.pod:5530
14694 "This function is primarily intended for use by programs. To get a simple "
14695 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14696 "consumption, use C<guestfs_ll>."
14700 #: ../src/guestfs-actions.pod:5534
14702 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14703 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14708 #: ../src/guestfs-actions.pod:5540
14709 msgid "guestfs_readlink"
14713 #: ../src/guestfs-actions.pod:5542
14717 " guestfs_readlink (guestfs_h *g,\n"
14718 " const char *path);\n"
14723 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
14724 msgid "This command reads the target of a symbolic link."
14728 #: ../src/guestfs-actions.pod:5553
14729 msgid "guestfs_readlinklist"
14733 #: ../src/guestfs-actions.pod:5555
14737 " guestfs_readlinklist (guestfs_h *g,\n"
14738 " const char *path,\n"
14739 " char *const *names);\n"
14744 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
14746 "This call allows you to do a C<readlink> operation on multiple files, where "
14747 "all files are in the directory C<path>. C<names> is the list of files from "
14752 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
14754 "On return you get a list of strings, with a one-to-one correspondence to the "
14755 "C<names> list. Each string is the value of the symbolic link."
14759 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
14761 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14762 "result string is the empty string C<\"\">. However the whole operation is "
14763 "completed even if there were C<readlink(2)> errors, and so you can call this "
14764 "function with names where you don't know if they are symbolic links already "
14765 "(albeit slightly less efficient)."
14769 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
14771 "This call is intended for programs that want to efficiently list a directory "
14772 "contents without making many round-trips. Very long directory listings "
14773 "might cause the protocol message size to be exceeded, causing this call to "
14774 "fail. The caller must split up such requests into smaller groups of names."
14778 #: ../src/guestfs-actions.pod:5588
14779 msgid "guestfs_realpath"
14783 #: ../src/guestfs-actions.pod:5590
14787 " guestfs_realpath (guestfs_h *g,\n"
14788 " const char *path);\n"
14793 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
14795 "Return the canonicalized absolute pathname of C<path>. The returned path "
14796 "has no C<.>, C<..> or symbolic link path elements."
14800 #: ../src/guestfs-actions.pod:5602
14801 msgid "guestfs_removexattr"
14805 #: ../src/guestfs-actions.pod:5604
14809 " guestfs_removexattr (guestfs_h *g,\n"
14810 " const char *xattr,\n"
14811 " const char *path);\n"
14816 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
14817 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14821 #: ../src/guestfs-actions.pod:5612
14822 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
14826 #: ../src/guestfs-actions.pod:5618
14827 msgid "guestfs_resize2fs"
14831 #: ../src/guestfs-actions.pod:5620
14835 " guestfs_resize2fs (guestfs_h *g,\n"
14836 " const char *device);\n"
14841 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
14843 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14844 "underlying device."
14848 #: ../src/guestfs-actions.pod:5627
14850 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
14851 "C<device> before calling this command. For unknown reasons C<resize2fs> "
14852 "sometimes gives an error about this and sometimes not. In any case, it is "
14853 "always safe to call C<guestfs_e2fsck_f> before calling this function."
14857 #: ../src/guestfs-actions.pod:5637
14858 msgid "guestfs_resize2fs_M"
14862 #: ../src/guestfs-actions.pod:5639
14866 " guestfs_resize2fs_M (guestfs_h *g,\n"
14867 " const char *device);\n"
14872 #: ../src/guestfs-actions.pod:5643
14874 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
14875 "resized to its minimum size. This works like the C<-M> option to the "
14876 "C<resize2fs> command."
14880 #: ../src/guestfs-actions.pod:5647
14882 "To get the resulting size of the filesystem you should call "
14883 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
14884 "These two numbers, multiplied together, give the resulting size of the "
14885 "minimal filesystem in bytes."
14889 #: ../src/guestfs-actions.pod:5654
14890 msgid "guestfs_resize2fs_size"
14894 #: ../src/guestfs-actions.pod:5656
14898 " guestfs_resize2fs_size (guestfs_h *g,\n"
14899 " const char *device,\n"
14900 " int64_t size);\n"
14905 #: ../src/guestfs-actions.pod:5661
14907 "This command is the same as C<guestfs_resize2fs> except that it allows you "
14908 "to specify the new size (in bytes) explicitly."
14912 #: ../src/guestfs-actions.pod:5668
14917 #: ../src/guestfs-actions.pod:5670
14921 " guestfs_rm (guestfs_h *g,\n"
14922 " const char *path);\n"
14927 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
14928 msgid "Remove the single file C<path>."
14932 #: ../src/guestfs-actions.pod:5680
14933 msgid "guestfs_rm_rf"
14937 #: ../src/guestfs-actions.pod:5682
14941 " guestfs_rm_rf (guestfs_h *g,\n"
14942 " const char *path);\n"
14947 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
14949 "Remove the file or directory C<path>, recursively removing the contents if "
14950 "its a directory. This is like the C<rm -rf> shell command."
14954 #: ../src/guestfs-actions.pod:5694
14955 msgid "guestfs_rmdir"
14959 #: ../src/guestfs-actions.pod:5696
14963 " guestfs_rmdir (guestfs_h *g,\n"
14964 " const char *path);\n"
14969 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
14970 msgid "Remove the single directory C<path>."
14974 #: ../src/guestfs-actions.pod:5706
14975 msgid "guestfs_rmmountpoint"
14979 #: ../src/guestfs-actions.pod:5708
14983 " guestfs_rmmountpoint (guestfs_h *g,\n"
14984 " const char *exemptpath);\n"
14989 #: ../src/guestfs-actions.pod:5712
14991 "This calls removes a mountpoint that was previously created with "
14992 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14996 #: ../src/guestfs-actions.pod:5720
14997 msgid "guestfs_scrub_device"
15001 #: ../src/guestfs-actions.pod:5722
15005 " guestfs_scrub_device (guestfs_h *g,\n"
15006 " const char *device);\n"
15011 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
15013 "This command writes patterns over C<device> to make data retrieval more "
15018 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843 ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
15020 "It is an interface to the L<scrub(1)> program. See that manual page for "
15025 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:5774
15026 msgid "(Added in 1.0.52)"
15030 #: ../src/guestfs-actions.pod:5739
15031 msgid "guestfs_scrub_file"
15035 #: ../src/guestfs-actions.pod:5741
15039 " guestfs_scrub_file (guestfs_h *g,\n"
15040 " const char *file);\n"
15045 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
15047 "This command writes patterns over a file to make data retrieval more "
15052 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
15053 msgid "The file is I<removed> after scrubbing."
15057 #: ../src/guestfs-actions.pod:5757
15058 msgid "guestfs_scrub_freespace"
15062 #: ../src/guestfs-actions.pod:5759
15066 " guestfs_scrub_freespace (guestfs_h *g,\n"
15067 " const char *dir);\n"
15072 #: ../src/guestfs-actions.pod:5763
15074 "This command creates the directory C<dir> and then fills it with files until "
15075 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15076 "and deletes them. The intention is to scrub any free space on the partition "
15077 "containing C<dir>."
15081 #: ../src/guestfs-actions.pod:5776
15082 msgid "guestfs_set_append"
15086 #: ../src/guestfs-actions.pod:5778
15090 " guestfs_set_append (guestfs_h *g,\n"
15091 " const char *append);\n"
15096 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
15098 "This function is used to add additional options to the guest kernel command "
15103 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
15105 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15106 "environment variable."
15110 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
15112 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15113 "(libguestfs always adds a few of its own)."
15117 #: ../src/guestfs-actions.pod:5795
15118 msgid "guestfs_set_attach_method"
15122 #: ../src/guestfs-actions.pod:5797
15126 " guestfs_set_attach_method (guestfs_h *g,\n"
15127 " const char *attachmethod);\n"
15132 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
15134 "Set the method that libguestfs uses to connect to the back end guestfsd "
15135 "daemon. Possible methods are:"
15139 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
15141 "Launch an appliance and connect to it. This is the ordinary method and the "
15146 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
15147 msgid "C<unix:I<path>>"
15151 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15152 msgid "Connect to the Unix domain socket I<path>."
15156 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
15158 "This method lets you connect to an existing daemon or (using virtio-serial) "
15159 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15160 "RUNNING DAEMONS>."
15164 #: ../src/guestfs-actions.pod:5823
15165 msgid "guestfs_set_autosync"
15169 #: ../src/guestfs-actions.pod:5825
15173 " guestfs_set_autosync (guestfs_h *g,\n"
15174 " int autosync);\n"
15179 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
15181 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15182 "effort attempt to make filesystems consistent and synchronized when the "
15183 "handle is closed (also if the program exits without closing handles)."
15187 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
15189 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15190 "disabled by default)."
15194 #: ../src/guestfs-actions.pod:5841
15195 msgid "guestfs_set_direct"
15199 #: ../src/guestfs-actions.pod:5843
15203 " guestfs_set_direct (guestfs_h *g,\n"
15209 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
15211 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15212 "passed directly through to the appliance once it is launched."
15216 #: ../src/guestfs-actions.pod:5851
15218 "One consequence of this is that log messages aren't caught by the library "
15219 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15224 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15225 msgid "You probably don't want to use this unless you know what you are doing."
15229 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
15230 msgid "The default is disabled."
15234 #: ../src/guestfs-actions.pod:5864
15235 msgid "guestfs_set_e2label"
15239 #: ../src/guestfs-actions.pod:5866
15243 " guestfs_set_e2label (guestfs_h *g,\n"
15244 " const char *device,\n"
15245 " const char *label);\n"
15250 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
15252 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15253 "C<label>. Filesystem labels are limited to 16 characters."
15257 #: ../src/guestfs-actions.pod:5875
15259 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15260 "the existing label on a filesystem."
15264 #: ../src/guestfs-actions.pod:5882
15265 msgid "guestfs_set_e2uuid"
15269 #: ../src/guestfs-actions.pod:5884
15273 " guestfs_set_e2uuid (guestfs_h *g,\n"
15274 " const char *device,\n"
15275 " const char *uuid);\n"
15280 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
15282 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15283 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15284 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15288 #: ../src/guestfs-actions.pod:5894
15290 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15291 "the existing UUID of a filesystem."
15295 #: ../src/guestfs-actions.pod:5901
15296 msgid "guestfs_set_memsize"
15300 #: ../src/guestfs-actions.pod:5903
15304 " guestfs_set_memsize (guestfs_h *g,\n"
15310 #: ../src/guestfs-actions.pod:5907
15312 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15313 "This only has any effect if called before C<guestfs_launch>."
15317 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
15319 "You can also change this by setting the environment variable "
15320 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15324 #: ../src/guestfs-actions.pod:5922
15325 msgid "guestfs_set_network"
15329 #: ../src/guestfs-actions.pod:5924
15333 " guestfs_set_network (guestfs_h *g,\n"
15339 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
15341 "If C<network> is true, then the network is enabled in the libguestfs "
15342 "appliance. The default is false."
15346 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
15348 "This affects whether commands are able to access the network (see "
15349 "L<guestfs(3)/RUNNING COMMANDS>)."
15353 #: ../src/guestfs-actions.pod:5934
15355 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15360 #: ../src/guestfs-actions.pod:5941
15361 msgid "guestfs_set_path"
15365 #: ../src/guestfs-actions.pod:5943
15369 " guestfs_set_path (guestfs_h *g,\n"
15370 " const char *searchpath);\n"
15375 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
15376 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15380 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
15382 "The default is C<$libdir/guestfs> unless overridden by setting "
15383 "C<LIBGUESTFS_PATH> environment variable."
15387 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
15388 msgid "Setting C<path> to C<NULL> restores the default path."
15392 #: ../src/guestfs-actions.pod:5958
15393 msgid "guestfs_set_qemu"
15397 #: ../src/guestfs-actions.pod:5960
15401 " guestfs_set_qemu (guestfs_h *g,\n"
15402 " const char *qemu);\n"
15407 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
15408 msgid "Set the qemu binary that we will use."
15412 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
15413 msgid "The default is chosen when the library was compiled by the configure script."
15417 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
15419 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15424 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15425 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15429 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15431 "Note that you should call this function as early as possible after creating "
15432 "the handle. This is because some pre-launch operations depend on testing "
15433 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15434 "don't retest features, and so you might see inconsistent results. Using the "
15435 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15436 "the qemu binary at the same time as the handle is created."
15440 #: ../src/guestfs-actions.pod:5986
15441 msgid "guestfs_set_recovery_proc"
15445 #: ../src/guestfs-actions.pod:5988
15449 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15450 " int recoveryproc);\n"
15455 #: ../src/guestfs-actions.pod:5992
15457 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15458 "not create a recovery process. The purpose of the recovery process is to "
15459 "stop runaway qemu processes in the case where the main program aborts "
15464 #: ../src/guestfs-actions.pod:5997
15466 "This only has any effect if called before C<guestfs_launch>, and the default "
15471 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
15473 "About the only time when you would want to disable this is if the main "
15474 "process will fork itself into the background (\"daemonize\" itself). In "
15475 "this case the recovery process thinks that the main program has disappeared "
15476 "and so kills qemu, which is not very helpful."
15480 #: ../src/guestfs-actions.pod:6010
15481 msgid "guestfs_set_selinux"
15485 #: ../src/guestfs-actions.pod:6012
15489 " guestfs_set_selinux (guestfs_h *g,\n"
15495 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
15497 "This sets the selinux flag that is passed to the appliance at boot time. "
15498 "The default is C<selinux=0> (disabled)."
15502 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
15504 "Note that if SELinux is enabled, it is always in Permissive mode "
15505 "(C<enforcing=0>)."
15509 #: ../src/guestfs-actions.pod:6029
15510 msgid "guestfs_set_trace"
15514 #: ../src/guestfs-actions.pod:6031
15518 " guestfs_set_trace (guestfs_h *g,\n"
15524 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
15526 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15527 "return values are traced."
15531 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
15533 "If you want to trace C API calls into libguestfs (and other libraries) then "
15534 "possibly a better way is to use the external ltrace(1) command."
15538 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
15540 "Command traces are disabled unless the environment variable "
15541 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15545 #: ../src/guestfs-actions.pod:6045
15547 "Trace messages are normally sent to C<stderr>, unless you register a "
15548 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15552 #: ../src/guestfs-actions.pod:6053
15553 msgid "guestfs_set_verbose"
15557 #: ../src/guestfs-actions.pod:6055
15561 " guestfs_set_verbose (guestfs_h *g,\n"
15567 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
15568 msgid "If C<verbose> is true, this turns on verbose messages."
15572 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
15574 "Verbose messages are disabled unless the environment variable "
15575 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15579 #: ../src/guestfs-actions.pod:6064
15581 "Verbose messages are normally sent to C<stderr>, unless you register a "
15582 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15586 #: ../src/guestfs-actions.pod:6072
15587 msgid "guestfs_setcon"
15591 #: ../src/guestfs-actions.pod:6074
15595 " guestfs_setcon (guestfs_h *g,\n"
15596 " const char *context);\n"
15601 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
15603 "This sets the SELinux security context of the daemon to the string "
15608 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
15609 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15613 #: ../src/guestfs-actions.pod:6087
15614 msgid "guestfs_setxattr"
15618 #: ../src/guestfs-actions.pod:6089
15622 " guestfs_setxattr (guestfs_h *g,\n"
15623 " const char *xattr,\n"
15624 " const char *val,\n"
15626 " const char *path);\n"
15631 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
15633 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15634 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15638 #: ../src/guestfs-actions.pod:6100
15639 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15643 #: ../src/guestfs-actions.pod:6106
15644 msgid "guestfs_sfdisk"
15648 #: ../src/guestfs-actions.pod:6108
15652 " guestfs_sfdisk (guestfs_h *g,\n"
15653 " const char *device,\n"
15657 " char *const *lines);\n"
15662 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
15664 "This is a direct interface to the L<sfdisk(8)> program for creating "
15665 "partitions on block devices."
15669 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
15670 msgid "C<device> should be a block device, for example C</dev/sda>."
15674 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
15676 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15677 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15678 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15679 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15680 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15681 "the kernel) cannot work out the right geometry and you will need to tell it."
15685 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
15687 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15688 "refer to the L<sfdisk(8)> manpage."
15692 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
15694 "To create a single partition occupying the whole disk, you would pass "
15695 "C<lines> as a single element list, when the single element being the string "
15700 #: ../src/guestfs-actions.pod:6136
15701 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15705 #: ../src/guestfs-actions.pod:6146
15706 msgid "guestfs_sfdiskM"
15710 #: ../src/guestfs-actions.pod:6148
15714 " guestfs_sfdiskM (guestfs_h *g,\n"
15715 " const char *device,\n"
15716 " char *const *lines);\n"
15721 #: ../src/guestfs-actions.pod:6153
15723 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15724 "partition sizes are specified in megabytes only (rounded to the nearest "
15725 "cylinder) and you don't need to specify the cyls, heads and sectors "
15726 "parameters which were rarely if ever used anyway."
15730 #: ../src/guestfs-actions.pod:6159
15732 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15733 "C<guestfs_part_disk>"
15737 #: ../src/guestfs-actions.pod:6169
15738 msgid "guestfs_sfdisk_N"
15742 #: ../src/guestfs-actions.pod:6171
15746 " guestfs_sfdisk_N (guestfs_h *g,\n"
15747 " const char *device,\n"
15752 " const char *line);\n"
15757 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
15759 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15760 "(note: C<n> counts from 1)."
15764 #: ../src/guestfs-actions.pod:6183
15766 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15767 "for the cyls/heads/sectors parameters."
15771 #: ../src/guestfs-actions.pod:6186
15772 msgid "See also: C<guestfs_part_add>"
15776 #: ../src/guestfs-actions.pod:6195
15777 msgid "guestfs_sfdisk_disk_geometry"
15781 #: ../src/guestfs-actions.pod:6197
15785 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
15786 " const char *device);\n"
15791 #: ../src/guestfs-actions.pod:6201
15793 "This displays the disk geometry of C<device> read from the partition table. "
15794 "Especially in the case where the underlying block device has been resized, "
15795 "this can be different from the kernel's idea of the geometry (see "
15796 "C<guestfs_sfdisk_kernel_geometry>)."
15800 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222 ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
15801 msgid "The result is in human-readable format, and not designed to be parsed."
15805 #: ../src/guestfs-actions.pod:6214
15806 msgid "guestfs_sfdisk_kernel_geometry"
15810 #: ../src/guestfs-actions.pod:6216
15814 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
15815 " const char *device);\n"
15820 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
15821 msgid "This displays the kernel's idea of the geometry of C<device>."
15825 #: ../src/guestfs-actions.pod:6230
15826 msgid "guestfs_sfdisk_l"
15830 #: ../src/guestfs-actions.pod:6232
15834 " guestfs_sfdisk_l (guestfs_h *g,\n"
15835 " const char *device);\n"
15840 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
15842 "This displays the partition table on C<device>, in the human-readable output "
15843 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15847 #: ../src/guestfs-actions.pod:6240
15848 msgid "See also: C<guestfs_part_list>"
15852 #: ../src/guestfs-actions.pod:6247
15857 #: ../src/guestfs-actions.pod:6249
15861 " guestfs_sh (guestfs_h *g,\n"
15862 " const char *command);\n"
15867 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
15869 "This call runs a command from the guest filesystem via the guest's "
15874 #: ../src/guestfs-actions.pod:6256
15875 msgid "This is like C<guestfs_command>, but passes the command to:"
15879 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
15882 " /bin/sh -c \"command\"\n"
15887 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
15889 "Depending on the guest's shell, this usually results in wildcards being "
15890 "expanded, shell expressions being interpolated and so on."
15894 #: ../src/guestfs-actions.pod:6264
15895 msgid "All the provisos about C<guestfs_command> apply to this call."
15899 #: ../src/guestfs-actions.pod:6271
15900 msgid "guestfs_sh_lines"
15904 #: ../src/guestfs-actions.pod:6273
15908 " guestfs_sh_lines (guestfs_h *g,\n"
15909 " const char *command);\n"
15914 #: ../src/guestfs-actions.pod:6277
15916 "This is the same as C<guestfs_sh>, but splits the result into a list of "
15921 #: ../src/guestfs-actions.pod:6280
15922 msgid "See also: C<guestfs_command_lines>"
15926 #: ../src/guestfs-actions.pod:6288
15927 msgid "guestfs_sleep"
15931 #: ../src/guestfs-actions.pod:6290
15935 " guestfs_sleep (guestfs_h *g,\n"
15941 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
15942 msgid "Sleep for C<secs> seconds."
15946 #: ../src/guestfs-actions.pod:6298
15947 msgid "(Added in 1.0.41)"
15951 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
15952 msgid "guestfs_stat"
15956 #: ../src/guestfs-actions.pod:6302
15959 " struct guestfs_stat *\n"
15960 " guestfs_stat (guestfs_h *g,\n"
15961 " const char *path);\n"
15966 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
15967 msgid "This is the same as the C<stat(2)> system call."
15971 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
15972 msgid "guestfs_statvfs"
15976 #: ../src/guestfs-actions.pod:6318
15979 " struct guestfs_statvfs *\n"
15980 " guestfs_statvfs (guestfs_h *g,\n"
15981 " const char *path);\n"
15986 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
15988 "Returns file system statistics for any mounted file system. C<path> should "
15989 "be a file or directory in the mounted file system (typically it is the mount "
15990 "point itself, but it doesn't need to be)."
15994 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
15995 msgid "This is the same as the C<statvfs(2)> system call."
15999 #: ../src/guestfs-actions.pod:6328
16001 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16002 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16006 #: ../src/guestfs-actions.pod:6334
16007 msgid "guestfs_strings"
16011 #: ../src/guestfs-actions.pod:6336
16015 " guestfs_strings (guestfs_h *g,\n"
16016 " const char *path);\n"
16021 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
16023 "This runs the L<strings(1)> command on a file and returns the list of "
16024 "printable strings found."
16028 #: ../src/guestfs-actions.pod:6352
16029 msgid "guestfs_strings_e"
16033 #: ../src/guestfs-actions.pod:6354
16037 " guestfs_strings_e (guestfs_h *g,\n"
16038 " const char *encoding,\n"
16039 " const char *path);\n"
16044 #: ../src/guestfs-actions.pod:6359
16046 "This is like the C<guestfs_strings> command, but allows you to specify the "
16047 "encoding of strings that are looked for in the source file C<path>."
16051 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
16052 msgid "Allowed encodings are:"
16056 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
16061 #: ../src/guestfs-actions.pod:6369
16063 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16064 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16068 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
16073 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
16074 msgid "Single 8-bit-byte characters."
16078 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
16083 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
16084 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16088 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
16089 msgid "l (lower case letter L)"
16093 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
16095 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16096 "examining binaries in Windows guests."
16100 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16105 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
16106 msgid "32-bit big endian such as UCS-4BE."
16110 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
16115 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
16116 msgid "32-bit little endian such as UCS-4LE."
16120 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16121 msgid "The returned strings are transcoded to UTF-8."
16125 #: ../src/guestfs-actions.pod:6407
16126 msgid "guestfs_swapoff_device"
16130 #: ../src/guestfs-actions.pod:6409
16134 " guestfs_swapoff_device (guestfs_h *g,\n"
16135 " const char *device);\n"
16140 #: ../src/guestfs-actions.pod:6413
16142 "This command disables the libguestfs appliance swap device or partition "
16143 "named C<device>. See C<guestfs_swapon_device>."
16147 #: ../src/guestfs-actions.pod:6421
16148 msgid "guestfs_swapoff_file"
16152 #: ../src/guestfs-actions.pod:6423
16156 " guestfs_swapoff_file (guestfs_h *g,\n"
16157 " const char *file);\n"
16162 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
16163 msgid "This command disables the libguestfs appliance swap on file."
16167 #: ../src/guestfs-actions.pod:6433
16168 msgid "guestfs_swapoff_label"
16172 #: ../src/guestfs-actions.pod:6435
16176 " guestfs_swapoff_label (guestfs_h *g,\n"
16177 " const char *label);\n"
16182 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
16184 "This command disables the libguestfs appliance swap on labeled swap "
16189 #: ../src/guestfs-actions.pod:6446
16190 msgid "guestfs_swapoff_uuid"
16194 #: ../src/guestfs-actions.pod:6448
16198 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16199 " const char *uuid);\n"
16204 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
16206 "This command disables the libguestfs appliance swap partition with the given "
16211 #: ../src/guestfs-actions.pod:6459
16212 msgid "guestfs_swapon_device"
16216 #: ../src/guestfs-actions.pod:6461
16220 " guestfs_swapon_device (guestfs_h *g,\n"
16221 " const char *device);\n"
16226 #: ../src/guestfs-actions.pod:6465
16228 "This command enables the libguestfs appliance to use the swap device or "
16229 "partition named C<device>. The increased memory is made available for all "
16230 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16234 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
16236 "Note that you should not swap to existing guest swap partitions unless you "
16237 "know what you are doing. They may contain hibernation information, or other "
16238 "information that the guest doesn't want you to trash. You also risk leaking "
16239 "information about the host to the guest this way. Instead, attach a new "
16240 "host device to the guest and swap on that."
16244 #: ../src/guestfs-actions.pod:6481
16245 msgid "guestfs_swapon_file"
16249 #: ../src/guestfs-actions.pod:6483
16253 " guestfs_swapon_file (guestfs_h *g,\n"
16254 " const char *file);\n"
16259 #: ../src/guestfs-actions.pod:6487
16261 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16266 #: ../src/guestfs-actions.pod:6494
16267 msgid "guestfs_swapon_label"
16271 #: ../src/guestfs-actions.pod:6496
16275 " guestfs_swapon_label (guestfs_h *g,\n"
16276 " const char *label);\n"
16281 #: ../src/guestfs-actions.pod:6500
16283 "This command enables swap to a labeled swap partition. See "
16284 "C<guestfs_swapon_device> for other notes."
16288 #: ../src/guestfs-actions.pod:6507
16289 msgid "guestfs_swapon_uuid"
16293 #: ../src/guestfs-actions.pod:6509
16297 " guestfs_swapon_uuid (guestfs_h *g,\n"
16298 " const char *uuid);\n"
16303 #: ../src/guestfs-actions.pod:6513
16305 "This command enables swap to a swap partition with the given UUID. See "
16306 "C<guestfs_swapon_device> for other notes."
16310 #: ../src/guestfs-actions.pod:6520
16311 msgid "guestfs_sync"
16315 #: ../src/guestfs-actions.pod:6522
16319 " guestfs_sync (guestfs_h *g);\n"
16324 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
16326 "This syncs the disk, so that any writes are flushed through to the "
16327 "underlying disk image."
16331 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
16333 "You should always call this if you have modified a disk image, before "
16334 "closing the handle."
16338 #: ../src/guestfs-actions.pod:6535
16339 msgid "guestfs_tail"
16343 #: ../src/guestfs-actions.pod:6537
16347 " guestfs_tail (guestfs_h *g,\n"
16348 " const char *path);\n"
16353 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
16354 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16358 #: ../src/guestfs-actions.pod:6553
16359 msgid "guestfs_tail_n"
16363 #: ../src/guestfs-actions.pod:6555
16367 " guestfs_tail_n (guestfs_h *g,\n"
16369 " const char *path);\n"
16374 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
16376 "If the parameter C<nrlines> is a positive number, this returns the last "
16377 "C<nrlines> lines of the file C<path>."
16381 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
16383 "If the parameter C<nrlines> is a negative number, this returns lines from "
16384 "the file C<path>, starting with the C<-nrlines>th line."
16388 #: ../src/guestfs-actions.pod:6577
16389 msgid "guestfs_tar_in"
16393 #: ../src/guestfs-actions.pod:6579
16397 " guestfs_tar_in (guestfs_h *g,\n"
16398 " const char *tarfile,\n"
16399 " const char *directory);\n"
16404 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
16406 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16407 "tar file) into C<directory>."
16411 #: ../src/guestfs-actions.pod:6587
16412 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16416 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
16417 msgid "(Added in 1.0.3)"
16421 #: ../src/guestfs-actions.pod:6594
16422 msgid "guestfs_tar_out"
16426 #: ../src/guestfs-actions.pod:6596
16430 " guestfs_tar_out (guestfs_h *g,\n"
16431 " const char *directory,\n"
16432 " const char *tarfile);\n"
16437 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
16439 "This command packs the contents of C<directory> and downloads it to local "
16444 #: ../src/guestfs-actions.pod:6604
16446 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16447 "C<guestfs_txz_out>."
16451 #: ../src/guestfs-actions.pod:6611
16452 msgid "guestfs_tgz_in"
16456 #: ../src/guestfs-actions.pod:6613
16460 " guestfs_tgz_in (guestfs_h *g,\n"
16461 " const char *tarball,\n"
16462 " const char *directory);\n"
16467 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
16469 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16470 "tar file) into C<directory>."
16474 #: ../src/guestfs-actions.pod:6621
16475 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16479 #: ../src/guestfs-actions.pod:6627
16480 msgid "guestfs_tgz_out"
16484 #: ../src/guestfs-actions.pod:6629
16488 " guestfs_tgz_out (guestfs_h *g,\n"
16489 " const char *directory,\n"
16490 " const char *tarball);\n"
16495 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
16497 "This command packs the contents of C<directory> and downloads it to local "
16502 #: ../src/guestfs-actions.pod:6637
16503 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16507 #: ../src/guestfs-actions.pod:6643
16508 msgid "guestfs_touch"
16512 #: ../src/guestfs-actions.pod:6645
16516 " guestfs_touch (guestfs_h *g,\n"
16517 " const char *path);\n"
16522 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
16524 "Touch acts like the L<touch(1)> command. It can be used to update the "
16525 "timestamps on a file, or, if the file does not exist, to create a new "
16526 "zero-length file."
16530 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
16532 "This command only works on regular files, and will fail on other file types "
16533 "such as directories, symbolic links, block special etc."
16537 #: ../src/guestfs-actions.pod:6660
16538 msgid "guestfs_truncate"
16542 #: ../src/guestfs-actions.pod:6662
16546 " guestfs_truncate (guestfs_h *g,\n"
16547 " const char *path);\n"
16552 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
16554 "This command truncates C<path> to a zero-length file. The file must exist "
16559 #: ../src/guestfs-actions.pod:6673
16560 msgid "guestfs_truncate_size"
16564 #: ../src/guestfs-actions.pod:6675
16568 " guestfs_truncate_size (guestfs_h *g,\n"
16569 " const char *path,\n"
16570 " int64_t size);\n"
16575 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
16577 "This command truncates C<path> to size C<size> bytes. The file must exist "
16582 #: ../src/guestfs-actions.pod:6683
16584 "If the current file size is less than C<size> then the file is extended to "
16585 "the required size with zero bytes. This creates a sparse file (ie. disk "
16586 "blocks are not allocated for the file until you write to it). To create a "
16587 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16591 #: ../src/guestfs-actions.pod:6693
16592 msgid "guestfs_tune2fs_l"
16596 #: ../src/guestfs-actions.pod:6695
16600 " guestfs_tune2fs_l (guestfs_h *g,\n"
16601 " const char *device);\n"
16606 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
16608 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16613 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
16615 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16616 "for more details. The list of fields returned isn't clearly defined, and "
16617 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16618 "and the filesystem itself."
16622 #: ../src/guestfs-actions.pod:6715
16623 msgid "guestfs_txz_in"
16627 #: ../src/guestfs-actions.pod:6717
16631 " guestfs_txz_in (guestfs_h *g,\n"
16632 " const char *tarball,\n"
16633 " const char *directory);\n"
16638 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
16640 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16641 "tar file) into C<directory>."
16645 #: ../src/guestfs-actions.pod:6729
16646 msgid "guestfs_txz_out"
16650 #: ../src/guestfs-actions.pod:6731
16654 " guestfs_txz_out (guestfs_h *g,\n"
16655 " const char *directory,\n"
16656 " const char *tarball);\n"
16661 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
16663 "This command packs the contents of C<directory> and downloads it to local "
16664 "file C<tarball> (as an xz compressed tar archive)."
16668 #: ../src/guestfs-actions.pod:6743
16669 msgid "guestfs_umask"
16673 #: ../src/guestfs-actions.pod:6745
16677 " guestfs_umask (guestfs_h *g,\n"
16683 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
16685 "This function sets the mask used for creating new files and device nodes to "
16690 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
16692 "Typical umask values would be C<022> which creates new files with "
16693 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16694 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16698 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
16700 "The default umask is C<022>. This is important because it means that "
16701 "directories and device nodes will be created with C<0644> or C<0755> mode "
16702 "even if you specify C<0777>."
16706 #: ../src/guestfs-actions.pod:6761
16708 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16709 "C<guestfs_mkdir>."
16713 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
16714 msgid "This call returns the previous umask."
16718 #: ../src/guestfs-actions.pod:6770
16719 msgid "guestfs_umount"
16723 #: ../src/guestfs-actions.pod:6772
16727 " guestfs_umount (guestfs_h *g,\n"
16728 " const char *pathordevice);\n"
16733 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
16735 "This unmounts the given filesystem. The filesystem may be specified either "
16736 "by its mountpoint (path) or the device which contains the filesystem."
16740 #: ../src/guestfs-actions.pod:6784
16741 msgid "guestfs_umount_all"
16745 #: ../src/guestfs-actions.pod:6786
16749 " guestfs_umount_all (guestfs_h *g);\n"
16754 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
16755 msgid "This unmounts all mounted filesystems."
16759 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
16760 msgid "Some internal mounts are not unmounted by this call."
16764 #: ../src/guestfs-actions.pod:6797
16765 msgid "guestfs_upload"
16769 #: ../src/guestfs-actions.pod:6799
16773 " guestfs_upload (guestfs_h *g,\n"
16774 " const char *filename,\n"
16775 " const char *remotefilename);\n"
16780 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
16781 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
16785 #: ../src/guestfs-actions.pod:6809
16786 msgid "See also C<guestfs_download>."
16790 #: ../src/guestfs-actions.pod:6820
16791 msgid "guestfs_upload_offset"
16795 #: ../src/guestfs-actions.pod:6822
16799 " guestfs_upload_offset (guestfs_h *g,\n"
16800 " const char *filename,\n"
16801 " const char *remotefilename,\n"
16802 " int64_t offset);\n"
16807 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
16809 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
16810 "The intention is to overwrite parts of existing files or devices, although "
16811 "if a non-existant file is specified then it is created with a \"hole\" "
16812 "before C<offset>. The size of the data written is implicit in the size of "
16813 "the source C<filename>."
16817 #: ../src/guestfs-actions.pod:6838
16819 "Note that there is no limit on the amount of data that can be uploaded with "
16820 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
16821 "full amount unless an error occurs."
16825 #: ../src/guestfs-actions.pod:6843
16826 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
16830 #: ../src/guestfs-actions.pod:6854
16831 msgid "guestfs_utimens"
16835 #: ../src/guestfs-actions.pod:6856
16839 " guestfs_utimens (guestfs_h *g,\n"
16840 " const char *path,\n"
16841 " int64_t atsecs,\n"
16842 " int64_t atnsecs,\n"
16843 " int64_t mtsecs,\n"
16844 " int64_t mtnsecs);\n"
16849 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
16850 msgid "This command sets the timestamps of a file with nanosecond precision."
16854 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
16856 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16861 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
16863 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16864 "nanoseconds from the epoch."
16868 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
16870 "If the C<*nsecs> field contains the special value C<-1> then the "
16871 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16872 "ignored in this case)."
16876 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
16878 "If the C<*nsecs> field contains the special value C<-2> then the "
16879 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16884 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
16885 msgid "guestfs_version"
16889 #: ../src/guestfs-actions.pod:6887
16892 " struct guestfs_version *\n"
16893 " guestfs_version (guestfs_h *g);\n"
16898 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
16899 msgid "Return the libguestfs version number that the program is linked against."
16903 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
16905 "Note that because of dynamic linking this is not necessarily the version of "
16906 "libguestfs that you compiled against. You can compile the program, and then "
16907 "at runtime dynamically link against a completely different C<libguestfs.so> "
16912 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
16914 "This call was added in version C<1.0.58>. In previous versions of "
16915 "libguestfs there was no way to get the version number. From C code you can "
16916 "use dynamic linker functions to find out if this symbol exists (if it "
16917 "doesn't, then it's an earlier version)."
16921 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
16923 "The call returns a structure with four elements. The first three (C<major>, "
16924 "C<minor> and C<release>) are numbers and correspond to the usual version "
16925 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16926 "but may be used for distro-specific information."
16930 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
16931 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16935 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
16936 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16940 #: ../src/guestfs-actions.pod:6915
16942 "I<Note:> Don't use this call to test for availability of features. In "
16943 "enterprise distributions we backport features from later versions into "
16944 "earlier versions, making this an unreliable way to test for features. Use "
16945 "C<guestfs_available> instead."
16949 #: ../src/guestfs-actions.pod:6921
16951 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
16952 "error. I<The caller must call C<guestfs_free_version> after use>."
16956 #: ../src/guestfs-actions.pod:6925
16957 msgid "(Added in 1.0.58)"
16961 #: ../src/guestfs-actions.pod:6927
16962 msgid "guestfs_vfs_label"
16966 #: ../src/guestfs-actions.pod:6929
16970 " guestfs_vfs_label (guestfs_h *g,\n"
16971 " const char *device);\n"
16976 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
16977 msgid "This returns the filesystem label of the filesystem on C<device>."
16981 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
16982 msgid "If the filesystem is unlabeled, this returns the empty string."
16986 #: ../src/guestfs-actions.pod:6938
16987 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16991 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
16992 msgid "(Added in 1.3.18)"
16996 #: ../src/guestfs-actions.pod:6945
16997 msgid "guestfs_vfs_type"
17001 #: ../src/guestfs-actions.pod:6947
17005 " guestfs_vfs_type (guestfs_h *g,\n"
17006 " const char *device);\n"
17011 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
17013 "This command gets the filesystem type corresponding to the filesystem on "
17018 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
17020 "For most filesystems, the result is the name of the Linux VFS module which "
17021 "would be used to mount this filesystem if you mounted it without specifying "
17022 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17026 #: ../src/guestfs-actions.pod:6964
17027 msgid "guestfs_vfs_uuid"
17031 #: ../src/guestfs-actions.pod:6966
17035 " guestfs_vfs_uuid (guestfs_h *g,\n"
17036 " const char *device);\n"
17041 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
17042 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17046 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
17047 msgid "If the filesystem does not have a UUID, this returns the empty string."
17051 #: ../src/guestfs-actions.pod:6975
17052 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17056 #: ../src/guestfs-actions.pod:6982
17057 msgid "guestfs_vg_activate"
17061 #: ../src/guestfs-actions.pod:6984
17065 " guestfs_vg_activate (guestfs_h *g,\n"
17067 " char *const *volgroups);\n"
17072 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
17074 "This command activates or (if C<activate> is false) deactivates all logical "
17075 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17076 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17077 "deactivated, then those devices disappear."
17081 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
17082 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17086 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17088 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17089 "activated or deactivated."
17093 #: ../src/guestfs-actions.pod:7004
17094 msgid "guestfs_vg_activate_all"
17098 #: ../src/guestfs-actions.pod:7006
17102 " guestfs_vg_activate_all (guestfs_h *g,\n"
17103 " int activate);\n"
17108 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
17110 "This command activates or (if C<activate> is false) deactivates all logical "
17111 "volumes in all volume groups. If activated, then they are made known to the "
17112 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17113 "those devices disappear."
17117 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
17118 msgid "This command is the same as running C<vgchange -a y|n>"
17122 #: ../src/guestfs-actions.pod:7022
17123 msgid "guestfs_vgcreate"
17127 #: ../src/guestfs-actions.pod:7024
17131 " guestfs_vgcreate (guestfs_h *g,\n"
17132 " const char *volgroup,\n"
17133 " char *const *physvols);\n"
17138 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
17140 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17141 "of physical volumes C<physvols>."
17145 #: ../src/guestfs-actions.pod:7036
17146 msgid "guestfs_vglvuuids"
17150 #: ../src/guestfs-actions.pod:7038
17154 " guestfs_vglvuuids (guestfs_h *g,\n"
17155 " const char *vgname);\n"
17160 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
17162 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17163 "volumes created in this volume group."
17167 #: ../src/guestfs-actions.pod:7045
17169 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17170 "associate logical volumes and volume groups."
17174 #: ../src/guestfs-actions.pod:7048
17175 msgid "See also C<guestfs_vgpvuuids>."
17179 #: ../src/guestfs-actions.pod:7056
17180 msgid "guestfs_vgpvuuids"
17184 #: ../src/guestfs-actions.pod:7058
17188 " guestfs_vgpvuuids (guestfs_h *g,\n"
17189 " const char *vgname);\n"
17194 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
17196 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17197 "volumes that this volume group resides on."
17201 #: ../src/guestfs-actions.pod:7065
17203 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17204 "associate physical volumes and volume groups."
17208 #: ../src/guestfs-actions.pod:7068
17209 msgid "See also C<guestfs_vglvuuids>."
17213 #: ../src/guestfs-actions.pod:7076
17214 msgid "guestfs_vgremove"
17218 #: ../src/guestfs-actions.pod:7078
17222 " guestfs_vgremove (guestfs_h *g,\n"
17223 " const char *vgname);\n"
17228 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
17229 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17233 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
17234 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17238 #: ../src/guestfs-actions.pod:7091
17239 msgid "guestfs_vgrename"
17243 #: ../src/guestfs-actions.pod:7093
17247 " guestfs_vgrename (guestfs_h *g,\n"
17248 " const char *volgroup,\n"
17249 " const char *newvolgroup);\n"
17254 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
17255 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17259 #: ../src/guestfs-actions.pod:7104
17260 msgid "guestfs_vgs"
17264 #: ../src/guestfs-actions.pod:7106
17268 " guestfs_vgs (guestfs_h *g);\n"
17273 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
17275 "List all the volumes groups detected. This is the equivalent of the "
17276 "L<vgs(8)> command."
17280 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
17282 "This returns a list of just the volume group names that were detected "
17283 "(eg. C<VolGroup00>)."
17287 #: ../src/guestfs-actions.pod:7115
17288 msgid "See also C<guestfs_vgs_full>."
17292 #: ../src/guestfs-actions.pod:7123
17293 msgid "guestfs_vgs_full"
17297 #: ../src/guestfs-actions.pod:7125
17300 " struct guestfs_lvm_vg_list *\n"
17301 " guestfs_vgs_full (guestfs_h *g);\n"
17306 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
17308 "List all the volumes groups detected. This is the equivalent of the "
17309 "L<vgs(8)> command. The \"full\" version includes all fields."
17313 #: ../src/guestfs-actions.pod:7131
17315 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17316 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17321 #: ../src/guestfs-actions.pod:7137
17322 msgid "guestfs_vgscan"
17326 #: ../src/guestfs-actions.pod:7139
17330 " guestfs_vgscan (guestfs_h *g);\n"
17335 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
17337 "This rescans all block devices and rebuilds the list of LVM physical "
17338 "volumes, volume groups and logical volumes."
17342 #: ../src/guestfs-actions.pod:7149
17343 msgid "guestfs_vguuid"
17347 #: ../src/guestfs-actions.pod:7151
17351 " guestfs_vguuid (guestfs_h *g,\n"
17352 " const char *vgname);\n"
17357 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
17358 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17362 #: ../src/guestfs-actions.pod:7162
17363 msgid "guestfs_wait_ready"
17367 #: ../src/guestfs-actions.pod:7164
17371 " guestfs_wait_ready (guestfs_h *g);\n"
17376 #: ../src/guestfs-actions.pod:7167
17377 msgid "This function is a no op."
17381 #: ../src/guestfs-actions.pod:7169
17383 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17384 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17385 "is no longer necessary because C<guestfs_launch> now does the waiting."
17389 #: ../src/guestfs-actions.pod:7174
17391 "If you see any calls to this function in code then you can just remove them, "
17392 "unless you want to retain compatibility with older versions of the API."
17396 #: ../src/guestfs-actions.pod:7182
17397 msgid "guestfs_wc_c"
17401 #: ../src/guestfs-actions.pod:7184
17405 " guestfs_wc_c (guestfs_h *g,\n"
17406 " const char *path);\n"
17411 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
17413 "This command counts the characters in a file, using the C<wc -c> external "
17418 #: ../src/guestfs-actions.pod:7195
17419 msgid "guestfs_wc_l"
17423 #: ../src/guestfs-actions.pod:7197
17427 " guestfs_wc_l (guestfs_h *g,\n"
17428 " const char *path);\n"
17433 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
17435 "This command counts the lines in a file, using the C<wc -l> external "
17440 #: ../src/guestfs-actions.pod:7208
17441 msgid "guestfs_wc_w"
17445 #: ../src/guestfs-actions.pod:7210
17449 " guestfs_wc_w (guestfs_h *g,\n"
17450 " const char *path);\n"
17455 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
17457 "This command counts the words in a file, using the C<wc -w> external "
17462 #: ../src/guestfs-actions.pod:7221
17463 msgid "guestfs_write"
17467 #: ../src/guestfs-actions.pod:7223
17471 " guestfs_write (guestfs_h *g,\n"
17472 " const char *path,\n"
17473 " const char *content,\n"
17474 " size_t content_size);\n"
17479 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
17481 "This call creates a file called C<path>. The content of the file is the "
17482 "string C<content> (which can contain any 8 bit data)."
17486 #: ../src/guestfs-actions.pod:7239
17487 msgid "guestfs_write_file"
17491 #: ../src/guestfs-actions.pod:7241
17495 " guestfs_write_file (guestfs_h *g,\n"
17496 " const char *path,\n"
17497 " const char *content,\n"
17503 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
17505 "This call creates a file called C<path>. The contents of the file is the "
17506 "string C<content> (which can contain any 8 bit data), with length C<size>."
17510 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
17512 "As a special case, if C<size> is C<0> then the length is calculated using "
17513 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17517 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
17519 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17520 "I<not> work, even if the length is specified."
17524 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
17525 msgid "This function is deprecated. In new code, use the C<write> call instead."
17529 #: ../src/guestfs-actions.pod:7272
17530 msgid "guestfs_zegrep"
17534 #: ../src/guestfs-actions.pod:7274
17538 " guestfs_zegrep (guestfs_h *g,\n"
17539 " const char *regex,\n"
17540 " const char *path);\n"
17545 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
17546 msgid "This calls the external C<zegrep> program and returns the matching lines."
17550 #: ../src/guestfs-actions.pod:7291
17551 msgid "guestfs_zegrepi"
17555 #: ../src/guestfs-actions.pod:7293
17559 " guestfs_zegrepi (guestfs_h *g,\n"
17560 " const char *regex,\n"
17561 " const char *path);\n"
17566 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
17567 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17571 #: ../src/guestfs-actions.pod:7310
17572 msgid "guestfs_zero"
17576 #: ../src/guestfs-actions.pod:7312
17580 " guestfs_zero (guestfs_h *g,\n"
17581 " const char *device);\n"
17586 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
17587 msgid "This command writes zeroes over the first few blocks of C<device>."
17591 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
17593 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17594 "securely wipe the device). It should be sufficient to remove any partition "
17595 "tables, filesystem superblocks and so on."
17599 #: ../src/guestfs-actions.pod:7322
17600 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17604 #: ../src/guestfs-actions.pod:7333
17605 msgid "guestfs_zero_device"
17609 #: ../src/guestfs-actions.pod:7335
17613 " guestfs_zero_device (guestfs_h *g,\n"
17614 " const char *device);\n"
17619 #: ../src/guestfs-actions.pod:7339
17621 "This command writes zeroes over the entire C<device>. Compare with "
17622 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17626 #: ../src/guestfs-actions.pod:7353
17627 msgid "(Added in 1.3.1)"
17631 #: ../src/guestfs-actions.pod:7355
17632 msgid "guestfs_zerofree"
17636 #: ../src/guestfs-actions.pod:7357
17640 " guestfs_zerofree (guestfs_h *g,\n"
17641 " const char *device);\n"
17646 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
17648 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17649 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17650 "possible to compress the filesystem more effectively."
17654 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
17655 msgid "You should B<not> run this program if the filesystem is mounted."
17659 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
17661 "It is possible that using this program can damage the filesystem or data on "
17666 #: ../src/guestfs-actions.pod:7376
17667 msgid "guestfs_zfgrep"
17671 #: ../src/guestfs-actions.pod:7378
17675 " guestfs_zfgrep (guestfs_h *g,\n"
17676 " const char *pattern,\n"
17677 " const char *path);\n"
17682 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
17683 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17687 #: ../src/guestfs-actions.pod:7395
17688 msgid "guestfs_zfgrepi"
17692 #: ../src/guestfs-actions.pod:7397
17696 " guestfs_zfgrepi (guestfs_h *g,\n"
17697 " const char *pattern,\n"
17698 " const char *path);\n"
17703 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
17704 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17708 #: ../src/guestfs-actions.pod:7414
17709 msgid "guestfs_zfile"
17713 #: ../src/guestfs-actions.pod:7416
17717 " guestfs_zfile (guestfs_h *g,\n"
17718 " const char *meth,\n"
17719 " const char *path);\n"
17724 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
17725 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17729 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
17730 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17734 #: ../src/guestfs-actions.pod:7426
17736 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17741 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
17742 msgid "This function is deprecated. In new code, use the C<file> call instead."
17746 #: ../src/guestfs-actions.pod:7441
17747 msgid "guestfs_zgrep"
17751 #: ../src/guestfs-actions.pod:7443
17755 " guestfs_zgrep (guestfs_h *g,\n"
17756 " const char *regex,\n"
17757 " const char *path);\n"
17762 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
17763 msgid "This calls the external C<zgrep> program and returns the matching lines."
17767 #: ../src/guestfs-actions.pod:7460
17768 msgid "guestfs_zgrepi"
17772 #: ../src/guestfs-actions.pod:7462
17776 " guestfs_zgrepi (guestfs_h *g,\n"
17777 " const char *regex,\n"
17778 " const char *path);\n"
17783 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
17784 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
17788 #: ../src/guestfs-availability.pod:3
17793 #: ../src/guestfs-availability.pod:5
17795 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
17796 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
17797 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
17798 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
17799 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
17803 #: ../src/guestfs-availability.pod:21
17808 #: ../src/guestfs-availability.pod:23
17810 "The following functions: L</guestfs_inotify_add_watch> "
17811 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
17812 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
17816 #: ../src/guestfs-availability.pod:31
17817 msgid "B<linuxfsuuid>"
17821 #: ../src/guestfs-availability.pod:33
17823 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
17824 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
17828 #: ../src/guestfs-availability.pod:40
17829 msgid "B<linuxmodules>"
17833 #: ../src/guestfs-availability.pod:42
17834 msgid "The following functions: L</guestfs_modprobe>"
17838 #: ../src/guestfs-availability.pod:45
17839 msgid "B<linuxxattrs>"
17843 #: ../src/guestfs-availability.pod:47
17845 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
17846 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
17847 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
17848 "L</guestfs_setxattr>"
17852 #: ../src/guestfs-availability.pod:58
17857 #: ../src/guestfs-availability.pod:60
17859 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
17860 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
17861 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
17865 #: ../src/guestfs-availability.pod:69
17870 #: ../src/guestfs-availability.pod:71
17872 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
17873 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
17874 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
17875 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
17876 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
17877 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
17878 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
17879 "L</guestfs_vgs_full>"
17883 #: ../src/guestfs-availability.pod:94
17888 #: ../src/guestfs-availability.pod:96
17890 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
17891 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
17895 #: ../src/guestfs-availability.pod:102
17900 #: ../src/guestfs-availability.pod:104
17901 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
17905 #: ../src/guestfs-availability.pod:107
17906 msgid "B<ntfsprogs>"
17910 #: ../src/guestfs-availability.pod:109
17911 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
17915 #: ../src/guestfs-availability.pod:113
17916 msgid "B<realpath>"
17920 #: ../src/guestfs-availability.pod:115
17921 msgid "The following functions: L</guestfs_realpath>"
17925 #: ../src/guestfs-availability.pod:118
17930 #: ../src/guestfs-availability.pod:120
17932 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
17933 "L</guestfs_scrub_freespace>"
17937 #: ../src/guestfs-availability.pod:125
17942 #: ../src/guestfs-availability.pod:127
17943 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
17947 #: ../src/guestfs-availability.pod:131
17952 #: ../src/guestfs-availability.pod:133
17953 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
17957 #: ../src/guestfs-availability.pod:137
17958 msgid "B<zerofree>"
17962 #: ../src/guestfs-availability.pod:139
17963 msgid "The following functions: L</guestfs_zerofree>"
17967 #: ../src/guestfs-structs.pod:1
17968 msgid "guestfs_int_bool"
17972 #: ../src/guestfs-structs.pod:3
17975 " struct guestfs_int_bool {\n"
17983 #: ../src/guestfs-structs.pod:8
17986 " struct guestfs_int_bool_list {\n"
17987 " uint32_t len; /* Number of elements in list. */\n"
17988 " struct guestfs_int_bool *val; /* Elements. */\n"
17994 #: ../src/guestfs-structs.pod:13
17997 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17998 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18003 #: ../src/guestfs-structs.pod:16
18004 msgid "guestfs_lvm_pv"
18008 #: ../src/guestfs-structs.pod:18
18011 " struct guestfs_lvm_pv {\n"
18012 " char *pv_name;\n"
18013 " /* The next field is NOT nul-terminated, be careful when printing it: "
18015 " char pv_uuid[32];\n"
18017 " uint64_t pv_size;\n"
18018 " uint64_t dev_size;\n"
18019 " uint64_t pv_free;\n"
18020 " uint64_t pv_used;\n"
18021 " char *pv_attr;\n"
18022 " int64_t pv_pe_count;\n"
18023 " int64_t pv_pe_alloc_count;\n"
18024 " char *pv_tags;\n"
18025 " uint64_t pe_start;\n"
18026 " int64_t pv_mda_count;\n"
18027 " uint64_t pv_mda_free;\n"
18033 #: ../src/guestfs-structs.pod:36
18036 " struct guestfs_lvm_pv_list {\n"
18037 " uint32_t len; /* Number of elements in list. */\n"
18038 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18044 #: ../src/guestfs-structs.pod:41
18047 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18048 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18053 #: ../src/guestfs-structs.pod:44
18054 msgid "guestfs_lvm_vg"
18058 #: ../src/guestfs-structs.pod:46
18061 " struct guestfs_lvm_vg {\n"
18062 " char *vg_name;\n"
18063 " /* The next field is NOT nul-terminated, be careful when printing it: "
18065 " char vg_uuid[32];\n"
18067 " char *vg_attr;\n"
18068 " uint64_t vg_size;\n"
18069 " uint64_t vg_free;\n"
18070 " char *vg_sysid;\n"
18071 " uint64_t vg_extent_size;\n"
18072 " int64_t vg_extent_count;\n"
18073 " int64_t vg_free_count;\n"
18074 " int64_t max_lv;\n"
18075 " int64_t max_pv;\n"
18076 " int64_t pv_count;\n"
18077 " int64_t lv_count;\n"
18078 " int64_t snap_count;\n"
18079 " int64_t vg_seqno;\n"
18080 " char *vg_tags;\n"
18081 " int64_t vg_mda_count;\n"
18082 " uint64_t vg_mda_free;\n"
18088 #: ../src/guestfs-structs.pod:69
18091 " struct guestfs_lvm_vg_list {\n"
18092 " uint32_t len; /* Number of elements in list. */\n"
18093 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18099 #: ../src/guestfs-structs.pod:74
18102 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18103 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18108 #: ../src/guestfs-structs.pod:77
18109 msgid "guestfs_lvm_lv"
18113 #: ../src/guestfs-structs.pod:79
18116 " struct guestfs_lvm_lv {\n"
18117 " char *lv_name;\n"
18118 " /* The next field is NOT nul-terminated, be careful when printing it: "
18120 " char lv_uuid[32];\n"
18121 " char *lv_attr;\n"
18122 " int64_t lv_major;\n"
18123 " int64_t lv_minor;\n"
18124 " int64_t lv_kernel_major;\n"
18125 " int64_t lv_kernel_minor;\n"
18126 " uint64_t lv_size;\n"
18127 " int64_t seg_count;\n"
18129 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18130 " float snap_percent;\n"
18131 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18132 " float copy_percent;\n"
18133 " char *move_pv;\n"
18134 " char *lv_tags;\n"
18135 " char *mirror_log;\n"
18136 " char *modules;\n"
18142 #: ../src/guestfs-structs.pod:101
18145 " struct guestfs_lvm_lv_list {\n"
18146 " uint32_t len; /* Number of elements in list. */\n"
18147 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18153 #: ../src/guestfs-structs.pod:106
18156 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18157 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18162 #: ../src/guestfs-structs.pod:111
18165 " struct guestfs_stat {\n"
18169 " int64_t nlink;\n"
18174 " int64_t blksize;\n"
18175 " int64_t blocks;\n"
18176 " int64_t atime;\n"
18177 " int64_t mtime;\n"
18178 " int64_t ctime;\n"
18184 #: ../src/guestfs-structs.pod:127
18187 " struct guestfs_stat_list {\n"
18188 " uint32_t len; /* Number of elements in list. */\n"
18189 " struct guestfs_stat *val; /* Elements. */\n"
18195 #: ../src/guestfs-structs.pod:132
18198 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18199 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18204 #: ../src/guestfs-structs.pod:137
18207 " struct guestfs_statvfs {\n"
18208 " int64_t bsize;\n"
18209 " int64_t frsize;\n"
18210 " int64_t blocks;\n"
18211 " int64_t bfree;\n"
18212 " int64_t bavail;\n"
18213 " int64_t files;\n"
18214 " int64_t ffree;\n"
18215 " int64_t favail;\n"
18218 " int64_t namemax;\n"
18224 #: ../src/guestfs-structs.pod:151
18227 " struct guestfs_statvfs_list {\n"
18228 " uint32_t len; /* Number of elements in list. */\n"
18229 " struct guestfs_statvfs *val; /* Elements. */\n"
18235 #: ../src/guestfs-structs.pod:156
18238 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18239 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18244 #: ../src/guestfs-structs.pod:159
18245 msgid "guestfs_dirent"
18249 #: ../src/guestfs-structs.pod:161
18252 " struct guestfs_dirent {\n"
18261 #: ../src/guestfs-structs.pod:167
18264 " struct guestfs_dirent_list {\n"
18265 " uint32_t len; /* Number of elements in list. */\n"
18266 " struct guestfs_dirent *val; /* Elements. */\n"
18272 #: ../src/guestfs-structs.pod:172
18275 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18276 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18281 #: ../src/guestfs-structs.pod:177
18284 " struct guestfs_version {\n"
18285 " int64_t major;\n"
18286 " int64_t minor;\n"
18287 " int64_t release;\n"
18294 #: ../src/guestfs-structs.pod:184
18297 " struct guestfs_version_list {\n"
18298 " uint32_t len; /* Number of elements in list. */\n"
18299 " struct guestfs_version *val; /* Elements. */\n"
18305 #: ../src/guestfs-structs.pod:189
18308 " void guestfs_free_version (struct guestfs_free_version *);\n"
18309 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18314 #: ../src/guestfs-structs.pod:192
18315 msgid "guestfs_xattr"
18319 #: ../src/guestfs-structs.pod:194
18322 " struct guestfs_xattr {\n"
18323 " char *attrname;\n"
18324 " /* The next two fields describe a byte array. */\n"
18325 " uint32_t attrval_len;\n"
18326 " char *attrval;\n"
18332 #: ../src/guestfs-structs.pod:201
18335 " struct guestfs_xattr_list {\n"
18336 " uint32_t len; /* Number of elements in list. */\n"
18337 " struct guestfs_xattr *val; /* Elements. */\n"
18343 #: ../src/guestfs-structs.pod:206
18346 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18347 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18352 #: ../src/guestfs-structs.pod:209
18353 msgid "guestfs_inotify_event"
18357 #: ../src/guestfs-structs.pod:211
18360 " struct guestfs_inotify_event {\n"
18361 " int64_t in_wd;\n"
18362 " uint32_t in_mask;\n"
18363 " uint32_t in_cookie;\n"
18364 " char *in_name;\n"
18370 #: ../src/guestfs-structs.pod:218
18373 " struct guestfs_inotify_event_list {\n"
18374 " uint32_t len; /* Number of elements in list. */\n"
18375 " struct guestfs_inotify_event *val; /* Elements. */\n"
18381 #: ../src/guestfs-structs.pod:223
18384 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18385 " void guestfs_free_inotify_event_list (struct "
18386 "guestfs_free_inotify_event_list *);\n"
18391 #: ../src/guestfs-structs.pod:226
18392 msgid "guestfs_partition"
18396 #: ../src/guestfs-structs.pod:228
18399 " struct guestfs_partition {\n"
18400 " int32_t part_num;\n"
18401 " uint64_t part_start;\n"
18402 " uint64_t part_end;\n"
18403 " uint64_t part_size;\n"
18409 #: ../src/guestfs-structs.pod:235
18412 " struct guestfs_partition_list {\n"
18413 " uint32_t len; /* Number of elements in list. */\n"
18414 " struct guestfs_partition *val; /* Elements. */\n"
18420 #: ../src/guestfs-structs.pod:240
18423 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18424 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18429 #: ../src/guestfs-structs.pod:243
18430 msgid "guestfs_application"
18434 #: ../src/guestfs-structs.pod:245
18437 " struct guestfs_application {\n"
18438 " char *app_name;\n"
18439 " char *app_display_name;\n"
18440 " int32_t app_epoch;\n"
18441 " char *app_version;\n"
18442 " char *app_release;\n"
18443 " char *app_install_path;\n"
18444 " char *app_trans_path;\n"
18445 " char *app_publisher;\n"
18446 " char *app_url;\n"
18447 " char *app_source_package;\n"
18448 " char *app_summary;\n"
18449 " char *app_description;\n"
18455 #: ../src/guestfs-structs.pod:260
18458 " struct guestfs_application_list {\n"
18459 " uint32_t len; /* Number of elements in list. */\n"
18460 " struct guestfs_application *val; /* Elements. */\n"
18466 #: ../src/guestfs-structs.pod:265
18469 " void guestfs_free_application (struct guestfs_free_application *);\n"
18470 " void guestfs_free_application_list (struct guestfs_free_application_list "
18476 #: ../fish/guestfish.pod:5
18477 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18481 #: ../fish/guestfish.pod:9
18484 " guestfish [--options] [commands]\n"
18489 #: ../fish/guestfish.pod:11
18497 #: ../fish/guestfish.pod:13
18500 " guestfish [--ro|--rw] -a disk.img\n"
18505 #: ../fish/guestfish.pod:15
18508 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18513 #: ../fish/guestfish.pod:17
18516 " guestfish -d libvirt-domain\n"
18521 #: ../fish/guestfish.pod:19
18524 " guestfish [--ro|--rw] -a disk.img -i\n"
18529 #: ../fish/guestfish.pod:21
18532 " guestfish -d libvirt-domain -i\n"
18537 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18542 #: ../fish/guestfish.pod:25
18544 "Using guestfish in read/write mode on live virtual machines can be "
18545 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18546 "option to use guestfish safely if the disk image or virtual machine might be "
18551 #: ../fish/guestfish.pod:32
18553 "Guestfish is a shell and command-line tool for examining and modifying "
18554 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18555 "functionality of the guestfs API, see L<guestfs(3)>."
18559 #: ../fish/guestfish.pod:36
18561 "Guestfish gives you structured access to the libguestfs API, from shell "
18562 "scripts or the command line or interactively. If you want to rescue a "
18563 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18568 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
18573 #: ../fish/guestfish.pod:43
18574 msgid "As an interactive shell"
18578 #: ../fish/guestfish.pod:45
18586 #: ../fish/guestfish.pod:47
18589 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18590 " editing virtual machine filesystems.\n"
18595 #: ../fish/guestfish.pod:50
18598 " Type: 'help' for a list of commands\n"
18599 " 'man' to read the manual\n"
18600 " 'quit' to quit the shell\n"
18605 #: ../fish/guestfish.pod:54
18608 " ><fs> add-ro disk.img\n"
18610 " ><fs> list-filesystems\n"
18611 " /dev/sda1: ext4\n"
18612 " /dev/vg_guest/lv_root: ext4\n"
18613 " /dev/vg_guest/lv_swap: swap\n"
18614 " ><fs> mount /dev/vg_guest/lv_root /\n"
18615 " ><fs> cat /etc/fstab\n"
18617 " # Created by anaconda\n"
18624 #: ../fish/guestfish.pod:67
18625 msgid "From shell scripts"
18629 #: ../fish/guestfish.pod:69
18630 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18634 #: ../fish/guestfish.pod:71
18637 " guestfish <<_EOF_\n"
18640 " mount /dev/vg_guest/lv_root /\n"
18641 " write /etc/motd \"Welcome, new users\"\n"
18647 #: ../fish/guestfish.pod:78
18648 msgid "List the LVM logical volumes in a disk image:"
18652 #: ../fish/guestfish.pod:80
18655 " guestfish -a disk.img --ro <<_EOF_\n"
18663 #: ../fish/guestfish.pod:85
18664 msgid "List all the filesystems in a disk image:"
18668 #: ../fish/guestfish.pod:87
18671 " guestfish -a disk.img --ro <<_EOF_\n"
18673 " list-filesystems\n"
18679 #: ../fish/guestfish.pod:92
18680 msgid "On one command line"
18684 #: ../fish/guestfish.pod:94
18685 msgid "Update C</etc/resolv.conf> in a guest:"
18689 #: ../fish/guestfish.pod:96
18693 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18694 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18699 #: ../fish/guestfish.pod:100
18700 msgid "Edit C</boot/grub/grub.conf> interactively:"
18704 #: ../fish/guestfish.pod:102
18707 " guestfish --rw --add disk.img \\\n"
18708 " --mount /dev/vg_guest/lv_root \\\n"
18709 " --mount /dev/sda1:/boot \\\n"
18710 " edit /boot/grub/grub.conf\n"
18715 #: ../fish/guestfish.pod:107
18716 msgid "Mount disks automatically"
18720 #: ../fish/guestfish.pod:109
18722 "Use the I<-i> option to automatically mount the disks from a virtual "
18727 #: ../fish/guestfish.pod:112
18730 " guestfish --ro -a disk.img -i cat /etc/group\n"
18735 #: ../fish/guestfish.pod:114
18738 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18743 #: ../fish/guestfish.pod:116
18744 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18748 #: ../fish/guestfish.pod:118
18751 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18756 #: ../fish/guestfish.pod:120
18757 msgid "As a script interpreter"
18761 #: ../fish/guestfish.pod:122
18762 msgid "Create a 100MB disk containing an ext2-formatted partition:"
18766 #: ../fish/guestfish.pod:124
18769 " #!/usr/bin/guestfish -f\n"
18770 " sparse test1.img 100M\n"
18772 " part-disk /dev/sda mbr\n"
18773 " mkfs ext2 /dev/sda1\n"
18778 #: ../fish/guestfish.pod:130
18779 msgid "Start with a prepared disk"
18783 #: ../fish/guestfish.pod:132
18785 "An alternate way to create a 100MB disk called C<test1.img> containing a "
18786 "single ext2-formatted partition:"
18790 #: ../fish/guestfish.pod:135
18793 " guestfish -N fs\n"
18798 #: ../fish/guestfish.pod:137
18799 msgid "To list what is available do:"
18803 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
18806 " guestfish -N help | less\n"
18811 #: ../fish/guestfish.pod:141
18812 msgid "Remote control"
18816 #: ../fish/guestfish.pod:143
18819 " eval \"`guestfish --listen`\"\n"
18820 " guestfish --remote add-ro disk.img\n"
18821 " guestfish --remote run\n"
18822 " guestfish --remote lvs\n"
18827 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81 ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
18832 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
18837 #: ../fish/guestfish.pod:154
18838 msgid "Displays general help on options."
18842 #: ../fish/guestfish.pod:156
18847 #: ../fish/guestfish.pod:158
18848 msgid "B<--cmd-help>"
18852 #: ../fish/guestfish.pod:160
18853 msgid "Lists all available guestfish commands."
18857 #: ../fish/guestfish.pod:162
18862 #: ../fish/guestfish.pod:164
18863 msgid "B<--cmd-help cmd>"
18867 #: ../fish/guestfish.pod:166
18868 msgid "Displays detailed help on a single command C<cmd>."
18872 #: ../fish/guestfish.pod:168
18873 msgid "B<-a image>"
18877 #: ../fish/guestfish.pod:170
18878 msgid "B<--add image>"
18882 #: ../fish/guestfish.pod:172
18883 msgid "Add a block device or virtual machine image to the shell."
18887 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
18889 "The format of the disk image is auto-detected. To override this and force a "
18890 "particular format use the I<--format=..> option."
18894 #: ../fish/guestfish.pod:177
18896 "Using this flag is mostly equivalent to using the C<add> command, with "
18897 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
18898 "the I<--format:...> flag was given."
18902 #: ../fish/guestfish.pod:181
18907 #: ../fish/guestfish.pod:183
18908 msgid "B<--connect URI>"
18912 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
18914 "When used in conjunction with the I<-d> option, this specifies the libvirt "
18915 "URI to use. The default is to use the default libvirt connection."
18919 #: ../fish/guestfish.pod:189
18924 #: ../fish/guestfish.pod:191
18926 "If using the I<--listen> option and a csh-like shell, use this option. See "
18927 "section L</REMOTE CONTROL AND CSH> below."
18931 #: ../fish/guestfish.pod:194
18932 msgid "B<-d libvirt-domain>"
18936 #: ../fish/guestfish.pod:196
18937 msgid "B<--domain libvirt-domain>"
18941 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
18943 "Add disks from the named libvirt domain. If the I<--ro> option is also "
18944 "used, then any libvirt domain can be used. However in write mode, only "
18945 "libvirt domains which are shut down can be named here."
18949 #: ../fish/guestfish.pod:202
18951 "Using this flag is mostly equivalent to using the C<add-domain> command, "
18952 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
18953 "if the I<--format:...> flag was given."
18957 #: ../fish/guestfish.pod:206
18962 #: ../fish/guestfish.pod:208
18963 msgid "B<--no-dest-paths>"
18967 #: ../fish/guestfish.pod:210
18969 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18970 "to hit the tab key to complete paths on the guest filesystem, but this "
18971 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18972 "allow this feature to be disabled."
18976 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18977 msgid "B<--echo-keys>"
18981 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18983 "When prompting for keys and passphrases, guestfish normally turns echoing "
18984 "off so you cannot see what you are typing. If you are not worried about "
18985 "Tempest attacks and there is no one else in the room you can specify this "
18986 "flag to see what you are typing."
18990 #: ../fish/guestfish.pod:222
18995 #: ../fish/guestfish.pod:224
18996 msgid "B<--file file>"
19000 #: ../fish/guestfish.pod:226
19001 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19005 #: ../fish/guestfish.pod:229
19008 " #!/usr/bin/guestfish -f\n"
19013 #: ../fish/guestfish.pod:231
19014 msgid "B<--format=raw|qcow2|..>"
19018 #: ../fish/guestfish.pod:233
19019 msgid "B<--format>"
19023 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19025 "The default for the I<-a> option is to auto-detect the format of the disk "
19026 "image. Using this forces the disk format for I<-a> options which follow on "
19027 "the command line. Using I<--format> with no argument switches back to "
19028 "auto-detection for subsequent I<-a> options."
19032 #: ../fish/guestfish.pod:242
19035 " guestfish --format=raw -a disk.img\n"
19040 #: ../fish/guestfish.pod:244
19041 msgid "forces raw format (no auto-detection) for C<disk.img>."
19045 #: ../fish/guestfish.pod:246
19048 " guestfish --format=raw -a disk.img --format -a another.img\n"
19053 #: ../fish/guestfish.pod:248
19055 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19056 "auto-detection for C<another.img>."
19060 #: ../fish/guestfish.pod:251
19062 "If you have untrusted raw-format guest disk images, you should use this "
19063 "option to specify the disk format. This avoids a possible security problem "
19064 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19068 #: ../fish/guestfish.pod:256
19073 #: ../fish/guestfish.pod:258
19074 msgid "B<--inspector>"
19078 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19080 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19081 "system and mount filesystems as they would be mounted on the real virtual "
19086 #: ../fish/guestfish.pod:264
19087 msgid "Typical usage is either:"
19091 #: ../fish/guestfish.pod:266
19094 " guestfish -d myguest -i\n"
19099 #: ../fish/guestfish.pod:268
19100 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19104 #: ../fish/guestfish.pod:270
19107 " guestfish --ro -d myguest -i\n"
19112 #: ../fish/guestfish.pod:272
19113 msgid "(for active domains, readonly), or specify the block device directly:"
19117 #: ../fish/guestfish.pod:274
19120 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19125 #: ../fish/guestfish.pod:276
19127 "Note that the command line syntax changed slightly over older versions of "
19128 "guestfish. You can still use the old syntax:"
19132 #: ../fish/guestfish.pod:279
19135 " guestfish [--ro] -i disk.img\n"
19140 #: ../fish/guestfish.pod:281
19143 " guestfish [--ro] -i libvirt-domain\n"
19148 #: ../fish/guestfish.pod:283
19150 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19151 "then using other commands to mount the filesystems that were found."
19155 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19156 msgid "B<--keys-from-stdin>"
19160 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19162 "Read key or passphrase parameters from stdin. The default is to try to read "
19163 "passphrases from the user by opening C</dev/tty>."
19167 #: ../fish/guestfish.pod:292
19168 msgid "B<--listen>"
19172 #: ../fish/guestfish.pod:294
19174 "Fork into the background and listen for remote commands. See section "
19175 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19179 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19184 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19186 "Connect to a live virtual machine. (Experimental, see "
19187 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19191 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19192 msgid "B<-m dev[:mountpoint[:options]]>"
19196 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19197 msgid "B<--mount dev[:mountpoint[:options]]>"
19201 #: ../fish/guestfish.pod:306
19202 msgid "Mount the named partition or logical volume on the given mountpoint."
19206 #: ../fish/guestfish.pod:308
19207 msgid "If the mountpoint is omitted, it defaults to C</>."
19211 #: ../fish/guestfish.pod:310
19212 msgid "You have to mount something on C</> before most commands will work."
19216 #: ../fish/guestfish.pod:312
19218 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19223 #: ../fish/guestfish.pod:315
19225 "If you don't know what filesystems a disk image contains, you can either run "
19226 "guestfish without this option, then list the partitions, filesystems and LVs "
19227 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19228 "commands), or you can use the L<virt-filesystems(1)> program."
19232 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19234 "The third (and rarely used) part of the mount parameter is the list of mount "
19235 "options used to mount the underlying filesystem. If this is not given, then "
19236 "the mount options are either the empty string or C<ro> (the latter if the "
19237 "I<--ro> flag is used). By specifying the mount options, you override this "
19238 "default choice. Probably the only time you would use this is to enable ACLs "
19239 "and/or extended attributes if the filesystem can support them:"
19243 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19246 " -m /dev/sda1:/:acl,user_xattr\n"
19251 #: ../fish/guestfish.pod:331
19252 msgid "Using this flag is equivalent to using the C<mount-options> command."
19256 #: ../fish/guestfish.pod:333
19261 #: ../fish/guestfish.pod:335
19262 msgid "B<--no-sync>"
19266 #: ../fish/guestfish.pod:337
19268 "Disable autosync. This is enabled by default. See the discussion of "
19269 "autosync in the L<guestfs(3)> manpage."
19273 #: ../fish/guestfish.pod:340
19278 #: ../fish/guestfish.pod:342
19279 msgid "B<--new type>"
19283 #: ../fish/guestfish.pod:344
19288 #: ../fish/guestfish.pod:346
19290 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19291 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19292 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19297 #: ../fish/guestfish.pod:351
19298 msgid "B<--progress-bars>"
19302 #: ../fish/guestfish.pod:353
19303 msgid "Enable progress bars, even when guestfish is used non-interactively."
19307 #: ../fish/guestfish.pod:355
19309 "Progress bars are enabled by default when guestfish is used as an "
19310 "interactive shell."
19314 #: ../fish/guestfish.pod:358
19315 msgid "B<--no-progress-bars>"
19319 #: ../fish/guestfish.pod:360
19320 msgid "Disable progress bars."
19324 #: ../fish/guestfish.pod:362
19325 msgid "B<--remote[=pid]>"
19329 #: ../fish/guestfish.pod:364
19331 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19332 "CONTROL GUESTFISH OVER A SOCKET> below."
19336 #: ../fish/guestfish.pod:367
19341 #: ../fish/guestfish.pod:369
19346 #: ../fish/guestfish.pod:371
19348 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19349 "mounts are done read-only."
19353 #: ../fish/guestfish.pod:374
19355 "The option must always be used if the disk image or virtual machine might be "
19356 "running, and is generally recommended in cases where you don't need write "
19357 "access to the disk."
19361 #: ../fish/guestfish.pod:378
19363 "Note that prepared disk images created with I<-N> are not affected by this "
19364 "option. Also commands like C<add> are not affected - you have to specify "
19365 "the C<readonly:true> option explicitly if you need it."
19369 #: ../fish/guestfish.pod:382
19370 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19374 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19375 msgid "B<--selinux>"
19379 #: ../fish/guestfish.pod:386
19380 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19384 #: ../fish/guestfish.pod:388
19389 #: ../fish/guestfish.pod:390
19390 msgid "B<--verbose>"
19394 #: ../fish/guestfish.pod:392
19396 "Enable very verbose messages. This is particularly useful if you find a "
19401 #: ../fish/guestfish.pod:395
19406 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97 ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19407 msgid "B<--version>"
19411 #: ../fish/guestfish.pod:399
19412 msgid "Display the guestfish / libguestfs version number and exit."
19416 #: ../fish/guestfish.pod:401
19421 #: ../fish/guestfish.pod:403
19426 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19428 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19429 "mounts are done read-write."
19433 #: ../fish/guestfish.pod:408
19434 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19438 #: ../fish/guestfish.pod:410
19443 #: ../fish/guestfish.pod:412
19444 msgid "Echo each command before executing it."
19448 #: ../fish/guestfish.pod:416
19449 msgid "COMMANDS ON COMMAND LINE"
19453 #: ../fish/guestfish.pod:418
19454 msgid "Any additional (non-option) arguments are treated as commands to execute."
19458 #: ../fish/guestfish.pod:421
19460 "Commands to execute should be separated by a colon (C<:>), where the colon "
19461 "is a separate parameter. Thus:"
19465 #: ../fish/guestfish.pod:424
19468 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19473 #: ../fish/guestfish.pod:426
19475 "If there are no additional arguments, then we enter a shell, either an "
19476 "interactive shell with a prompt (if the input is a terminal) or a "
19477 "non-interactive shell."
19481 #: ../fish/guestfish.pod:430
19483 "In either command line mode or non-interactive shell, the first command that "
19484 "gives an error causes the whole shell to exit. In interactive mode (with a "
19485 "prompt) if a command fails, you can continue to enter commands."
19489 #: ../fish/guestfish.pod:435
19490 msgid "USING launch (OR run)"
19494 #: ../fish/guestfish.pod:437
19496 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19497 "then launch it, then mount any disks you need, and finally issue "
19498 "actions/commands. So the general order of the day is:"
19502 #: ../fish/guestfish.pod:445
19503 msgid "add or -a/--add"
19507 #: ../fish/guestfish.pod:449
19508 msgid "launch (aka run)"
19512 #: ../fish/guestfish.pod:453
19513 msgid "mount or -m/--mount"
19517 #: ../fish/guestfish.pod:457
19518 msgid "any other commands"
19522 #: ../fish/guestfish.pod:461
19524 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19525 "guest before mounting or performing any other commands."
19529 #: ../fish/guestfish.pod:464
19531 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19532 "I<--new> options were given then C<run> is done automatically, simply "
19533 "because guestfish can't perform the action you asked for without doing this."
19537 #: ../fish/guestfish.pod:469
19538 msgid "OPENING DISKS FOR READ AND WRITE"
19542 #: ../fish/guestfish.pod:471
19544 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19545 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19546 "I<-i> and I<-m> open disk images read-only or for writing."
19550 #: ../fish/guestfish.pod:476
19552 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
19553 "opening disk images supplied on the command line for write. To open a disk "
19554 "image read-only you have to do I<-a image --ro>."
19558 #: ../fish/guestfish.pod:480
19560 "This matters: If you accidentally open a live VM disk image writable then "
19561 "you will cause irreversible disk corruption."
19565 #: ../fish/guestfish.pod:483
19567 "By libguestfs 1.10 we intend to change the default the other way. Disk "
19568 "images will be opened read-only. You will have to either specify "
19569 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19570 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19571 "access for disk images specified by those other command line options."
19575 #: ../fish/guestfish.pod:490
19577 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19578 "which does nothing (it is already the default). However it is highly "
19579 "recommended that you use this option to indicate that you need write access, "
19580 "and prepare your scripts for the day when this option will be required for "
19585 #: ../fish/guestfish.pod:496
19587 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19588 "other libguestfs program apart from guestfish and guestmount."
19592 #: ../fish/guestfish.pod:499
19597 #: ../fish/guestfish.pod:501
19599 "You can quote ordinary parameters using either single or double quotes. For "
19604 #: ../fish/guestfish.pod:504
19607 " add \"file with a space.img\"\n"
19612 #: ../fish/guestfish.pod:506
19615 " rm '/file name'\n"
19620 #: ../fish/guestfish.pod:508
19628 #: ../fish/guestfish.pod:510
19630 "A few commands require a list of strings to be passed. For these, use a "
19631 "whitespace-separated list, enclosed in quotes. Strings containing "
19632 "whitespace to be passed through must be enclosed in single quotes. A "
19633 "literal single quote must be escaped with a backslash."
19637 #: ../fish/guestfish.pod:515
19640 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19641 " command \"/bin/echo 'foo bar'\"\n"
19642 " command \"/bin/echo \\'foo\\'\"\n"
19647 #: ../fish/guestfish.pod:519
19648 msgid "OPTIONAL ARGUMENTS"
19652 #: ../fish/guestfish.pod:521
19654 "Some commands take optional arguments. These arguments appear in this "
19655 "documentation as C<[argname:..]>. You can use them as in these examples:"
19659 #: ../fish/guestfish.pod:525
19662 " add-drive-opts filename\n"
19667 #: ../fish/guestfish.pod:527
19670 " add-drive-opts filename readonly:true\n"
19675 #: ../fish/guestfish.pod:529
19678 " add-drive-opts filename format:qcow2 readonly:false\n"
19683 #: ../fish/guestfish.pod:531
19685 "Each optional argument can appear at most once. All optional arguments must "
19686 "appear after the required ones."
19690 #: ../fish/guestfish.pod:534
19695 #: ../fish/guestfish.pod:536
19696 msgid "This section applies to all commands which can take integers as parameters."
19700 #: ../fish/guestfish.pod:539
19701 msgid "SIZE SUFFIX"
19705 #: ../fish/guestfish.pod:541
19707 "When the command takes a parameter measured in bytes, you can use one of the "
19708 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19712 #: ../fish/guestfish.pod:547
19713 msgid "B<k> or B<K> or B<KiB>"
19717 #: ../fish/guestfish.pod:549
19718 msgid "The size in kilobytes (multiplied by 1024)."
19722 #: ../fish/guestfish.pod:551
19727 #: ../fish/guestfish.pod:553
19728 msgid "The size in SI 1000 byte units."
19732 #: ../fish/guestfish.pod:555
19733 msgid "B<M> or B<MiB>"
19737 #: ../fish/guestfish.pod:557
19738 msgid "The size in megabytes (multiplied by 1048576)."
19742 #: ../fish/guestfish.pod:559
19747 #: ../fish/guestfish.pod:561
19748 msgid "The size in SI 1000000 byte units."
19752 #: ../fish/guestfish.pod:563
19753 msgid "B<G> or B<GiB>"
19757 #: ../fish/guestfish.pod:565
19758 msgid "The size in gigabytes (multiplied by 2**30)."
19762 #: ../fish/guestfish.pod:567
19767 #: ../fish/guestfish.pod:569
19768 msgid "The size in SI 10**9 byte units."
19772 #: ../fish/guestfish.pod:571
19773 msgid "B<T> or B<TiB>"
19777 #: ../fish/guestfish.pod:573
19778 msgid "The size in terabytes (multiplied by 2**40)."
19782 #: ../fish/guestfish.pod:575
19787 #: ../fish/guestfish.pod:577
19788 msgid "The size in SI 10**12 byte units."
19792 #: ../fish/guestfish.pod:579
19793 msgid "B<P> or B<PiB>"
19797 #: ../fish/guestfish.pod:581
19798 msgid "The size in petabytes (multiplied by 2**50)."
19802 #: ../fish/guestfish.pod:583
19807 #: ../fish/guestfish.pod:585
19808 msgid "The size in SI 10**15 byte units."
19812 #: ../fish/guestfish.pod:587
19813 msgid "B<E> or B<EiB>"
19817 #: ../fish/guestfish.pod:589
19818 msgid "The size in exabytes (multiplied by 2**60)."
19822 #: ../fish/guestfish.pod:591
19827 #: ../fish/guestfish.pod:593
19828 msgid "The size in SI 10**18 byte units."
19832 #: ../fish/guestfish.pod:595
19833 msgid "B<Z> or B<ZiB>"
19837 #: ../fish/guestfish.pod:597
19838 msgid "The size in zettabytes (multiplied by 2**70)."
19842 #: ../fish/guestfish.pod:599
19847 #: ../fish/guestfish.pod:601
19848 msgid "The size in SI 10**21 byte units."
19852 #: ../fish/guestfish.pod:603
19853 msgid "B<Y> or B<YiB>"
19857 #: ../fish/guestfish.pod:605
19858 msgid "The size in yottabytes (multiplied by 2**80)."
19862 #: ../fish/guestfish.pod:607
19867 #: ../fish/guestfish.pod:609
19868 msgid "The size in SI 10**24 byte units."
19872 #: ../fish/guestfish.pod:615
19875 " truncate-size /file 1G\n"
19880 #: ../fish/guestfish.pod:617
19881 msgid "would truncate the file to 1 gigabyte."
19885 #: ../fish/guestfish.pod:619
19887 "Be careful because a few commands take sizes in kilobytes or megabytes "
19888 "(eg. the parameter to L</memsize> is specified in megabytes already). "
19889 "Adding a suffix will probably not do what you expect."
19893 #: ../fish/guestfish.pod:623
19894 msgid "OCTAL AND HEXADECIMAL NUMBERS"
19898 #: ../fish/guestfish.pod:625
19900 "For specifying the radix (base) use the C convention: C<0> to prefix an "
19901 "octal number or C<0x> to prefix a hexadecimal number. For example:"
19905 #: ../fish/guestfish.pod:628
19908 " 1234 decimal number 1234\n"
19909 " 02322 octal number, equivalent to decimal 1234\n"
19910 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
19915 #: ../fish/guestfish.pod:632
19917 "When using the C<chmod> command, you almost always want to specify an octal "
19918 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
19919 "L<chmod(1)> program):"
19923 #: ../fish/guestfish.pod:636
19926 " chmod 0777 /public # OK\n"
19927 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
19932 #: ../fish/guestfish.pod:639
19934 "Commands that return numbers usually print them in decimal, but some "
19935 "commands print numbers in other radices (eg. C<umask> prints the mode in "
19936 "octal, preceeded by C<0>)."
19940 #: ../fish/guestfish.pod:643
19941 msgid "WILDCARDS AND GLOBBING"
19945 #: ../fish/guestfish.pod:645
19947 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
19948 "(globbing) by default. So for example the following will not do what you "
19953 #: ../fish/guestfish.pod:649
19961 #: ../fish/guestfish.pod:651
19963 "Assuming you don't have a directory called literally C</home/*> then the "
19964 "above command will return an error."
19968 #: ../fish/guestfish.pod:654
19969 msgid "To perform wildcard expansion, use the C<glob> command."
19973 #: ../fish/guestfish.pod:656
19976 " glob rm-rf /home/*\n"
19981 #: ../fish/guestfish.pod:658
19983 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
19984 "many times), equivalent to:"
19988 #: ../fish/guestfish.pod:661
19991 " rm-rf /home/jim\n"
19992 " rm-rf /home/joe\n"
19993 " rm-rf /home/mary\n"
19998 #: ../fish/guestfish.pod:665
19999 msgid "C<glob> only works on simple guest paths and not on device names."
20003 #: ../fish/guestfish.pod:667
20005 "If you have several parameters, each containing a wildcard, then glob will "
20006 "perform a Cartesian product."
20010 #: ../fish/guestfish.pod:670
20015 #: ../fish/guestfish.pod:672
20017 "Any line which starts with a I<#> character is treated as a comment and "
20018 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20019 "a command. For example:"
20023 #: ../fish/guestfish.pod:676
20026 " # this is a comment\n"
20027 " # this is a comment\n"
20028 " foo # NOT a comment\n"
20033 #: ../fish/guestfish.pod:680
20034 msgid "Blank lines are also ignored."
20038 #: ../fish/guestfish.pod:682
20039 msgid "RUNNING COMMANDS LOCALLY"
20043 #: ../fish/guestfish.pod:684
20045 "Any line which starts with a I<!> character is treated as a command sent to "
20046 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20050 #: ../fish/guestfish.pod:688
20054 " tgz-out /remote local/remote-data.tar.gz\n"
20059 #: ../fish/guestfish.pod:691
20061 "will create a directory C<local> on the host, and then export the contents "
20062 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20063 "(See C<tgz-out>)."
20067 #: ../fish/guestfish.pod:695
20069 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20070 "effect, due to the way that subprocesses work in Unix."
20074 #: ../fish/guestfish.pod:698
20075 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20079 #: ../fish/guestfish.pod:700
20081 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20082 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20083 "and executed as guestfish commands."
20087 #: ../fish/guestfish.pod:704
20089 "Thus you can use shell script to construct arbitrary guestfish commands "
20090 "which are then parsed by guestfish."
20094 #: ../fish/guestfish.pod:707
20096 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20097 "through C</foo.100>) using guestfish commands alone. However this is simple "
20098 "if we use a shell script to create the guestfish commands for us:"
20102 #: ../fish/guestfish.pod:712
20105 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20110 #: ../fish/guestfish.pod:714
20111 msgid "or with names like C</foo.001>:"
20115 #: ../fish/guestfish.pod:716
20118 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20123 #: ../fish/guestfish.pod:718
20125 "When using guestfish interactively it can be helpful to just run the shell "
20126 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20127 "ordinary I<!> local command), see what guestfish commands it would run, and "
20128 "when you are happy with those prepend the C<E<lt>> character to run the "
20129 "guestfish commands for real."
20133 #: ../fish/guestfish.pod:724
20138 #: ../fish/guestfish.pod:726
20140 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20141 "command (a guestfish command) to the second command (any host command). For "
20146 #: ../fish/guestfish.pod:730
20149 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20154 #: ../fish/guestfish.pod:732
20156 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20157 "program). The above command would list all accounts in the guest filesystem "
20158 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20162 #: ../fish/guestfish.pod:737
20165 " hexdump /bin/ls | head\n"
20166 " list-devices | tail -1\n"
20167 " tgz-out / - | tar ztf -\n"
20172 #: ../fish/guestfish.pod:741
20174 "The space before the pipe symbol is required, any space after the pipe "
20175 "symbol is optional. Everything after the pipe symbol is just passed "
20176 "straight to the host shell, so it can contain redirections, globs and "
20177 "anything else that makes sense on the host side."
20181 #: ../fish/guestfish.pod:746
20183 "To use a literal argument which begins with a pipe symbol, you have to quote "
20188 #: ../fish/guestfish.pod:749
20196 #: ../fish/guestfish.pod:751
20197 msgid "HOME DIRECTORIES"
20201 #: ../fish/guestfish.pod:753
20203 "If a parameter starts with the character C<~> then the tilde may be expanded "
20204 "as a home directory path (either C<~> for the current user's home directory, "
20205 "or C<~user> for another user)."
20209 #: ../fish/guestfish.pod:757
20211 "Note that home directory expansion happens for users known I<on the host>, "
20212 "not in the guest filesystem."
20216 #: ../fish/guestfish.pod:760
20218 "To use a literal argument which begins with a tilde, you have to quote it, "
20223 #: ../fish/guestfish.pod:763
20231 #: ../fish/guestfish.pod:767
20233 "Libguestfs has some support for Linux guests encrypted according to the "
20234 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20235 "disk encryption systems used by modern Linux guests. Currently only "
20236 "LVM-on-LUKS is supported."
20240 #: ../fish/guestfish.pod:772
20241 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20245 #: ../fish/guestfish.pod:774
20248 " ><fs> vfs-type /dev/sda2\n"
20254 #: ../fish/guestfish.pod:777
20256 "Then open those devices using L</luks-open>. This creates a device-mapper "
20257 "device called C</dev/mapper/luksdev>."
20261 #: ../fish/guestfish.pod:780
20264 " ><fs> luks-open /dev/sda2 luksdev\n"
20265 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20270 #: ../fish/guestfish.pod:783
20272 "Finally you have to tell LVM to scan for volume groups on the newly created "
20277 #: ../fish/guestfish.pod:786
20281 " vg-activate-all true\n"
20286 #: ../fish/guestfish.pod:789
20287 msgid "The logical volume(s) can now be mounted in the usual way."
20291 #: ../fish/guestfish.pod:791
20293 "Before closing a LUKS device you must unmount any logical volumes on it and "
20294 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20295 "one. Then you can close the mapper device:"
20299 #: ../fish/guestfish.pod:795
20302 " vg-activate false /dev/VG\n"
20303 " luks-close /dev/mapper/luksdev\n"
20308 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20309 msgid "WINDOWS PATHS"
20313 #: ../fish/guestfish.pod:800
20315 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20316 "letters and paths (with some limitations). The following commands are "
20321 #: ../fish/guestfish.pod:804
20324 " file /WINDOWS/system32/config/system.LOG\n"
20329 #: ../fish/guestfish.pod:806
20332 " file win:\\windows\\system32\\config\\system.log\n"
20337 #: ../fish/guestfish.pod:808
20340 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20345 #: ../fish/guestfish.pod:810
20347 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20348 "where the drive is mounted, prepending that to the path, changing all "
20349 "backslash characters to forward slash, then resolving the result using "
20350 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20351 "then the parameter might be rewritten like this:"
20355 #: ../fish/guestfish.pod:816
20358 " win:e:\\foo\\bar => /e/FOO/bar\n"
20363 #: ../fish/guestfish.pod:818
20364 msgid "This only works in argument positions that expect a path."
20368 #: ../fish/guestfish.pod:820
20369 msgid "UPLOADING AND DOWNLOADING FILES"
20373 #: ../fish/guestfish.pod:822
20375 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20376 "others which upload from or download to a local file, you can use the "
20377 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20381 #: ../fish/guestfish.pod:826
20389 #: ../fish/guestfish.pod:828
20390 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20394 #: ../fish/guestfish.pod:831
20397 " tar-out /etc - | tar tf -\n"
20402 #: ../fish/guestfish.pod:833
20404 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20405 "command (see L</PIPES>)."
20409 #: ../fish/guestfish.pod:836
20411 "When using C<-> to read from stdin, the input is read up to the end of "
20412 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20413 "some arbitrary end marker:"
20417 #: ../fish/guestfish.pod:840
20420 " upload -<<END /foo\n"
20429 #: ../fish/guestfish.pod:846
20431 "Any string of characters can be used instead of C<END>. The end marker must "
20432 "appear on a line of its own, without any preceeding or following characters "
20433 "(not even spaces)."
20437 #: ../fish/guestfish.pod:850
20439 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20440 "upload local files (so-called \"FileIn\" parameters in the generator)."
20444 #: ../fish/guestfish.pod:853
20445 msgid "EXIT ON ERROR BEHAVIOUR"
20449 #: ../fish/guestfish.pod:855
20451 "By default, guestfish will ignore any errors when in interactive mode "
20452 "(ie. taking commands from a human over a tty), and will exit on the first "
20453 "error in non-interactive mode (scripts, commands given on the command line)."
20457 #: ../fish/guestfish.pod:860
20459 "If you prefix a command with a I<-> character, then that command will not "
20460 "cause guestfish to exit, even if that (one) command returns an error."
20464 #: ../fish/guestfish.pod:864
20465 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20469 #: ../fish/guestfish.pod:866
20471 "Guestfish can be remote-controlled over a socket. This is useful "
20472 "particularly in shell scripts where you want to make several different "
20473 "changes to a filesystem, but you don't want the overhead of starting up a "
20474 "guestfish process each time."
20478 #: ../fish/guestfish.pod:871
20479 msgid "Start a guestfish server process using:"
20483 #: ../fish/guestfish.pod:873
20486 " eval \"`guestfish --listen`\"\n"
20491 #: ../fish/guestfish.pod:875
20492 msgid "and then send it commands by doing:"
20496 #: ../fish/guestfish.pod:877
20499 " guestfish --remote cmd [...]\n"
20504 #: ../fish/guestfish.pod:879
20505 msgid "To cause the server to exit, send it the exit command:"
20509 #: ../fish/guestfish.pod:881
20512 " guestfish --remote exit\n"
20517 #: ../fish/guestfish.pod:883
20519 "Note that the server will normally exit if there is an error in a command. "
20520 "You can change this in the usual way. See section L</EXIT ON ERROR "
20525 #: ../fish/guestfish.pod:887
20526 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20530 #: ../fish/guestfish.pod:889
20532 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20533 "is how the I<--remote> option knows where to send the commands. You can "
20534 "have several guestfish listener processes running using:"
20538 #: ../fish/guestfish.pod:893
20541 " eval \"`guestfish --listen`\"\n"
20542 " pid1=$GUESTFISH_PID\n"
20543 " eval \"`guestfish --listen`\"\n"
20544 " pid2=$GUESTFISH_PID\n"
20546 " guestfish --remote=$pid1 cmd\n"
20547 " guestfish --remote=$pid2 cmd\n"
20552 #: ../fish/guestfish.pod:901
20553 msgid "REMOTE CONTROL AND CSH"
20557 #: ../fish/guestfish.pod:903
20559 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20564 #: ../fish/guestfish.pod:906
20567 " eval \"`guestfish --listen --csh`\"\n"
20572 #: ../fish/guestfish.pod:908
20573 msgid "REMOTE CONTROL DETAILS"
20577 #: ../fish/guestfish.pod:910
20579 "Remote control happens over a Unix domain socket called "
20580 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20581 "of the process, and C<$PID> is the process ID of the server."
20585 #: ../fish/guestfish.pod:914
20586 msgid "Guestfish client and server versions must match exactly."
20590 #: ../fish/guestfish.pod:916
20591 msgid "PREPARED DISK IMAGES"
20595 #: ../fish/guestfish.pod:918
20597 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20598 "preformatted disk images that guestfish can make for you to save typing. "
20599 "This is particularly useful for testing purposes. This option is used "
20600 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20601 "can be mixed with I<-a>)."
20605 #: ../fish/guestfish.pod:924
20607 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20608 "the second and so on. Existing files in the current directory are "
20613 #: ../fish/guestfish.pod:928
20615 "The type briefly describes how the disk should be sized, partitioned, how "
20616 "filesystem(s) should be created, and how content should be added. "
20617 "Optionally the type can be followed by extra parameters, separated by C<:> "
20618 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20619 "sparsely-allocated disk, containing a single partition, with the partition "
20620 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20621 "on a 1GB disk instead."
20625 #: ../fish/guestfish.pod:936
20626 msgid "To list the available types and any extra parameters they take, run:"
20630 #: ../fish/guestfish.pod:940
20632 "Note that the prepared filesystem is not mounted. You would usually have to "
20633 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20637 #: ../fish/guestfish.pod:944
20639 "If any I<-N> or I<--new> options are given, the guest is automatically "
20644 #: ../fish/guestfish.pod:949
20645 msgid "Create a 100MB disk with an ext4-formatted partition:"
20649 #: ../fish/guestfish.pod:951
20652 " guestfish -N fs:ext4\n"
20657 #: ../fish/guestfish.pod:953
20658 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20662 #: ../fish/guestfish.pod:955
20665 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20670 #: ../fish/guestfish.pod:957
20671 msgid "Create a blank 200MB disk:"
20675 #: ../fish/guestfish.pod:959
20678 " guestfish -N disk:200M\n"
20683 #: ../fish/guestfish.pod:961
20684 msgid "PROGRESS BARS"
20688 #: ../fish/guestfish.pod:963
20690 "Some (not all) long-running commands send progress notification messages as "
20691 "they are running. Guestfish turns these messages into progress bars."
20695 #: ../fish/guestfish.pod:967
20697 "When a command that supports progress bars takes longer than two seconds to "
20698 "run, and if progress bars are enabled, then you will see one appearing below "
20703 #: ../fish/guestfish.pod:971
20706 " ><fs> copy-size /large-file /another-file 2048M\n"
20707 " / 10% [#####-----------------------------------------] 00:30\n"
20712 #: ../fish/guestfish.pod:974
20714 "The spinner on the left hand side moves round once for every progress "
20715 "notification received from the backend. This is a (reasonably) golden "
20716 "assurance that the command is \"doing something\" even if the progress bar "
20717 "is not moving, because the command is able to send the progress "
20718 "notifications. When the bar reaches 100% and the command finishes, the "
20719 "spinner disappears."
20723 #: ../fish/guestfish.pod:981
20725 "Progress bars are enabled by default when guestfish is used interactively. "
20726 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20727 "and you can disable them completely using I<--no-progress-bars>."
20731 #: ../fish/guestfish.pod:986
20732 msgid "GUESTFISH COMMANDS"
20736 #: ../fish/guestfish.pod:988
20738 "The commands in this section are guestfish convenience commands, in other "
20739 "words, they are not part of the L<guestfs(3)> API."
20743 #: ../fish/guestfish.pod:991
20748 #: ../fish/guestfish.pod:993
20757 #: ../fish/guestfish.pod:996
20758 msgid "Without any parameter, this provides general help."
20762 #: ../fish/guestfish.pod:998
20763 msgid "With a C<cmd> parameter, this displays detailed help for that command."
20767 #: ../fish/guestfish.pod:1000
20768 msgid "quit | exit"
20772 #: ../fish/guestfish.pod:1002
20773 msgid "This exits guestfish. You can also use C<^D> key."
20777 #: ../fish/guestfish.pod:1004
20778 msgid "@FISH_COMMANDS@"
20782 #: ../fish/guestfish.pod:1006
20787 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
20792 #: ../fish/guestfish.pod:1012
20794 "guestfish returns 0 if the commands completed without error, or 1 if there "
20799 #: ../fish/guestfish.pod:1019
20804 #: ../fish/guestfish.pod:1021
20806 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
20811 #: ../fish/guestfish.pod:1024
20812 msgid "GUESTFISH_PID"
20816 #: ../fish/guestfish.pod:1026
20818 "Used with the I<--remote> option to specify the remote guestfish process to "
20819 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
20823 #: ../fish/guestfish.pod:1030
20828 #: ../fish/guestfish.pod:1032
20830 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
20831 "not specified, the external L<hexedit(1)> program is used."
20835 #: ../fish/guestfish.pod:1036
20840 #: ../fish/guestfish.pod:1038
20842 "If compiled with GNU readline support, various files in the home directory "
20843 "can be used. See L</FILES>."
20847 #: ../fish/guestfish.pod:1047
20849 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
20850 "effect as using the B<-v> option."
20854 #: ../fish/guestfish.pod:1059
20856 "Set the path that guestfish uses to search for kernel and initrd.img. See "
20857 "the discussion of paths in L<guestfs(3)>."
20861 #: ../fish/guestfish.pod:1070
20862 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
20866 #: ../fish/guestfish.pod:1072
20871 #: ../fish/guestfish.pod:1074
20873 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
20878 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
20883 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
20884 msgid "$HOME/.libguestfs-tools.rc"
20888 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
20889 msgid "/etc/libguestfs-tools.conf"
20893 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
20895 "This configuration file controls the default read-only or read-write mode "
20896 "(I<--ro> or I<--rw>)."
20900 #: ../fish/guestfish.pod:1101
20901 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
20905 #: ../fish/guestfish.pod:1103
20906 msgid "$HOME/.guestfish"
20910 #: ../fish/guestfish.pod:1105
20912 "If compiled with GNU readline support, then the command history is saved in "
20917 #: ../fish/guestfish.pod:1108
20918 msgid "$HOME/.inputrc"
20922 #: ../fish/guestfish.pod:1110
20923 msgid "/etc/inputrc"
20927 #: ../fish/guestfish.pod:1112
20929 "If compiled with GNU readline support, then these files can be used to "
20930 "configure readline. For further information, please see "
20931 "L<readline(3)/INITIALIZATION FILE>."
20935 #: ../fish/guestfish.pod:1116
20936 msgid "To write rules which only apply to guestfish, use:"
20940 #: ../fish/guestfish.pod:1118
20950 #: ../fish/guestfish.pod:1122
20952 "Variables that you can set in inputrc that change the behaviour of guestfish "
20953 "in useful ways include:"
20957 #: ../fish/guestfish.pod:1127
20958 msgid "completion-ignore-case (default: on)"
20962 #: ../fish/guestfish.pod:1129
20964 "By default, guestfish will ignore case when tab-completing paths on the "
20969 #: ../fish/guestfish.pod:1132
20972 " set completion-ignore-case off\n"
20977 #: ../fish/guestfish.pod:1134
20978 msgid "to make guestfish case sensitive."
20982 #: ../fish/guestfish.pod:1138
20987 #: ../fish/guestfish.pod:1140
20988 msgid "test2.img (etc)"
20992 #: ../fish/guestfish.pod:1142
20994 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
20995 "will be created in the file C<test1.img> in the current directory. The "
20996 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
20997 "the same name will be overwritten."
21001 #: ../fish/guestfish.pod:1151
21003 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21004 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21005 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21006 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21007 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21008 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21012 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518 ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21014 "This program is free software; you can redistribute it and/or modify it "
21015 "under the terms of the GNU General Public License as published by the Free "
21016 "Software Foundation; either version 2 of the License, or (at your option) "
21017 "any later version."
21021 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523 ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21023 "This program is distributed in the hope that it will be useful, but WITHOUT "
21024 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21025 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21030 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528 ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21032 "You should have received a copy of the GNU General Public License along with "
21033 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21034 "Ave, Cambridge, MA 02139, USA."
21038 #: ../fish/guestfish-actions.pod:1
21043 #: ../fish/guestfish-actions.pod:3
21046 " add-cdrom filename\n"
21051 #: ../fish/guestfish-actions.pod:15
21053 "This call checks for the existence of C<filename>. This stops you from "
21054 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21055 "and C<http:> URLs. To specify those, use the general L</config> call "
21060 #: ../fish/guestfish-actions.pod:22
21062 "If you just want to add an ISO file (often you use this as an efficient way "
21063 "to transfer large files into the guest), then you should probably use "
21064 "L</add-drive-ro> instead."
21068 #: ../fish/guestfish-actions.pod:35
21073 #: ../fish/guestfish-actions.pod:37
21078 #: ../fish/guestfish-actions.pod:39
21081 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21086 #: ../fish/guestfish-actions.pod:41
21088 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21089 "It works by connecting to libvirt, requesting the domain and domain XML from "
21090 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21094 #: ../fish/guestfish-actions.pod:71
21096 "The other optional parameters are passed directly through to "
21097 "L</add-drive-opts>."
21101 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:3039
21103 "This command has one or more optional arguments. See L</OPTIONAL "
21108 #: ../fish/guestfish-actions.pod:76
21113 #: ../fish/guestfish-actions.pod:78
21116 " add-drive filename\n"
21121 #: ../fish/guestfish-actions.pod:80
21123 "This function is the equivalent of calling L</add-drive-opts> with no "
21124 "optional parameters, so the disk is added writable, with the format being "
21125 "detected automatically."
21129 #: ../fish/guestfish-actions.pod:84
21131 "Automatic detection of the format opens you up to a potential security hole "
21132 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21133 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21134 "you should think about replacing calls to this function with calls to "
21135 "L</add-drive-opts>, and specifying the format."
21139 #: ../fish/guestfish-actions.pod:91
21140 msgid "add-drive-opts"
21144 #: ../fish/guestfish-actions.pod:93
21149 #: ../fish/guestfish-actions.pod:95
21152 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21157 #: ../fish/guestfish-actions.pod:122
21159 "This forces the image format. If you omit this (or use L</add-drive> or "
21160 "L</add-drive-ro>) then the format is automatically detected. Possible "
21161 "formats include C<raw> and C<qcow2>."
21165 #: ../fish/guestfish-actions.pod:133
21167 "This rarely-used option lets you emulate the behaviour of the deprecated "
21168 "L</add-drive-with-if> call (q.v.)"
21172 #: ../fish/guestfish-actions.pod:140
21173 msgid "add-drive-ro"
21177 #: ../fish/guestfish-actions.pod:142
21182 #: ../fish/guestfish-actions.pod:144
21185 " add-drive-ro filename\n"
21190 #: ../fish/guestfish-actions.pod:146
21192 "This function is the equivalent of calling L</add-drive-opts> with the "
21193 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21194 "is added read-only, with the format being detected automatically."
21198 #: ../fish/guestfish-actions.pod:151
21199 msgid "add-drive-ro-with-if"
21203 #: ../fish/guestfish-actions.pod:153
21206 " add-drive-ro-with-if filename iface\n"
21211 #: ../fish/guestfish-actions.pod:155
21213 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21214 "interface emulation to use at run time."
21218 #: ../fish/guestfish-actions.pod:165
21219 msgid "add-drive-with-if"
21223 #: ../fish/guestfish-actions.pod:167
21226 " add-drive-with-if filename iface\n"
21231 #: ../fish/guestfish-actions.pod:169
21233 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21234 "interface emulation to use at run time."
21238 #: ../fish/guestfish-actions.pod:179
21243 #: ../fish/guestfish-actions.pod:181
21246 " aug-clear augpath\n"
21251 #: ../fish/guestfish-actions.pod:186
21256 #: ../fish/guestfish-actions.pod:188
21264 #: ../fish/guestfish-actions.pod:190
21266 "Close the current Augeas handle and free up any resources used by it. After "
21267 "calling this, you have to call L</aug-init> again before you can use any "
21268 "other Augeas functions."
21272 #: ../fish/guestfish-actions.pod:195
21273 msgid "aug-defnode"
21277 #: ../fish/guestfish-actions.pod:197
21280 " aug-defnode name expr val\n"
21285 #: ../fish/guestfish-actions.pod:202
21287 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21288 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21289 "containing that single node."
21293 #: ../fish/guestfish-actions.pod:210
21298 #: ../fish/guestfish-actions.pod:212
21301 " aug-defvar name expr\n"
21306 #: ../fish/guestfish-actions.pod:221
21311 #: ../fish/guestfish-actions.pod:223
21314 " aug-get augpath\n"
21319 #: ../fish/guestfish-actions.pod:228
21324 #: ../fish/guestfish-actions.pod:230
21327 " aug-init root flags\n"
21332 #: ../fish/guestfish-actions.pod:236
21333 msgid "You must call this before using any other L</aug-*> commands."
21337 #: ../fish/guestfish-actions.pod:271
21338 msgid "Do not load the tree in L</aug-init>."
21342 #: ../fish/guestfish-actions.pod:275
21343 msgid "To close the handle, you can call L</aug-close>."
21347 #: ../fish/guestfish-actions.pod:279
21352 #: ../fish/guestfish-actions.pod:281
21355 " aug-insert augpath label true|false\n"
21360 #: ../fish/guestfish-actions.pod:291
21365 #: ../fish/guestfish-actions.pod:293
21373 #: ../fish/guestfish-actions.pod:300
21378 #: ../fish/guestfish-actions.pod:302
21381 " aug-ls augpath\n"
21386 #: ../fish/guestfish-actions.pod:304
21388 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21389 "resulting nodes into alphabetical order."
21393 #: ../fish/guestfish-actions.pod:307
21398 #: ../fish/guestfish-actions.pod:309
21401 " aug-match augpath\n"
21406 #: ../fish/guestfish-actions.pod:315
21411 #: ../fish/guestfish-actions.pod:317
21414 " aug-mv src dest\n"
21419 #: ../fish/guestfish-actions.pod:322
21424 #: ../fish/guestfish-actions.pod:324
21427 " aug-rm augpath\n"
21432 #: ../fish/guestfish-actions.pod:330
21437 #: ../fish/guestfish-actions.pod:332
21445 #: ../fish/guestfish-actions.pod:336
21447 "The flags which were passed to L</aug-init> affect exactly how files are "
21452 #: ../fish/guestfish-actions.pod:339
21457 #: ../fish/guestfish-actions.pod:341
21460 " aug-set augpath val\n"
21465 #: ../fish/guestfish-actions.pod:345
21467 "In the Augeas API, it is possible to clear a node by setting the value to "
21468 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21469 "this call. Instead you must use the L</aug-clear> call."
21473 #: ../fish/guestfish-actions.pod:350
21478 #: ../fish/guestfish-actions.pod:352
21481 " available 'groups ...'\n"
21486 #: ../fish/guestfish-actions.pod:358
21488 "The libguestfs groups, and the functions that those groups correspond to, "
21489 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21490 "runtime by calling L</available-all-groups>."
21494 #: ../fish/guestfish-actions.pod:382
21495 msgid "You must call L</launch> before calling this function."
21499 #: ../fish/guestfish-actions.pod:404
21501 "This call was added in version C<1.0.80>. In previous versions of "
21502 "libguestfs all you could do would be to speculatively execute a command to "
21503 "find out if the daemon implemented it. See also L</version>."
21507 #: ../fish/guestfish-actions.pod:411
21508 msgid "available-all-groups"
21512 #: ../fish/guestfish-actions.pod:413
21515 " available-all-groups\n"
21520 #: ../fish/guestfish-actions.pod:415
21522 "This command returns a list of all optional groups that this daemon knows "
21523 "about. Note this returns both supported and unsupported groups. To find "
21524 "out which ones the daemon can actually support you have to call "
21525 "L</available> on each member of the returned list."
21529 #: ../fish/guestfish-actions.pod:421
21530 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21534 #: ../fish/guestfish-actions.pod:423
21539 #: ../fish/guestfish-actions.pod:425
21542 " base64-in (base64file|-) filename\n"
21547 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439 ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832 ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228 ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449 ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471 ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532 ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
21548 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21552 #: ../fish/guestfish-actions.pod:432
21557 #: ../fish/guestfish-actions.pod:434
21560 " base64-out filename (base64file|-)\n"
21565 #: ../fish/guestfish-actions.pod:441
21566 msgid "blockdev-flushbufs"
21570 #: ../fish/guestfish-actions.pod:443
21573 " blockdev-flushbufs device\n"
21578 #: ../fish/guestfish-actions.pod:450
21579 msgid "blockdev-getbsz"
21583 #: ../fish/guestfish-actions.pod:452
21586 " blockdev-getbsz device\n"
21591 #: ../fish/guestfish-actions.pod:461
21592 msgid "blockdev-getro"
21596 #: ../fish/guestfish-actions.pod:463
21599 " blockdev-getro device\n"
21604 #: ../fish/guestfish-actions.pod:470
21605 msgid "blockdev-getsize64"
21609 #: ../fish/guestfish-actions.pod:472
21612 " blockdev-getsize64 device\n"
21617 #: ../fish/guestfish-actions.pod:476
21618 msgid "See also L</blockdev-getsz>."
21622 #: ../fish/guestfish-actions.pod:480
21623 msgid "blockdev-getss"
21627 #: ../fish/guestfish-actions.pod:482
21630 " blockdev-getss device\n"
21635 #: ../fish/guestfish-actions.pod:487
21636 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21640 #: ../fish/guestfish-actions.pod:492
21641 msgid "blockdev-getsz"
21645 #: ../fish/guestfish-actions.pod:494
21648 " blockdev-getsz device\n"
21653 #: ../fish/guestfish-actions.pod:499
21655 "See also L</blockdev-getss> for the real sector size of the device, and "
21656 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21660 #: ../fish/guestfish-actions.pod:505
21661 msgid "blockdev-rereadpt"
21665 #: ../fish/guestfish-actions.pod:507
21668 " blockdev-rereadpt device\n"
21673 #: ../fish/guestfish-actions.pod:513
21674 msgid "blockdev-setbsz"
21678 #: ../fish/guestfish-actions.pod:515
21681 " blockdev-setbsz device blocksize\n"
21686 #: ../fish/guestfish-actions.pod:524
21687 msgid "blockdev-setro"
21691 #: ../fish/guestfish-actions.pod:526
21694 " blockdev-setro device\n"
21699 #: ../fish/guestfish-actions.pod:532
21700 msgid "blockdev-setrw"
21704 #: ../fish/guestfish-actions.pod:534
21707 " blockdev-setrw device\n"
21712 #: ../fish/guestfish-actions.pod:540
21713 msgid "case-sensitive-path"
21717 #: ../fish/guestfish-actions.pod:542
21720 " case-sensitive-path path\n"
21725 #: ../fish/guestfish-actions.pod:566
21727 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21728 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21729 "how the directories were originally created under Windows)."
21733 #: ../fish/guestfish-actions.pod:574
21734 msgid "See also L</realpath>."
21738 #: ../fish/guestfish-actions.pod:576
21743 #: ../fish/guestfish-actions.pod:578
21751 #: ../fish/guestfish-actions.pod:582
21753 "Note that this function cannot correctly handle binary files (specifically, "
21754 "files containing C<\\0> character which is treated as end of string). For "
21755 "those you need to use the L</read-file> or L</download> functions which have "
21756 "a more complex interface."
21760 #: ../fish/guestfish-actions.pod:590
21765 #: ../fish/guestfish-actions.pod:592
21768 " checksum csumtype path\n"
21773 #: ../fish/guestfish-actions.pod:635
21774 msgid "To get the checksum for a device, use L</checksum-device>."
21778 #: ../fish/guestfish-actions.pod:637
21779 msgid "To get the checksums for many files, use L</checksums-out>."
21783 #: ../fish/guestfish-actions.pod:639
21784 msgid "checksum-device"
21788 #: ../fish/guestfish-actions.pod:641
21791 " checksum-device csumtype device\n"
21796 #: ../fish/guestfish-actions.pod:643
21798 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
21799 "device named C<device>. For the types of checksums supported see the "
21800 "L</checksum> command."
21804 #: ../fish/guestfish-actions.pod:647
21805 msgid "checksums-out"
21809 #: ../fish/guestfish-actions.pod:649
21812 " checksums-out csumtype directory (sumsfile|-)\n"
21817 #: ../fish/guestfish-actions.pod:665
21822 #: ../fish/guestfish-actions.pod:667
21825 " chmod mode path\n"
21830 #: ../fish/guestfish-actions.pod:678
21835 #: ../fish/guestfish-actions.pod:680
21838 " chown owner group path\n"
21843 #: ../fish/guestfish-actions.pod:688
21848 #: ../fish/guestfish-actions.pod:690
21851 " command 'arguments ...'\n"
21856 #: ../fish/guestfish-actions.pod:697
21858 "The single parameter is an argv-style list of arguments. The first element "
21859 "is the name of the program to run. Subsequent elements are parameters. The "
21860 "list must be non-empty (ie. must contain a program name). Note that the "
21861 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
21865 #: ../fish/guestfish-actions.pod:725
21866 msgid "command-lines"
21870 #: ../fish/guestfish-actions.pod:727
21873 " command-lines 'arguments ...'\n"
21878 #: ../fish/guestfish-actions.pod:729
21879 msgid "This is the same as L</command>, but splits the result into a list of lines."
21883 #: ../fish/guestfish-actions.pod:732
21884 msgid "See also: L</sh-lines>"
21888 #: ../fish/guestfish-actions.pod:737
21893 #: ../fish/guestfish-actions.pod:739
21896 " config qemuparam qemuvalue\n"
21901 #: ../fish/guestfish-actions.pod:750
21906 #: ../fish/guestfish-actions.pod:752
21909 " copy-size src dest size\n"
21914 #: ../fish/guestfish-actions.pod:760
21919 #: ../fish/guestfish-actions.pod:762
21927 #: ../fish/guestfish-actions.pod:767
21932 #: ../fish/guestfish-actions.pod:769
21940 #: ../fish/guestfish-actions.pod:774
21945 #: ../fish/guestfish-actions.pod:776
21953 #: ../fish/guestfish-actions.pod:783
21955 "If the destination is a device, it must be as large or larger than the "
21956 "source file or device, otherwise the copy will fail. This command cannot do "
21957 "partial copies (see L</copy-size>)."
21961 #: ../fish/guestfish-actions.pod:787
21966 #: ../fish/guestfish-actions.pod:789
21974 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
21976 "This command is mostly useful for interactive sessions. It is I<not> "
21977 "intended that you try to parse the output string. Use L</statvfs> from "
21982 #: ../fish/guestfish-actions.pod:797
21987 #: ../fish/guestfish-actions.pod:799
21995 #: ../fish/guestfish-actions.pod:808
22000 #: ../fish/guestfish-actions.pod:810
22008 #: ../fish/guestfish-actions.pod:816
22010 "Another way to get the same information is to enable verbose messages with "
22011 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22012 "before running the program."
22016 #: ../fish/guestfish-actions.pod:821
22021 #: ../fish/guestfish-actions.pod:823
22024 " download remotefilename (filename|-)\n"
22029 #: ../fish/guestfish-actions.pod:830
22030 msgid "See also L</upload>, L</cat>."
22034 #: ../fish/guestfish-actions.pod:834
22035 msgid "download-offset"
22039 #: ../fish/guestfish-actions.pod:836
22042 " download-offset remotefilename (filename|-) offset size\n"
22047 #: ../fish/guestfish-actions.pod:844
22049 "Note that there is no limit on the amount of data that can be downloaded "
22050 "with this call, unlike with L</pread>, and this call always reads the full "
22051 "amount unless an error occurs."
22055 #: ../fish/guestfish-actions.pod:849
22056 msgid "See also L</download>, L</pread>."
22060 #: ../fish/guestfish-actions.pod:853
22061 msgid "drop-caches"
22065 #: ../fish/guestfish-actions.pod:855
22068 " drop-caches whattodrop\n"
22073 #: ../fish/guestfish-actions.pod:867
22078 #: ../fish/guestfish-actions.pod:869
22086 #: ../fish/guestfish-actions.pod:881
22091 #: ../fish/guestfish-actions.pod:883
22094 " e2fsck-f device\n"
22099 #: ../fish/guestfish-actions.pod:889
22101 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22102 "should use L</fsck>."
22106 #: ../fish/guestfish-actions.pod:892
22107 msgid "echo-daemon"
22111 #: ../fish/guestfish-actions.pod:894
22114 " echo-daemon 'words ...'\n"
22119 #: ../fish/guestfish-actions.pod:901
22120 msgid "See also L</ping-daemon>."
22124 #: ../fish/guestfish-actions.pod:903
22129 #: ../fish/guestfish-actions.pod:905
22132 " egrep regex path\n"
22137 #: ../fish/guestfish-actions.pod:913
22142 #: ../fish/guestfish-actions.pod:915
22145 " egrepi regex path\n"
22150 #: ../fish/guestfish-actions.pod:923
22155 #: ../fish/guestfish-actions.pod:925
22158 " equal file1 file2\n"
22163 #: ../fish/guestfish-actions.pod:932
22168 #: ../fish/guestfish-actions.pod:934
22176 #: ../fish/guestfish-actions.pod:939
22177 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22181 #: ../fish/guestfish-actions.pod:941
22186 #: ../fish/guestfish-actions.pod:943
22189 " fallocate path len\n"
22194 #: ../fish/guestfish-actions.pod:960
22195 msgid "fallocate64"
22199 #: ../fish/guestfish-actions.pod:962
22202 " fallocate64 path len\n"
22207 #: ../fish/guestfish-actions.pod:968
22209 "Note that this call allocates disk blocks for the file. To create a sparse "
22210 "file use L</truncate-size> instead."
22214 #: ../fish/guestfish-actions.pod:971
22216 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22217 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22218 "maximum size of files created through that call to 1GB."
22222 #: ../fish/guestfish-actions.pod:980
22227 #: ../fish/guestfish-actions.pod:982
22230 " fgrep pattern path\n"
22235 #: ../fish/guestfish-actions.pod:990
22240 #: ../fish/guestfish-actions.pod:992
22243 " fgrepi pattern path\n"
22248 #: ../fish/guestfish-actions.pod:1000
22253 #: ../fish/guestfish-actions.pod:1002
22261 #: ../fish/guestfish-actions.pod:1014
22263 "This command can also be used on C</dev/> devices (and partitions, LV "
22264 "names). You can for example use this to determine if a device contains a "
22265 "filesystem, although it's usually better to use L</vfs-type>."
22269 #: ../fish/guestfish-actions.pod:1024
22270 msgid "file-architecture"
22274 #: ../fish/guestfish-actions.pod:1026
22277 " file-architecture filename\n"
22282 #: ../fish/guestfish-actions.pod:1129
22287 #: ../fish/guestfish-actions.pod:1131
22295 #: ../fish/guestfish-actions.pod:1135
22297 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22298 "L</is-file> etc. To get the size of block devices, use "
22299 "L</blockdev-getsize64>."
22303 #: ../fish/guestfish-actions.pod:1139
22308 #: ../fish/guestfish-actions.pod:1141
22311 " fill c len path\n"
22316 #: ../fish/guestfish-actions.pod:1147
22318 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22319 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22320 "L</fill-pattern>."
22324 #: ../fish/guestfish-actions.pod:1152
22325 msgid "fill-pattern"
22329 #: ../fish/guestfish-actions.pod:1154
22332 " fill-pattern pattern len path\n"
22337 #: ../fish/guestfish-actions.pod:1156
22339 "This function is like L</fill> except that it creates a new file of length "
22340 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22341 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22346 #: ../fish/guestfish-actions.pod:1161
22351 #: ../fish/guestfish-actions.pod:1163
22354 " find directory\n"
22359 #: ../fish/guestfish-actions.pod:1177
22360 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22364 #: ../fish/guestfish-actions.pod:1190
22365 msgid "See also L</find0>."
22369 #: ../fish/guestfish-actions.pod:1195
22374 #: ../fish/guestfish-actions.pod:1197
22377 " find0 directory (files|-)\n"
22382 #: ../fish/guestfish-actions.pod:1203
22383 msgid "This command works the same way as L</find> with the following exceptions:"
22387 #: ../fish/guestfish-actions.pod:1230
22388 msgid "findfs-label"
22392 #: ../fish/guestfish-actions.pod:1232
22395 " findfs-label label\n"
22400 #: ../fish/guestfish-actions.pod:1238
22401 msgid "To find the label of a filesystem, use L</vfs-label>."
22405 #: ../fish/guestfish-actions.pod:1240
22406 msgid "findfs-uuid"
22410 #: ../fish/guestfish-actions.pod:1242
22413 " findfs-uuid uuid\n"
22418 #: ../fish/guestfish-actions.pod:1248
22419 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22423 #: ../fish/guestfish-actions.pod:1250
22428 #: ../fish/guestfish-actions.pod:1252
22431 " fsck fstype device\n"
22436 #: ../fish/guestfish-actions.pod:1282
22441 #: ../fish/guestfish-actions.pod:1284
22449 #: ../fish/guestfish-actions.pod:1291
22450 msgid "get-attach-method"
22454 #: ../fish/guestfish-actions.pod:1293
22457 " get-attach-method\n"
22462 #: ../fish/guestfish-actions.pod:1295
22463 msgid "Return the current attach method. See L</set-attach-method>."
22467 #: ../fish/guestfish-actions.pod:1297
22468 msgid "get-autosync"
22472 #: ../fish/guestfish-actions.pod:1299
22480 #: ../fish/guestfish-actions.pod:1303
22485 #: ../fish/guestfish-actions.pod:1305
22493 #: ../fish/guestfish-actions.pod:1309
22494 msgid "get-e2label"
22498 #: ../fish/guestfish-actions.pod:1311
22501 " get-e2label device\n"
22506 #: ../fish/guestfish-actions.pod:1323
22511 #: ../fish/guestfish-actions.pod:1325
22514 " get-e2uuid device\n"
22519 #: ../fish/guestfish-actions.pod:1337
22520 msgid "get-memsize"
22524 #: ../fish/guestfish-actions.pod:1339
22532 #: ../fish/guestfish-actions.pod:1344
22534 "If L</set-memsize> was not called on this handle, and if "
22535 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22536 "value for memsize."
22540 #: ../fish/guestfish-actions.pod:1351
22541 msgid "get-network"
22545 #: ../fish/guestfish-actions.pod:1353
22553 #: ../fish/guestfish-actions.pod:1357
22558 #: ../fish/guestfish-actions.pod:1359
22566 #: ../fish/guestfish-actions.pod:1366
22571 #: ../fish/guestfish-actions.pod:1368
22576 #: ../fish/guestfish-actions.pod:1370
22584 #: ../fish/guestfish-actions.pod:1377
22589 #: ../fish/guestfish-actions.pod:1379
22597 #: ../fish/guestfish-actions.pod:1386
22598 msgid "get-recovery-proc"
22602 #: ../fish/guestfish-actions.pod:1388
22605 " get-recovery-proc\n"
22610 #: ../fish/guestfish-actions.pod:1392
22611 msgid "get-selinux"
22615 #: ../fish/guestfish-actions.pod:1394
22623 #: ../fish/guestfish-actions.pod:1396
22625 "This returns the current setting of the selinux flag which is passed to the "
22626 "appliance at boot time. See L</set-selinux>."
22630 #: ../fish/guestfish-actions.pod:1402
22635 #: ../fish/guestfish-actions.pod:1404
22643 #: ../fish/guestfish-actions.pod:1411
22648 #: ../fish/guestfish-actions.pod:1413
22656 #: ../fish/guestfish-actions.pod:1417
22661 #: ../fish/guestfish-actions.pod:1419
22669 #: ../fish/guestfish-actions.pod:1421
22671 "Return the current umask. By default the umask is C<022> unless it has been "
22672 "set by calling L</umask>."
22676 #: ../fish/guestfish-actions.pod:1424
22677 msgid "get-verbose"
22681 #: ../fish/guestfish-actions.pod:1426
22689 #: ../fish/guestfish-actions.pod:1430
22694 #: ../fish/guestfish-actions.pod:1432
22702 #: ../fish/guestfish-actions.pod:1436
22703 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22707 #: ../fish/guestfish-actions.pod:1439
22712 #: ../fish/guestfish-actions.pod:1441
22715 " getxattr path name\n"
22720 #: ../fish/guestfish-actions.pod:1443
22722 "Get a single extended attribute from file C<path> named C<name>. This call "
22723 "follows symlinks. If you want to lookup an extended attribute for the "
22724 "symlink itself, use L</lgetxattr>."
22728 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
22730 "Normally it is better to get all extended attributes from a file in one go "
22731 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22732 "buggy and do not provide a way to list out attributes. For these "
22733 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22734 "attributes you want in advance and call this function."
22738 #: ../fish/guestfish-actions.pod:1457
22739 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22743 #: ../fish/guestfish-actions.pod:1459
22748 #: ../fish/guestfish-actions.pod:1461
22751 " getxattrs path\n"
22756 #: ../fish/guestfish-actions.pod:1469
22757 msgid "See also: L</lgetxattrs>, L<attr(5)>."
22761 #: ../fish/guestfish-actions.pod:1471
22762 msgid "glob-expand"
22766 #: ../fish/guestfish-actions.pod:1473
22769 " glob-expand pattern\n"
22774 #: ../fish/guestfish-actions.pod:1486
22779 #: ../fish/guestfish-actions.pod:1488
22782 " grep regex path\n"
22787 #: ../fish/guestfish-actions.pod:1496
22792 #: ../fish/guestfish-actions.pod:1498
22795 " grepi regex path\n"
22800 #: ../fish/guestfish-actions.pod:1506
22801 msgid "grub-install"
22805 #: ../fish/guestfish-actions.pod:1508
22808 " grub-install root device\n"
22813 #: ../fish/guestfish-actions.pod:1524
22818 #: ../fish/guestfish-actions.pod:1526
22826 #: ../fish/guestfish-actions.pod:1534
22831 #: ../fish/guestfish-actions.pod:1536
22834 " head-n nrlines path\n"
22839 #: ../fish/guestfish-actions.pod:1549
22844 #: ../fish/guestfish-actions.pod:1551
22852 #: ../fish/guestfish-actions.pod:1559
22857 #: ../fish/guestfish-actions.pod:1561
22860 " initrd-cat initrdpath filename\n"
22865 #: ../fish/guestfish-actions.pod:1573
22866 msgid "See also L</initrd-list>."
22870 #: ../fish/guestfish-actions.pod:1578
22871 msgid "initrd-list"
22875 #: ../fish/guestfish-actions.pod:1580
22878 " initrd-list path\n"
22883 #: ../fish/guestfish-actions.pod:1592
22884 msgid "inotify-add-watch"
22888 #: ../fish/guestfish-actions.pod:1594
22891 " inotify-add-watch path mask\n"
22896 #: ../fish/guestfish-actions.pod:1606
22897 msgid "inotify-close"
22901 #: ../fish/guestfish-actions.pod:1608
22909 #: ../fish/guestfish-actions.pod:1614
22910 msgid "inotify-files"
22914 #: ../fish/guestfish-actions.pod:1616
22922 #: ../fish/guestfish-actions.pod:1618
22924 "This function is a helpful wrapper around L</inotify-read> which just "
22925 "returns a list of pathnames of objects that were touched. The returned "
22926 "pathnames are sorted and deduplicated."
22930 #: ../fish/guestfish-actions.pod:1622
22931 msgid "inotify-init"
22935 #: ../fish/guestfish-actions.pod:1624
22938 " inotify-init maxevents\n"
22943 #: ../fish/guestfish-actions.pod:1630
22945 "C<maxevents> is the maximum number of events which will be queued up between "
22946 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
22947 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
22948 "default was 16384 events. Beyond this limit, the kernel throws away events, "
22949 "but records the fact that it threw them away by setting a flag "
22950 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
22954 #: ../fish/guestfish-actions.pod:1640
22956 "Before any events are generated, you have to add some watches to the "
22957 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
22958 "L</inotify-watch-all>."
22962 #: ../fish/guestfish-actions.pod:1646
22964 "Queued up events should be read periodically by calling L</inotify-read> (or "
22965 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
22966 "If you don't read the events out often enough then you risk the internal "
22967 "queue overflowing."
22971 #: ../fish/guestfish-actions.pod:1653
22973 "The handle should be closed after use by calling L</inotify-close>. This "
22974 "also removes any watches automatically."
22978 #: ../fish/guestfish-actions.pod:1662
22979 msgid "inotify-read"
22983 #: ../fish/guestfish-actions.pod:1664
22991 #: ../fish/guestfish-actions.pod:1677
22992 msgid "inotify-rm-watch"
22996 #: ../fish/guestfish-actions.pod:1679
22999 " inotify-rm-watch wd\n"
23004 #: ../fish/guestfish-actions.pod:1681
23005 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23009 #: ../fish/guestfish-actions.pod:1684
23010 msgid "inspect-get-arch"
23014 #: ../fish/guestfish-actions.pod:1686
23017 " inspect-get-arch root\n"
23022 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818 ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870 ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060 ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111 ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
23024 "This function should only be called with a root device string as returned by "
23029 #: ../fish/guestfish-actions.pod:1691
23031 "This returns the architecture of the inspected operating system. The "
23032 "possible return values are listed under L</file-architecture>."
23036 #: ../fish/guestfish-actions.pod:1700
23037 msgid "inspect-get-distro"
23041 #: ../fish/guestfish-actions.pod:1702
23044 " inspect-get-distro root\n"
23049 #: ../fish/guestfish-actions.pod:1778
23050 msgid "inspect-get-drive-mappings"
23054 #: ../fish/guestfish-actions.pod:1780
23057 " inspect-get-drive-mappings root\n"
23062 #: ../fish/guestfish-actions.pod:1810
23064 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23065 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23069 #: ../fish/guestfish-actions.pod:1814
23070 msgid "inspect-get-filesystems"
23074 #: ../fish/guestfish-actions.pod:1816
23077 " inspect-get-filesystems root\n"
23082 #: ../fish/guestfish-actions.pod:1829
23084 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23085 "L</inspect-get-mountpoints>."
23089 #: ../fish/guestfish-actions.pod:1832
23090 msgid "inspect-get-format"
23094 #: ../fish/guestfish-actions.pod:1834
23097 " inspect-get-format root\n"
23102 #: ../fish/guestfish-actions.pod:1866
23103 msgid "inspect-get-hostname"
23107 #: ../fish/guestfish-actions.pod:1868
23110 " inspect-get-hostname root\n"
23115 #: ../fish/guestfish-actions.pod:1881
23116 msgid "inspect-get-major-version"
23120 #: ../fish/guestfish-actions.pod:1883
23123 " inspect-get-major-version root\n"
23128 #: ../fish/guestfish-actions.pod:1902
23129 msgid "inspect-get-minor-version"
23133 #: ../fish/guestfish-actions.pod:1904
23136 " inspect-get-minor-version root\n"
23141 #: ../fish/guestfish-actions.pod:1914
23143 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23144 "L</inspect-get-major-version>."
23148 #: ../fish/guestfish-actions.pod:1917
23149 msgid "inspect-get-mountpoints"
23153 #: ../fish/guestfish-actions.pod:1919
23156 " inspect-get-mountpoints root\n"
23161 #: ../fish/guestfish-actions.pod:1941
23163 "For operating systems like Windows which still use drive letters, this call "
23164 "will only return an entry for the first drive \"mounted on\" C</>. For "
23165 "information about the mapping of drive letters to partitions, see "
23166 "L</inspect-get-drive-mappings>."
23170 #: ../fish/guestfish-actions.pod:1947
23172 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23173 "L</inspect-get-filesystems>."
23177 #: ../fish/guestfish-actions.pod:1950
23178 msgid "inspect-get-package-format"
23182 #: ../fish/guestfish-actions.pod:1952
23185 " inspect-get-package-format root\n"
23190 #: ../fish/guestfish-actions.pod:1957
23192 "This function and L</inspect-get-package-management> return the package "
23193 "format and package management tool used by the inspected operating system. "
23194 "For example for Fedora these functions would return C<rpm> (package format) "
23195 "and C<yum> (package management)."
23199 #: ../fish/guestfish-actions.pod:1972
23200 msgid "inspect-get-package-management"
23204 #: ../fish/guestfish-actions.pod:1974
23207 " inspect-get-package-management root\n"
23212 #: ../fish/guestfish-actions.pod:1979
23214 "L</inspect-get-package-format> and this function return the package format "
23215 "and package management tool used by the inspected operating system. For "
23216 "example for Fedora these functions would return C<rpm> (package format) and "
23217 "C<yum> (package management)."
23221 #: ../fish/guestfish-actions.pod:1996
23222 msgid "inspect-get-product-name"
23226 #: ../fish/guestfish-actions.pod:1998
23229 " inspect-get-product-name root\n"
23234 #: ../fish/guestfish-actions.pod:2013
23235 msgid "inspect-get-product-variant"
23239 #: ../fish/guestfish-actions.pod:2015
23242 " inspect-get-product-variant root\n"
23247 #: ../fish/guestfish-actions.pod:2039
23249 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23250 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23254 #: ../fish/guestfish-actions.pod:2043
23255 msgid "inspect-get-roots"
23259 #: ../fish/guestfish-actions.pod:2045
23262 " inspect-get-roots\n"
23267 #: ../fish/guestfish-actions.pod:2047
23269 "This function is a convenient way to get the list of root devices, as "
23270 "returned from a previous call to L</inspect-os>, but without redoing the "
23271 "whole inspection process."
23275 #: ../fish/guestfish-actions.pod:2051
23277 "This returns an empty list if either no root devices were found or the "
23278 "caller has not called L</inspect-os>."
23282 #: ../fish/guestfish-actions.pod:2056
23283 msgid "inspect-get-type"
23287 #: ../fish/guestfish-actions.pod:2058
23290 " inspect-get-type root\n"
23295 #: ../fish/guestfish-actions.pod:2091
23296 msgid "inspect-get-windows-current-control-set"
23300 #: ../fish/guestfish-actions.pod:2093
23303 " inspect-get-windows-current-control-set root\n"
23308 #: ../fish/guestfish-actions.pod:2107
23309 msgid "inspect-get-windows-systemroot"
23313 #: ../fish/guestfish-actions.pod:2109
23316 " inspect-get-windows-systemroot root\n"
23321 #: ../fish/guestfish-actions.pod:2123
23322 msgid "inspect-is-live"
23326 #: ../fish/guestfish-actions.pod:2125
23329 " inspect-is-live root\n"
23334 #: ../fish/guestfish-actions.pod:2130
23336 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23337 "then this returns true if a live image was detected on the disk."
23341 #: ../fish/guestfish-actions.pod:2136
23342 msgid "inspect-is-multipart"
23346 #: ../fish/guestfish-actions.pod:2138
23349 " inspect-is-multipart root\n"
23354 #: ../fish/guestfish-actions.pod:2143
23356 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23357 "then this returns true if the disk is part of a set."
23361 #: ../fish/guestfish-actions.pod:2149
23362 msgid "inspect-is-netinst"
23366 #: ../fish/guestfish-actions.pod:2151
23369 " inspect-is-netinst root\n"
23374 #: ../fish/guestfish-actions.pod:2156
23376 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23377 "then this returns true if the disk is a network installer, ie. not a "
23378 "self-contained install CD but one which is likely to require network access "
23379 "to complete the install."
23383 #: ../fish/guestfish-actions.pod:2164
23384 msgid "inspect-list-applications"
23388 #: ../fish/guestfish-actions.pod:2166
23391 " inspect-list-applications root\n"
23396 #: ../fish/guestfish-actions.pod:2173
23398 "I<Note:> This call works differently from other parts of the inspection "
23399 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23400 "then mount up the disks, before calling this. Listing applications is a "
23401 "significantly more difficult operation which requires access to the full "
23402 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23403 "are just returning data cached in the libguestfs handle, this call actually "
23404 "reads parts of the mounted filesystems during the call."
23408 #: ../fish/guestfish-actions.pod:2263
23413 #: ../fish/guestfish-actions.pod:2265
23421 #: ../fish/guestfish-actions.pod:2280
23423 "You can pass the root string(s) returned to other L</inspect-get-*> "
23424 "functions in order to query further information about each operating system, "
23425 "such as the name and version."
23429 #: ../fish/guestfish-actions.pod:2285
23431 "This function uses other libguestfs features such as L</mount-ro> and "
23432 "L</umount-all> in order to mount and unmount filesystems and look at the "
23433 "contents. This should be called with no disks currently mounted. The "
23434 "function may also use Augeas, so any existing Augeas handle will be closed."
23438 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473 ../fish/guestfish-actions.pod:2519
23439 msgid "See also L</list-filesystems>."
23443 #: ../fish/guestfish-actions.pod:2299
23444 msgid "is-blockdev"
23448 #: ../fish/guestfish-actions.pod:2301
23451 " is-blockdev path\n"
23456 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396 ../fish/guestfish-actions.pod:2405
23457 msgid "See also L</stat>."
23461 #: ../fish/guestfish-actions.pod:2308
23466 #: ../fish/guestfish-actions.pod:2310
23474 #: ../fish/guestfish-actions.pod:2317
23479 #: ../fish/guestfish-actions.pod:2319
23482 " is-chardev path\n"
23487 #: ../fish/guestfish-actions.pod:2326
23492 #: ../fish/guestfish-actions.pod:2328
23500 #: ../fish/guestfish-actions.pod:2335
23505 #: ../fish/guestfish-actions.pod:2337
23513 #: ../fish/guestfish-actions.pod:2345
23518 #: ../fish/guestfish-actions.pod:2347
23526 #: ../fish/guestfish-actions.pod:2354
23531 #: ../fish/guestfish-actions.pod:2356
23539 #: ../fish/guestfish-actions.pod:2364
23540 msgid "is-launching"
23544 #: ../fish/guestfish-actions.pod:2366
23552 #: ../fish/guestfish-actions.pod:2373
23557 #: ../fish/guestfish-actions.pod:2375
23565 #: ../fish/guestfish-actions.pod:2380
23570 #: ../fish/guestfish-actions.pod:2382
23578 #: ../fish/guestfish-actions.pod:2389
23583 #: ../fish/guestfish-actions.pod:2391
23586 " is-socket path\n"
23591 #: ../fish/guestfish-actions.pod:2398
23596 #: ../fish/guestfish-actions.pod:2400
23599 " is-symlink path\n"
23604 #: ../fish/guestfish-actions.pod:2407
23605 msgid "kill-subprocess"
23609 #: ../fish/guestfish-actions.pod:2409
23612 " kill-subprocess\n"
23617 #: ../fish/guestfish-actions.pod:2413
23622 #: ../fish/guestfish-actions.pod:2415
23627 #: ../fish/guestfish-actions.pod:2417
23635 #: ../fish/guestfish-actions.pod:2425
23640 #: ../fish/guestfish-actions.pod:2427
23643 " lchown owner group path\n"
23648 #: ../fish/guestfish-actions.pod:2429
23650 "Change the file owner to C<owner> and group to C<group>. This is like "
23651 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23656 #: ../fish/guestfish-actions.pod:2437
23661 #: ../fish/guestfish-actions.pod:2439
23664 " lgetxattr path name\n"
23669 #: ../fish/guestfish-actions.pod:2455
23670 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23674 #: ../fish/guestfish-actions.pod:2457
23679 #: ../fish/guestfish-actions.pod:2459
23682 " lgetxattrs path\n"
23687 #: ../fish/guestfish-actions.pod:2461
23689 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23690 "it returns the extended attributes of the link itself."
23694 #: ../fish/guestfish-actions.pod:2465
23695 msgid "list-devices"
23699 #: ../fish/guestfish-actions.pod:2467
23707 #: ../fish/guestfish-actions.pod:2475
23708 msgid "list-filesystems"
23712 #: ../fish/guestfish-actions.pod:2477
23715 " list-filesystems\n"
23720 #: ../fish/guestfish-actions.pod:2496
23722 "This command runs other libguestfs commands, which might include L</mount> "
23723 "and L</umount>, and therefore you should use this soon after launch and only "
23724 "when nothing is mounted."
23728 #: ../fish/guestfish-actions.pod:2500
23730 "Not all of the filesystems returned will be mountable. In particular, swap "
23731 "partitions are returned in the list. Also this command does not check that "
23732 "each filesystem found is valid and mountable, and some filesystems might be "
23733 "mountable but require special options. Filesystems may not all belong to a "
23734 "single logical operating system (use L</inspect-os> to look for OSes)."
23738 #: ../fish/guestfish-actions.pod:2508
23739 msgid "list-partitions"
23743 #: ../fish/guestfish-actions.pod:2510
23746 " list-partitions\n"
23751 #: ../fish/guestfish-actions.pod:2516
23753 "This does not return logical volumes. For that you will need to call "
23758 #: ../fish/guestfish-actions.pod:2521
23763 #: ../fish/guestfish-actions.pod:2523
23771 #: ../fish/guestfish-actions.pod:2531
23776 #: ../fish/guestfish-actions.pod:2533
23779 " ln target linkname\n"
23784 #: ../fish/guestfish-actions.pod:2537
23789 #: ../fish/guestfish-actions.pod:2539
23792 " ln-f target linkname\n"
23797 #: ../fish/guestfish-actions.pod:2544
23802 #: ../fish/guestfish-actions.pod:2546
23805 " ln-s target linkname\n"
23810 #: ../fish/guestfish-actions.pod:2550
23815 #: ../fish/guestfish-actions.pod:2552
23818 " ln-sf target linkname\n"
23823 #: ../fish/guestfish-actions.pod:2557
23824 msgid "lremovexattr"
23828 #: ../fish/guestfish-actions.pod:2559
23831 " lremovexattr xattr path\n"
23836 #: ../fish/guestfish-actions.pod:2561
23838 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
23839 "it removes an extended attribute of the link itself."
23843 #: ../fish/guestfish-actions.pod:2565
23848 #: ../fish/guestfish-actions.pod:2567
23856 #: ../fish/guestfish-actions.pod:2573
23858 "This command is mostly useful for interactive sessions. Programs should "
23859 "probably use L</readdir> instead."
23863 #: ../fish/guestfish-actions.pod:2576
23868 #: ../fish/guestfish-actions.pod:2578
23871 " lsetxattr xattr val vallen path\n"
23876 #: ../fish/guestfish-actions.pod:2580
23878 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
23879 "sets an extended attribute of the link itself."
23883 #: ../fish/guestfish-actions.pod:2584
23888 #: ../fish/guestfish-actions.pod:2586
23896 #: ../fish/guestfish-actions.pod:2590
23898 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
23899 "the link is stat-ed, not the file it refers to."
23903 #: ../fish/guestfish-actions.pod:2596
23908 #: ../fish/guestfish-actions.pod:2598
23911 " lstatlist path 'names ...'\n"
23916 #: ../fish/guestfish-actions.pod:2600
23918 "This call allows you to perform the L</lstat> operation on multiple files, "
23919 "where all files are in the directory C<path>. C<names> is the list of files "
23920 "from this directory."
23924 #: ../fish/guestfish-actions.pod:2609
23926 "This call is intended for programs that want to efficiently list a directory "
23927 "contents without making many round-trips. See also L</lxattrlist> for a "
23928 "similarly efficient call for getting extended attributes. Very long "
23929 "directory listings might cause the protocol message size to be exceeded, "
23930 "causing this call to fail. The caller must split up such requests into "
23931 "smaller groups of names."
23935 #: ../fish/guestfish-actions.pod:2617
23936 msgid "luks-add-key"
23940 #: ../fish/guestfish-actions.pod:2619
23943 " luks-add-key device keyslot\n"
23948 #: ../fish/guestfish-actions.pod:2626
23950 "Note that if C<keyslot> already contains a key, then this command will "
23951 "fail. You have to use L</luks-kill-slot> first to remove that key."
23955 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679 ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
23957 "This command has one or more key or passphrase parameters. Guestfish will "
23958 "prompt for these separately."
23962 #: ../fish/guestfish-actions.pod:2633
23967 #: ../fish/guestfish-actions.pod:2635
23970 " luks-close device\n"
23975 #: ../fish/guestfish-actions.pod:2637
23977 "This closes a LUKS device that was created earlier by L</luks-open> or "
23978 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
23979 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
23980 "underlying block device."
23984 #: ../fish/guestfish-actions.pod:2643
23985 msgid "luks-format"
23989 #: ../fish/guestfish-actions.pod:2645
23992 " luks-format device keyslot\n"
23997 #: ../fish/guestfish-actions.pod:2658
23998 msgid "luks-format-cipher"
24002 #: ../fish/guestfish-actions.pod:2660
24005 " luks-format-cipher device keyslot cipher\n"
24010 #: ../fish/guestfish-actions.pod:2662
24012 "This command is the same as L</luks-format> but it also allows you to set "
24013 "the C<cipher> used."
24017 #: ../fish/guestfish-actions.pod:2671
24018 msgid "luks-kill-slot"
24022 #: ../fish/guestfish-actions.pod:2673
24025 " luks-kill-slot device keyslot\n"
24030 #: ../fish/guestfish-actions.pod:2682
24035 #: ../fish/guestfish-actions.pod:2684
24038 " luks-open device mapname\n"
24043 #: ../fish/guestfish-actions.pod:2698
24045 "If this block device contains LVM volume groups, then calling L</vgscan> "
24046 "followed by L</vg-activate-all> will make them visible."
24050 #: ../fish/guestfish-actions.pod:2705
24051 msgid "luks-open-ro"
24055 #: ../fish/guestfish-actions.pod:2707
24058 " luks-open-ro device mapname\n"
24063 #: ../fish/guestfish-actions.pod:2709
24065 "This is the same as L</luks-open> except that a read-only mapping is "
24070 #: ../fish/guestfish-actions.pod:2715
24075 #: ../fish/guestfish-actions.pod:2717
24078 " lvcreate logvol volgroup mbytes\n"
24083 #: ../fish/guestfish-actions.pod:2722
24084 msgid "lvm-canonical-lv-name"
24088 #: ../fish/guestfish-actions.pod:2724
24091 " lvm-canonical-lv-name lvname\n"
24096 #: ../fish/guestfish-actions.pod:2733
24097 msgid "See also L</is-lv>."
24101 #: ../fish/guestfish-actions.pod:2735
24102 msgid "lvm-clear-filter"
24106 #: ../fish/guestfish-actions.pod:2737
24109 " lvm-clear-filter\n"
24114 #: ../fish/guestfish-actions.pod:2739
24116 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24121 #: ../fish/guestfish-actions.pod:2745
24122 msgid "lvm-remove-all"
24126 #: ../fish/guestfish-actions.pod:2747
24129 " lvm-remove-all\n"
24134 #: ../fish/guestfish-actions.pod:2755
24135 msgid "lvm-set-filter"
24139 #: ../fish/guestfish-actions.pod:2757
24142 " lvm-set-filter 'devices ...'\n"
24147 #: ../fish/guestfish-actions.pod:2782
24152 #: ../fish/guestfish-actions.pod:2784
24155 " lvremove device\n"
24160 #: ../fish/guestfish-actions.pod:2792
24165 #: ../fish/guestfish-actions.pod:2794
24168 " lvrename logvol newlogvol\n"
24173 #: ../fish/guestfish-actions.pod:2798
24178 #: ../fish/guestfish-actions.pod:2800
24181 " lvresize device mbytes\n"
24186 #: ../fish/guestfish-actions.pod:2806
24187 msgid "lvresize-free"
24191 #: ../fish/guestfish-actions.pod:2808
24194 " lvresize-free lv percent\n"
24199 #: ../fish/guestfish-actions.pod:2816
24204 #: ../fish/guestfish-actions.pod:2818
24212 #: ../fish/guestfish-actions.pod:2826
24213 msgid "See also L</lvs-full>, L</list-filesystems>."
24217 #: ../fish/guestfish-actions.pod:2828
24222 #: ../fish/guestfish-actions.pod:2830
24230 #: ../fish/guestfish-actions.pod:2835
24235 #: ../fish/guestfish-actions.pod:2837
24243 #: ../fish/guestfish-actions.pod:2841
24248 #: ../fish/guestfish-actions.pod:2843
24251 " lxattrlist path 'names ...'\n"
24256 #: ../fish/guestfish-actions.pod:2859
24258 "This call is intended for programs that want to efficiently list a directory "
24259 "contents without making many round-trips. See also L</lstatlist> for a "
24260 "similarly efficient call for getting standard stats. Very long directory "
24261 "listings might cause the protocol message size to be exceeded, causing this "
24262 "call to fail. The caller must split up such requests into smaller groups of "
24267 #: ../fish/guestfish-actions.pod:2867
24272 #: ../fish/guestfish-actions.pod:2869
24280 #: ../fish/guestfish-actions.pod:2873
24285 #: ../fish/guestfish-actions.pod:2875
24288 " mkdir-mode path mode\n"
24293 #: ../fish/guestfish-actions.pod:2884
24294 msgid "See also L</mkdir>, L</umask>"
24298 #: ../fish/guestfish-actions.pod:2886
24303 #: ../fish/guestfish-actions.pod:2888
24311 #: ../fish/guestfish-actions.pod:2893
24316 #: ../fish/guestfish-actions.pod:2895
24319 " mkdtemp template\n"
24324 #: ../fish/guestfish-actions.pod:2916
24329 #: ../fish/guestfish-actions.pod:2918
24332 " mke2fs-J fstype blocksize device journal\n"
24337 #: ../fish/guestfish-actions.pod:2926
24338 msgid "See also L</mke2journal>."
24342 #: ../fish/guestfish-actions.pod:2928
24347 #: ../fish/guestfish-actions.pod:2930
24350 " mke2fs-JL fstype blocksize device label\n"
24355 #: ../fish/guestfish-actions.pod:2935
24356 msgid "See also L</mke2journal-L>."
24360 #: ../fish/guestfish-actions.pod:2937
24365 #: ../fish/guestfish-actions.pod:2939
24368 " mke2fs-JU fstype blocksize device uuid\n"
24373 #: ../fish/guestfish-actions.pod:2944
24374 msgid "See also L</mke2journal-U>."
24378 #: ../fish/guestfish-actions.pod:2946
24379 msgid "mke2journal"
24383 #: ../fish/guestfish-actions.pod:2948
24386 " mke2journal blocksize device\n"
24391 #: ../fish/guestfish-actions.pod:2955
24392 msgid "mke2journal-L"
24396 #: ../fish/guestfish-actions.pod:2957
24399 " mke2journal-L blocksize label device\n"
24404 #: ../fish/guestfish-actions.pod:2961
24405 msgid "mke2journal-U"
24409 #: ../fish/guestfish-actions.pod:2963
24412 " mke2journal-U blocksize uuid device\n"
24417 #: ../fish/guestfish-actions.pod:2967
24422 #: ../fish/guestfish-actions.pod:2969
24425 " mkfifo mode path\n"
24430 #: ../fish/guestfish-actions.pod:2971
24432 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24433 "is just a convenient wrapper around L</mknod>."
24437 #: ../fish/guestfish-actions.pod:2977
24442 #: ../fish/guestfish-actions.pod:2979
24445 " mkfs fstype device\n"
24450 #: ../fish/guestfish-actions.pod:2985
24455 #: ../fish/guestfish-actions.pod:2987
24458 " mkfs-b fstype blocksize device\n"
24463 #: ../fish/guestfish-actions.pod:2989
24465 "This call is similar to L</mkfs>, but it allows you to control the block "
24466 "size of the resulting filesystem. Supported block sizes depend on the "
24467 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24471 #: ../fish/guestfish-actions.pod:3004
24476 #: ../fish/guestfish-actions.pod:3006
24479 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24484 #: ../fish/guestfish-actions.pod:3041
24485 msgid "mkmountpoint"
24489 #: ../fish/guestfish-actions.pod:3043
24492 " mkmountpoint exemptpath\n"
24497 #: ../fish/guestfish-actions.pod:3045
24499 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24500 "to create extra mountpoints before mounting the first filesystem."
24504 #: ../fish/guestfish-actions.pod:3069
24506 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24507 "unexpected errors if you try to mix these calls. It is safest to manually "
24508 "unmount filesystems and remove mountpoints after use."
24512 #: ../fish/guestfish-actions.pod:3073
24514 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24515 "for this to work for manual mountpoints, you must ensure that the innermost "
24516 "mountpoints have the longest pathnames, as in the example code above."
24520 #: ../fish/guestfish-actions.pod:3080
24522 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24523 "L</umount-all> to be called when the handle is closed which can also trigger "
24528 #: ../fish/guestfish-actions.pod:3084
24533 #: ../fish/guestfish-actions.pod:3086
24536 " mknod mode devmajor devminor path\n"
24541 #: ../fish/guestfish-actions.pod:3096
24543 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24544 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24545 "regular file). These constants are available in the standard Linux header "
24546 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24547 "wrappers around this command which bitwise OR in the appropriate constant "
24552 #: ../fish/guestfish-actions.pod:3106
24557 #: ../fish/guestfish-actions.pod:3108
24560 " mknod-b mode devmajor devminor path\n"
24565 #: ../fish/guestfish-actions.pod:3110
24567 "This call creates a block device node called C<path> with mode C<mode> and "
24568 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24569 "wrapper around L</mknod>."
24573 #: ../fish/guestfish-actions.pod:3116
24578 #: ../fish/guestfish-actions.pod:3118
24581 " mknod-c mode devmajor devminor path\n"
24586 #: ../fish/guestfish-actions.pod:3120
24588 "This call creates a char device node called C<path> with mode C<mode> and "
24589 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24590 "wrapper around L</mknod>."
24594 #: ../fish/guestfish-actions.pod:3126
24599 #: ../fish/guestfish-actions.pod:3128
24607 #: ../fish/guestfish-actions.pod:3132
24612 #: ../fish/guestfish-actions.pod:3134
24615 " mkswap-L label device\n"
24620 #: ../fish/guestfish-actions.pod:3142
24625 #: ../fish/guestfish-actions.pod:3144
24628 " mkswap-U uuid device\n"
24633 #: ../fish/guestfish-actions.pod:3148
24634 msgid "mkswap-file"
24638 #: ../fish/guestfish-actions.pod:3150
24641 " mkswap-file path\n"
24646 #: ../fish/guestfish-actions.pod:3154
24648 "This command just writes a swap file signature to an existing file. To "
24649 "create the file itself, use something like L</fallocate>."
24653 #: ../fish/guestfish-actions.pod:3157
24658 #: ../fish/guestfish-actions.pod:3159
24661 " modprobe modulename\n"
24666 #: ../fish/guestfish-actions.pod:3166
24671 #: ../fish/guestfish-actions.pod:3168
24674 " mount device mountpoint\n"
24679 #: ../fish/guestfish-actions.pod:3184
24681 "B<Important note:> When you use this call, the filesystem options C<sync> "
24682 "and C<noatime> are set implicitly. This was originally done because we "
24683 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24684 "very large negative performance impact and negligible effect on "
24685 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24686 "code that needs performance, and instead use L</mount-options> (use an empty "
24687 "string for the first parameter if you don't want any options)."
24691 #: ../fish/guestfish-actions.pod:3194
24696 #: ../fish/guestfish-actions.pod:3196
24699 " mount-loop file mountpoint\n"
24704 #: ../fish/guestfish-actions.pod:3202
24705 msgid "mount-options"
24709 #: ../fish/guestfish-actions.pod:3204
24712 " mount-options options device mountpoint\n"
24717 #: ../fish/guestfish-actions.pod:3206
24719 "This is the same as the L</mount> command, but it allows you to set the "
24720 "mount options as for the L<mount(8)> I<-o> flag."
24724 #: ../fish/guestfish-actions.pod:3214
24729 #: ../fish/guestfish-actions.pod:3216
24732 " mount-ro device mountpoint\n"
24737 #: ../fish/guestfish-actions.pod:3218
24739 "This is the same as the L</mount> command, but it mounts the filesystem with "
24740 "the read-only (I<-o ro>) flag."
24744 #: ../fish/guestfish-actions.pod:3221
24749 #: ../fish/guestfish-actions.pod:3223
24752 " mount-vfs options vfstype device mountpoint\n"
24757 #: ../fish/guestfish-actions.pod:3225
24759 "This is the same as the L</mount> command, but it allows you to set both the "
24760 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
24764 #: ../fish/guestfish-actions.pod:3229
24765 msgid "mountpoints"
24769 #: ../fish/guestfish-actions.pod:3231
24777 #: ../fish/guestfish-actions.pod:3233
24779 "This call is similar to L</mounts>. That call returns a list of devices. "
24780 "This one returns a hash table (map) of device name to directory where the "
24781 "device is mounted."
24785 #: ../fish/guestfish-actions.pod:3237
24790 #: ../fish/guestfish-actions.pod:3239
24798 #: ../fish/guestfish-actions.pod:3246
24799 msgid "See also: L</mountpoints>"
24803 #: ../fish/guestfish-actions.pod:3248
24808 #: ../fish/guestfish-actions.pod:3250
24816 #: ../fish/guestfish-actions.pod:3255
24817 msgid "ntfs-3g-probe"
24821 #: ../fish/guestfish-actions.pod:3257
24824 " ntfs-3g-probe true|false device\n"
24829 #: ../fish/guestfish-actions.pod:3271
24834 #: ../fish/guestfish-actions.pod:3273
24837 " ntfsresize device\n"
24842 #: ../fish/guestfish-actions.pod:3279
24843 msgid "ntfsresize-size"
24847 #: ../fish/guestfish-actions.pod:3281
24850 " ntfsresize-size device size\n"
24855 #: ../fish/guestfish-actions.pod:3283
24857 "This command is the same as L</ntfsresize> except that it allows you to "
24858 "specify the new size (in bytes) explicitly."
24862 #: ../fish/guestfish-actions.pod:3286
24867 #: ../fish/guestfish-actions.pod:3288
24870 " part-add device prlogex startsect endsect\n"
24875 #: ../fish/guestfish-actions.pod:3290
24877 "This command adds a partition to C<device>. If there is no partition table "
24878 "on the device, call L</part-init> first."
24882 #: ../fish/guestfish-actions.pod:3302
24884 "Creating a partition which covers the whole disk is not so easy. Use "
24885 "L</part-disk> to do that."
24889 #: ../fish/guestfish-actions.pod:3305
24894 #: ../fish/guestfish-actions.pod:3307
24897 " part-del device partnum\n"
24902 #: ../fish/guestfish-actions.pod:3315
24907 #: ../fish/guestfish-actions.pod:3317
24910 " part-disk device parttype\n"
24915 #: ../fish/guestfish-actions.pod:3319
24917 "This command is simply a combination of L</part-init> followed by "
24918 "L</part-add> to create a single primary partition covering the whole disk."
24922 #: ../fish/guestfish-actions.pod:3323
24924 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
24925 "possible values are described in L</part-init>."
24929 #: ../fish/guestfish-actions.pod:3329
24930 msgid "part-get-bootable"
24934 #: ../fish/guestfish-actions.pod:3331
24937 " part-get-bootable device partnum\n"
24942 #: ../fish/guestfish-actions.pod:3336
24943 msgid "See also L</part-set-bootable>."
24947 #: ../fish/guestfish-actions.pod:3338
24948 msgid "part-get-mbr-id"
24952 #: ../fish/guestfish-actions.pod:3340
24955 " part-get-mbr-id device partnum\n"
24960 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
24962 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
24963 "undefined results for other partition table types (see "
24964 "L</part-get-parttype>)."
24968 #: ../fish/guestfish-actions.pod:3349
24969 msgid "part-get-parttype"
24973 #: ../fish/guestfish-actions.pod:3351
24976 " part-get-parttype device\n"
24981 #: ../fish/guestfish-actions.pod:3356
24983 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
24984 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
24985 "possible, although unusual. See L</part-init> for a full list."
24989 #: ../fish/guestfish-actions.pod:3361
24994 #: ../fish/guestfish-actions.pod:3363
24997 " part-init device parttype\n"
25002 #: ../fish/guestfish-actions.pod:3369
25004 "Initially there are no partitions. Following this, you should call "
25005 "L</part-add> for each partition required."
25009 #: ../fish/guestfish-actions.pod:3432
25014 #: ../fish/guestfish-actions.pod:3434
25017 " part-list device\n"
25022 #: ../fish/guestfish-actions.pod:3449
25024 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25025 "the device's sector size, see L</blockdev-getss>."
25029 #: ../fish/guestfish-actions.pod:3462
25030 msgid "part-set-bootable"
25034 #: ../fish/guestfish-actions.pod:3464
25037 " part-set-bootable device partnum true|false\n"
25042 #: ../fish/guestfish-actions.pod:3473
25043 msgid "part-set-mbr-id"
25047 #: ../fish/guestfish-actions.pod:3475
25050 " part-set-mbr-id device partnum idbyte\n"
25055 #: ../fish/guestfish-actions.pod:3487
25056 msgid "part-set-name"
25060 #: ../fish/guestfish-actions.pod:3489
25063 " part-set-name device partnum name\n"
25068 #: ../fish/guestfish-actions.pod:3497
25069 msgid "part-to-dev"
25073 #: ../fish/guestfish-actions.pod:3499
25076 " part-to-dev partition\n"
25081 #: ../fish/guestfish-actions.pod:3505
25083 "The named partition must exist, for example as a string returned from "
25084 "L</list-partitions>."
25088 #: ../fish/guestfish-actions.pod:3508
25089 msgid "ping-daemon"
25093 #: ../fish/guestfish-actions.pod:3510
25101 #: ../fish/guestfish-actions.pod:3517
25106 #: ../fish/guestfish-actions.pod:3519
25109 " pread path count offset\n"
25114 #: ../fish/guestfish-actions.pod:3527
25115 msgid "See also L</pwrite>, L</pread-device>."
25119 #: ../fish/guestfish-actions.pod:3532
25120 msgid "pread-device"
25124 #: ../fish/guestfish-actions.pod:3534
25127 " pread-device device count offset\n"
25132 #: ../fish/guestfish-actions.pod:3542
25133 msgid "See also L</pread>."
25137 #: ../fish/guestfish-actions.pod:3547
25142 #: ../fish/guestfish-actions.pod:3549
25145 " pvcreate device\n"
25150 #: ../fish/guestfish-actions.pod:3555
25155 #: ../fish/guestfish-actions.pod:3557
25158 " pvremove device\n"
25163 #: ../fish/guestfish-actions.pod:3566
25168 #: ../fish/guestfish-actions.pod:3568
25171 " pvresize device\n"
25176 #: ../fish/guestfish-actions.pod:3573
25177 msgid "pvresize-size"
25181 #: ../fish/guestfish-actions.pod:3575
25184 " pvresize-size device size\n"
25189 #: ../fish/guestfish-actions.pod:3577
25191 "This command is the same as L</pvresize> except that it allows you to "
25192 "specify the new size (in bytes) explicitly."
25196 #: ../fish/guestfish-actions.pod:3580
25201 #: ../fish/guestfish-actions.pod:3582
25209 #: ../fish/guestfish-actions.pod:3590
25210 msgid "See also L</pvs-full>."
25214 #: ../fish/guestfish-actions.pod:3592
25219 #: ../fish/guestfish-actions.pod:3594
25227 #: ../fish/guestfish-actions.pod:3599
25232 #: ../fish/guestfish-actions.pod:3601
25240 #: ../fish/guestfish-actions.pod:3605
25245 #: ../fish/guestfish-actions.pod:3607
25248 " pwrite path content offset\n"
25253 #: ../fish/guestfish-actions.pod:3618
25254 msgid "See also L</pread>, L</pwrite-device>."
25258 #: ../fish/guestfish-actions.pod:3623
25259 msgid "pwrite-device"
25263 #: ../fish/guestfish-actions.pod:3625
25266 " pwrite-device device content offset\n"
25271 #: ../fish/guestfish-actions.pod:3635
25272 msgid "See also L</pwrite>."
25276 #: ../fish/guestfish-actions.pod:3640
25281 #: ../fish/guestfish-actions.pod:3642
25284 " read-file path\n"
25289 #: ../fish/guestfish-actions.pod:3647
25291 "Unlike L</cat>, this function can correctly handle files that contain "
25292 "embedded ASCII NUL characters. However unlike L</download>, this function "
25293 "is limited in the total size of file that can be handled."
25297 #: ../fish/guestfish-actions.pod:3655
25302 #: ../fish/guestfish-actions.pod:3657
25305 " read-lines path\n"
25310 #: ../fish/guestfish-actions.pod:3664
25312 "Note that this function cannot correctly handle binary files (specifically, "
25313 "files containing C<\\0> character which is treated as end of line). For "
25314 "those you need to use the L</read-file> function which has a more complex "
25319 #: ../fish/guestfish-actions.pod:3669
25324 #: ../fish/guestfish-actions.pod:3671
25332 #: ../fish/guestfish-actions.pod:3723
25334 "This function is primarily intended for use by programs. To get a simple "
25335 "list of names, use L</ls>. To get a printable directory for human "
25336 "consumption, use L</ll>."
25340 #: ../fish/guestfish-actions.pod:3727
25345 #: ../fish/guestfish-actions.pod:3729
25353 #: ../fish/guestfish-actions.pod:3733
25354 msgid "readlinklist"
25358 #: ../fish/guestfish-actions.pod:3735
25361 " readlinklist path 'names ...'\n"
25366 #: ../fish/guestfish-actions.pod:3759
25371 #: ../fish/guestfish-actions.pod:3761
25379 #: ../fish/guestfish-actions.pod:3766
25380 msgid "removexattr"
25384 #: ../fish/guestfish-actions.pod:3768
25387 " removexattr xattr path\n"
25392 #: ../fish/guestfish-actions.pod:3773
25393 msgid "See also: L</lremovexattr>, L<attr(5)>."
25397 #: ../fish/guestfish-actions.pod:3775
25402 #: ../fish/guestfish-actions.pod:3777
25405 " resize2fs device\n"
25410 #: ../fish/guestfish-actions.pod:3782
25412 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25413 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25414 "gives an error about this and sometimes not. In any case, it is always safe "
25415 "to call L</e2fsck-f> before calling this function."
25419 #: ../fish/guestfish-actions.pod:3788
25420 msgid "resize2fs-M"
25424 #: ../fish/guestfish-actions.pod:3790
25427 " resize2fs-M device\n"
25432 #: ../fish/guestfish-actions.pod:3792
25434 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25435 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
25440 #: ../fish/guestfish-actions.pod:3796
25442 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25443 "and read the C<Block size> and C<Block count> values. These two numbers, "
25444 "multiplied together, give the resulting size of the minimal filesystem in "
25449 #: ../fish/guestfish-actions.pod:3801
25450 msgid "resize2fs-size"
25454 #: ../fish/guestfish-actions.pod:3803
25457 " resize2fs-size device size\n"
25462 #: ../fish/guestfish-actions.pod:3805
25464 "This command is the same as L</resize2fs> except that it allows you to "
25465 "specify the new size (in bytes) explicitly."
25469 #: ../fish/guestfish-actions.pod:3808
25474 #: ../fish/guestfish-actions.pod:3810
25482 #: ../fish/guestfish-actions.pod:3814
25487 #: ../fish/guestfish-actions.pod:3816
25495 #: ../fish/guestfish-actions.pod:3822
25500 #: ../fish/guestfish-actions.pod:3824
25508 #: ../fish/guestfish-actions.pod:3828
25509 msgid "rmmountpoint"
25513 #: ../fish/guestfish-actions.pod:3830
25516 " rmmountpoint exemptpath\n"
25521 #: ../fish/guestfish-actions.pod:3832
25523 "This calls removes a mountpoint that was previously created with "
25524 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25528 #: ../fish/guestfish-actions.pod:3836
25529 msgid "scrub-device"
25533 #: ../fish/guestfish-actions.pod:3838
25536 " scrub-device device\n"
25541 #: ../fish/guestfish-actions.pod:3849
25546 #: ../fish/guestfish-actions.pod:3851
25549 " scrub-file file\n"
25554 #: ../fish/guestfish-actions.pod:3861
25555 msgid "scrub-freespace"
25559 #: ../fish/guestfish-actions.pod:3863
25562 " scrub-freespace dir\n"
25567 #: ../fish/guestfish-actions.pod:3865
25569 "This command creates the directory C<dir> and then fills it with files until "
25570 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25571 "deletes them. The intention is to scrub any free space on the partition "
25572 "containing C<dir>."
25576 #: ../fish/guestfish-actions.pod:3874
25581 #: ../fish/guestfish-actions.pod:3876
25586 #: ../fish/guestfish-actions.pod:3878
25589 " set-append append\n"
25594 #: ../fish/guestfish-actions.pod:3889
25595 msgid "set-attach-method"
25599 #: ../fish/guestfish-actions.pod:3891
25600 msgid "attach-method"
25604 #: ../fish/guestfish-actions.pod:3893
25607 " set-attach-method attachmethod\n"
25612 #: ../fish/guestfish-actions.pod:3915
25613 msgid "set-autosync"
25617 #: ../fish/guestfish-actions.pod:3917
25622 #: ../fish/guestfish-actions.pod:3919
25625 " set-autosync true|false\n"
25630 #: ../fish/guestfish-actions.pod:3929
25635 #: ../fish/guestfish-actions.pod:3931
25640 #: ../fish/guestfish-actions.pod:3933
25643 " set-direct true|false\n"
25648 #: ../fish/guestfish-actions.pod:3939
25650 "One consequence of this is that log messages aren't caught by the library "
25651 "and handled by L</set-log-message-callback>, but go straight to stdout."
25655 #: ../fish/guestfish-actions.pod:3948
25656 msgid "set-e2label"
25660 #: ../fish/guestfish-actions.pod:3950
25663 " set-e2label device label\n"
25668 #: ../fish/guestfish-actions.pod:3956
25670 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25671 "label on a filesystem."
25675 #: ../fish/guestfish-actions.pod:3959
25680 #: ../fish/guestfish-actions.pod:3961
25683 " set-e2uuid device uuid\n"
25688 #: ../fish/guestfish-actions.pod:3968
25690 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25691 "UUID of a filesystem."
25695 #: ../fish/guestfish-actions.pod:3971
25696 msgid "set-memsize"
25700 #: ../fish/guestfish-actions.pod:3973
25705 #: ../fish/guestfish-actions.pod:3975
25708 " set-memsize memsize\n"
25713 #: ../fish/guestfish-actions.pod:3977
25715 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25716 "This only has any effect if called before L</launch>."
25720 #: ../fish/guestfish-actions.pod:3988
25721 msgid "set-network"
25725 #: ../fish/guestfish-actions.pod:3990
25730 #: ../fish/guestfish-actions.pod:3992
25733 " set-network true|false\n"
25738 #: ../fish/guestfish-actions.pod:4000
25739 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25743 #: ../fish/guestfish-actions.pod:4003
25748 #: ../fish/guestfish-actions.pod:4005
25753 #: ../fish/guestfish-actions.pod:4007
25756 " set-path searchpath\n"
25761 #: ../fish/guestfish-actions.pod:4016
25766 #: ../fish/guestfish-actions.pod:4018
25771 #: ../fish/guestfish-actions.pod:4020
25779 #: ../fish/guestfish-actions.pod:4040
25780 msgid "set-recovery-proc"
25784 #: ../fish/guestfish-actions.pod:4042
25785 msgid "recovery-proc"
25789 #: ../fish/guestfish-actions.pod:4044
25792 " set-recovery-proc true|false\n"
25797 #: ../fish/guestfish-actions.pod:4046
25799 "If this is called with the parameter C<false> then L</launch> does not "
25800 "create a recovery process. The purpose of the recovery process is to stop "
25801 "runaway qemu processes in the case where the main program aborts abruptly."
25805 #: ../fish/guestfish-actions.pod:4051
25807 "This only has any effect if called before L</launch>, and the default is "
25812 #: ../fish/guestfish-actions.pod:4060
25813 msgid "set-selinux"
25817 #: ../fish/guestfish-actions.pod:4062
25822 #: ../fish/guestfish-actions.pod:4064
25825 " set-selinux true|false\n"
25830 #: ../fish/guestfish-actions.pod:4075
25835 #: ../fish/guestfish-actions.pod:4077
25840 #: ../fish/guestfish-actions.pod:4079
25843 " set-trace true|false\n"
25848 #: ../fish/guestfish-actions.pod:4091
25850 "Trace messages are normally sent to C<stderr>, unless you register a "
25851 "callback to send them somewhere else (see L</set-event-callback>)."
25855 #: ../fish/guestfish-actions.pod:4095
25856 msgid "set-verbose"
25860 #: ../fish/guestfish-actions.pod:4097
25865 #: ../fish/guestfish-actions.pod:4099
25868 " set-verbose true|false\n"
25873 #: ../fish/guestfish-actions.pod:4106
25875 "Verbose messages are normally sent to C<stderr>, unless you register a "
25876 "callback to send them somewhere else (see L</set-event-callback>)."
25880 #: ../fish/guestfish-actions.pod:4110
25885 #: ../fish/guestfish-actions.pod:4112
25888 " setcon context\n"
25893 #: ../fish/guestfish-actions.pod:4119
25898 #: ../fish/guestfish-actions.pod:4121
25901 " setxattr xattr val vallen path\n"
25906 #: ../fish/guestfish-actions.pod:4127
25907 msgid "See also: L</lsetxattr>, L<attr(5)>."
25911 #: ../fish/guestfish-actions.pod:4129
25916 #: ../fish/guestfish-actions.pod:4131
25919 " sfdisk device cyls heads sectors 'lines ...'\n"
25924 #: ../fish/guestfish-actions.pod:4153
25925 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
25929 #: ../fish/guestfish-actions.pod:4159
25934 #: ../fish/guestfish-actions.pod:4161
25937 " sfdiskM device 'lines ...'\n"
25942 #: ../fish/guestfish-actions.pod:4163
25944 "This is a simplified interface to the L</sfdisk> command, where partition "
25945 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
25946 "you don't need to specify the cyls, heads and sectors parameters which were "
25947 "rarely if ever used anyway."
25951 #: ../fish/guestfish-actions.pod:4169
25952 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
25956 #: ../fish/guestfish-actions.pod:4175
25961 #: ../fish/guestfish-actions.pod:4177
25964 " sfdisk-N device partnum cyls heads sectors line\n"
25969 #: ../fish/guestfish-actions.pod:4182
25971 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
25972 "cyls/heads/sectors parameters."
25976 #: ../fish/guestfish-actions.pod:4185
25977 msgid "See also: L</part-add>"
25981 #: ../fish/guestfish-actions.pod:4190
25982 msgid "sfdisk-disk-geometry"
25986 #: ../fish/guestfish-actions.pod:4192
25989 " sfdisk-disk-geometry device\n"
25994 #: ../fish/guestfish-actions.pod:4194
25996 "This displays the disk geometry of C<device> read from the partition table. "
25997 "Especially in the case where the underlying block device has been resized, "
25998 "this can be different from the kernel's idea of the geometry (see "
25999 "L</sfdisk-kernel-geometry>)."
26003 #: ../fish/guestfish-actions.pod:4202
26004 msgid "sfdisk-kernel-geometry"
26008 #: ../fish/guestfish-actions.pod:4204
26011 " sfdisk-kernel-geometry device\n"
26016 #: ../fish/guestfish-actions.pod:4211
26021 #: ../fish/guestfish-actions.pod:4213
26024 " sfdisk-l device\n"
26029 #: ../fish/guestfish-actions.pod:4219
26030 msgid "See also: L</part-list>"
26034 #: ../fish/guestfish-actions.pod:4221
26039 #: ../fish/guestfish-actions.pod:4223
26047 #: ../fish/guestfish-actions.pod:4228
26048 msgid "This is like L</command>, but passes the command to:"
26052 #: ../fish/guestfish-actions.pod:4236
26053 msgid "All the provisos about L</command> apply to this call."
26057 #: ../fish/guestfish-actions.pod:4238
26062 #: ../fish/guestfish-actions.pod:4240
26065 " sh-lines command\n"
26070 #: ../fish/guestfish-actions.pod:4242
26071 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26075 #: ../fish/guestfish-actions.pod:4245
26076 msgid "See also: L</command-lines>"
26080 #: ../fish/guestfish-actions.pod:4247
26085 #: ../fish/guestfish-actions.pod:4249
26093 #: ../fish/guestfish-actions.pod:4253
26098 #: ../fish/guestfish-actions.pod:4255
26106 #: ../fish/guestfish-actions.pod:4261
26111 #: ../fish/guestfish-actions.pod:4263
26119 #: ../fish/guestfish-actions.pod:4271
26124 #: ../fish/guestfish-actions.pod:4273
26132 #: ../fish/guestfish-actions.pod:4281
26137 #: ../fish/guestfish-actions.pod:4283
26140 " strings-e encoding path\n"
26145 #: ../fish/guestfish-actions.pod:4285
26147 "This is like the L</strings> command, but allows you to specify the encoding "
26148 "of strings that are looked for in the source file C<path>."
26152 #: ../fish/guestfish-actions.pod:4295
26154 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26155 "ISO-8859-X (this is what L</strings> uses)."
26159 #: ../fish/guestfish-actions.pod:4327
26160 msgid "swapoff-device"
26164 #: ../fish/guestfish-actions.pod:4329
26167 " swapoff-device device\n"
26172 #: ../fish/guestfish-actions.pod:4331
26174 "This command disables the libguestfs appliance swap device or partition "
26175 "named C<device>. See L</swapon-device>."
26179 #: ../fish/guestfish-actions.pod:4335
26180 msgid "swapoff-file"
26184 #: ../fish/guestfish-actions.pod:4337
26187 " swapoff-file file\n"
26192 #: ../fish/guestfish-actions.pod:4341
26193 msgid "swapoff-label"
26197 #: ../fish/guestfish-actions.pod:4343
26200 " swapoff-label label\n"
26205 #: ../fish/guestfish-actions.pod:4348
26206 msgid "swapoff-uuid"
26210 #: ../fish/guestfish-actions.pod:4350
26213 " swapoff-uuid uuid\n"
26218 #: ../fish/guestfish-actions.pod:4355
26219 msgid "swapon-device"
26223 #: ../fish/guestfish-actions.pod:4357
26226 " swapon-device device\n"
26231 #: ../fish/guestfish-actions.pod:4359
26233 "This command enables the libguestfs appliance to use the swap device or "
26234 "partition named C<device>. The increased memory is made available for all "
26235 "commands, for example those run using L</command> or L</sh>."
26239 #: ../fish/guestfish-actions.pod:4371
26240 msgid "swapon-file"
26244 #: ../fish/guestfish-actions.pod:4373
26247 " swapon-file file\n"
26252 #: ../fish/guestfish-actions.pod:4375
26253 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26257 #: ../fish/guestfish-actions.pod:4378
26258 msgid "swapon-label"
26262 #: ../fish/guestfish-actions.pod:4380
26265 " swapon-label label\n"
26270 #: ../fish/guestfish-actions.pod:4382
26272 "This command enables swap to a labeled swap partition. See "
26273 "L</swapon-device> for other notes."
26277 #: ../fish/guestfish-actions.pod:4385
26278 msgid "swapon-uuid"
26282 #: ../fish/guestfish-actions.pod:4387
26285 " swapon-uuid uuid\n"
26290 #: ../fish/guestfish-actions.pod:4389
26292 "This command enables swap to a swap partition with the given UUID. See "
26293 "L</swapon-device> for other notes."
26297 #: ../fish/guestfish-actions.pod:4392
26302 #: ../fish/guestfish-actions.pod:4394
26310 #: ../fish/guestfish-actions.pod:4402
26315 #: ../fish/guestfish-actions.pod:4404
26323 #: ../fish/guestfish-actions.pod:4412
26328 #: ../fish/guestfish-actions.pod:4414
26331 " tail-n nrlines path\n"
26336 #: ../fish/guestfish-actions.pod:4427
26341 #: ../fish/guestfish-actions.pod:4429
26344 " tar-in (tarfile|-) directory\n"
26349 #: ../fish/guestfish-actions.pod:4434
26350 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26354 #: ../fish/guestfish-actions.pod:4439
26359 #: ../fish/guestfish-actions.pod:4441
26362 " tar-out directory (tarfile|-)\n"
26367 #: ../fish/guestfish-actions.pod:4446
26368 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26372 #: ../fish/guestfish-actions.pod:4451
26377 #: ../fish/guestfish-actions.pod:4453
26380 " tgz-in (tarball|-) directory\n"
26385 #: ../fish/guestfish-actions.pod:4458
26386 msgid "To upload an uncompressed tarball, use L</tar-in>."
26390 #: ../fish/guestfish-actions.pod:4462
26395 #: ../fish/guestfish-actions.pod:4464
26398 " tgz-out directory (tarball|-)\n"
26403 #: ../fish/guestfish-actions.pod:4469
26404 msgid "To download an uncompressed tarball, use L</tar-out>."
26408 #: ../fish/guestfish-actions.pod:4473
26413 #: ../fish/guestfish-actions.pod:4475
26421 #: ../fish/guestfish-actions.pod:4484
26426 #: ../fish/guestfish-actions.pod:4486
26434 #: ../fish/guestfish-actions.pod:4491
26435 msgid "truncate-size"
26439 #: ../fish/guestfish-actions.pod:4493
26442 " truncate-size path size\n"
26447 #: ../fish/guestfish-actions.pod:4498
26449 "If the current file size is less than C<size> then the file is extended to "
26450 "the required size with zero bytes. This creates a sparse file (ie. disk "
26451 "blocks are not allocated for the file until you write to it). To create a "
26452 "non-sparse file of zeroes, use L</fallocate64> instead."
26456 #: ../fish/guestfish-actions.pod:4504
26461 #: ../fish/guestfish-actions.pod:4506
26464 " tune2fs-l device\n"
26469 #: ../fish/guestfish-actions.pod:4516
26474 #: ../fish/guestfish-actions.pod:4518
26477 " txz-in (tarball|-) directory\n"
26482 #: ../fish/guestfish-actions.pod:4525
26487 #: ../fish/guestfish-actions.pod:4527
26490 " txz-out directory (tarball|-)\n"
26495 #: ../fish/guestfish-actions.pod:4534
26500 #: ../fish/guestfish-actions.pod:4536
26508 #: ../fish/guestfish-actions.pod:4550
26509 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26513 #: ../fish/guestfish-actions.pod:4555
26518 #: ../fish/guestfish-actions.pod:4557
26523 #: ../fish/guestfish-actions.pod:4559
26526 " umount pathordevice\n"
26531 #: ../fish/guestfish-actions.pod:4565
26536 #: ../fish/guestfish-actions.pod:4567
26537 msgid "unmount-all"
26541 #: ../fish/guestfish-actions.pod:4569
26549 #: ../fish/guestfish-actions.pod:4575
26554 #: ../fish/guestfish-actions.pod:4577
26557 " upload (filename|-) remotefilename\n"
26562 #: ../fish/guestfish-actions.pod:4584
26563 msgid "See also L</download>."
26567 #: ../fish/guestfish-actions.pod:4588
26568 msgid "upload-offset"
26572 #: ../fish/guestfish-actions.pod:4590
26575 " upload-offset (filename|-) remotefilename offset\n"
26580 #: ../fish/guestfish-actions.pod:4602
26582 "Note that there is no limit on the amount of data that can be uploaded with "
26583 "this call, unlike with L</pwrite>, and this call always writes the full "
26584 "amount unless an error occurs."
26588 #: ../fish/guestfish-actions.pod:4607
26589 msgid "See also L</upload>, L</pwrite>."
26593 #: ../fish/guestfish-actions.pod:4611
26598 #: ../fish/guestfish-actions.pod:4613
26601 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26606 #: ../fish/guestfish-actions.pod:4632
26611 #: ../fish/guestfish-actions.pod:4634
26619 #: ../fish/guestfish-actions.pod:4661
26621 "I<Note:> Don't use this call to test for availability of features. In "
26622 "enterprise distributions we backport features from later versions into "
26623 "earlier versions, making this an unreliable way to test for features. Use "
26624 "L</available> instead."
26628 #: ../fish/guestfish-actions.pod:4667
26633 #: ../fish/guestfish-actions.pod:4669
26636 " vfs-label device\n"
26641 #: ../fish/guestfish-actions.pod:4676
26642 msgid "To find a filesystem from the label, use L</findfs-label>."
26646 #: ../fish/guestfish-actions.pod:4678
26651 #: ../fish/guestfish-actions.pod:4680
26654 " vfs-type device\n"
26659 #: ../fish/guestfish-actions.pod:4690
26664 #: ../fish/guestfish-actions.pod:4692
26667 " vfs-uuid device\n"
26672 #: ../fish/guestfish-actions.pod:4699
26673 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26677 #: ../fish/guestfish-actions.pod:4701
26678 msgid "vg-activate"
26682 #: ../fish/guestfish-actions.pod:4703
26685 " vg-activate true|false 'volgroups ...'\n"
26690 #: ../fish/guestfish-actions.pod:4716
26691 msgid "vg-activate-all"
26695 #: ../fish/guestfish-actions.pod:4718
26698 " vg-activate-all true|false\n"
26703 #: ../fish/guestfish-actions.pod:4728
26708 #: ../fish/guestfish-actions.pod:4730
26711 " vgcreate volgroup 'physvols ...'\n"
26716 #: ../fish/guestfish-actions.pod:4735
26721 #: ../fish/guestfish-actions.pod:4737
26724 " vglvuuids vgname\n"
26729 #: ../fish/guestfish-actions.pod:4742
26731 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26732 "logical volumes and volume groups."
26736 #: ../fish/guestfish-actions.pod:4745
26737 msgid "See also L</vgpvuuids>."
26741 #: ../fish/guestfish-actions.pod:4747
26746 #: ../fish/guestfish-actions.pod:4749
26749 " vgpvuuids vgname\n"
26754 #: ../fish/guestfish-actions.pod:4754
26756 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
26757 "physical volumes and volume groups."
26761 #: ../fish/guestfish-actions.pod:4757
26762 msgid "See also L</vglvuuids>."
26766 #: ../fish/guestfish-actions.pod:4759
26771 #: ../fish/guestfish-actions.pod:4761
26774 " vgremove vgname\n"
26779 #: ../fish/guestfish-actions.pod:4768
26784 #: ../fish/guestfish-actions.pod:4770
26787 " vgrename volgroup newvolgroup\n"
26792 #: ../fish/guestfish-actions.pod:4774
26797 #: ../fish/guestfish-actions.pod:4776
26805 #: ../fish/guestfish-actions.pod:4784
26806 msgid "See also L</vgs-full>."
26810 #: ../fish/guestfish-actions.pod:4786
26815 #: ../fish/guestfish-actions.pod:4788
26823 #: ../fish/guestfish-actions.pod:4793
26828 #: ../fish/guestfish-actions.pod:4795
26836 #: ../fish/guestfish-actions.pod:4800
26841 #: ../fish/guestfish-actions.pod:4802
26849 #: ../fish/guestfish-actions.pod:4806
26854 #: ../fish/guestfish-actions.pod:4808
26862 #: ../fish/guestfish-actions.pod:4813
26867 #: ../fish/guestfish-actions.pod:4815
26875 #: ../fish/guestfish-actions.pod:4820
26880 #: ../fish/guestfish-actions.pod:4822
26888 #: ../fish/guestfish-actions.pod:4827
26893 #: ../fish/guestfish-actions.pod:4829
26896 " write path content\n"
26901 #: ../fish/guestfish-actions.pod:4837
26906 #: ../fish/guestfish-actions.pod:4839
26909 " write-file path content size\n"
26914 #: ../fish/guestfish-actions.pod:4862
26919 #: ../fish/guestfish-actions.pod:4864
26922 " zegrep regex path\n"
26927 #: ../fish/guestfish-actions.pod:4872
26932 #: ../fish/guestfish-actions.pod:4874
26935 " zegrepi regex path\n"
26940 #: ../fish/guestfish-actions.pod:4882
26945 #: ../fish/guestfish-actions.pod:4884
26953 #: ../fish/guestfish-actions.pod:4892
26954 msgid "See also: L</zero-device>, L</scrub-device>."
26958 #: ../fish/guestfish-actions.pod:4894
26959 msgid "zero-device"
26963 #: ../fish/guestfish-actions.pod:4896
26966 " zero-device device\n"
26971 #: ../fish/guestfish-actions.pod:4898
26973 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
26974 "which just zeroes the first few blocks of a device."
26978 #: ../fish/guestfish-actions.pod:4905
26983 #: ../fish/guestfish-actions.pod:4907
26986 " zerofree device\n"
26991 #: ../fish/guestfish-actions.pod:4920
26996 #: ../fish/guestfish-actions.pod:4922
26999 " zfgrep pattern path\n"
27004 #: ../fish/guestfish-actions.pod:4930
27009 #: ../fish/guestfish-actions.pod:4932
27012 " zfgrepi pattern path\n"
27017 #: ../fish/guestfish-actions.pod:4940
27022 #: ../fish/guestfish-actions.pod:4942
27025 " zfile meth path\n"
27030 #: ../fish/guestfish-actions.pod:4949
27031 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27035 #: ../fish/guestfish-actions.pod:4959
27040 #: ../fish/guestfish-actions.pod:4961
27043 " zgrep regex path\n"
27048 #: ../fish/guestfish-actions.pod:4969
27053 #: ../fish/guestfish-actions.pod:4971
27056 " zgrepi regex path\n"
27061 #: ../fish/guestfish-commands.pod:1
27066 #: ../fish/guestfish-commands.pod:3
27071 #: ../fish/guestfish-commands.pod:5
27074 " alloc filename size\n"
27079 #: ../fish/guestfish-commands.pod:7
27081 "This creates an empty (zeroed) file of the given size, and then adds so it "
27082 "can be further examined."
27086 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27087 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27091 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27092 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27096 #: ../fish/guestfish-commands.pod:14
27098 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27099 "image, see L</PREPARED DISK IMAGES>."
27103 #: ../fish/guestfish-commands.pod:17
27108 #: ../fish/guestfish-commands.pod:19
27111 " copy-in local [local ...] /remotedir\n"
27116 #: ../fish/guestfish-commands.pod:21
27118 "C<copy-in> copies local files or directories recursively into the disk "
27119 "image, placing them in the directory called C</remotedir> (which must "
27120 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27121 "other commands as necessary."
27125 #: ../fish/guestfish-commands.pod:26
27127 "Multiple local files and directories can be specified, but the last "
27128 "parameter must always be a remote directory. Wildcards cannot be used."
27132 #: ../fish/guestfish-commands.pod:30
27137 #: ../fish/guestfish-commands.pod:32
27140 " copy-out remote [remote ...] localdir\n"
27145 #: ../fish/guestfish-commands.pod:34
27147 "C<copy-out> copies remote files or directories recursively out of the disk "
27148 "image, placing them on the host disk in a local directory called C<localdir> "
27149 "(which must exist). This guestfish meta-command turns into a sequence of "
27150 "L</download>, L</tar-out> and other commands as necessary."
27154 #: ../fish/guestfish-commands.pod:40
27156 "Multiple remote files and directories can be specified, but the last "
27157 "parameter must always be a local directory. To download to the current "
27158 "directory, use C<.> as in:"
27162 #: ../fish/guestfish-commands.pod:44
27165 " copy-out /home .\n"
27170 #: ../fish/guestfish-commands.pod:46
27172 "Wildcards cannot be used in the ordinary command, but you can use them with "
27173 "the help of L</glob> like this:"
27177 #: ../fish/guestfish-commands.pod:49
27180 " glob copy-out /home/* .\n"
27185 #: ../fish/guestfish-commands.pod:51
27190 #: ../fish/guestfish-commands.pod:53
27193 " echo [params ...]\n"
27198 #: ../fish/guestfish-commands.pod:55
27199 msgid "This echos the parameters to the terminal."
27203 #: ../fish/guestfish-commands.pod:57
27208 #: ../fish/guestfish-commands.pod:59
27213 #: ../fish/guestfish-commands.pod:61
27218 #: ../fish/guestfish-commands.pod:63
27226 #: ../fish/guestfish-commands.pod:65
27228 "This is used to edit a file. It downloads the file, edits it locally using "
27229 "your editor, then uploads the result."
27233 #: ../fish/guestfish-commands.pod:68
27235 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27236 "or C<emacs> you will get those corresponding editors."
27240 #: ../fish/guestfish-commands.pod:72
27245 #: ../fish/guestfish-commands.pod:74
27248 " glob command args...\n"
27253 #: ../fish/guestfish-commands.pod:76
27255 "Expand wildcards in any paths in the args list, and run C<command> "
27256 "repeatedly on each matching path."
27260 #: ../fish/guestfish-commands.pod:79
27261 msgid "See L</WILDCARDS AND GLOBBING>."
27265 #: ../fish/guestfish-commands.pod:81
27270 #: ../fish/guestfish-commands.pod:83
27273 " hexedit <filename|device>\n"
27274 " hexedit <filename|device> <max>\n"
27275 " hexedit <filename|device> <start> <max>\n"
27280 #: ../fish/guestfish-commands.pod:87
27282 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27287 #: ../fish/guestfish-commands.pod:90
27289 "This command works by downloading potentially the whole file or device, "
27290 "editing it locally, then uploading it. If the file or device is large, you "
27291 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27292 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27293 "usual modifiers allowed such as C<1M> (1 megabyte)."
27297 #: ../fish/guestfish-commands.pod:97
27298 msgid "For example to edit the first few sectors of a disk you might do:"
27302 #: ../fish/guestfish-commands.pod:100
27305 " hexedit /dev/sda 1M\n"
27310 #: ../fish/guestfish-commands.pod:102
27312 "which would allow you to edit anywhere within the first megabyte of the "
27317 #: ../fish/guestfish-commands.pod:105
27318 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27322 #: ../fish/guestfish-commands.pod:107
27325 " hexedit /dev/sda1 0x400 0x400\n"
27330 #: ../fish/guestfish-commands.pod:109
27331 msgid "(assuming the superblock is in the standard location)."
27335 #: ../fish/guestfish-commands.pod:111
27337 "This command requires the external L<hexedit(1)> program. You can specify "
27338 "another program to use by setting the C<HEXEDITOR> environment variable."
27342 #: ../fish/guestfish-commands.pod:115
27343 msgid "See also L</hexdump>."
27347 #: ../fish/guestfish-commands.pod:117
27352 #: ../fish/guestfish-commands.pod:119
27360 #: ../fish/guestfish-commands.pod:121
27361 msgid "Change the local directory, ie. the current directory of guestfish itself."
27365 #: ../fish/guestfish-commands.pod:124
27366 msgid "Note that C<!cd> won't do what you might expect."
27370 #: ../fish/guestfish-commands.pod:126
27375 #: ../fish/guestfish-commands.pod:128
27380 #: ../fish/guestfish-commands.pod:130
27388 #: ../fish/guestfish-commands.pod:132
27389 msgid "Opens the manual page for guestfish."
27393 #: ../fish/guestfish-commands.pod:134
27398 #: ../fish/guestfish-commands.pod:136
27403 #: ../fish/guestfish-commands.pod:138
27411 #: ../fish/guestfish-commands.pod:140
27419 #: ../fish/guestfish-commands.pod:142
27420 msgid "This is used to view a file."
27424 #: ../fish/guestfish-commands.pod:144
27426 "The default viewer is C<$PAGER>. However if you use the alternate command "
27427 "C<less> you will get the C<less> command specifically."
27431 #: ../fish/guestfish-commands.pod:147
27436 #: ../fish/guestfish-commands.pod:149
27444 #: ../fish/guestfish-commands.pod:151
27446 "Close and reopen the libguestfs handle. It is not necessary to use this "
27447 "normally, because the handle is closed properly when guestfish exits. "
27448 "However this is occasionally useful for testing."
27452 #: ../fish/guestfish-commands.pod:155
27457 #: ../fish/guestfish-commands.pod:157
27460 " sparse filename size\n"
27465 #: ../fish/guestfish-commands.pod:159
27467 "This creates an empty sparse file of the given size, and then adds so it can "
27468 "be further examined."
27472 #: ../fish/guestfish-commands.pod:162
27474 "In all respects it works the same as the L</alloc> command, except that the "
27475 "image file is allocated sparsely, which means that disk blocks are not "
27476 "assigned to the file until they are needed. Sparse disk files only use "
27477 "space when written to, but they are slower and there is a danger you could "
27478 "run out of real disk space during a write operation."
27482 #: ../fish/guestfish-commands.pod:172
27487 #: ../fish/guestfish-commands.pod:174
27495 #: ../fish/guestfish-commands.pod:176
27497 "This command returns a list of the optional groups known to the daemon, and "
27498 "indicates which ones are supported by this build of the libguestfs "
27503 #: ../fish/guestfish-commands.pod:180
27504 msgid "See also L<guestfs(3)/AVAILABILITY>."
27508 #: ../fish/guestfish-commands.pod:182
27513 #: ../fish/guestfish-commands.pod:184
27516 " time command args...\n"
27521 #: ../fish/guestfish-commands.pod:186
27523 "Run the command as usual, but print the elapsed time afterwards. This can "
27524 "be useful for benchmarking operations."
27528 #: ../test-tool/libguestfs-test-tool.pod:5
27529 msgid "libguestfs-test-tool - End user tests for libguestfs"
27533 #: ../test-tool/libguestfs-test-tool.pod:9
27536 " libguestfs-test-tool [--options]\n"
27541 #: ../test-tool/libguestfs-test-tool.pod:13
27543 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27544 "and developers, to allow them to check basic libguestfs functionality is "
27545 "working. This is needed because libguestfs occasionally breaks for reasons "
27546 "beyond our control: usually because of changes in the underlying qemu or "
27547 "kernel packages, or the host environment."
27551 #: ../test-tool/libguestfs-test-tool.pod:20
27552 msgid "If you suspect a problem in libguestfs, then just run:"
27556 #: ../test-tool/libguestfs-test-tool.pod:22
27559 " libguestfs-test-tool\n"
27564 #: ../test-tool/libguestfs-test-tool.pod:24
27565 msgid "It will print lots of diagnostic messages."
27569 #: ../test-tool/libguestfs-test-tool.pod:26
27570 msgid "If it runs to completion successfully, you will see this near the end:"
27574 #: ../test-tool/libguestfs-test-tool.pod:28
27577 " ===== TEST FINISHED OK =====\n"
27582 #: ../test-tool/libguestfs-test-tool.pod:30
27583 msgid "and the test tool will exit with code 0."
27587 #: ../test-tool/libguestfs-test-tool.pod:32
27589 "If it fails (and/or exits with non-zero error code), please paste the "
27590 "B<complete, unedited> output of the test tool into a bug report. More "
27591 "information about reporting bugs can be found on the "
27592 "L<http://libguestfs.org/> website."
27596 #: ../test-tool/libguestfs-test-tool.pod:41
27601 #: ../test-tool/libguestfs-test-tool.pod:43
27602 msgid "Display short usage information and exit."
27606 #: ../test-tool/libguestfs-test-tool.pod:45
27607 msgid "I<--qemu qemu_binary>"
27611 #: ../test-tool/libguestfs-test-tool.pod:47
27613 "If you have downloaded another qemu binary, point this option at the full "
27614 "path of the binary to try it."
27618 #: ../test-tool/libguestfs-test-tool.pod:50
27619 msgid "I<--qemudir qemu_source_dir>"
27623 #: ../test-tool/libguestfs-test-tool.pod:52
27625 "If you have compiled qemu from source, point this option at the source "
27626 "directory to try it."
27630 #: ../test-tool/libguestfs-test-tool.pod:55
27631 msgid "I<--timeout N>"
27635 #: ../test-tool/libguestfs-test-tool.pod:57
27637 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27638 "does not usually need to be adjusted unless your machine is very slow."
27642 #: ../test-tool/libguestfs-test-tool.pod:63
27643 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27647 #: ../test-tool/libguestfs-test-tool.pod:65
27649 "If you have compiled another version of qemu from source and would like to "
27650 "try that, then you can use the I<--qemudir> option to point to the qemu "
27651 "source directory."
27655 #: ../test-tool/libguestfs-test-tool.pod:69
27657 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27658 "option to point to the binary."
27662 #: ../test-tool/libguestfs-test-tool.pod:72
27664 "When using an alternate qemu with libguestfs, usually you would need to "
27665 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27666 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27667 "when you use either of the I<--qemudir> or I<--qemu> options."
27671 #: ../test-tool/libguestfs-test-tool.pod:79
27673 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27674 "I<1> if there was an error."
27678 #: ../test-tool/libguestfs-test-tool.pod:84
27680 "For the full list of environment variables which may affect libguestfs, "
27681 "please see the L<guestfs(3)> manual page."
27685 #: ../test-tool/libguestfs-test-tool.pod:89
27686 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27690 #: ../fuse/guestmount.pod:5
27691 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27695 #: ../fuse/guestmount.pod:9
27698 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27703 #: ../fuse/guestmount.pod:11
27706 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27711 #: ../fuse/guestmount.pod:13
27714 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27719 #: ../fuse/guestmount.pod:17
27721 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27722 "machines. If you do this, you risk disk corruption in the VM."
27726 #: ../fuse/guestmount.pod:22
27728 "The guestmount program can be used to mount virtual machine filesystems and "
27729 "other disk images on the host. It uses libguestfs for access to the guest "
27730 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27731 "a mountable device."
27735 #: ../fuse/guestmount.pod:27
27737 "Along with other options, you have to give at least one device (I<-a> "
27738 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27739 "option) or use the I<-i> inspection option. How this works is better "
27740 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27745 #: ../fuse/guestmount.pod:33
27747 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27748 "by you, and the filesystem will not be visible to any other users unless you "
27749 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27750 "the filesystem, use the C<fusermount -u> command."
27754 #: ../fuse/guestmount.pod:41
27756 "For a typical Windows guest which has its main filesystem on the first "
27761 #: ../fuse/guestmount.pod:44
27764 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
27769 #: ../fuse/guestmount.pod:46
27771 "For a typical Linux guest which has a /boot filesystem on the first "
27772 "partition, and the root filesystem on a logical volume:"
27776 #: ../fuse/guestmount.pod:49
27779 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
27784 #: ../fuse/guestmount.pod:51
27785 msgid "To get libguestfs to detect guest mountpoints for you:"
27789 #: ../fuse/guestmount.pod:53
27792 " guestmount -a guest.img -i --ro /mnt\n"
27797 #: ../fuse/guestmount.pod:55
27798 msgid "For a libvirt guest called \"Guest\" you could do:"
27802 #: ../fuse/guestmount.pod:57
27805 " guestmount -d Guest -i --ro /mnt\n"
27810 #: ../fuse/guestmount.pod:59
27812 "If you don't know what filesystems are contained in a guest or disk image, "
27813 "use L<virt-filesystems(1)> first:"
27817 #: ../fuse/guestmount.pod:62
27820 " virt-filesystems MyGuest\n"
27825 #: ../fuse/guestmount.pod:64
27827 "If you want to trace the libguestfs calls but without excessive debugging "
27828 "information, we recommend:"
27832 #: ../fuse/guestmount.pod:67
27835 " guestmount [...] --trace /mnt\n"
27840 #: ../fuse/guestmount.pod:69
27841 msgid "If you want to debug the program, we recommend:"
27845 #: ../fuse/guestmount.pod:71
27848 " guestmount [...] --trace --verbose /mnt\n"
27853 #: ../fuse/guestmount.pod:77
27854 msgid "B<-a image> | B<--add image>"
27858 #: ../fuse/guestmount.pod:79
27859 msgid "Add a block device or virtual machine image."
27863 #: ../fuse/guestmount.pod:84
27864 msgid "B<-c URI> | B<--connect URI>"
27868 #: ../fuse/guestmount.pod:90
27869 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
27873 #: ../fuse/guestmount.pod:96
27874 msgid "B<--dir-cache-timeout N>"
27878 #: ../fuse/guestmount.pod:98
27880 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
27881 "seconds. The readdir cache [actually, there are several semi-independent "
27882 "caches] is populated after a readdir(2) call with the stat and extended "
27883 "attributes of the files in the directory, in anticipation that they will be "
27884 "requested soon after."
27888 #: ../fuse/guestmount.pod:104
27890 "There is also a different attribute cache implemented by FUSE (see the FUSE "
27891 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
27892 "requests, only cache existing ones."
27896 #: ../fuse/guestmount.pod:115
27897 msgid "B<--format=raw|qcow2|..> | B<--format>"
27901 #: ../fuse/guestmount.pod:122
27903 "If you have untrusted raw-format guest disk images, you should use this "
27904 "option to specify the disk format. This avoids a possible security problem "
27905 "with malicious guests (CVE-2010-3851). See also "
27906 "L<guestfs(3)/guestfs_add_drive_opts>."
27910 #: ../fuse/guestmount.pod:127
27911 msgid "B<--fuse-help>"
27915 #: ../fuse/guestmount.pod:129
27916 msgid "Display help on special FUSE options (see I<-o> below)."
27920 #: ../fuse/guestmount.pod:133
27921 msgid "Display brief help and exit."
27925 #: ../fuse/guestmount.pod:135
27926 msgid "B<-i> | B<--inspector>"
27930 #: ../fuse/guestmount.pod:155
27932 "Mount the named partition or logical volume on the given mountpoint B<in the "
27933 "guest> (this has nothing to do with mountpoints in the host)."
27937 #: ../fuse/guestmount.pod:158
27939 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
27940 "something on C</>."
27944 #: ../fuse/guestmount.pod:171
27945 msgid "B<-n> | B<--no-sync>"
27949 #: ../fuse/guestmount.pod:173
27951 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
27952 "unmounted. If you specify this option, then we don't attempt to sync the "
27953 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
27957 #: ../fuse/guestmount.pod:178
27958 msgid "B<-o option> | B<--option option>"
27962 #: ../fuse/guestmount.pod:180
27963 msgid "Pass extra options to FUSE."
27967 #: ../fuse/guestmount.pod:182
27969 "To get a list of all the extra options supported by FUSE, use the command "
27970 "below. Note that only the FUSE I<-o> options can be passed, and only some "
27971 "of them are a good idea."
27975 #: ../fuse/guestmount.pod:186
27978 " guestmount --fuse-help\n"
27983 #: ../fuse/guestmount.pod:188
27984 msgid "Some potentially useful FUSE options:"
27988 #: ../fuse/guestmount.pod:192
27989 msgid "B<-o allow_other>"
27993 #: ../fuse/guestmount.pod:194
27994 msgid "Allow other users to see the filesystem."
27998 #: ../fuse/guestmount.pod:196
27999 msgid "B<-o attr_timeout=N>"
28003 #: ../fuse/guestmount.pod:198
28004 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28008 #: ../fuse/guestmount.pod:200
28009 msgid "B<-o kernel_cache>"
28013 #: ../fuse/guestmount.pod:202
28015 "Allow the kernel to cache files (reduces the number of reads that have to go "
28016 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28017 "afford the extra memory usage."
28021 #: ../fuse/guestmount.pod:206
28022 msgid "B<-o uid=N> B<-o gid=N>"
28026 #: ../fuse/guestmount.pod:208
28028 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28029 "the chosen values."
28033 #: ../fuse/guestmount.pod:213
28034 msgid "B<-r> | B<--ro>"
28038 #: ../fuse/guestmount.pod:215
28040 "Add devices and mount everything read-only. Also disallow writes and make "
28041 "the disk appear read-only to FUSE."
28045 #: ../fuse/guestmount.pod:218
28047 "This is highly recommended if you are not going to edit the guest disk. If "
28048 "the guest is running and this option is I<not> supplied, then there is a "
28049 "strong risk of disk corruption in the guest. We try to prevent this from "
28050 "happening, but it is not always possible."
28054 #: ../fuse/guestmount.pod:223
28055 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28059 #: ../fuse/guestmount.pod:227
28060 msgid "Enable SELinux support for the guest."
28064 #: ../fuse/guestmount.pod:229
28065 msgid "B<-v> | B<--verbose>"
28069 #: ../fuse/guestmount.pod:231
28070 msgid "Enable verbose messages from underlying libguestfs."
28074 #: ../fuse/guestmount.pod:233
28075 msgid "B<-V> | B<--version>"
28079 #: ../fuse/guestmount.pod:235
28080 msgid "Display the program version and exit."
28084 #: ../fuse/guestmount.pod:237
28085 msgid "B<-w> | B<--rw>"
28089 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28090 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28094 #: ../fuse/guestmount.pod:244
28095 msgid "B<-x> | B<--trace>"
28099 #: ../fuse/guestmount.pod:246
28100 msgid "Trace libguestfs calls and entry into each FUSE function."
28104 #: ../fuse/guestmount.pod:248
28105 msgid "This also stops the daemon from forking into the background."
28109 #: ../fuse/guestmount.pod:269
28111 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28112 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28113 "L<http://fuse.sf.net/>."
28117 #: ../fuse/guestmount.pod:284
28118 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28122 #: ../tools/virt-edit.pl:34
28123 msgid "virt-edit - Edit a file in a virtual machine"
28127 #: ../tools/virt-edit.pl:38
28130 " virt-edit [--options] domname file\n"
28135 #: ../tools/virt-edit.pl:40
28138 " virt-edit [--options] disk.img [disk.img ...] file\n"
28143 #: ../tools/virt-edit.pl:42
28146 " virt-edit [domname|disk.img] file -e 'expr'\n"
28151 #: ../tools/virt-edit.pl:46
28153 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28154 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28155 "doing this, but doesn't catch all cases."
28159 #: ../tools/virt-edit.pl:52
28161 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28162 "the named virtual machine (or disk image)."
28166 #: ../tools/virt-edit.pl:55
28167 msgid "If you want to just view a file, use L<virt-cat(1)>."
28171 #: ../tools/virt-edit.pl:57
28173 "For more complex cases you should look at the L<guestfish(1)> tool (see "
28174 "L</USING GUESTFISH> below)."
28178 #: ../tools/virt-edit.pl:60
28180 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28181 "files. L<guestfish(1)> can do that and much more."
28185 #: ../tools/virt-edit.pl:65
28186 msgid "Edit the named files interactively:"
28190 #: ../tools/virt-edit.pl:67
28193 " virt-edit mydomain /boot/grub/grub.conf\n"
28198 #: ../tools/virt-edit.pl:69
28201 " virt-edit mydomain /etc/passwd\n"
28206 #: ../tools/virt-edit.pl:71
28207 msgid "For Windows guests, some Windows paths are understood:"
28211 #: ../tools/virt-edit.pl:73
28214 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28219 #: ../tools/virt-edit.pl:75
28221 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28222 "below). To change the init default level to 5:"
28226 #: ../tools/virt-edit.pl:79
28229 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28234 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28235 msgid "Display brief help."
28239 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28240 msgid "Display version number and exit."
28244 #: ../tools/virt-edit.pl:105
28245 msgid "B<--backup extension> | B<-b extension>"
28249 #: ../tools/virt-edit.pl:107
28251 "Create a backup of the original file I<in the guest disk image>. The backup "
28252 "has the original filename with C<extension> added."
28256 #: ../tools/virt-edit.pl:110
28258 "Usually the first character of C<extension> would be a dot C<.> so you would "
28263 #: ../tools/virt-edit.pl:113
28266 " virt-edit -b .orig [etc]\n"
28271 #: ../tools/virt-edit.pl:115
28272 msgid "By default, no backup file is made."
28276 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28277 msgid "B<--connect URI> | B<-c URI>"
28281 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28283 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28284 "to the default libvirt hypervisor."
28288 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28290 "If you specify guest block devices directly, then libvirt is not used at "
28295 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28296 msgid "B<--format> raw"
28300 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28302 "Specify the format of disk images given on the command line. If this is "
28303 "omitted then the format is autodetected from the content of the disk image."
28307 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28309 "If disk images are requested from libvirt, then this program asks libvirt "
28310 "for this information. In this case, the value of the format parameter is "
28315 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
28317 "If working with untrusted raw-format guest disk images, you should ensure "
28318 "the format is always specified."
28322 #: ../tools/virt-edit.pl:150
28323 msgid "B<--expr EXPR> | B<-e EXPR>"
28327 #: ../tools/virt-edit.pl:152
28329 "Instead of launching the external editor, non-interactively apply the Perl "
28330 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28335 #: ../tools/virt-edit.pl:156
28337 "Be careful to properly quote the expression to prevent it from being altered "
28342 #: ../tools/virt-edit.pl:280
28343 msgid "NON-INTERACTIVE EDITING"
28347 #: ../tools/virt-edit.pl:282
28349 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28350 "administrator can interactively edit the file."
28354 #: ../tools/virt-edit.pl:285
28356 "There are two ways also to use C<virt-edit> from scripts in order to make "
28357 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28358 "like this, it's less error-prone to write scripts directly using the "
28359 "libguestfs API and Augeas for configuration file editing.)"
28363 #: ../tools/virt-edit.pl:291
28365 "The first method is to temporarily set C<$EDITOR> to any script or program "
28366 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28367 "update C<tmpfile> in place however it likes."
28371 #: ../tools/virt-edit.pl:295
28373 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28374 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28375 "instances of C<foo> with C<bar> in a file:"
28379 #: ../tools/virt-edit.pl:299
28382 " virt-edit domname filename -e 's/foo/bar/'\n"
28387 #: ../tools/virt-edit.pl:301
28389 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28390 "For example to delete root's password you could do:"
28394 #: ../tools/virt-edit.pl:304
28397 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28402 #: ../tools/virt-edit.pl:306
28404 "What really happens is that the snippet is evaluated as a Perl expression "
28405 "for each line of the file. The line, including the final C<\\n>, is passed "
28406 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28410 #: ../tools/virt-edit.pl:311
28412 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28413 "C<apache> user account from the password file you can do:"
28417 #: ../tools/virt-edit.pl:314
28420 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28425 #: ../tools/virt-edit.pl:316
28427 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28428 "the end of the file is rather difficult this way since there is no concept "
28429 "of \"last line of the file\" - your expression just doesn't get called "
28430 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28435 #: ../tools/virt-edit.pl:322
28437 "The variable C<$lineno> contains the current line number. As is "
28438 "traditional, the first line in the file is number C<1>."
28442 #: ../tools/virt-edit.pl:325
28444 "The return value from the expression is ignored, but the expression may call "
28445 "C<die> in order to abort the whole program, leaving the original file "
28450 #: ../tools/virt-edit.pl:329
28452 "Remember when matching the end of a line that C<$_> may contain the final "
28453 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28454 "newline then neither of these. Thus to match or substitute some text at the "
28455 "end of a line, use this regular expression:"
28459 #: ../tools/virt-edit.pl:334
28462 " /some text(\\r?\\n)?$/\n"
28467 #: ../tools/virt-edit.pl:336
28469 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28470 "C<$_> itself (since that would remove all newlines from the file):"
28474 #: ../tools/virt-edit.pl:340
28477 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28482 #: ../tools/virt-edit.pl:344
28484 "C<virt-edit> has a limited ability to understand Windows drive letters and "
28485 "paths (eg. C<E:\\foo\\bar.txt>)."
28489 #: ../tools/virt-edit.pl:347
28490 msgid "If and only if the guest is running Windows then:"
28494 #: ../tools/virt-edit.pl:353
28496 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
28497 "to the correct filesystem."
28501 #: ../tools/virt-edit.pl:358
28503 "Any backslash (C<\\>) characters in the path are replaced with forward "
28504 "slashes so that libguestfs can process it."
28508 #: ../tools/virt-edit.pl:363
28510 "The path is resolved case insensitively to locate the file that should be "
28515 #: ../tools/virt-edit.pl:368
28516 msgid "There are some known shortcomings:"
28520 #: ../tools/virt-edit.pl:374
28521 msgid "Some NTFS symbolic links may not be followed correctly."
28525 #: ../tools/virt-edit.pl:378
28526 msgid "NTFS junction points that cross filesystems are not followed."
28530 #: ../tools/virt-edit.pl:435
28531 msgid "USING GUESTFISH"
28535 #: ../tools/virt-edit.pl:437
28537 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
28538 "C<virt-edit> doesn't work."
28542 #: ../tools/virt-edit.pl:440
28543 msgid "Using C<virt-edit> is approximately equivalent to doing:"
28547 #: ../tools/virt-edit.pl:442
28550 " guestfish --rw -i -d domname edit /file\n"
28555 #: ../tools/virt-edit.pl:444
28557 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
28558 "path to the file."
28562 #: ../tools/virt-edit.pl:447
28564 "The command above uses libguestfs's guest inspection feature and so does not "
28565 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
28566 "disk images that don't contain guests. To edit a file on a disk image "
28571 #: ../tools/virt-edit.pl:452
28574 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
28579 #: ../tools/virt-edit.pl:454
28581 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
28582 "the disk image to edit, and C</file> is the full path to the file."
28586 #: ../tools/virt-edit.pl:458
28588 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
28589 "C<write> or C<upload> instead:"
28593 #: ../tools/virt-edit.pl:461
28596 " guestfish --rw -i -d domname touch /newfile\n"
28601 #: ../tools/virt-edit.pl:463
28604 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
28609 #: ../tools/virt-edit.pl:465
28612 " guestfish --rw -i -d domname upload localfile /newfile\n"
28617 #: ../tools/virt-edit.pl:467
28618 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
28622 #: ../tools/virt-edit.pl:470
28625 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
28630 #: ../tools/virt-edit.pl:480
28635 #: ../tools/virt-edit.pl:482
28637 "If set, this string is used as the editor. It may contain arguments, "
28638 "eg. C<\"emacs -nw\">"
28642 #: ../tools/virt-edit.pl:485
28643 msgid "If not set, C<vi> is used."
28647 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
28648 msgid "SHELL QUOTING"
28652 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
28654 "Libvirt guest names can contain arbitrary characters, some of which have "
28655 "meaning to the shell such as C<#> and space. You may need to quote or "
28656 "escape these characters on the command line. See the shell manual page "
28657 "L<sh(1)> for details."
28661 #: ../tools/virt-edit.pl:498
28663 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
28664 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28665 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
28669 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
28674 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
28675 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
28679 #: ../tools/virt-edit.pl:516
28680 msgid "Copyright (C) 2009-2011 Red Hat Inc."
28684 #: ../tools/virt-win-reg.pl:37
28686 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28691 #: ../tools/virt-win-reg.pl:41
28694 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28699 #: ../tools/virt-win-reg.pl:43
28702 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28707 #: ../tools/virt-win-reg.pl:45
28710 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28715 #: ../tools/virt-win-reg.pl:47
28718 " virt-win-reg --merge domname [input.reg ...]\n"
28723 #: ../tools/virt-win-reg.pl:49
28726 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28731 #: ../tools/virt-win-reg.pl:53
28733 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
28734 "virtual machines. If you do this, you I<will> get irreversible disk "
28735 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28736 "but doesn't catch all cases."
28740 #: ../tools/virt-win-reg.pl:58
28742 "Modifying the Windows Registry is an inherently risky operation. The format "
28743 "is deliberately obscure and undocumented, and Registry changes can leave the "
28744 "system unbootable. Therefore when using the C<--merge> option, make sure "
28745 "you have a reliable backup first."
28749 #: ../tools/virt-win-reg.pl:65
28751 "This program can export and merge Windows Registry entries from a Windows "
28756 #: ../tools/virt-win-reg.pl:68
28758 "The first parameter is the libvirt guest name or the raw disk image of a "
28763 #: ../tools/virt-win-reg.pl:71
28765 "If C<--merge> is I<not> specified, then the chosen registry key is "
28766 "displayed/exported (recursively). For example:"
28770 #: ../tools/virt-win-reg.pl:74
28773 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28778 #: ../tools/virt-win-reg.pl:76
28779 msgid "You can also display single values from within registry keys, for example:"
28783 #: ../tools/virt-win-reg.pl:79
28786 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28787 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28788 " Windows 7 Enterprise\n"
28793 #: ../tools/virt-win-reg.pl:83
28795 "With C<--merge>, you can merge a textual regedit file into the Windows "
28800 #: ../tools/virt-win-reg.pl:86
28803 " $ virt-win-reg --merge Windows7 changes.reg\n"
28808 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28813 #: ../tools/virt-win-reg.pl:90
28815 "This program is only meant for simple access to the registry. If you want "
28816 "to do complicated things with the registry, we suggest you download the "
28817 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28818 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28819 "L<hivexregedit(1)>."
28823 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28828 #: ../tools/virt-win-reg.pl:122
28829 msgid "Enable debugging messages."
28833 #: ../tools/virt-win-reg.pl:157
28838 #: ../tools/virt-win-reg.pl:159
28840 "In merge mode, this merges a textual regedit file into the Windows Registry "
28841 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
28842 "displays or exports Registry entries instead."
28846 #: ../tools/virt-win-reg.pl:163
28848 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
28849 "result in disk corruption. However exporting (without this flag) is always "
28854 #: ../tools/virt-win-reg.pl:171
28855 msgid "B<--encoding> UTF-16LE|ASCII"
28859 #: ../tools/virt-win-reg.pl:173
28861 "When merging (only), you may need to specify the encoding for strings to be "
28862 "used in the hive file. This is explained in detail in "
28863 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
28867 #: ../tools/virt-win-reg.pl:177
28869 "The default is to use UTF-16LE, which should work with recent versions of "
28874 #: ../tools/virt-win-reg.pl:402
28875 msgid "SUPPORTED SYSTEMS"
28879 #: ../tools/virt-win-reg.pl:404
28881 "The program currently supports Windows NT-derived guests starting with "
28882 "Windows XP through to at least Windows 7."
28886 #: ../tools/virt-win-reg.pl:407
28888 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
28889 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
28890 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
28894 #: ../tools/virt-win-reg.pl:411
28896 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28901 #: ../tools/virt-win-reg.pl:414
28903 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
28908 #: ../tools/virt-win-reg.pl:417
28913 #: ../tools/virt-win-reg.pl:419
28915 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28916 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28917 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28918 "with Windows-style line endings, you may need to reencode the whole file "
28919 "before or after processing."
28923 #: ../tools/virt-win-reg.pl:425
28925 "To reencode a file from Windows format to Linux (before processing it with "
28926 "the C<--merge> option), you would do something like this:"
28930 #: ../tools/virt-win-reg.pl:428
28933 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28938 #: ../tools/virt-win-reg.pl:430
28940 "To go in the opposite direction, after exporting and before sending the file "
28941 "to a Windows user, do something like this:"
28945 #: ../tools/virt-win-reg.pl:433
28948 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28953 #: ../tools/virt-win-reg.pl:435
28954 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28958 #: ../tools/virt-win-reg.pl:437
28960 "If you are unsure about the current encoding, use the L<file(1)> command. "
28961 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28962 "Windows-style (CRLF) line endings, like this:"
28966 #: ../tools/virt-win-reg.pl:441
28969 " $ file software.reg\n"
28970 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
28971 " with CRLF line terminators\n"
28976 #: ../tools/virt-win-reg.pl:445
28977 msgid "This file would need conversion before you could C<--merge> it."
28981 #: ../tools/virt-win-reg.pl:447
28982 msgid "CurrentControlSet etc."
28986 #: ../tools/virt-win-reg.pl:449
28988 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
28989 "Registry at the level of the hive file, and therefore you cannot modify "
28994 #: ../tools/virt-win-reg.pl:453
28996 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
28997 "circumstances it might refer to another control set. The way to find out is "
28998 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29002 #: ../tools/virt-win-reg.pl:457
29005 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29006 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29007 " \"Current\"=dword:00000001\n"
29008 " \"Default\"=dword:00000001\n"
29009 " \"Failed\"=dword:00000000\n"
29010 " \"LastKnownGood\"=dword:00000002\n"
29015 #: ../tools/virt-win-reg.pl:464
29016 msgid "\"Current\" is the one which Windows will choose when it boots."
29020 #: ../tools/virt-win-reg.pl:466
29021 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29025 #: ../tools/virt-win-reg.pl:469
29026 msgid "WINDOWS TIPS"
29030 #: ../tools/virt-win-reg.pl:471
29032 "Note that some of these tips modify the guest disk image. The guest I<must> "
29033 "be shut off, else you will get disk corruption."
29037 #: ../tools/virt-win-reg.pl:474
29038 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29042 #: ../tools/virt-win-reg.pl:476
29044 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29045 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29046 "is uploaded into C<C:\\>:"
29050 #: ../tools/virt-win-reg.pl:480
29053 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29058 #: ../tools/virt-win-reg.pl:482
29059 msgid "Prepare a regedit file containing the registry change:"
29063 #: ../tools/virt-win-reg.pl:484
29066 " cat > test.reg <<'EOF'\n"
29067 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29068 " \"Test\"=\"c:\\\\test.bat\"\n"
29074 #: ../tools/virt-win-reg.pl:489
29076 "In this example we use the key C<RunOnce> which means that the script will "
29077 "run precisely once when the first user logs in. If you want it to run every "
29078 "time a user logs in, replace C<RunOnce> with C<Run>."
29082 #: ../tools/virt-win-reg.pl:493
29083 msgid "Now update the registry:"
29087 #: ../tools/virt-win-reg.pl:495
29090 " virt-win-reg --merge WindowsGuest test.reg\n"
29095 #: ../tools/virt-win-reg.pl:497
29096 msgid "INSTALLING A SERVICE"
29100 #: ../tools/virt-win-reg.pl:499
29102 "This section assumes you are familiar with Windows services, and you either "
29103 "have a program which handles the Windows Service Control Protocol directly "
29104 "or you want to run any program using a service wrapper like SrvAny or the "
29109 #: ../tools/virt-win-reg.pl:504
29111 "First upload the program and optionally the service wrapper. In this case "
29112 "the test program is called C<test.exe> and we are using the RHSrvAny "
29117 #: ../tools/virt-win-reg.pl:508
29120 " guestfish -i -d WindowsGuest <<EOF\n"
29121 " upload rhsrvany.exe /rhsrvany.exe\n"
29122 " upload test.exe /test.exe\n"
29128 #: ../tools/virt-win-reg.pl:513
29130 "Prepare a regedit file containing the registry changes. In this example, "
29131 "the first registry change is needed for the service itself or the service "
29132 "wrapper (if used). The second registry change is only needed because I am "
29133 "using the RHSrvAny service wrapper."
29137 #: ../tools/virt-win-reg.pl:518
29140 " cat > service.reg <<'EOF'\n"
29141 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29142 " \"Type\"=dword:00000010\n"
29143 " \"Start\"=dword:00000002\n"
29144 " \"ErrorControl\"=dword:00000001\n"
29145 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29146 " \"DisplayName\"=\"RHSrvAny\"\n"
29147 " \"ObjectName\"=\"NetworkService\"\n"
29152 #: ../tools/virt-win-reg.pl:527
29155 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29156 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29157 " \"PWD\"=\"c:\\\\Temp\"\n"
29163 #: ../tools/virt-win-reg.pl:538
29165 "For use of C<ControlSet001> see the section above in this manual page. You "
29166 "may need to adjust this according to the control set that is in use by the "
29171 #: ../tools/virt-win-reg.pl:544
29173 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29174 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29175 "privileged account."
29179 #: ../tools/virt-win-reg.pl:550
29181 "For the meaning of the magic numbers, see this Microsoft KB article: "
29182 "L<http://support.microsoft.com/kb/103000>."
29186 #: ../tools/virt-win-reg.pl:555
29187 msgid "Update the registry:"
29191 #: ../tools/virt-win-reg.pl:557
29194 " virt-win-reg --merge WindowsGuest service.reg\n"
29199 #: ../tools/virt-win-reg.pl:561
29201 "Be careful when passing parameters containing C<\\> (backslash) in the "
29202 "shell. Usually you will have to use 'single quotes' or double backslashes "
29203 "(but not both) to protect them from the shell."
29207 #: ../tools/virt-win-reg.pl:565
29208 msgid "Paths and value names are case-insensitive."
29212 #: ../tools/virt-win-reg.pl:574
29214 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29215 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29216 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29217 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29221 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29223 "When reporting bugs, please enable debugging and capture the I<complete> "
29228 #: ../tools/virt-win-reg.pl:592
29231 " export LIBGUESTFS_DEBUG=1\n"
29232 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29237 #: ../tools/virt-win-reg.pl:595
29239 "Attach /tmp/virt-win-reg.log to a new bug report at "
29240 "L<https://bugzilla.redhat.com/>"
29244 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29245 msgid "Copyright (C) 2010 Red Hat Inc."
29249 #: ../tools/virt-list-filesystems.pl:32
29250 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29254 #: ../tools/virt-list-filesystems.pl:36
29257 " virt-list-filesystems [--options] domname\n"
29262 #: ../tools/virt-list-filesystems.pl:38
29265 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29270 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29272 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29277 #: ../tools/virt-list-filesystems.pl:45
29279 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29280 "are contained in a virtual machine or disk image."
29284 #: ../tools/virt-list-filesystems.pl:49
29286 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29287 "functionality. For more complex cases you should look at the "
29288 "L<guestfish(1)> tool."
29292 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29293 msgid "B<-l> | B<--long>"
29297 #: ../tools/virt-list-filesystems.pl:108
29299 "With this option, C<virt-list-filesystems> displays the type of each "
29300 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29304 #: ../tools/virt-list-filesystems.pl:115
29305 msgid "B<-a> | B<--all>"
29309 #: ../tools/virt-list-filesystems.pl:117
29311 "Normally we only show mountable filesystems. If this option is given then "
29312 "swap devices are shown too."
29316 #: ../tools/virt-list-filesystems.pl:191
29318 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29319 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29320 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29324 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29325 msgid "Copyright (C) 2009 Red Hat Inc."
29329 #: ../tools/virt-tar.pl:33
29330 msgid "virt-tar - Extract or upload files to a virtual machine"
29334 #: ../tools/virt-tar.pl:37
29337 " virt-tar [--options] -x domname directory tarball\n"
29342 #: ../tools/virt-tar.pl:39
29345 " virt-tar [--options] -u domname tarball directory\n"
29350 #: ../tools/virt-tar.pl:41
29353 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29358 #: ../tools/virt-tar.pl:43
29361 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29366 #: ../tools/virt-tar.pl:47
29368 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29369 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29373 #: ../tools/virt-tar.pl:52
29374 msgid "Download C</home> from the VM into a local tarball:"
29378 #: ../tools/virt-tar.pl:54
29381 " virt-tar -x domname /home home.tar\n"
29386 #: ../tools/virt-tar.pl:56
29389 " virt-tar -zx domname /home home.tar.gz\n"
29394 #: ../tools/virt-tar.pl:58
29395 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29399 #: ../tools/virt-tar.pl:60
29402 " virt-tar -u domname uploadstuff.tar /tmp\n"
29407 #: ../tools/virt-tar.pl:62
29410 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29415 #: ../tools/virt-tar.pl:66
29417 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29418 "virtual machines. If you do this, you risk disk corruption in the VM. "
29419 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29423 #: ../tools/virt-tar.pl:71
29425 "You can use C<-x> (extract) on live virtual machines, but you might get "
29426 "inconsistent results or errors if there is filesystem activity inside the "
29427 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29428 "work, but the only way to guarantee consistent results is if the virtual "
29429 "machine is shut down."
29433 #: ../tools/virt-tar.pl:79
29435 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29436 "parts of a guest filesystem. There are many possibilities: making backups, "
29437 "uploading data files, snooping on guest activity, fixing or customizing "
29442 #: ../tools/virt-tar.pl:84
29444 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29445 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29446 "should look at the L<guestfish(1)> tool."
29450 #: ../tools/virt-tar.pl:88
29452 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29453 "its contents (recursively) from the virtual machine into a local tarball. "
29454 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29455 "virtual machine. You cannot use these two options together."
29459 #: ../tools/virt-tar.pl:94
29461 "In addition, you may need to use the C<-z> (gZip) option to enable "
29462 "compression. When uploading, you have to specify C<-z> if the upload file "
29463 "is compressed because virt-tar won't detect this on its own."
29467 #: ../tools/virt-tar.pl:98
29469 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29470 "example it cannot do PKZip files or bzip2 compression. If you want that "
29471 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29472 "the L<libguestfs(3)> API)."
29476 #: ../tools/virt-tar.pl:156
29477 msgid "B<-x> | B<--extract> | B<--download>"
29481 #: ../tools/virt-tar.pl:158
29482 msgid "B<-u> | B<--upload>"
29486 #: ../tools/virt-tar.pl:160
29488 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29493 #: ../tools/virt-tar.pl:163
29495 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29496 "Please read the L</WARNING> section above before using this option."
29500 #: ../tools/virt-tar.pl:167
29501 msgid "You must specify exactly one of these options."
29505 #: ../tools/virt-tar.pl:173
29506 msgid "B<-z> | B<--gzip>"
29510 #: ../tools/virt-tar.pl:175
29511 msgid "Specify that the input or output tarball is gzip-compressed."
29515 #: ../tools/virt-tar.pl:288
29517 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29518 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29519 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29520 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29524 #: ../tools/virt-make-fs.pl:37
29525 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29529 #: ../tools/virt-make-fs.pl:41
29532 " virt-make-fs [--options] input.tar output.img\n"
29537 #: ../tools/virt-make-fs.pl:43
29540 " virt-make-fs [--options] input.tar.gz output.img\n"
29545 #: ../tools/virt-make-fs.pl:45
29548 " virt-make-fs [--options] directory output.img\n"
29553 #: ../tools/virt-make-fs.pl:49
29555 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29556 "archive or some files in a directory. It is similar to tools like "
29557 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29558 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29559 "useful if you want to attach these filesystems to existing virtual machines "
29560 "(eg. to import large amounts of read-only data to a VM)."
29564 #: ../tools/virt-make-fs.pl:57
29565 msgid "Basic usage is:"
29569 #: ../tools/virt-make-fs.pl:59
29572 " virt-make-fs input output\n"
29577 #: ../tools/virt-make-fs.pl:61
29579 "where C<input> is either a directory containing files that you want to add, "
29580 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29581 "C<output> is a disk image. The input type is detected automatically. The "
29582 "output disk image defaults to a raw ext2 image unless you specify extra "
29583 "flags (see L</OPTIONS> below)."
29587 #: ../tools/virt-make-fs.pl:67
29588 msgid "EXTRA SPACE"
29592 #: ../tools/virt-make-fs.pl:69
29594 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29595 "the files that it contains, but might have extra space. Depending on how "
29596 "you are going to use the output, you might think this extra space is wasted "
29597 "and want to minimize it, or you might want to leave space so that more files "
29598 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29599 "but you can use the C<--size> flag to leave space in the filesystem if you "
29604 #: ../tools/virt-make-fs.pl:77
29606 "An alternative way to leave extra space but not make the output image any "
29607 "bigger is to use an alternative disk image format (instead of the default "
29608 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29609 "image format (check your hypervisor supports this before using it). This "
29610 "allows you to choose a large C<--size> but the extra space won't actually be "
29611 "allocated in the image until you try to store something in it."
29615 #: ../tools/virt-make-fs.pl:85
29617 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29618 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29619 "to build another image from scratch."
29623 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29628 #: ../tools/virt-make-fs.pl:91
29631 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29636 #: ../tools/virt-make-fs.pl:93
29637 msgid "FILESYSTEM TYPE"
29641 #: ../tools/virt-make-fs.pl:95
29643 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29644 "libguestfs supports can be used (but I<not> read-only formats like "
29645 "ISO9660). Here are some of the more common choices:"
29649 #: ../tools/virt-make-fs.pl:101
29654 #: ../tools/virt-make-fs.pl:103
29656 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29657 "you are not going to use the filesystem in a way that requires the journal, "
29658 "then this is just wasted overhead."
29662 #: ../tools/virt-make-fs.pl:107
29663 msgid "I<ntfs> or I<vfat>"
29667 #: ../tools/virt-make-fs.pl:109
29668 msgid "Useful if exporting data to a Windows guest."
29672 #: ../tools/virt-make-fs.pl:111
29674 "I<Note for vfat>: The tar archive or local directory must only contain files "
29675 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29676 "program running within libguestfs is unable to change the ownership of "
29677 "non-root files, since vfat itself does not support this."
29681 #: ../tools/virt-make-fs.pl:116
29686 #: ../tools/virt-make-fs.pl:118
29688 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29689 "total filesystem size."
29693 #: ../tools/virt-make-fs.pl:125
29696 " virt-make-fs --type=minix input minixfs.img\n"
29701 #: ../tools/virt-make-fs.pl:127
29702 msgid "TO PARTITION OR NOT TO PARTITION"
29706 #: ../tools/virt-make-fs.pl:129
29707 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29711 #: ../tools/virt-make-fs.pl:131
29713 "Adding a partition can make the disk image more compatible with certain "
29714 "virtualized operating systems which don't expect to see a filesystem "
29715 "directly located on a block device (Linux doesn't care and will happily "
29716 "handle both types)."
29720 #: ../tools/virt-make-fs.pl:136
29722 "On the other hand, if you have a partition table then the output image is no "
29723 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29724 "directly on a partitioned disk image. (However libguestfs tools such as "
29725 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29729 #: ../tools/virt-make-fs.pl:144
29730 msgid "Add an MBR partition:"
29734 #: ../tools/virt-make-fs.pl:146
29737 " virt-make-fs --partition -- input disk.img\n"
29742 #: ../tools/virt-make-fs.pl:148
29744 "If the output disk image could be terabyte-sized or larger, it's better to "
29745 "use an EFI/GPT-compatible partition table:"
29749 #: ../tools/virt-make-fs.pl:151
29752 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29757 #: ../tools/virt-make-fs.pl:179
29758 msgid "Enable debugging information."
29762 #: ../tools/virt-make-fs.pl:185
29763 msgid "B<--size=E<lt>NE<gt>>"
29767 #: ../tools/virt-make-fs.pl:187
29768 msgid "B<--size=+E<lt>NE<gt>>"
29772 #: ../tools/virt-make-fs.pl:189
29773 msgid "B<-s E<lt>NE<gt>>"
29777 #: ../tools/virt-make-fs.pl:191
29778 msgid "B<-s +E<lt>NE<gt>>"
29782 #: ../tools/virt-make-fs.pl:193
29783 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29787 #: ../tools/virt-make-fs.pl:196
29789 "If this option is I<not> given, then the output image will be just large "
29790 "enough to contain all the files, with not much wasted space."
29794 #: ../tools/virt-make-fs.pl:199
29796 "To choose a fixed size output disk, specify an absolute number followed by "
29797 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29798 "Petabytes or Exabytes. This must be large enough to contain all the input "
29799 "files, else you will get an error."
29803 #: ../tools/virt-make-fs.pl:204
29805 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29806 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29807 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29808 "the input files, and (approximately) an extra 200 MB free space."
29812 #: ../tools/virt-make-fs.pl:210
29814 "Note that virt-make-fs estimates free space, and therefore will not produce "
29815 "filesystems containing precisely the free space requested. (It is much more "
29816 "expensive and time-consuming to produce a filesystem which has precisely the "
29817 "desired free space)."
29821 #: ../tools/virt-make-fs.pl:219
29822 msgid "B<--format=E<lt>fmtE<gt>>"
29826 #: ../tools/virt-make-fs.pl:221
29827 msgid "B<-F E<lt>fmtE<gt>>"
29831 #: ../tools/virt-make-fs.pl:223
29832 msgid "Choose the output disk image format."
29836 #: ../tools/virt-make-fs.pl:225
29837 msgid "The default is C<raw> (raw disk image)."
29841 #: ../tools/virt-make-fs.pl:227
29843 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29844 "that would really make sense here is C<qcow2>."
29848 #: ../tools/virt-make-fs.pl:234
29849 msgid "B<--type=E<lt>fsE<gt>>"
29853 #: ../tools/virt-make-fs.pl:236
29854 msgid "B<-t E<lt>fsE<gt>>"
29858 #: ../tools/virt-make-fs.pl:238
29859 msgid "Choose the output filesystem type."
29863 #: ../tools/virt-make-fs.pl:240
29864 msgid "The default is C<ext2>."
29868 #: ../tools/virt-make-fs.pl:242
29869 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29873 #: ../tools/virt-make-fs.pl:249
29874 msgid "B<--partition>"
29878 #: ../tools/virt-make-fs.pl:251
29879 msgid "B<--partition=E<lt>parttypeE<gt>>"
29883 #: ../tools/virt-make-fs.pl:253
29885 "If specified, this flag adds an MBR partition table to the output disk "
29890 #: ../tools/virt-make-fs.pl:256
29892 "You can change the partition table type, eg. C<--partition=gpt> for large "
29897 #: ../tools/virt-make-fs.pl:259
29899 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29900 "might consider the next parameter to be the partition type. For example:"
29904 #: ../tools/virt-make-fs.pl:263
29907 " virt-make-fs --partition input.tar ...\n"
29912 #: ../tools/virt-make-fs.pl:265
29914 "would cause virt-make-fs to think you wanted to use a partition type of "
29915 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29916 "dash) between options and the input file argument:"
29920 #: ../tools/virt-make-fs.pl:269
29923 " virt-make-fs --partition -- input.tar ...\n"
29928 #: ../tools/virt-make-fs.pl:541
29930 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
29931 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29932 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29936 #: ../tools/virt-make-fs.pl:558
29939 " export LIBGUESTFS_DEBUG=1\n"
29940 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29945 #: ../tools/virt-make-fs.pl:561
29947 "Attach /tmp/virt-make-fs.log to a new bug report at "
29948 "L<https://bugzilla.redhat.com/>"
29952 #: ../tools/virt-list-partitions.pl:32
29953 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29957 #: ../tools/virt-list-partitions.pl:36
29960 " virt-list-partitions [--options] domname\n"
29965 #: ../tools/virt-list-partitions.pl:38
29968 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29973 #: ../tools/virt-list-partitions.pl:45
29975 "C<virt-list-partitions> is a command line tool to list the partitions that "
29976 "are contained in a virtual machine or disk image. It is mainly useful as a "
29977 "first step to using L<virt-resize(1)>."
29981 #: ../tools/virt-list-partitions.pl:50
29983 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29984 "functionality. For more complex cases you should look at the "
29985 "L<guestfish(1)> tool."
29989 #: ../tools/virt-list-partitions.pl:107
29990 msgid "B<-h> | B<--human-readable>"
29994 #: ../tools/virt-list-partitions.pl:109
29995 msgid "Show sizes in human-readable form (eg. \"1G\")."
29999 #: ../tools/virt-list-partitions.pl:117
30001 "With this option, C<virt-list-partitions> displays the type and size of each "
30002 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30006 #: ../tools/virt-list-partitions.pl:124
30007 msgid "B<-t> | B<--total>"
30011 #: ../tools/virt-list-partitions.pl:126
30012 msgid "Display the total size of each block device (as a separate row or rows)."
30016 #: ../tools/virt-list-partitions.pl:259
30018 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30019 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30020 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30024 #: ../tools/virt-list-partitions.pl:275
30025 msgid "Copyright (C) 2009-2010 Red Hat Inc."