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.5\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-07-13 17:55+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 file descriptor 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:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762 ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012 ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380 ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../src/guestfs.pod:2979 ../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:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1621 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1639 ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1781 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1856 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865 ../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:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1115 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1209 ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1265 ../fish/guestfish-actions.pod:1270 ../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:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2425
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:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2450
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:1405
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 "I<Update:> Autosync is enabled by default for all API users starting from "
1551 "libguestfs 1.5.24. This section only applies to older versions."
1555 #: ../src/guestfs.pod:781
1557 "When modifying a filesystem from C or another language, you B<must> unmount "
1558 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1559 "libguestfs handle. You can also call:"
1563 #: ../src/guestfs.pod:785
1566 " guestfs_set_autosync (g, 1);\n"
1571 #: ../src/guestfs.pod:787
1573 "to have the unmount/sync done automatically for you when the handle 'g' is "
1574 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1579 #: ../src/guestfs.pod:791
1581 "If you forget to do this, then it is entirely possible that your changes "
1582 "won't be written out, or will be partially written, or (very rarely) that "
1583 "you'll get disk corruption."
1587 #: ../src/guestfs.pod:795
1589 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1590 "guestfish scripts that forget to sync will work just fine, which can make "
1591 "this very puzzling if you are trying to debug a problem."
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 "KEYS AND PASSPHRASES"
1767 #: ../src/guestfs.pod:884
1769 "Certain libguestfs calls take a parameter that contains sensitive key "
1770 "material, passed in as a C string."
1774 #: ../src/guestfs.pod:887
1776 "In the future we would hope to change the libguestfs implementation so that "
1777 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1778 "swap. However this is I<not> done at the moment, because of the complexity "
1779 "of such an implementation."
1783 #: ../src/guestfs.pod:892
1785 "Therefore you should be aware that any key parameter you pass to libguestfs "
1786 "might end up being written out to the swap partition. If this is a concern, "
1787 "scrub the swap partition or don't use libguestfs on encrypted devices."
1791 #: ../src/guestfs.pod:897
1792 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1796 #: ../src/guestfs.pod:899
1798 "All high-level libguestfs actions are synchronous. If you want to use "
1799 "libguestfs asynchronously then you must create a thread."
1803 #: ../src/guestfs.pod:902
1805 "Only use the handle from a single thread. Either use the handle exclusively "
1806 "from one thread, or provide your own mutex so that two threads cannot issue "
1807 "calls on the same handle at the same time."
1811 #: ../src/guestfs.pod:906
1813 "See the graphical program guestfs-browser for one possible architecture for "
1814 "multithreaded programs using libvirt and libguestfs."
1818 #: ../src/guestfs.pod:909
1823 #: ../src/guestfs.pod:911
1825 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1830 #: ../src/guestfs.pod:914
1832 "By default it looks for these in the directory C<$libdir/guestfs> "
1833 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1837 #: ../src/guestfs.pod:917
1839 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1840 "to change the directories that libguestfs will search in. The value is a "
1841 "colon-separated list of paths. The current directory is I<not> searched "
1842 "unless the path contains an empty element or C<.>. For example "
1843 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1844 "then C</usr/lib/guestfs>."
1848 #: ../src/guestfs.pod:924
1849 msgid "QEMU WRAPPERS"
1853 #: ../src/guestfs.pod:926
1855 "If you want to compile your own qemu, run qemu from a non-standard location, "
1856 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1861 #: ../src/guestfs.pod:930
1863 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1864 "last command in the shell script (so that qemu replaces the shell and "
1865 "becomes the direct child of the libguestfs-using program). If you don't do "
1866 "this, then the qemu process won't be cleaned up correctly."
1870 #: ../src/guestfs.pod:935
1872 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1877 #: ../src/guestfs.pod:938
1881 " qemudir=/home/rjones/d/qemu\n"
1882 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1888 #: ../src/guestfs.pod:942
1890 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1891 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1896 #: ../src/guestfs.pod:946
1899 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1904 #: ../src/guestfs.pod:948
1906 "Note that libguestfs also calls qemu with the -help and -version options in "
1907 "order to determine features."
1911 #: ../src/guestfs.pod:951
1912 msgid "ATTACHING TO RUNNING DAEMONS"
1916 #: ../src/guestfs.pod:953
1918 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1919 "babies. Use with caution."
1923 #: ../src/guestfs.pod:956
1925 "I<Note (2):> This section explains how to attach to a running daemon from a "
1926 "low level perspective. For most users, simply using virt tools such as "
1927 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1931 #: ../src/guestfs.pod:960
1932 msgid "Using guestfs_set_attach_method"
1936 #: ../src/guestfs.pod:962
1938 "By calling L</guestfs_set_attach_method> you can change how the library "
1939 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1940 "L</ARCHITECTURE> for some background)."
1944 #: ../src/guestfs.pod:966
1946 "The normal attach method is C<appliance>, where a small appliance is created "
1947 "containing the daemon, and then the library connects to this."
1951 #: ../src/guestfs.pod:969
1953 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1954 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1955 "daemon over the Unix domain socket."
1959 #: ../src/guestfs.pod:973
1961 "The normal use for this is to connect to a running virtual machine that "
1962 "contains a C<guestfsd> daemon, and send commands so you can read and write "
1963 "files inside the live virtual machine."
1967 #: ../src/guestfs.pod:977
1968 msgid "Using guestfs_add_domain with live flag"
1972 #: ../src/guestfs.pod:979
1974 "L</guestfs_add_domain> provides some help for getting the correct attach "
1975 "method. If you pass the C<live> option to this function, then (if the "
1976 "virtual machine is running) it will examine the libvirt XML looking for a "
1977 "virtio-serial channel to connect to:"
1981 #: ../src/guestfs.pod:985
1988 " <channel type='unix'>\n"
1989 " <source mode='bind' path='/path/to/socket'/>\n"
1990 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
1999 #: ../src/guestfs.pod:997
2001 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2002 "method to C<unix:/path/to/socket>."
2006 #: ../src/guestfs.pod:1000
2008 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2009 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2010 "to attach to and modify live virtual machines."
2014 #: ../src/guestfs.pod:1004
2016 "The virtual machine needs to have been set up beforehand so that it has the "
2017 "virtio-serial channel and so that guestfsd is running inside it."
2021 #: ../src/guestfs.pod:1008
2022 msgid "ABI GUARANTEE"
2026 #: ../src/guestfs.pod:1010
2028 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2029 "actions as outlined in this section. Although we will deprecate some "
2030 "actions, for example if they get replaced by newer calls, we will keep the "
2031 "old actions forever. This allows you the developer to program in confidence "
2032 "against the libguestfs API."
2036 #: ../src/guestfs.pod:1016
2037 msgid "BLOCK DEVICE NAMING"
2041 #: ../src/guestfs.pod:1018
2043 "In the kernel there is now quite a profusion of schemata for naming block "
2044 "devices (in this context, by I<block device> I mean a physical or virtual "
2045 "hard drive). The original Linux IDE driver used names starting with "
2046 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2047 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2048 "replacement for the old IDE driver (particularly for SATA devices) those "
2049 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2050 "machines with paravirtualized drivers. This has created several different "
2051 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2056 #: ../src/guestfs.pod:1030
2058 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2059 "Linux kernel to access block devices. We can run a variety of appliances "
2060 "based on a variety of Linux kernels."
2064 #: ../src/guestfs.pod:1034
2066 "This causes a problem for libguestfs because many API calls use device or "
2067 "partition names. Working scripts and the recipe (example) scripts that we "
2068 "make available over the internet could fail if the naming scheme changes."
2072 #: ../src/guestfs.pod:1039
2074 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2075 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2076 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2077 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2081 #: ../src/guestfs.pod:1045
2083 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2084 "L</guestfs_list_partitions> and similar calls return the true names of the "
2085 "devices and partitions as known to the appliance."
2089 #: ../src/guestfs.pod:1050
2090 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2094 #: ../src/guestfs.pod:1052
2096 "Usually this translation is transparent. However in some (very rare) cases "
2097 "you may need to know the exact algorithm. Such cases include where you use "
2098 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2099 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2104 #: ../src/guestfs.pod:1058
2106 "The algorithm is applied only to I<parameters> which are known to be either "
2107 "device or partition names. Return values from functions such as "
2108 "L</guestfs_list_devices> are never changed."
2112 #: ../src/guestfs.pod:1066
2113 msgid "Is the string a parameter which is a device or partition name?"
2117 #: ../src/guestfs.pod:1070
2118 msgid "Does the string begin with C</dev/sd>?"
2122 #: ../src/guestfs.pod:1074
2124 "Does the named device exist? If so, we use that device. However if I<not> "
2125 "then we continue with this algorithm."
2129 #: ../src/guestfs.pod:1079
2130 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2134 #: ../src/guestfs.pod:1081
2135 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2139 #: ../src/guestfs.pod:1083
2140 msgid "If that named device exists, use it. If not, continue."
2144 #: ../src/guestfs.pod:1087
2145 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2149 #: ../src/guestfs.pod:1089
2150 msgid "If that named device exists, use it. If not, return an error."
2154 #: ../src/guestfs.pod:1093
2155 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2159 #: ../src/guestfs.pod:1095
2161 "Although the standard naming scheme and automatic translation is useful for "
2162 "simple programs and guestfish scripts, for larger programs it is best not to "
2163 "rely on this mechanism."
2167 #: ../src/guestfs.pod:1099
2169 "Where possible for maximum future portability programs using libguestfs "
2170 "should use these future-proof techniques:"
2174 #: ../src/guestfs.pod:1106
2176 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2177 "device names, and then use those names directly."
2181 #: ../src/guestfs.pod:1109
2182 msgid "Since those device names exist by definition, they will never be translated."
2186 #: ../src/guestfs.pod:1114
2188 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2189 "filesystem labels."
2193 #: ../src/guestfs.pod:1119
2198 #: ../src/guestfs.pod:1121
2200 "This section discusses security implications of using libguestfs, "
2201 "particularly with untrusted or malicious guests or disk images."
2205 #: ../src/guestfs.pod:1124
2206 msgid "GENERAL SECURITY CONSIDERATIONS"
2210 #: ../src/guestfs.pod:1126
2212 "Be careful with any files or data that you download from a guest (by "
2213 "\"download\" we mean not just the L</guestfs_download> command but any "
2214 "command that reads files, filenames, directories or anything else from a "
2215 "disk image). An attacker could manipulate the data to fool your program "
2216 "into doing the wrong thing. Consider cases such as:"
2220 #: ../src/guestfs.pod:1136
2221 msgid "the data (file etc) not being present"
2225 #: ../src/guestfs.pod:1140
2226 msgid "being present but empty"
2230 #: ../src/guestfs.pod:1144
2231 msgid "being much larger than normal"
2235 #: ../src/guestfs.pod:1148
2236 msgid "containing arbitrary 8 bit data"
2240 #: ../src/guestfs.pod:1152
2241 msgid "being in an unexpected character encoding"
2245 #: ../src/guestfs.pod:1156
2246 msgid "containing homoglyphs."
2250 #: ../src/guestfs.pod:1160
2251 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2255 #: ../src/guestfs.pod:1162
2257 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2258 "(VFS) module can sometimes be escalated into exploits by deliberately "
2259 "creating a malicious, malformed filesystem. These exploits are very severe "
2260 "for two reasons. Firstly there are very many filesystem drivers in the "
2261 "kernel, and many of them are infrequently used and not much developer "
2262 "attention has been paid to the code. Linux userspace helps potential "
2263 "crackers by detecting the filesystem type and automatically choosing the "
2264 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2265 "the administrator. Secondly, a kernel-level exploit is like a local root "
2266 "exploit (worse in some ways), giving immediate and total access to the "
2267 "system right down to the hardware level."
2271 #: ../src/guestfs.pod:1175
2273 "That explains why you should never mount a filesystem from an untrusted "
2274 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2275 "inside a qemu virtual machine, usually running as a non-root user. The "
2276 "attacker would need to write a filesystem which first exploited the kernel, "
2277 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2278 "the libguestfs protocol, and finally to be as serious as the host kernel "
2279 "exploit it would need to escalate its privileges to root. This multi-step "
2280 "escalation, performed by a static piece of data, is thought to be extremely "
2281 "hard to do, although we never say 'never' about security issues."
2285 #: ../src/guestfs.pod:1186
2287 "In any case callers can reduce the attack surface by forcing the filesystem "
2288 "type when mounting (use L</guestfs_mount_vfs>)."
2292 #: ../src/guestfs.pod:1189
2293 msgid "PROTOCOL SECURITY"
2297 #: ../src/guestfs.pod:1191
2299 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2300 "defined upper message size. However a program that uses libguestfs must "
2301 "also take care - for example you can write a program that downloads a binary "
2302 "from a disk image and executes it locally, and no amount of protocol "
2303 "security will save you from the consequences."
2307 #: ../src/guestfs.pod:1197
2308 msgid "INSPECTION SECURITY"
2312 #: ../src/guestfs.pod:1199
2314 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2315 "directly from the guest, and these could contain any 8 bit data. Callers "
2316 "should be careful to escape these before printing them to a structured file "
2317 "(for example, use HTML escaping if creating a web page)."
2321 #: ../src/guestfs.pod:1205
2323 "Guest configuration may be altered in unusual ways by the administrator of "
2324 "the virtual machine, and may not reflect reality (particularly for untrusted "
2325 "or actively malicious guests). For example we parse the hostname from "
2326 "configuration files like C</etc/sysconfig/network> that we find in the "
2327 "guest, but the guest administrator can easily manipulate these files to "
2328 "provide the wrong hostname."
2332 #: ../src/guestfs.pod:1213
2334 "The inspection API parses guest configuration using two external libraries: "
2335 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2336 "designed to be robust in the face of malicious data, although denial of "
2337 "service attacks are still possible, for example with oversized configuration "
2342 #: ../src/guestfs.pod:1219
2343 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2347 #: ../src/guestfs.pod:1221
2349 "Be very cautious about running commands from the guest. By running a "
2350 "command in the guest, you are giving CPU time to a binary that you do not "
2351 "control, under the same user account as the library, albeit wrapped in qemu "
2352 "virtualization. More information and alternatives can be found in the "
2353 "section L</RUNNING COMMANDS>."
2357 #: ../src/guestfs.pod:1227
2358 msgid "CVE-2010-3851"
2362 #: ../src/guestfs.pod:1229
2363 msgid "https://bugzilla.redhat.com/642934"
2367 #: ../src/guestfs.pod:1231
2369 "This security bug concerns the automatic disk format detection that qemu "
2370 "does on disk images."
2374 #: ../src/guestfs.pod:1234
2376 "A raw disk image is just the raw bytes, there is no header. Other disk "
2377 "images like qcow2 contain a special header. Qemu deals with this by looking "
2378 "for one of the known headers, and if none is found then assuming the disk "
2379 "image must be raw."
2383 #: ../src/guestfs.pod:1239
2385 "This allows a guest which has been given a raw disk image to write some "
2386 "other header. At next boot (or when the disk image is accessed by "
2387 "libguestfs) qemu would do autodetection and think the disk image format was, "
2388 "say, qcow2 based on the header written by the guest."
2392 #: ../src/guestfs.pod:1244
2394 "This in itself would not be a problem, but qcow2 offers many features, one "
2395 "of which is to allow a disk image to refer to another image (called the "
2396 "\"backing disk\"). It does this by placing the path to the backing disk "
2397 "into the qcow2 header. This path is not validated and could point to any "
2398 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2399 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2400 "control of the attacker."
2404 #: ../src/guestfs.pod:1252
2405 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2409 #: ../src/guestfs.pod:1259
2410 msgid "You have enabled the network or have opened the disk in write mode."
2414 #: ../src/guestfs.pod:1263
2416 "You are also running untrusted code from the guest (see L</RUNNING "
2421 #: ../src/guestfs.pod:1268
2423 "The way to avoid this is to specify the expected disk format when adding "
2424 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2425 "should always do this if the disk is raw format, and it's a good idea for "
2430 #: ../src/guestfs.pod:1273
2432 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2433 "format is fetched from libvirt and passed through."
2437 #: ../src/guestfs.pod:1276
2439 "For libguestfs tools, use the I<--format> command line parameter as "
2444 #: ../src/guestfs.pod:1279
2445 msgid "CONNECTION MANAGEMENT"
2449 #: ../src/guestfs.pod:1281
2454 #: ../src/guestfs.pod:1283
2456 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2457 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2458 "handle and release all resources used."
2462 #: ../src/guestfs.pod:1287
2464 "For information on using multiple handles and threads, see the section "
2465 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2469 #: ../src/guestfs.pod:1290
2470 msgid "guestfs_create"
2474 #: ../src/guestfs.pod:1292
2477 " guestfs_h *guestfs_create (void);\n"
2482 #: ../src/guestfs.pod:1294
2483 msgid "Create a connection handle."
2487 #: ../src/guestfs.pod:1296
2489 "On success this returns a non-NULL pointer to a handle. On error it returns "
2494 #: ../src/guestfs.pod:1299
2496 "You have to \"configure\" the handle after creating it. This includes "
2497 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2498 "handle at least once."
2502 #: ../src/guestfs.pod:1303
2503 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2507 #: ../src/guestfs.pod:1305
2509 "You may also want to configure error handling for the handle. See the "
2510 "L</ERROR HANDLING> section below."
2514 #: ../src/guestfs.pod:1308
2515 msgid "guestfs_close"
2519 #: ../src/guestfs.pod:1310
2522 " void guestfs_close (guestfs_h *g);\n"
2527 #: ../src/guestfs.pod:1312
2528 msgid "This closes the connection handle and frees up all resources used."
2532 #: ../src/guestfs.pod:1314
2534 "If autosync was set on the handle and the handle was launched, then this "
2535 "implicitly calls various functions to unmount filesystems and sync the "
2536 "disk. See L</guestfs_set_autosync> for more details."
2540 #: ../src/guestfs.pod:1318
2541 msgid "If a close callback was set on the handle, then it is called."
2545 #: ../src/guestfs.pod:1320
2546 msgid "ERROR HANDLING"
2550 #: ../src/guestfs.pod:1322
2552 "API functions can return errors. For example, almost all functions that "
2553 "return C<int> will return C<-1> to indicate an error."
2557 #: ../src/guestfs.pod:1325
2559 "Additional information is available for errors: an error message string and "
2560 "optionally an error number (errno) if the thing that failed was a system "
2565 #: ../src/guestfs.pod:1329
2567 "You can get at the additional information about the last error on the handle "
2568 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2569 "up an error handler with L</guestfs_set_error_handler>."
2573 #: ../src/guestfs.pod:1334
2575 "When the handle is created, a default error handler is installed which "
2576 "prints the error message string to C<stderr>. For small short-running "
2577 "command line programs it is sufficient to do:"
2581 #: ../src/guestfs.pod:1338
2584 " if (guestfs_launch (g) == -1)\n"
2585 " exit (EXIT_FAILURE);\n"
2590 #: ../src/guestfs.pod:1341
2592 "since the default error handler will ensure that an error message has been "
2593 "printed to C<stderr> before the program exits."
2597 #: ../src/guestfs.pod:1344
2599 "For other programs the caller will almost certainly want to install an "
2600 "alternate error handler or do error handling in-line like this:"
2604 #: ../src/guestfs.pod:1347
2607 " g = guestfs_create ();\n"
2612 #: ../src/guestfs.pod:1349
2615 " /* This disables the default behaviour of printing errors\n"
2617 " guestfs_set_error_handler (g, NULL, NULL);\n"
2622 #: ../src/guestfs.pod:1353
2625 " if (guestfs_launch (g) == -1) {\n"
2626 " /* Examine the error message and print it etc. */\n"
2627 " char *msg = guestfs_last_error (g);\n"
2628 " int errnum = guestfs_last_errno (g);\n"
2629 " fprintf (stderr, \"%s\\n\", msg);\n"
2636 #: ../src/guestfs.pod:1361
2638 "Out of memory errors are handled differently. The default action is to call "
2639 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2640 "L</guestfs_set_out_of_memory_handler>."
2644 #: ../src/guestfs.pod:1365
2646 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2647 "because there is no handle if this happens there is no way to get additional "
2648 "error information. However L</guestfs_create> is supposed to be a "
2649 "lightweight operation which can only fail because of insufficient memory (it "
2650 "returns NULL in this case)."
2654 #: ../src/guestfs.pod:1371
2655 msgid "guestfs_last_error"
2659 #: ../src/guestfs.pod:1373
2662 " const char *guestfs_last_error (guestfs_h *g);\n"
2667 #: ../src/guestfs.pod:1375
2669 "This returns the last error message that happened on C<g>. If there has not "
2670 "been an error since the handle was created, then this returns C<NULL>."
2674 #: ../src/guestfs.pod:1379
2676 "The lifetime of the returned string is until the next error occurs, or "
2677 "L</guestfs_close> is called."
2681 #: ../src/guestfs.pod:1382
2682 msgid "guestfs_last_errno"
2686 #: ../src/guestfs.pod:1384
2689 " int guestfs_last_errno (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1386
2695 msgid "This returns the last error number (errno) that happened on C<g>."
2699 #: ../src/guestfs.pod:1388
2700 msgid "If successful, an errno integer not equal to zero is returned."
2704 #: ../src/guestfs.pod:1390
2705 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2709 #: ../src/guestfs.pod:1397
2710 msgid "There has not been any error on the handle."
2714 #: ../src/guestfs.pod:1401
2716 "There has been an error but the errno was meaningless. This corresponds to "
2717 "the case where the error did not come from a failed system call, but for "
2718 "some other reason."
2722 #: ../src/guestfs.pod:1407
2724 "There was an error from a failed system call, but for some reason the errno "
2725 "was not captured and returned. This usually indicates a bug in libguestfs."
2729 #: ../src/guestfs.pod:1413
2731 "Libguestfs tries to convert the errno from inside the applicance into a "
2732 "corresponding errno for the caller (not entirely trivial: the appliance "
2733 "might be running a completely different operating system from the library "
2734 "and error numbers are not standardized across Un*xen). If this could not be "
2735 "done, then the error is translated to C<EINVAL>. In practice this should "
2736 "only happen in very rare circumstances."
2740 #: ../src/guestfs.pod:1421
2741 msgid "guestfs_set_error_handler"
2745 #: ../src/guestfs.pod:1423
2748 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2750 " const char *msg);\n"
2751 " void guestfs_set_error_handler (guestfs_h *g,\n"
2752 " guestfs_error_handler_cb cb,\n"
2758 #: ../src/guestfs.pod:1430
2760 "The callback C<cb> will be called if there is an error. The parameters "
2761 "passed to the callback are an opaque data pointer and the error message "
2766 #: ../src/guestfs.pod:1434
2768 "C<errno> is not passed to the callback. To get that the callback must call "
2769 "L</guestfs_last_errno>."
2773 #: ../src/guestfs.pod:1437
2775 "Note that the message string C<msg> is freed as soon as the callback "
2776 "function returns, so if you want to stash it somewhere you must make your "
2781 #: ../src/guestfs.pod:1441
2782 msgid "The default handler prints messages on C<stderr>."
2786 #: ../src/guestfs.pod:1443
2787 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2791 #: ../src/guestfs.pod:1445
2792 msgid "guestfs_get_error_handler"
2796 #: ../src/guestfs.pod:1447
2799 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2800 " void **opaque_rtn);\n"
2805 #: ../src/guestfs.pod:1450
2806 msgid "Returns the current error handler callback."
2810 #: ../src/guestfs.pod:1452
2811 msgid "guestfs_set_out_of_memory_handler"
2815 #: ../src/guestfs.pod:1454
2818 " typedef void (*guestfs_abort_cb) (void);\n"
2819 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2820 " guestfs_abort_cb);\n"
2825 #: ../src/guestfs.pod:1458
2827 "The callback C<cb> will be called if there is an out of memory situation. "
2828 "I<Note this callback must not return>."
2832 #: ../src/guestfs.pod:1461
2833 msgid "The default is to call L<abort(3)>."
2837 #: ../src/guestfs.pod:1463
2838 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2842 #: ../src/guestfs.pod:1466
2843 msgid "guestfs_get_out_of_memory_handler"
2847 #: ../src/guestfs.pod:1468
2850 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2855 #: ../src/guestfs.pod:1470
2856 msgid "This returns the current out of memory handler."
2860 #: ../src/guestfs.pod:1472
2865 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1008
2870 #: ../src/guestfs.pod:1476
2875 #: ../src/guestfs.pod:1478
2880 #: ../src/guestfs.pod:1480
2881 msgid "AVAILABILITY"
2885 #: ../src/guestfs.pod:1482
2886 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2890 #: ../src/guestfs.pod:1484
2892 "Using L</guestfs_available> you can test availability of the following "
2893 "groups of functions. This test queries the appliance to see if the "
2894 "appliance you are currently using supports the functionality."
2898 #: ../src/guestfs.pod:1489
2899 msgid "@AVAILABILITY@"
2903 #: ../src/guestfs.pod:1491
2904 msgid "GUESTFISH supported COMMAND"
2908 #: ../src/guestfs.pod:1493
2910 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2911 "prints out the available groups and whether they are supported by this build "
2912 "of libguestfs. Note however that you have to do C<run> first."
2916 #: ../src/guestfs.pod:1498
2917 msgid "SINGLE CALLS AT COMPILE TIME"
2921 #: ../src/guestfs.pod:1500
2923 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2924 "function, such as:"
2928 #: ../src/guestfs.pod:1503
2931 " #define LIBGUESTFS_HAVE_DD 1\n"
2936 #: ../src/guestfs.pod:1505
2937 msgid "if L</guestfs_dd> is available."
2941 #: ../src/guestfs.pod:1507
2943 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2944 "function is available at compile time, we recommended using build tools such "
2945 "as autoconf or cmake. For example in autotools you could use:"
2949 #: ../src/guestfs.pod:1512
2952 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2953 " AC_CHECK_FUNCS([guestfs_dd])\n"
2958 #: ../src/guestfs.pod:1515
2960 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2965 #: ../src/guestfs.pod:1518
2966 msgid "SINGLE CALLS AT RUN TIME"
2970 #: ../src/guestfs.pod:1520
2972 "Testing at compile time doesn't guarantee that a function really exists in "
2973 "the library. The reason is that you might be dynamically linked against a "
2974 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2975 "This situation unfortunately results in a segmentation fault, which is a "
2976 "shortcoming of the C dynamic linking system itself."
2980 #: ../src/guestfs.pod:1527
2982 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2983 "in this example program (note that you still need the compile time check as "
2988 #: ../src/guestfs.pod:1531
2991 " #include <stdio.h>\n"
2992 " #include <stdlib.h>\n"
2993 " #include <unistd.h>\n"
2994 " #include <dlfcn.h>\n"
2995 " #include <guestfs.h>\n"
3000 #: ../src/guestfs.pod:1537
3005 " #ifdef LIBGUESTFS_HAVE_DD\n"
3007 " int has_function;\n"
3012 #: ../src/guestfs.pod:1543
3015 " /* Test if the function guestfs_dd is really available. */\n"
3016 " dl = dlopen (NULL, RTLD_LAZY);\n"
3018 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3019 " exit (EXIT_FAILURE);\n"
3021 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3027 #: ../src/guestfs.pod:1552
3030 " if (!has_function)\n"
3031 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3033 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3034 " /* Now it's safe to call\n"
3035 " guestfs_dd (g, \"foo\", \"bar\");\n"
3039 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3046 #: ../src/guestfs.pod:1565
3048 "You may think the above is an awful lot of hassle, and it is. There are "
3049 "other ways outside of the C linking system to ensure that this kind of "
3050 "incompatibility never arises, such as using package versioning:"
3054 #: ../src/guestfs.pod:1570
3057 " Requires: libguestfs >= 1.0.80\n"
3062 #: ../src/guestfs.pod:1572
3063 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3067 #: ../src/guestfs.pod:1574
3069 "A recent feature of the API is the introduction of calls which take optional "
3070 "arguments. In C these are declared 3 ways. The main way is as a call which "
3071 "takes variable arguments (ie. C<...>), as in this example:"
3075 #: ../src/guestfs.pod:1579
3078 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3083 #: ../src/guestfs.pod:1581
3085 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3086 "call with no optional arguments specified:"
3090 #: ../src/guestfs.pod:1584
3093 " guestfs_add_drive_opts (g, filename, -1);\n"
3098 #: ../src/guestfs.pod:1586
3099 msgid "With a single optional argument:"
3103 #: ../src/guestfs.pod:1588
3106 " guestfs_add_drive_opts (g, filename,\n"
3107 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3113 #: ../src/guestfs.pod:1592
3118 #: ../src/guestfs.pod:1594
3121 " guestfs_add_drive_opts (g, filename,\n"
3122 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3123 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3129 #: ../src/guestfs.pod:1599
3131 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3136 #: ../src/guestfs.pod:1602
3137 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3141 #: ../src/guestfs.pod:1604
3143 "The second variant has the same name with the suffix C<_va>, which works the "
3144 "same way but takes a C<va_list>. See the C manual for details. For the "
3145 "example function, this is declared:"
3149 #: ../src/guestfs.pod:1608
3152 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3158 #: ../src/guestfs.pod:1611
3159 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3163 #: ../src/guestfs.pod:1613
3165 "The third variant is useful where you need to construct these calls. You "
3166 "pass in a structure where you fill in the optional fields. The structure "
3167 "has a bitmask as the first element which you must set to indicate which "
3168 "fields you have filled in. For our example function the structure and call "
3173 #: ../src/guestfs.pod:1619
3176 " struct guestfs_add_drive_opts_argv {\n"
3177 " uint64_t bitmask;\n"
3179 " const char *format;\n"
3182 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3183 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3188 #: ../src/guestfs.pod:1628
3189 msgid "You could call it like this:"
3193 #: ../src/guestfs.pod:1630
3196 " struct guestfs_add_drive_opts_argv optargs = {\n"
3197 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3198 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3200 " .format = \"qcow2\"\n"
3206 #: ../src/guestfs.pod:1637
3209 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3214 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1257 ../tools/virt-win-reg.pl:532
3219 #: ../src/guestfs.pod:1645
3220 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3224 #: ../src/guestfs.pod:1650
3225 msgid "You do not need to fill in all fields of the structure."
3229 #: ../src/guestfs.pod:1654
3231 "There must be a one-to-one correspondence between fields of the structure "
3232 "that are filled in, and bits set in the bitmask."
3236 #: ../src/guestfs.pod:1659
3237 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3241 #: ../src/guestfs.pod:1661
3243 "In other languages, optional arguments are expressed in the way that is "
3244 "natural for that language. We refer you to the language-specific "
3245 "documentation for more details on that."
3249 #: ../src/guestfs.pod:1665
3250 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3254 #: ../src/guestfs.pod:1667
3255 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3259 #: ../src/guestfs.pod:1669
3261 "B<Note:> This section documents the generic event mechanism introduced in "
3262 "libguestfs 1.10, which you should use in new code if possible. The old "
3263 "functions C<guestfs_set_log_message_callback>, "
3264 "C<guestfs_set_subprocess_quit_callback>, "
3265 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3266 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3271 #: ../src/guestfs.pod:1677
3273 "Handles generate events when certain things happen, such as log messages "
3274 "being generated, progress messages during long-running operations, or the "
3275 "handle being closed. The API calls described below let you register a "
3276 "callback to be called when events happen. You can register multiple "
3277 "callbacks (for the same, different or overlapping sets of events), and "
3278 "individually remove callbacks. If callbacks are not removed, then they "
3279 "remain in force until the handle is closed."
3283 #: ../src/guestfs.pod:1685
3285 "In the current implementation, events are only generated synchronously: that "
3286 "means that events (and hence callbacks) can only happen while you are in the "
3287 "middle of making another libguestfs call. The callback is called in the "
3292 #: ../src/guestfs.pod:1690
3294 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3295 "unsigned integers, or a message buffer. Payloads are discussed later on."
3299 #: ../src/guestfs.pod:1694
3300 msgid "CLASSES OF EVENTS"
3304 #: ../src/guestfs.pod:1698
3305 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3309 #: ../src/guestfs.pod:1701
3311 "The callback function will be called while the handle is being closed "
3312 "(synchronously from L</guestfs_close>)."
3316 #: ../src/guestfs.pod:1704
3318 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3319 "handles that are open when the program exits. This means that this callback "
3320 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3321 "problems in higher-level languages (eg. if your HLL interpreter has already "
3322 "been cleaned up by the time this is called, and if your callback then jumps "
3323 "into some HLL function)."
3327 #: ../src/guestfs.pod:1711
3329 "If no callback is registered: the handle is closed without any callback "
3334 #: ../src/guestfs.pod:1714
3335 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3339 #: ../src/guestfs.pod:1717
3341 "The callback function will be called when the child process quits, either "
3342 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3343 "corresponds to a transition from any state to the CONFIG state)."
3347 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3348 msgid "If no callback is registered: the event is ignored."
3352 #: ../src/guestfs.pod:1723
3353 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3357 #: ../src/guestfs.pod:1726
3359 "The callback function will be called when the child process becomes ready "
3360 "first time after it has been launched. (This corresponds to a transition "
3361 "from LAUNCHING to the READY state)."
3365 #: ../src/guestfs.pod:1732
3366 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3370 #: ../src/guestfs.pod:1735
3372 "Some long-running operations can generate progress messages. If this "
3373 "callback is registered, then it will be called each time a progress message "
3374 "is generated (usually two seconds after the operation started, and three "
3375 "times per second thereafter until it completes, although the frequency may "
3376 "change in future versions)."
3380 #: ../src/guestfs.pod:1741
3382 "The callback receives in the payload four unsigned 64 bit numbers which are "
3383 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3387 #: ../src/guestfs.pod:1744
3389 "The units of C<total> are not defined, although for some operations C<total> "
3390 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3391 "or megabytes), and C<position> may be the portion which has been "
3396 #: ../src/guestfs.pod:1749
3397 msgid "The only defined and stable parts of the API are:"
3401 #: ../src/guestfs.pod:1755
3403 "The callback can display to the user some type of progress bar or indicator "
3404 "which shows the ratio of C<position>:C<total>."
3408 #: ../src/guestfs.pod:1760
3409 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3413 #: ../src/guestfs.pod:1764
3415 "If any progress notification is sent during a call, then a final progress "
3416 "notification is always sent when C<position> = C<total> (I<unless> the call "
3417 "fails with an error)."
3421 #: ../src/guestfs.pod:1768
3423 "This is to simplify caller code, so callers can easily set the progress "
3424 "indicator to \"100%\" at the end of the operation, without requiring special "
3425 "code to detect this case."
3429 #: ../src/guestfs.pod:1774
3431 "For some calls we are unable to estimate the progress of the call, but we "
3432 "can still generate progress messages to indicate activity. This is known as "
3433 "\"pulse mode\", and is directly supported by certain progress bar "
3434 "implementations (eg. GtkProgressBar)."
3438 #: ../src/guestfs.pod:1779
3440 "For these calls, zero or more progress messages are generated with "
3441 "C<position = 0> and C<total = 1>, followed by a final message with "
3442 "C<position = total = 1>."
3446 #: ../src/guestfs.pod:1783
3448 "As noted above, if the call fails with an error then the final message may "
3453 #: ../src/guestfs.pod:1788
3455 "The callback also receives the procedure number (C<proc_nr>) and serial "
3456 "number (C<serial>) of the call. These are only useful for debugging "
3457 "protocol issues, and the callback can normally ignore them. The callback "
3458 "may want to print these numbers in error messages or debugging messages."
3462 #: ../src/guestfs.pod:1794
3463 msgid "If no callback is registered: progress messages are discarded."
3467 #: ../src/guestfs.pod:1796
3468 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3472 #: ../src/guestfs.pod:1799
3474 "The callback function is called whenever a log message is generated by qemu, "
3475 "the appliance kernel, guestfsd (daemon), or utility programs."
3479 #: ../src/guestfs.pod:1802
3481 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3482 "(L</guestfs_launch>) then additional debug messages are generated."
3486 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3488 "If no callback is registered: the messages are discarded unless the verbose "
3489 "flag is set in which case they are sent to stderr. You can override the "
3490 "printing of verbose messages to stderr by setting up a callback."
3494 #: ../src/guestfs.pod:1810
3495 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1813
3501 "The callback function is called whenever a log message is generated by the "
3502 "library part of libguestfs."
3506 #: ../src/guestfs.pod:1816
3508 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3509 "messages are generated."
3513 #: ../src/guestfs.pod:1824
3514 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3518 #: ../src/guestfs.pod:1827
3520 "The callback function is called whenever a trace message is generated. This "
3521 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3525 #: ../src/guestfs.pod:1830
3527 "If no callback is registered: the messages are sent to stderr. You can "
3528 "override the printing of trace messages to stderr by setting up a callback."
3532 #: ../src/guestfs.pod:1836
3533 msgid "guestfs_set_event_callback"
3537 #: ../src/guestfs.pod:1838
3540 " int guestfs_set_event_callback (guestfs_h *g,\n"
3541 " guestfs_event_callback cb,\n"
3542 " uint64_t event_bitmask,\n"
3549 #: ../src/guestfs.pod:1844
3551 "This function registers a callback (C<cb>) for all event classes in the "
3556 #: ../src/guestfs.pod:1847
3558 "For example, to register for all log message events, you could call this "
3559 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3560 "To register a single callback for all possible classes of events, use "
3561 "C<GUESTFS_EVENT_ALL>."
3565 #: ../src/guestfs.pod:1853
3566 msgid "C<flags> should always be passed as 0."
3570 #: ../src/guestfs.pod:1855
3572 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3573 "it for any purpose."
3577 #: ../src/guestfs.pod:1858
3579 "The return value is the event handle (an integer) which you can use to "
3580 "delete the callback (see below)."
3584 #: ../src/guestfs.pod:1861
3586 "If there is an error, this function returns C<-1>, and sets the error in the "
3587 "handle in the usual way (see L</guestfs_last_error> etc.)"
3591 #: ../src/guestfs.pod:1864
3593 "Callbacks remain in effect until they are deleted, or until the handle is "
3598 #: ../src/guestfs.pod:1867
3600 "In the case where multiple callbacks are registered for a particular event "
3601 "class, all of the callbacks are called. The order in which multiple "
3602 "callbacks are called is not defined."
3606 #: ../src/guestfs.pod:1871
3607 msgid "guestfs_delete_event_callback"
3611 #: ../src/guestfs.pod:1873
3614 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3619 #: ../src/guestfs.pod:1875
3621 "Delete a callback that was previously registered. C<event_handle> should be "
3622 "the integer that was returned by a previous call to "
3623 "C<guestfs_set_event_callback> on the same handle."
3627 #: ../src/guestfs.pod:1879
3628 msgid "guestfs_event_callback"
3632 #: ../src/guestfs.pod:1881
3635 " typedef void (*guestfs_event_callback) (\n"
3638 " uint64_t event,\n"
3639 " int event_handle,\n"
3641 " const char *buf, size_t buf_len,\n"
3642 " const uint64_t *array, size_t array_len);\n"
3647 #: ../src/guestfs.pod:1890
3648 msgid "This is the type of the event callback function that you have to provide."
3652 #: ../src/guestfs.pod:1893
3654 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3655 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3656 "handle, and C<flags> which in the current API you should ignore."
3660 #: ../src/guestfs.pod:1897
3662 "The remaining parameters contain the event payload (if any). Each event may "
3663 "contain a payload, which usually relates to the event class, but for future "
3664 "proofing your code should be written to handle any payload for any event "
3669 #: ../src/guestfs.pod:1902
3671 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3672 "there is no message buffer). Note that this message buffer can contain "
3673 "arbitrary 8 bit data, including NUL bytes."
3677 #: ../src/guestfs.pod:1906
3679 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3680 "moment this is only used for progress messages."
3684 #: ../src/guestfs.pod:1909
3685 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3689 #: ../src/guestfs.pod:1911
3691 "One motivation for the generic event API was to allow GUI programs to "
3692 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3693 "unconditionally to C<stderr>."
3697 #: ../src/guestfs.pod:1915
3699 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3700 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3701 "messages are not events; you must capture error messages separately)."
3705 #: ../src/guestfs.pod:1920
3707 "Programs have to set up a callback to capture the classes of events of "
3712 #: ../src/guestfs.pod:1923
3716 " guestfs_set_event_callback\n"
3717 " (g, message_callback,\n"
3718 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3719 " GUESTFS_EVENT_TRACE,\n"
3720 " 0, NULL) == -1)\n"
3721 " if (eh == -1) {\n"
3722 " // handle error in the usual way\n"
3728 #: ../src/guestfs.pod:1933
3730 "The callback can then direct messages to the appropriate place. In this "
3731 "example, messages are directed to syslog:"
3735 #: ../src/guestfs.pod:1936
3739 " message_callback (\n"
3742 " uint64_t event,\n"
3743 " int event_handle,\n"
3745 " const char *buf, size_t buf_len,\n"
3746 " const uint64_t *array, size_t array_len)\n"
3748 " const int priority = LOG_USER|LOG_INFO;\n"
3749 " if (buf_len > 0)\n"
3750 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3756 #: ../src/guestfs.pod:1951
3757 msgid "PRIVATE DATA AREA"
3761 #: ../src/guestfs.pod:1953
3763 "You can attach named pieces of private data to the libguestfs handle, fetch "
3764 "them by name, and walk over them, for the lifetime of the handle. This is "
3765 "called the private data area and is only available from the C API."
3769 #: ../src/guestfs.pod:1958
3770 msgid "To attach a named piece of data, use the following call:"
3774 #: ../src/guestfs.pod:1960
3777 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3782 #: ../src/guestfs.pod:1962
3784 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3785 "pointer (which can be C<NULL>). Any previous item with the same key is "
3790 #: ../src/guestfs.pod:1966
3792 "You can use any C<key> you want, but your key should I<not> start with an "
3793 "underscore character. Keys beginning with an underscore character are "
3794 "reserved for internal libguestfs purposes (eg. for implementing language "
3795 "bindings). It is recommended that you prefix the key with some unique "
3796 "string to avoid collisions with other users."
3800 #: ../src/guestfs.pod:1972
3801 msgid "To retrieve the pointer, use:"
3805 #: ../src/guestfs.pod:1974
3808 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3813 #: ../src/guestfs.pod:1976
3815 "This function returns C<NULL> if either no data is found associated with "
3816 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3821 #: ../src/guestfs.pod:1980
3823 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3824 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3825 "all. In particular, libguestfs does I<not> try to free the data when the "
3826 "handle is closed. If the data must be freed, then the caller must either "
3827 "free it before calling L</guestfs_close> or must set up a close callback to "
3828 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3832 #: ../src/guestfs.pod:1987
3833 msgid "To walk over all entries, use these two functions:"
3837 #: ../src/guestfs.pod:1989
3840 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3845 #: ../src/guestfs.pod:1991
3848 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3853 #: ../src/guestfs.pod:1993
3855 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3856 "not have any particular meaning -- keys are not returned in any defined "
3857 "order). A pointer to the key is returned in C<*key_rtn> and the "
3858 "corresponding data pointer is returned from the function. C<NULL> is "
3859 "returned if there are no keys stored in the handle."
3863 #: ../src/guestfs.pod:1999
3865 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3866 "value of this function is also C<NULL> is there are no further entries to "
3871 #: ../src/guestfs.pod:2003
3872 msgid "Notes about walking over entries:"
3876 #: ../src/guestfs.pod:2009
3877 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3881 #: ../src/guestfs.pod:2014
3883 "The handle maintains an internal iterator which is reset when you call "
3884 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3885 "call C<guestfs_set_private>."
3889 #: ../src/guestfs.pod:2020
3890 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3894 #: ../src/guestfs.pod:2022
3897 " guestfs_set_private (g, key, NULL);\n"
3902 #: ../src/guestfs.pod:2024
3903 msgid "then that C<key> is not returned when walking."
3907 #: ../src/guestfs.pod:2028
3909 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3910 "C<guestfs_next_private> or C<guestfs_set_private>."
3914 #: ../src/guestfs.pod:2034
3916 "The following example code shows how to print all keys and data pointers "
3917 "that are associated with the handle C<g>:"
3921 #: ../src/guestfs.pod:2037
3924 " const char *key;\n"
3925 " void *data = guestfs_first_private (g, &key);\n"
3926 " while (data != NULL)\n"
3928 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3929 " data = guestfs_next_private (g, &key);\n"
3935 #: ../src/guestfs.pod:2045
3937 "More commonly you are only interested in keys that begin with an "
3938 "application-specific prefix C<foo_>. Modify the loop like so:"
3942 #: ../src/guestfs.pod:2048
3945 " const char *key;\n"
3946 " void *data = guestfs_first_private (g, &key);\n"
3947 " while (data != NULL)\n"
3949 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3950 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3951 " data = guestfs_next_private (g, &key);\n"
3957 #: ../src/guestfs.pod:2057
3959 "If you need to modify keys while walking, then you have to jump back to the "
3960 "beginning of the loop. For example, to delete all keys prefixed with "
3965 #: ../src/guestfs.pod:2061
3968 " const char *key;\n"
3971 " data = guestfs_first_private (g, &key);\n"
3972 " while (data != NULL)\n"
3974 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3976 " guestfs_set_private (g, key, NULL);\n"
3977 " /* note that 'key' pointer is now invalid, and so is\n"
3978 " the internal iterator */\n"
3981 " data = guestfs_next_private (g, &key);\n"
3987 #: ../src/guestfs.pod:2077
3989 "Note that the above loop is guaranteed to terminate because the keys are "
3990 "being deleted, but other manipulations of keys within the loop might not "
3991 "terminate unless you also maintain an indication of which keys have been "
3996 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4001 #: ../src/guestfs.pod:2084
4003 "<!-- old anchor for the next section --> <a "
4004 "name=\"state_machine_and_low_level_event_api\"/>"
4008 #: ../src/guestfs.pod:2089
4009 msgid "ARCHITECTURE"
4013 #: ../src/guestfs.pod:2091
4015 "Internally, libguestfs is implemented by running an appliance (a special "
4016 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4017 "process of the main program."
4021 #: ../src/guestfs.pod:2095
4024 " ___________________\n"
4026 " | main program |\n"
4028 " | | child process / appliance\n"
4029 " | | __________________________\n"
4031 " +-------------------+ RPC | +-----------------+ |\n"
4032 " | libguestfs <--------------------> guestfsd | |\n"
4033 " | | | +-----------------+ |\n"
4034 " \\___________________/ | | Linux kernel | |\n"
4035 " | +--^--------------+ |\n"
4036 " \\_________|________________/\n"
4042 " \\______________/\n"
4047 #: ../src/guestfs.pod:2115
4049 "The library, linked to the main program, creates the child process and hence "
4050 "the appliance in the L</guestfs_launch> function."
4054 #: ../src/guestfs.pod:2118
4056 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4057 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4058 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4059 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4060 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4061 "attached to the qemu process which translates device access by the "
4062 "appliance's Linux kernel into accesses to the image."
4066 #: ../src/guestfs.pod:2127
4068 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4069 "Although the disk image you are attached to might also be used by some "
4070 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4071 "care if both libguestfs's qemu process and your virtual machine are trying "
4072 "to update the disk image at the same time, since these usually results in "
4073 "massive disk corruption)."
4077 #: ../src/guestfs.pod:2134
4078 msgid "STATE MACHINE"
4082 #: ../src/guestfs.pod:2136
4083 msgid "libguestfs uses a state machine to model the child process:"
4087 #: ../src/guestfs.pod:2138
4099 " / | \\ \\ guestfs_launch\n"
4100 " / | _\\__V______\n"
4102 " / | | LAUNCHING |\n"
4103 " / | \\___________/\n"
4105 " / | guestfs_launch\n"
4107 " ______ / __|____V\n"
4108 " / \\ ------> / \\\n"
4109 " | BUSY | | READY |\n"
4110 " \\______/ <------ \\________/\n"
4115 #: ../src/guestfs.pod:2160
4117 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4118 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4119 "(3) alternating between READY and BUSY as commands are issued to, and "
4120 "carried out by, the child process."
4124 #: ../src/guestfs.pod:2165
4126 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4127 "asynchronously at any time (eg. due to some internal error), and that causes "
4128 "the state to transition back to CONFIG."
4132 #: ../src/guestfs.pod:2169
4134 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4135 "issued when in the CONFIG state."
4139 #: ../src/guestfs.pod:2172
4141 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4142 "L</guestfs_launch> blocks until the child process is READY to accept "
4143 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4144 "moves the state from CONFIG to LAUNCHING while it is running."
4148 #: ../src/guestfs.pod:2178
4150 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4151 "state. These API calls block waiting for the command to be carried out "
4152 "(ie. the state to transition to BUSY and then back to READY). There are no "
4153 "non-blocking versions, and no way to issue more than one command per handle "
4158 #: ../src/guestfs.pod:2184
4160 "Finally, the child process sends asynchronous messages back to the main "
4161 "program, such as kernel log messages. You can register a callback to "
4162 "receive these messages."
4166 #: ../src/guestfs.pod:2188
4171 #: ../src/guestfs.pod:2190
4172 msgid "COMMUNICATION PROTOCOL"
4176 #: ../src/guestfs.pod:2192
4178 "Don't rely on using this protocol directly. This section documents how it "
4179 "currently works, but it may change at any time."
4183 #: ../src/guestfs.pod:2195
4185 "The protocol used to talk between the library and the daemon running inside "
4186 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4187 "1014, RFC 1832, RFC 4506)."
4191 #: ../src/guestfs.pod:2199
4193 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4194 "this file is automatically generated)."
4198 #: ../src/guestfs.pod:2202
4200 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4201 "and C<FileOut> parameters, which are handled with very simple request/reply "
4202 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4203 "parameters, which use the same request and reply messages, but they may also "
4204 "be followed by files sent using a chunked encoding."
4208 #: ../src/guestfs.pod:2209
4209 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4213 #: ../src/guestfs.pod:2211
4214 msgid "For ordinary functions, the request message is:"
4218 #: ../src/guestfs.pod:2213
4221 " total length (header + arguments,\n"
4222 " but not including the length word itself)\n"
4223 " struct guestfs_message_header (encoded as XDR)\n"
4224 " struct guestfs_<foo>_args (encoded as XDR)\n"
4229 #: ../src/guestfs.pod:2218
4231 "The total length field allows the daemon to allocate a fixed size buffer "
4232 "into which it slurps the rest of the message. As a result, the total length "
4233 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4234 "effective size of any request is limited to somewhere under this size."
4238 #: ../src/guestfs.pod:2224
4240 "Note also that many functions don't take any arguments, in which case the "
4241 "C<guestfs_I<foo>_args> is completely omitted."
4245 #: ../src/guestfs.pod:2227
4247 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4248 "receiver knows what type of args structure to expect, or none at all."
4252 #: ../src/guestfs.pod:2231
4254 "For functions that take optional arguments, the optional arguments are "
4255 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4256 "arguments. A bitmask in the header indicates which optional arguments are "
4257 "meaningful. The bitmask is also checked to see if it contains bits set "
4258 "which the daemon does not know about (eg. if more optional arguments were "
4259 "added in a later version of the library), and this causes the call to be "
4264 #: ../src/guestfs.pod:2239
4265 msgid "The reply message for ordinary functions is:"
4269 #: ../src/guestfs.pod:2241
4272 " total length (header + ret,\n"
4273 " but not including the length word itself)\n"
4274 " struct guestfs_message_header (encoded as XDR)\n"
4275 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4280 #: ../src/guestfs.pod:2246
4282 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4283 "functions that return no formal return values."
4287 #: ../src/guestfs.pod:2249
4288 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4292 #: ../src/guestfs.pod:2252
4294 "In the case of an error, a flag is set in the header, and the reply message "
4295 "is slightly changed:"
4299 #: ../src/guestfs.pod:2255
4302 " total length (header + error,\n"
4303 " but not including the length word itself)\n"
4304 " struct guestfs_message_header (encoded as XDR)\n"
4305 " struct guestfs_message_error (encoded as XDR)\n"
4310 #: ../src/guestfs.pod:2260
4312 "The C<guestfs_message_error> structure contains the error message as a "
4317 #: ../src/guestfs.pod:2263
4318 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4322 #: ../src/guestfs.pod:2265
4324 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4325 "The normal request message is sent (see above). However this is followed by "
4326 "a sequence of file chunks."
4330 #: ../src/guestfs.pod:2269
4333 " total length (header + arguments,\n"
4334 " but not including the length word itself,\n"
4335 " and not including the chunks)\n"
4336 " struct guestfs_message_header (encoded as XDR)\n"
4337 " struct guestfs_<foo>_args (encoded as XDR)\n"
4338 " sequence of chunks for FileIn param #0\n"
4339 " sequence of chunks for FileIn param #1 etc.\n"
4344 #: ../src/guestfs.pod:2277
4345 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:2279
4352 " length of chunk (not including length word itself)\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (encoded as XDR)\n"
4357 " length of chunk\n"
4358 " struct guestfs_chunk (with data.data_len == 0)\n"
4363 #: ../src/guestfs.pod:2287
4365 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4366 "is set in the final chunk to indicate either successful completion or early "
4371 #: ../src/guestfs.pod:2291
4373 "At time of writing there are no functions that have more than one FileIn "
4374 "parameter. However this is (theoretically) supported, by sending the "
4375 "sequence of chunks for each FileIn parameter one after another (from left to "
4380 #: ../src/guestfs.pod:2296
4382 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4383 "transfer. The library does this by sending a chunk with a special flag set "
4384 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4385 "RPC, does I<not> send any reply, and goes back to reading the next request."
4389 #: ../src/guestfs.pod:2302
4391 "The daemon may also cancel. It does this by writing a special word "
4392 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4393 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4394 "cancel chunk). The special word is chosen so that even if cancellation "
4395 "happens right at the end of the transfer (after the library has finished "
4396 "writing and has started listening for the reply), the \"spurious\" cancel "
4397 "flag will not be confused with the reply message."
4401 #: ../src/guestfs.pod:2311
4403 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4404 "limit), and also files where the size is not known in advance (eg. from "
4405 "pipes or sockets). However the chunks are rather small "
4406 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4407 "to keep much in memory."
4411 #: ../src/guestfs.pod:2317
4412 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4416 #: ../src/guestfs.pod:2319
4418 "The protocol for FileOut parameters is exactly the same as for FileIn "
4419 "parameters, but with the roles of daemon and library reversed."
4423 #: ../src/guestfs.pod:2322
4426 " total length (header + ret,\n"
4427 " but not including the length word itself,\n"
4428 " and not including the chunks)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4431 " sequence of chunks for FileOut param #0\n"
4432 " sequence of chunks for FileOut param #1 etc.\n"
4437 #: ../src/guestfs.pod:2330
4438 msgid "INITIAL MESSAGE"
4442 #: ../src/guestfs.pod:2332
4444 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4445 "which indicates that the guest and daemon is alive. This is what "
4446 "L</guestfs_launch> waits for."
4450 #: ../src/guestfs.pod:2336
4451 msgid "PROGRESS NOTIFICATION MESSAGES"
4455 #: ../src/guestfs.pod:2338
4457 "The daemon may send progress notification messages at any time. These are "
4458 "distinguished by the normal length word being replaced by "
4459 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4463 #: ../src/guestfs.pod:2342
4465 "The library turns them into progress callbacks (see "
4466 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4471 #: ../src/guestfs.pod:2346
4473 "The daemon self-limits the frequency of progress messages it sends (see "
4474 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4479 #: ../src/guestfs.pod:2350
4480 msgid "LIBGUESTFS VERSION NUMBERS"
4484 #: ../src/guestfs.pod:2352
4486 "Since April 2010, libguestfs has started to make separate development and "
4487 "stable releases, along with corresponding branches in our git repository. "
4488 "These separate releases can be identified by version number:"
4492 #: ../src/guestfs.pod:2357
4495 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4496 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4502 " | `-------- sub-version\n"
4504 " `------ always '1' because we don't change the ABI\n"
4509 #: ../src/guestfs.pod:2368
4510 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4514 #: ../src/guestfs.pod:2370
4516 "As time passes we cherry pick fixes from the development branch and backport "
4517 "those into the stable branch, the effect being that the stable branch should "
4518 "get more stable and less buggy over time. So the stable releases are ideal "
4519 "for people who don't need new features but would just like the software to "
4524 #: ../src/guestfs.pod:2376
4525 msgid "Our criteria for backporting changes are:"
4529 #: ../src/guestfs.pod:2382
4531 "Documentation changes which don't affect any code are backported unless the "
4532 "documentation refers to a future feature which is not in stable."
4536 #: ../src/guestfs.pod:2388
4538 "Bug fixes which are not controversial, fix obvious problems, and have been "
4539 "well tested are backported."
4543 #: ../src/guestfs.pod:2393
4545 "Simple rearrangements of code which shouldn't affect how it works get "
4546 "backported. This is so that the code in the two branches doesn't get too "
4547 "far out of step, allowing us to backport future fixes more easily."
4551 #: ../src/guestfs.pod:2399
4553 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4554 "exceptional case: the new feature is required in order to implement an "
4555 "important bug fix."
4559 #: ../src/guestfs.pod:2405
4561 "A new stable branch starts when we think the new features in development are "
4562 "substantial and compelling enough over the current stable branch to warrant "
4563 "it. When that happens we create new stable and development versions 1.N.0 "
4564 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4565 "stable at this point, but by backporting fixes from development, that branch "
4566 "will stabilize over time."
4570 #: ../src/guestfs.pod:2413
4571 msgid "EXTENDING LIBGUESTFS"
4575 #: ../src/guestfs.pod:2415
4576 msgid "ADDING A NEW API ACTION"
4580 #: ../src/guestfs.pod:2417
4582 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4583 "documentation) are generated, and this makes it easy to extend the "
4588 #: ../src/guestfs.pod:2421
4589 msgid "To add a new API action there are two changes:"
4593 #: ../src/guestfs.pod:2427
4595 "You need to add a description of the call (name, parameters, return type, "
4596 "tests, documentation) to C<generator/generator_actions.ml>."
4600 #: ../src/guestfs.pod:2430
4602 "There are two sorts of API action, depending on whether the call goes "
4603 "through to the daemon in the appliance, or is serviced entirely by the "
4604 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4605 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4606 "an example of the latter, since a trace flag is maintained in the handle and "
4607 "all tracing is done on the library side."
4611 #: ../src/guestfs.pod:2438
4613 "Most new actions are of the first type, and get added to the "
4614 "C<daemon_functions> list. Each function has a unique procedure number used "
4615 "in the RPC protocol which is assigned to that action when we publish "
4616 "libguestfs and cannot be reused. Take the latest procedure number and "
4621 #: ../src/guestfs.pod:2444
4623 "For library-only actions of the second type, add to the "
4624 "C<non_daemon_functions> list. Since these functions are serviced by the "
4625 "library and do not travel over the RPC mechanism to the daemon, these "
4626 "functions do not need a procedure number, and so the procedure number is set "
4631 #: ../src/guestfs.pod:2452
4632 msgid "Implement the action (in C):"
4636 #: ../src/guestfs.pod:2454
4638 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4639 "C<daemon/> directory."
4643 #: ../src/guestfs.pod:2457
4645 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4646 "(note: double underscore) in the C<src/> directory."
4650 #: ../src/guestfs.pod:2460
4651 msgid "In either case, use another function as an example of what to do."
4655 #: ../src/guestfs.pod:2464
4656 msgid "After making these changes, use C<make> to compile."
4660 #: ../src/guestfs.pod:2466
4662 "Note that you don't need to implement the RPC, language bindings, manual "
4663 "pages or anything else. It's all automatically generated from the OCaml "
4668 #: ../src/guestfs.pod:2470
4669 msgid "ADDING TESTS FOR AN API ACTION"
4673 #: ../src/guestfs.pod:2472
4675 "You can supply zero or as many tests as you want per API call. The tests "
4676 "can either be added as part of the API description "
4677 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4678 "drop a script into C<regressions/>. Note that adding a script to "
4679 "C<regressions/> is slower, so if possible use the first method."
4683 #: ../src/guestfs.pod:2478
4685 "The following describes the test environment used when you add an API test "
4686 "in C<generator_actions.ml>."
4690 #: ../src/guestfs.pod:2481
4691 msgid "The test environment has 4 block devices:"
4695 #: ../src/guestfs.pod:2485
4696 msgid "C</dev/sda> 500MB"
4700 #: ../src/guestfs.pod:2487
4701 msgid "General block device for testing."
4705 #: ../src/guestfs.pod:2489
4706 msgid "C</dev/sdb> 50MB"
4710 #: ../src/guestfs.pod:2491
4712 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4717 #: ../src/guestfs.pod:2494
4718 msgid "C</dev/sdc> 10MB"
4722 #: ../src/guestfs.pod:2496
4723 msgid "Used in a few tests where two block devices are needed."
4727 #: ../src/guestfs.pod:2498
4732 #: ../src/guestfs.pod:2500
4733 msgid "ISO with fixed content (see C<images/test.iso>)."
4737 #: ../src/guestfs.pod:2504
4739 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4740 "appliance and block devices are reused between tests. So don't try testing "
4741 "L</guestfs_kill_subprocess> :-x"
4745 #: ../src/guestfs.pod:2508
4747 "Each test starts with an initial scenario, selected using one of the "
4748 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4749 "initialize the disks mentioned above in a particular way as documented in "
4750 "C<generator_types.ml>. You should not assume anything about the previous "
4751 "contents of other disks that are not initialized."
4755 #: ../src/guestfs.pod:2514
4757 "You can add a prerequisite clause to any individual test. This is a "
4758 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4759 "if testing a command which might not work on all variations of libguestfs "
4760 "builds. A test that has prerequisite of C<Always> means to run "
4765 #: ../src/guestfs.pod:2520
4767 "In addition, packagers can skip individual tests by setting environment "
4768 "variables before running C<make check>."
4772 #: ../src/guestfs.pod:2523
4775 " SKIP_TEST_<CMD>_<NUM>=1\n"
4780 #: ../src/guestfs.pod:2525
4781 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4785 #: ../src/guestfs.pod:2527
4790 #: ../src/guestfs.pod:2529
4793 " SKIP_TEST_<CMD>=1\n"
4798 #: ../src/guestfs.pod:2531
4799 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4803 #: ../src/guestfs.pod:2533
4804 msgid "Packagers can run only certain tests by setting for example:"
4808 #: ../src/guestfs.pod:2535
4811 " TEST_ONLY=\"vfs_type zerofree\"\n"
4816 #: ../src/guestfs.pod:2537
4818 "See C<capitests/tests.c> for more details of how these environment variables "
4823 #: ../src/guestfs.pod:2540
4824 msgid "DEBUGGING NEW API ACTIONS"
4828 #: ../src/guestfs.pod:2542
4829 msgid "Test new actions work before submitting them."
4833 #: ../src/guestfs.pod:2544
4834 msgid "You can use guestfish to try out new commands."
4838 #: ../src/guestfs.pod:2546
4840 "Debugging the daemon is a problem because it runs inside a minimal "
4841 "environment. However you can fprintf messages in the daemon to stderr, and "
4842 "they will show up if you use C<guestfish -v>."
4846 #: ../src/guestfs.pod:2550
4847 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4851 #: ../src/guestfs.pod:2552
4853 "Our C source code generally adheres to some basic code-formatting "
4854 "conventions. The existing code base is not totally consistent on this "
4855 "front, but we do prefer that contributed code be formatted similarly. In "
4856 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4857 "indentation level, and other than that, follow the K&R style."
4861 #: ../src/guestfs.pod:2558
4863 "If you use Emacs, add the following to one of one of your start-up files "
4864 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4868 #: ../src/guestfs.pod:2561
4871 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4872 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4873 " (add-hook 'find-file-hook\n"
4874 " '(lambda () (if (and buffer-file-name\n"
4875 " (string-match \"/libguestfs\\\\>\"\n"
4876 " (buffer-file-name))\n"
4877 " (not (string-equal mode-name \"Change Log\"))\n"
4878 " (not (string-equal mode-name \"Makefile\")))\n"
4879 " (setq indent-tabs-mode nil))))\n"
4884 #: ../src/guestfs.pod:2571
4887 " ;;; When editing C sources in libguestfs, use this style.\n"
4888 " (defun libguestfs-c-mode ()\n"
4889 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4891 " (c-set-style \"K&R\")\n"
4892 " (setq c-indent-level 2)\n"
4893 " (setq c-basic-offset 2))\n"
4894 " (add-hook 'c-mode-hook\n"
4895 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4896 " (buffer-file-name))\n"
4897 " (libguestfs-c-mode))))\n"
4902 #: ../src/guestfs.pod:2583
4903 msgid "Enable warnings when compiling (and fix any problems this finds):"
4907 #: ../src/guestfs.pod:2586
4910 " ./configure --enable-gcc-warnings\n"
4915 #: ../src/guestfs.pod:2588
4916 msgid "Useful targets are:"
4920 #: ../src/guestfs.pod:2590
4923 " make syntax-check # checks the syntax of the C code\n"
4924 " make check # runs the test suite\n"
4929 #: ../src/guestfs.pod:2593
4930 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4934 #: ../src/guestfs.pod:2595
4936 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4937 "which are used to do shell quoting."
4941 #: ../src/guestfs.pod:2600
4946 #: ../src/guestfs.pod:2602
4948 "Simple shell quoted string. Any spaces or other shell characters are "
4953 #: ../src/guestfs.pod:2605
4958 #: ../src/guestfs.pod:2607
4960 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4965 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
4966 msgid "For example:"
4970 #: ../src/guestfs.pod:2614
4973 " asprintf (&cmd, \"cat %R\", path);\n"
4978 #: ../src/guestfs.pod:2616
4979 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4983 #: ../src/guestfs.pod:2618
4985 "I<Note:> Do I<not> use these when you are passing parameters to the "
4986 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4987 "because they are not passed via the shell (instead, straight to exec). You "
4988 "probably want to use the C<sysroot_path()> function however."
4992 #: ../src/guestfs.pod:2624
4993 msgid "SUBMITTING YOUR NEW API ACTIONS"
4997 #: ../src/guestfs.pod:2626
4999 "Submit patches to the mailing list: "
5000 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5001 "L<rjones@redhat.com>."
5005 #: ../src/guestfs.pod:2630
5006 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5010 #: ../src/guestfs.pod:2632
5011 msgid "We support i18n (gettext anyhow) in the library."
5015 #: ../src/guestfs.pod:2634
5017 "However many messages come from the daemon, and we don't translate those at "
5018 "the moment. One reason is that the appliance generally has all locale files "
5019 "removed from it, because they take up a lot of space. So we'd have to readd "
5020 "some of those, as well as copying our PO files into the appliance."
5024 #: ../src/guestfs.pod:2640
5026 "Debugging messages are never translated, since they are intended for the "
5031 #: ../src/guestfs.pod:2643
5032 msgid "SOURCE CODE SUBDIRECTORIES"
5036 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
5037 msgid "C<appliance>"
5041 #: ../src/guestfs.pod:2649
5042 msgid "The libguestfs appliance, build scripts and so on."
5046 #: ../src/guestfs.pod:2651
5047 msgid "C<capitests>"
5051 #: ../src/guestfs.pod:2653
5052 msgid "Automated tests of the C API."
5056 #: ../src/guestfs.pod:2655
5061 #: ../src/guestfs.pod:2657
5063 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5068 #: ../src/guestfs.pod:2660
5073 #: ../src/guestfs.pod:2662
5075 "Safety and liveness tests of components that libguestfs depends upon (not of "
5076 "libguestfs itself). Mainly this is for qemu and the kernel."
5080 #: ../src/guestfs.pod:2665
5085 #: ../src/guestfs.pod:2667
5086 msgid "Outside contributions, experimental parts."
5090 #: ../src/guestfs.pod:2669
5095 #: ../src/guestfs.pod:2671
5097 "The daemon that runs inside the libguestfs appliance and carries out "
5102 #: ../src/guestfs.pod:2674
5107 #: ../src/guestfs.pod:2676
5108 msgid "L<virt-df(1)> command and documentation."
5112 #: ../src/guestfs.pod:2678
5117 #: ../src/guestfs.pod:2680
5118 msgid "C API example code."
5122 #: ../src/guestfs.pod:2682
5127 #: ../src/guestfs.pod:2684
5129 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5130 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5131 "L<virt-tar-out(1)>."
5135 #: ../src/guestfs.pod:2688
5140 #: ../src/guestfs.pod:2690
5141 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5145 #: ../src/guestfs.pod:2692
5146 msgid "C<generator>"
5150 #: ../src/guestfs.pod:2694
5152 "The crucially important generator, used to automatically generate large "
5153 "amounts of boilerplate C code for things like RPC and bindings."
5157 #: ../src/guestfs.pod:2697
5162 #: ../src/guestfs.pod:2699
5163 msgid "Files used by the test suite."
5167 #: ../src/guestfs.pod:2701
5168 msgid "Some \"phony\" guest images which we test against."
5172 #: ../src/guestfs.pod:2703
5173 msgid "C<inspector>"
5177 #: ../src/guestfs.pod:2705
5178 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5182 #: ../src/guestfs.pod:2707
5187 #: ../src/guestfs.pod:2709
5188 msgid "Logo used on the website. The fish is called Arthur by the way."
5192 #: ../src/guestfs.pod:2711
5197 #: ../src/guestfs.pod:2713
5198 msgid "M4 macros used by autoconf."
5202 #: ../src/guestfs.pod:2715
5207 #: ../src/guestfs.pod:2717
5208 msgid "Translations of simple gettext strings."
5212 #: ../src/guestfs.pod:2719
5217 #: ../src/guestfs.pod:2721
5219 "The build infrastructure and PO files for translations of manpages and POD "
5220 "files. Eventually this will be combined with the C<po> directory, but that "
5221 "is rather complicated."
5225 #: ../src/guestfs.pod:2725
5226 msgid "C<regressions>"
5230 #: ../src/guestfs.pod:2727
5231 msgid "Regression tests."
5235 #: ../src/guestfs.pod:2729
5240 #: ../src/guestfs.pod:2731
5241 msgid "L<virt-rescue(1)> command and documentation."
5245 #: ../src/guestfs.pod:2733
5250 #: ../src/guestfs.pod:2735
5251 msgid "Source code to the C library."
5255 #: ../src/guestfs.pod:2737
5260 #: ../src/guestfs.pod:2739
5261 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5265 #: ../src/guestfs.pod:2741
5266 msgid "C<test-tool>"
5270 #: ../src/guestfs.pod:2743
5272 "Test tool for end users to test if their qemu/kernel combination will work "
5277 #: ../src/guestfs.pod:2746
5282 #: ../src/guestfs.pod:2748
5287 #: ../src/guestfs.pod:2750
5292 #: ../src/guestfs.pod:2752
5297 #: ../src/guestfs.pod:2754
5302 #: ../src/guestfs.pod:2756
5307 #: ../src/guestfs.pod:2758
5312 #: ../src/guestfs.pod:2760
5317 #: ../src/guestfs.pod:2762
5318 msgid "Language bindings."
5322 #: ../src/guestfs.pod:2766
5327 #: ../src/guestfs.pod:2768
5328 msgid "PROTOCOL LIMITS"
5332 #: ../src/guestfs.pod:2770
5334 "Internally libguestfs uses a message-based protocol to pass API calls and "
5335 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5336 "plenty more detail about this). The maximum message size used by the "
5337 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5338 "aware of this limit. The API calls which may be affected are individually "
5339 "documented, with a link back to this section of the documentation."
5343 #: ../src/guestfs.pod:2778
5345 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5346 "a simple string. Because this string is at some point internally encoded as "
5347 "a message, the maximum size that it can return is slightly under 4 MB. If "
5348 "the requested file is larger than this then you will get an error."
5352 #: ../src/guestfs.pod:2784
5354 "In order to transfer large files into and out of the guest filesystem, you "
5355 "need to use particular calls that support this. The sections L</UPLOADING> "
5356 "and L</DOWNLOADING> document how to do this."
5360 #: ../src/guestfs.pod:2788
5362 "You might also consider mounting the disk image using our FUSE filesystem "
5363 "support (L<guestmount(1)>)."
5367 #: ../src/guestfs.pod:2791
5368 msgid "MAXIMUM NUMBER OF DISKS"
5372 #: ../src/guestfs.pod:2793
5373 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5377 #: ../src/guestfs.pod:2796
5379 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5380 "slots. However febootstrap only understands disks with names C</dev/vda> "
5381 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5386 #: ../src/guestfs.pod:2801
5388 "We are working to substantially raise this limit in future versions but it "
5389 "requires complex changes to qemu."
5393 #: ../src/guestfs.pod:2804
5395 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5396 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5397 "requires changes to qemu."
5401 #: ../src/guestfs.pod:2808
5402 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5406 #: ../src/guestfs.pod:2810
5407 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5411 #: ../src/guestfs.pod:2812
5413 "This is because it reserves 4 bits for the minor device number (thus "
5414 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5418 #: ../src/guestfs.pod:2815
5420 "If you attach a disk with more than 15 partitions, the extra partitions are "
5421 "ignored by libguestfs."
5425 #: ../src/guestfs.pod:2818
5426 msgid "MAXIMUM SIZE OF A DISK"
5430 #: ../src/guestfs.pod:2820
5431 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5435 #: ../src/guestfs.pod:2822
5437 "We have tested block devices up to 1 exabyte (2**60 or "
5438 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5443 #: ../src/guestfs.pod:2826
5445 "Although libguestfs probably does not impose any limit, the underlying host "
5446 "storage will. If you store disk images on a host ext4 filesystem, then the "
5447 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5448 "TB). If you store disk images as host logical volumes then you are limited "
5449 "by the maximum size of an LV."
5453 #: ../src/guestfs.pod:2832
5455 "For the hugest disk image files, we recommend using XFS on the host for "
5460 #: ../src/guestfs.pod:2835
5461 msgid "MAXIMUM SIZE OF A PARTITION"
5465 #: ../src/guestfs.pod:2837
5467 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5468 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5469 "address a partition located beyond 2 TB on the disk."
5473 #: ../src/guestfs.pod:2841
5475 "It is recommended that you use GPT partitions on disks which are larger than "
5476 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5477 "which are theoretically larger than the largest disk we could support."
5481 #: ../src/guestfs.pod:2846
5482 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5486 #: ../src/guestfs.pod:2848
5488 "This depends on the filesystem type. libguestfs itself does not impose any "
5489 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5490 "what these limits are."
5494 #: ../src/guestfs.pod:2852
5495 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5499 #: ../src/guestfs.pod:2854
5501 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5502 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5503 "uploads and downloads."
5507 #: ../src/guestfs.pod:2858
5508 msgid "INSPECTION LIMITS"
5512 #: ../src/guestfs.pod:2860
5514 "The inspection code has several arbitrary limits on things like the size of "
5515 "Windows Registry hive it will read, and the length of product name. These "
5516 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5517 "memory and disk space on the host, and should not be reached in practice. "
5518 "See the source code for more information."
5522 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1015 ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5523 msgid "ENVIRONMENT VARIABLES"
5527 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1041
5528 msgid "LIBGUESTFS_APPEND"
5532 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1043
5533 msgid "Pass additional options to the guest kernel."
5537 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1045
5538 msgid "LIBGUESTFS_DEBUG"
5542 #: ../src/guestfs.pod:2876
5544 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5545 "effect as calling C<guestfs_set_verbose (g, 1)>."
5549 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1050
5550 msgid "LIBGUESTFS_MEMSIZE"
5554 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1052
5555 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5559 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1055
5562 " LIBGUESTFS_MEMSIZE=700\n"
5567 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1057
5568 msgid "LIBGUESTFS_PATH"
5572 #: ../src/guestfs.pod:2888
5574 "Set the path that libguestfs uses to search for a supermin appliance. See "
5575 "the discussion of paths in section L</PATH> above."
5579 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1062
5580 msgid "LIBGUESTFS_QEMU"
5584 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1064
5586 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5587 "which was found at compile time by the configure script is used."
5591 #: ../src/guestfs.pod:2897
5592 msgid "See also L</QEMU WRAPPERS> above."
5596 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1068
5597 msgid "LIBGUESTFS_TRACE"
5601 #: ../src/guestfs.pod:2901
5603 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5604 "effect as calling C<guestfs_set_trace (g, 1)>."
5608 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1077
5613 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1079
5615 "Location of temporary directory, defaults to C</tmp> except for the cached "
5616 "supermin appliance which defaults to C</var/tmp>."
5620 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1082
5622 "If libguestfs was compiled to use the supermin appliance then the real "
5623 "appliance is cached in this directory, shared between all handles belonging "
5624 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5625 "use in case C</var/tmp> is not large enough."
5629 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1149 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277 ../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
5634 #: ../src/guestfs.pod:2919
5636 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5637 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5638 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5639 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5640 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5641 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5642 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5643 "L<http://libguestfs.org/>."
5647 #: ../src/guestfs.pod:2946
5649 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5650 "L<lvm(8)>, L<disktype(1)>."
5654 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5659 #: ../src/guestfs.pod:2955
5660 msgid "To get a list of bugs against libguestfs use this link:"
5664 #: ../src/guestfs.pod:2957
5665 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5669 #: ../src/guestfs.pod:2959
5670 msgid "To report a new bug against libguestfs use this link:"
5674 #: ../src/guestfs.pod:2961
5675 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5679 #: ../src/guestfs.pod:2963
5680 msgid "When reporting a bug, please check:"
5684 #: ../src/guestfs.pod:2969
5685 msgid "That the bug hasn't been reported already."
5689 #: ../src/guestfs.pod:2973
5690 msgid "That you are testing a recent version."
5694 #: ../src/guestfs.pod:2977
5695 msgid "Describe the bug accurately, and give a way to reproduce it."
5699 #: ../src/guestfs.pod:2981
5701 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5706 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1172 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5711 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1174 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
5712 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5716 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292 ../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
5721 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1178 ../test-tool/libguestfs-test-tool.pod:99
5722 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5726 #: ../src/guestfs.pod:2995
5728 "This library is free software; you can redistribute it and/or modify it "
5729 "under the terms of the GNU Lesser General Public License as published by the "
5730 "Free Software Foundation; either version 2 of the License, or (at your "
5731 "option) any later version."
5735 #: ../src/guestfs.pod:3000
5737 "This library is distributed in the hope that it will be useful, but WITHOUT "
5738 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5739 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5744 #: ../src/guestfs.pod:3005
5746 "You should have received a copy of the GNU Lesser General Public License "
5747 "along with this library; if not, write to the Free Software Foundation, "
5748 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5752 #: ../src/guestfs-actions.pod:1
5753 msgid "guestfs_add_cdrom"
5757 #: ../src/guestfs-actions.pod:3
5761 " guestfs_add_cdrom (guestfs_h *g,\n"
5762 " const char *filename);\n"
5767 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5768 msgid "This function adds a virtual CD-ROM disk image to the guest."
5772 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5773 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5777 #: ../src/guestfs-actions.pod:17
5779 "This call checks for the existence of C<filename>. This stops you from "
5780 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5781 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5786 #: ../src/guestfs-actions.pod:24
5788 "If you just want to add an ISO file (often you use this as an efficient way "
5789 "to transfer large files into the guest), then you should probably use "
5790 "C<guestfs_add_drive_ro> instead."
5794 #: ../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:1692 ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3743 ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3835 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:3968 ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4015 ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4067 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095 ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4205 ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4238 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4341 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4369 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4401 ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4479 ../src/guestfs-actions.pod:4552 ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4678 ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4728 ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4770 ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4801 ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4896 ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5204 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5332 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5723 ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:5858 ../src/guestfs-actions.pod:5881 ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:5958 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6046 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6478 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:7049 ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7149 ../src/guestfs-actions.pod:7194 ../src/guestfs-actions.pod:7227 ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7314 ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7428
5795 msgid "This function returns 0 on success or -1 on error."
5799 #: ../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
5801 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5806 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:6168 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7322 ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1316 ../fish/guestfish-actions.pod:1330 ../fish/guestfish-actions.pod:3005 ../fish/guestfish-actions.pod:3202 ../fish/guestfish-actions.pod:4183 ../fish/guestfish-actions.pod:4206 ../fish/guestfish-actions.pod:4228 ../fish/guestfish-actions.pod:4266 ../fish/guestfish-actions.pod:4907 ../fish/guestfish-actions.pod:5004
5808 "Deprecated functions will not be removed from the API, but the fact that "
5809 "they are deprecated indicates that there are problems with correct use of "
5814 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1913 ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:7236
5815 msgid "(Added in 0.3)"
5819 #: ../src/guestfs-actions.pod:41
5820 msgid "guestfs_add_domain"
5824 #: ../src/guestfs-actions.pod:43
5828 " guestfs_add_domain (guestfs_h *g,\n"
5829 " const char *dom,\n"
5835 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4440
5837 "You may supply a list of optional arguments to this call. Use zero or more "
5838 "of the following pairs of parameters, and terminate the list with C<-1> on "
5839 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5843 #: ../src/guestfs-actions.pod:53
5846 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5847 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5848 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5849 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5854 #: ../src/guestfs-actions.pod:58
5856 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5857 "It works by connecting to libvirt, requesting the domain and domain XML from "
5858 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5863 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5865 "The number of disks added is returned. This operation is atomic: if an "
5866 "error is returned, then no disks are added."
5870 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5872 "This function does some minimal checks to make sure the libvirt domain is "
5873 "not running (unless C<readonly> is true). In a future version we will try "
5874 "to acquire the libvirt lock on each disk."
5878 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5880 "Disks must be accessible locally. This often means that adding disks from a "
5881 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5882 "unless those disks are accessible via the same device path locally too."
5886 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5888 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5889 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5890 "default libvirt URI (or one set through an environment variable, see the "
5891 "libvirt documentation for full details)."
5895 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5897 "The optional C<live> flag controls whether this call will try to connect to "
5898 "a running virtual machine C<guestfsd> process if it sees a suitable "
5899 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5900 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5901 "DAEMONS> for more information."
5905 #: ../src/guestfs-actions.pod:88
5907 "The other optional parameters are passed directly through to "
5908 "C<guestfs_add_drive_opts>."
5912 #: ../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:1671 ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:4873 ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5416 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7273
5913 msgid "On error this function returns -1."
5917 #: ../src/guestfs-actions.pod:93
5918 msgid "(Added in 1.7.4)"
5922 #: ../src/guestfs-actions.pod:95
5923 msgid "guestfs_add_domain_va"
5927 #: ../src/guestfs-actions.pod:97
5931 " guestfs_add_domain_va (guestfs_h *g,\n"
5932 " const char *dom,\n"
5938 #: ../src/guestfs-actions.pod:102
5939 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5943 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4505
5944 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5948 #: ../src/guestfs-actions.pod:106
5949 msgid "guestfs_add_domain_argv"
5953 #: ../src/guestfs-actions.pod:108
5957 " guestfs_add_domain_argv (guestfs_h *g,\n"
5958 " const char *dom,\n"
5959 " const struct guestfs_add_domain_argv *optargs);\n"
5964 #: ../src/guestfs-actions.pod:113
5965 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5969 #: ../src/guestfs-actions.pod:117
5970 msgid "guestfs_add_drive"
5974 #: ../src/guestfs-actions.pod:119
5978 " guestfs_add_drive (guestfs_h *g,\n"
5979 " const char *filename);\n"
5984 #: ../src/guestfs-actions.pod:123
5986 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5987 "optional parameters, so the disk is added writable, with the format being "
5988 "detected automatically."
5992 #: ../src/guestfs-actions.pod:127
5994 "Automatic detection of the format opens you up to a potential security hole "
5995 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5996 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5997 "you should think about replacing calls to this function with calls to "
5998 "C<guestfs_add_drive_opts>, and specifying the format."
6002 #: ../src/guestfs-actions.pod:138
6003 msgid "guestfs_add_drive_opts"
6007 #: ../src/guestfs-actions.pod:140
6011 " guestfs_add_drive_opts (guestfs_h *g,\n"
6012 " const char *filename,\n"
6018 #: ../src/guestfs-actions.pod:150
6021 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6022 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6023 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6028 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6030 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6031 "The first time you call this function, the disk appears as C</dev/sda>, the "
6032 "second time as C</dev/sdb>, and so on."
6036 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6038 "You don't necessarily need to be root when using libguestfs. However you "
6039 "obviously do need sufficient permissions to access the filename for whatever "
6040 "operations you want to perform (ie. read access if you just want to read the "
6041 "image or write access if you want to modify the image)."
6045 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6046 msgid "This call checks that C<filename> exists."
6050 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3016
6051 msgid "The optional arguments are:"
6055 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6060 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6062 "If true then the image is treated as read-only. Writes are still allowed, "
6063 "but they are stored in a temporary snapshot overlay which is discarded at "
6064 "the end. The disk that you add is not modified."
6068 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6073 #: ../src/guestfs-actions.pod:179
6075 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6076 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6077 "Possible formats include C<raw> and C<qcow2>."
6081 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6083 "Automatic detection of the format opens you up to a potential security hole "
6084 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6085 "RHBZ#642934. Specifying the format closes this security hole."
6089 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6094 #: ../src/guestfs-actions.pod:190
6096 "This rarely-used option lets you emulate the behaviour of the deprecated "
6097 "C<guestfs_add_drive_with_if> call (q.v.)"
6101 #: ../src/guestfs-actions.pod:197
6102 msgid "(Added in 1.5.23)"
6106 #: ../src/guestfs-actions.pod:199
6107 msgid "guestfs_add_drive_opts_va"
6111 #: ../src/guestfs-actions.pod:201
6115 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6116 " const char *filename,\n"
6122 #: ../src/guestfs-actions.pod:206
6123 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6127 #: ../src/guestfs-actions.pod:210
6128 msgid "guestfs_add_drive_opts_argv"
6132 #: ../src/guestfs-actions.pod:212
6136 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6137 " const char *filename,\n"
6138 " const struct guestfs_add_drive_opts_argv "
6144 #: ../src/guestfs-actions.pod:217
6145 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6149 #: ../src/guestfs-actions.pod:221
6150 msgid "guestfs_add_drive_ro"
6154 #: ../src/guestfs-actions.pod:223
6158 " guestfs_add_drive_ro (guestfs_h *g,\n"
6159 " const char *filename);\n"
6164 #: ../src/guestfs-actions.pod:227
6166 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6167 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6168 "disk is added read-only, with the format being detected automatically."
6172 #: ../src/guestfs-actions.pod:234
6173 msgid "(Added in 1.0.38)"
6177 #: ../src/guestfs-actions.pod:236
6178 msgid "guestfs_add_drive_ro_with_if"
6182 #: ../src/guestfs-actions.pod:238
6186 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6187 " const char *filename,\n"
6188 " const char *iface);\n"
6193 #: ../src/guestfs-actions.pod:243
6195 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6196 "QEMU interface emulation to use at run time."
6200 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2353
6201 msgid "(Added in 1.0.84)"
6205 #: ../src/guestfs-actions.pod:257
6206 msgid "guestfs_add_drive_with_if"
6210 #: ../src/guestfs-actions.pod:259
6214 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6215 " const char *filename,\n"
6216 " const char *iface);\n"
6221 #: ../src/guestfs-actions.pod:264
6223 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6224 "QEMU interface emulation to use at run time."
6228 #: ../src/guestfs-actions.pod:278
6229 msgid "guestfs_aug_clear"
6233 #: ../src/guestfs-actions.pod:280
6237 " guestfs_aug_clear (guestfs_h *g,\n"
6238 " const char *augpath);\n"
6243 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6245 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6246 "L<augtool(1)> C<clear> command."
6250 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2103
6251 msgid "(Added in 1.3.4)"
6255 #: ../src/guestfs-actions.pod:291
6256 msgid "guestfs_aug_close"
6260 #: ../src/guestfs-actions.pod:293
6264 " guestfs_aug_close (guestfs_h *g);\n"
6269 #: ../src/guestfs-actions.pod:296
6271 "Close the current Augeas handle and free up any resources used by it. After "
6272 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6273 "any other Augeas functions."
6277 #: ../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:5493
6278 msgid "(Added in 0.7)"
6282 #: ../src/guestfs-actions.pod:305
6283 msgid "guestfs_aug_defnode"
6287 #: ../src/guestfs-actions.pod:307
6290 " struct guestfs_int_bool *\n"
6291 " guestfs_aug_defnode (guestfs_h *g,\n"
6292 " const char *name,\n"
6293 " const char *expr,\n"
6294 " const char *val);\n"
6299 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6300 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6304 #: ../src/guestfs-actions.pod:316
6306 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6307 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6308 "containing that single node."
6312 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6314 "On success this returns a pair containing the number of nodes in the "
6315 "nodeset, and a boolean flag if a node was created."
6319 #: ../src/guestfs-actions.pod:324
6321 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6322 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6326 #: ../src/guestfs-actions.pod:330
6327 msgid "guestfs_aug_defvar"
6331 #: ../src/guestfs-actions.pod:332
6335 " guestfs_aug_defvar (guestfs_h *g,\n"
6336 " const char *name,\n"
6337 " const char *expr);\n"
6342 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6344 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6345 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6349 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6351 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6352 "evaluates to something which is not a nodeset."
6356 #: ../src/guestfs-actions.pod:348
6357 msgid "guestfs_aug_get"
6361 #: ../src/guestfs-actions.pod:350
6365 " guestfs_aug_get (guestfs_h *g,\n"
6366 " const char *augpath);\n"
6371 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6373 "Look up the value associated with C<path>. If C<path> matches exactly one "
6374 "node, the C<value> is returned."
6378 #: ../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:1542 ../src/guestfs-actions.pod:1654 ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1834 ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:1956 ../src/guestfs-actions.pod:2126 ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:2869 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2924 ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3021 ../src/guestfs-actions.pod:3044 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5221 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5569 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7485
6380 "This function returns a string, or NULL on error. I<The caller must free "
6381 "the returned string after use>."
6385 #: ../src/guestfs-actions.pod:362
6386 msgid "guestfs_aug_init"
6390 #: ../src/guestfs-actions.pod:364
6394 " guestfs_aug_init (guestfs_h *g,\n"
6395 " const char *root,\n"
6401 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6403 "Create a new Augeas handle for editing configuration files. If there was "
6404 "any previous Augeas handle associated with this guestfs session, then it is "
6409 #: ../src/guestfs-actions.pod:373
6410 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6414 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6415 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6419 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6421 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6422 "logical I<or> of the following integers:"
6426 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6427 msgid "C<AUG_SAVE_BACKUP> = 1"
6431 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6432 msgid "Keep the original file with a C<.augsave> extension."
6436 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6437 msgid "C<AUG_SAVE_NEWFILE> = 2"
6441 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6443 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6444 "original. Overrides C<AUG_SAVE_BACKUP>."
6448 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6449 msgid "C<AUG_TYPE_CHECK> = 4"
6453 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6454 msgid "Typecheck lenses (can be expensive)."
6458 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6459 msgid "C<AUG_NO_STDINC> = 8"
6463 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6464 msgid "Do not use standard load path for modules."
6468 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6469 msgid "C<AUG_SAVE_NOOP> = 16"
6473 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6474 msgid "Make save a no-op, just record what would have been changed."
6478 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6479 msgid "C<AUG_NO_LOAD> = 32"
6483 #: ../src/guestfs-actions.pod:408
6484 msgid "Do not load the tree in C<guestfs_aug_init>."
6488 #: ../src/guestfs-actions.pod:412
6489 msgid "To close the handle, you can call C<guestfs_aug_close>."
6493 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6494 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6498 #: ../src/guestfs-actions.pod:420
6499 msgid "guestfs_aug_insert"
6503 #: ../src/guestfs-actions.pod:422
6507 " guestfs_aug_insert (guestfs_h *g,\n"
6508 " const char *augpath,\n"
6509 " const char *label,\n"
6515 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6517 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6518 "or after C<path> (depending on the boolean flag C<before>)."
6522 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6524 "C<path> must match exactly one existing node in the tree, and C<label> must "
6525 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6529 #: ../src/guestfs-actions.pod:440
6530 msgid "guestfs_aug_load"
6534 #: ../src/guestfs-actions.pod:442
6538 " guestfs_aug_load (guestfs_h *g);\n"
6543 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6544 msgid "Load files into the tree."
6548 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6549 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6553 #: ../src/guestfs-actions.pod:454
6554 msgid "guestfs_aug_ls"
6558 #: ../src/guestfs-actions.pod:456
6562 " guestfs_aug_ls (guestfs_h *g,\n"
6563 " const char *augpath);\n"
6568 #: ../src/guestfs-actions.pod:460
6570 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6571 "sorting the resulting nodes into alphabetical order."
6575 #: ../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:1756 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2978 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3724 ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7461 ../src/guestfs-actions.pod:7507 ../src/guestfs-actions.pod:7526
6577 "This function returns a NULL-terminated array of strings (like "
6578 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6579 "strings and the array after use>."
6583 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3376 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5699 ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:7083 ../src/guestfs-actions.pod:7326
6584 msgid "(Added in 0.8)"
6588 #: ../src/guestfs-actions.pod:469
6589 msgid "guestfs_aug_match"
6593 #: ../src/guestfs-actions.pod:471
6597 " guestfs_aug_match (guestfs_h *g,\n"
6598 " const char *augpath);\n"
6603 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6605 "Returns a list of paths which match the path expression C<path>. The "
6606 "returned paths are sufficiently qualified so that they match exactly one "
6607 "node in the current tree."
6611 #: ../src/guestfs-actions.pod:485
6612 msgid "guestfs_aug_mv"
6616 #: ../src/guestfs-actions.pod:487
6620 " guestfs_aug_mv (guestfs_h *g,\n"
6621 " const char *src,\n"
6622 " const char *dest);\n"
6627 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6629 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6630 "C<dest> is overwritten if it exists."
6634 #: ../src/guestfs-actions.pod:499
6635 msgid "guestfs_aug_rm"
6639 #: ../src/guestfs-actions.pod:501
6643 " guestfs_aug_rm (guestfs_h *g,\n"
6644 " const char *augpath);\n"
6649 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6650 msgid "Remove C<path> and all of its children."
6654 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6655 msgid "On success this returns the number of entries which were removed."
6659 #: ../src/guestfs-actions.pod:513
6660 msgid "guestfs_aug_save"
6664 #: ../src/guestfs-actions.pod:515
6668 " guestfs_aug_save (guestfs_h *g);\n"
6673 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6674 msgid "This writes all pending changes to disk."
6678 #: ../src/guestfs-actions.pod:520
6680 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6685 #: ../src/guestfs-actions.pod:527
6686 msgid "guestfs_aug_set"
6690 #: ../src/guestfs-actions.pod:529
6694 " guestfs_aug_set (guestfs_h *g,\n"
6695 " const char *augpath,\n"
6696 " const char *val);\n"
6701 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6702 msgid "Set the value associated with C<path> to C<val>."
6706 #: ../src/guestfs-actions.pod:536
6708 "In the Augeas API, it is possible to clear a node by setting the value to "
6709 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6710 "this call. Instead you must use the C<guestfs_aug_clear> call."
6714 #: ../src/guestfs-actions.pod:545
6715 msgid "guestfs_available"
6719 #: ../src/guestfs-actions.pod:547
6723 " guestfs_available (guestfs_h *g,\n"
6724 " char *const *groups);\n"
6729 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6731 "This command is used to check the availability of some groups of "
6732 "functionality in the appliance, which not all builds of the libguestfs "
6733 "appliance will be able to provide."
6737 #: ../src/guestfs-actions.pod:555
6739 "The libguestfs groups, and the functions that those groups correspond to, "
6740 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6741 "runtime by calling C<guestfs_available_all_groups>."
6745 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6747 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6748 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6749 "and Augeas (configuration file editing) functions."
6753 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6754 msgid "The command returns no error if I<all> requested groups are available."
6758 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6760 "It fails with an error if one or more of the requested groups is unavailable "
6765 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6767 "If an unknown group name is included in the list of groups then an error is "
6772 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6777 #: ../src/guestfs-actions.pod:579
6778 msgid "You must call C<guestfs_launch> before calling this function."
6782 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6784 "The reason is because we don't know what groups are supported by the "
6785 "appliance/daemon until it is running and can be queried."
6789 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6791 "If a group of functions is available, this does not necessarily mean that "
6792 "they will work. You still have to check for errors when calling individual "
6793 "API functions even if they are available."
6797 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6799 "It is usually the job of distro packagers to build complete functionality "
6800 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6801 "with all requirements satisfied, will support everything."
6805 #: ../src/guestfs-actions.pod:601
6807 "This call was added in version C<1.0.80>. In previous versions of "
6808 "libguestfs all you could do would be to speculatively execute a command to "
6809 "find out if the daemon implemented it. See also C<guestfs_version>."
6813 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6814 msgid "(Added in 1.0.80)"
6818 #: ../src/guestfs-actions.pod:612
6819 msgid "guestfs_available_all_groups"
6823 #: ../src/guestfs-actions.pod:614
6827 " guestfs_available_all_groups (guestfs_h *g);\n"
6832 #: ../src/guestfs-actions.pod:617
6834 "This command returns a list of all optional groups that this daemon knows "
6835 "about. Note this returns both supported and unsupported groups. To find "
6836 "out which ones the daemon can actually support you have to call "
6837 "C<guestfs_available> on each member of the returned list."
6841 #: ../src/guestfs-actions.pod:623
6842 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6846 #: ../src/guestfs-actions.pod:629
6847 msgid "(Added in 1.3.15)"
6851 #: ../src/guestfs-actions.pod:631
6852 msgid "guestfs_base64_in"
6856 #: ../src/guestfs-actions.pod:633
6860 " guestfs_base64_in (guestfs_h *g,\n"
6861 " const char *base64file,\n"
6862 " const char *filename);\n"
6867 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6868 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6872 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6873 msgid "(Added in 1.3.5)"
6877 #: ../src/guestfs-actions.pod:645
6878 msgid "guestfs_base64_out"
6882 #: ../src/guestfs-actions.pod:647
6886 " guestfs_base64_out (guestfs_h *g,\n"
6887 " const char *filename,\n"
6888 " const char *base64file);\n"
6893 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6895 "This command downloads the contents of C<filename>, writing it out to local "
6896 "file C<base64file> encoded as base64."
6900 #: ../src/guestfs-actions.pod:659
6901 msgid "guestfs_blockdev_flushbufs"
6905 #: ../src/guestfs-actions.pod:661
6909 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6910 " const char *device);\n"
6915 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6916 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6920 #: ../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
6921 msgid "This uses the L<blockdev(8)> command."
6925 #: ../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
6926 msgid "(Added in 0.9.3)"
6930 #: ../src/guestfs-actions.pod:674
6931 msgid "guestfs_blockdev_getbsz"
6935 #: ../src/guestfs-actions.pod:676
6939 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6940 " const char *device);\n"
6945 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6946 msgid "This returns the block size of a device."
6950 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6952 "(Note this is different from both I<size in blocks> and I<filesystem block "
6957 #: ../src/guestfs-actions.pod:691
6958 msgid "guestfs_blockdev_getro"
6962 #: ../src/guestfs-actions.pod:693
6966 " guestfs_blockdev_getro (guestfs_h *g,\n"
6967 " const char *device);\n"
6972 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6974 "Returns a boolean indicating if the block device is read-only (true if "
6975 "read-only, false if not)."
6979 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1911 ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:2112 ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3313 ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3343 ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3374 ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:4992
6980 msgid "This function returns a C truth value on success or -1 on error."
6984 #: ../src/guestfs-actions.pod:706
6985 msgid "guestfs_blockdev_getsize64"
6989 #: ../src/guestfs-actions.pod:708
6993 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6994 " const char *device);\n"
6999 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7000 msgid "This returns the size of the device in bytes."
7004 #: ../src/guestfs-actions.pod:714
7005 msgid "See also C<guestfs_blockdev_getsz>."
7009 #: ../src/guestfs-actions.pod:722
7010 msgid "guestfs_blockdev_getss"
7014 #: ../src/guestfs-actions.pod:724
7018 " guestfs_blockdev_getss (guestfs_h *g,\n"
7019 " const char *device);\n"
7024 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7026 "This returns the size of sectors on a block device. Usually 512, but can be "
7027 "larger for modern devices."
7031 #: ../src/guestfs-actions.pod:731
7033 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7038 #: ../src/guestfs-actions.pod:740
7039 msgid "guestfs_blockdev_getsz"
7043 #: ../src/guestfs-actions.pod:742
7047 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7048 " const char *device);\n"
7053 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7055 "This returns the size of the device in units of 512-byte sectors (even if "
7056 "the sectorsize isn't 512 bytes ... weird)."
7060 #: ../src/guestfs-actions.pod:749
7062 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7063 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7067 #: ../src/guestfs-actions.pod:759
7068 msgid "guestfs_blockdev_rereadpt"
7072 #: ../src/guestfs-actions.pod:761
7076 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7077 " const char *device);\n"
7082 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7083 msgid "Reread the partition table on C<device>."
7087 #: ../src/guestfs-actions.pod:773
7088 msgid "guestfs_blockdev_setbsz"
7092 #: ../src/guestfs-actions.pod:775
7096 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7097 " const char *device,\n"
7098 " int blocksize);\n"
7103 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7104 msgid "This sets the block size of a device."
7108 #: ../src/guestfs-actions.pod:791
7109 msgid "guestfs_blockdev_setro"
7113 #: ../src/guestfs-actions.pod:793
7117 " guestfs_blockdev_setro (guestfs_h *g,\n"
7118 " const char *device);\n"
7123 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7124 msgid "Sets the block device named C<device> to read-only."
7128 #: ../src/guestfs-actions.pod:805
7129 msgid "guestfs_blockdev_setrw"
7133 #: ../src/guestfs-actions.pod:807
7137 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7138 " const char *device);\n"
7143 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7144 msgid "Sets the block device named C<device> to read-write."
7148 #: ../src/guestfs-actions.pod:819
7149 msgid "guestfs_case_sensitive_path"
7153 #: ../src/guestfs-actions.pod:821
7157 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7158 " const char *path);\n"
7163 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7165 "This can be used to resolve case insensitive paths on a filesystem which is "
7166 "case sensitive. The use case is to resolve paths which you have read from "
7167 "Windows configuration files or the Windows Registry, to the true path."
7171 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7173 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7174 "(and probably others), which is that although the underlying filesystem is "
7175 "case-insensitive, the driver exports the filesystem to Linux as "
7180 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7182 "One consequence of this is that special directories such as C<c:\\windows> "
7183 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7184 "precise details of how they were created. In Windows itself this would not "
7189 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7191 "Bug or feature? You decide: "
7192 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7196 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7198 "This function resolves the true case of each element in the path and returns "
7199 "the case-sensitive path."
7203 #: ../src/guestfs-actions.pod:847
7205 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7206 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7207 "how the directories were originally created under Windows)."
7211 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7212 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7216 #: ../src/guestfs-actions.pod:855
7217 msgid "See also C<guestfs_realpath>."
7221 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:7011
7222 msgid "(Added in 1.0.75)"
7226 #: ../src/guestfs-actions.pod:862
7231 #: ../src/guestfs-actions.pod:864
7235 " guestfs_cat (guestfs_h *g,\n"
7236 " const char *path);\n"
7241 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3680
7242 msgid "Return the contents of the file named C<path>."
7246 #: ../src/guestfs-actions.pod:870
7248 "Note that this function cannot correctly handle binary files (specifically, "
7249 "files containing C<\\0> character which is treated as end of string). For "
7250 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7251 "functions which have a more complex interface."
7255 #: ../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:1760 ../src/guestfs-actions.pod:2218 ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2350 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:6396 ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:7290 ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7361 ../src/guestfs-actions.pod:7446 ../src/guestfs-actions.pod:7465 ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7530 ../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:1189 ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1528 ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1553 ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:3550 ../fish/guestfish-actions.pod:3565 ../fish/guestfish-actions.pod:3641 ../fish/guestfish-actions.pod:3658 ../fish/guestfish-actions.pod:3673 ../fish/guestfish-actions.pod:4327 ../fish/guestfish-actions.pod:4373 ../fish/guestfish-actions.pod:4458 ../fish/guestfish-actions.pod:4473 ../fish/guestfish-actions.pod:4883 ../fish/guestfish-actions.pod:4901 ../fish/guestfish-actions.pod:4918 ../fish/guestfish-actions.pod:4928 ../fish/guestfish-actions.pod:4976 ../fish/guestfish-actions.pod:4986 ../fish/guestfish-actions.pod:5015 ../fish/guestfish-actions.pod:5025
7257 "Because of the message protocol, there is a transfer limit of somewhere "
7258 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7262 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3561 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:5367 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7170 ../src/guestfs-actions.pod:7184
7263 msgid "(Added in 0.4)"
7267 #: ../src/guestfs-actions.pod:883
7268 msgid "guestfs_checksum"
7272 #: ../src/guestfs-actions.pod:885
7276 " guestfs_checksum (guestfs_h *g,\n"
7277 " const char *csumtype,\n"
7278 " const char *path);\n"
7283 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7284 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7288 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7290 "The type of checksum to compute is given by the C<csumtype> parameter which "
7291 "must have one of the following values:"
7295 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7300 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7302 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7307 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7312 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7313 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7317 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7322 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7323 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7327 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7332 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7333 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7337 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7342 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7343 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7347 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7352 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7353 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7357 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7362 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7363 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7367 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7368 msgid "The checksum is returned as a printable string."
7372 #: ../src/guestfs-actions.pod:931
7373 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7377 #: ../src/guestfs-actions.pod:933
7378 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7382 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:6867
7383 msgid "(Added in 1.0.2)"
7387 #: ../src/guestfs-actions.pod:940
7388 msgid "guestfs_checksum_device"
7392 #: ../src/guestfs-actions.pod:942
7396 " guestfs_checksum_device (guestfs_h *g,\n"
7397 " const char *csumtype,\n"
7398 " const char *device);\n"
7403 #: ../src/guestfs-actions.pod:947
7405 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7406 "device named C<device>. For the types of checksums supported see the "
7407 "C<guestfs_checksum> command."
7411 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5188 ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6790 ../src/guestfs-actions.pod:7196
7412 msgid "(Added in 1.3.2)"
7416 #: ../src/guestfs-actions.pod:956
7417 msgid "guestfs_checksums_out"
7421 #: ../src/guestfs-actions.pod:958
7425 " guestfs_checksums_out (guestfs_h *g,\n"
7426 " const char *csumtype,\n"
7427 " const char *directory,\n"
7428 " const char *sumsfile);\n"
7433 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7435 "This command computes the checksums of all regular files in C<directory> and "
7436 "then emits a list of those checksums to the local output file C<sumsfile>."
7440 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7442 "This can be used for verifying the integrity of a virtual machine. However "
7443 "to be properly secure you should pay attention to the output of the checksum "
7444 "command (it uses the ones from GNU coreutils). In particular when the "
7445 "filename is not printable, coreutils uses a special backslash syntax. For "
7446 "more information, see the GNU coreutils info file."
7450 #: ../src/guestfs-actions.pod:978
7451 msgid "(Added in 1.3.7)"
7455 #: ../src/guestfs-actions.pod:980
7456 msgid "guestfs_chmod"
7460 #: ../src/guestfs-actions.pod:982
7464 " guestfs_chmod (guestfs_h *g,\n"
7466 " const char *path);\n"
7471 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7473 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7478 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7480 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7481 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7486 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2980 ../fish/guestfish-actions.pod:3109 ../fish/guestfish-actions.pod:3119 ../fish/guestfish-actions.pod:3129
7487 msgid "The mode actually set is affected by the umask."
7491 #: ../src/guestfs-actions.pod:1000
7492 msgid "guestfs_chown"
7496 #: ../src/guestfs-actions.pod:1002
7500 " guestfs_chown (guestfs_h *g,\n"
7503 " const char *path);\n"
7508 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7509 msgid "Change the file owner to C<owner> and group to C<group>."
7513 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3492 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2438
7515 "Only numeric uid and gid are supported. If you want to use names, you will "
7516 "need to locate and parse the password file yourself (Augeas support makes "
7517 "this relatively easy)."
7521 #: ../src/guestfs-actions.pod:1018
7522 msgid "guestfs_command"
7526 #: ../src/guestfs-actions.pod:1020
7530 " guestfs_command (guestfs_h *g,\n"
7531 " char *const *arguments);\n"
7536 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7538 "This call runs a command from the guest filesystem. The filesystem must be "
7539 "mounted, and must contain a compatible operating system (ie. something "
7540 "Linux, with the same or compatible processor architecture)."
7544 #: ../src/guestfs-actions.pod:1029
7546 "The single parameter is an argv-style list of arguments. The first element "
7547 "is the name of the program to run. Subsequent elements are parameters. The "
7548 "list must be non-empty (ie. must contain a program name). Note that the "
7549 "command runs directly, and is I<not> invoked via the shell (see "
7554 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7555 msgid "The return value is anything printed to I<stdout> by the command."
7559 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7561 "If the command returns a non-zero exit status, then this function returns an "
7562 "error message. The error message string is the content of I<stderr> from "
7567 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7569 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7570 "C</bin>. If you require a program from another location, you should provide "
7571 "the full path in the first parameter."
7575 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7577 "Shared libraries and data files required by the program must be available on "
7578 "filesystems which are mounted in the correct places. It is the caller's "
7579 "responsibility to ensure all filesystems that are needed are mounted at the "
7584 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1545
7585 msgid "(Added in 0.9.1)"
7589 #: ../src/guestfs-actions.pod:1062
7590 msgid "guestfs_command_lines"
7594 #: ../src/guestfs-actions.pod:1064
7598 " guestfs_command_lines (guestfs_h *g,\n"
7599 " char *const *arguments);\n"
7604 #: ../src/guestfs-actions.pod:1068
7606 "This is the same as C<guestfs_command>, but splits the result into a list of "
7611 #: ../src/guestfs-actions.pod:1071
7612 msgid "See also: C<guestfs_sh_lines>"
7616 #: ../src/guestfs-actions.pod:1082
7617 msgid "guestfs_config"
7621 #: ../src/guestfs-actions.pod:1084
7625 " guestfs_config (guestfs_h *g,\n"
7626 " const char *qemuparam,\n"
7627 " const char *qemuvalue);\n"
7632 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7634 "This can be used to add arbitrary qemu command line parameters of the form "
7635 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7636 "setting some parameters which would interfere with parameters that we use."
7640 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7641 msgid "The first character of C<param> string must be a C<-> (dash)."
7645 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7646 msgid "C<value> can be NULL."
7650 #: ../src/guestfs-actions.pod:1102
7651 msgid "guestfs_copy_size"
7655 #: ../src/guestfs-actions.pod:1104
7659 " guestfs_copy_size (guestfs_h *g,\n"
7660 " const char *src,\n"
7661 " const char *dest,\n"
7667 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7669 "This command copies exactly C<size> bytes from one source device or file "
7670 "C<src> to another destination device or file C<dest>."
7674 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7676 "Note this will fail if the source is too short or if the destination is not "
7681 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7382 ../src/guestfs-actions.pod:7401
7683 "This long-running command can generate progress notification messages so "
7684 "that the caller can display a progress bar or indicator. To receive these "
7685 "messages, the caller must register a progress event callback. See "
7686 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7690 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:7103 ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7209
7691 msgid "(Added in 1.0.87)"
7695 #: ../src/guestfs-actions.pod:1125
7700 #: ../src/guestfs-actions.pod:1127
7704 " guestfs_cp (guestfs_h *g,\n"
7705 " const char *src,\n"
7706 " const char *dest);\n"
7711 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7713 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7714 "destination filename or destination directory."
7718 #: ../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:4852 ../src/guestfs-actions.pod:5238
7719 msgid "(Added in 1.0.18)"
7723 #: ../src/guestfs-actions.pod:1139
7724 msgid "guestfs_cp_a"
7728 #: ../src/guestfs-actions.pod:1141
7732 " guestfs_cp_a (guestfs_h *g,\n"
7733 " const char *src,\n"
7734 " const char *dest);\n"
7739 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7741 "This copies a file or directory from C<src> to C<dest> recursively using the "
7746 #: ../src/guestfs-actions.pod:1153
7751 #: ../src/guestfs-actions.pod:1155
7755 " guestfs_dd (guestfs_h *g,\n"
7756 " const char *src,\n"
7757 " const char *dest);\n"
7762 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7764 "This command copies from one source device or file C<src> to another "
7765 "destination device or file C<dest>. Normally you would use this to copy to "
7766 "or from a device or partition, for example to duplicate a filesystem."
7770 #: ../src/guestfs-actions.pod:1165
7772 "If the destination is a device, it must be as large or larger than the "
7773 "source file or device, otherwise the copy will fail. This command cannot do "
7774 "partial copies (see C<guestfs_copy_size>)."
7778 #: ../src/guestfs-actions.pod:1173
7783 #: ../src/guestfs-actions.pod:1175
7787 " guestfs_df (guestfs_h *g);\n"
7792 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7793 msgid "This command runs the C<df> command to report disk space used."
7797 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7799 "This command is mostly useful for interactive sessions. It is I<not> "
7800 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7805 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2375 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7275
7806 msgid "(Added in 1.0.54)"
7810 #: ../src/guestfs-actions.pod:1189
7811 msgid "guestfs_df_h"
7815 #: ../src/guestfs-actions.pod:1191
7819 " guestfs_df_h (guestfs_h *g);\n"
7824 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7826 "This command runs the C<df -h> command to report disk space used in "
7827 "human-readable format."
7831 #: ../src/guestfs-actions.pod:1206
7832 msgid "guestfs_dmesg"
7836 #: ../src/guestfs-actions.pod:1208
7840 " guestfs_dmesg (guestfs_h *g);\n"
7845 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7847 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7848 "This is sometimes useful for extended debugging of problems."
7852 #: ../src/guestfs-actions.pod:1215
7854 "Another way to get the same information is to enable verbose messages with "
7855 "C<guestfs_set_verbose> or by setting the environment variable "
7856 "C<LIBGUESTFS_DEBUG=1> before running the program."
7860 #: ../src/guestfs-actions.pod:1225
7861 msgid "guestfs_download"
7865 #: ../src/guestfs-actions.pod:1227
7869 " guestfs_download (guestfs_h *g,\n"
7870 " const char *remotefilename,\n"
7871 " const char *filename);\n"
7876 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7878 "Download file C<remotefilename> and save it as C<filename> on the local "
7883 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6856 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4631
7884 msgid "C<filename> can also be a named pipe."
7888 #: ../src/guestfs-actions.pod:1237
7889 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7893 #: ../src/guestfs-actions.pod:1248
7894 msgid "guestfs_download_offset"
7898 #: ../src/guestfs-actions.pod:1250
7902 " guestfs_download_offset (guestfs_h *g,\n"
7903 " const char *remotefilename,\n"
7904 " const char *filename,\n"
7905 " int64_t offset,\n"
7911 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7913 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7914 "region must be within the file or device)."
7918 #: ../src/guestfs-actions.pod:1263
7920 "Note that there is no limit on the amount of data that can be downloaded "
7921 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7922 "full amount unless an error occurs."
7926 #: ../src/guestfs-actions.pod:1268
7927 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7931 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6901
7932 msgid "(Added in 1.5.17)"
7936 #: ../src/guestfs-actions.pod:1279
7937 msgid "guestfs_drop_caches"
7941 #: ../src/guestfs-actions.pod:1281
7945 " guestfs_drop_caches (guestfs_h *g,\n"
7946 " int whattodrop);\n"
7951 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7953 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7954 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7955 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7959 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7960 msgid "Setting C<whattodrop> to 3 should drop everything."
7964 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7966 "This automatically calls L<sync(2)> before the operation, so that the "
7967 "maximum guest memory is freed."
7971 #: ../src/guestfs-actions.pod:1299
7976 #: ../src/guestfs-actions.pod:1301
7980 " guestfs_du (guestfs_h *g,\n"
7981 " const char *path);\n"
7986 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7988 "This command runs the C<du -s> command to estimate file space usage for "
7993 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7995 "C<path> can be a file or a directory. If C<path> is a directory then the "
7996 "estimate includes the contents of the directory and all subdirectories "
8001 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8002 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8006 #: ../src/guestfs-actions.pod:1324
8007 msgid "guestfs_e2fsck_f"
8011 #: ../src/guestfs-actions.pod:1326
8015 " guestfs_e2fsck_f (guestfs_h *g,\n"
8016 " const char *device);\n"
8021 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8023 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8024 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8029 #: ../src/guestfs-actions.pod:1334
8031 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8032 "Normally you should use C<guestfs_fsck>."
8036 #: ../src/guestfs-actions.pod:1339
8037 msgid "(Added in 1.0.29)"
8041 #: ../src/guestfs-actions.pod:1341
8042 msgid "guestfs_echo_daemon"
8046 #: ../src/guestfs-actions.pod:1343
8050 " guestfs_echo_daemon (guestfs_h *g,\n"
8051 " char *const *words);\n"
8056 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8058 "This command concatenates the list of C<words> passed with single spaces "
8059 "between them and returns the resulting string."
8063 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8064 msgid "You can use this command to test the connection through to the daemon."
8068 #: ../src/guestfs-actions.pod:1352
8069 msgid "See also C<guestfs_ping_daemon>."
8073 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:6072
8074 msgid "(Added in 1.0.69)"
8078 #: ../src/guestfs-actions.pod:1359
8079 msgid "guestfs_egrep"
8083 #: ../src/guestfs-actions.pod:1361
8087 " guestfs_egrep (guestfs_h *g,\n"
8088 " const char *regex,\n"
8089 " const char *path);\n"
8094 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8095 msgid "This calls the external C<egrep> program and returns the matching lines."
8099 #: ../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:2221 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2424 ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:3653 ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3680 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:7345 ../src/guestfs-actions.pod:7364 ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7514 ../src/guestfs-actions.pod:7533
8100 msgid "(Added in 1.0.66)"
8104 #: ../src/guestfs-actions.pod:1378
8105 msgid "guestfs_egrepi"
8109 #: ../src/guestfs-actions.pod:1380
8113 " guestfs_egrepi (guestfs_h *g,\n"
8114 " const char *regex,\n"
8115 " const char *path);\n"
8120 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8121 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8125 #: ../src/guestfs-actions.pod:1397
8126 msgid "guestfs_equal"
8130 #: ../src/guestfs-actions.pod:1399
8134 " guestfs_equal (guestfs_h *g,\n"
8135 " const char *file1,\n"
8136 " const char *file2);\n"
8141 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8143 "This compares the two files C<file1> and C<file2> and returns true if their "
8144 "content is exactly equal, or false otherwise."
8148 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8149 msgid "The external L<cmp(1)> program is used for the comparison."
8153 #: ../src/guestfs-actions.pod:1413
8154 msgid "guestfs_exists"
8158 #: ../src/guestfs-actions.pod:1415
8162 " guestfs_exists (guestfs_h *g,\n"
8163 " const char *path);\n"
8168 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8170 "This returns C<true> if and only if there is a file, directory (or anything) "
8171 "with the given C<path> name."
8175 #: ../src/guestfs-actions.pod:1422
8176 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8180 #: ../src/guestfs-actions.pod:1428
8181 msgid "guestfs_fallocate"
8185 #: ../src/guestfs-actions.pod:1430
8189 " guestfs_fallocate (guestfs_h *g,\n"
8190 " const char *path,\n"
8196 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8198 "This command preallocates a file (containing zero bytes) named C<path> of "
8199 "size C<len> bytes. If the file exists already, it is overwritten."
8203 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8205 "Do not confuse this with the guestfish-specific C<alloc> command which "
8206 "allocates a file in the host and attaches it as a device."
8210 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8212 "This function is deprecated. In new code, use the C<fallocate64> call "
8217 #: ../src/guestfs-actions.pod:1454
8218 msgid "guestfs_fallocate64"
8222 #: ../src/guestfs-actions.pod:1456
8226 " guestfs_fallocate64 (guestfs_h *g,\n"
8227 " const char *path,\n"
8233 #: ../src/guestfs-actions.pod:1465
8235 "Note that this call allocates disk blocks for the file. To create a sparse "
8236 "file use C<guestfs_truncate_size> instead."
8240 #: ../src/guestfs-actions.pod:1468
8242 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8243 "oversight it only allowed 30 bit lengths to be specified, effectively "
8244 "limiting the maximum size of files created through that call to 1GB."
8248 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8250 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8251 "commands which create a file in the host and attach it as a device."
8255 #: ../src/guestfs-actions.pod:1479
8256 msgid "(Added in 1.3.17)"
8260 #: ../src/guestfs-actions.pod:1481
8261 msgid "guestfs_fgrep"
8265 #: ../src/guestfs-actions.pod:1483
8269 " guestfs_fgrep (guestfs_h *g,\n"
8270 " const char *pattern,\n"
8271 " const char *path);\n"
8276 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8277 msgid "This calls the external C<fgrep> program and returns the matching lines."
8281 #: ../src/guestfs-actions.pod:1500
8282 msgid "guestfs_fgrepi"
8286 #: ../src/guestfs-actions.pod:1502
8290 " guestfs_fgrepi (guestfs_h *g,\n"
8291 " const char *pattern,\n"
8292 " const char *path);\n"
8297 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8298 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8302 #: ../src/guestfs-actions.pod:1519
8303 msgid "guestfs_file"
8307 #: ../src/guestfs-actions.pod:1521
8311 " guestfs_file (guestfs_h *g,\n"
8312 " const char *path);\n"
8317 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8319 "This call uses the standard L<file(1)> command to determine the type or "
8320 "contents of the file."
8324 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8326 "This call will also transparently look inside various types of compressed "
8331 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8333 "The exact command which runs is C<file -zb path>. Note in particular that "
8334 "the filename is not prepended to the output (the I<-b> option)."
8338 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1014
8340 "The output depends on the output of the underlying L<file(1)> command and it "
8341 "can change in future in ways beyond our control. In other words, the output "
8342 "is not guaranteed by the ABI."
8346 #: ../src/guestfs-actions.pod:1539
8348 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8349 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8353 #: ../src/guestfs-actions.pod:1547
8354 msgid "guestfs_file_architecture"
8358 #: ../src/guestfs-actions.pod:1549
8362 " guestfs_file_architecture (guestfs_h *g,\n"
8363 " const char *filename);\n"
8368 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1025
8370 "This detects the architecture of the binary C<filename>, and returns it if "
8375 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8376 msgid "Currently defined architectures are:"
8380 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1032
8385 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1034
8387 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8388 "irrespective of the precise processor requirements of the binary."
8392 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8397 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8398 msgid "64 bit x86-64."
8402 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1041
8407 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1043
8408 msgid "32 bit SPARC."
8412 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1045
8417 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1047
8418 msgid "64 bit SPARC V9 and above."
8422 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1049
8427 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1051
8428 msgid "Intel Itanium."
8432 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1053
8437 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1055
8438 msgid "32 bit Power PC."
8442 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1057
8447 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1059
8448 msgid "64 bit Power PC."
8452 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1063
8453 msgid "Libguestfs may return other architecture strings in future."
8457 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1065
8458 msgid "The function works on at least the following types of files:"
8462 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1071
8463 msgid "many types of Un*x and Linux binary"
8467 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1075
8468 msgid "many types of Un*x and Linux shared library"
8472 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1079
8473 msgid "Windows Win32 and Win64 binaries"
8477 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1083
8478 msgid "Windows Win32 and Win64 DLLs"
8482 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1085
8483 msgid "Win32 binaries and DLLs return C<i386>."
8487 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1087
8488 msgid "Win64 binaries and DLLs return C<x86_64>."
8492 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1091
8493 msgid "Linux kernel modules"
8497 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1095
8498 msgid "Linux new-style initrd images"
8502 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1099
8503 msgid "some non-x86 Linux vmlinuz kernels"
8507 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1103
8508 msgid "What it can't do currently:"
8512 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1109
8513 msgid "static libraries (libfoo.a)"
8517 #: ../src/guestfs-actions.pod:1641 ../fish/guestfish-actions.pod:1113
8518 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8522 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1117
8523 msgid "x86 Linux vmlinuz kernels"
8527 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1119
8529 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8530 "compressed code, and are horribly hard to unpack. If you want to find the "
8531 "architecture of a kernel, use the architecture of the associated initrd or "
8532 "kernel module(s) instead."
8536 #: ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3403
8537 msgid "(Added in 1.5.3)"
8541 #: ../src/guestfs-actions.pod:1659
8542 msgid "guestfs_filesize"
8546 #: ../src/guestfs-actions.pod:1661
8550 " guestfs_filesize (guestfs_h *g,\n"
8551 " const char *file);\n"
8556 #: ../src/guestfs-actions.pod:1665 ../fish/guestfish-actions.pod:1130
8557 msgid "This command returns the size of C<file> in bytes."
8561 #: ../src/guestfs-actions.pod:1667
8563 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8564 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8565 "devices, use C<guestfs_blockdev_getsize64>."
8569 #: ../src/guestfs-actions.pod:1673
8570 msgid "(Added in 1.0.82)"
8574 #: ../src/guestfs-actions.pod:1675
8575 msgid "guestfs_fill"
8579 #: ../src/guestfs-actions.pod:1677
8583 " guestfs_fill (guestfs_h *g,\n"
8586 " const char *path);\n"
8591 #: ../src/guestfs-actions.pod:1683 ../fish/guestfish-actions.pod:1140
8593 "This command creates a new file called C<path>. The initial content of the "
8594 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8599 #: ../src/guestfs-actions.pod:1687
8601 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8602 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8603 "bytes use C<guestfs_fill_pattern>."
8607 #: ../src/guestfs-actions.pod:1699
8608 msgid "(Added in 1.0.79)"
8612 #: ../src/guestfs-actions.pod:1701
8613 msgid "guestfs_fill_pattern"
8617 #: ../src/guestfs-actions.pod:1703
8621 " guestfs_fill_pattern (guestfs_h *g,\n"
8622 " const char *pattern,\n"
8624 " const char *path);\n"
8629 #: ../src/guestfs-actions.pod:1709
8631 "This function is like C<guestfs_fill> except that it creates a new file of "
8632 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8633 "pattern is truncated if necessary to ensure the length of the file is "
8634 "exactly C<len> bytes."
8638 #: ../src/guestfs-actions.pod:1721
8639 msgid "(Added in 1.3.12)"
8643 #: ../src/guestfs-actions.pod:1723
8644 msgid "guestfs_find"
8648 #: ../src/guestfs-actions.pod:1725
8652 " guestfs_find (guestfs_h *g,\n"
8653 " const char *directory);\n"
8658 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1162
8660 "This command lists out all files and directories, recursively, starting at "
8661 "C<directory>. It is essentially equivalent to running the shell command "
8662 "C<find directory -print> but some post-processing happens on the output, "
8667 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
8669 "This returns a list of strings I<without any prefix>. Thus if the directory "
8674 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8684 #: ../src/guestfs-actions.pod:1741
8685 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8689 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1177
8700 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
8701 msgid "If C<directory> is not a directory, then this command returns an error."
8705 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8706 msgid "The returned list is sorted."
8710 #: ../src/guestfs-actions.pod:1754
8711 msgid "See also C<guestfs_find0>."
8715 #: ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:5656
8716 msgid "(Added in 1.0.27)"
8720 #: ../src/guestfs-actions.pod:1765
8721 msgid "guestfs_find0"
8725 #: ../src/guestfs-actions.pod:1767
8729 " guestfs_find0 (guestfs_h *g,\n"
8730 " const char *directory,\n"
8731 " const char *files);\n"
8736 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1196
8738 "This command lists out all files and directories, recursively, starting at "
8739 "C<directory>, placing the resulting list in the external file called "
8744 #: ../src/guestfs-actions.pod:1776
8746 "This command works the same way as C<guestfs_find> with the following "
8751 #: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1207
8752 msgid "The resulting list is written to an external file."
8756 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1211
8758 "Items (filenames) in the result are separated by C<\\0> characters. See "
8759 "L<find(1)> option I<-print0>."
8763 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
8764 msgid "This command is not limited in the number of names that it can return."
8768 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
8769 msgid "The result list is not sorted."
8773 #: ../src/guestfs-actions.pod:1803
8774 msgid "(Added in 1.0.74)"
8778 #: ../src/guestfs-actions.pod:1805
8779 msgid "guestfs_findfs_label"
8783 #: ../src/guestfs-actions.pod:1807
8787 " guestfs_findfs_label (guestfs_h *g,\n"
8788 " const char *label);\n"
8793 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1231
8795 "This command searches the filesystems and returns the one which has the "
8796 "given label. An error is returned if no such filesystem can be found."
8800 #: ../src/guestfs-actions.pod:1815
8801 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8805 #: ../src/guestfs-actions.pod:1822
8806 msgid "guestfs_findfs_uuid"
8810 #: ../src/guestfs-actions.pod:1824
8814 " guestfs_findfs_uuid (guestfs_h *g,\n"
8815 " const char *uuid);\n"
8820 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1241
8822 "This command searches the filesystems and returns the one which has the "
8823 "given UUID. An error is returned if no such filesystem can be found."
8827 #: ../src/guestfs-actions.pod:1832
8828 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8832 #: ../src/guestfs-actions.pod:1839
8833 msgid "guestfs_fsck"
8837 #: ../src/guestfs-actions.pod:1841
8841 " guestfs_fsck (guestfs_h *g,\n"
8842 " const char *fstype,\n"
8843 " const char *device);\n"
8848 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1251
8850 "This runs the filesystem checker (fsck) on C<device> which should have "
8851 "filesystem type C<fstype>."
8855 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
8857 "The returned integer is the status. See L<fsck(8)> for the list of status "
8858 "codes from C<fsck>."
8862 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1263
8863 msgid "Multiple status codes can be summed together."
8867 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1267
8869 "A non-zero return code can mean \"success\", for example if errors have been "
8870 "corrected on the filesystem."
8874 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
8875 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8879 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
8880 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8884 #: ../src/guestfs-actions.pod:1876 ../src/guestfs-actions.pod:7387
8885 msgid "(Added in 1.0.16)"
8889 #: ../src/guestfs-actions.pod:1878
8890 msgid "guestfs_get_append"
8894 #: ../src/guestfs-actions.pod:1880
8898 " guestfs_get_append (guestfs_h *g);\n"
8903 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1283
8905 "Return the additional kernel options which are added to the guest kernel "
8910 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
8911 msgid "If C<NULL> then no options are added."
8915 #: ../src/guestfs-actions.pod:1888
8917 "This function returns a string which may be NULL. There is no way to return "
8918 "an error from this function. The string is owned by the guest handle and "
8919 "must I<not> be freed."
8923 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5814 ../src/guestfs-actions.pod:6235 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6270 ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:7051 ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7430
8924 msgid "(Added in 1.0.26)"
8928 #: ../src/guestfs-actions.pod:1894
8929 msgid "guestfs_get_attach_method"
8933 #: ../src/guestfs-actions.pod:1896
8937 " guestfs_get_attach_method (guestfs_h *g);\n"
8942 #: ../src/guestfs-actions.pod:1899
8943 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8947 #: ../src/guestfs-actions.pod:1904
8948 msgid "guestfs_get_autosync"
8952 #: ../src/guestfs-actions.pod:1906
8956 " guestfs_get_autosync (guestfs_h *g);\n"
8961 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1298
8962 msgid "Get the autosync flag."
8966 #: ../src/guestfs-actions.pod:1915
8967 msgid "guestfs_get_direct"
8971 #: ../src/guestfs-actions.pod:1917
8975 " guestfs_get_direct (guestfs_h *g);\n"
8980 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1304
8981 msgid "Return the direct appliance mode flag."
8985 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:5883
8986 msgid "(Added in 1.0.72)"
8990 #: ../src/guestfs-actions.pod:1926
8991 msgid "guestfs_get_e2label"
8995 #: ../src/guestfs-actions.pod:1928
8999 " guestfs_get_e2label (guestfs_h *g,\n"
9000 " const char *device);\n"
9005 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1310
9006 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9010 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1313
9012 "This function is deprecated. In new code, use the C<vfs_label> call "
9017 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5920
9018 msgid "(Added in 1.0.15)"
9022 #: ../src/guestfs-actions.pod:1947
9023 msgid "guestfs_get_e2uuid"
9027 #: ../src/guestfs-actions.pod:1949
9031 " guestfs_get_e2uuid (guestfs_h *g,\n"
9032 " const char *device);\n"
9037 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1324
9038 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9042 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1327
9043 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9047 #: ../src/guestfs-actions.pod:1968
9048 msgid "guestfs_get_memsize"
9052 #: ../src/guestfs-actions.pod:1970
9056 " guestfs_get_memsize (guestfs_h *g);\n"
9061 #: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1338
9062 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9066 #: ../src/guestfs-actions.pod:1976
9068 "If C<guestfs_set_memsize> was not called on this handle, and if "
9069 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9070 "value for memsize."
9074 #: ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:1345 ../fish/guestfish-actions.pod:1396 ../fish/guestfish-actions.pod:4006 ../fish/guestfish-actions.pod:4093
9075 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9079 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6817
9080 msgid "(Added in 1.0.55)"
9084 #: ../src/guestfs-actions.pod:1987
9085 msgid "guestfs_get_network"
9089 #: ../src/guestfs-actions.pod:1989
9093 " guestfs_get_network (guestfs_h *g);\n"
9098 #: ../src/guestfs-actions.pod:1992 ../fish/guestfish-actions.pod:1352
9099 msgid "This returns the enable network flag."
9103 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:5960
9104 msgid "(Added in 1.5.4)"
9108 #: ../src/guestfs-actions.pod:1998
9109 msgid "guestfs_get_path"
9113 #: ../src/guestfs-actions.pod:2000
9117 " guestfs_get_path (guestfs_h *g);\n"
9122 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1358
9123 msgid "Return the current search path."
9127 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1360
9129 "This is always non-NULL. If it wasn't set already, then this will return "
9134 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2037
9136 "This function returns a string, or NULL on error. The string is owned by "
9137 "the guest handle and must I<not> be freed."
9141 #: ../src/guestfs-actions.pod:2013
9142 msgid "guestfs_get_pid"
9146 #: ../src/guestfs-actions.pod:2015
9150 " guestfs_get_pid (guestfs_h *g);\n"
9155 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1369
9157 "Return the process ID of the qemu subprocess. If there is no qemu "
9158 "subprocess, then this will return an error."
9162 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9163 msgid "This is an internal call used for debugging and testing."
9167 #: ../src/guestfs-actions.pod:2025
9168 msgid "(Added in 1.0.56)"
9172 #: ../src/guestfs-actions.pod:2027
9173 msgid "guestfs_get_qemu"
9177 #: ../src/guestfs-actions.pod:2029
9181 " guestfs_get_qemu (guestfs_h *g);\n"
9186 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1378
9187 msgid "Return the current qemu binary."
9191 #: ../src/guestfs-actions.pod:2034 ../fish/guestfish-actions.pod:1380
9193 "This is always non-NULL. If it wasn't set already, then this will return "
9194 "the default qemu binary name."
9198 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:6005
9199 msgid "(Added in 1.0.6)"
9203 #: ../src/guestfs-actions.pod:2042
9204 msgid "guestfs_get_recovery_proc"
9208 #: ../src/guestfs-actions.pod:2044
9212 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9217 #: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1387
9218 msgid "Return the recovery process enabled flag."
9222 #: ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3795 ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:6029 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6932
9223 msgid "(Added in 1.0.77)"
9227 #: ../src/guestfs-actions.pod:2053
9228 msgid "guestfs_get_selinux"
9232 #: ../src/guestfs-actions.pod:2055
9236 " guestfs_get_selinux (guestfs_h *g);\n"
9241 #: ../src/guestfs-actions.pod:2058
9243 "This returns the current setting of the selinux flag which is passed to the "
9244 "appliance at boot time. See C<guestfs_set_selinux>."
9248 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:6048 ../src/guestfs-actions.pod:6106
9249 msgid "(Added in 1.0.67)"
9253 #: ../src/guestfs-actions.pod:2068
9254 msgid "guestfs_get_state"
9258 #: ../src/guestfs-actions.pod:2070
9262 " guestfs_get_state (guestfs_h *g);\n"
9267 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1403
9269 "This returns the current state as an opaque integer. This is only useful "
9270 "for printing debug and internal error messages."
9274 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:3296 ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:1406 ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2338 ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2392
9275 msgid "For more information on states, see L<guestfs(3)>."
9279 #: ../src/guestfs-actions.pod:2082
9280 msgid "guestfs_get_trace"
9284 #: ../src/guestfs-actions.pod:2084
9288 " guestfs_get_trace (guestfs_h *g);\n"
9293 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
9294 msgid "Return the command trace flag."
9298 #: ../src/guestfs-actions.pod:2093
9299 msgid "guestfs_get_umask"
9303 #: ../src/guestfs-actions.pod:2095
9307 " guestfs_get_umask (guestfs_h *g);\n"
9312 #: ../src/guestfs-actions.pod:2098
9314 "Return the current umask. By default the umask is C<022> unless it has been "
9315 "set by calling C<guestfs_umask>."
9319 #: ../src/guestfs-actions.pod:2105
9320 msgid "guestfs_get_verbose"
9324 #: ../src/guestfs-actions.pod:2107
9328 " guestfs_get_verbose (guestfs_h *g);\n"
9333 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1425
9334 msgid "This returns the verbose messages flag."
9338 #: ../src/guestfs-actions.pod:2116
9339 msgid "guestfs_getcon"
9343 #: ../src/guestfs-actions.pod:2118
9347 " guestfs_getcon (guestfs_h *g);\n"
9352 #: ../src/guestfs-actions.pod:2121 ../fish/guestfish-actions.pod:1431
9353 msgid "This gets the SELinux security context of the daemon."
9357 #: ../src/guestfs-actions.pod:2123
9358 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9362 #: ../src/guestfs-actions.pod:2131
9363 msgid "guestfs_getxattr"
9367 #: ../src/guestfs-actions.pod:2133
9371 " guestfs_getxattr (guestfs_h *g,\n"
9372 " const char *path,\n"
9373 " const char *name,\n"
9374 " size_t *size_r);\n"
9379 #: ../src/guestfs-actions.pod:2139
9381 "Get a single extended attribute from file C<path> named C<name>. This call "
9382 "follows symlinks. If you want to lookup an extended attribute for the "
9383 "symlink itself, use C<guestfs_lgetxattr>."
9387 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:3512
9389 "Normally it is better to get all extended attributes from a file in one go "
9390 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9391 "implementations are buggy and do not provide a way to list out attributes. "
9392 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9393 "extended attributes you want in advance and call this function."
9397 #: ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:2457
9399 "Extended attribute values are blobs of binary data. If there is no extended "
9400 "attribute named C<name>, this returns an error."
9404 #: ../src/guestfs-actions.pod:2153
9405 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9409 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5464
9411 "This function returns a buffer, or NULL on error. The size of the returned "
9412 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9417 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
9418 msgid "(Added in 1.7.24)"
9422 #: ../src/guestfs-actions.pod:2161
9423 msgid "guestfs_getxattrs"
9427 #: ../src/guestfs-actions.pod:2163
9430 " struct guestfs_xattr_list *\n"
9431 " guestfs_getxattrs (guestfs_h *g,\n"
9432 " const char *path);\n"
9437 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1460
9438 msgid "This call lists the extended attributes of the file or directory C<path>."
9442 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9444 "At the system call level, this is a combination of the L<listxattr(2)> and "
9445 "L<getxattr(2)> calls."
9449 #: ../src/guestfs-actions.pod:2173
9450 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9454 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:4191
9456 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9457 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9461 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:7495
9462 msgid "(Added in 1.0.59)"
9466 #: ../src/guestfs-actions.pod:2181
9467 msgid "guestfs_glob_expand"
9471 #: ../src/guestfs-actions.pod:2183
9475 " guestfs_glob_expand (guestfs_h *g,\n"
9476 " const char *pattern);\n"
9481 #: ../src/guestfs-actions.pod:2187 ../fish/guestfish-actions.pod:1472
9483 "This command searches for all the pathnames matching C<pattern> according to "
9484 "the wildcard expansion rules used by the shell."
9488 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1476
9489 msgid "If no paths match, then this returns an empty list (note: not an error)."
9493 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9495 "It is just a wrapper around the C L<glob(3)> function with flags "
9496 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9500 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6335
9501 msgid "(Added in 1.0.50)"
9505 #: ../src/guestfs-actions.pod:2204
9506 msgid "guestfs_grep"
9510 #: ../src/guestfs-actions.pod:2206
9514 " guestfs_grep (guestfs_h *g,\n"
9515 " const char *regex,\n"
9516 " const char *path);\n"
9521 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1487
9522 msgid "This calls the external C<grep> program and returns the matching lines."
9526 #: ../src/guestfs-actions.pod:2223
9527 msgid "guestfs_grepi"
9531 #: ../src/guestfs-actions.pod:2225
9535 " guestfs_grepi (guestfs_h *g,\n"
9536 " const char *regex,\n"
9537 " const char *path);\n"
9542 #: ../src/guestfs-actions.pod:2230 ../fish/guestfish-actions.pod:1497
9543 msgid "This calls the external C<grep -i> program and returns the matching lines."
9547 #: ../src/guestfs-actions.pod:2242
9548 msgid "guestfs_grub_install"
9552 #: ../src/guestfs-actions.pod:2244
9556 " guestfs_grub_install (guestfs_h *g,\n"
9557 " const char *root,\n"
9558 " const char *device);\n"
9563 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1507
9565 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9566 "the root directory being C<root>."
9570 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9572 "Note: If grub-install reports the error \"No suitable drive was found in the "
9573 "generated device map.\" it may be that you need to create a "
9574 "C</boot/grub/device.map> file first that contains the mapping between grub "
9575 "device names and Linux device names. It is usually sufficient to create a "
9580 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1517
9588 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1519
9589 msgid "replacing C</dev/vda> with the name of the installation device."
9593 #: ../src/guestfs-actions.pod:2265
9594 msgid "(Added in 1.0.17)"
9598 #: ../src/guestfs-actions.pod:2267
9599 msgid "guestfs_head"
9603 #: ../src/guestfs-actions.pod:2269
9607 " guestfs_head (guestfs_h *g,\n"
9608 " const char *path);\n"
9613 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1525
9615 "This command returns up to the first 10 lines of a file as a list of "
9620 #: ../src/guestfs-actions.pod:2285
9621 msgid "guestfs_head_n"
9625 #: ../src/guestfs-actions.pod:2287
9629 " guestfs_head_n (guestfs_h *g,\n"
9631 " const char *path);\n"
9636 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1535
9638 "If the parameter C<nrlines> is a positive number, this returns the first "
9639 "C<nrlines> lines of the file C<path>."
9643 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9645 "If the parameter C<nrlines> is a negative number, this returns lines from "
9646 "the file C<path>, excluding the last C<nrlines> lines."
9650 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:4471
9651 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9655 #: ../src/guestfs-actions.pod:2309
9656 msgid "guestfs_hexdump"
9660 #: ../src/guestfs-actions.pod:2311
9664 " guestfs_hexdump (guestfs_h *g,\n"
9665 " const char *path);\n"
9670 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1550
9672 "This runs C<hexdump -C> on the given C<path>. The result is the "
9673 "human-readable, canonical hex dump of the file."
9677 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:6399 ../src/guestfs-actions.pod:6454
9678 msgid "(Added in 1.0.22)"
9682 #: ../src/guestfs-actions.pod:2326
9683 msgid "guestfs_initrd_cat"
9687 #: ../src/guestfs-actions.pod:2328
9691 " guestfs_initrd_cat (guestfs_h *g,\n"
9692 " const char *initrdpath,\n"
9693 " const char *filename,\n"
9694 " size_t *size_r);\n"
9699 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1560
9701 "This command unpacks the file C<filename> from the initrd file called "
9702 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9707 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1564
9709 "For example, in guestfish you could use the following command to examine the "
9710 "boot script (usually called C</init>) contained in a Linux initrd or "
9715 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1568
9718 " initrd-cat /boot/initrd-<version>.img init\n"
9723 #: ../src/guestfs-actions.pod:2344
9724 msgid "See also C<guestfs_initrd_list>."
9728 #: ../src/guestfs-actions.pod:2355
9729 msgid "guestfs_initrd_list"
9733 #: ../src/guestfs-actions.pod:2357
9737 " guestfs_initrd_list (guestfs_h *g,\n"
9738 " const char *path);\n"
9743 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1579
9744 msgid "This command lists out files contained in an initrd."
9748 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1581
9750 "The files are listed without any initial C</> character. The files are "
9751 "listed in the order they appear (not necessarily alphabetical). Directory "
9752 "names are listed as separate items."
9756 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1585
9758 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9759 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9764 #: ../src/guestfs-actions.pod:2377
9765 msgid "guestfs_inotify_add_watch"
9769 #: ../src/guestfs-actions.pod:2379
9773 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9774 " const char *path,\n"
9780 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1593
9781 msgid "Watch C<path> for the events listed in C<mask>."
9785 #: ../src/guestfs-actions.pod:2386 ../fish/guestfish-actions.pod:1595
9787 "Note that if C<path> is a directory then events within that directory are "
9788 "watched, but this does I<not> happen recursively (in subdirectories)."
9792 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1599
9794 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9795 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9799 #: ../src/guestfs-actions.pod:2398
9800 msgid "guestfs_inotify_close"
9804 #: ../src/guestfs-actions.pod:2400
9808 " guestfs_inotify_close (guestfs_h *g);\n"
9813 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1607
9815 "This closes the inotify handle which was previously opened by inotify_init. "
9816 "It removes all watches, throws away any pending events, and deallocates all "
9821 #: ../src/guestfs-actions.pod:2411
9822 msgid "guestfs_inotify_files"
9826 #: ../src/guestfs-actions.pod:2413
9830 " guestfs_inotify_files (guestfs_h *g);\n"
9835 #: ../src/guestfs-actions.pod:2416
9837 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9838 "returns a list of pathnames of objects that were touched. The returned "
9839 "pathnames are sorted and deduplicated."
9843 #: ../src/guestfs-actions.pod:2426
9844 msgid "guestfs_inotify_init"
9848 #: ../src/guestfs-actions.pod:2428
9852 " guestfs_inotify_init (guestfs_h *g,\n"
9853 " int maxevents);\n"
9858 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1623
9860 "This command creates a new inotify handle. The inotify subsystem can be "
9861 "used to notify events which happen to objects in the guest filesystem."
9865 #: ../src/guestfs-actions.pod:2436
9867 "C<maxevents> is the maximum number of events which will be queued up between "
9868 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9869 "passed as C<0>, then the kernel (or previously set) default is used. For "
9870 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9871 "throws away events, but records the fact that it threw them away by setting "
9872 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9873 "C<guestfs_inotify_read>)."
9877 #: ../src/guestfs-actions.pod:2446
9879 "Before any events are generated, you have to add some watches to the "
9880 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9881 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9885 #: ../src/guestfs-actions.pod:2452
9887 "Queued up events should be read periodically by calling "
9888 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9889 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9890 "often enough then you risk the internal queue overflowing."
9894 #: ../src/guestfs-actions.pod:2459
9896 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9897 "This also removes any watches automatically."
9901 #: ../src/guestfs-actions.pod:2463 ../fish/guestfish-actions.pod:1654
9903 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9904 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9905 "that there is one global inotify handle per libguestfs instance."
9909 #: ../src/guestfs-actions.pod:2472
9910 msgid "guestfs_inotify_read"
9914 #: ../src/guestfs-actions.pod:2474
9917 " struct guestfs_inotify_event_list *\n"
9918 " guestfs_inotify_read (guestfs_h *g);\n"
9923 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1663
9925 "Return the complete queue of events that have happened since the previous "
9930 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
9931 msgid "If no events have happened, this returns an empty list."
9935 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
9937 "I<Note>: In order to make sure that all events have been read, you must call "
9938 "this function repeatedly until it returns an empty list. The reason is that "
9939 "the call will read events up to the maximum appliance-to-host message size "
9940 "and leave remaining events in the queue."
9944 #: ../src/guestfs-actions.pod:2488
9946 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9947 "there was an error. I<The caller must call "
9948 "C<guestfs_free_inotify_event_list> after use>."
9952 #: ../src/guestfs-actions.pod:2494
9953 msgid "guestfs_inotify_rm_watch"
9957 #: ../src/guestfs-actions.pod:2496
9961 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9967 #: ../src/guestfs-actions.pod:2500
9969 "Remove a previously defined inotify watch. See "
9970 "C<guestfs_inotify_add_watch>."
9974 #: ../src/guestfs-actions.pod:2507
9975 msgid "guestfs_inspect_get_arch"
9979 #: ../src/guestfs-actions.pod:2509
9983 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9984 " const char *root);\n"
9989 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2536 ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2673 ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2851 ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2911 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3129
9991 "This function should only be called with a root device string as returned by "
9992 "C<guestfs_inspect_os>."
9996 #: ../src/guestfs-actions.pod:2516
9998 "This returns the architecture of the inspected operating system. The "
9999 "possible return values are listed under C<guestfs_file_architecture>."
10003 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1692
10005 "If the architecture could not be determined, then the string C<unknown> is "
10010 #: ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1905 ../fish/guestfish-actions.pod:1975 ../fish/guestfish-actions.pod:1999 ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2094 ../fish/guestfish-actions.pod:2110 ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2139 ../fish/guestfish-actions.pod:2152 ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2300
10011 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10015 #: ../src/guestfs-actions.pod:2530
10016 msgid "guestfs_inspect_get_distro"
10020 #: ../src/guestfs-actions.pod:2532
10024 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10025 " const char *root);\n"
10030 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1704
10031 msgid "This returns the distro (distribution) of the inspected operating system."
10035 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10036 msgid "Currently defined distros are:"
10040 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1711
10041 msgid "\"archlinux\""
10045 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1713
10046 msgid "Arch Linux."
10050 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1715
10055 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1717
10060 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1719
10065 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1721
10070 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1723
10075 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1725
10080 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1727
10085 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1729
10090 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
10091 msgid "\"linuxmint\""
10095 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1733
10096 msgid "Linux Mint."
10100 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1735
10101 msgid "\"mandriva\""
10105 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1737
10110 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1739
10115 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1741
10120 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1743
10125 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1745
10130 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1747
10131 msgid "\"redhat-based\""
10135 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1749
10136 msgid "Some Red Hat-derived distro."
10140 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1751
10145 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1753
10146 msgid "Red Hat Enterprise Linux."
10150 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1755
10151 msgid "\"scientificlinux\""
10155 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1757
10156 msgid "Scientific Linux."
10160 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1759
10161 msgid "\"slackware\""
10165 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1761
10170 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1763
10175 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1765
10180 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:2085
10181 msgid "\"unknown\""
10185 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1769
10186 msgid "The distro could not be determined."
10190 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:1771 ../fish/guestfish-actions.pod:2077
10191 msgid "\"windows\""
10195 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1773
10197 "Windows does not have distributions. This string is returned if the OS type "
10202 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:2091
10204 "Future versions of libguestfs may return other strings here. The caller "
10205 "should be prepared to handle any string."
10209 #: ../src/guestfs-actions.pod:2623
10210 msgid "guestfs_inspect_get_drive_mappings"
10214 #: ../src/guestfs-actions.pod:2625
10218 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10219 " const char *root);\n"
10224 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
10226 "This call is useful for Windows which uses a primitive system of assigning "
10227 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10228 "Windows Registry to find out how disks/partitions are mapped to drive "
10229 "letters, and returns a hash table as in the example below:"
10233 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1796
10236 " C => /dev/vda2\n"
10237 " E => /dev/vdb1\n"
10238 " F => /dev/vdc1\n"
10243 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1800
10245 "Note that keys are drive letters. For Windows, the key is case insensitive "
10246 "and just contains the drive letter, without the customary colon separator "
10251 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10253 "In future we may support other operating systems that also used drive "
10254 "letters, but the keys for those might not be case insensitive and might be "
10255 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10260 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
10262 "For Windows guests, currently only hard drive mappings are returned. "
10263 "Removable disks (eg. DVD-ROMs) are ignored."
10267 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10269 "For guests that do not use drive mappings, or if the drive mappings could "
10270 "not be determined, this returns an empty hash table."
10274 #: ../src/guestfs-actions.pod:2657
10276 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10277 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10281 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:6756
10283 "This function returns a NULL-terminated array of strings, or NULL if there "
10284 "was an error. The array of strings will always have length C<2n+1>, where "
10285 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10286 "caller must free the strings and the array after use>."
10290 #: ../src/guestfs-actions.pod:2667
10291 msgid "guestfs_inspect_get_filesystems"
10295 #: ../src/guestfs-actions.pod:2669
10299 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10300 " const char *root);\n"
10305 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10307 "This returns a list of all the filesystems that we think are associated with "
10308 "this operating system. This includes the root filesystem, other ordinary "
10309 "filesystems, and non-mounted devices like swap partitions."
10313 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
10315 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10316 "to be shared between operating systems."
10320 #: ../src/guestfs-actions.pod:2684
10322 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10323 "C<guestfs_inspect_get_mountpoints>."
10327 #: ../src/guestfs-actions.pod:2693
10328 msgid "guestfs_inspect_get_format"
10332 #: ../src/guestfs-actions.pod:2695
10336 " guestfs_inspect_get_format (guestfs_h *g,\n"
10337 " const char *root);\n"
10342 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1844
10344 "This returns the format of the inspected operating system. You can use it "
10345 "to detect install images, live CDs and similar."
10349 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10350 msgid "Currently defined formats are:"
10354 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1851
10355 msgid "\"installed\""
10359 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1853
10360 msgid "This is an installed operating system."
10364 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1855
10365 msgid "\"installer\""
10369 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10371 "The disk image being inspected is not an installed operating system, but a "
10372 "I<bootable> install disk, live CD, or similar."
10376 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
10377 msgid "The format of this disk image is not known."
10381 #: ../src/guestfs-actions.pod:2732
10382 msgid "guestfs_inspect_get_hostname"
10386 #: ../src/guestfs-actions.pod:2734
10390 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10391 " const char *root);\n"
10396 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1878
10398 "This function returns the hostname of the operating system as found by "
10399 "inspection of the guest's configuration files."
10403 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10405 "If the hostname could not be determined, then the string C<unknown> is "
10410 #: ../src/guestfs-actions.pod:2752
10411 msgid "(Added in 1.7.9)"
10415 #: ../src/guestfs-actions.pod:2754
10416 msgid "guestfs_inspect_get_major_version"
10420 #: ../src/guestfs-actions.pod:2756
10424 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10425 " const char *root);\n"
10430 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1893
10431 msgid "This returns the major version number of the inspected operating system."
10435 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10437 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10438 "popular public names used by the operating system. Notably the operating "
10439 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10440 "1). You can find out the real versions corresponding to releases of Windows "
10441 "by consulting Wikipedia or MSDN."
10445 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1917
10446 msgid "If the version could not be determined, then C<0> is returned."
10450 #: ../src/guestfs-actions.pod:2781
10451 msgid "guestfs_inspect_get_minor_version"
10455 #: ../src/guestfs-actions.pod:2783
10459 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10460 " const char *root);\n"
10465 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1914
10466 msgid "This returns the minor version number of the inspected operating system."
10470 #: ../src/guestfs-actions.pod:2795
10472 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10473 "C<guestfs_inspect_get_major_version>."
10477 #: ../src/guestfs-actions.pod:2802
10478 msgid "guestfs_inspect_get_mountpoints"
10482 #: ../src/guestfs-actions.pod:2804
10486 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10487 " const char *root);\n"
10492 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1929
10494 "This returns a hash of where we think the filesystems associated with this "
10495 "operating system should be mounted. Callers should note that this is at "
10496 "best an educated guess made by reading configuration files such as "
10497 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10498 "are non-existent or not mountable and callers should be prepared to handle "
10499 "or ignore failures if they try to mount them."
10503 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10505 "Each element in the returned hashtable has a key which is the path of the "
10506 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10507 "mounted there (eg. C</dev/sda1>)."
10511 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
10512 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10516 #: ../src/guestfs-actions.pod:2828
10518 "For operating systems like Windows which still use drive letters, this call "
10519 "will only return an entry for the first drive \"mounted on\" C</>. For "
10520 "information about the mapping of drive letters to partitions, see "
10521 "C<guestfs_inspect_get_drive_mappings>."
10525 #: ../src/guestfs-actions.pod:2834
10527 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10528 "C<guestfs_inspect_get_filesystems>."
10532 #: ../src/guestfs-actions.pod:2845
10533 msgid "guestfs_inspect_get_package_format"
10537 #: ../src/guestfs-actions.pod:2847
10541 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10542 " const char *root);\n"
10547 #: ../src/guestfs-actions.pod:2854
10549 "This function and C<guestfs_inspect_get_package_management> return the "
10550 "package format and package management tool used by the inspected operating "
10551 "system. For example for Fedora these functions would return C<rpm> (package "
10552 "format) and C<yum> (package management)."
10556 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1968
10558 "This returns the string C<unknown> if we could not determine the package "
10559 "format I<or> if the operating system does not have a real packaging system "
10564 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1972
10566 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10567 "Future versions of libguestfs may return other strings."
10571 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903
10572 msgid "(Added in 1.7.5)"
10576 #: ../src/guestfs-actions.pod:2874
10577 msgid "guestfs_inspect_get_package_management"
10581 #: ../src/guestfs-actions.pod:2876
10585 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10586 " const char *root);\n"
10591 #: ../src/guestfs-actions.pod:2883
10593 "C<guestfs_inspect_get_package_format> and this function return the package "
10594 "format and package management tool used by the inspected operating system. "
10595 "For example for Fedora these functions would return C<rpm> (package format) "
10596 "and C<yum> (package management)."
10600 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1990
10602 "This returns the string C<unknown> if we could not determine the package "
10603 "management tool I<or> if the operating system does not have a real packaging "
10604 "system (eg. Windows)."
10608 #: ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1994
10610 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10611 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10612 "libguestfs may return other strings."
10616 #: ../src/guestfs-actions.pod:2905
10617 msgid "guestfs_inspect_get_product_name"
10621 #: ../src/guestfs-actions.pod:2907
10625 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10626 " const char *root);\n"
10631 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10633 "This returns the product name of the inspected operating system. The "
10634 "product name is generally some freeform string which can be displayed to the "
10635 "user, but should not be parsed by programs."
10639 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
10641 "If the product name could not be determined, then the string C<unknown> is "
10646 #: ../src/guestfs-actions.pod:2929
10647 msgid "guestfs_inspect_get_product_variant"
10651 #: ../src/guestfs-actions.pod:2931
10655 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10656 " const char *root);\n"
10661 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2025
10662 msgid "This returns the product variant of the inspected operating system."
10666 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
10668 "For Windows guests, this returns the contents of the Registry key "
10669 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10670 "which is usually a string such as C<Client> or C<Server> (other values are "
10671 "possible). This can be used to distinguish consumer and enterprise versions "
10672 "of Windows that have the same version number (for example, Windows 7 and "
10673 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10674 "the latter is C<Server>)."
10678 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2037
10680 "For enterprise Linux guests, in future we intend this to return the product "
10681 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10682 "implemented at present."
10686 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2041
10688 "If the product variant could not be determined, then the string C<unknown> "
10693 #: ../src/guestfs-actions.pod:2957
10695 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10696 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10700 #: ../src/guestfs-actions.pod:2964
10701 msgid "guestfs_inspect_get_roots"
10705 #: ../src/guestfs-actions.pod:2966
10709 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10714 #: ../src/guestfs-actions.pod:2969
10716 "This function is a convenient way to get the list of root devices, as "
10717 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10718 "the whole inspection process."
10722 #: ../src/guestfs-actions.pod:2973
10724 "This returns an empty list if either no root devices were found or the "
10725 "caller has not called C<guestfs_inspect_os>."
10729 #: ../src/guestfs-actions.pod:2982
10730 msgid "(Added in 1.7.3)"
10734 #: ../src/guestfs-actions.pod:2984
10735 msgid "guestfs_inspect_get_type"
10739 #: ../src/guestfs-actions.pod:2986
10743 " guestfs_inspect_get_type (guestfs_h *g,\n"
10744 " const char *root);\n"
10749 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
10751 "This returns the type of the inspected operating system. Currently defined "
10756 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
10761 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2075
10762 msgid "Any Linux-based operating system."
10766 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2079
10767 msgid "Any Microsoft Windows operating system."
10771 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2081
10772 msgid "\"freebsd\""
10776 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2083
10781 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2087
10782 msgid "The operating system type could not be determined."
10786 #: ../src/guestfs-actions.pod:3026
10787 msgid "guestfs_inspect_get_windows_current_control_set"
10791 #: ../src/guestfs-actions.pod:3028
10795 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10796 " const char *root);\n"
10801 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2103
10803 "This returns the Windows CurrentControlSet of the inspected guest. The "
10804 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10808 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
10810 "This call assumes that the guest is Windows and that the Registry could be "
10811 "examined by inspection. If this is not the case then an error is returned."
10815 #: ../src/guestfs-actions.pod:3047
10816 msgid "guestfs_inspect_get_windows_systemroot"
10820 #: ../src/guestfs-actions.pod:3049
10824 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10825 " const char *root);\n"
10830 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2119
10832 "This returns the Windows systemroot of the inspected guest. The systemroot "
10833 "is a directory path such as C</WINDOWS>."
10837 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
10839 "This call assumes that the guest is Windows and that the systemroot could be "
10840 "determined by inspection. If this is not the case then an error is "
10845 #: ../src/guestfs-actions.pod:3068
10846 msgid "(Added in 1.5.25)"
10850 #: ../src/guestfs-actions.pod:3070
10851 msgid "guestfs_inspect_is_live"
10855 #: ../src/guestfs-actions.pod:3072
10859 " guestfs_inspect_is_live (guestfs_h *g,\n"
10860 " const char *root);\n"
10865 #: ../src/guestfs-actions.pod:3079
10867 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10868 "disk), then this returns true if a live image was detected on the disk."
10872 #: ../src/guestfs-actions.pod:3087
10873 msgid "guestfs_inspect_is_multipart"
10877 #: ../src/guestfs-actions.pod:3089
10881 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10882 " const char *root);\n"
10887 #: ../src/guestfs-actions.pod:3096
10889 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10890 "disk), then this returns true if the disk is part of a set."
10894 #: ../src/guestfs-actions.pod:3104
10895 msgid "guestfs_inspect_is_netinst"
10899 #: ../src/guestfs-actions.pod:3106
10903 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10904 " const char *root);\n"
10909 #: ../src/guestfs-actions.pod:3113
10911 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10912 "disk), then this returns true if the disk is a network installer, ie. not a "
10913 "self-contained install CD but one which is likely to require network access "
10914 "to complete the install."
10918 #: ../src/guestfs-actions.pod:3123
10919 msgid "guestfs_inspect_list_applications"
10923 #: ../src/guestfs-actions.pod:3125
10926 " struct guestfs_application_list *\n"
10927 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10928 " const char *root);\n"
10933 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2176
10934 msgid "Return the list of applications installed in the operating system."
10938 #: ../src/guestfs-actions.pod:3134
10940 "I<Note:> This call works differently from other parts of the inspection "
10941 "API. You have to call C<guestfs_inspect_os>, then "
10942 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10943 "this. Listing applications is a significantly more difficult operation "
10944 "which requires access to the full filesystem. Also note that unlike the "
10945 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10946 "the libguestfs handle, this call actually reads parts of the mounted "
10947 "filesystems during the call."
10951 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2188
10953 "This returns an empty list if the inspection code was not able to determine "
10954 "the list of applications."
10958 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
10959 msgid "The application structure contains the following fields:"
10963 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
10964 msgid "C<app_name>"
10968 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
10970 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10971 "guests, this is the package name."
10975 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
10976 msgid "C<app_display_name>"
10980 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
10982 "The display name of the application, sometimes localized to the install "
10983 "language of the guest operating system."
10987 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
10989 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10990 "to display something can use C<app_name> instead."
10994 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
10995 msgid "C<app_epoch>"
10999 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11001 "For package managers which use epochs, this contains the epoch of the "
11002 "package (an integer). If unavailable, this is returned as C<0>."
11006 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11007 msgid "C<app_version>"
11011 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11013 "The version string of the application or package. If unavailable this is "
11014 "returned as an empty string C<\"\">."
11018 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11019 msgid "C<app_release>"
11023 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
11025 "The release string of the application or package, for package managers that "
11026 "use this. If unavailable this is returned as an empty string C<\"\">."
11030 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
11031 msgid "C<app_install_path>"
11035 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11037 "The installation path of the application (on operating systems such as "
11038 "Windows which use installation paths). This path is in the format used by "
11039 "the guest operating system, it is not a libguestfs path."
11043 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
11044 msgid "If unavailable this is returned as an empty string C<\"\">."
11048 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11049 msgid "C<app_trans_path>"
11053 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11055 "The install path translated into a libguestfs path. If unavailable this is "
11056 "returned as an empty string C<\"\">."
11060 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11061 msgid "C<app_publisher>"
11065 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11067 "The name of the publisher of the application, for package managers that use "
11068 "this. If unavailable this is returned as an empty string C<\"\">."
11072 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11077 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11079 "The URL (eg. upstream URL) of the application. If unavailable this is "
11080 "returned as an empty string C<\"\">."
11084 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11085 msgid "C<app_source_package>"
11089 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11091 "For packaging systems which support this, the name of the source package. "
11092 "If unavailable this is returned as an empty string C<\"\">."
11096 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11097 msgid "C<app_summary>"
11101 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11103 "A short (usually one line) description of the application or package. If "
11104 "unavailable this is returned as an empty string C<\"\">."
11108 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11109 msgid "C<app_description>"
11113 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
11115 "A longer description of the application or package. If unavailable this is "
11116 "returned as an empty string C<\"\">."
11120 #: ../src/guestfs-actions.pod:3224
11122 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11123 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11128 #: ../src/guestfs-actions.pod:3228
11129 msgid "(Added in 1.7.8)"
11133 #: ../src/guestfs-actions.pod:3230
11134 msgid "guestfs_inspect_os"
11138 #: ../src/guestfs-actions.pod:3232
11142 " guestfs_inspect_os (guestfs_h *g);\n"
11147 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2272
11149 "This function uses other libguestfs functions and certain heuristics to "
11150 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11151 "for operating systems."
11155 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2276
11156 msgid "The list returned is empty if no operating systems were found."
11160 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2278
11162 "If one operating system was found, then this returns a list with a single "
11163 "element, which is the name of the root filesystem of this operating system. "
11164 "It is also possible for this function to return a list containing more than "
11165 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11166 "element being the root filesystem of one of the operating systems."
11170 #: ../src/guestfs-actions.pod:3248
11172 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11173 "functions in order to query further information about each operating system, "
11174 "such as the name and version."
11178 #: ../src/guestfs-actions.pod:3253
11180 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11181 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11182 "the contents. This should be called with no disks currently mounted. The "
11183 "function may also use Augeas, so any existing Augeas handle will be closed."
11187 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2296
11189 "This function cannot decrypt encrypted disks. The caller must do that first "
11190 "(supplying the necessary keys) if the disk is encrypted."
11194 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3617
11195 msgid "See also C<guestfs_list_filesystems>."
11199 #: ../src/guestfs-actions.pod:3273
11200 msgid "guestfs_is_blockdev"
11204 #: ../src/guestfs-actions.pod:3275
11208 " guestfs_is_blockdev (guestfs_h *g,\n"
11209 " const char *path);\n"
11214 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2308
11216 "This returns C<true> if and only if there is a block device with the given "
11221 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3311 ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3443
11222 msgid "See also C<guestfs_stat>."
11226 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3447
11227 msgid "(Added in 1.5.10)"
11231 #: ../src/guestfs-actions.pod:3288
11232 msgid "guestfs_is_busy"
11236 #: ../src/guestfs-actions.pod:3290
11240 " guestfs_is_busy (guestfs_h *g);\n"
11245 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2317
11247 "This returns true iff this handle is busy processing a command (in the "
11252 #: ../src/guestfs-actions.pod:3302
11253 msgid "guestfs_is_chardev"
11257 #: ../src/guestfs-actions.pod:3304
11261 " guestfs_is_chardev (guestfs_h *g,\n"
11262 " const char *path);\n"
11267 #: ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:2326
11269 "This returns C<true> if and only if there is a character device with the "
11270 "given C<path> name."
11274 #: ../src/guestfs-actions.pod:3317
11275 msgid "guestfs_is_config"
11279 #: ../src/guestfs-actions.pod:3319
11283 " guestfs_is_config (guestfs_h *g);\n"
11288 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2335
11290 "This returns true iff this handle is being configured (in the C<CONFIG> "
11295 #: ../src/guestfs-actions.pod:3331
11296 msgid "guestfs_is_dir"
11300 #: ../src/guestfs-actions.pod:3333
11304 " guestfs_is_dir (guestfs_h *g,\n"
11305 " const char *path);\n"
11310 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2344
11312 "This returns C<true> if and only if there is a directory with the given "
11313 "C<path> name. Note that it returns false for other objects like files."
11317 #: ../src/guestfs-actions.pod:3347
11318 msgid "guestfs_is_fifo"
11322 #: ../src/guestfs-actions.pod:3349
11326 " guestfs_is_fifo (guestfs_h *g,\n"
11327 " const char *path);\n"
11332 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2354
11334 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11335 "given C<path> name."
11339 #: ../src/guestfs-actions.pod:3362
11340 msgid "guestfs_is_file"
11344 #: ../src/guestfs-actions.pod:3364
11348 " guestfs_is_file (guestfs_h *g,\n"
11349 " const char *path);\n"
11354 #: ../src/guestfs-actions.pod:3368 ../fish/guestfish-actions.pod:2363
11356 "This returns C<true> if and only if there is a regular file with the given "
11357 "C<path> name. Note that it returns false for other objects like "
11362 #: ../src/guestfs-actions.pod:3378
11363 msgid "guestfs_is_launching"
11367 #: ../src/guestfs-actions.pod:3380
11371 " guestfs_is_launching (guestfs_h *g);\n"
11376 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2373
11378 "This returns true iff this handle is launching the subprocess (in the "
11379 "C<LAUNCHING> state)."
11383 #: ../src/guestfs-actions.pod:3392
11384 msgid "guestfs_is_lv"
11388 #: ../src/guestfs-actions.pod:3394
11392 " guestfs_is_lv (guestfs_h *g,\n"
11393 " const char *device);\n"
11398 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2382
11400 "This command tests whether C<device> is a logical volume, and returns true "
11401 "iff this is the case."
11405 #: ../src/guestfs-actions.pod:3405
11406 msgid "guestfs_is_ready"
11410 #: ../src/guestfs-actions.pod:3407
11414 " guestfs_is_ready (guestfs_h *g);\n"
11419 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2389
11421 "This returns true iff this handle is ready to accept commands (in the "
11426 #: ../src/guestfs-actions.pod:3419
11427 msgid "guestfs_is_socket"
11431 #: ../src/guestfs-actions.pod:3421
11435 " guestfs_is_socket (guestfs_h *g,\n"
11436 " const char *path);\n"
11441 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2398
11443 "This returns C<true> if and only if there is a Unix domain socket with the "
11444 "given C<path> name."
11448 #: ../src/guestfs-actions.pod:3434
11449 msgid "guestfs_is_symlink"
11453 #: ../src/guestfs-actions.pod:3436
11457 " guestfs_is_symlink (guestfs_h *g,\n"
11458 " const char *path);\n"
11463 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:2407
11465 "This returns C<true> if and only if there is a symbolic link with the given "
11470 #: ../src/guestfs-actions.pod:3449
11471 msgid "guestfs_kill_subprocess"
11475 #: ../src/guestfs-actions.pod:3451
11479 " guestfs_kill_subprocess (guestfs_h *g);\n"
11484 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2416
11485 msgid "This kills the qemu subprocess. You should never need to call this."
11489 #: ../src/guestfs-actions.pod:3460
11490 msgid "guestfs_launch"
11494 #: ../src/guestfs-actions.pod:3462
11498 " guestfs_launch (guestfs_h *g);\n"
11503 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2424
11505 "Internally libguestfs is implemented by running a virtual machine using "
11510 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
11512 "You should call this after configuring the handle (eg. adding drives) but "
11513 "before performing any actions."
11517 #: ../src/guestfs-actions.pod:3480
11518 msgid "guestfs_lchown"
11522 #: ../src/guestfs-actions.pod:3482
11526 " guestfs_lchown (guestfs_h *g,\n"
11529 " const char *path);\n"
11534 #: ../src/guestfs-actions.pod:3488
11536 "Change the file owner to C<owner> and group to C<group>. This is like "
11537 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11538 "changed, not the target."
11542 #: ../src/guestfs-actions.pod:3500
11543 msgid "guestfs_lgetxattr"
11547 #: ../src/guestfs-actions.pod:3502
11551 " guestfs_lgetxattr (guestfs_h *g,\n"
11552 " const char *path,\n"
11553 " const char *name,\n"
11554 " size_t *size_r);\n"
11559 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2446
11561 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11562 "is a symlink, then this call returns an extended attribute from the symlink."
11566 #: ../src/guestfs-actions.pod:3522
11567 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11571 #: ../src/guestfs-actions.pod:3530
11572 msgid "guestfs_lgetxattrs"
11576 #: ../src/guestfs-actions.pod:3532
11579 " struct guestfs_xattr_list *\n"
11580 " guestfs_lgetxattrs (guestfs_h *g,\n"
11581 " const char *path);\n"
11586 #: ../src/guestfs-actions.pod:3536
11588 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11589 "then it returns the extended attributes of the link itself."
11593 #: ../src/guestfs-actions.pod:3546
11594 msgid "guestfs_list_devices"
11598 #: ../src/guestfs-actions.pod:3548
11602 " guestfs_list_devices (guestfs_h *g);\n"
11607 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2474
11608 msgid "List all the block devices."
11612 #: ../src/guestfs-actions.pod:3553 ../fish/guestfish-actions.pod:2476
11613 msgid "The full block device names are returned, eg. C</dev/sda>."
11617 #: ../src/guestfs-actions.pod:3563
11618 msgid "guestfs_list_filesystems"
11622 #: ../src/guestfs-actions.pod:3565
11626 " guestfs_list_filesystems (guestfs_h *g);\n"
11631 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2484
11633 "This inspection command looks for filesystems on partitions, block devices "
11634 "and logical volumes, returning a list of devices containing filesystems and "
11639 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2488
11641 "The return value is a hash, where the keys are the devices containing "
11642 "filesystems, and the values are the filesystem types. For example:"
11646 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11649 " \"/dev/sda1\" => \"ntfs\"\n"
11650 " \"/dev/sda2\" => \"ext2\"\n"
11651 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11652 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11657 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
11659 "The value can have the special value \"unknown\", meaning the content of the "
11660 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11664 #: ../src/guestfs-actions.pod:3585
11666 "This command runs other libguestfs commands, which might include "
11667 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11668 "soon after launch and only when nothing is mounted."
11672 #: ../src/guestfs-actions.pod:3589
11674 "Not all of the filesystems returned will be mountable. In particular, swap "
11675 "partitions are returned in the list. Also this command does not check that "
11676 "each filesystem found is valid and mountable, and some filesystems might be "
11677 "mountable but require special options. Filesystems may not all belong to a "
11678 "single logical operating system (use C<guestfs_inspect_os> to look for "
11683 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:5224
11684 msgid "(Added in 1.5.15)"
11688 #: ../src/guestfs-actions.pod:3605
11689 msgid "guestfs_list_partitions"
11693 #: ../src/guestfs-actions.pod:3607
11697 " guestfs_list_partitions (guestfs_h *g);\n"
11702 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
11703 msgid "List all the partitions detected on all block devices."
11707 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2519
11708 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11712 #: ../src/guestfs-actions.pod:3614
11714 "This does not return logical volumes. For that you will need to call "
11719 #: ../src/guestfs-actions.pod:3625
11724 #: ../src/guestfs-actions.pod:3627
11728 " guestfs_ll (guestfs_h *g,\n"
11729 " const char *directory);\n"
11734 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2530
11736 "List the files in C<directory> (relative to the root directory, there is no "
11737 "cwd) in the format of 'ls -la'."
11741 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
11743 "This command is mostly useful for interactive sessions. It is I<not> "
11744 "intended that you try to parse the output string."
11748 #: ../src/guestfs-actions.pod:3642
11753 #: ../src/guestfs-actions.pod:3644
11757 " guestfs_ln (guestfs_h *g,\n"
11758 " const char *target,\n"
11759 " const char *linkname);\n"
11764 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2540
11765 msgid "This command creates a hard link using the C<ln> command."
11769 #: ../src/guestfs-actions.pod:3655
11770 msgid "guestfs_ln_f"
11774 #: ../src/guestfs-actions.pod:3657
11778 " guestfs_ln_f (guestfs_h *g,\n"
11779 " const char *target,\n"
11780 " const char *linkname);\n"
11785 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2546
11787 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11788 "option removes the link (C<linkname>) if it exists already."
11792 #: ../src/guestfs-actions.pod:3669
11793 msgid "guestfs_ln_s"
11797 #: ../src/guestfs-actions.pod:3671
11801 " guestfs_ln_s (guestfs_h *g,\n"
11802 " const char *target,\n"
11803 " const char *linkname);\n"
11808 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2553
11809 msgid "This command creates a symbolic link using the C<ln -s> command."
11813 #: ../src/guestfs-actions.pod:3682
11814 msgid "guestfs_ln_sf"
11818 #: ../src/guestfs-actions.pod:3684
11822 " guestfs_ln_sf (guestfs_h *g,\n"
11823 " const char *target,\n"
11824 " const char *linkname);\n"
11829 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2559
11831 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11832 "option removes the link (C<linkname>) if it exists already."
11836 #: ../src/guestfs-actions.pod:3696
11837 msgid "guestfs_lremovexattr"
11841 #: ../src/guestfs-actions.pod:3698
11845 " guestfs_lremovexattr (guestfs_h *g,\n"
11846 " const char *xattr,\n"
11847 " const char *path);\n"
11852 #: ../src/guestfs-actions.pod:3703
11854 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11855 "link, then it removes an extended attribute of the link itself."
11859 #: ../src/guestfs-actions.pod:3711
11864 #: ../src/guestfs-actions.pod:3713
11868 " guestfs_ls (guestfs_h *g,\n"
11869 " const char *directory);\n"
11874 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2574
11876 "List the files in C<directory> (relative to the root directory, there is no "
11877 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11882 #: ../src/guestfs-actions.pod:3721
11884 "This command is mostly useful for interactive sessions. Programs should "
11885 "probably use C<guestfs_readdir> instead."
11889 #: ../src/guestfs-actions.pod:3730
11890 msgid "guestfs_lsetxattr"
11894 #: ../src/guestfs-actions.pod:3732
11898 " guestfs_lsetxattr (guestfs_h *g,\n"
11899 " const char *xattr,\n"
11900 " const char *val,\n"
11902 " const char *path);\n"
11907 #: ../src/guestfs-actions.pod:3739
11909 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11910 "then it sets an extended attribute of the link itself."
11914 #: ../src/guestfs-actions.pod:3747
11915 msgid "guestfs_lstat"
11919 #: ../src/guestfs-actions.pod:3749
11922 " struct guestfs_stat *\n"
11923 " guestfs_lstat (guestfs_h *g,\n"
11924 " const char *path);\n"
11929 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:6355 ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:4306
11930 msgid "Returns file information for the given C<path>."
11934 #: ../src/guestfs-actions.pod:3755
11936 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11937 "link, then the link is stat-ed, not the file it refers to."
11941 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2599
11942 msgid "This is the same as the C<lstat(2)> system call."
11946 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:6359
11948 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11949 "error. I<The caller must call C<guestfs_free_stat> after use>."
11953 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6762
11954 msgid "(Added in 0.9.2)"
11958 #: ../src/guestfs-actions.pod:3767
11959 msgid "guestfs_lstatlist"
11963 #: ../src/guestfs-actions.pod:3769
11966 " struct guestfs_stat_list *\n"
11967 " guestfs_lstatlist (guestfs_h *g,\n"
11968 " const char *path,\n"
11969 " char *const *names);\n"
11974 #: ../src/guestfs-actions.pod:3774
11976 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11977 "files, where all files are in the directory C<path>. C<names> is the list "
11978 "of files from this directory."
11982 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2609
11984 "On return you get a list of stat structs, with a one-to-one correspondence "
11985 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11986 "then the C<ino> field of that structure is set to C<-1>."
11990 #: ../src/guestfs-actions.pod:3783
11992 "This call is intended for programs that want to efficiently list a directory "
11993 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11994 "for a similarly efficient call for getting extended attributes. Very long "
11995 "directory listings might cause the protocol message size to be exceeded, "
11996 "causing this call to fail. The caller must split up such requests into "
11997 "smaller groups of names."
12001 #: ../src/guestfs-actions.pod:3791
12003 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12004 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12008 #: ../src/guestfs-actions.pod:3797
12009 msgid "guestfs_luks_add_key"
12013 #: ../src/guestfs-actions.pod:3799
12017 " guestfs_luks_add_key (guestfs_h *g,\n"
12018 " const char *device,\n"
12019 " const char *key,\n"
12020 " const char *newkey,\n"
12026 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2626
12028 "This command adds a new key on LUKS device C<device>. C<key> is any "
12029 "existing key, and is used to access the device. C<newkey> is the new key to "
12030 "add. C<keyslot> is the key slot that will be replaced."
12034 #: ../src/guestfs-actions.pod:3811
12036 "Note that if C<keyslot> already contains a key, then this command will "
12037 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12041 #: ../src/guestfs-actions.pod:3817 ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3951
12043 "This function takes a key or passphrase parameter which could contain "
12044 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12049 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3904
12050 msgid "(Added in 1.5.2)"
12054 #: ../src/guestfs-actions.pod:3823
12055 msgid "guestfs_luks_close"
12059 #: ../src/guestfs-actions.pod:3825
12063 " guestfs_luks_close (guestfs_h *g,\n"
12064 " const char *device);\n"
12069 #: ../src/guestfs-actions.pod:3829
12071 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12072 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12073 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12074 "underlying block device."
12078 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3936 ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4053
12079 msgid "(Added in 1.5.1)"
12083 #: ../src/guestfs-actions.pod:3839
12084 msgid "guestfs_luks_format"
12088 #: ../src/guestfs-actions.pod:3841
12092 " guestfs_luks_format (guestfs_h *g,\n"
12093 " const char *device,\n"
12094 " const char *key,\n"
12100 #: ../src/guestfs-actions.pod:3847 ../fish/guestfish-actions.pod:2652
12102 "This command erases existing data on C<device> and formats the device as a "
12103 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12104 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12108 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:2660 ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2757 ../fish/guestfish-actions.pod:3347 ../fish/guestfish-actions.pod:3867 ../fish/guestfish-actions.pod:4177 ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4222 ../fish/guestfish-actions.pod:4951
12110 "B<This command is dangerous. Without careful use you can easily destroy all "
12115 #: ../src/guestfs-actions.pod:3863
12116 msgid "guestfs_luks_format_cipher"
12120 #: ../src/guestfs-actions.pod:3865
12124 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12125 " const char *device,\n"
12126 " const char *key,\n"
12128 " const char *cipher);\n"
12133 #: ../src/guestfs-actions.pod:3872
12135 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12136 "set the C<cipher> used."
12140 #: ../src/guestfs-actions.pod:3886
12141 msgid "guestfs_luks_kill_slot"
12145 #: ../src/guestfs-actions.pod:3888
12149 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12150 " const char *device,\n"
12151 " const char *key,\n"
12157 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2680
12159 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12160 "device C<device>. C<key> must be one of the I<other> keys."
12164 #: ../src/guestfs-actions.pod:3906
12165 msgid "guestfs_luks_open"
12169 #: ../src/guestfs-actions.pod:3908
12173 " guestfs_luks_open (guestfs_h *g,\n"
12174 " const char *device,\n"
12175 " const char *key,\n"
12176 " const char *mapname);\n"
12181 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12183 "This command opens a block device which has been encrypted according to the "
12184 "Linux Unified Key Setup (LUKS) standard."
12188 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12189 msgid "C<device> is the encrypted block device or partition."
12193 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
12195 "The caller must supply one of the keys associated with the LUKS block "
12196 "device, in the C<key> parameter."
12200 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12202 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12203 "writes to this block device are decrypted from and encrypted to the "
12204 "underlying C<device> respectively."
12208 #: ../src/guestfs-actions.pod:3926
12210 "If this block device contains LVM volume groups, then calling "
12211 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12216 #: ../src/guestfs-actions.pod:3938
12217 msgid "guestfs_luks_open_ro"
12221 #: ../src/guestfs-actions.pod:3940
12225 " guestfs_luks_open_ro (guestfs_h *g,\n"
12226 " const char *device,\n"
12227 " const char *key,\n"
12228 " const char *mapname);\n"
12233 #: ../src/guestfs-actions.pod:3946
12235 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12240 #: ../src/guestfs-actions.pod:3957
12241 msgid "guestfs_lvcreate"
12245 #: ../src/guestfs-actions.pod:3959
12249 " guestfs_lvcreate (guestfs_h *g,\n"
12250 " const char *logvol,\n"
12251 " const char *volgroup,\n"
12257 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2724
12259 "This creates an LVM logical volume called C<logvol> on the volume group "
12260 "C<volgroup>, with C<size> megabytes."
12264 #: ../src/guestfs-actions.pod:3972
12265 msgid "guestfs_lvm_canonical_lv_name"
12269 #: ../src/guestfs-actions.pod:3974
12273 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12274 " const char *lvname);\n"
12279 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
12281 "This converts alternative naming schemes for LVs that you might find to the "
12282 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12287 #: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:2735
12289 "This command returns an error if the C<lvname> parameter does not refer to a "
12294 #: ../src/guestfs-actions.pod:3985
12295 msgid "See also C<guestfs_is_lv>."
12299 #: ../src/guestfs-actions.pod:3990
12300 msgid "(Added in 1.5.24)"
12304 #: ../src/guestfs-actions.pod:3992
12305 msgid "guestfs_lvm_clear_filter"
12309 #: ../src/guestfs-actions.pod:3994
12313 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12318 #: ../src/guestfs-actions.pod:3997
12320 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12321 "see every block device."
12325 #: ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2778
12326 msgid "This command also clears the LVM cache and performs a volume group scan."
12330 #: ../src/guestfs-actions.pod:4007
12331 msgid "guestfs_lvm_remove_all"
12335 #: ../src/guestfs-actions.pod:4009
12339 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12344 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2754
12346 "This command removes all LVM logical volumes, volume groups and physical "
12351 #: ../src/guestfs-actions.pod:4022
12352 msgid "guestfs_lvm_set_filter"
12356 #: ../src/guestfs-actions.pod:4024
12360 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12361 " char *const *devices);\n"
12366 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2764
12368 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12369 "block devices in the list C<devices>, and will ignore all other attached "
12374 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2768
12376 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12377 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12378 "there are two types of duplication possible: either cloned PVs/VGs which "
12379 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12380 "same name. In normal operation you cannot create this situation, but you "
12381 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12382 "inside the LVM metadata."
12386 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2781
12387 msgid "You can filter whole block devices or individual partitions."
12391 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2783
12393 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12394 "filesystem), even if you are not filtering out that VG."
12398 #: ../src/guestfs-actions.pod:4055
12399 msgid "guestfs_lvremove"
12403 #: ../src/guestfs-actions.pod:4057
12407 " guestfs_lvremove (guestfs_h *g,\n"
12408 " const char *device);\n"
12413 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2791
12415 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12416 "LV, such as C</dev/VG/LV>."
12420 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12422 "You can also remove all LVs in a volume group by specifying the VG name, "
12427 #: ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:5321 ../src/guestfs-actions.pod:7138
12428 msgid "(Added in 1.0.13)"
12432 #: ../src/guestfs-actions.pod:4071
12433 msgid "guestfs_lvrename"
12437 #: ../src/guestfs-actions.pod:4073
12441 " guestfs_lvrename (guestfs_h *g,\n"
12442 " const char *logvol,\n"
12443 " const char *newlogvol);\n"
12448 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2801
12449 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12453 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:7151
12454 msgid "(Added in 1.0.83)"
12458 #: ../src/guestfs-actions.pod:4084
12459 msgid "guestfs_lvresize"
12463 #: ../src/guestfs-actions.pod:4086
12467 " guestfs_lvresize (guestfs_h *g,\n"
12468 " const char *device,\n"
12474 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2807
12476 "This resizes (expands or shrinks) an existing LVM logical volume to "
12477 "C<mbytes>. When reducing, data in the reduced part is lost."
12481 #: ../src/guestfs-actions.pod:4099
12482 msgid "guestfs_lvresize_free"
12486 #: ../src/guestfs-actions.pod:4101
12490 " guestfs_lvresize_free (guestfs_h *g,\n"
12491 " const char *lv,\n"
12497 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2815
12499 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12500 "remaining free space in the volume group. Commonly you would call this with "
12501 "pc = 100 which expands the logical volume as much as possible, using all "
12502 "remaining free space in the volume group."
12506 #: ../src/guestfs-actions.pod:4114
12507 msgid "(Added in 1.3.3)"
12511 #: ../src/guestfs-actions.pod:4116
12512 msgid "guestfs_lvs"
12516 #: ../src/guestfs-actions.pod:4118
12520 " guestfs_lvs (guestfs_h *g);\n"
12525 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2825
12527 "List all the logical volumes detected. This is the equivalent of the "
12528 "L<lvs(8)> command."
12532 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
12534 "This returns a list of the logical volume device names "
12535 "(eg. C</dev/VolGroup00/LogVol00>)."
12539 #: ../src/guestfs-actions.pod:4127
12540 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12544 #: ../src/guestfs-actions.pod:4135
12545 msgid "guestfs_lvs_full"
12549 #: ../src/guestfs-actions.pod:4137
12552 " struct guestfs_lvm_lv_list *\n"
12553 " guestfs_lvs_full (guestfs_h *g);\n"
12558 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2837
12560 "List all the logical volumes detected. This is the equivalent of the "
12561 "L<lvs(8)> command. The \"full\" version includes all fields."
12565 #: ../src/guestfs-actions.pod:4143
12567 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12568 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12573 #: ../src/guestfs-actions.pod:4149
12574 msgid "guestfs_lvuuid"
12578 #: ../src/guestfs-actions.pod:4151
12582 " guestfs_lvuuid (guestfs_h *g,\n"
12583 " const char *device);\n"
12588 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2844
12589 msgid "This command returns the UUID of the LVM LV C<device>."
12593 #: ../src/guestfs-actions.pod:4162
12594 msgid "guestfs_lxattrlist"
12598 #: ../src/guestfs-actions.pod:4164
12601 " struct guestfs_xattr_list *\n"
12602 " guestfs_lxattrlist (guestfs_h *g,\n"
12603 " const char *path,\n"
12604 " char *const *names);\n"
12609 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2850
12611 "This call allows you to get the extended attributes of multiple files, where "
12612 "all files are in the directory C<path>. C<names> is the list of files from "
12617 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2854
12619 "On return you get a flat list of xattr structs which must be interpreted "
12620 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12621 "C<attrval> in this struct is zero-length to indicate there was an error "
12622 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12623 "number (the number of following attributes for this file, which could be "
12624 "C<\"0\">). Then after the first xattr struct are the zero or more "
12625 "attributes for the first named file. This repeats for the second and "
12626 "subsequent files."
12630 #: ../src/guestfs-actions.pod:4183
12632 "This call is intended for programs that want to efficiently list a directory "
12633 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12634 "a similarly efficient call for getting standard stats. Very long directory "
12635 "listings might cause the protocol message size to be exceeded, causing this "
12636 "call to fail. The caller must split up such requests into smaller groups of "
12641 #: ../src/guestfs-actions.pod:4197
12642 msgid "guestfs_mkdir"
12646 #: ../src/guestfs-actions.pod:4199
12650 " guestfs_mkdir (guestfs_h *g,\n"
12651 " const char *path);\n"
12656 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:2876
12657 msgid "Create a directory named C<path>."
12661 #: ../src/guestfs-actions.pod:4209
12662 msgid "guestfs_mkdir_mode"
12666 #: ../src/guestfs-actions.pod:4211
12670 " guestfs_mkdir_mode (guestfs_h *g,\n"
12671 " const char *path,\n"
12677 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2882
12679 "This command creates a directory, setting the initial permissions of the "
12680 "directory to C<mode>."
12684 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
12686 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12687 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12692 #: ../src/guestfs-actions.pod:4223
12693 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12697 #: ../src/guestfs-actions.pod:4229
12698 msgid "guestfs_mkdir_p"
12702 #: ../src/guestfs-actions.pod:4231
12706 " guestfs_mkdir_p (guestfs_h *g,\n"
12707 " const char *path);\n"
12712 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2895
12714 "Create a directory named C<path>, creating any parent directories as "
12715 "necessary. This is like the C<mkdir -p> shell command."
12719 #: ../src/guestfs-actions.pod:4242
12720 msgid "guestfs_mkdtemp"
12724 #: ../src/guestfs-actions.pod:4244
12728 " guestfs_mkdtemp (guestfs_h *g,\n"
12729 " const char *template);\n"
12734 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
12736 "This command creates a temporary directory. The C<template> parameter "
12737 "should be a full pathname for the temporary directory name with the final "
12738 "six characters being \"XXXXXX\"."
12742 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
12744 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12745 "being suitable for Windows filesystems."
12749 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
12750 msgid "The name of the temporary directory that was created is returned."
12754 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
12755 msgid "The temporary directory is created with mode 0700 and is owned by root."
12759 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
12761 "The caller is responsible for deleting the temporary directory and its "
12762 "contents after use."
12766 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
12767 msgid "See also: L<mkdtemp(3)>"
12771 #: ../src/guestfs-actions.pod:4272
12772 msgid "guestfs_mke2fs_J"
12776 #: ../src/guestfs-actions.pod:4274
12780 " guestfs_mke2fs_J (guestfs_h *g,\n"
12781 " const char *fstype,\n"
12782 " int blocksize,\n"
12783 " const char *device,\n"
12784 " const char *journal);\n"
12789 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2925
12791 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12792 "C<journal>. It is equivalent to the command:"
12796 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2929
12799 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12804 #: ../src/guestfs-actions.pod:4287
12805 msgid "See also C<guestfs_mke2journal>."
12809 #: ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4309 ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4343 ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4695
12810 msgid "(Added in 1.0.68)"
12814 #: ../src/guestfs-actions.pod:4293
12815 msgid "guestfs_mke2fs_JL"
12819 #: ../src/guestfs-actions.pod:4295
12823 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12824 " const char *fstype,\n"
12825 " int blocksize,\n"
12826 " const char *device,\n"
12827 " const char *label);\n"
12832 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:2937
12834 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12835 "the journal labeled C<label>."
12839 #: ../src/guestfs-actions.pod:4305
12840 msgid "See also C<guestfs_mke2journal_L>."
12844 #: ../src/guestfs-actions.pod:4311
12845 msgid "guestfs_mke2fs_JU"
12849 #: ../src/guestfs-actions.pod:4313
12853 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12854 " const char *fstype,\n"
12855 " int blocksize,\n"
12856 " const char *device,\n"
12857 " const char *uuid);\n"
12862 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2946
12864 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12865 "the journal with UUID C<uuid>."
12869 #: ../src/guestfs-actions.pod:4323
12870 msgid "See also C<guestfs_mke2journal_U>."
12874 #: ../src/guestfs-actions.pod:4329
12875 msgid "guestfs_mke2journal"
12879 #: ../src/guestfs-actions.pod:4331
12883 " guestfs_mke2journal (guestfs_h *g,\n"
12884 " int blocksize,\n"
12885 " const char *device);\n"
12890 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2955
12892 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12897 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
12900 " mke2fs -O journal_dev -b blocksize device\n"
12905 #: ../src/guestfs-actions.pod:4345
12906 msgid "guestfs_mke2journal_L"
12910 #: ../src/guestfs-actions.pod:4347
12914 " guestfs_mke2journal_L (guestfs_h *g,\n"
12915 " int blocksize,\n"
12916 " const char *label,\n"
12917 " const char *device);\n"
12922 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:2964
12923 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12927 #: ../src/guestfs-actions.pod:4359
12928 msgid "guestfs_mke2journal_U"
12932 #: ../src/guestfs-actions.pod:4361
12936 " guestfs_mke2journal_U (guestfs_h *g,\n"
12937 " int blocksize,\n"
12938 " const char *uuid,\n"
12939 " const char *device);\n"
12944 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2970
12945 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12949 #: ../src/guestfs-actions.pod:4373
12950 msgid "guestfs_mkfifo"
12954 #: ../src/guestfs-actions.pod:4375
12958 " guestfs_mkfifo (guestfs_h *g,\n"
12960 " const char *path);\n"
12965 #: ../src/guestfs-actions.pod:4380
12967 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12968 "is just a convenient wrapper around C<guestfs_mknod>."
12972 #: ../src/guestfs-actions.pod:4390
12973 msgid "guestfs_mkfs"
12977 #: ../src/guestfs-actions.pod:4392
12981 " guestfs_mkfs (guestfs_h *g,\n"
12982 " const char *fstype,\n"
12983 " const char *device);\n"
12988 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2986
12990 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12991 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12995 #: ../src/guestfs-actions.pod:4405
12996 msgid "guestfs_mkfs_b"
13000 #: ../src/guestfs-actions.pod:4407
13004 " guestfs_mkfs_b (guestfs_h *g,\n"
13005 " const char *fstype,\n"
13006 " int blocksize,\n"
13007 " const char *device);\n"
13012 #: ../src/guestfs-actions.pod:4413
13014 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13015 "block size of the resulting filesystem. Supported block sizes depend on the "
13016 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13020 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3026
13022 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13027 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3002
13029 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13034 #: ../src/guestfs-actions.pod:4432
13035 msgid "guestfs_mkfs_opts"
13039 #: ../src/guestfs-actions.pod:4434
13043 " guestfs_mkfs_opts (guestfs_h *g,\n"
13044 " const char *fstype,\n"
13045 " const char *device,\n"
13051 #: ../src/guestfs-actions.pod:4445
13054 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13055 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13060 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3013
13062 "This function creates a filesystem on C<device>. The filesystem type is "
13063 "C<fstype>, for example C<ext3>."
13067 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:3020
13068 msgid "C<blocksize>"
13072 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3022
13074 "The filesystem block size. Supported block sizes depend on the filesystem "
13075 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13080 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3029
13081 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13085 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3031
13086 msgid "C<features>"
13090 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3033
13091 msgid "This passes the I<-O> parameter to the external mkfs program."
13095 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3035
13097 "For certain filesystem types, this allows extra filesystem features to be "
13098 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13102 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3039
13104 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13109 #: ../src/guestfs-actions.pod:4481
13110 msgid "(Added in 1.7.19)"
13114 #: ../src/guestfs-actions.pod:4483
13115 msgid "guestfs_mkfs_opts_va"
13119 #: ../src/guestfs-actions.pod:4485
13123 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13124 " const char *fstype,\n"
13125 " const char *device,\n"
13126 " va_list args);\n"
13131 #: ../src/guestfs-actions.pod:4491
13132 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13136 #: ../src/guestfs-actions.pod:4495
13137 msgid "guestfs_mkfs_opts_argv"
13141 #: ../src/guestfs-actions.pod:4497
13145 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13146 " const char *fstype,\n"
13147 " const char *device,\n"
13148 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13153 #: ../src/guestfs-actions.pod:4503
13154 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13158 #: ../src/guestfs-actions.pod:4507
13159 msgid "guestfs_mkmountpoint"
13163 #: ../src/guestfs-actions.pod:4509
13167 " guestfs_mkmountpoint (guestfs_h *g,\n"
13168 " const char *exemptpath);\n"
13173 #: ../src/guestfs-actions.pod:4513
13175 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13176 "that can be used to create extra mountpoints before mounting the first "
13181 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3054
13183 "These calls are I<only> necessary in some very limited circumstances, mainly "
13184 "the case where you want to mount a mix of unrelated and/or read-only "
13185 "filesystems together."
13189 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13191 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13192 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13193 "inside that. You can unpack this as follows in guestfish:"
13197 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
13200 " add-ro Fedora-11-i686-Live.iso\n"
13202 " mkmountpoint /cd\n"
13203 " mkmountpoint /sqsh\n"
13204 " mkmountpoint /ext3fs\n"
13205 " mount /dev/sda /cd\n"
13206 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13207 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13212 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3072
13213 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13217 #: ../src/guestfs-actions.pod:4537
13219 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13220 "may get unexpected errors if you try to mix these calls. It is safest to "
13221 "manually unmount filesystems and remove mountpoints after use."
13225 #: ../src/guestfs-actions.pod:4541
13227 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13228 "first, so for this to work for manual mountpoints, you must ensure that the "
13229 "innermost mountpoints have the longest pathnames, as in the example code "
13234 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3083
13235 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13239 #: ../src/guestfs-actions.pod:4548
13241 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13242 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13243 "can also trigger these issues."
13247 #: ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:5739
13248 msgid "(Added in 1.0.62)"
13252 #: ../src/guestfs-actions.pod:4556
13253 msgid "guestfs_mknod"
13257 #: ../src/guestfs-actions.pod:4558
13261 " guestfs_mknod (guestfs_h *g,\n"
13265 " const char *path);\n"
13270 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3093
13272 "This call creates block or character special devices, or named pipes "
13277 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13279 "The C<mode> parameter should be the mode, using the standard constants. "
13280 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13281 "used when creating block and character special devices."
13285 #: ../src/guestfs-actions.pod:4573
13287 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13288 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13289 "regular file). These constants are available in the standard Linux header "
13290 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13291 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13292 "the appropriate constant for you."
13296 #: ../src/guestfs-actions.pod:4587
13297 msgid "guestfs_mknod_b"
13301 #: ../src/guestfs-actions.pod:4589
13305 " guestfs_mknod_b (guestfs_h *g,\n"
13309 " const char *path);\n"
13314 #: ../src/guestfs-actions.pod:4596
13316 "This call creates a block device node called C<path> with mode C<mode> and "
13317 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13318 "wrapper around C<guestfs_mknod>."
13322 #: ../src/guestfs-actions.pod:4606
13323 msgid "guestfs_mknod_c"
13327 #: ../src/guestfs-actions.pod:4608
13331 " guestfs_mknod_c (guestfs_h *g,\n"
13335 " const char *path);\n"
13340 #: ../src/guestfs-actions.pod:4615
13342 "This call creates a char device node called C<path> with mode C<mode> and "
13343 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13344 "wrapper around C<guestfs_mknod>."
13348 #: ../src/guestfs-actions.pod:4625
13349 msgid "guestfs_mkswap"
13353 #: ../src/guestfs-actions.pod:4627
13357 " guestfs_mkswap (guestfs_h *g,\n"
13358 " const char *device);\n"
13363 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3135
13364 msgid "Create a swap partition on C<device>."
13368 #: ../src/guestfs-actions.pod:4637
13369 msgid "guestfs_mkswap_L"
13373 #: ../src/guestfs-actions.pod:4639
13377 " guestfs_mkswap_L (guestfs_h *g,\n"
13378 " const char *label,\n"
13379 " const char *device);\n"
13384 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3141
13385 msgid "Create a swap partition on C<device> with label C<label>."
13389 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3143
13391 "Note that you cannot attach a swap label to a block device "
13392 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13393 "the kernel or swap tools."
13397 #: ../src/guestfs-actions.pod:4654
13398 msgid "guestfs_mkswap_U"
13402 #: ../src/guestfs-actions.pod:4656
13406 " guestfs_mkswap_U (guestfs_h *g,\n"
13407 " const char *uuid,\n"
13408 " const char *device);\n"
13413 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3151
13414 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13418 #: ../src/guestfs-actions.pod:4667
13419 msgid "guestfs_mkswap_file"
13423 #: ../src/guestfs-actions.pod:4669
13427 " guestfs_mkswap_file (guestfs_h *g,\n"
13428 " const char *path);\n"
13433 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3157
13434 msgid "Create a swap file."
13438 #: ../src/guestfs-actions.pod:4675
13440 "This command just writes a swap file signature to an existing file. To "
13441 "create the file itself, use something like C<guestfs_fallocate>."
13445 #: ../src/guestfs-actions.pod:4682
13446 msgid "guestfs_modprobe"
13450 #: ../src/guestfs-actions.pod:4684
13454 " guestfs_modprobe (guestfs_h *g,\n"
13455 " const char *modulename);\n"
13460 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3166
13461 msgid "This loads a kernel module in the appliance."
13465 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3168
13467 "The kernel module must have been whitelisted when libguestfs was built (see "
13468 "C<appliance/kmod.whitelist.in> in the source)."
13472 #: ../src/guestfs-actions.pod:4697
13473 msgid "guestfs_mount"
13477 #: ../src/guestfs-actions.pod:4699
13481 " guestfs_mount (guestfs_h *g,\n"
13482 " const char *device,\n"
13483 " const char *mountpoint);\n"
13488 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3175
13490 "Mount a guest disk at a position in the filesystem. Block devices are named "
13491 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13492 "those block devices contain partitions, they will have the usual names "
13493 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13497 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13499 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13500 "mounted on C</> before others can be mounted. Other filesystems can only be "
13501 "mounted on directories which already exist."
13505 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
13507 "The mounted filesystem is writable, if we have sufficient permissions on the "
13508 "underlying device."
13512 #: ../src/guestfs-actions.pod:4718
13514 "B<Important note:> When you use this call, the filesystem options C<sync> "
13515 "and C<noatime> are set implicitly. This was originally done because we "
13516 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13517 "very large negative performance impact and negligible effect on "
13518 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13519 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13520 "(use an empty string for the first parameter if you don't want any options)."
13524 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3199
13526 "This function is deprecated. In new code, use the C<mount_options> call "
13531 #: ../src/guestfs-actions.pod:4739
13532 msgid "guestfs_mount_loop"
13536 #: ../src/guestfs-actions.pod:4741
13540 " guestfs_mount_loop (guestfs_h *g,\n"
13541 " const char *file,\n"
13542 " const char *mountpoint);\n"
13547 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3210
13549 "This command lets you mount C<file> (a filesystem image in a file) on a "
13550 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13555 #: ../src/guestfs-actions.pod:4754
13556 msgid "guestfs_mount_options"
13560 #: ../src/guestfs-actions.pod:4756
13564 " guestfs_mount_options (guestfs_h *g,\n"
13565 " const char *options,\n"
13566 " const char *device,\n"
13567 " const char *mountpoint);\n"
13572 #: ../src/guestfs-actions.pod:4762
13574 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13575 "the mount options as for the L<mount(8)> I<-o> flag."
13579 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3222
13581 "If the C<options> parameter is an empty string, then no options are passed "
13582 "(all options default to whatever the filesystem uses)."
13586 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4803
13587 msgid "(Added in 1.0.10)"
13591 #: ../src/guestfs-actions.pod:4774
13592 msgid "guestfs_mount_ro"
13596 #: ../src/guestfs-actions.pod:4776
13600 " guestfs_mount_ro (guestfs_h *g,\n"
13601 " const char *device,\n"
13602 " const char *mountpoint);\n"
13607 #: ../src/guestfs-actions.pod:4781
13609 "This is the same as the C<guestfs_mount> command, but it mounts the "
13610 "filesystem with the read-only (I<-o ro>) flag."
13614 #: ../src/guestfs-actions.pod:4788
13615 msgid "guestfs_mount_vfs"
13619 #: ../src/guestfs-actions.pod:4790
13623 " guestfs_mount_vfs (guestfs_h *g,\n"
13624 " const char *options,\n"
13625 " const char *vfstype,\n"
13626 " const char *device,\n"
13627 " const char *mountpoint);\n"
13632 #: ../src/guestfs-actions.pod:4797
13634 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13635 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13640 #: ../src/guestfs-actions.pod:4805
13641 msgid "guestfs_mountpoints"
13645 #: ../src/guestfs-actions.pod:4807
13649 " guestfs_mountpoints (guestfs_h *g);\n"
13654 #: ../src/guestfs-actions.pod:4810
13656 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13657 "devices. This one returns a hash table (map) of device name to directory "
13658 "where the device is mounted."
13662 #: ../src/guestfs-actions.pod:4822
13663 msgid "guestfs_mounts"
13667 #: ../src/guestfs-actions.pod:4824
13671 " guestfs_mounts (guestfs_h *g);\n"
13676 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3253
13678 "This returns the list of currently mounted filesystems. It returns the list "
13679 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13683 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3256
13684 msgid "Some internal mounts are not shown."
13688 #: ../src/guestfs-actions.pod:4832
13689 msgid "See also: C<guestfs_mountpoints>"
13693 #: ../src/guestfs-actions.pod:4840
13698 #: ../src/guestfs-actions.pod:4842
13702 " guestfs_mv (guestfs_h *g,\n"
13703 " const char *src,\n"
13704 " const char *dest);\n"
13709 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3264
13711 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13712 "destination filename or destination directory."
13716 #: ../src/guestfs-actions.pod:4854
13717 msgid "guestfs_ntfs_3g_probe"
13721 #: ../src/guestfs-actions.pod:4856
13725 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13727 " const char *device);\n"
13732 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
13734 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13735 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13736 "read-write, and some cannot be mounted at all)."
13740 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
13742 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13743 "can be mounted read-write. Set it to false if you want to test if the "
13744 "volume can be mounted read-only."
13748 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3279
13750 "The return value is an integer which C<0> if the operation would succeed, or "
13751 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13755 #: ../src/guestfs-actions.pod:4875
13756 msgid "(Added in 1.0.43)"
13760 #: ../src/guestfs-actions.pod:4877
13761 msgid "guestfs_ntfsresize"
13765 #: ../src/guestfs-actions.pod:4879
13769 " guestfs_ntfsresize (guestfs_h *g,\n"
13770 " const char *device);\n"
13775 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3287
13777 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13778 "size of the underlying device."
13782 #: ../src/guestfs-actions.pod:4886 ../fish/guestfish-actions.pod:3290
13784 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
13785 "consistency check (for safety). You have to boot into Windows to perform "
13786 "this check and clear this condition. Furthermore, ntfsresize refuses to "
13787 "resize filesystems which have been marked in this way. So in effect it is "
13788 "not possible to call ntfsresize multiple times on a single filesystem "
13789 "without booting into Windows between each resize."
13793 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3298
13794 msgid "See also L<ntfsresize(8)>."
13798 #: ../src/guestfs-actions.pod:4900
13799 msgid "guestfs_ntfsresize_size"
13803 #: ../src/guestfs-actions.pod:4902
13807 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13808 " const char *device,\n"
13809 " int64_t size);\n"
13814 #: ../src/guestfs-actions.pod:4907
13816 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13817 "to specify the new size (in bytes) explicitly."
13821 #: ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:5348 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5687 ../src/guestfs-actions.pod:7293
13822 msgid "(Added in 1.3.14)"
13826 #: ../src/guestfs-actions.pod:4914
13827 msgid "guestfs_part_add"
13831 #: ../src/guestfs-actions.pod:4916
13835 " guestfs_part_add (guestfs_h *g,\n"
13836 " const char *device,\n"
13837 " const char *prlogex,\n"
13838 " int64_t startsect,\n"
13839 " int64_t endsect);\n"
13844 #: ../src/guestfs-actions.pod:4923
13846 "This command adds a partition to C<device>. If there is no partition table "
13847 "on the device, call C<guestfs_part_init> first."
13851 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3314
13853 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13854 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13855 "C<logical>) and C<e> (or C<extended>) partition types."
13859 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
13861 "C<startsect> and C<endsect> are the start and end of the partition in "
13862 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13863 "from the end of the disk (C<-1> is the last sector)."
13867 #: ../src/guestfs-actions.pod:4935
13869 "Creating a partition which covers the whole disk is not so easy. Use "
13870 "C<guestfs_part_disk> to do that."
13874 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4978 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5109 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5206
13875 msgid "(Added in 1.0.78)"
13879 #: ../src/guestfs-actions.pod:4942
13880 msgid "guestfs_part_del"
13884 #: ../src/guestfs-actions.pod:4944
13888 " guestfs_part_del (guestfs_h *g,\n"
13889 " const char *device,\n"
13895 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3330
13896 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13900 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3332
13902 "Note that in the case of MBR partitioning, deleting an extended partition "
13903 "also deletes any logical partitions it contains."
13907 #: ../src/guestfs-actions.pod:4959
13908 msgid "guestfs_part_disk"
13912 #: ../src/guestfs-actions.pod:4961
13916 " guestfs_part_disk (guestfs_h *g,\n"
13917 " const char *device,\n"
13918 " const char *parttype);\n"
13923 #: ../src/guestfs-actions.pod:4966
13925 "This command is simply a combination of C<guestfs_part_init> followed by "
13926 "C<guestfs_part_add> to create a single primary partition covering the whole "
13931 #: ../src/guestfs-actions.pod:4970
13933 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13934 "possible values are described in C<guestfs_part_init>."
13938 #: ../src/guestfs-actions.pod:4980
13939 msgid "guestfs_part_get_bootable"
13943 #: ../src/guestfs-actions.pod:4982
13947 " guestfs_part_get_bootable (guestfs_h *g,\n"
13948 " const char *device,\n"
13954 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3354
13956 "This command returns true if the partition C<partnum> on C<device> has the "
13957 "bootable flag set."
13961 #: ../src/guestfs-actions.pod:4990
13962 msgid "See also C<guestfs_part_set_bootable>."
13966 #: ../src/guestfs-actions.pod:4996
13967 msgid "guestfs_part_get_mbr_id"
13971 #: ../src/guestfs-actions.pod:4998
13975 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13976 " const char *device,\n"
13982 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3363
13984 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13985 "partition C<partnum>."
13989 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5182
13991 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13992 "undefined results for other partition table types (see "
13993 "C<guestfs_part_get_parttype>)."
13997 #: ../src/guestfs-actions.pod:5014
13998 msgid "guestfs_part_get_parttype"
14002 #: ../src/guestfs-actions.pod:5016
14006 " guestfs_part_get_parttype (guestfs_h *g,\n"
14007 " const char *device);\n"
14012 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3374
14014 "This command examines the partition table on C<device> and returns the "
14015 "partition table type (format) being used."
14019 #: ../src/guestfs-actions.pod:5023
14021 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14022 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14023 "possible, although unusual. See C<guestfs_part_init> for a full list."
14027 #: ../src/guestfs-actions.pod:5033
14028 msgid "guestfs_part_init"
14032 #: ../src/guestfs-actions.pod:5035
14036 " guestfs_part_init (guestfs_h *g,\n"
14037 " const char *device,\n"
14038 " const char *parttype);\n"
14043 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14045 "This creates an empty partition table on C<device> of one of the partition "
14046 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14047 "(for large disks)."
14051 #: ../src/guestfs-actions.pod:5044
14053 "Initially there are no partitions. Following this, you should call "
14054 "C<guestfs_part_add> for each partition required."
14058 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
14059 msgid "Possible values for C<parttype> are:"
14063 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3397
14064 msgid "B<efi> | B<gpt>"
14068 #: ../src/guestfs-actions.pod:5053 ../fish/guestfish-actions.pod:3399
14069 msgid "Intel EFI / GPT partition table."
14073 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
14075 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14076 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14077 "the C<mbr> format."
14081 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3405
14082 msgid "B<mbr> | B<msdos>"
14086 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3407
14088 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14089 "Windows. This partition type will B<only> work for device sizes up to 2 "
14090 "TB. For large disks we recommend using C<gpt>."
14094 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14095 msgid "Other partition table types that may work but are not supported include:"
14099 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
14104 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3421
14105 msgid "AIX disk labels."
14109 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3423
14110 msgid "B<amiga> | B<rdb>"
14114 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3425
14115 msgid "Amiga \"Rigid Disk Block\" format."
14119 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3427
14124 #: ../src/guestfs-actions.pod:5083 ../fish/guestfish-actions.pod:3429
14125 msgid "BSD disk labels."
14129 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3431
14134 #: ../src/guestfs-actions.pod:5087 ../fish/guestfish-actions.pod:3433
14135 msgid "DASD, used on IBM mainframes."
14139 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3435
14144 #: ../src/guestfs-actions.pod:5091 ../fish/guestfish-actions.pod:3437
14145 msgid "MIPS/SGI volumes."
14149 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3439
14154 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3441
14155 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14159 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3443
14164 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3445
14165 msgid "NEC PC-98 format, common in Japan apparently."
14169 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3447
14174 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3449
14175 msgid "Sun disk labels."
14179 #: ../src/guestfs-actions.pod:5111
14180 msgid "guestfs_part_list"
14184 #: ../src/guestfs-actions.pod:5113
14187 " struct guestfs_partition_list *\n"
14188 " guestfs_part_list (guestfs_h *g,\n"
14189 " const char *device);\n"
14194 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3457
14196 "This command parses the partition table on C<device> and returns the list of "
14197 "partitions found."
14201 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
14202 msgid "The fields in the returned structure are:"
14206 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14207 msgid "B<part_num>"
14211 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14212 msgid "Partition number, counting from 1."
14216 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3468
14217 msgid "B<part_start>"
14221 #: ../src/guestfs-actions.pod:5130
14223 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14224 "the device's sector size, see C<guestfs_blockdev_getss>."
14228 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
14229 msgid "B<part_end>"
14233 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3475
14234 msgid "End of the partition in bytes."
14238 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3477
14239 msgid "B<part_size>"
14243 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3479
14244 msgid "Size of the partition in bytes."
14248 #: ../src/guestfs-actions.pod:5143
14250 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14251 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14256 #: ../src/guestfs-actions.pod:5149
14257 msgid "guestfs_part_set_bootable"
14261 #: ../src/guestfs-actions.pod:5151
14265 " guestfs_part_set_bootable (guestfs_h *g,\n"
14266 " const char *device,\n"
14268 " int bootable);\n"
14273 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3487
14275 "This sets the bootable flag on partition numbered C<partnum> on device "
14276 "C<device>. Note that partitions are numbered from 1."
14280 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3490
14282 "The bootable flag is used by some operating systems (notably Windows) to "
14283 "determine which partition to boot from. It is by no means universally "
14288 #: ../src/guestfs-actions.pod:5168
14289 msgid "guestfs_part_set_mbr_id"
14293 #: ../src/guestfs-actions.pod:5170
14297 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14298 " const char *device,\n"
14305 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:3498
14307 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14308 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14309 "documentation are in fact hexadecimal numbers, but usually documented "
14310 "without any leading \"0x\" which might be confusing."
14314 #: ../src/guestfs-actions.pod:5190
14315 msgid "guestfs_part_set_name"
14319 #: ../src/guestfs-actions.pod:5192
14323 " guestfs_part_set_name (guestfs_h *g,\n"
14324 " const char *device,\n"
14326 " const char *name);\n"
14331 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3512
14333 "This sets the partition name on partition numbered C<partnum> on device "
14334 "C<device>. Note that partitions are numbered from 1."
14338 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3515
14340 "The partition name can only be set on certain types of partition table. "
14341 "This works on C<gpt> but not on C<mbr> partitions."
14345 #: ../src/guestfs-actions.pod:5208
14346 msgid "guestfs_part_to_dev"
14350 #: ../src/guestfs-actions.pod:5210
14354 " guestfs_part_to_dev (guestfs_h *g,\n"
14355 " const char *partition);\n"
14360 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3522
14362 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14363 "partition number, returning the device name (eg. \"/dev/sdb\")."
14367 #: ../src/guestfs-actions.pod:5218
14369 "The named partition must exist, for example as a string returned from "
14370 "C<guestfs_list_partitions>."
14374 #: ../src/guestfs-actions.pod:5226
14375 msgid "guestfs_ping_daemon"
14379 #: ../src/guestfs-actions.pod:5228
14383 " guestfs_ping_daemon (guestfs_h *g);\n"
14388 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3533
14390 "This is a test probe into the guestfs daemon running inside the qemu "
14391 "subprocess. Calling this function checks that the daemon responds to the "
14392 "ping message, without affecting the daemon or attached block device(s) in "
14397 #: ../src/guestfs-actions.pod:5240
14398 msgid "guestfs_pread"
14402 #: ../src/guestfs-actions.pod:5242
14406 " guestfs_pread (guestfs_h *g,\n"
14407 " const char *path,\n"
14409 " int64_t offset,\n"
14410 " size_t *size_r);\n"
14415 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3542
14417 "This command lets you read part of a file. It reads C<count> bytes of the "
14418 "file, starting at C<offset>, from file C<path>."
14422 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3545 ../fish/guestfish-actions.pod:3560
14424 "This may read fewer bytes than requested. For further details see the "
14425 "L<pread(2)> system call."
14429 #: ../src/guestfs-actions.pod:5255
14430 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14434 #: ../src/guestfs-actions.pod:5266
14435 msgid "guestfs_pread_device"
14439 #: ../src/guestfs-actions.pod:5268
14443 " guestfs_pread_device (guestfs_h *g,\n"
14444 " const char *device,\n"
14446 " int64_t offset,\n"
14447 " size_t *size_r);\n"
14452 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3557
14454 "This command lets you read part of a file. It reads C<count> bytes of "
14455 "C<device>, starting at C<offset>."
14459 #: ../src/guestfs-actions.pod:5281
14460 msgid "See also C<guestfs_pread>."
14464 #: ../src/guestfs-actions.pod:5290
14465 msgid "(Added in 1.5.21)"
14469 #: ../src/guestfs-actions.pod:5292
14470 msgid "guestfs_pvcreate"
14474 #: ../src/guestfs-actions.pod:5294
14478 " guestfs_pvcreate (guestfs_h *g,\n"
14479 " const char *device);\n"
14484 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3572
14486 "This creates an LVM physical volume on the named C<device>, where C<device> "
14487 "should usually be a partition name such as C</dev/sda1>."
14491 #: ../src/guestfs-actions.pod:5306
14492 msgid "guestfs_pvremove"
14496 #: ../src/guestfs-actions.pod:5308
14500 " guestfs_pvremove (guestfs_h *g,\n"
14501 " const char *device);\n"
14506 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3580
14508 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14513 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3583
14515 "The implementation uses the C<pvremove> command which refuses to wipe "
14516 "physical volumes that contain any volume groups, so you have to remove those "
14521 #: ../src/guestfs-actions.pod:5323
14522 msgid "guestfs_pvresize"
14526 #: ../src/guestfs-actions.pod:5325
14530 " guestfs_pvresize (guestfs_h *g,\n"
14531 " const char *device);\n"
14536 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3591
14538 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14539 "the new size of the underlying device."
14543 #: ../src/guestfs-actions.pod:5336
14544 msgid "guestfs_pvresize_size"
14548 #: ../src/guestfs-actions.pod:5338
14552 " guestfs_pvresize_size (guestfs_h *g,\n"
14553 " const char *device,\n"
14554 " int64_t size);\n"
14559 #: ../src/guestfs-actions.pod:5343
14561 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14562 "specify the new size (in bytes) explicitly."
14566 #: ../src/guestfs-actions.pod:5350
14567 msgid "guestfs_pvs"
14571 #: ../src/guestfs-actions.pod:5352
14575 " guestfs_pvs (guestfs_h *g);\n"
14580 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3605
14582 "List all the physical volumes detected. This is the equivalent of the "
14583 "L<pvs(8)> command."
14587 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3608
14589 "This returns a list of just the device names that contain PVs "
14590 "(eg. C</dev/sda2>)."
14594 #: ../src/guestfs-actions.pod:5361
14595 msgid "See also C<guestfs_pvs_full>."
14599 #: ../src/guestfs-actions.pod:5369
14600 msgid "guestfs_pvs_full"
14604 #: ../src/guestfs-actions.pod:5371
14607 " struct guestfs_lvm_pv_list *\n"
14608 " guestfs_pvs_full (guestfs_h *g);\n"
14613 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3617
14615 "List all the physical volumes detected. This is the equivalent of the "
14616 "L<pvs(8)> command. The \"full\" version includes all fields."
14620 #: ../src/guestfs-actions.pod:5377
14622 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14623 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14628 #: ../src/guestfs-actions.pod:5383
14629 msgid "guestfs_pvuuid"
14633 #: ../src/guestfs-actions.pod:5385
14637 " guestfs_pvuuid (guestfs_h *g,\n"
14638 " const char *device);\n"
14643 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3624
14644 msgid "This command returns the UUID of the LVM PV C<device>."
14648 #: ../src/guestfs-actions.pod:5396
14649 msgid "guestfs_pwrite"
14653 #: ../src/guestfs-actions.pod:5398
14657 " guestfs_pwrite (guestfs_h *g,\n"
14658 " const char *path,\n"
14659 " const char *content,\n"
14660 " size_t content_size,\n"
14661 " int64_t offset);\n"
14666 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3630
14668 "This command writes to part of a file. It writes the data buffer C<content> "
14669 "to the file C<path> starting at offset C<offset>."
14673 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3633
14675 "This command implements the L<pwrite(2)> system call, and like that system "
14676 "call it may not write the full data requested. The return value is the "
14677 "number of bytes that were actually written to the file. This could even be "
14678 "0, although short writes are unlikely for regular files in ordinary "
14683 #: ../src/guestfs-actions.pod:5414
14684 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14688 #: ../src/guestfs-actions.pod:5423
14689 msgid "guestfs_pwrite_device"
14693 #: ../src/guestfs-actions.pod:5425
14697 " guestfs_pwrite_device (guestfs_h *g,\n"
14698 " const char *device,\n"
14699 " const char *content,\n"
14700 " size_t content_size,\n"
14701 " int64_t offset);\n"
14706 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
14708 "This command writes to part of a device. It writes the data buffer "
14709 "C<content> to C<device> starting at offset C<offset>."
14713 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3651
14715 "This command implements the L<pwrite(2)> system call, and like that system "
14716 "call it may not write the full data requested (although short writes to disk "
14717 "devices and partitions are probably impossible with standard Linux kernels)."
14721 #: ../src/guestfs-actions.pod:5440
14722 msgid "See also C<guestfs_pwrite>."
14726 #: ../src/guestfs-actions.pod:5447
14727 msgid "(Added in 1.5.20)"
14731 #: ../src/guestfs-actions.pod:5449
14732 msgid "guestfs_read_file"
14736 #: ../src/guestfs-actions.pod:5451
14740 " guestfs_read_file (guestfs_h *g,\n"
14741 " const char *path,\n"
14742 " size_t *size_r);\n"
14747 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3665
14748 msgid "This calls returns the contents of the file C<path> as a buffer."
14752 #: ../src/guestfs-actions.pod:5459
14754 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14755 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14756 "function is limited in the total size of file that can be handled."
14760 #: ../src/guestfs-actions.pod:5471
14761 msgid "(Added in 1.0.63)"
14765 #: ../src/guestfs-actions.pod:5473
14766 msgid "guestfs_read_lines"
14770 #: ../src/guestfs-actions.pod:5475
14774 " guestfs_read_lines (guestfs_h *g,\n"
14775 " const char *path);\n"
14780 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3682
14782 "The file contents are returned as a list of lines. Trailing C<LF> and "
14783 "C<CRLF> character sequences are I<not> returned."
14787 #: ../src/guestfs-actions.pod:5484
14789 "Note that this function cannot correctly handle binary files (specifically, "
14790 "files containing C<\\0> character which is treated as end of line). For "
14791 "those you need to use the C<guestfs_read_file> function which has a more "
14792 "complex interface."
14796 #: ../src/guestfs-actions.pod:5495
14797 msgid "guestfs_readdir"
14801 #: ../src/guestfs-actions.pod:5497
14804 " struct guestfs_dirent_list *\n"
14805 " guestfs_readdir (guestfs_h *g,\n"
14806 " const char *dir);\n"
14811 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
14812 msgid "This returns the list of directory entries in directory C<dir>."
14816 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
14818 "All entries in the directory are returned, including C<.> and C<..>. The "
14819 "entries are I<not> sorted, but returned in the same order as the underlying "
14824 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
14826 "Also this call returns basic file type information about each file. The "
14827 "C<ftyp> field will contain one of the following characters:"
14831 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
14836 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3707
14837 msgid "Block special"
14841 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3709
14846 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3711
14847 msgid "Char special"
14851 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3713
14856 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3715
14861 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3717
14866 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3719
14867 msgid "FIFO (named pipe)"
14871 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3721
14876 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3723
14877 msgid "Symbolic link"
14881 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3725
14886 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3727
14887 msgid "Regular file"
14891 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3729
14896 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3731
14901 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3733
14906 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3735
14907 msgid "Unknown file type"
14911 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3737
14916 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3739
14917 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14921 #: ../src/guestfs-actions.pod:5551
14923 "This function is primarily intended for use by programs. To get a simple "
14924 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14925 "consumption, use C<guestfs_ll>."
14929 #: ../src/guestfs-actions.pod:5555
14931 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14932 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14937 #: ../src/guestfs-actions.pod:5561
14938 msgid "guestfs_readlink"
14942 #: ../src/guestfs-actions.pod:5563
14946 " guestfs_readlink (guestfs_h *g,\n"
14947 " const char *path);\n"
14952 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3752
14953 msgid "This command reads the target of a symbolic link."
14957 #: ../src/guestfs-actions.pod:5574
14958 msgid "guestfs_readlinklist"
14962 #: ../src/guestfs-actions.pod:5576
14966 " guestfs_readlinklist (guestfs_h *g,\n"
14967 " const char *path,\n"
14968 " char *const *names);\n"
14973 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3758
14975 "This call allows you to do a C<readlink> operation on multiple files, where "
14976 "all files are in the directory C<path>. C<names> is the list of files from "
14981 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3762
14983 "On return you get a list of strings, with a one-to-one correspondence to the "
14984 "C<names> list. Each string is the value of the symbolic link."
14988 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3766
14990 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14991 "result string is the empty string C<\"\">. However the whole operation is "
14992 "completed even if there were C<readlink(2)> errors, and so you can call this "
14993 "function with names where you don't know if they are symbolic links already "
14994 "(albeit slightly less efficient)."
14998 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3773
15000 "This call is intended for programs that want to efficiently list a directory "
15001 "contents without making many round-trips. Very long directory listings "
15002 "might cause the protocol message size to be exceeded, causing this call to "
15003 "fail. The caller must split up such requests into smaller groups of names."
15007 #: ../src/guestfs-actions.pod:5609
15008 msgid "guestfs_realpath"
15012 #: ../src/guestfs-actions.pod:5611
15016 " guestfs_realpath (guestfs_h *g,\n"
15017 " const char *path);\n"
15022 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3784
15024 "Return the canonicalized absolute pathname of C<path>. The returned path "
15025 "has no C<.>, C<..> or symbolic link path elements."
15029 #: ../src/guestfs-actions.pod:5623
15030 msgid "guestfs_removexattr"
15034 #: ../src/guestfs-actions.pod:5625
15038 " guestfs_removexattr (guestfs_h *g,\n"
15039 " const char *xattr,\n"
15040 " const char *path);\n"
15045 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3791
15046 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15050 #: ../src/guestfs-actions.pod:5633
15051 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15055 #: ../src/guestfs-actions.pod:5639
15056 msgid "guestfs_resize2fs"
15060 #: ../src/guestfs-actions.pod:5641
15064 " guestfs_resize2fs (guestfs_h *g,\n"
15065 " const char *device);\n"
15070 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3800
15072 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15073 "underlying device."
15077 #: ../src/guestfs-actions.pod:5648
15079 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15080 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15081 "sometimes gives an error about this and sometimes not. In any case, it is "
15082 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15086 #: ../src/guestfs-actions.pod:5658
15087 msgid "guestfs_resize2fs_M"
15091 #: ../src/guestfs-actions.pod:5660
15095 " guestfs_resize2fs_M (guestfs_h *g,\n"
15096 " const char *device);\n"
15101 #: ../src/guestfs-actions.pod:5664
15103 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15104 "resized to its minimum size. This works like the I<-M> option to the "
15105 "C<resize2fs> command."
15109 #: ../src/guestfs-actions.pod:5668
15111 "To get the resulting size of the filesystem you should call "
15112 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15113 "These two numbers, multiplied together, give the resulting size of the "
15114 "minimal filesystem in bytes."
15118 #: ../src/guestfs-actions.pod:5675
15119 msgid "guestfs_resize2fs_size"
15123 #: ../src/guestfs-actions.pod:5677
15127 " guestfs_resize2fs_size (guestfs_h *g,\n"
15128 " const char *device,\n"
15129 " int64_t size);\n"
15134 #: ../src/guestfs-actions.pod:5682
15136 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15137 "to specify the new size (in bytes) explicitly."
15141 #: ../src/guestfs-actions.pod:5689
15146 #: ../src/guestfs-actions.pod:5691
15150 " guestfs_rm (guestfs_h *g,\n"
15151 " const char *path);\n"
15156 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3833
15157 msgid "Remove the single file C<path>."
15161 #: ../src/guestfs-actions.pod:5701
15162 msgid "guestfs_rm_rf"
15166 #: ../src/guestfs-actions.pod:5703
15170 " guestfs_rm_rf (guestfs_h *g,\n"
15171 " const char *path);\n"
15176 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3839
15178 "Remove the file or directory C<path>, recursively removing the contents if "
15179 "its a directory. This is like the C<rm -rf> shell command."
15183 #: ../src/guestfs-actions.pod:5715
15184 msgid "guestfs_rmdir"
15188 #: ../src/guestfs-actions.pod:5717
15192 " guestfs_rmdir (guestfs_h *g,\n"
15193 " const char *path);\n"
15198 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3847
15199 msgid "Remove the single directory C<path>."
15203 #: ../src/guestfs-actions.pod:5727
15204 msgid "guestfs_rmmountpoint"
15208 #: ../src/guestfs-actions.pod:5729
15212 " guestfs_rmmountpoint (guestfs_h *g,\n"
15213 " const char *exemptpath);\n"
15218 #: ../src/guestfs-actions.pod:5733
15220 "This calls removes a mountpoint that was previously created with "
15221 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15225 #: ../src/guestfs-actions.pod:5741
15226 msgid "guestfs_scrub_device"
15230 #: ../src/guestfs-actions.pod:5743
15234 " guestfs_scrub_device (guestfs_h *g,\n"
15235 " const char *device);\n"
15240 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3861
15242 "This command writes patterns over C<device> to make data retrieval more "
15247 #: ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3864 ../fish/guestfish-actions.pod:3879 ../fish/guestfish-actions.pod:3892
15249 "It is an interface to the L<scrub(1)> program. See that manual page for "
15254 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5795
15255 msgid "(Added in 1.0.52)"
15259 #: ../src/guestfs-actions.pod:5760
15260 msgid "guestfs_scrub_file"
15264 #: ../src/guestfs-actions.pod:5762
15268 " guestfs_scrub_file (guestfs_h *g,\n"
15269 " const char *file);\n"
15274 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3874
15276 "This command writes patterns over a file to make data retrieval more "
15281 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3877
15282 msgid "The file is I<removed> after scrubbing."
15286 #: ../src/guestfs-actions.pod:5778
15287 msgid "guestfs_scrub_freespace"
15291 #: ../src/guestfs-actions.pod:5780
15295 " guestfs_scrub_freespace (guestfs_h *g,\n"
15296 " const char *dir);\n"
15301 #: ../src/guestfs-actions.pod:5784
15303 "This command creates the directory C<dir> and then fills it with files until "
15304 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15305 "and deletes them. The intention is to scrub any free space on the partition "
15306 "containing C<dir>."
15310 #: ../src/guestfs-actions.pod:5797
15311 msgid "guestfs_set_append"
15315 #: ../src/guestfs-actions.pod:5799
15319 " guestfs_set_append (guestfs_h *g,\n"
15320 " const char *append);\n"
15325 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3901
15327 "This function is used to add additional options to the guest kernel command "
15332 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3904
15334 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15335 "environment variable."
15339 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3907
15341 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15342 "(libguestfs always adds a few of its own)."
15346 #: ../src/guestfs-actions.pod:5816
15347 msgid "guestfs_set_attach_method"
15351 #: ../src/guestfs-actions.pod:5818
15355 " guestfs_set_attach_method (guestfs_h *g,\n"
15356 " const char *attachmethod);\n"
15361 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3916
15363 "Set the method that libguestfs uses to connect to the back end guestfsd "
15364 "daemon. Possible methods are:"
15368 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3923
15370 "Launch an appliance and connect to it. This is the ordinary method and the "
15375 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3926
15376 msgid "C<unix:I<path>>"
15380 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
15381 msgid "Connect to the Unix domain socket I<path>."
15385 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3930
15387 "This method lets you connect to an existing daemon or (using virtio-serial) "
15388 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15389 "RUNNING DAEMONS>."
15393 #: ../src/guestfs-actions.pod:5844
15394 msgid "guestfs_set_autosync"
15398 #: ../src/guestfs-actions.pod:5846
15402 " guestfs_set_autosync (guestfs_h *g,\n"
15403 " int autosync);\n"
15408 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3942
15410 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15411 "effort attempt to make filesystems consistent and synchronized when the "
15412 "handle is closed (also if the program exits without closing handles)."
15416 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
15418 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15419 "disabled by default)."
15423 #: ../src/guestfs-actions.pod:5862
15424 msgid "guestfs_set_direct"
15428 #: ../src/guestfs-actions.pod:5864
15432 " guestfs_set_direct (guestfs_h *g,\n"
15438 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3956
15440 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15441 "passed directly through to the appliance once it is launched."
15445 #: ../src/guestfs-actions.pod:5872
15447 "One consequence of this is that log messages aren't caught by the library "
15448 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15453 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3964
15454 msgid "You probably don't want to use this unless you know what you are doing."
15458 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3967
15459 msgid "The default is disabled."
15463 #: ../src/guestfs-actions.pod:5885
15464 msgid "guestfs_set_e2label"
15468 #: ../src/guestfs-actions.pod:5887
15472 " guestfs_set_e2label (guestfs_h *g,\n"
15473 " const char *device,\n"
15474 " const char *label);\n"
15479 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3973
15481 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15482 "C<label>. Filesystem labels are limited to 16 characters."
15486 #: ../src/guestfs-actions.pod:5896
15488 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15489 "the existing label on a filesystem."
15493 #: ../src/guestfs-actions.pod:5903
15494 msgid "guestfs_set_e2uuid"
15498 #: ../src/guestfs-actions.pod:5905
15502 " guestfs_set_e2uuid (guestfs_h *g,\n"
15503 " const char *device,\n"
15504 " const char *uuid);\n"
15509 #: ../src/guestfs-actions.pod:5910 ../fish/guestfish-actions.pod:3984
15511 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15512 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15513 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15517 #: ../src/guestfs-actions.pod:5915
15519 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15520 "the existing UUID of a filesystem."
15524 #: ../src/guestfs-actions.pod:5922
15525 msgid "guestfs_set_memsize"
15529 #: ../src/guestfs-actions.pod:5924
15533 " guestfs_set_memsize (guestfs_h *g,\n"
15539 #: ../src/guestfs-actions.pod:5928
15541 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15542 "This only has any effect if called before C<guestfs_launch>."
15546 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:4002
15548 "You can also change this by setting the environment variable "
15549 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15553 #: ../src/guestfs-actions.pod:5943
15554 msgid "guestfs_set_network"
15558 #: ../src/guestfs-actions.pod:5945
15562 " guestfs_set_network (guestfs_h *g,\n"
15568 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4015
15570 "If C<network> is true, then the network is enabled in the libguestfs "
15571 "appliance. The default is false."
15575 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4018
15577 "This affects whether commands are able to access the network (see "
15578 "L<guestfs(3)/RUNNING COMMANDS>)."
15582 #: ../src/guestfs-actions.pod:5955
15584 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15589 #: ../src/guestfs-actions.pod:5962
15590 msgid "guestfs_set_path"
15594 #: ../src/guestfs-actions.pod:5964
15598 " guestfs_set_path (guestfs_h *g,\n"
15599 " const char *searchpath);\n"
15604 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4030
15605 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15609 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:4032
15611 "The default is C<$libdir/guestfs> unless overridden by setting "
15612 "C<LIBGUESTFS_PATH> environment variable."
15616 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
15617 msgid "Setting C<path> to C<NULL> restores the default path."
15621 #: ../src/guestfs-actions.pod:5979
15622 msgid "guestfs_set_qemu"
15626 #: ../src/guestfs-actions.pod:5981
15630 " guestfs_set_qemu (guestfs_h *g,\n"
15631 " const char *qemu);\n"
15636 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4043
15637 msgid "Set the qemu binary that we will use."
15641 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:4045
15642 msgid "The default is chosen when the library was compiled by the configure script."
15646 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
15648 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15653 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4051
15654 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15658 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
15660 "Note that you should call this function as early as possible after creating "
15661 "the handle. This is because some pre-launch operations depend on testing "
15662 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15663 "don't retest features, and so you might see inconsistent results. Using the "
15664 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15665 "the qemu binary at the same time as the handle is created."
15669 #: ../src/guestfs-actions.pod:6007
15670 msgid "guestfs_set_recovery_proc"
15674 #: ../src/guestfs-actions.pod:6009
15678 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15679 " int recoveryproc);\n"
15684 #: ../src/guestfs-actions.pod:6013
15686 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15687 "not create a recovery process. The purpose of the recovery process is to "
15688 "stop runaway qemu processes in the case where the main program aborts "
15693 #: ../src/guestfs-actions.pod:6018
15695 "This only has any effect if called before C<guestfs_launch>, and the default "
15700 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4075
15702 "About the only time when you would want to disable this is if the main "
15703 "process will fork itself into the background (\"daemonize\" itself). In "
15704 "this case the recovery process thinks that the main program has disappeared "
15705 "and so kills qemu, which is not very helpful."
15709 #: ../src/guestfs-actions.pod:6031
15710 msgid "guestfs_set_selinux"
15714 #: ../src/guestfs-actions.pod:6033
15718 " guestfs_set_selinux (guestfs_h *g,\n"
15724 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4087
15726 "This sets the selinux flag that is passed to the appliance at boot time. "
15727 "The default is C<selinux=0> (disabled)."
15731 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4090
15733 "Note that if SELinux is enabled, it is always in Permissive mode "
15734 "(C<enforcing=0>)."
15738 #: ../src/guestfs-actions.pod:6050
15739 msgid "guestfs_set_trace"
15743 #: ../src/guestfs-actions.pod:6052
15747 " guestfs_set_trace (guestfs_h *g,\n"
15753 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4102
15755 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15756 "return values are traced."
15760 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4105
15762 "If you want to trace C API calls into libguestfs (and other libraries) then "
15763 "possibly a better way is to use the external ltrace(1) command."
15767 #: ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:4109
15769 "Command traces are disabled unless the environment variable "
15770 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15774 #: ../src/guestfs-actions.pod:6066
15776 "Trace messages are normally sent to C<stderr>, unless you register a "
15777 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15781 #: ../src/guestfs-actions.pod:6074
15782 msgid "guestfs_set_verbose"
15786 #: ../src/guestfs-actions.pod:6076
15790 " guestfs_set_verbose (guestfs_h *g,\n"
15796 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4122
15797 msgid "If C<verbose> is true, this turns on verbose messages."
15801 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4124
15803 "Verbose messages are disabled unless the environment variable "
15804 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15808 #: ../src/guestfs-actions.pod:6085
15810 "Verbose messages are normally sent to C<stderr>, unless you register a "
15811 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15815 #: ../src/guestfs-actions.pod:6093
15816 msgid "guestfs_setcon"
15820 #: ../src/guestfs-actions.pod:6095
15824 " guestfs_setcon (guestfs_h *g,\n"
15825 " const char *context);\n"
15830 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4135
15832 "This sets the SELinux security context of the daemon to the string "
15837 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4138
15838 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15842 #: ../src/guestfs-actions.pod:6108
15843 msgid "guestfs_setxattr"
15847 #: ../src/guestfs-actions.pod:6110
15851 " guestfs_setxattr (guestfs_h *g,\n"
15852 " const char *xattr,\n"
15853 " const char *val,\n"
15855 " const char *path);\n"
15860 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4144
15862 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15863 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15867 #: ../src/guestfs-actions.pod:6121
15868 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15872 #: ../src/guestfs-actions.pod:6127
15873 msgid "guestfs_sfdisk"
15877 #: ../src/guestfs-actions.pod:6129
15881 " guestfs_sfdisk (guestfs_h *g,\n"
15882 " const char *device,\n"
15886 " char *const *lines);\n"
15891 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
15893 "This is a direct interface to the L<sfdisk(8)> program for creating "
15894 "partitions on block devices."
15898 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
15899 msgid "C<device> should be a block device, for example C</dev/sda>."
15903 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
15905 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15906 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15907 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15908 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15909 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15910 "the kernel) cannot work out the right geometry and you will need to tell it."
15914 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4167
15916 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15917 "refer to the L<sfdisk(8)> manpage."
15921 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4170
15923 "To create a single partition occupying the whole disk, you would pass "
15924 "C<lines> as a single element list, when the single element being the string "
15929 #: ../src/guestfs-actions.pod:6157
15930 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15934 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195 ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4180 ../fish/guestfish-actions.pod:4203 ../fish/guestfish-actions.pod:4225
15935 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
15939 #: ../src/guestfs-actions.pod:6174
15940 msgid "guestfs_sfdiskM"
15944 #: ../src/guestfs-actions.pod:6176
15948 " guestfs_sfdiskM (guestfs_h *g,\n"
15949 " const char *device,\n"
15950 " char *const *lines);\n"
15955 #: ../src/guestfs-actions.pod:6181
15957 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15958 "partition sizes are specified in megabytes only (rounded to the nearest "
15959 "cylinder) and you don't need to specify the cyls, heads and sectors "
15960 "parameters which were rarely if ever used anyway."
15964 #: ../src/guestfs-actions.pod:6187
15966 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15967 "C<guestfs_part_disk>"
15971 #: ../src/guestfs-actions.pod:6204
15972 msgid "guestfs_sfdisk_N"
15976 #: ../src/guestfs-actions.pod:6206
15980 " guestfs_sfdisk_N (guestfs_h *g,\n"
15981 " const char *device,\n"
15986 " const char *line);\n"
15991 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4214
15993 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15994 "(note: C<n> counts from 1)."
15998 #: ../src/guestfs-actions.pod:6218
16000 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16001 "for the cyls/heads/sectors parameters."
16005 #: ../src/guestfs-actions.pod:6221
16006 msgid "See also: C<guestfs_part_add>"
16010 #: ../src/guestfs-actions.pod:6237
16011 msgid "guestfs_sfdisk_disk_geometry"
16015 #: ../src/guestfs-actions.pod:6239
16019 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16020 " const char *device);\n"
16025 #: ../src/guestfs-actions.pod:6243
16027 "This displays the disk geometry of C<device> read from the partition table. "
16028 "Especially in the case where the underlying block device has been resized, "
16029 "this can be different from the kernel's idea of the geometry (see "
16030 "C<guestfs_sfdisk_kernel_geometry>)."
16034 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4241 ../fish/guestfish-actions.pod:4250
16035 msgid "The result is in human-readable format, and not designed to be parsed."
16039 #: ../src/guestfs-actions.pod:6256
16040 msgid "guestfs_sfdisk_kernel_geometry"
16044 #: ../src/guestfs-actions.pod:6258
16048 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16049 " const char *device);\n"
16054 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4248
16055 msgid "This displays the kernel's idea of the geometry of C<device>."
16059 #: ../src/guestfs-actions.pod:6272
16060 msgid "guestfs_sfdisk_l"
16064 #: ../src/guestfs-actions.pod:6274
16068 " guestfs_sfdisk_l (guestfs_h *g,\n"
16069 " const char *device);\n"
16074 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4257
16076 "This displays the partition table on C<device>, in the human-readable output "
16077 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16081 #: ../src/guestfs-actions.pod:6282
16082 msgid "See also: C<guestfs_part_list>"
16086 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4263
16088 "This function is deprecated. In new code, use the C<part_list> call "
16093 #: ../src/guestfs-actions.pod:6296
16098 #: ../src/guestfs-actions.pod:6298
16102 " guestfs_sh (guestfs_h *g,\n"
16103 " const char *command);\n"
16108 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4274
16110 "This call runs a command from the guest filesystem via the guest's "
16115 #: ../src/guestfs-actions.pod:6305
16116 msgid "This is like C<guestfs_command>, but passes the command to:"
16120 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
16123 " /bin/sh -c \"command\"\n"
16128 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4281
16130 "Depending on the guest's shell, this usually results in wildcards being "
16131 "expanded, shell expressions being interpolated and so on."
16135 #: ../src/guestfs-actions.pod:6313
16136 msgid "All the provisos about C<guestfs_command> apply to this call."
16140 #: ../src/guestfs-actions.pod:6320
16141 msgid "guestfs_sh_lines"
16145 #: ../src/guestfs-actions.pod:6322
16149 " guestfs_sh_lines (guestfs_h *g,\n"
16150 " const char *command);\n"
16155 #: ../src/guestfs-actions.pod:6326
16157 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16162 #: ../src/guestfs-actions.pod:6329
16163 msgid "See also: C<guestfs_command_lines>"
16167 #: ../src/guestfs-actions.pod:6337
16168 msgid "guestfs_sleep"
16172 #: ../src/guestfs-actions.pod:6339
16176 " guestfs_sleep (guestfs_h *g,\n"
16182 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4300
16183 msgid "Sleep for C<secs> seconds."
16187 #: ../src/guestfs-actions.pod:6347
16188 msgid "(Added in 1.0.41)"
16192 #: ../src/guestfs-actions.pod:6349 ../src/guestfs-structs.pod:109
16193 msgid "guestfs_stat"
16197 #: ../src/guestfs-actions.pod:6351
16200 " struct guestfs_stat *\n"
16201 " guestfs_stat (guestfs_h *g,\n"
16202 " const char *path);\n"
16207 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4308
16208 msgid "This is the same as the C<stat(2)> system call."
16212 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-structs.pod:135
16213 msgid "guestfs_statvfs"
16217 #: ../src/guestfs-actions.pod:6367
16220 " struct guestfs_statvfs *\n"
16221 " guestfs_statvfs (guestfs_h *g,\n"
16222 " const char *path);\n"
16227 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4314
16229 "Returns file system statistics for any mounted file system. C<path> should "
16230 "be a file or directory in the mounted file system (typically it is the mount "
16231 "point itself, but it doesn't need to be)."
16235 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4318
16236 msgid "This is the same as the C<statvfs(2)> system call."
16240 #: ../src/guestfs-actions.pod:6377
16242 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16243 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16247 #: ../src/guestfs-actions.pod:6383
16248 msgid "guestfs_strings"
16252 #: ../src/guestfs-actions.pod:6385
16256 " guestfs_strings (guestfs_h *g,\n"
16257 " const char *path);\n"
16262 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4324
16264 "This runs the L<strings(1)> command on a file and returns the list of "
16265 "printable strings found."
16269 #: ../src/guestfs-actions.pod:6401
16270 msgid "guestfs_strings_e"
16274 #: ../src/guestfs-actions.pod:6403
16278 " guestfs_strings_e (guestfs_h *g,\n"
16279 " const char *encoding,\n"
16280 " const char *path);\n"
16285 #: ../src/guestfs-actions.pod:6408
16287 "This is like the C<guestfs_strings> command, but allows you to specify the "
16288 "encoding of strings that are looked for in the source file C<path>."
16292 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4338
16293 msgid "Allowed encodings are:"
16297 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4342
16302 #: ../src/guestfs-actions.pod:6418
16304 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16305 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16309 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
16314 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4349
16315 msgid "Single 8-bit-byte characters."
16319 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4351
16324 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4353
16325 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16329 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
16330 msgid "l (lower case letter L)"
16334 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
16336 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16337 "examining binaries in Windows guests."
16341 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
16346 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
16347 msgid "32-bit big endian such as UCS-4BE."
16351 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4365
16356 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4367
16357 msgid "32-bit little endian such as UCS-4LE."
16361 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4371
16362 msgid "The returned strings are transcoded to UTF-8."
16366 #: ../src/guestfs-actions.pod:6456
16367 msgid "guestfs_swapoff_device"
16371 #: ../src/guestfs-actions.pod:6458
16375 " guestfs_swapoff_device (guestfs_h *g,\n"
16376 " const char *device);\n"
16381 #: ../src/guestfs-actions.pod:6462
16383 "This command disables the libguestfs appliance swap device or partition "
16384 "named C<device>. See C<guestfs_swapon_device>."
16388 #: ../src/guestfs-actions.pod:6470
16389 msgid "guestfs_swapoff_file"
16393 #: ../src/guestfs-actions.pod:6472
16397 " guestfs_swapoff_file (guestfs_h *g,\n"
16398 " const char *file);\n"
16403 #: ../src/guestfs-actions.pod:6476 ../fish/guestfish-actions.pod:4388
16404 msgid "This command disables the libguestfs appliance swap on file."
16408 #: ../src/guestfs-actions.pod:6482
16409 msgid "guestfs_swapoff_label"
16413 #: ../src/guestfs-actions.pod:6484
16417 " guestfs_swapoff_label (guestfs_h *g,\n"
16418 " const char *label);\n"
16423 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4394
16425 "This command disables the libguestfs appliance swap on labeled swap "
16430 #: ../src/guestfs-actions.pod:6495
16431 msgid "guestfs_swapoff_uuid"
16435 #: ../src/guestfs-actions.pod:6497
16439 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16440 " const char *uuid);\n"
16445 #: ../src/guestfs-actions.pod:6501 ../fish/guestfish-actions.pod:4401
16447 "This command disables the libguestfs appliance swap partition with the given "
16452 #: ../src/guestfs-actions.pod:6508
16453 msgid "guestfs_swapon_device"
16457 #: ../src/guestfs-actions.pod:6510
16461 " guestfs_swapon_device (guestfs_h *g,\n"
16462 " const char *device);\n"
16467 #: ../src/guestfs-actions.pod:6514
16469 "This command enables the libguestfs appliance to use the swap device or "
16470 "partition named C<device>. The increased memory is made available for all "
16471 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16475 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4413
16477 "Note that you should not swap to existing guest swap partitions unless you "
16478 "know what you are doing. They may contain hibernation information, or other "
16479 "information that the guest doesn't want you to trash. You also risk leaking "
16480 "information about the host to the guest this way. Instead, attach a new "
16481 "host device to the guest and swap on that."
16485 #: ../src/guestfs-actions.pod:6530
16486 msgid "guestfs_swapon_file"
16490 #: ../src/guestfs-actions.pod:6532
16494 " guestfs_swapon_file (guestfs_h *g,\n"
16495 " const char *file);\n"
16500 #: ../src/guestfs-actions.pod:6536
16502 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16507 #: ../src/guestfs-actions.pod:6543
16508 msgid "guestfs_swapon_label"
16512 #: ../src/guestfs-actions.pod:6545
16516 " guestfs_swapon_label (guestfs_h *g,\n"
16517 " const char *label);\n"
16522 #: ../src/guestfs-actions.pod:6549
16524 "This command enables swap to a labeled swap partition. See "
16525 "C<guestfs_swapon_device> for other notes."
16529 #: ../src/guestfs-actions.pod:6556
16530 msgid "guestfs_swapon_uuid"
16534 #: ../src/guestfs-actions.pod:6558
16538 " guestfs_swapon_uuid (guestfs_h *g,\n"
16539 " const char *uuid);\n"
16544 #: ../src/guestfs-actions.pod:6562
16546 "This command enables swap to a swap partition with the given UUID. See "
16547 "C<guestfs_swapon_device> for other notes."
16551 #: ../src/guestfs-actions.pod:6569
16552 msgid "guestfs_sync"
16556 #: ../src/guestfs-actions.pod:6571
16560 " guestfs_sync (guestfs_h *g);\n"
16565 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4445
16567 "This syncs the disk, so that any writes are flushed through to the "
16568 "underlying disk image."
16572 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4448
16574 "You should always call this if you have modified a disk image, before "
16575 "closing the handle."
16579 #: ../src/guestfs-actions.pod:6584
16580 msgid "guestfs_tail"
16584 #: ../src/guestfs-actions.pod:6586
16588 " guestfs_tail (guestfs_h *g,\n"
16589 " const char *path);\n"
16594 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4455
16595 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16599 #: ../src/guestfs-actions.pod:6602
16600 msgid "guestfs_tail_n"
16604 #: ../src/guestfs-actions.pod:6604
16608 " guestfs_tail_n (guestfs_h *g,\n"
16610 " const char *path);\n"
16615 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4465
16617 "If the parameter C<nrlines> is a positive number, this returns the last "
16618 "C<nrlines> lines of the file C<path>."
16622 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4468
16624 "If the parameter C<nrlines> is a negative number, this returns lines from "
16625 "the file C<path>, starting with the C<-nrlines>th line."
16629 #: ../src/guestfs-actions.pod:6626
16630 msgid "guestfs_tar_in"
16634 #: ../src/guestfs-actions.pod:6628
16638 " guestfs_tar_in (guestfs_h *g,\n"
16639 " const char *tarfile,\n"
16640 " const char *directory);\n"
16645 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4480
16647 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16648 "tar file) into C<directory>."
16652 #: ../src/guestfs-actions.pod:6636
16653 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16657 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6690
16658 msgid "(Added in 1.0.3)"
16662 #: ../src/guestfs-actions.pod:6643
16663 msgid "guestfs_tar_out"
16667 #: ../src/guestfs-actions.pod:6645
16671 " guestfs_tar_out (guestfs_h *g,\n"
16672 " const char *directory,\n"
16673 " const char *tarfile);\n"
16678 #: ../src/guestfs-actions.pod:6650 ../fish/guestfish-actions.pod:4492
16680 "This command packs the contents of C<directory> and downloads it to local "
16685 #: ../src/guestfs-actions.pod:6653
16687 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16688 "C<guestfs_txz_out>."
16692 #: ../src/guestfs-actions.pod:6660
16693 msgid "guestfs_tgz_in"
16697 #: ../src/guestfs-actions.pod:6662
16701 " guestfs_tgz_in (guestfs_h *g,\n"
16702 " const char *tarball,\n"
16703 " const char *directory);\n"
16708 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4504
16710 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16711 "tar file) into C<directory>."
16715 #: ../src/guestfs-actions.pod:6670
16716 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16720 #: ../src/guestfs-actions.pod:6676
16721 msgid "guestfs_tgz_out"
16725 #: ../src/guestfs-actions.pod:6678
16729 " guestfs_tgz_out (guestfs_h *g,\n"
16730 " const char *directory,\n"
16731 " const char *tarball);\n"
16736 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4515
16738 "This command packs the contents of C<directory> and downloads it to local "
16743 #: ../src/guestfs-actions.pod:6686
16744 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16748 #: ../src/guestfs-actions.pod:6692
16749 msgid "guestfs_touch"
16753 #: ../src/guestfs-actions.pod:6694
16757 " guestfs_touch (guestfs_h *g,\n"
16758 " const char *path);\n"
16763 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4526
16765 "Touch acts like the L<touch(1)> command. It can be used to update the "
16766 "timestamps on a file, or, if the file does not exist, to create a new "
16767 "zero-length file."
16771 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4530
16773 "This command only works on regular files, and will fail on other file types "
16774 "such as directories, symbolic links, block special etc."
16778 #: ../src/guestfs-actions.pod:6709
16779 msgid "guestfs_truncate"
16783 #: ../src/guestfs-actions.pod:6711
16787 " guestfs_truncate (guestfs_h *g,\n"
16788 " const char *path);\n"
16793 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4537
16795 "This command truncates C<path> to a zero-length file. The file must exist "
16800 #: ../src/guestfs-actions.pod:6722
16801 msgid "guestfs_truncate_size"
16805 #: ../src/guestfs-actions.pod:6724
16809 " guestfs_truncate_size (guestfs_h *g,\n"
16810 " const char *path,\n"
16811 " int64_t size);\n"
16816 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4544
16818 "This command truncates C<path> to size C<size> bytes. The file must exist "
16823 #: ../src/guestfs-actions.pod:6732
16825 "If the current file size is less than C<size> then the file is extended to "
16826 "the required size with zero bytes. This creates a sparse file (ie. disk "
16827 "blocks are not allocated for the file until you write to it). To create a "
16828 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16832 #: ../src/guestfs-actions.pod:6742
16833 msgid "guestfs_tune2fs_l"
16837 #: ../src/guestfs-actions.pod:6744
16841 " guestfs_tune2fs_l (guestfs_h *g,\n"
16842 " const char *device);\n"
16847 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4557
16849 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16854 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4560
16856 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16857 "for more details. The list of fields returned isn't clearly defined, and "
16858 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16859 "and the filesystem itself."
16863 #: ../src/guestfs-actions.pod:6764
16864 msgid "guestfs_txz_in"
16868 #: ../src/guestfs-actions.pod:6766
16872 " guestfs_txz_in (guestfs_h *g,\n"
16873 " const char *tarball,\n"
16874 " const char *directory);\n"
16879 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4569
16881 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16882 "tar file) into C<directory>."
16886 #: ../src/guestfs-actions.pod:6778
16887 msgid "guestfs_txz_out"
16891 #: ../src/guestfs-actions.pod:6780
16895 " guestfs_txz_out (guestfs_h *g,\n"
16896 " const char *directory,\n"
16897 " const char *tarball);\n"
16902 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4578
16904 "This command packs the contents of C<directory> and downloads it to local "
16905 "file C<tarball> (as an xz compressed tar archive)."
16909 #: ../src/guestfs-actions.pod:6792
16910 msgid "guestfs_umask"
16914 #: ../src/guestfs-actions.pod:6794
16918 " guestfs_umask (guestfs_h *g,\n"
16924 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4587
16926 "This function sets the mask used for creating new files and device nodes to "
16931 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4590
16933 "Typical umask values would be C<022> which creates new files with "
16934 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16935 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16939 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
16941 "The default umask is C<022>. This is important because it means that "
16942 "directories and device nodes will be created with C<0644> or C<0755> mode "
16943 "even if you specify C<0777>."
16947 #: ../src/guestfs-actions.pod:6810
16949 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16950 "C<guestfs_mkdir>."
16954 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4602
16955 msgid "This call returns the previous umask."
16959 #: ../src/guestfs-actions.pod:6819
16960 msgid "guestfs_umount"
16964 #: ../src/guestfs-actions.pod:6821
16968 " guestfs_umount (guestfs_h *g,\n"
16969 " const char *pathordevice);\n"
16974 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4610
16976 "This unmounts the given filesystem. The filesystem may be specified either "
16977 "by its mountpoint (path) or the device which contains the filesystem."
16981 #: ../src/guestfs-actions.pod:6833
16982 msgid "guestfs_umount_all"
16986 #: ../src/guestfs-actions.pod:6835
16990 " guestfs_umount_all (guestfs_h *g);\n"
16995 #: ../src/guestfs-actions.pod:6838 ../fish/guestfish-actions.pod:4620
16996 msgid "This unmounts all mounted filesystems."
17000 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4622
17001 msgid "Some internal mounts are not unmounted by this call."
17005 #: ../src/guestfs-actions.pod:6846
17006 msgid "guestfs_upload"
17010 #: ../src/guestfs-actions.pod:6848
17014 " guestfs_upload (guestfs_h *g,\n"
17015 " const char *filename,\n"
17016 " const char *remotefilename);\n"
17021 #: ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4641
17022 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17026 #: ../src/guestfs-actions.pod:6858
17027 msgid "See also C<guestfs_download>."
17031 #: ../src/guestfs-actions.pod:6869
17032 msgid "guestfs_upload_offset"
17036 #: ../src/guestfs-actions.pod:6871
17040 " guestfs_upload_offset (guestfs_h *g,\n"
17041 " const char *filename,\n"
17042 " const char *remotefilename,\n"
17043 " int64_t offset);\n"
17048 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4644
17050 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17051 "The intention is to overwrite parts of existing files or devices, although "
17052 "if a non-existant file is specified then it is created with a \"hole\" "
17053 "before C<offset>. The size of the data written is implicit in the size of "
17054 "the source C<filename>."
17058 #: ../src/guestfs-actions.pod:6887
17060 "Note that there is no limit on the amount of data that can be uploaded with "
17061 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17062 "full amount unless an error occurs."
17066 #: ../src/guestfs-actions.pod:6892
17067 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17071 #: ../src/guestfs-actions.pod:6903
17072 msgid "guestfs_utimens"
17076 #: ../src/guestfs-actions.pod:6905
17080 " guestfs_utimens (guestfs_h *g,\n"
17081 " const char *path,\n"
17082 " int64_t atsecs,\n"
17083 " int64_t atnsecs,\n"
17084 " int64_t mtsecs,\n"
17085 " int64_t mtnsecs);\n"
17090 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4664
17091 msgid "This command sets the timestamps of a file with nanosecond precision."
17095 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4667
17097 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17102 #: ../src/guestfs-actions.pod:6919 ../fish/guestfish-actions.pod:4670
17104 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17105 "nanoseconds from the epoch."
17109 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4673
17111 "If the C<*nsecs> field contains the special value C<-1> then the "
17112 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17113 "ignored in this case)."
17117 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4677
17119 "If the C<*nsecs> field contains the special value C<-2> then the "
17120 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17125 #: ../src/guestfs-actions.pod:6934 ../src/guestfs-structs.pod:175
17126 msgid "guestfs_version"
17130 #: ../src/guestfs-actions.pod:6936
17133 " struct guestfs_version *\n"
17134 " guestfs_version (guestfs_h *g);\n"
17139 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4685
17140 msgid "Return the libguestfs version number that the program is linked against."
17144 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4688
17146 "Note that because of dynamic linking this is not necessarily the version of "
17147 "libguestfs that you compiled against. You can compile the program, and then "
17148 "at runtime dynamically link against a completely different C<libguestfs.so> "
17153 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
17155 "This call was added in version C<1.0.58>. In previous versions of "
17156 "libguestfs there was no way to get the version number. From C code you can "
17157 "use dynamic linker functions to find out if this symbol exists (if it "
17158 "doesn't, then it's an earlier version)."
17162 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4699
17164 "The call returns a structure with four elements. The first three (C<major>, "
17165 "C<minor> and C<release>) are numbers and correspond to the usual version "
17166 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17167 "but may be used for distro-specific information."
17171 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4705
17172 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17176 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4708
17177 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17181 #: ../src/guestfs-actions.pod:6964
17183 "I<Note:> Don't use this call to test for availability of features. In "
17184 "enterprise distributions we backport features from later versions into "
17185 "earlier versions, making this an unreliable way to test for features. Use "
17186 "C<guestfs_available> instead."
17190 #: ../src/guestfs-actions.pod:6970
17192 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17193 "error. I<The caller must call C<guestfs_free_version> after use>."
17197 #: ../src/guestfs-actions.pod:6974
17198 msgid "(Added in 1.0.58)"
17202 #: ../src/guestfs-actions.pod:6976
17203 msgid "guestfs_vfs_label"
17207 #: ../src/guestfs-actions.pod:6978
17211 " guestfs_vfs_label (guestfs_h *g,\n"
17212 " const char *device);\n"
17217 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4720
17218 msgid "This returns the filesystem label of the filesystem on C<device>."
17222 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4723
17223 msgid "If the filesystem is unlabeled, this returns the empty string."
17227 #: ../src/guestfs-actions.pod:6987
17228 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17232 #: ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7029
17233 msgid "(Added in 1.3.18)"
17237 #: ../src/guestfs-actions.pod:6994
17238 msgid "guestfs_vfs_type"
17242 #: ../src/guestfs-actions.pod:6996
17246 " guestfs_vfs_type (guestfs_h *g,\n"
17247 " const char *device);\n"
17252 #: ../src/guestfs-actions.pod:7000 ../fish/guestfish-actions.pod:4731
17254 "This command gets the filesystem type corresponding to the filesystem on "
17259 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4734
17261 "For most filesystems, the result is the name of the Linux VFS module which "
17262 "would be used to mount this filesystem if you mounted it without specifying "
17263 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17267 #: ../src/guestfs-actions.pod:7013
17268 msgid "guestfs_vfs_uuid"
17272 #: ../src/guestfs-actions.pod:7015
17276 " guestfs_vfs_uuid (guestfs_h *g,\n"
17277 " const char *device);\n"
17282 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4743
17283 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17287 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4746
17288 msgid "If the filesystem does not have a UUID, this returns the empty string."
17292 #: ../src/guestfs-actions.pod:7024
17293 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17297 #: ../src/guestfs-actions.pod:7031
17298 msgid "guestfs_vg_activate"
17302 #: ../src/guestfs-actions.pod:7033
17306 " guestfs_vg_activate (guestfs_h *g,\n"
17308 " char *const *volgroups);\n"
17313 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4754
17315 "This command activates or (if C<activate> is false) deactivates all logical "
17316 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17317 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17318 "deactivated, then those devices disappear."
17322 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4760
17323 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17327 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4762
17329 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17330 "activated or deactivated."
17334 #: ../src/guestfs-actions.pod:7053
17335 msgid "guestfs_vg_activate_all"
17339 #: ../src/guestfs-actions.pod:7055
17343 " guestfs_vg_activate_all (guestfs_h *g,\n"
17344 " int activate);\n"
17349 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4769
17351 "This command activates or (if C<activate> is false) deactivates all logical "
17352 "volumes in all volume groups. If activated, then they are made known to the "
17353 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17354 "those devices disappear."
17358 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4775
17359 msgid "This command is the same as running C<vgchange -a y|n>"
17363 #: ../src/guestfs-actions.pod:7071
17364 msgid "guestfs_vgcreate"
17368 #: ../src/guestfs-actions.pod:7073
17372 " guestfs_vgcreate (guestfs_h *g,\n"
17373 " const char *volgroup,\n"
17374 " char *const *physvols);\n"
17379 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4781
17381 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17382 "of physical volumes C<physvols>."
17386 #: ../src/guestfs-actions.pod:7085
17387 msgid "guestfs_vglvuuids"
17391 #: ../src/guestfs-actions.pod:7087
17395 " guestfs_vglvuuids (guestfs_h *g,\n"
17396 " const char *vgname);\n"
17401 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4788
17403 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17404 "volumes created in this volume group."
17408 #: ../src/guestfs-actions.pod:7094
17410 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17411 "associate logical volumes and volume groups."
17415 #: ../src/guestfs-actions.pod:7097
17416 msgid "See also C<guestfs_vgpvuuids>."
17420 #: ../src/guestfs-actions.pod:7105
17421 msgid "guestfs_vgpvuuids"
17425 #: ../src/guestfs-actions.pod:7107
17429 " guestfs_vgpvuuids (guestfs_h *g,\n"
17430 " const char *vgname);\n"
17435 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4800
17437 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17438 "volumes that this volume group resides on."
17442 #: ../src/guestfs-actions.pod:7114
17444 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17445 "associate physical volumes and volume groups."
17449 #: ../src/guestfs-actions.pod:7117
17450 msgid "See also C<guestfs_vglvuuids>."
17454 #: ../src/guestfs-actions.pod:7125
17455 msgid "guestfs_vgremove"
17459 #: ../src/guestfs-actions.pod:7127
17463 " guestfs_vgremove (guestfs_h *g,\n"
17464 " const char *vgname);\n"
17469 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4812
17470 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17474 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4814
17475 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17479 #: ../src/guestfs-actions.pod:7140
17480 msgid "guestfs_vgrename"
17484 #: ../src/guestfs-actions.pod:7142
17488 " guestfs_vgrename (guestfs_h *g,\n"
17489 " const char *volgroup,\n"
17490 " const char *newvolgroup);\n"
17495 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4821
17496 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17500 #: ../src/guestfs-actions.pod:7153
17501 msgid "guestfs_vgs"
17505 #: ../src/guestfs-actions.pod:7155
17509 " guestfs_vgs (guestfs_h *g);\n"
17514 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4827
17516 "List all the volumes groups detected. This is the equivalent of the "
17517 "L<vgs(8)> command."
17521 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4830
17523 "This returns a list of just the volume group names that were detected "
17524 "(eg. C<VolGroup00>)."
17528 #: ../src/guestfs-actions.pod:7164
17529 msgid "See also C<guestfs_vgs_full>."
17533 #: ../src/guestfs-actions.pod:7172
17534 msgid "guestfs_vgs_full"
17538 #: ../src/guestfs-actions.pod:7174
17541 " struct guestfs_lvm_vg_list *\n"
17542 " guestfs_vgs_full (guestfs_h *g);\n"
17547 #: ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:4839
17549 "List all the volumes groups detected. This is the equivalent of the "
17550 "L<vgs(8)> command. The \"full\" version includes all fields."
17554 #: ../src/guestfs-actions.pod:7180
17556 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17557 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17562 #: ../src/guestfs-actions.pod:7186
17563 msgid "guestfs_vgscan"
17567 #: ../src/guestfs-actions.pod:7188
17571 " guestfs_vgscan (guestfs_h *g);\n"
17576 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4846
17578 "This rescans all block devices and rebuilds the list of LVM physical "
17579 "volumes, volume groups and logical volumes."
17583 #: ../src/guestfs-actions.pod:7198
17584 msgid "guestfs_vguuid"
17588 #: ../src/guestfs-actions.pod:7200
17592 " guestfs_vguuid (guestfs_h *g,\n"
17593 " const char *vgname);\n"
17598 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4853
17599 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17603 #: ../src/guestfs-actions.pod:7211
17604 msgid "guestfs_wait_ready"
17608 #: ../src/guestfs-actions.pod:7213
17612 " guestfs_wait_ready (guestfs_h *g);\n"
17617 #: ../src/guestfs-actions.pod:7216
17618 msgid "This function is a no op."
17622 #: ../src/guestfs-actions.pod:7218
17624 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17625 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17626 "is no longer necessary because C<guestfs_launch> now does the waiting."
17630 #: ../src/guestfs-actions.pod:7223
17632 "If you see any calls to this function in code then you can just remove them, "
17633 "unless you want to retain compatibility with older versions of the API."
17637 #: ../src/guestfs-actions.pod:7229
17638 msgid "This function is deprecated. In new code, use the C<launch> call instead."
17642 #: ../src/guestfs-actions.pod:7238
17643 msgid "guestfs_wc_c"
17647 #: ../src/guestfs-actions.pod:7240
17651 " guestfs_wc_c (guestfs_h *g,\n"
17652 " const char *path);\n"
17657 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4859
17659 "This command counts the characters in a file, using the C<wc -c> external "
17664 #: ../src/guestfs-actions.pod:7251
17665 msgid "guestfs_wc_l"
17669 #: ../src/guestfs-actions.pod:7253
17673 " guestfs_wc_l (guestfs_h *g,\n"
17674 " const char *path);\n"
17679 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4866
17681 "This command counts the lines in a file, using the C<wc -l> external "
17686 #: ../src/guestfs-actions.pod:7264
17687 msgid "guestfs_wc_w"
17691 #: ../src/guestfs-actions.pod:7266
17695 " guestfs_wc_w (guestfs_h *g,\n"
17696 " const char *path);\n"
17701 #: ../src/guestfs-actions.pod:7270 ../fish/guestfish-actions.pod:4873
17703 "This command counts the words in a file, using the C<wc -w> external "
17708 #: ../src/guestfs-actions.pod:7277
17709 msgid "guestfs_write"
17713 #: ../src/guestfs-actions.pod:7279
17717 " guestfs_write (guestfs_h *g,\n"
17718 " const char *path,\n"
17719 " const char *content,\n"
17720 " size_t content_size);\n"
17725 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4880
17727 "This call creates a file called C<path>. The content of the file is the "
17728 "string C<content> (which can contain any 8 bit data)."
17732 #: ../src/guestfs-actions.pod:7295
17733 msgid "guestfs_write_file"
17737 #: ../src/guestfs-actions.pod:7297
17741 " guestfs_write_file (guestfs_h *g,\n"
17742 " const char *path,\n"
17743 " const char *content,\n"
17749 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4890
17751 "This call creates a file called C<path>. The contents of the file is the "
17752 "string C<content> (which can contain any 8 bit data), with length C<size>."
17756 #: ../src/guestfs-actions.pod:7307 ../fish/guestfish-actions.pod:4894
17758 "As a special case, if C<size> is C<0> then the length is calculated using "
17759 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17763 #: ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:4898
17765 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17766 "I<not> work, even if the length is specified."
17770 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4904
17771 msgid "This function is deprecated. In new code, use the C<write> call instead."
17775 #: ../src/guestfs-actions.pod:7328
17776 msgid "guestfs_zegrep"
17780 #: ../src/guestfs-actions.pod:7330
17784 " guestfs_zegrep (guestfs_h *g,\n"
17785 " const char *regex,\n"
17786 " const char *path);\n"
17791 #: ../src/guestfs-actions.pod:7335 ../fish/guestfish-actions.pod:4915
17792 msgid "This calls the external C<zegrep> program and returns the matching lines."
17796 #: ../src/guestfs-actions.pod:7347
17797 msgid "guestfs_zegrepi"
17801 #: ../src/guestfs-actions.pod:7349
17805 " guestfs_zegrepi (guestfs_h *g,\n"
17806 " const char *regex,\n"
17807 " const char *path);\n"
17812 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:4925
17813 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17817 #: ../src/guestfs-actions.pod:7366
17818 msgid "guestfs_zero"
17822 #: ../src/guestfs-actions.pod:7368
17826 " guestfs_zero (guestfs_h *g,\n"
17827 " const char *device);\n"
17832 #: ../src/guestfs-actions.pod:7372 ../fish/guestfish-actions.pod:4935
17833 msgid "This command writes zeroes over the first few blocks of C<device>."
17837 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4937
17839 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17840 "securely wipe the device). It should be sufficient to remove any partition "
17841 "tables, filesystem superblocks and so on."
17845 #: ../src/guestfs-actions.pod:7378
17846 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17850 #: ../src/guestfs-actions.pod:7389
17851 msgid "guestfs_zero_device"
17855 #: ../src/guestfs-actions.pod:7391
17859 " guestfs_zero_device (guestfs_h *g,\n"
17860 " const char *device);\n"
17865 #: ../src/guestfs-actions.pod:7395
17867 "This command writes zeroes over the entire C<device>. Compare with "
17868 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17872 #: ../src/guestfs-actions.pod:7409
17873 msgid "(Added in 1.3.1)"
17877 #: ../src/guestfs-actions.pod:7411
17878 msgid "guestfs_zerofree"
17882 #: ../src/guestfs-actions.pod:7413
17886 " guestfs_zerofree (guestfs_h *g,\n"
17887 " const char *device);\n"
17892 #: ../src/guestfs-actions.pod:7417 ../fish/guestfish-actions.pod:4958
17894 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17895 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17896 "possible to compress the filesystem more effectively."
17900 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
17901 msgid "You should B<not> run this program if the filesystem is mounted."
17905 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4966
17907 "It is possible that using this program can damage the filesystem or data on "
17912 #: ../src/guestfs-actions.pod:7432
17913 msgid "guestfs_zfgrep"
17917 #: ../src/guestfs-actions.pod:7434
17921 " guestfs_zfgrep (guestfs_h *g,\n"
17922 " const char *pattern,\n"
17923 " const char *path);\n"
17928 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4973
17929 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17933 #: ../src/guestfs-actions.pod:7451
17934 msgid "guestfs_zfgrepi"
17938 #: ../src/guestfs-actions.pod:7453
17942 " guestfs_zfgrepi (guestfs_h *g,\n"
17943 " const char *pattern,\n"
17944 " const char *path);\n"
17949 #: ../src/guestfs-actions.pod:7458 ../fish/guestfish-actions.pod:4983
17950 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17954 #: ../src/guestfs-actions.pod:7470
17955 msgid "guestfs_zfile"
17959 #: ../src/guestfs-actions.pod:7472
17963 " guestfs_zfile (guestfs_h *g,\n"
17964 " const char *meth,\n"
17965 " const char *path);\n"
17970 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4993
17971 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17975 #: ../src/guestfs-actions.pod:7480 ../fish/guestfish-actions.pod:4996
17976 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17980 #: ../src/guestfs-actions.pod:7482
17982 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17987 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:5001
17988 msgid "This function is deprecated. In new code, use the C<file> call instead."
17992 #: ../src/guestfs-actions.pod:7497
17993 msgid "guestfs_zgrep"
17997 #: ../src/guestfs-actions.pod:7499
18001 " guestfs_zgrep (guestfs_h *g,\n"
18002 " const char *regex,\n"
18003 " const char *path);\n"
18008 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5012
18009 msgid "This calls the external C<zgrep> program and returns the matching lines."
18013 #: ../src/guestfs-actions.pod:7516
18014 msgid "guestfs_zgrepi"
18018 #: ../src/guestfs-actions.pod:7518
18022 " guestfs_zgrepi (guestfs_h *g,\n"
18023 " const char *regex,\n"
18024 " const char *path);\n"
18029 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:5022
18030 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18034 #: ../src/guestfs-availability.pod:3
18039 #: ../src/guestfs-availability.pod:5
18041 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18042 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18043 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18044 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18045 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18049 #: ../src/guestfs-availability.pod:21
18054 #: ../src/guestfs-availability.pod:23
18056 "The following functions: L</guestfs_inotify_add_watch> "
18057 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18058 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18062 #: ../src/guestfs-availability.pod:31
18063 msgid "B<linuxfsuuid>"
18067 #: ../src/guestfs-availability.pod:33
18069 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18070 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18074 #: ../src/guestfs-availability.pod:40
18075 msgid "B<linuxmodules>"
18079 #: ../src/guestfs-availability.pod:42
18080 msgid "The following functions: L</guestfs_modprobe>"
18084 #: ../src/guestfs-availability.pod:45
18085 msgid "B<linuxxattrs>"
18089 #: ../src/guestfs-availability.pod:47
18091 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18092 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18093 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18094 "L</guestfs_setxattr>"
18098 #: ../src/guestfs-availability.pod:58
18103 #: ../src/guestfs-availability.pod:60
18105 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18106 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18107 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18111 #: ../src/guestfs-availability.pod:69
18116 #: ../src/guestfs-availability.pod:71
18118 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18119 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18120 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18121 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18122 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18123 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18124 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18125 "L</guestfs_vgs_full>"
18129 #: ../src/guestfs-availability.pod:94
18134 #: ../src/guestfs-availability.pod:96
18136 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18137 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18141 #: ../src/guestfs-availability.pod:102
18146 #: ../src/guestfs-availability.pod:104
18147 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18151 #: ../src/guestfs-availability.pod:107
18152 msgid "B<ntfsprogs>"
18156 #: ../src/guestfs-availability.pod:109
18157 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18161 #: ../src/guestfs-availability.pod:113
18162 msgid "B<realpath>"
18166 #: ../src/guestfs-availability.pod:115
18167 msgid "The following functions: L</guestfs_realpath>"
18171 #: ../src/guestfs-availability.pod:118
18176 #: ../src/guestfs-availability.pod:120
18178 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18179 "L</guestfs_scrub_freespace>"
18183 #: ../src/guestfs-availability.pod:125
18188 #: ../src/guestfs-availability.pod:127
18189 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18193 #: ../src/guestfs-availability.pod:131
18198 #: ../src/guestfs-availability.pod:133
18199 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18203 #: ../src/guestfs-availability.pod:137
18204 msgid "B<zerofree>"
18208 #: ../src/guestfs-availability.pod:139
18209 msgid "The following functions: L</guestfs_zerofree>"
18213 #: ../src/guestfs-structs.pod:1
18214 msgid "guestfs_int_bool"
18218 #: ../src/guestfs-structs.pod:3
18221 " struct guestfs_int_bool {\n"
18229 #: ../src/guestfs-structs.pod:8
18232 " struct guestfs_int_bool_list {\n"
18233 " uint32_t len; /* Number of elements in list. */\n"
18234 " struct guestfs_int_bool *val; /* Elements. */\n"
18240 #: ../src/guestfs-structs.pod:13
18243 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18244 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18249 #: ../src/guestfs-structs.pod:16
18250 msgid "guestfs_lvm_pv"
18254 #: ../src/guestfs-structs.pod:18
18257 " struct guestfs_lvm_pv {\n"
18258 " char *pv_name;\n"
18259 " /* The next field is NOT nul-terminated, be careful when printing it: "
18261 " char pv_uuid[32];\n"
18263 " uint64_t pv_size;\n"
18264 " uint64_t dev_size;\n"
18265 " uint64_t pv_free;\n"
18266 " uint64_t pv_used;\n"
18267 " char *pv_attr;\n"
18268 " int64_t pv_pe_count;\n"
18269 " int64_t pv_pe_alloc_count;\n"
18270 " char *pv_tags;\n"
18271 " uint64_t pe_start;\n"
18272 " int64_t pv_mda_count;\n"
18273 " uint64_t pv_mda_free;\n"
18279 #: ../src/guestfs-structs.pod:36
18282 " struct guestfs_lvm_pv_list {\n"
18283 " uint32_t len; /* Number of elements in list. */\n"
18284 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18290 #: ../src/guestfs-structs.pod:41
18293 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18294 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18299 #: ../src/guestfs-structs.pod:44
18300 msgid "guestfs_lvm_vg"
18304 #: ../src/guestfs-structs.pod:46
18307 " struct guestfs_lvm_vg {\n"
18308 " char *vg_name;\n"
18309 " /* The next field is NOT nul-terminated, be careful when printing it: "
18311 " char vg_uuid[32];\n"
18313 " char *vg_attr;\n"
18314 " uint64_t vg_size;\n"
18315 " uint64_t vg_free;\n"
18316 " char *vg_sysid;\n"
18317 " uint64_t vg_extent_size;\n"
18318 " int64_t vg_extent_count;\n"
18319 " int64_t vg_free_count;\n"
18320 " int64_t max_lv;\n"
18321 " int64_t max_pv;\n"
18322 " int64_t pv_count;\n"
18323 " int64_t lv_count;\n"
18324 " int64_t snap_count;\n"
18325 " int64_t vg_seqno;\n"
18326 " char *vg_tags;\n"
18327 " int64_t vg_mda_count;\n"
18328 " uint64_t vg_mda_free;\n"
18334 #: ../src/guestfs-structs.pod:69
18337 " struct guestfs_lvm_vg_list {\n"
18338 " uint32_t len; /* Number of elements in list. */\n"
18339 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18345 #: ../src/guestfs-structs.pod:74
18348 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18349 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18354 #: ../src/guestfs-structs.pod:77
18355 msgid "guestfs_lvm_lv"
18359 #: ../src/guestfs-structs.pod:79
18362 " struct guestfs_lvm_lv {\n"
18363 " char *lv_name;\n"
18364 " /* The next field is NOT nul-terminated, be careful when printing it: "
18366 " char lv_uuid[32];\n"
18367 " char *lv_attr;\n"
18368 " int64_t lv_major;\n"
18369 " int64_t lv_minor;\n"
18370 " int64_t lv_kernel_major;\n"
18371 " int64_t lv_kernel_minor;\n"
18372 " uint64_t lv_size;\n"
18373 " int64_t seg_count;\n"
18375 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18376 " float snap_percent;\n"
18377 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18378 " float copy_percent;\n"
18379 " char *move_pv;\n"
18380 " char *lv_tags;\n"
18381 " char *mirror_log;\n"
18382 " char *modules;\n"
18388 #: ../src/guestfs-structs.pod:101
18391 " struct guestfs_lvm_lv_list {\n"
18392 " uint32_t len; /* Number of elements in list. */\n"
18393 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18399 #: ../src/guestfs-structs.pod:106
18402 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18403 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18408 #: ../src/guestfs-structs.pod:111
18411 " struct guestfs_stat {\n"
18415 " int64_t nlink;\n"
18420 " int64_t blksize;\n"
18421 " int64_t blocks;\n"
18422 " int64_t atime;\n"
18423 " int64_t mtime;\n"
18424 " int64_t ctime;\n"
18430 #: ../src/guestfs-structs.pod:127
18433 " struct guestfs_stat_list {\n"
18434 " uint32_t len; /* Number of elements in list. */\n"
18435 " struct guestfs_stat *val; /* Elements. */\n"
18441 #: ../src/guestfs-structs.pod:132
18444 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18445 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18450 #: ../src/guestfs-structs.pod:137
18453 " struct guestfs_statvfs {\n"
18454 " int64_t bsize;\n"
18455 " int64_t frsize;\n"
18456 " int64_t blocks;\n"
18457 " int64_t bfree;\n"
18458 " int64_t bavail;\n"
18459 " int64_t files;\n"
18460 " int64_t ffree;\n"
18461 " int64_t favail;\n"
18464 " int64_t namemax;\n"
18470 #: ../src/guestfs-structs.pod:151
18473 " struct guestfs_statvfs_list {\n"
18474 " uint32_t len; /* Number of elements in list. */\n"
18475 " struct guestfs_statvfs *val; /* Elements. */\n"
18481 #: ../src/guestfs-structs.pod:156
18484 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18485 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18490 #: ../src/guestfs-structs.pod:159
18491 msgid "guestfs_dirent"
18495 #: ../src/guestfs-structs.pod:161
18498 " struct guestfs_dirent {\n"
18507 #: ../src/guestfs-structs.pod:167
18510 " struct guestfs_dirent_list {\n"
18511 " uint32_t len; /* Number of elements in list. */\n"
18512 " struct guestfs_dirent *val; /* Elements. */\n"
18518 #: ../src/guestfs-structs.pod:172
18521 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18522 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18527 #: ../src/guestfs-structs.pod:177
18530 " struct guestfs_version {\n"
18531 " int64_t major;\n"
18532 " int64_t minor;\n"
18533 " int64_t release;\n"
18540 #: ../src/guestfs-structs.pod:184
18543 " struct guestfs_version_list {\n"
18544 " uint32_t len; /* Number of elements in list. */\n"
18545 " struct guestfs_version *val; /* Elements. */\n"
18551 #: ../src/guestfs-structs.pod:189
18554 " void guestfs_free_version (struct guestfs_free_version *);\n"
18555 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18560 #: ../src/guestfs-structs.pod:192
18561 msgid "guestfs_xattr"
18565 #: ../src/guestfs-structs.pod:194
18568 " struct guestfs_xattr {\n"
18569 " char *attrname;\n"
18570 " /* The next two fields describe a byte array. */\n"
18571 " uint32_t attrval_len;\n"
18572 " char *attrval;\n"
18578 #: ../src/guestfs-structs.pod:201
18581 " struct guestfs_xattr_list {\n"
18582 " uint32_t len; /* Number of elements in list. */\n"
18583 " struct guestfs_xattr *val; /* Elements. */\n"
18589 #: ../src/guestfs-structs.pod:206
18592 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18593 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18598 #: ../src/guestfs-structs.pod:209
18599 msgid "guestfs_inotify_event"
18603 #: ../src/guestfs-structs.pod:211
18606 " struct guestfs_inotify_event {\n"
18607 " int64_t in_wd;\n"
18608 " uint32_t in_mask;\n"
18609 " uint32_t in_cookie;\n"
18610 " char *in_name;\n"
18616 #: ../src/guestfs-structs.pod:218
18619 " struct guestfs_inotify_event_list {\n"
18620 " uint32_t len; /* Number of elements in list. */\n"
18621 " struct guestfs_inotify_event *val; /* Elements. */\n"
18627 #: ../src/guestfs-structs.pod:223
18630 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18631 " void guestfs_free_inotify_event_list (struct "
18632 "guestfs_free_inotify_event_list *);\n"
18637 #: ../src/guestfs-structs.pod:226
18638 msgid "guestfs_partition"
18642 #: ../src/guestfs-structs.pod:228
18645 " struct guestfs_partition {\n"
18646 " int32_t part_num;\n"
18647 " uint64_t part_start;\n"
18648 " uint64_t part_end;\n"
18649 " uint64_t part_size;\n"
18655 #: ../src/guestfs-structs.pod:235
18658 " struct guestfs_partition_list {\n"
18659 " uint32_t len; /* Number of elements in list. */\n"
18660 " struct guestfs_partition *val; /* Elements. */\n"
18666 #: ../src/guestfs-structs.pod:240
18669 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18670 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18675 #: ../src/guestfs-structs.pod:243
18676 msgid "guestfs_application"
18680 #: ../src/guestfs-structs.pod:245
18683 " struct guestfs_application {\n"
18684 " char *app_name;\n"
18685 " char *app_display_name;\n"
18686 " int32_t app_epoch;\n"
18687 " char *app_version;\n"
18688 " char *app_release;\n"
18689 " char *app_install_path;\n"
18690 " char *app_trans_path;\n"
18691 " char *app_publisher;\n"
18692 " char *app_url;\n"
18693 " char *app_source_package;\n"
18694 " char *app_summary;\n"
18695 " char *app_description;\n"
18701 #: ../src/guestfs-structs.pod:260
18704 " struct guestfs_application_list {\n"
18705 " uint32_t len; /* Number of elements in list. */\n"
18706 " struct guestfs_application *val; /* Elements. */\n"
18712 #: ../src/guestfs-structs.pod:265
18715 " void guestfs_free_application (struct guestfs_free_application *);\n"
18716 " void guestfs_free_application_list (struct guestfs_free_application_list "
18722 #: ../fish/guestfish.pod:5
18723 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18727 #: ../fish/guestfish.pod:9
18730 " guestfish [--options] [commands]\n"
18735 #: ../fish/guestfish.pod:11
18743 #: ../fish/guestfish.pod:13
18746 " guestfish [--ro|--rw] -a disk.img\n"
18751 #: ../fish/guestfish.pod:15
18754 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18759 #: ../fish/guestfish.pod:17
18762 " guestfish -d libvirt-domain\n"
18767 #: ../fish/guestfish.pod:19
18770 " guestfish [--ro|--rw] -a disk.img -i\n"
18775 #: ../fish/guestfish.pod:21
18778 " guestfish -d libvirt-domain -i\n"
18783 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18788 #: ../fish/guestfish.pod:25
18790 "Using guestfish in read/write mode on live virtual machines can be "
18791 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18792 "option to use guestfish safely if the disk image or virtual machine might be "
18797 #: ../fish/guestfish.pod:32
18799 "Guestfish is a shell and command-line tool for examining and modifying "
18800 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18801 "functionality of the guestfs API, see L<guestfs(3)>."
18805 #: ../fish/guestfish.pod:36
18807 "Guestfish gives you structured access to the libguestfs API, from shell "
18808 "scripts or the command line or interactively. If you want to rescue a "
18809 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18814 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
18819 #: ../fish/guestfish.pod:43
18820 msgid "As an interactive shell"
18824 #: ../fish/guestfish.pod:45
18832 #: ../fish/guestfish.pod:47
18835 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18836 " editing virtual machine filesystems.\n"
18841 #: ../fish/guestfish.pod:50
18844 " Type: 'help' for a list of commands\n"
18845 " 'man' to read the manual\n"
18846 " 'quit' to quit the shell\n"
18851 #: ../fish/guestfish.pod:54
18854 " ><fs> add-ro disk.img\n"
18856 " ><fs> list-filesystems\n"
18857 " /dev/sda1: ext4\n"
18858 " /dev/vg_guest/lv_root: ext4\n"
18859 " /dev/vg_guest/lv_swap: swap\n"
18860 " ><fs> mount /dev/vg_guest/lv_root /\n"
18861 " ><fs> cat /etc/fstab\n"
18863 " # Created by anaconda\n"
18870 #: ../fish/guestfish.pod:67
18871 msgid "From shell scripts"
18875 #: ../fish/guestfish.pod:69
18876 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18880 #: ../fish/guestfish.pod:71
18883 " guestfish <<_EOF_\n"
18886 " mount /dev/vg_guest/lv_root /\n"
18887 " write /etc/motd \"Welcome, new users\"\n"
18893 #: ../fish/guestfish.pod:78
18894 msgid "List the LVM logical volumes in a disk image:"
18898 #: ../fish/guestfish.pod:80
18901 " guestfish -a disk.img --ro <<_EOF_\n"
18909 #: ../fish/guestfish.pod:85
18910 msgid "List all the filesystems in a disk image:"
18914 #: ../fish/guestfish.pod:87
18917 " guestfish -a disk.img --ro <<_EOF_\n"
18919 " list-filesystems\n"
18925 #: ../fish/guestfish.pod:92
18926 msgid "On one command line"
18930 #: ../fish/guestfish.pod:94
18931 msgid "Update C</etc/resolv.conf> in a guest:"
18935 #: ../fish/guestfish.pod:96
18939 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18940 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18945 #: ../fish/guestfish.pod:100
18946 msgid "Edit C</boot/grub/grub.conf> interactively:"
18950 #: ../fish/guestfish.pod:102
18953 " guestfish --rw --add disk.img \\\n"
18954 " --mount /dev/vg_guest/lv_root \\\n"
18955 " --mount /dev/sda1:/boot \\\n"
18956 " edit /boot/grub/grub.conf\n"
18961 #: ../fish/guestfish.pod:107
18962 msgid "Mount disks automatically"
18966 #: ../fish/guestfish.pod:109
18968 "Use the I<-i> option to automatically mount the disks from a virtual "
18973 #: ../fish/guestfish.pod:112
18976 " guestfish --ro -a disk.img -i cat /etc/group\n"
18981 #: ../fish/guestfish.pod:114
18984 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18989 #: ../fish/guestfish.pod:116
18990 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18994 #: ../fish/guestfish.pod:118
18997 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19002 #: ../fish/guestfish.pod:120
19003 msgid "As a script interpreter"
19007 #: ../fish/guestfish.pod:122
19008 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19012 #: ../fish/guestfish.pod:124
19015 " #!/usr/bin/guestfish -f\n"
19016 " sparse test1.img 100M\n"
19018 " part-disk /dev/sda mbr\n"
19019 " mkfs ext2 /dev/sda1\n"
19024 #: ../fish/guestfish.pod:130
19025 msgid "Start with a prepared disk"
19029 #: ../fish/guestfish.pod:132
19031 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19032 "single ext2-formatted partition:"
19036 #: ../fish/guestfish.pod:135
19039 " guestfish -N fs\n"
19044 #: ../fish/guestfish.pod:137
19045 msgid "To list what is available do:"
19049 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19052 " guestfish -N help | less\n"
19057 #: ../fish/guestfish.pod:141
19058 msgid "Remote control"
19062 #: ../fish/guestfish.pod:143
19065 " eval \"`guestfish --listen`\"\n"
19066 " guestfish --remote add-ro disk.img\n"
19067 " guestfish --remote run\n"
19068 " guestfish --remote lvs\n"
19073 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:83 ../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
19078 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141 ../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
19083 #: ../fish/guestfish.pod:154
19084 msgid "Displays general help on options."
19088 #: ../fish/guestfish.pod:156
19093 #: ../fish/guestfish.pod:158
19094 msgid "B<--cmd-help>"
19098 #: ../fish/guestfish.pod:160
19099 msgid "Lists all available guestfish commands."
19103 #: ../fish/guestfish.pod:162
19108 #: ../fish/guestfish.pod:164
19109 msgid "B<--cmd-help cmd>"
19113 #: ../fish/guestfish.pod:166
19114 msgid "Displays detailed help on a single command C<cmd>."
19118 #: ../fish/guestfish.pod:168
19119 msgid "B<-a image>"
19123 #: ../fish/guestfish.pod:170
19124 msgid "B<--add image>"
19128 #: ../fish/guestfish.pod:172
19129 msgid "Add a block device or virtual machine image to the shell."
19133 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19135 "The format of the disk image is auto-detected. To override this and force a "
19136 "particular format use the I<--format=..> option."
19140 #: ../fish/guestfish.pod:177
19142 "Using this flag is mostly equivalent to using the C<add> command, with "
19143 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19144 "the I<--format=...> flag was given."
19148 #: ../fish/guestfish.pod:181
19153 #: ../fish/guestfish.pod:183
19154 msgid "B<--connect URI>"
19158 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19160 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19161 "URI to use. The default is to use the default libvirt connection."
19165 #: ../fish/guestfish.pod:189
19170 #: ../fish/guestfish.pod:191
19172 "If using the I<--listen> option and a csh-like shell, use this option. See "
19173 "section L</REMOTE CONTROL AND CSH> below."
19177 #: ../fish/guestfish.pod:194
19178 msgid "B<-d libvirt-domain>"
19182 #: ../fish/guestfish.pod:196
19183 msgid "B<--domain libvirt-domain>"
19187 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19189 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19190 "used, then any libvirt domain can be used. However in write mode, only "
19191 "libvirt domains which are shut down can be named here."
19195 #: ../fish/guestfish.pod:202
19197 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19198 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19199 "if the I<--format:...> flag was given."
19203 #: ../fish/guestfish.pod:206
19208 #: ../fish/guestfish.pod:208
19209 msgid "B<--no-dest-paths>"
19213 #: ../fish/guestfish.pod:210
19215 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19216 "to hit the tab key to complete paths on the guest filesystem, but this "
19217 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19218 "allow this feature to be disabled."
19222 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19223 msgid "B<--echo-keys>"
19227 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19229 "When prompting for keys and passphrases, guestfish normally turns echoing "
19230 "off so you cannot see what you are typing. If you are not worried about "
19231 "Tempest attacks and there is no one else in the room you can specify this "
19232 "flag to see what you are typing."
19236 #: ../fish/guestfish.pod:222
19241 #: ../fish/guestfish.pod:224
19242 msgid "B<--file file>"
19246 #: ../fish/guestfish.pod:226
19247 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19251 #: ../fish/guestfish.pod:229
19254 " #!/usr/bin/guestfish -f\n"
19259 #: ../fish/guestfish.pod:231
19260 msgid "B<--format=raw|qcow2|..>"
19264 #: ../fish/guestfish.pod:233
19265 msgid "B<--format>"
19269 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19271 "The default for the I<-a> option is to auto-detect the format of the disk "
19272 "image. Using this forces the disk format for I<-a> options which follow on "
19273 "the command line. Using I<--format> with no argument switches back to "
19274 "auto-detection for subsequent I<-a> options."
19278 #: ../fish/guestfish.pod:242
19281 " guestfish --format=raw -a disk.img\n"
19286 #: ../fish/guestfish.pod:244
19287 msgid "forces raw format (no auto-detection) for C<disk.img>."
19291 #: ../fish/guestfish.pod:246
19294 " guestfish --format=raw -a disk.img --format -a another.img\n"
19299 #: ../fish/guestfish.pod:248
19301 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19302 "auto-detection for C<another.img>."
19306 #: ../fish/guestfish.pod:251
19308 "If you have untrusted raw-format guest disk images, you should use this "
19309 "option to specify the disk format. This avoids a possible security problem "
19310 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19314 #: ../fish/guestfish.pod:256
19319 #: ../fish/guestfish.pod:258
19320 msgid "B<--inspector>"
19324 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19326 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19327 "system and mount filesystems as they would be mounted on the real virtual "
19332 #: ../fish/guestfish.pod:264
19333 msgid "Typical usage is either:"
19337 #: ../fish/guestfish.pod:266
19340 " guestfish -d myguest -i\n"
19345 #: ../fish/guestfish.pod:268
19346 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19350 #: ../fish/guestfish.pod:270
19353 " guestfish --ro -d myguest -i\n"
19358 #: ../fish/guestfish.pod:272
19359 msgid "(for active domains, readonly), or specify the block device directly:"
19363 #: ../fish/guestfish.pod:274
19366 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19371 #: ../fish/guestfish.pod:276
19373 "Note that the command line syntax changed slightly over older versions of "
19374 "guestfish. You can still use the old syntax:"
19378 #: ../fish/guestfish.pod:279
19381 " guestfish [--ro] -i disk.img\n"
19386 #: ../fish/guestfish.pod:281
19389 " guestfish [--ro] -i libvirt-domain\n"
19394 #: ../fish/guestfish.pod:283
19396 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19397 "then using other commands to mount the filesystems that were found."
19401 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
19402 msgid "B<--keys-from-stdin>"
19406 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19408 "Read key or passphrase parameters from stdin. The default is to try to read "
19409 "passphrases from the user by opening C</dev/tty>."
19413 #: ../fish/guestfish.pod:292
19414 msgid "B<--listen>"
19418 #: ../fish/guestfish.pod:294
19420 "Fork into the background and listen for remote commands. See section "
19421 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19425 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
19430 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19432 "Connect to a live virtual machine. (Experimental, see "
19433 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19437 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
19438 msgid "B<-m dev[:mountpoint[:options]]>"
19442 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19443 msgid "B<--mount dev[:mountpoint[:options]]>"
19447 #: ../fish/guestfish.pod:306
19448 msgid "Mount the named partition or logical volume on the given mountpoint."
19452 #: ../fish/guestfish.pod:308
19453 msgid "If the mountpoint is omitted, it defaults to C</>."
19457 #: ../fish/guestfish.pod:310
19458 msgid "You have to mount something on C</> before most commands will work."
19462 #: ../fish/guestfish.pod:312
19464 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19469 #: ../fish/guestfish.pod:315
19471 "If you don't know what filesystems a disk image contains, you can either run "
19472 "guestfish without this option, then list the partitions, filesystems and LVs "
19473 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19474 "commands), or you can use the L<virt-filesystems(1)> program."
19478 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
19480 "The third (and rarely used) part of the mount parameter is the list of mount "
19481 "options used to mount the underlying filesystem. If this is not given, then "
19482 "the mount options are either the empty string or C<ro> (the latter if the "
19483 "I<--ro> flag is used). By specifying the mount options, you override this "
19484 "default choice. Probably the only time you would use this is to enable ACLs "
19485 "and/or extended attributes if the filesystem can support them:"
19489 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
19492 " -m /dev/sda1:/:acl,user_xattr\n"
19497 #: ../fish/guestfish.pod:331
19498 msgid "Using this flag is equivalent to using the C<mount-options> command."
19502 #: ../fish/guestfish.pod:333
19507 #: ../fish/guestfish.pod:335
19508 msgid "B<--no-sync>"
19512 #: ../fish/guestfish.pod:337
19514 "Disable autosync. This is enabled by default. See the discussion of "
19515 "autosync in the L<guestfs(3)> manpage."
19519 #: ../fish/guestfish.pod:340
19524 #: ../fish/guestfish.pod:342
19525 msgid "B<--new type>"
19529 #: ../fish/guestfish.pod:344
19534 #: ../fish/guestfish.pod:346
19536 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19537 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19538 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19543 #: ../fish/guestfish.pod:351
19544 msgid "B<--progress-bars>"
19548 #: ../fish/guestfish.pod:353
19549 msgid "Enable progress bars, even when guestfish is used non-interactively."
19553 #: ../fish/guestfish.pod:355
19555 "Progress bars are enabled by default when guestfish is used as an "
19556 "interactive shell."
19560 #: ../fish/guestfish.pod:358
19561 msgid "B<--no-progress-bars>"
19565 #: ../fish/guestfish.pod:360
19566 msgid "Disable progress bars."
19570 #: ../fish/guestfish.pod:362
19571 msgid "B<--remote[=pid]>"
19575 #: ../fish/guestfish.pod:364
19577 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19578 "CONTROL GUESTFISH OVER A SOCKET> below."
19582 #: ../fish/guestfish.pod:367
19587 #: ../fish/guestfish.pod:369
19592 #: ../fish/guestfish.pod:371
19594 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19595 "mounts are done read-only."
19599 #: ../fish/guestfish.pod:374
19601 "The option must always be used if the disk image or virtual machine might be "
19602 "running, and is generally recommended in cases where you don't need write "
19603 "access to the disk."
19607 #: ../fish/guestfish.pod:378
19609 "Note that prepared disk images created with I<-N> are not affected by this "
19610 "option. Also commands like C<add> are not affected - you have to specify "
19611 "the C<readonly:true> option explicitly if you need it."
19615 #: ../fish/guestfish.pod:382
19616 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19620 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
19621 msgid "B<--selinux>"
19625 #: ../fish/guestfish.pod:386
19626 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19630 #: ../fish/guestfish.pod:388
19635 #: ../fish/guestfish.pod:390
19636 msgid "B<--verbose>"
19640 #: ../fish/guestfish.pod:392
19642 "Enable very verbose messages. This is particularly useful if you find a "
19647 #: ../fish/guestfish.pod:395
19652 #: ../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
19653 msgid "B<--version>"
19657 #: ../fish/guestfish.pod:399
19658 msgid "Display the guestfish / libguestfs version number and exit."
19662 #: ../fish/guestfish.pod:401
19667 #: ../fish/guestfish.pod:403
19672 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
19674 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19675 "mounts are done read-write."
19679 #: ../fish/guestfish.pod:408
19680 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19684 #: ../fish/guestfish.pod:410
19689 #: ../fish/guestfish.pod:412
19690 msgid "Echo each command before executing it."
19694 #: ../fish/guestfish.pod:416
19695 msgid "COMMANDS ON COMMAND LINE"
19699 #: ../fish/guestfish.pod:418
19700 msgid "Any additional (non-option) arguments are treated as commands to execute."
19704 #: ../fish/guestfish.pod:421
19706 "Commands to execute should be separated by a colon (C<:>), where the colon "
19707 "is a separate parameter. Thus:"
19711 #: ../fish/guestfish.pod:424
19714 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19719 #: ../fish/guestfish.pod:426
19721 "If there are no additional arguments, then we enter a shell, either an "
19722 "interactive shell with a prompt (if the input is a terminal) or a "
19723 "non-interactive shell."
19727 #: ../fish/guestfish.pod:430
19729 "In either command line mode or non-interactive shell, the first command that "
19730 "gives an error causes the whole shell to exit. In interactive mode (with a "
19731 "prompt) if a command fails, you can continue to enter commands."
19735 #: ../fish/guestfish.pod:435
19736 msgid "USING launch (OR run)"
19740 #: ../fish/guestfish.pod:437
19742 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19743 "then launch it, then mount any disks you need, and finally issue "
19744 "actions/commands. So the general order of the day is:"
19748 #: ../fish/guestfish.pod:445
19749 msgid "add or -a/--add"
19753 #: ../fish/guestfish.pod:449
19754 msgid "launch (aka run)"
19758 #: ../fish/guestfish.pod:453
19759 msgid "mount or -m/--mount"
19763 #: ../fish/guestfish.pod:457
19764 msgid "any other commands"
19768 #: ../fish/guestfish.pod:461
19770 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19771 "guest before mounting or performing any other commands."
19775 #: ../fish/guestfish.pod:464
19777 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19778 "I<--new> options were given then C<run> is done automatically, simply "
19779 "because guestfish can't perform the action you asked for without doing this."
19783 #: ../fish/guestfish.pod:469
19784 msgid "OPENING DISKS FOR READ AND WRITE"
19788 #: ../fish/guestfish.pod:471
19790 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19791 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19792 "I<-i> and I<-m> open disk images read-only or for writing."
19796 #: ../fish/guestfish.pod:476
19798 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19799 "opening disk images supplied on the command line for write. To open a disk "
19800 "image read-only you have to do I<-a image --ro>."
19804 #: ../fish/guestfish.pod:480
19806 "This matters: If you accidentally open a live VM disk image writable then "
19807 "you will cause irreversible disk corruption."
19811 #: ../fish/guestfish.pod:483
19813 "By libguestfs 1.12 we intend to change the default the other way. Disk "
19814 "images will be opened read-only. You will have to either specify "
19815 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19816 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19817 "access for disk images specified by those other command line options."
19821 #: ../fish/guestfish.pod:490
19823 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19824 "which does nothing (it is already the default). However it is highly "
19825 "recommended that you use this option to indicate that you need write access, "
19826 "and prepare your scripts for the day when this option will be required for "
19831 #: ../fish/guestfish.pod:496
19833 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19834 "other libguestfs program apart from guestfish and guestmount."
19838 #: ../fish/guestfish.pod:499
19843 #: ../fish/guestfish.pod:501
19845 "You can quote ordinary parameters using either single or double quotes. For "
19850 #: ../fish/guestfish.pod:504
19853 " add \"file with a space.img\"\n"
19858 #: ../fish/guestfish.pod:506
19861 " rm '/file name'\n"
19866 #: ../fish/guestfish.pod:508
19874 #: ../fish/guestfish.pod:510
19876 "A few commands require a list of strings to be passed. For these, use a "
19877 "whitespace-separated list, enclosed in quotes. Strings containing "
19878 "whitespace to be passed through must be enclosed in single quotes. A "
19879 "literal single quote must be escaped with a backslash."
19883 #: ../fish/guestfish.pod:515
19886 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19887 " command \"/bin/echo 'foo bar'\"\n"
19888 " command \"/bin/echo \\'foo\\'\"\n"
19893 #: ../fish/guestfish.pod:519
19894 msgid "OPTIONAL ARGUMENTS"
19898 #: ../fish/guestfish.pod:521
19900 "Some commands take optional arguments. These arguments appear in this "
19901 "documentation as C<[argname:..]>. You can use them as in these examples:"
19905 #: ../fish/guestfish.pod:525
19908 " add-drive-opts filename\n"
19913 #: ../fish/guestfish.pod:527
19916 " add-drive-opts filename readonly:true\n"
19921 #: ../fish/guestfish.pod:529
19924 " add-drive-opts filename format:qcow2 readonly:false\n"
19929 #: ../fish/guestfish.pod:531
19931 "Each optional argument can appear at most once. All optional arguments must "
19932 "appear after the required ones."
19936 #: ../fish/guestfish.pod:534
19941 #: ../fish/guestfish.pod:536
19942 msgid "This section applies to all commands which can take integers as parameters."
19946 #: ../fish/guestfish.pod:539
19947 msgid "SIZE SUFFIX"
19951 #: ../fish/guestfish.pod:541
19953 "When the command takes a parameter measured in bytes, you can use one of the "
19954 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19958 #: ../fish/guestfish.pod:547
19959 msgid "B<k> or B<K> or B<KiB>"
19963 #: ../fish/guestfish.pod:549
19964 msgid "The size in kilobytes (multiplied by 1024)."
19968 #: ../fish/guestfish.pod:551
19973 #: ../fish/guestfish.pod:553
19974 msgid "The size in SI 1000 byte units."
19978 #: ../fish/guestfish.pod:555
19979 msgid "B<M> or B<MiB>"
19983 #: ../fish/guestfish.pod:557
19984 msgid "The size in megabytes (multiplied by 1048576)."
19988 #: ../fish/guestfish.pod:559
19993 #: ../fish/guestfish.pod:561
19994 msgid "The size in SI 1000000 byte units."
19998 #: ../fish/guestfish.pod:563
19999 msgid "B<G> or B<GiB>"
20003 #: ../fish/guestfish.pod:565
20004 msgid "The size in gigabytes (multiplied by 2**30)."
20008 #: ../fish/guestfish.pod:567
20013 #: ../fish/guestfish.pod:569
20014 msgid "The size in SI 10**9 byte units."
20018 #: ../fish/guestfish.pod:571
20019 msgid "B<T> or B<TiB>"
20023 #: ../fish/guestfish.pod:573
20024 msgid "The size in terabytes (multiplied by 2**40)."
20028 #: ../fish/guestfish.pod:575
20033 #: ../fish/guestfish.pod:577
20034 msgid "The size in SI 10**12 byte units."
20038 #: ../fish/guestfish.pod:579
20039 msgid "B<P> or B<PiB>"
20043 #: ../fish/guestfish.pod:581
20044 msgid "The size in petabytes (multiplied by 2**50)."
20048 #: ../fish/guestfish.pod:583
20053 #: ../fish/guestfish.pod:585
20054 msgid "The size in SI 10**15 byte units."
20058 #: ../fish/guestfish.pod:587
20059 msgid "B<E> or B<EiB>"
20063 #: ../fish/guestfish.pod:589
20064 msgid "The size in exabytes (multiplied by 2**60)."
20068 #: ../fish/guestfish.pod:591
20073 #: ../fish/guestfish.pod:593
20074 msgid "The size in SI 10**18 byte units."
20078 #: ../fish/guestfish.pod:595
20079 msgid "B<Z> or B<ZiB>"
20083 #: ../fish/guestfish.pod:597
20084 msgid "The size in zettabytes (multiplied by 2**70)."
20088 #: ../fish/guestfish.pod:599
20093 #: ../fish/guestfish.pod:601
20094 msgid "The size in SI 10**21 byte units."
20098 #: ../fish/guestfish.pod:603
20099 msgid "B<Y> or B<YiB>"
20103 #: ../fish/guestfish.pod:605
20104 msgid "The size in yottabytes (multiplied by 2**80)."
20108 #: ../fish/guestfish.pod:607
20113 #: ../fish/guestfish.pod:609
20114 msgid "The size in SI 10**24 byte units."
20118 #: ../fish/guestfish.pod:615
20121 " truncate-size /file 1G\n"
20126 #: ../fish/guestfish.pod:617
20127 msgid "would truncate the file to 1 gigabyte."
20131 #: ../fish/guestfish.pod:619
20133 "Be careful because a few commands take sizes in kilobytes or megabytes "
20134 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20135 "Adding a suffix will probably not do what you expect."
20139 #: ../fish/guestfish.pod:623
20140 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20144 #: ../fish/guestfish.pod:625
20146 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20147 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20151 #: ../fish/guestfish.pod:628
20154 " 1234 decimal number 1234\n"
20155 " 02322 octal number, equivalent to decimal 1234\n"
20156 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20161 #: ../fish/guestfish.pod:632
20163 "When using the C<chmod> command, you almost always want to specify an octal "
20164 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20165 "L<chmod(1)> program):"
20169 #: ../fish/guestfish.pod:636
20172 " chmod 0777 /public # OK\n"
20173 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20178 #: ../fish/guestfish.pod:639
20180 "Commands that return numbers usually print them in decimal, but some "
20181 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20182 "octal, preceeded by C<0>)."
20186 #: ../fish/guestfish.pod:643
20187 msgid "WILDCARDS AND GLOBBING"
20191 #: ../fish/guestfish.pod:645
20193 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20194 "(globbing) by default. So for example the following will not do what you "
20199 #: ../fish/guestfish.pod:649
20207 #: ../fish/guestfish.pod:651
20209 "Assuming you don't have a directory called literally C</home/*> then the "
20210 "above command will return an error."
20214 #: ../fish/guestfish.pod:654
20215 msgid "To perform wildcard expansion, use the C<glob> command."
20219 #: ../fish/guestfish.pod:656
20222 " glob rm-rf /home/*\n"
20227 #: ../fish/guestfish.pod:658
20229 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20230 "many times), equivalent to:"
20234 #: ../fish/guestfish.pod:661
20237 " rm-rf /home/jim\n"
20238 " rm-rf /home/joe\n"
20239 " rm-rf /home/mary\n"
20244 #: ../fish/guestfish.pod:665
20245 msgid "C<glob> only works on simple guest paths and not on device names."
20249 #: ../fish/guestfish.pod:667
20251 "If you have several parameters, each containing a wildcard, then glob will "
20252 "perform a Cartesian product."
20256 #: ../fish/guestfish.pod:670
20261 #: ../fish/guestfish.pod:672
20263 "Any line which starts with a I<#> character is treated as a comment and "
20264 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20265 "a command. For example:"
20269 #: ../fish/guestfish.pod:676
20272 " # this is a comment\n"
20273 " # this is a comment\n"
20274 " foo # NOT a comment\n"
20279 #: ../fish/guestfish.pod:680
20280 msgid "Blank lines are also ignored."
20284 #: ../fish/guestfish.pod:682
20285 msgid "RUNNING COMMANDS LOCALLY"
20289 #: ../fish/guestfish.pod:684
20291 "Any line which starts with a I<!> character is treated as a command sent to "
20292 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20296 #: ../fish/guestfish.pod:688
20300 " tgz-out /remote local/remote-data.tar.gz\n"
20305 #: ../fish/guestfish.pod:691
20307 "will create a directory C<local> on the host, and then export the contents "
20308 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20309 "(See C<tgz-out>)."
20313 #: ../fish/guestfish.pod:695
20315 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20316 "effect, due to the way that subprocesses work in Unix."
20320 #: ../fish/guestfish.pod:698
20321 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20325 #: ../fish/guestfish.pod:700
20327 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20328 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20329 "and executed as guestfish commands."
20333 #: ../fish/guestfish.pod:704
20335 "Thus you can use shell script to construct arbitrary guestfish commands "
20336 "which are then parsed by guestfish."
20340 #: ../fish/guestfish.pod:707
20342 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20343 "through C</foo.100>) using guestfish commands alone. However this is simple "
20344 "if we use a shell script to create the guestfish commands for us:"
20348 #: ../fish/guestfish.pod:712
20351 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20356 #: ../fish/guestfish.pod:714
20357 msgid "or with names like C</foo.001>:"
20361 #: ../fish/guestfish.pod:716
20364 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20369 #: ../fish/guestfish.pod:718
20371 "When using guestfish interactively it can be helpful to just run the shell "
20372 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20373 "ordinary I<!> local command), see what guestfish commands it would run, and "
20374 "when you are happy with those prepend the C<E<lt>> character to run the "
20375 "guestfish commands for real."
20379 #: ../fish/guestfish.pod:724
20384 #: ../fish/guestfish.pod:726
20386 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20387 "command (a guestfish command) to the second command (any host command). For "
20392 #: ../fish/guestfish.pod:730
20395 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20400 #: ../fish/guestfish.pod:732
20402 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20403 "program). The above command would list all accounts in the guest filesystem "
20404 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20408 #: ../fish/guestfish.pod:737
20411 " hexdump /bin/ls | head\n"
20412 " list-devices | tail -1\n"
20413 " tgz-out / - | tar ztf -\n"
20418 #: ../fish/guestfish.pod:741
20420 "The space before the pipe symbol is required, any space after the pipe "
20421 "symbol is optional. Everything after the pipe symbol is just passed "
20422 "straight to the host shell, so it can contain redirections, globs and "
20423 "anything else that makes sense on the host side."
20427 #: ../fish/guestfish.pod:746
20429 "To use a literal argument which begins with a pipe symbol, you have to quote "
20434 #: ../fish/guestfish.pod:749
20442 #: ../fish/guestfish.pod:751
20443 msgid "HOME DIRECTORIES"
20447 #: ../fish/guestfish.pod:753
20449 "If a parameter starts with the character C<~> then the tilde may be expanded "
20450 "as a home directory path (either C<~> for the current user's home directory, "
20451 "or C<~user> for another user)."
20455 #: ../fish/guestfish.pod:757
20457 "Note that home directory expansion happens for users known I<on the host>, "
20458 "not in the guest filesystem."
20462 #: ../fish/guestfish.pod:760
20464 "To use a literal argument which begins with a tilde, you have to quote it, "
20469 #: ../fish/guestfish.pod:763
20477 #: ../fish/guestfish.pod:767
20479 "Libguestfs has some support for Linux guests encrypted according to the "
20480 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20481 "disk encryption systems used by modern Linux guests. Currently only "
20482 "LVM-on-LUKS is supported."
20486 #: ../fish/guestfish.pod:772
20487 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20491 #: ../fish/guestfish.pod:774
20494 " ><fs> vfs-type /dev/sda2\n"
20500 #: ../fish/guestfish.pod:777
20502 "Then open those devices using L</luks-open>. This creates a device-mapper "
20503 "device called C</dev/mapper/luksdev>."
20507 #: ../fish/guestfish.pod:780
20510 " ><fs> luks-open /dev/sda2 luksdev\n"
20511 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20516 #: ../fish/guestfish.pod:783
20518 "Finally you have to tell LVM to scan for volume groups on the newly created "
20523 #: ../fish/guestfish.pod:786
20527 " vg-activate-all true\n"
20532 #: ../fish/guestfish.pod:789
20533 msgid "The logical volume(s) can now be mounted in the usual way."
20537 #: ../fish/guestfish.pod:791
20539 "Before closing a LUKS device you must unmount any logical volumes on it and "
20540 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20541 "one. Then you can close the mapper device:"
20545 #: ../fish/guestfish.pod:795
20548 " vg-activate false /dev/VG\n"
20549 " luks-close /dev/mapper/luksdev\n"
20554 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20555 msgid "WINDOWS PATHS"
20559 #: ../fish/guestfish.pod:800
20561 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20562 "letters and paths (with some limitations). The following commands are "
20567 #: ../fish/guestfish.pod:804
20570 " file /WINDOWS/system32/config/system.LOG\n"
20575 #: ../fish/guestfish.pod:806
20578 " file win:\\windows\\system32\\config\\system.log\n"
20583 #: ../fish/guestfish.pod:808
20586 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20591 #: ../fish/guestfish.pod:810
20593 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20594 "where the drive is mounted, prepending that to the path, changing all "
20595 "backslash characters to forward slash, then resolving the result using "
20596 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20597 "then the parameter might be rewritten like this:"
20601 #: ../fish/guestfish.pod:816
20604 " win:e:\\foo\\bar => /e/FOO/bar\n"
20609 #: ../fish/guestfish.pod:818
20610 msgid "This only works in argument positions that expect a path."
20614 #: ../fish/guestfish.pod:820
20615 msgid "UPLOADING AND DOWNLOADING FILES"
20619 #: ../fish/guestfish.pod:822
20621 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20622 "others which upload from or download to a local file, you can use the "
20623 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20627 #: ../fish/guestfish.pod:826
20635 #: ../fish/guestfish.pod:828
20636 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20640 #: ../fish/guestfish.pod:831
20643 " tar-out /etc - | tar tf -\n"
20648 #: ../fish/guestfish.pod:833
20650 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20651 "command (see L</PIPES>)."
20655 #: ../fish/guestfish.pod:836
20657 "When using C<-> to read from stdin, the input is read up to the end of "
20658 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20659 "some arbitrary end marker:"
20663 #: ../fish/guestfish.pod:840
20666 " upload -<<END /foo\n"
20675 #: ../fish/guestfish.pod:846
20677 "Any string of characters can be used instead of C<END>. The end marker must "
20678 "appear on a line of its own, without any preceeding or following characters "
20679 "(not even spaces)."
20683 #: ../fish/guestfish.pod:850
20685 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20686 "upload local files (so-called \"FileIn\" parameters in the generator)."
20690 #: ../fish/guestfish.pod:853
20691 msgid "EXIT ON ERROR BEHAVIOUR"
20695 #: ../fish/guestfish.pod:855
20697 "By default, guestfish will ignore any errors when in interactive mode "
20698 "(ie. taking commands from a human over a tty), and will exit on the first "
20699 "error in non-interactive mode (scripts, commands given on the command line)."
20703 #: ../fish/guestfish.pod:860
20705 "If you prefix a command with a I<-> character, then that command will not "
20706 "cause guestfish to exit, even if that (one) command returns an error."
20710 #: ../fish/guestfish.pod:864
20711 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20715 #: ../fish/guestfish.pod:866
20717 "Guestfish can be remote-controlled over a socket. This is useful "
20718 "particularly in shell scripts where you want to make several different "
20719 "changes to a filesystem, but you don't want the overhead of starting up a "
20720 "guestfish process each time."
20724 #: ../fish/guestfish.pod:871
20725 msgid "Start a guestfish server process using:"
20729 #: ../fish/guestfish.pod:873
20732 " eval \"`guestfish --listen`\"\n"
20737 #: ../fish/guestfish.pod:875
20738 msgid "and then send it commands by doing:"
20742 #: ../fish/guestfish.pod:877
20745 " guestfish --remote cmd [...]\n"
20750 #: ../fish/guestfish.pod:879
20751 msgid "To cause the server to exit, send it the exit command:"
20755 #: ../fish/guestfish.pod:881
20758 " guestfish --remote exit\n"
20763 #: ../fish/guestfish.pod:883
20765 "Note that the server will normally exit if there is an error in a command. "
20766 "You can change this in the usual way. See section L</EXIT ON ERROR "
20771 #: ../fish/guestfish.pod:887
20772 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20776 #: ../fish/guestfish.pod:889
20778 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20779 "is how the I<--remote> option knows where to send the commands. You can "
20780 "have several guestfish listener processes running using:"
20784 #: ../fish/guestfish.pod:893
20787 " eval \"`guestfish --listen`\"\n"
20788 " pid1=$GUESTFISH_PID\n"
20789 " eval \"`guestfish --listen`\"\n"
20790 " pid2=$GUESTFISH_PID\n"
20792 " guestfish --remote=$pid1 cmd\n"
20793 " guestfish --remote=$pid2 cmd\n"
20798 #: ../fish/guestfish.pod:901
20799 msgid "REMOTE CONTROL AND CSH"
20803 #: ../fish/guestfish.pod:903
20805 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20810 #: ../fish/guestfish.pod:906
20813 " eval \"`guestfish --listen --csh`\"\n"
20818 #: ../fish/guestfish.pod:908
20819 msgid "REMOTE CONTROL DETAILS"
20823 #: ../fish/guestfish.pod:910
20825 "Remote control happens over a Unix domain socket called "
20826 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20827 "of the process, and C<$PID> is the process ID of the server."
20831 #: ../fish/guestfish.pod:914
20832 msgid "Guestfish client and server versions must match exactly."
20836 #: ../fish/guestfish.pod:916
20837 msgid "PREPARED DISK IMAGES"
20841 #: ../fish/guestfish.pod:918
20843 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20844 "preformatted disk images that guestfish can make for you to save typing. "
20845 "This is particularly useful for testing purposes. This option is used "
20846 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20847 "can be mixed with I<-a>)."
20851 #: ../fish/guestfish.pod:924
20853 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20854 "the second and so on. Existing files in the current directory are "
20859 #: ../fish/guestfish.pod:928
20861 "The type briefly describes how the disk should be sized, partitioned, how "
20862 "filesystem(s) should be created, and how content should be added. "
20863 "Optionally the type can be followed by extra parameters, separated by C<:> "
20864 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20865 "sparsely-allocated disk, containing a single partition, with the partition "
20866 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20867 "on a 1GB disk instead."
20871 #: ../fish/guestfish.pod:936
20872 msgid "To list the available types and any extra parameters they take, run:"
20876 #: ../fish/guestfish.pod:940
20878 "Note that the prepared filesystem is not mounted. You would usually have to "
20879 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20883 #: ../fish/guestfish.pod:944
20885 "If any I<-N> or I<--new> options are given, the guest is automatically "
20890 #: ../fish/guestfish.pod:949
20891 msgid "Create a 100MB disk with an ext4-formatted partition:"
20895 #: ../fish/guestfish.pod:951
20898 " guestfish -N fs:ext4\n"
20903 #: ../fish/guestfish.pod:953
20904 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20908 #: ../fish/guestfish.pod:955
20911 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20916 #: ../fish/guestfish.pod:957
20917 msgid "Create a blank 200MB disk:"
20921 #: ../fish/guestfish.pod:959
20924 " guestfish -N disk:200M\n"
20929 #: ../fish/guestfish.pod:961
20930 msgid "PROGRESS BARS"
20934 #: ../fish/guestfish.pod:963
20936 "Some (not all) long-running commands send progress notification messages as "
20937 "they are running. Guestfish turns these messages into progress bars."
20941 #: ../fish/guestfish.pod:967
20943 "When a command that supports progress bars takes longer than two seconds to "
20944 "run, and if progress bars are enabled, then you will see one appearing below "
20949 #: ../fish/guestfish.pod:971
20952 " ><fs> copy-size /large-file /another-file 2048M\n"
20953 " / 10% [#####-----------------------------------------] 00:30\n"
20958 #: ../fish/guestfish.pod:974
20960 "The spinner on the left hand side moves round once for every progress "
20961 "notification received from the backend. This is a (reasonably) golden "
20962 "assurance that the command is \"doing something\" even if the progress bar "
20963 "is not moving, because the command is able to send the progress "
20964 "notifications. When the bar reaches 100% and the command finishes, the "
20965 "spinner disappears."
20969 #: ../fish/guestfish.pod:981
20971 "Progress bars are enabled by default when guestfish is used interactively. "
20972 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20973 "and you can disable them completely using I<--no-progress-bars>."
20977 #: ../fish/guestfish.pod:986
20978 msgid "GUESTFISH COMMANDS"
20982 #: ../fish/guestfish.pod:988
20984 "The commands in this section are guestfish convenience commands, in other "
20985 "words, they are not part of the L<guestfs(3)> API."
20989 #: ../fish/guestfish.pod:991
20994 #: ../fish/guestfish.pod:993
21003 #: ../fish/guestfish.pod:996
21004 msgid "Without any parameter, this provides general help."
21008 #: ../fish/guestfish.pod:998
21009 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21013 #: ../fish/guestfish.pod:1000
21014 msgid "quit | exit"
21018 #: ../fish/guestfish.pod:1002
21019 msgid "This exits guestfish. You can also use C<^D> key."
21023 #: ../fish/guestfish.pod:1004
21024 msgid "@FISH_COMMANDS@"
21028 #: ../fish/guestfish.pod:1006
21033 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21038 #: ../fish/guestfish.pod:1012
21040 "guestfish returns 0 if the commands completed without error, or 1 if there "
21045 #: ../fish/guestfish.pod:1019
21050 #: ../fish/guestfish.pod:1021
21052 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21057 #: ../fish/guestfish.pod:1024
21058 msgid "GUESTFISH_PID"
21062 #: ../fish/guestfish.pod:1026
21064 "Used with the I<--remote> option to specify the remote guestfish process to "
21065 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21069 #: ../fish/guestfish.pod:1030
21074 #: ../fish/guestfish.pod:1032
21076 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21077 "not specified, the external L<hexedit(1)> program is used."
21081 #: ../fish/guestfish.pod:1036
21086 #: ../fish/guestfish.pod:1038
21088 "If compiled with GNU readline support, various files in the home directory "
21089 "can be used. See L</FILES>."
21093 #: ../fish/guestfish.pod:1047
21095 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21096 "effect as using the B<-v> option."
21100 #: ../fish/guestfish.pod:1059
21102 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21103 "the discussion of paths in L<guestfs(3)>."
21107 #: ../fish/guestfish.pod:1070
21108 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21112 #: ../fish/guestfish.pod:1072
21117 #: ../fish/guestfish.pod:1074
21119 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21124 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:262
21129 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:266
21130 msgid "$HOME/.libguestfs-tools.rc"
21134 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
21135 msgid "/etc/libguestfs-tools.conf"
21139 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
21141 "This configuration file controls the default read-only or read-write mode "
21142 "(I<--ro> or I<--rw>)."
21146 #: ../fish/guestfish.pod:1101
21147 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21151 #: ../fish/guestfish.pod:1103
21152 msgid "$HOME/.guestfish"
21156 #: ../fish/guestfish.pod:1105
21158 "If compiled with GNU readline support, then the command history is saved in "
21163 #: ../fish/guestfish.pod:1108
21164 msgid "$HOME/.inputrc"
21168 #: ../fish/guestfish.pod:1110
21169 msgid "/etc/inputrc"
21173 #: ../fish/guestfish.pod:1112
21175 "If compiled with GNU readline support, then these files can be used to "
21176 "configure readline. For further information, please see "
21177 "L<readline(3)/INITIALIZATION FILE>."
21181 #: ../fish/guestfish.pod:1116
21182 msgid "To write rules which only apply to guestfish, use:"
21186 #: ../fish/guestfish.pod:1118
21196 #: ../fish/guestfish.pod:1122
21198 "Variables that you can set in inputrc that change the behaviour of guestfish "
21199 "in useful ways include:"
21203 #: ../fish/guestfish.pod:1127
21204 msgid "completion-ignore-case (default: on)"
21208 #: ../fish/guestfish.pod:1129
21210 "By default, guestfish will ignore case when tab-completing paths on the "
21215 #: ../fish/guestfish.pod:1132
21218 " set completion-ignore-case off\n"
21223 #: ../fish/guestfish.pod:1134
21224 msgid "to make guestfish case sensitive."
21228 #: ../fish/guestfish.pod:1138
21233 #: ../fish/guestfish.pod:1140
21234 msgid "test2.img (etc)"
21238 #: ../fish/guestfish.pod:1142
21240 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21241 "will be created in the file C<test1.img> in the current directory. The "
21242 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21243 "the same name will be overwritten."
21247 #: ../fish/guestfish.pod:1151
21249 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21250 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21251 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21252 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21253 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21254 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21258 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:297 ../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
21260 "This program is free software; you can redistribute it and/or modify it "
21261 "under the terms of the GNU General Public License as published by the Free "
21262 "Software Foundation; either version 2 of the License, or (at your option) "
21263 "any later version."
21267 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:302 ../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
21269 "This program is distributed in the hope that it will be useful, but WITHOUT "
21270 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21271 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21276 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:307 ../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
21278 "You should have received a copy of the GNU General Public License along with "
21279 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21280 "Ave, Cambridge, MA 02139, USA."
21284 #: ../fish/guestfish-actions.pod:1
21289 #: ../fish/guestfish-actions.pod:3
21292 " add-cdrom filename\n"
21297 #: ../fish/guestfish-actions.pod:15
21299 "This call checks for the existence of C<filename>. This stops you from "
21300 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21301 "and C<http:> URLs. To specify those, use the general L</config> call "
21306 #: ../fish/guestfish-actions.pod:22
21308 "If you just want to add an ISO file (often you use this as an efficient way "
21309 "to transfer large files into the guest), then you should probably use "
21310 "L</add-drive-ro> instead."
21314 #: ../fish/guestfish-actions.pod:35
21319 #: ../fish/guestfish-actions.pod:37
21324 #: ../fish/guestfish-actions.pod:39
21327 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21332 #: ../fish/guestfish-actions.pod:41
21334 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21335 "It works by connecting to libvirt, requesting the domain and domain XML from "
21336 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21340 #: ../fish/guestfish-actions.pod:71
21342 "The other optional parameters are passed directly through to "
21343 "L</add-drive-opts>."
21347 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:3044
21349 "This command has one or more optional arguments. See L</OPTIONAL "
21354 #: ../fish/guestfish-actions.pod:76
21359 #: ../fish/guestfish-actions.pod:78
21362 " add-drive filename\n"
21367 #: ../fish/guestfish-actions.pod:80
21369 "This function is the equivalent of calling L</add-drive-opts> with no "
21370 "optional parameters, so the disk is added writable, with the format being "
21371 "detected automatically."
21375 #: ../fish/guestfish-actions.pod:84
21377 "Automatic detection of the format opens you up to a potential security hole "
21378 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21379 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21380 "you should think about replacing calls to this function with calls to "
21381 "L</add-drive-opts>, and specifying the format."
21385 #: ../fish/guestfish-actions.pod:91
21386 msgid "add-drive-opts"
21390 #: ../fish/guestfish-actions.pod:93
21395 #: ../fish/guestfish-actions.pod:95
21398 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21403 #: ../fish/guestfish-actions.pod:122
21405 "This forces the image format. If you omit this (or use L</add-drive> or "
21406 "L</add-drive-ro>) then the format is automatically detected. Possible "
21407 "formats include C<raw> and C<qcow2>."
21411 #: ../fish/guestfish-actions.pod:133
21413 "This rarely-used option lets you emulate the behaviour of the deprecated "
21414 "L</add-drive-with-if> call (q.v.)"
21418 #: ../fish/guestfish-actions.pod:140
21419 msgid "add-drive-ro"
21423 #: ../fish/guestfish-actions.pod:142
21428 #: ../fish/guestfish-actions.pod:144
21431 " add-drive-ro filename\n"
21436 #: ../fish/guestfish-actions.pod:146
21438 "This function is the equivalent of calling L</add-drive-opts> with the "
21439 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21440 "is added read-only, with the format being detected automatically."
21444 #: ../fish/guestfish-actions.pod:151
21445 msgid "add-drive-ro-with-if"
21449 #: ../fish/guestfish-actions.pod:153
21452 " add-drive-ro-with-if filename iface\n"
21457 #: ../fish/guestfish-actions.pod:155
21459 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21460 "interface emulation to use at run time."
21464 #: ../fish/guestfish-actions.pod:165
21465 msgid "add-drive-with-if"
21469 #: ../fish/guestfish-actions.pod:167
21472 " add-drive-with-if filename iface\n"
21477 #: ../fish/guestfish-actions.pod:169
21479 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21480 "interface emulation to use at run time."
21484 #: ../fish/guestfish-actions.pod:179
21489 #: ../fish/guestfish-actions.pod:181
21492 " aug-clear augpath\n"
21497 #: ../fish/guestfish-actions.pod:186
21502 #: ../fish/guestfish-actions.pod:188
21510 #: ../fish/guestfish-actions.pod:190
21512 "Close the current Augeas handle and free up any resources used by it. After "
21513 "calling this, you have to call L</aug-init> again before you can use any "
21514 "other Augeas functions."
21518 #: ../fish/guestfish-actions.pod:195
21519 msgid "aug-defnode"
21523 #: ../fish/guestfish-actions.pod:197
21526 " aug-defnode name expr val\n"
21531 #: ../fish/guestfish-actions.pod:202
21533 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21534 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21535 "containing that single node."
21539 #: ../fish/guestfish-actions.pod:210
21544 #: ../fish/guestfish-actions.pod:212
21547 " aug-defvar name expr\n"
21552 #: ../fish/guestfish-actions.pod:221
21557 #: ../fish/guestfish-actions.pod:223
21560 " aug-get augpath\n"
21565 #: ../fish/guestfish-actions.pod:228
21570 #: ../fish/guestfish-actions.pod:230
21573 " aug-init root flags\n"
21578 #: ../fish/guestfish-actions.pod:236
21579 msgid "You must call this before using any other L</aug-*> commands."
21583 #: ../fish/guestfish-actions.pod:271
21584 msgid "Do not load the tree in L</aug-init>."
21588 #: ../fish/guestfish-actions.pod:275
21589 msgid "To close the handle, you can call L</aug-close>."
21593 #: ../fish/guestfish-actions.pod:279
21598 #: ../fish/guestfish-actions.pod:281
21601 " aug-insert augpath label true|false\n"
21606 #: ../fish/guestfish-actions.pod:291
21611 #: ../fish/guestfish-actions.pod:293
21619 #: ../fish/guestfish-actions.pod:300
21624 #: ../fish/guestfish-actions.pod:302
21627 " aug-ls augpath\n"
21632 #: ../fish/guestfish-actions.pod:304
21634 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21635 "resulting nodes into alphabetical order."
21639 #: ../fish/guestfish-actions.pod:307
21644 #: ../fish/guestfish-actions.pod:309
21647 " aug-match augpath\n"
21652 #: ../fish/guestfish-actions.pod:315
21657 #: ../fish/guestfish-actions.pod:317
21660 " aug-mv src dest\n"
21665 #: ../fish/guestfish-actions.pod:322
21670 #: ../fish/guestfish-actions.pod:324
21673 " aug-rm augpath\n"
21678 #: ../fish/guestfish-actions.pod:330
21683 #: ../fish/guestfish-actions.pod:332
21691 #: ../fish/guestfish-actions.pod:336
21693 "The flags which were passed to L</aug-init> affect exactly how files are "
21698 #: ../fish/guestfish-actions.pod:339
21703 #: ../fish/guestfish-actions.pod:341
21706 " aug-set augpath val\n"
21711 #: ../fish/guestfish-actions.pod:345
21713 "In the Augeas API, it is possible to clear a node by setting the value to "
21714 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21715 "this call. Instead you must use the L</aug-clear> call."
21719 #: ../fish/guestfish-actions.pod:350
21724 #: ../fish/guestfish-actions.pod:352
21727 " available 'groups ...'\n"
21732 #: ../fish/guestfish-actions.pod:358
21734 "The libguestfs groups, and the functions that those groups correspond to, "
21735 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21736 "runtime by calling L</available-all-groups>."
21740 #: ../fish/guestfish-actions.pod:382
21741 msgid "You must call L</launch> before calling this function."
21745 #: ../fish/guestfish-actions.pod:404
21747 "This call was added in version C<1.0.80>. In previous versions of "
21748 "libguestfs all you could do would be to speculatively execute a command to "
21749 "find out if the daemon implemented it. See also L</version>."
21753 #: ../fish/guestfish-actions.pod:411
21754 msgid "available-all-groups"
21758 #: ../fish/guestfish-actions.pod:413
21761 " available-all-groups\n"
21766 #: ../fish/guestfish-actions.pod:415
21768 "This command returns a list of all optional groups that this daemon knows "
21769 "about. Note this returns both supported and unsupported groups. To find "
21770 "out which ones the daemon can actually support you have to call "
21771 "L</available> on each member of the returned list."
21775 #: ../fish/guestfish-actions.pod:421
21776 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21780 #: ../fish/guestfish-actions.pod:423
21785 #: ../fish/guestfish-actions.pod:425
21788 " base64-in (base64file|-) filename\n"
21793 #: ../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:1225 ../fish/guestfish-actions.pod:4486 ../fish/guestfish-actions.pod:4498 ../fish/guestfish-actions.pod:4509 ../fish/guestfish-actions.pod:4520 ../fish/guestfish-actions.pod:4572 ../fish/guestfish-actions.pod:4581 ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4658
21794 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21798 #: ../fish/guestfish-actions.pod:432
21803 #: ../fish/guestfish-actions.pod:434
21806 " base64-out filename (base64file|-)\n"
21811 #: ../fish/guestfish-actions.pod:441
21812 msgid "blockdev-flushbufs"
21816 #: ../fish/guestfish-actions.pod:443
21819 " blockdev-flushbufs device\n"
21824 #: ../fish/guestfish-actions.pod:450
21825 msgid "blockdev-getbsz"
21829 #: ../fish/guestfish-actions.pod:452
21832 " blockdev-getbsz device\n"
21837 #: ../fish/guestfish-actions.pod:461
21838 msgid "blockdev-getro"
21842 #: ../fish/guestfish-actions.pod:463
21845 " blockdev-getro device\n"
21850 #: ../fish/guestfish-actions.pod:470
21851 msgid "blockdev-getsize64"
21855 #: ../fish/guestfish-actions.pod:472
21858 " blockdev-getsize64 device\n"
21863 #: ../fish/guestfish-actions.pod:476
21864 msgid "See also L</blockdev-getsz>."
21868 #: ../fish/guestfish-actions.pod:480
21869 msgid "blockdev-getss"
21873 #: ../fish/guestfish-actions.pod:482
21876 " blockdev-getss device\n"
21881 #: ../fish/guestfish-actions.pod:487
21882 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21886 #: ../fish/guestfish-actions.pod:492
21887 msgid "blockdev-getsz"
21891 #: ../fish/guestfish-actions.pod:494
21894 " blockdev-getsz device\n"
21899 #: ../fish/guestfish-actions.pod:499
21901 "See also L</blockdev-getss> for the real sector size of the device, and "
21902 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21906 #: ../fish/guestfish-actions.pod:505
21907 msgid "blockdev-rereadpt"
21911 #: ../fish/guestfish-actions.pod:507
21914 " blockdev-rereadpt device\n"
21919 #: ../fish/guestfish-actions.pod:513
21920 msgid "blockdev-setbsz"
21924 #: ../fish/guestfish-actions.pod:515
21927 " blockdev-setbsz device blocksize\n"
21932 #: ../fish/guestfish-actions.pod:524
21933 msgid "blockdev-setro"
21937 #: ../fish/guestfish-actions.pod:526
21940 " blockdev-setro device\n"
21945 #: ../fish/guestfish-actions.pod:532
21946 msgid "blockdev-setrw"
21950 #: ../fish/guestfish-actions.pod:534
21953 " blockdev-setrw device\n"
21958 #: ../fish/guestfish-actions.pod:540
21959 msgid "case-sensitive-path"
21963 #: ../fish/guestfish-actions.pod:542
21966 " case-sensitive-path path\n"
21971 #: ../fish/guestfish-actions.pod:566
21973 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21974 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21975 "how the directories were originally created under Windows)."
21979 #: ../fish/guestfish-actions.pod:574
21980 msgid "See also L</realpath>."
21984 #: ../fish/guestfish-actions.pod:576
21989 #: ../fish/guestfish-actions.pod:578
21997 #: ../fish/guestfish-actions.pod:582
21999 "Note that this function cannot correctly handle binary files (specifically, "
22000 "files containing C<\\0> character which is treated as end of string). For "
22001 "those you need to use the L</read-file> or L</download> functions which have "
22002 "a more complex interface."
22006 #: ../fish/guestfish-actions.pod:590
22011 #: ../fish/guestfish-actions.pod:592
22014 " checksum csumtype path\n"
22019 #: ../fish/guestfish-actions.pod:635
22020 msgid "To get the checksum for a device, use L</checksum-device>."
22024 #: ../fish/guestfish-actions.pod:637
22025 msgid "To get the checksums for many files, use L</checksums-out>."
22029 #: ../fish/guestfish-actions.pod:639
22030 msgid "checksum-device"
22034 #: ../fish/guestfish-actions.pod:641
22037 " checksum-device csumtype device\n"
22042 #: ../fish/guestfish-actions.pod:643
22044 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22045 "device named C<device>. For the types of checksums supported see the "
22046 "L</checksum> command."
22050 #: ../fish/guestfish-actions.pod:647
22051 msgid "checksums-out"
22055 #: ../fish/guestfish-actions.pod:649
22058 " checksums-out csumtype directory (sumsfile|-)\n"
22063 #: ../fish/guestfish-actions.pod:665
22068 #: ../fish/guestfish-actions.pod:667
22071 " chmod mode path\n"
22076 #: ../fish/guestfish-actions.pod:678
22081 #: ../fish/guestfish-actions.pod:680
22084 " chown owner group path\n"
22089 #: ../fish/guestfish-actions.pod:688
22094 #: ../fish/guestfish-actions.pod:690
22097 " command 'arguments ...'\n"
22102 #: ../fish/guestfish-actions.pod:697
22104 "The single parameter is an argv-style list of arguments. The first element "
22105 "is the name of the program to run. Subsequent elements are parameters. The "
22106 "list must be non-empty (ie. must contain a program name). Note that the "
22107 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22111 #: ../fish/guestfish-actions.pod:725
22112 msgid "command-lines"
22116 #: ../fish/guestfish-actions.pod:727
22119 " command-lines 'arguments ...'\n"
22124 #: ../fish/guestfish-actions.pod:729
22125 msgid "This is the same as L</command>, but splits the result into a list of lines."
22129 #: ../fish/guestfish-actions.pod:732
22130 msgid "See also: L</sh-lines>"
22134 #: ../fish/guestfish-actions.pod:737
22139 #: ../fish/guestfish-actions.pod:739
22142 " config qemuparam qemuvalue\n"
22147 #: ../fish/guestfish-actions.pod:750
22152 #: ../fish/guestfish-actions.pod:752
22155 " copy-size src dest size\n"
22160 #: ../fish/guestfish-actions.pod:760
22165 #: ../fish/guestfish-actions.pod:762
22173 #: ../fish/guestfish-actions.pod:767
22178 #: ../fish/guestfish-actions.pod:769
22186 #: ../fish/guestfish-actions.pod:774
22191 #: ../fish/guestfish-actions.pod:776
22199 #: ../fish/guestfish-actions.pod:783
22201 "If the destination is a device, it must be as large or larger than the "
22202 "source file or device, otherwise the copy will fail. This command cannot do "
22203 "partial copies (see L</copy-size>)."
22207 #: ../fish/guestfish-actions.pod:787
22212 #: ../fish/guestfish-actions.pod:789
22220 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22222 "This command is mostly useful for interactive sessions. It is I<not> "
22223 "intended that you try to parse the output string. Use L</statvfs> from "
22228 #: ../fish/guestfish-actions.pod:797
22233 #: ../fish/guestfish-actions.pod:799
22241 #: ../fish/guestfish-actions.pod:808
22246 #: ../fish/guestfish-actions.pod:810
22254 #: ../fish/guestfish-actions.pod:816
22256 "Another way to get the same information is to enable verbose messages with "
22257 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22258 "before running the program."
22262 #: ../fish/guestfish-actions.pod:821
22267 #: ../fish/guestfish-actions.pod:823
22270 " download remotefilename (filename|-)\n"
22275 #: ../fish/guestfish-actions.pod:830
22276 msgid "See also L</upload>, L</cat>."
22280 #: ../fish/guestfish-actions.pod:834
22281 msgid "download-offset"
22285 #: ../fish/guestfish-actions.pod:836
22288 " download-offset remotefilename (filename|-) offset size\n"
22293 #: ../fish/guestfish-actions.pod:844
22295 "Note that there is no limit on the amount of data that can be downloaded "
22296 "with this call, unlike with L</pread>, and this call always reads the full "
22297 "amount unless an error occurs."
22301 #: ../fish/guestfish-actions.pod:849
22302 msgid "See also L</download>, L</pread>."
22306 #: ../fish/guestfish-actions.pod:853
22307 msgid "drop-caches"
22311 #: ../fish/guestfish-actions.pod:855
22314 " drop-caches whattodrop\n"
22319 #: ../fish/guestfish-actions.pod:867
22324 #: ../fish/guestfish-actions.pod:869
22332 #: ../fish/guestfish-actions.pod:881
22337 #: ../fish/guestfish-actions.pod:883
22340 " e2fsck-f device\n"
22345 #: ../fish/guestfish-actions.pod:889
22347 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22348 "should use L</fsck>."
22352 #: ../fish/guestfish-actions.pod:892
22353 msgid "echo-daemon"
22357 #: ../fish/guestfish-actions.pod:894
22360 " echo-daemon 'words ...'\n"
22365 #: ../fish/guestfish-actions.pod:901
22366 msgid "See also L</ping-daemon>."
22370 #: ../fish/guestfish-actions.pod:903
22375 #: ../fish/guestfish-actions.pod:905
22378 " egrep regex path\n"
22383 #: ../fish/guestfish-actions.pod:913
22388 #: ../fish/guestfish-actions.pod:915
22391 " egrepi regex path\n"
22396 #: ../fish/guestfish-actions.pod:923
22401 #: ../fish/guestfish-actions.pod:925
22404 " equal file1 file2\n"
22409 #: ../fish/guestfish-actions.pod:932
22414 #: ../fish/guestfish-actions.pod:934
22422 #: ../fish/guestfish-actions.pod:939
22423 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22427 #: ../fish/guestfish-actions.pod:941
22432 #: ../fish/guestfish-actions.pod:943
22435 " fallocate path len\n"
22440 #: ../fish/guestfish-actions.pod:960
22441 msgid "fallocate64"
22445 #: ../fish/guestfish-actions.pod:962
22448 " fallocate64 path len\n"
22453 #: ../fish/guestfish-actions.pod:968
22455 "Note that this call allocates disk blocks for the file. To create a sparse "
22456 "file use L</truncate-size> instead."
22460 #: ../fish/guestfish-actions.pod:971
22462 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22463 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22464 "maximum size of files created through that call to 1GB."
22468 #: ../fish/guestfish-actions.pod:980
22473 #: ../fish/guestfish-actions.pod:982
22476 " fgrep pattern path\n"
22481 #: ../fish/guestfish-actions.pod:990
22486 #: ../fish/guestfish-actions.pod:992
22489 " fgrepi pattern path\n"
22494 #: ../fish/guestfish-actions.pod:1000
22499 #: ../fish/guestfish-actions.pod:1002
22507 #: ../fish/guestfish-actions.pod:1018
22509 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
22514 #: ../fish/guestfish-actions.pod:1021
22515 msgid "file-architecture"
22519 #: ../fish/guestfish-actions.pod:1023
22522 " file-architecture filename\n"
22527 #: ../fish/guestfish-actions.pod:1126
22532 #: ../fish/guestfish-actions.pod:1128
22540 #: ../fish/guestfish-actions.pod:1132
22542 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22543 "L</is-file> etc. To get the size of block devices, use "
22544 "L</blockdev-getsize64>."
22548 #: ../fish/guestfish-actions.pod:1136
22553 #: ../fish/guestfish-actions.pod:1138
22556 " fill c len path\n"
22561 #: ../fish/guestfish-actions.pod:1144
22563 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22564 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22565 "L</fill-pattern>."
22569 #: ../fish/guestfish-actions.pod:1149
22570 msgid "fill-pattern"
22574 #: ../fish/guestfish-actions.pod:1151
22577 " fill-pattern pattern len path\n"
22582 #: ../fish/guestfish-actions.pod:1153
22584 "This function is like L</fill> except that it creates a new file of length "
22585 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22586 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22591 #: ../fish/guestfish-actions.pod:1158
22596 #: ../fish/guestfish-actions.pod:1160
22599 " find directory\n"
22604 #: ../fish/guestfish-actions.pod:1174
22605 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22609 #: ../fish/guestfish-actions.pod:1187
22610 msgid "See also L</find0>."
22614 #: ../fish/guestfish-actions.pod:1192
22619 #: ../fish/guestfish-actions.pod:1194
22622 " find0 directory (files|-)\n"
22627 #: ../fish/guestfish-actions.pod:1200
22628 msgid "This command works the same way as L</find> with the following exceptions:"
22632 #: ../fish/guestfish-actions.pod:1227
22633 msgid "findfs-label"
22637 #: ../fish/guestfish-actions.pod:1229
22640 " findfs-label label\n"
22645 #: ../fish/guestfish-actions.pod:1235
22646 msgid "To find the label of a filesystem, use L</vfs-label>."
22650 #: ../fish/guestfish-actions.pod:1237
22651 msgid "findfs-uuid"
22655 #: ../fish/guestfish-actions.pod:1239
22658 " findfs-uuid uuid\n"
22663 #: ../fish/guestfish-actions.pod:1245
22664 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22668 #: ../fish/guestfish-actions.pod:1247
22673 #: ../fish/guestfish-actions.pod:1249
22676 " fsck fstype device\n"
22681 #: ../fish/guestfish-actions.pod:1279
22686 #: ../fish/guestfish-actions.pod:1281
22694 #: ../fish/guestfish-actions.pod:1288
22695 msgid "get-attach-method"
22699 #: ../fish/guestfish-actions.pod:1290
22702 " get-attach-method\n"
22707 #: ../fish/guestfish-actions.pod:1292
22708 msgid "Return the current attach method. See L</set-attach-method>."
22712 #: ../fish/guestfish-actions.pod:1294
22713 msgid "get-autosync"
22717 #: ../fish/guestfish-actions.pod:1296
22725 #: ../fish/guestfish-actions.pod:1300
22730 #: ../fish/guestfish-actions.pod:1302
22738 #: ../fish/guestfish-actions.pod:1306
22739 msgid "get-e2label"
22743 #: ../fish/guestfish-actions.pod:1308
22746 " get-e2label device\n"
22751 #: ../fish/guestfish-actions.pod:1320
22756 #: ../fish/guestfish-actions.pod:1322
22759 " get-e2uuid device\n"
22764 #: ../fish/guestfish-actions.pod:1334
22765 msgid "get-memsize"
22769 #: ../fish/guestfish-actions.pod:1336
22777 #: ../fish/guestfish-actions.pod:1341
22779 "If L</set-memsize> was not called on this handle, and if "
22780 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22781 "value for memsize."
22785 #: ../fish/guestfish-actions.pod:1348
22786 msgid "get-network"
22790 #: ../fish/guestfish-actions.pod:1350
22798 #: ../fish/guestfish-actions.pod:1354
22803 #: ../fish/guestfish-actions.pod:1356
22811 #: ../fish/guestfish-actions.pod:1363
22816 #: ../fish/guestfish-actions.pod:1365
22821 #: ../fish/guestfish-actions.pod:1367
22829 #: ../fish/guestfish-actions.pod:1374
22834 #: ../fish/guestfish-actions.pod:1376
22842 #: ../fish/guestfish-actions.pod:1383
22843 msgid "get-recovery-proc"
22847 #: ../fish/guestfish-actions.pod:1385
22850 " get-recovery-proc\n"
22855 #: ../fish/guestfish-actions.pod:1389
22856 msgid "get-selinux"
22860 #: ../fish/guestfish-actions.pod:1391
22868 #: ../fish/guestfish-actions.pod:1393
22870 "This returns the current setting of the selinux flag which is passed to the "
22871 "appliance at boot time. See L</set-selinux>."
22875 #: ../fish/guestfish-actions.pod:1399
22880 #: ../fish/guestfish-actions.pod:1401
22888 #: ../fish/guestfish-actions.pod:1408
22893 #: ../fish/guestfish-actions.pod:1410
22901 #: ../fish/guestfish-actions.pod:1414
22906 #: ../fish/guestfish-actions.pod:1416
22914 #: ../fish/guestfish-actions.pod:1418
22916 "Return the current umask. By default the umask is C<022> unless it has been "
22917 "set by calling L</umask>."
22921 #: ../fish/guestfish-actions.pod:1421
22922 msgid "get-verbose"
22926 #: ../fish/guestfish-actions.pod:1423
22934 #: ../fish/guestfish-actions.pod:1427
22939 #: ../fish/guestfish-actions.pod:1429
22947 #: ../fish/guestfish-actions.pod:1433
22948 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22952 #: ../fish/guestfish-actions.pod:1436
22957 #: ../fish/guestfish-actions.pod:1438
22960 " getxattr path name\n"
22965 #: ../fish/guestfish-actions.pod:1440
22967 "Get a single extended attribute from file C<path> named C<name>. This call "
22968 "follows symlinks. If you want to lookup an extended attribute for the "
22969 "symlink itself, use L</lgetxattr>."
22973 #: ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:2450
22975 "Normally it is better to get all extended attributes from a file in one go "
22976 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22977 "buggy and do not provide a way to list out attributes. For these "
22978 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22979 "attributes you want in advance and call this function."
22983 #: ../fish/guestfish-actions.pod:1454
22984 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22988 #: ../fish/guestfish-actions.pod:1456
22993 #: ../fish/guestfish-actions.pod:1458
22996 " getxattrs path\n"
23001 #: ../fish/guestfish-actions.pod:1466
23002 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23006 #: ../fish/guestfish-actions.pod:1468
23007 msgid "glob-expand"
23011 #: ../fish/guestfish-actions.pod:1470
23014 " glob-expand pattern\n"
23019 #: ../fish/guestfish-actions.pod:1483
23024 #: ../fish/guestfish-actions.pod:1485
23027 " grep regex path\n"
23032 #: ../fish/guestfish-actions.pod:1493
23037 #: ../fish/guestfish-actions.pod:1495
23040 " grepi regex path\n"
23045 #: ../fish/guestfish-actions.pod:1503
23046 msgid "grub-install"
23050 #: ../fish/guestfish-actions.pod:1505
23053 " grub-install root device\n"
23058 #: ../fish/guestfish-actions.pod:1521
23063 #: ../fish/guestfish-actions.pod:1523
23071 #: ../fish/guestfish-actions.pod:1531
23076 #: ../fish/guestfish-actions.pod:1533
23079 " head-n nrlines path\n"
23084 #: ../fish/guestfish-actions.pod:1546
23089 #: ../fish/guestfish-actions.pod:1548
23097 #: ../fish/guestfish-actions.pod:1556
23102 #: ../fish/guestfish-actions.pod:1558
23105 " initrd-cat initrdpath filename\n"
23110 #: ../fish/guestfish-actions.pod:1570
23111 msgid "See also L</initrd-list>."
23115 #: ../fish/guestfish-actions.pod:1575
23116 msgid "initrd-list"
23120 #: ../fish/guestfish-actions.pod:1577
23123 " initrd-list path\n"
23128 #: ../fish/guestfish-actions.pod:1589
23129 msgid "inotify-add-watch"
23133 #: ../fish/guestfish-actions.pod:1591
23136 " inotify-add-watch path mask\n"
23141 #: ../fish/guestfish-actions.pod:1603
23142 msgid "inotify-close"
23146 #: ../fish/guestfish-actions.pod:1605
23154 #: ../fish/guestfish-actions.pod:1611
23155 msgid "inotify-files"
23159 #: ../fish/guestfish-actions.pod:1613
23167 #: ../fish/guestfish-actions.pod:1615
23169 "This function is a helpful wrapper around L</inotify-read> which just "
23170 "returns a list of pathnames of objects that were touched. The returned "
23171 "pathnames are sorted and deduplicated."
23175 #: ../fish/guestfish-actions.pod:1619
23176 msgid "inotify-init"
23180 #: ../fish/guestfish-actions.pod:1621
23183 " inotify-init maxevents\n"
23188 #: ../fish/guestfish-actions.pod:1627
23190 "C<maxevents> is the maximum number of events which will be queued up between "
23191 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23192 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23193 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23194 "but records the fact that it threw them away by setting a flag "
23195 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23199 #: ../fish/guestfish-actions.pod:1637
23201 "Before any events are generated, you have to add some watches to the "
23202 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23203 "L</inotify-watch-all>."
23207 #: ../fish/guestfish-actions.pod:1643
23209 "Queued up events should be read periodically by calling L</inotify-read> (or "
23210 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23211 "If you don't read the events out often enough then you risk the internal "
23212 "queue overflowing."
23216 #: ../fish/guestfish-actions.pod:1650
23218 "The handle should be closed after use by calling L</inotify-close>. This "
23219 "also removes any watches automatically."
23223 #: ../fish/guestfish-actions.pod:1659
23224 msgid "inotify-read"
23228 #: ../fish/guestfish-actions.pod:1661
23236 #: ../fish/guestfish-actions.pod:1674
23237 msgid "inotify-rm-watch"
23241 #: ../fish/guestfish-actions.pod:1676
23244 " inotify-rm-watch wd\n"
23249 #: ../fish/guestfish-actions.pod:1678
23250 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23254 #: ../fish/guestfish-actions.pod:1681
23255 msgid "inspect-get-arch"
23259 #: ../fish/guestfish-actions.pod:1683
23262 " inspect-get-arch root\n"
23267 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1701 ../fish/guestfish-actions.pod:1787 ../fish/guestfish-actions.pod:1823 ../fish/guestfish-actions.pod:1841 ../fish/guestfish-actions.pod:1875 ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:2005 ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2065 ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2116 ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2145 ../fish/guestfish-actions.pod:2158 ../fish/guestfish-actions.pod:2173
23269 "This function should only be called with a root device string as returned by "
23274 #: ../fish/guestfish-actions.pod:1688
23276 "This returns the architecture of the inspected operating system. The "
23277 "possible return values are listed under L</file-architecture>."
23281 #: ../fish/guestfish-actions.pod:1697
23282 msgid "inspect-get-distro"
23286 #: ../fish/guestfish-actions.pod:1699
23289 " inspect-get-distro root\n"
23294 #: ../fish/guestfish-actions.pod:1783
23295 msgid "inspect-get-drive-mappings"
23299 #: ../fish/guestfish-actions.pod:1785
23302 " inspect-get-drive-mappings root\n"
23307 #: ../fish/guestfish-actions.pod:1815
23309 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23310 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23314 #: ../fish/guestfish-actions.pod:1819
23315 msgid "inspect-get-filesystems"
23319 #: ../fish/guestfish-actions.pod:1821
23322 " inspect-get-filesystems root\n"
23327 #: ../fish/guestfish-actions.pod:1834
23329 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23330 "L</inspect-get-mountpoints>."
23334 #: ../fish/guestfish-actions.pod:1837
23335 msgid "inspect-get-format"
23339 #: ../fish/guestfish-actions.pod:1839
23342 " inspect-get-format root\n"
23347 #: ../fish/guestfish-actions.pod:1871
23348 msgid "inspect-get-hostname"
23352 #: ../fish/guestfish-actions.pod:1873
23355 " inspect-get-hostname root\n"
23360 #: ../fish/guestfish-actions.pod:1886
23361 msgid "inspect-get-major-version"
23365 #: ../fish/guestfish-actions.pod:1888
23368 " inspect-get-major-version root\n"
23373 #: ../fish/guestfish-actions.pod:1907
23374 msgid "inspect-get-minor-version"
23378 #: ../fish/guestfish-actions.pod:1909
23381 " inspect-get-minor-version root\n"
23386 #: ../fish/guestfish-actions.pod:1919
23388 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23389 "L</inspect-get-major-version>."
23393 #: ../fish/guestfish-actions.pod:1922
23394 msgid "inspect-get-mountpoints"
23398 #: ../fish/guestfish-actions.pod:1924
23401 " inspect-get-mountpoints root\n"
23406 #: ../fish/guestfish-actions.pod:1946
23408 "For operating systems like Windows which still use drive letters, this call "
23409 "will only return an entry for the first drive \"mounted on\" C</>. For "
23410 "information about the mapping of drive letters to partitions, see "
23411 "L</inspect-get-drive-mappings>."
23415 #: ../fish/guestfish-actions.pod:1952
23417 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23418 "L</inspect-get-filesystems>."
23422 #: ../fish/guestfish-actions.pod:1955
23423 msgid "inspect-get-package-format"
23427 #: ../fish/guestfish-actions.pod:1957
23430 " inspect-get-package-format root\n"
23435 #: ../fish/guestfish-actions.pod:1962
23437 "This function and L</inspect-get-package-management> return the package "
23438 "format and package management tool used by the inspected operating system. "
23439 "For example for Fedora these functions would return C<rpm> (package format) "
23440 "and C<yum> (package management)."
23444 #: ../fish/guestfish-actions.pod:1977
23445 msgid "inspect-get-package-management"
23449 #: ../fish/guestfish-actions.pod:1979
23452 " inspect-get-package-management root\n"
23457 #: ../fish/guestfish-actions.pod:1984
23459 "L</inspect-get-package-format> and this function return the package format "
23460 "and package management tool used by the inspected operating system. For "
23461 "example for Fedora these functions would return C<rpm> (package format) and "
23462 "C<yum> (package management)."
23466 #: ../fish/guestfish-actions.pod:2001
23467 msgid "inspect-get-product-name"
23471 #: ../fish/guestfish-actions.pod:2003
23474 " inspect-get-product-name root\n"
23479 #: ../fish/guestfish-actions.pod:2018
23480 msgid "inspect-get-product-variant"
23484 #: ../fish/guestfish-actions.pod:2020
23487 " inspect-get-product-variant root\n"
23492 #: ../fish/guestfish-actions.pod:2044
23494 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23495 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23499 #: ../fish/guestfish-actions.pod:2048
23500 msgid "inspect-get-roots"
23504 #: ../fish/guestfish-actions.pod:2050
23507 " inspect-get-roots\n"
23512 #: ../fish/guestfish-actions.pod:2052
23514 "This function is a convenient way to get the list of root devices, as "
23515 "returned from a previous call to L</inspect-os>, but without redoing the "
23516 "whole inspection process."
23520 #: ../fish/guestfish-actions.pod:2056
23522 "This returns an empty list if either no root devices were found or the "
23523 "caller has not called L</inspect-os>."
23527 #: ../fish/guestfish-actions.pod:2061
23528 msgid "inspect-get-type"
23532 #: ../fish/guestfish-actions.pod:2063
23535 " inspect-get-type root\n"
23540 #: ../fish/guestfish-actions.pod:2096
23541 msgid "inspect-get-windows-current-control-set"
23545 #: ../fish/guestfish-actions.pod:2098
23548 " inspect-get-windows-current-control-set root\n"
23553 #: ../fish/guestfish-actions.pod:2112
23554 msgid "inspect-get-windows-systemroot"
23558 #: ../fish/guestfish-actions.pod:2114
23561 " inspect-get-windows-systemroot root\n"
23566 #: ../fish/guestfish-actions.pod:2128
23567 msgid "inspect-is-live"
23571 #: ../fish/guestfish-actions.pod:2130
23574 " inspect-is-live root\n"
23579 #: ../fish/guestfish-actions.pod:2135
23581 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23582 "then this returns true if a live image was detected on the disk."
23586 #: ../fish/guestfish-actions.pod:2141
23587 msgid "inspect-is-multipart"
23591 #: ../fish/guestfish-actions.pod:2143
23594 " inspect-is-multipart root\n"
23599 #: ../fish/guestfish-actions.pod:2148
23601 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23602 "then this returns true if the disk is part of a set."
23606 #: ../fish/guestfish-actions.pod:2154
23607 msgid "inspect-is-netinst"
23611 #: ../fish/guestfish-actions.pod:2156
23614 " inspect-is-netinst root\n"
23619 #: ../fish/guestfish-actions.pod:2161
23621 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23622 "then this returns true if the disk is a network installer, ie. not a "
23623 "self-contained install CD but one which is likely to require network access "
23624 "to complete the install."
23628 #: ../fish/guestfish-actions.pod:2169
23629 msgid "inspect-list-applications"
23633 #: ../fish/guestfish-actions.pod:2171
23636 " inspect-list-applications root\n"
23641 #: ../fish/guestfish-actions.pod:2178
23643 "I<Note:> This call works differently from other parts of the inspection "
23644 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23645 "then mount up the disks, before calling this. Listing applications is a "
23646 "significantly more difficult operation which requires access to the full "
23647 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23648 "are just returning data cached in the libguestfs handle, this call actually "
23649 "reads parts of the mounted filesystems during the call."
23653 #: ../fish/guestfish-actions.pod:2268
23658 #: ../fish/guestfish-actions.pod:2270
23666 #: ../fish/guestfish-actions.pod:2285
23668 "You can pass the root string(s) returned to other L</inspect-get-*> "
23669 "functions in order to query further information about each operating system, "
23670 "such as the name and version."
23674 #: ../fish/guestfish-actions.pod:2290
23676 "This function uses other libguestfs features such as L</mount-ro> and "
23677 "L</umount-all> in order to mount and unmount filesystems and look at the "
23678 "contents. This should be called with no disks currently mounted. The "
23679 "function may also use Augeas, so any existing Augeas handle will be closed."
23683 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2478 ../fish/guestfish-actions.pod:2524
23684 msgid "See also L</list-filesystems>."
23688 #: ../fish/guestfish-actions.pod:2304
23689 msgid "is-blockdev"
23693 #: ../fish/guestfish-actions.pod:2306
23696 " is-blockdev path\n"
23701 #: ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2329 ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2357 ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2401 ../fish/guestfish-actions.pod:2410
23702 msgid "See also L</stat>."
23706 #: ../fish/guestfish-actions.pod:2313
23711 #: ../fish/guestfish-actions.pod:2315
23719 #: ../fish/guestfish-actions.pod:2322
23724 #: ../fish/guestfish-actions.pod:2324
23727 " is-chardev path\n"
23732 #: ../fish/guestfish-actions.pod:2331
23737 #: ../fish/guestfish-actions.pod:2333
23745 #: ../fish/guestfish-actions.pod:2340
23750 #: ../fish/guestfish-actions.pod:2342
23758 #: ../fish/guestfish-actions.pod:2350
23763 #: ../fish/guestfish-actions.pod:2352
23771 #: ../fish/guestfish-actions.pod:2359
23776 #: ../fish/guestfish-actions.pod:2361
23784 #: ../fish/guestfish-actions.pod:2369
23785 msgid "is-launching"
23789 #: ../fish/guestfish-actions.pod:2371
23797 #: ../fish/guestfish-actions.pod:2378
23802 #: ../fish/guestfish-actions.pod:2380
23810 #: ../fish/guestfish-actions.pod:2385
23815 #: ../fish/guestfish-actions.pod:2387
23823 #: ../fish/guestfish-actions.pod:2394
23828 #: ../fish/guestfish-actions.pod:2396
23831 " is-socket path\n"
23836 #: ../fish/guestfish-actions.pod:2403
23841 #: ../fish/guestfish-actions.pod:2405
23844 " is-symlink path\n"
23849 #: ../fish/guestfish-actions.pod:2412
23850 msgid "kill-subprocess"
23854 #: ../fish/guestfish-actions.pod:2414
23857 " kill-subprocess\n"
23862 #: ../fish/guestfish-actions.pod:2418
23867 #: ../fish/guestfish-actions.pod:2420
23872 #: ../fish/guestfish-actions.pod:2422
23880 #: ../fish/guestfish-actions.pod:2430
23885 #: ../fish/guestfish-actions.pod:2432
23888 " lchown owner group path\n"
23893 #: ../fish/guestfish-actions.pod:2434
23895 "Change the file owner to C<owner> and group to C<group>. This is like "
23896 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23901 #: ../fish/guestfish-actions.pod:2442
23906 #: ../fish/guestfish-actions.pod:2444
23909 " lgetxattr path name\n"
23914 #: ../fish/guestfish-actions.pod:2460
23915 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23919 #: ../fish/guestfish-actions.pod:2462
23924 #: ../fish/guestfish-actions.pod:2464
23927 " lgetxattrs path\n"
23932 #: ../fish/guestfish-actions.pod:2466
23934 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23935 "it returns the extended attributes of the link itself."
23939 #: ../fish/guestfish-actions.pod:2470
23940 msgid "list-devices"
23944 #: ../fish/guestfish-actions.pod:2472
23952 #: ../fish/guestfish-actions.pod:2480
23953 msgid "list-filesystems"
23957 #: ../fish/guestfish-actions.pod:2482
23960 " list-filesystems\n"
23965 #: ../fish/guestfish-actions.pod:2501
23967 "This command runs other libguestfs commands, which might include L</mount> "
23968 "and L</umount>, and therefore you should use this soon after launch and only "
23969 "when nothing is mounted."
23973 #: ../fish/guestfish-actions.pod:2505
23975 "Not all of the filesystems returned will be mountable. In particular, swap "
23976 "partitions are returned in the list. Also this command does not check that "
23977 "each filesystem found is valid and mountable, and some filesystems might be "
23978 "mountable but require special options. Filesystems may not all belong to a "
23979 "single logical operating system (use L</inspect-os> to look for OSes)."
23983 #: ../fish/guestfish-actions.pod:2513
23984 msgid "list-partitions"
23988 #: ../fish/guestfish-actions.pod:2515
23991 " list-partitions\n"
23996 #: ../fish/guestfish-actions.pod:2521
23998 "This does not return logical volumes. For that you will need to call "
24003 #: ../fish/guestfish-actions.pod:2526
24008 #: ../fish/guestfish-actions.pod:2528
24016 #: ../fish/guestfish-actions.pod:2536
24021 #: ../fish/guestfish-actions.pod:2538
24024 " ln target linkname\n"
24029 #: ../fish/guestfish-actions.pod:2542
24034 #: ../fish/guestfish-actions.pod:2544
24037 " ln-f target linkname\n"
24042 #: ../fish/guestfish-actions.pod:2549
24047 #: ../fish/guestfish-actions.pod:2551
24050 " ln-s target linkname\n"
24055 #: ../fish/guestfish-actions.pod:2555
24060 #: ../fish/guestfish-actions.pod:2557
24063 " ln-sf target linkname\n"
24068 #: ../fish/guestfish-actions.pod:2562
24069 msgid "lremovexattr"
24073 #: ../fish/guestfish-actions.pod:2564
24076 " lremovexattr xattr path\n"
24081 #: ../fish/guestfish-actions.pod:2566
24083 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24084 "it removes an extended attribute of the link itself."
24088 #: ../fish/guestfish-actions.pod:2570
24093 #: ../fish/guestfish-actions.pod:2572
24101 #: ../fish/guestfish-actions.pod:2578
24103 "This command is mostly useful for interactive sessions. Programs should "
24104 "probably use L</readdir> instead."
24108 #: ../fish/guestfish-actions.pod:2581
24113 #: ../fish/guestfish-actions.pod:2583
24116 " lsetxattr xattr val vallen path\n"
24121 #: ../fish/guestfish-actions.pod:2585
24123 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24124 "sets an extended attribute of the link itself."
24128 #: ../fish/guestfish-actions.pod:2589
24133 #: ../fish/guestfish-actions.pod:2591
24141 #: ../fish/guestfish-actions.pod:2595
24143 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24144 "the link is stat-ed, not the file it refers to."
24148 #: ../fish/guestfish-actions.pod:2601
24153 #: ../fish/guestfish-actions.pod:2603
24156 " lstatlist path 'names ...'\n"
24161 #: ../fish/guestfish-actions.pod:2605
24163 "This call allows you to perform the L</lstat> operation on multiple files, "
24164 "where all files are in the directory C<path>. C<names> is the list of files "
24165 "from this directory."
24169 #: ../fish/guestfish-actions.pod:2614
24171 "This call is intended for programs that want to efficiently list a directory "
24172 "contents without making many round-trips. See also L</lxattrlist> for a "
24173 "similarly efficient call for getting extended attributes. Very long "
24174 "directory listings might cause the protocol message size to be exceeded, "
24175 "causing this call to fail. The caller must split up such requests into "
24176 "smaller groups of names."
24180 #: ../fish/guestfish-actions.pod:2622
24181 msgid "luks-add-key"
24185 #: ../fish/guestfish-actions.pod:2624
24188 " luks-add-key device keyslot\n"
24193 #: ../fish/guestfish-actions.pod:2631
24195 "Note that if C<keyslot> already contains a key, then this command will "
24196 "fail. You have to use L</luks-kill-slot> first to remove that key."
24200 #: ../fish/guestfish-actions.pod:2635 ../fish/guestfish-actions.pod:2657 ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:2684 ../fish/guestfish-actions.pod:2707 ../fish/guestfish-actions.pod:2717
24202 "This command has one or more key or passphrase parameters. Guestfish will "
24203 "prompt for these separately."
24207 #: ../fish/guestfish-actions.pod:2638
24212 #: ../fish/guestfish-actions.pod:2640
24215 " luks-close device\n"
24220 #: ../fish/guestfish-actions.pod:2642
24222 "This closes a LUKS device that was created earlier by L</luks-open> or "
24223 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24224 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24225 "underlying block device."
24229 #: ../fish/guestfish-actions.pod:2648
24230 msgid "luks-format"
24234 #: ../fish/guestfish-actions.pod:2650
24237 " luks-format device keyslot\n"
24242 #: ../fish/guestfish-actions.pod:2663
24243 msgid "luks-format-cipher"
24247 #: ../fish/guestfish-actions.pod:2665
24250 " luks-format-cipher device keyslot cipher\n"
24255 #: ../fish/guestfish-actions.pod:2667
24257 "This command is the same as L</luks-format> but it also allows you to set "
24258 "the C<cipher> used."
24262 #: ../fish/guestfish-actions.pod:2676
24263 msgid "luks-kill-slot"
24267 #: ../fish/guestfish-actions.pod:2678
24270 " luks-kill-slot device keyslot\n"
24275 #: ../fish/guestfish-actions.pod:2687
24280 #: ../fish/guestfish-actions.pod:2689
24283 " luks-open device mapname\n"
24288 #: ../fish/guestfish-actions.pod:2703
24290 "If this block device contains LVM volume groups, then calling L</vgscan> "
24291 "followed by L</vg-activate-all> will make them visible."
24295 #: ../fish/guestfish-actions.pod:2710
24296 msgid "luks-open-ro"
24300 #: ../fish/guestfish-actions.pod:2712
24303 " luks-open-ro device mapname\n"
24308 #: ../fish/guestfish-actions.pod:2714
24310 "This is the same as L</luks-open> except that a read-only mapping is "
24315 #: ../fish/guestfish-actions.pod:2720
24320 #: ../fish/guestfish-actions.pod:2722
24323 " lvcreate logvol volgroup mbytes\n"
24328 #: ../fish/guestfish-actions.pod:2727
24329 msgid "lvm-canonical-lv-name"
24333 #: ../fish/guestfish-actions.pod:2729
24336 " lvm-canonical-lv-name lvname\n"
24341 #: ../fish/guestfish-actions.pod:2738
24342 msgid "See also L</is-lv>."
24346 #: ../fish/guestfish-actions.pod:2740
24347 msgid "lvm-clear-filter"
24351 #: ../fish/guestfish-actions.pod:2742
24354 " lvm-clear-filter\n"
24359 #: ../fish/guestfish-actions.pod:2744
24361 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24366 #: ../fish/guestfish-actions.pod:2750
24367 msgid "lvm-remove-all"
24371 #: ../fish/guestfish-actions.pod:2752
24374 " lvm-remove-all\n"
24379 #: ../fish/guestfish-actions.pod:2760
24380 msgid "lvm-set-filter"
24384 #: ../fish/guestfish-actions.pod:2762
24387 " lvm-set-filter 'devices ...'\n"
24392 #: ../fish/guestfish-actions.pod:2787
24397 #: ../fish/guestfish-actions.pod:2789
24400 " lvremove device\n"
24405 #: ../fish/guestfish-actions.pod:2797
24410 #: ../fish/guestfish-actions.pod:2799
24413 " lvrename logvol newlogvol\n"
24418 #: ../fish/guestfish-actions.pod:2803
24423 #: ../fish/guestfish-actions.pod:2805
24426 " lvresize device mbytes\n"
24431 #: ../fish/guestfish-actions.pod:2811
24432 msgid "lvresize-free"
24436 #: ../fish/guestfish-actions.pod:2813
24439 " lvresize-free lv percent\n"
24444 #: ../fish/guestfish-actions.pod:2821
24449 #: ../fish/guestfish-actions.pod:2823
24457 #: ../fish/guestfish-actions.pod:2831
24458 msgid "See also L</lvs-full>, L</list-filesystems>."
24462 #: ../fish/guestfish-actions.pod:2833
24467 #: ../fish/guestfish-actions.pod:2835
24475 #: ../fish/guestfish-actions.pod:2840
24480 #: ../fish/guestfish-actions.pod:2842
24488 #: ../fish/guestfish-actions.pod:2846
24493 #: ../fish/guestfish-actions.pod:2848
24496 " lxattrlist path 'names ...'\n"
24501 #: ../fish/guestfish-actions.pod:2864
24503 "This call is intended for programs that want to efficiently list a directory "
24504 "contents without making many round-trips. See also L</lstatlist> for a "
24505 "similarly efficient call for getting standard stats. Very long directory "
24506 "listings might cause the protocol message size to be exceeded, causing this "
24507 "call to fail. The caller must split up such requests into smaller groups of "
24512 #: ../fish/guestfish-actions.pod:2872
24517 #: ../fish/guestfish-actions.pod:2874
24525 #: ../fish/guestfish-actions.pod:2878
24530 #: ../fish/guestfish-actions.pod:2880
24533 " mkdir-mode path mode\n"
24538 #: ../fish/guestfish-actions.pod:2889
24539 msgid "See also L</mkdir>, L</umask>"
24543 #: ../fish/guestfish-actions.pod:2891
24548 #: ../fish/guestfish-actions.pod:2893
24556 #: ../fish/guestfish-actions.pod:2898
24561 #: ../fish/guestfish-actions.pod:2900
24564 " mkdtemp template\n"
24569 #: ../fish/guestfish-actions.pod:2921
24574 #: ../fish/guestfish-actions.pod:2923
24577 " mke2fs-J fstype blocksize device journal\n"
24582 #: ../fish/guestfish-actions.pod:2931
24583 msgid "See also L</mke2journal>."
24587 #: ../fish/guestfish-actions.pod:2933
24592 #: ../fish/guestfish-actions.pod:2935
24595 " mke2fs-JL fstype blocksize device label\n"
24600 #: ../fish/guestfish-actions.pod:2940
24601 msgid "See also L</mke2journal-L>."
24605 #: ../fish/guestfish-actions.pod:2942
24610 #: ../fish/guestfish-actions.pod:2944
24613 " mke2fs-JU fstype blocksize device uuid\n"
24618 #: ../fish/guestfish-actions.pod:2949
24619 msgid "See also L</mke2journal-U>."
24623 #: ../fish/guestfish-actions.pod:2951
24624 msgid "mke2journal"
24628 #: ../fish/guestfish-actions.pod:2953
24631 " mke2journal blocksize device\n"
24636 #: ../fish/guestfish-actions.pod:2960
24637 msgid "mke2journal-L"
24641 #: ../fish/guestfish-actions.pod:2962
24644 " mke2journal-L blocksize label device\n"
24649 #: ../fish/guestfish-actions.pod:2966
24650 msgid "mke2journal-U"
24654 #: ../fish/guestfish-actions.pod:2968
24657 " mke2journal-U blocksize uuid device\n"
24662 #: ../fish/guestfish-actions.pod:2972
24667 #: ../fish/guestfish-actions.pod:2974
24670 " mkfifo mode path\n"
24675 #: ../fish/guestfish-actions.pod:2976
24677 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24678 "is just a convenient wrapper around L</mknod>."
24682 #: ../fish/guestfish-actions.pod:2982
24687 #: ../fish/guestfish-actions.pod:2984
24690 " mkfs fstype device\n"
24695 #: ../fish/guestfish-actions.pod:2990
24700 #: ../fish/guestfish-actions.pod:2992
24703 " mkfs-b fstype blocksize device\n"
24708 #: ../fish/guestfish-actions.pod:2994
24710 "This call is similar to L</mkfs>, but it allows you to control the block "
24711 "size of the resulting filesystem. Supported block sizes depend on the "
24712 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24716 #: ../fish/guestfish-actions.pod:3009
24721 #: ../fish/guestfish-actions.pod:3011
24724 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24729 #: ../fish/guestfish-actions.pod:3046
24730 msgid "mkmountpoint"
24734 #: ../fish/guestfish-actions.pod:3048
24737 " mkmountpoint exemptpath\n"
24742 #: ../fish/guestfish-actions.pod:3050
24744 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24745 "to create extra mountpoints before mounting the first filesystem."
24749 #: ../fish/guestfish-actions.pod:3074
24751 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24752 "unexpected errors if you try to mix these calls. It is safest to manually "
24753 "unmount filesystems and remove mountpoints after use."
24757 #: ../fish/guestfish-actions.pod:3078
24759 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24760 "for this to work for manual mountpoints, you must ensure that the innermost "
24761 "mountpoints have the longest pathnames, as in the example code above."
24765 #: ../fish/guestfish-actions.pod:3085
24767 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24768 "L</umount-all> to be called when the handle is closed which can also trigger "
24773 #: ../fish/guestfish-actions.pod:3089
24778 #: ../fish/guestfish-actions.pod:3091
24781 " mknod mode devmajor devminor path\n"
24786 #: ../fish/guestfish-actions.pod:3101
24788 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24789 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24790 "regular file). These constants are available in the standard Linux header "
24791 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24792 "wrappers around this command which bitwise OR in the appropriate constant "
24797 #: ../fish/guestfish-actions.pod:3111
24802 #: ../fish/guestfish-actions.pod:3113
24805 " mknod-b mode devmajor devminor path\n"
24810 #: ../fish/guestfish-actions.pod:3115
24812 "This call creates a block device node called C<path> with mode C<mode> and "
24813 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24814 "wrapper around L</mknod>."
24818 #: ../fish/guestfish-actions.pod:3121
24823 #: ../fish/guestfish-actions.pod:3123
24826 " mknod-c mode devmajor devminor path\n"
24831 #: ../fish/guestfish-actions.pod:3125
24833 "This call creates a char device node called C<path> with mode C<mode> and "
24834 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24835 "wrapper around L</mknod>."
24839 #: ../fish/guestfish-actions.pod:3131
24844 #: ../fish/guestfish-actions.pod:3133
24852 #: ../fish/guestfish-actions.pod:3137
24857 #: ../fish/guestfish-actions.pod:3139
24860 " mkswap-L label device\n"
24865 #: ../fish/guestfish-actions.pod:3147
24870 #: ../fish/guestfish-actions.pod:3149
24873 " mkswap-U uuid device\n"
24878 #: ../fish/guestfish-actions.pod:3153
24879 msgid "mkswap-file"
24883 #: ../fish/guestfish-actions.pod:3155
24886 " mkswap-file path\n"
24891 #: ../fish/guestfish-actions.pod:3159
24893 "This command just writes a swap file signature to an existing file. To "
24894 "create the file itself, use something like L</fallocate>."
24898 #: ../fish/guestfish-actions.pod:3162
24903 #: ../fish/guestfish-actions.pod:3164
24906 " modprobe modulename\n"
24911 #: ../fish/guestfish-actions.pod:3171
24916 #: ../fish/guestfish-actions.pod:3173
24919 " mount device mountpoint\n"
24924 #: ../fish/guestfish-actions.pod:3189
24926 "B<Important note:> When you use this call, the filesystem options C<sync> "
24927 "and C<noatime> are set implicitly. This was originally done because we "
24928 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24929 "very large negative performance impact and negligible effect on "
24930 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24931 "code that needs performance, and instead use L</mount-options> (use an empty "
24932 "string for the first parameter if you don't want any options)."
24936 #: ../fish/guestfish-actions.pod:3206
24941 #: ../fish/guestfish-actions.pod:3208
24944 " mount-loop file mountpoint\n"
24949 #: ../fish/guestfish-actions.pod:3214
24950 msgid "mount-options"
24954 #: ../fish/guestfish-actions.pod:3216
24957 " mount-options options device mountpoint\n"
24962 #: ../fish/guestfish-actions.pod:3218
24964 "This is the same as the L</mount> command, but it allows you to set the "
24965 "mount options as for the L<mount(8)> I<-o> flag."
24969 #: ../fish/guestfish-actions.pod:3226
24974 #: ../fish/guestfish-actions.pod:3228
24977 " mount-ro device mountpoint\n"
24982 #: ../fish/guestfish-actions.pod:3230
24984 "This is the same as the L</mount> command, but it mounts the filesystem with "
24985 "the read-only (I<-o ro>) flag."
24989 #: ../fish/guestfish-actions.pod:3233
24994 #: ../fish/guestfish-actions.pod:3235
24997 " mount-vfs options vfstype device mountpoint\n"
25002 #: ../fish/guestfish-actions.pod:3237
25004 "This is the same as the L</mount> command, but it allows you to set both the "
25005 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25009 #: ../fish/guestfish-actions.pod:3241
25010 msgid "mountpoints"
25014 #: ../fish/guestfish-actions.pod:3243
25022 #: ../fish/guestfish-actions.pod:3245
25024 "This call is similar to L</mounts>. That call returns a list of devices. "
25025 "This one returns a hash table (map) of device name to directory where the "
25026 "device is mounted."
25030 #: ../fish/guestfish-actions.pod:3249
25035 #: ../fish/guestfish-actions.pod:3251
25043 #: ../fish/guestfish-actions.pod:3258
25044 msgid "See also: L</mountpoints>"
25048 #: ../fish/guestfish-actions.pod:3260
25053 #: ../fish/guestfish-actions.pod:3262
25061 #: ../fish/guestfish-actions.pod:3267
25062 msgid "ntfs-3g-probe"
25066 #: ../fish/guestfish-actions.pod:3269
25069 " ntfs-3g-probe true|false device\n"
25074 #: ../fish/guestfish-actions.pod:3283
25079 #: ../fish/guestfish-actions.pod:3285
25082 " ntfsresize device\n"
25087 #: ../fish/guestfish-actions.pod:3300
25088 msgid "ntfsresize-size"
25092 #: ../fish/guestfish-actions.pod:3302
25095 " ntfsresize-size device size\n"
25100 #: ../fish/guestfish-actions.pod:3304
25102 "This command is the same as L</ntfsresize> except that it allows you to "
25103 "specify the new size (in bytes) explicitly."
25107 #: ../fish/guestfish-actions.pod:3307
25112 #: ../fish/guestfish-actions.pod:3309
25115 " part-add device prlogex startsect endsect\n"
25120 #: ../fish/guestfish-actions.pod:3311
25122 "This command adds a partition to C<device>. If there is no partition table "
25123 "on the device, call L</part-init> first."
25127 #: ../fish/guestfish-actions.pod:3323
25129 "Creating a partition which covers the whole disk is not so easy. Use "
25130 "L</part-disk> to do that."
25134 #: ../fish/guestfish-actions.pod:3326
25139 #: ../fish/guestfish-actions.pod:3328
25142 " part-del device partnum\n"
25147 #: ../fish/guestfish-actions.pod:3336
25152 #: ../fish/guestfish-actions.pod:3338
25155 " part-disk device parttype\n"
25160 #: ../fish/guestfish-actions.pod:3340
25162 "This command is simply a combination of L</part-init> followed by "
25163 "L</part-add> to create a single primary partition covering the whole disk."
25167 #: ../fish/guestfish-actions.pod:3344
25169 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25170 "possible values are described in L</part-init>."
25174 #: ../fish/guestfish-actions.pod:3350
25175 msgid "part-get-bootable"
25179 #: ../fish/guestfish-actions.pod:3352
25182 " part-get-bootable device partnum\n"
25187 #: ../fish/guestfish-actions.pod:3357
25188 msgid "See also L</part-set-bootable>."
25192 #: ../fish/guestfish-actions.pod:3359
25193 msgid "part-get-mbr-id"
25197 #: ../fish/guestfish-actions.pod:3361
25200 " part-get-mbr-id device partnum\n"
25205 #: ../fish/guestfish-actions.pod:3366 ../fish/guestfish-actions.pod:3504
25207 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25208 "undefined results for other partition table types (see "
25209 "L</part-get-parttype>)."
25213 #: ../fish/guestfish-actions.pod:3370
25214 msgid "part-get-parttype"
25218 #: ../fish/guestfish-actions.pod:3372
25221 " part-get-parttype device\n"
25226 #: ../fish/guestfish-actions.pod:3377
25228 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25229 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25230 "possible, although unusual. See L</part-init> for a full list."
25234 #: ../fish/guestfish-actions.pod:3382
25239 #: ../fish/guestfish-actions.pod:3384
25242 " part-init device parttype\n"
25247 #: ../fish/guestfish-actions.pod:3390
25249 "Initially there are no partitions. Following this, you should call "
25250 "L</part-add> for each partition required."
25254 #: ../fish/guestfish-actions.pod:3453
25259 #: ../fish/guestfish-actions.pod:3455
25262 " part-list device\n"
25267 #: ../fish/guestfish-actions.pod:3470
25269 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25270 "the device's sector size, see L</blockdev-getss>."
25274 #: ../fish/guestfish-actions.pod:3483
25275 msgid "part-set-bootable"
25279 #: ../fish/guestfish-actions.pod:3485
25282 " part-set-bootable device partnum true|false\n"
25287 #: ../fish/guestfish-actions.pod:3494
25288 msgid "part-set-mbr-id"
25292 #: ../fish/guestfish-actions.pod:3496
25295 " part-set-mbr-id device partnum idbyte\n"
25300 #: ../fish/guestfish-actions.pod:3508
25301 msgid "part-set-name"
25305 #: ../fish/guestfish-actions.pod:3510
25308 " part-set-name device partnum name\n"
25313 #: ../fish/guestfish-actions.pod:3518
25314 msgid "part-to-dev"
25318 #: ../fish/guestfish-actions.pod:3520
25321 " part-to-dev partition\n"
25326 #: ../fish/guestfish-actions.pod:3526
25328 "The named partition must exist, for example as a string returned from "
25329 "L</list-partitions>."
25333 #: ../fish/guestfish-actions.pod:3529
25334 msgid "ping-daemon"
25338 #: ../fish/guestfish-actions.pod:3531
25346 #: ../fish/guestfish-actions.pod:3538
25351 #: ../fish/guestfish-actions.pod:3540
25354 " pread path count offset\n"
25359 #: ../fish/guestfish-actions.pod:3548
25360 msgid "See also L</pwrite>, L</pread-device>."
25364 #: ../fish/guestfish-actions.pod:3553
25365 msgid "pread-device"
25369 #: ../fish/guestfish-actions.pod:3555
25372 " pread-device device count offset\n"
25377 #: ../fish/guestfish-actions.pod:3563
25378 msgid "See also L</pread>."
25382 #: ../fish/guestfish-actions.pod:3568
25387 #: ../fish/guestfish-actions.pod:3570
25390 " pvcreate device\n"
25395 #: ../fish/guestfish-actions.pod:3576
25400 #: ../fish/guestfish-actions.pod:3578
25403 " pvremove device\n"
25408 #: ../fish/guestfish-actions.pod:3587
25413 #: ../fish/guestfish-actions.pod:3589
25416 " pvresize device\n"
25421 #: ../fish/guestfish-actions.pod:3594
25422 msgid "pvresize-size"
25426 #: ../fish/guestfish-actions.pod:3596
25429 " pvresize-size device size\n"
25434 #: ../fish/guestfish-actions.pod:3598
25436 "This command is the same as L</pvresize> except that it allows you to "
25437 "specify the new size (in bytes) explicitly."
25441 #: ../fish/guestfish-actions.pod:3601
25446 #: ../fish/guestfish-actions.pod:3603
25454 #: ../fish/guestfish-actions.pod:3611
25455 msgid "See also L</pvs-full>."
25459 #: ../fish/guestfish-actions.pod:3613
25464 #: ../fish/guestfish-actions.pod:3615
25472 #: ../fish/guestfish-actions.pod:3620
25477 #: ../fish/guestfish-actions.pod:3622
25485 #: ../fish/guestfish-actions.pod:3626
25490 #: ../fish/guestfish-actions.pod:3628
25493 " pwrite path content offset\n"
25498 #: ../fish/guestfish-actions.pod:3639
25499 msgid "See also L</pread>, L</pwrite-device>."
25503 #: ../fish/guestfish-actions.pod:3644
25504 msgid "pwrite-device"
25508 #: ../fish/guestfish-actions.pod:3646
25511 " pwrite-device device content offset\n"
25516 #: ../fish/guestfish-actions.pod:3656
25517 msgid "See also L</pwrite>."
25521 #: ../fish/guestfish-actions.pod:3661
25526 #: ../fish/guestfish-actions.pod:3663
25529 " read-file path\n"
25534 #: ../fish/guestfish-actions.pod:3668
25536 "Unlike L</cat>, this function can correctly handle files that contain "
25537 "embedded ASCII NUL characters. However unlike L</download>, this function "
25538 "is limited in the total size of file that can be handled."
25542 #: ../fish/guestfish-actions.pod:3676
25547 #: ../fish/guestfish-actions.pod:3678
25550 " read-lines path\n"
25555 #: ../fish/guestfish-actions.pod:3685
25557 "Note that this function cannot correctly handle binary files (specifically, "
25558 "files containing C<\\0> character which is treated as end of line). For "
25559 "those you need to use the L</read-file> function which has a more complex "
25564 #: ../fish/guestfish-actions.pod:3690
25569 #: ../fish/guestfish-actions.pod:3692
25577 #: ../fish/guestfish-actions.pod:3744
25579 "This function is primarily intended for use by programs. To get a simple "
25580 "list of names, use L</ls>. To get a printable directory for human "
25581 "consumption, use L</ll>."
25585 #: ../fish/guestfish-actions.pod:3748
25590 #: ../fish/guestfish-actions.pod:3750
25598 #: ../fish/guestfish-actions.pod:3754
25599 msgid "readlinklist"
25603 #: ../fish/guestfish-actions.pod:3756
25606 " readlinklist path 'names ...'\n"
25611 #: ../fish/guestfish-actions.pod:3780
25616 #: ../fish/guestfish-actions.pod:3782
25624 #: ../fish/guestfish-actions.pod:3787
25625 msgid "removexattr"
25629 #: ../fish/guestfish-actions.pod:3789
25632 " removexattr xattr path\n"
25637 #: ../fish/guestfish-actions.pod:3794
25638 msgid "See also: L</lremovexattr>, L<attr(5)>."
25642 #: ../fish/guestfish-actions.pod:3796
25647 #: ../fish/guestfish-actions.pod:3798
25650 " resize2fs device\n"
25655 #: ../fish/guestfish-actions.pod:3803
25657 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25658 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25659 "gives an error about this and sometimes not. In any case, it is always safe "
25660 "to call L</e2fsck-f> before calling this function."
25664 #: ../fish/guestfish-actions.pod:3809
25665 msgid "resize2fs-M"
25669 #: ../fish/guestfish-actions.pod:3811
25672 " resize2fs-M device\n"
25677 #: ../fish/guestfish-actions.pod:3813
25679 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25680 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
25685 #: ../fish/guestfish-actions.pod:3817
25687 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25688 "and read the C<Block size> and C<Block count> values. These two numbers, "
25689 "multiplied together, give the resulting size of the minimal filesystem in "
25694 #: ../fish/guestfish-actions.pod:3822
25695 msgid "resize2fs-size"
25699 #: ../fish/guestfish-actions.pod:3824
25702 " resize2fs-size device size\n"
25707 #: ../fish/guestfish-actions.pod:3826
25709 "This command is the same as L</resize2fs> except that it allows you to "
25710 "specify the new size (in bytes) explicitly."
25714 #: ../fish/guestfish-actions.pod:3829
25719 #: ../fish/guestfish-actions.pod:3831
25727 #: ../fish/guestfish-actions.pod:3835
25732 #: ../fish/guestfish-actions.pod:3837
25740 #: ../fish/guestfish-actions.pod:3843
25745 #: ../fish/guestfish-actions.pod:3845
25753 #: ../fish/guestfish-actions.pod:3849
25754 msgid "rmmountpoint"
25758 #: ../fish/guestfish-actions.pod:3851
25761 " rmmountpoint exemptpath\n"
25766 #: ../fish/guestfish-actions.pod:3853
25768 "This calls removes a mountpoint that was previously created with "
25769 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25773 #: ../fish/guestfish-actions.pod:3857
25774 msgid "scrub-device"
25778 #: ../fish/guestfish-actions.pod:3859
25781 " scrub-device device\n"
25786 #: ../fish/guestfish-actions.pod:3870
25791 #: ../fish/guestfish-actions.pod:3872
25794 " scrub-file file\n"
25799 #: ../fish/guestfish-actions.pod:3882
25800 msgid "scrub-freespace"
25804 #: ../fish/guestfish-actions.pod:3884
25807 " scrub-freespace dir\n"
25812 #: ../fish/guestfish-actions.pod:3886
25814 "This command creates the directory C<dir> and then fills it with files until "
25815 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25816 "deletes them. The intention is to scrub any free space on the partition "
25817 "containing C<dir>."
25821 #: ../fish/guestfish-actions.pod:3895
25826 #: ../fish/guestfish-actions.pod:3897
25831 #: ../fish/guestfish-actions.pod:3899
25834 " set-append append\n"
25839 #: ../fish/guestfish-actions.pod:3910
25840 msgid "set-attach-method"
25844 #: ../fish/guestfish-actions.pod:3912
25845 msgid "attach-method"
25849 #: ../fish/guestfish-actions.pod:3914
25852 " set-attach-method attachmethod\n"
25857 #: ../fish/guestfish-actions.pod:3936
25858 msgid "set-autosync"
25862 #: ../fish/guestfish-actions.pod:3938
25867 #: ../fish/guestfish-actions.pod:3940
25870 " set-autosync true|false\n"
25875 #: ../fish/guestfish-actions.pod:3950
25880 #: ../fish/guestfish-actions.pod:3952
25885 #: ../fish/guestfish-actions.pod:3954
25888 " set-direct true|false\n"
25893 #: ../fish/guestfish-actions.pod:3960
25895 "One consequence of this is that log messages aren't caught by the library "
25896 "and handled by L</set-log-message-callback>, but go straight to stdout."
25900 #: ../fish/guestfish-actions.pod:3969
25901 msgid "set-e2label"
25905 #: ../fish/guestfish-actions.pod:3971
25908 " set-e2label device label\n"
25913 #: ../fish/guestfish-actions.pod:3977
25915 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25916 "label on a filesystem."
25920 #: ../fish/guestfish-actions.pod:3980
25925 #: ../fish/guestfish-actions.pod:3982
25928 " set-e2uuid device uuid\n"
25933 #: ../fish/guestfish-actions.pod:3989
25935 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25936 "UUID of a filesystem."
25940 #: ../fish/guestfish-actions.pod:3992
25941 msgid "set-memsize"
25945 #: ../fish/guestfish-actions.pod:3994
25950 #: ../fish/guestfish-actions.pod:3996
25953 " set-memsize memsize\n"
25958 #: ../fish/guestfish-actions.pod:3998
25960 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25961 "This only has any effect if called before L</launch>."
25965 #: ../fish/guestfish-actions.pod:4009
25966 msgid "set-network"
25970 #: ../fish/guestfish-actions.pod:4011
25975 #: ../fish/guestfish-actions.pod:4013
25978 " set-network true|false\n"
25983 #: ../fish/guestfish-actions.pod:4021
25984 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25988 #: ../fish/guestfish-actions.pod:4024
25993 #: ../fish/guestfish-actions.pod:4026
25998 #: ../fish/guestfish-actions.pod:4028
26001 " set-path searchpath\n"
26006 #: ../fish/guestfish-actions.pod:4037
26011 #: ../fish/guestfish-actions.pod:4039
26016 #: ../fish/guestfish-actions.pod:4041
26024 #: ../fish/guestfish-actions.pod:4061
26025 msgid "set-recovery-proc"
26029 #: ../fish/guestfish-actions.pod:4063
26030 msgid "recovery-proc"
26034 #: ../fish/guestfish-actions.pod:4065
26037 " set-recovery-proc true|false\n"
26042 #: ../fish/guestfish-actions.pod:4067
26044 "If this is called with the parameter C<false> then L</launch> does not "
26045 "create a recovery process. The purpose of the recovery process is to stop "
26046 "runaway qemu processes in the case where the main program aborts abruptly."
26050 #: ../fish/guestfish-actions.pod:4072
26052 "This only has any effect if called before L</launch>, and the default is "
26057 #: ../fish/guestfish-actions.pod:4081
26058 msgid "set-selinux"
26062 #: ../fish/guestfish-actions.pod:4083
26067 #: ../fish/guestfish-actions.pod:4085
26070 " set-selinux true|false\n"
26075 #: ../fish/guestfish-actions.pod:4096
26080 #: ../fish/guestfish-actions.pod:4098
26085 #: ../fish/guestfish-actions.pod:4100
26088 " set-trace true|false\n"
26093 #: ../fish/guestfish-actions.pod:4112
26095 "Trace messages are normally sent to C<stderr>, unless you register a "
26096 "callback to send them somewhere else (see L</set-event-callback>)."
26100 #: ../fish/guestfish-actions.pod:4116
26101 msgid "set-verbose"
26105 #: ../fish/guestfish-actions.pod:4118
26110 #: ../fish/guestfish-actions.pod:4120
26113 " set-verbose true|false\n"
26118 #: ../fish/guestfish-actions.pod:4127
26120 "Verbose messages are normally sent to C<stderr>, unless you register a "
26121 "callback to send them somewhere else (see L</set-event-callback>)."
26125 #: ../fish/guestfish-actions.pod:4131
26130 #: ../fish/guestfish-actions.pod:4133
26133 " setcon context\n"
26138 #: ../fish/guestfish-actions.pod:4140
26143 #: ../fish/guestfish-actions.pod:4142
26146 " setxattr xattr val vallen path\n"
26151 #: ../fish/guestfish-actions.pod:4148
26152 msgid "See also: L</lsetxattr>, L<attr(5)>."
26156 #: ../fish/guestfish-actions.pod:4150
26161 #: ../fish/guestfish-actions.pod:4152
26164 " sfdisk device cyls heads sectors 'lines ...'\n"
26169 #: ../fish/guestfish-actions.pod:4174
26170 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26174 #: ../fish/guestfish-actions.pod:4187
26179 #: ../fish/guestfish-actions.pod:4189
26182 " sfdiskM device 'lines ...'\n"
26187 #: ../fish/guestfish-actions.pod:4191
26189 "This is a simplified interface to the L</sfdisk> command, where partition "
26190 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26191 "you don't need to specify the cyls, heads and sectors parameters which were "
26192 "rarely if ever used anyway."
26196 #: ../fish/guestfish-actions.pod:4197
26197 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26201 #: ../fish/guestfish-actions.pod:4210
26206 #: ../fish/guestfish-actions.pod:4212
26209 " sfdisk-N device partnum cyls heads sectors line\n"
26214 #: ../fish/guestfish-actions.pod:4217
26216 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26217 "cyls/heads/sectors parameters."
26221 #: ../fish/guestfish-actions.pod:4220
26222 msgid "See also: L</part-add>"
26226 #: ../fish/guestfish-actions.pod:4232
26227 msgid "sfdisk-disk-geometry"
26231 #: ../fish/guestfish-actions.pod:4234
26234 " sfdisk-disk-geometry device\n"
26239 #: ../fish/guestfish-actions.pod:4236
26241 "This displays the disk geometry of C<device> read from the partition table. "
26242 "Especially in the case where the underlying block device has been resized, "
26243 "this can be different from the kernel's idea of the geometry (see "
26244 "L</sfdisk-kernel-geometry>)."
26248 #: ../fish/guestfish-actions.pod:4244
26249 msgid "sfdisk-kernel-geometry"
26253 #: ../fish/guestfish-actions.pod:4246
26256 " sfdisk-kernel-geometry device\n"
26261 #: ../fish/guestfish-actions.pod:4253
26266 #: ../fish/guestfish-actions.pod:4255
26269 " sfdisk-l device\n"
26274 #: ../fish/guestfish-actions.pod:4261
26275 msgid "See also: L</part-list>"
26279 #: ../fish/guestfish-actions.pod:4270
26284 #: ../fish/guestfish-actions.pod:4272
26292 #: ../fish/guestfish-actions.pod:4277
26293 msgid "This is like L</command>, but passes the command to:"
26297 #: ../fish/guestfish-actions.pod:4285
26298 msgid "All the provisos about L</command> apply to this call."
26302 #: ../fish/guestfish-actions.pod:4287
26307 #: ../fish/guestfish-actions.pod:4289
26310 " sh-lines command\n"
26315 #: ../fish/guestfish-actions.pod:4291
26316 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26320 #: ../fish/guestfish-actions.pod:4294
26321 msgid "See also: L</command-lines>"
26325 #: ../fish/guestfish-actions.pod:4296
26330 #: ../fish/guestfish-actions.pod:4298
26338 #: ../fish/guestfish-actions.pod:4302
26343 #: ../fish/guestfish-actions.pod:4304
26351 #: ../fish/guestfish-actions.pod:4310
26356 #: ../fish/guestfish-actions.pod:4312
26364 #: ../fish/guestfish-actions.pod:4320
26369 #: ../fish/guestfish-actions.pod:4322
26377 #: ../fish/guestfish-actions.pod:4330
26382 #: ../fish/guestfish-actions.pod:4332
26385 " strings-e encoding path\n"
26390 #: ../fish/guestfish-actions.pod:4334
26392 "This is like the L</strings> command, but allows you to specify the encoding "
26393 "of strings that are looked for in the source file C<path>."
26397 #: ../fish/guestfish-actions.pod:4344
26399 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26400 "ISO-8859-X (this is what L</strings> uses)."
26404 #: ../fish/guestfish-actions.pod:4376
26405 msgid "swapoff-device"
26409 #: ../fish/guestfish-actions.pod:4378
26412 " swapoff-device device\n"
26417 #: ../fish/guestfish-actions.pod:4380
26419 "This command disables the libguestfs appliance swap device or partition "
26420 "named C<device>. See L</swapon-device>."
26424 #: ../fish/guestfish-actions.pod:4384
26425 msgid "swapoff-file"
26429 #: ../fish/guestfish-actions.pod:4386
26432 " swapoff-file file\n"
26437 #: ../fish/guestfish-actions.pod:4390
26438 msgid "swapoff-label"
26442 #: ../fish/guestfish-actions.pod:4392
26445 " swapoff-label label\n"
26450 #: ../fish/guestfish-actions.pod:4397
26451 msgid "swapoff-uuid"
26455 #: ../fish/guestfish-actions.pod:4399
26458 " swapoff-uuid uuid\n"
26463 #: ../fish/guestfish-actions.pod:4404
26464 msgid "swapon-device"
26468 #: ../fish/guestfish-actions.pod:4406
26471 " swapon-device device\n"
26476 #: ../fish/guestfish-actions.pod:4408
26478 "This command enables the libguestfs appliance to use the swap device or "
26479 "partition named C<device>. The increased memory is made available for all "
26480 "commands, for example those run using L</command> or L</sh>."
26484 #: ../fish/guestfish-actions.pod:4420
26485 msgid "swapon-file"
26489 #: ../fish/guestfish-actions.pod:4422
26492 " swapon-file file\n"
26497 #: ../fish/guestfish-actions.pod:4424
26498 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26502 #: ../fish/guestfish-actions.pod:4427
26503 msgid "swapon-label"
26507 #: ../fish/guestfish-actions.pod:4429
26510 " swapon-label label\n"
26515 #: ../fish/guestfish-actions.pod:4431
26517 "This command enables swap to a labeled swap partition. See "
26518 "L</swapon-device> for other notes."
26522 #: ../fish/guestfish-actions.pod:4434
26523 msgid "swapon-uuid"
26527 #: ../fish/guestfish-actions.pod:4436
26530 " swapon-uuid uuid\n"
26535 #: ../fish/guestfish-actions.pod:4438
26537 "This command enables swap to a swap partition with the given UUID. See "
26538 "L</swapon-device> for other notes."
26542 #: ../fish/guestfish-actions.pod:4441
26547 #: ../fish/guestfish-actions.pod:4443
26555 #: ../fish/guestfish-actions.pod:4451
26560 #: ../fish/guestfish-actions.pod:4453
26568 #: ../fish/guestfish-actions.pod:4461
26573 #: ../fish/guestfish-actions.pod:4463
26576 " tail-n nrlines path\n"
26581 #: ../fish/guestfish-actions.pod:4476
26586 #: ../fish/guestfish-actions.pod:4478
26589 " tar-in (tarfile|-) directory\n"
26594 #: ../fish/guestfish-actions.pod:4483
26595 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26599 #: ../fish/guestfish-actions.pod:4488
26604 #: ../fish/guestfish-actions.pod:4490
26607 " tar-out directory (tarfile|-)\n"
26612 #: ../fish/guestfish-actions.pod:4495
26613 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26617 #: ../fish/guestfish-actions.pod:4500
26622 #: ../fish/guestfish-actions.pod:4502
26625 " tgz-in (tarball|-) directory\n"
26630 #: ../fish/guestfish-actions.pod:4507
26631 msgid "To upload an uncompressed tarball, use L</tar-in>."
26635 #: ../fish/guestfish-actions.pod:4511
26640 #: ../fish/guestfish-actions.pod:4513
26643 " tgz-out directory (tarball|-)\n"
26648 #: ../fish/guestfish-actions.pod:4518
26649 msgid "To download an uncompressed tarball, use L</tar-out>."
26653 #: ../fish/guestfish-actions.pod:4522
26658 #: ../fish/guestfish-actions.pod:4524
26666 #: ../fish/guestfish-actions.pod:4533
26671 #: ../fish/guestfish-actions.pod:4535
26679 #: ../fish/guestfish-actions.pod:4540
26680 msgid "truncate-size"
26684 #: ../fish/guestfish-actions.pod:4542
26687 " truncate-size path size\n"
26692 #: ../fish/guestfish-actions.pod:4547
26694 "If the current file size is less than C<size> then the file is extended to "
26695 "the required size with zero bytes. This creates a sparse file (ie. disk "
26696 "blocks are not allocated for the file until you write to it). To create a "
26697 "non-sparse file of zeroes, use L</fallocate64> instead."
26701 #: ../fish/guestfish-actions.pod:4553
26706 #: ../fish/guestfish-actions.pod:4555
26709 " tune2fs-l device\n"
26714 #: ../fish/guestfish-actions.pod:4565
26719 #: ../fish/guestfish-actions.pod:4567
26722 " txz-in (tarball|-) directory\n"
26727 #: ../fish/guestfish-actions.pod:4574
26732 #: ../fish/guestfish-actions.pod:4576
26735 " txz-out directory (tarball|-)\n"
26740 #: ../fish/guestfish-actions.pod:4583
26745 #: ../fish/guestfish-actions.pod:4585
26753 #: ../fish/guestfish-actions.pod:4599
26754 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26758 #: ../fish/guestfish-actions.pod:4604
26763 #: ../fish/guestfish-actions.pod:4606
26768 #: ../fish/guestfish-actions.pod:4608
26771 " umount pathordevice\n"
26776 #: ../fish/guestfish-actions.pod:4614
26781 #: ../fish/guestfish-actions.pod:4616
26782 msgid "unmount-all"
26786 #: ../fish/guestfish-actions.pod:4618
26794 #: ../fish/guestfish-actions.pod:4624
26799 #: ../fish/guestfish-actions.pod:4626
26802 " upload (filename|-) remotefilename\n"
26807 #: ../fish/guestfish-actions.pod:4633
26808 msgid "See also L</download>."
26812 #: ../fish/guestfish-actions.pod:4637
26813 msgid "upload-offset"
26817 #: ../fish/guestfish-actions.pod:4639
26820 " upload-offset (filename|-) remotefilename offset\n"
26825 #: ../fish/guestfish-actions.pod:4651
26827 "Note that there is no limit on the amount of data that can be uploaded with "
26828 "this call, unlike with L</pwrite>, and this call always writes the full "
26829 "amount unless an error occurs."
26833 #: ../fish/guestfish-actions.pod:4656
26834 msgid "See also L</upload>, L</pwrite>."
26838 #: ../fish/guestfish-actions.pod:4660
26843 #: ../fish/guestfish-actions.pod:4662
26846 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26851 #: ../fish/guestfish-actions.pod:4681
26856 #: ../fish/guestfish-actions.pod:4683
26864 #: ../fish/guestfish-actions.pod:4710
26866 "I<Note:> Don't use this call to test for availability of features. In "
26867 "enterprise distributions we backport features from later versions into "
26868 "earlier versions, making this an unreliable way to test for features. Use "
26869 "L</available> instead."
26873 #: ../fish/guestfish-actions.pod:4716
26878 #: ../fish/guestfish-actions.pod:4718
26881 " vfs-label device\n"
26886 #: ../fish/guestfish-actions.pod:4725
26887 msgid "To find a filesystem from the label, use L</findfs-label>."
26891 #: ../fish/guestfish-actions.pod:4727
26896 #: ../fish/guestfish-actions.pod:4729
26899 " vfs-type device\n"
26904 #: ../fish/guestfish-actions.pod:4739
26909 #: ../fish/guestfish-actions.pod:4741
26912 " vfs-uuid device\n"
26917 #: ../fish/guestfish-actions.pod:4748
26918 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26922 #: ../fish/guestfish-actions.pod:4750
26923 msgid "vg-activate"
26927 #: ../fish/guestfish-actions.pod:4752
26930 " vg-activate true|false 'volgroups ...'\n"
26935 #: ../fish/guestfish-actions.pod:4765
26936 msgid "vg-activate-all"
26940 #: ../fish/guestfish-actions.pod:4767
26943 " vg-activate-all true|false\n"
26948 #: ../fish/guestfish-actions.pod:4777
26953 #: ../fish/guestfish-actions.pod:4779
26956 " vgcreate volgroup 'physvols ...'\n"
26961 #: ../fish/guestfish-actions.pod:4784
26966 #: ../fish/guestfish-actions.pod:4786
26969 " vglvuuids vgname\n"
26974 #: ../fish/guestfish-actions.pod:4791
26976 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26977 "logical volumes and volume groups."
26981 #: ../fish/guestfish-actions.pod:4794
26982 msgid "See also L</vgpvuuids>."
26986 #: ../fish/guestfish-actions.pod:4796
26991 #: ../fish/guestfish-actions.pod:4798
26994 " vgpvuuids vgname\n"
26999 #: ../fish/guestfish-actions.pod:4803
27001 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27002 "physical volumes and volume groups."
27006 #: ../fish/guestfish-actions.pod:4806
27007 msgid "See also L</vglvuuids>."
27011 #: ../fish/guestfish-actions.pod:4808
27016 #: ../fish/guestfish-actions.pod:4810
27019 " vgremove vgname\n"
27024 #: ../fish/guestfish-actions.pod:4817
27029 #: ../fish/guestfish-actions.pod:4819
27032 " vgrename volgroup newvolgroup\n"
27037 #: ../fish/guestfish-actions.pod:4823
27042 #: ../fish/guestfish-actions.pod:4825
27050 #: ../fish/guestfish-actions.pod:4833
27051 msgid "See also L</vgs-full>."
27055 #: ../fish/guestfish-actions.pod:4835
27060 #: ../fish/guestfish-actions.pod:4837
27068 #: ../fish/guestfish-actions.pod:4842
27073 #: ../fish/guestfish-actions.pod:4844
27081 #: ../fish/guestfish-actions.pod:4849
27086 #: ../fish/guestfish-actions.pod:4851
27094 #: ../fish/guestfish-actions.pod:4855
27099 #: ../fish/guestfish-actions.pod:4857
27107 #: ../fish/guestfish-actions.pod:4862
27112 #: ../fish/guestfish-actions.pod:4864
27120 #: ../fish/guestfish-actions.pod:4869
27125 #: ../fish/guestfish-actions.pod:4871
27133 #: ../fish/guestfish-actions.pod:4876
27138 #: ../fish/guestfish-actions.pod:4878
27141 " write path content\n"
27146 #: ../fish/guestfish-actions.pod:4886
27151 #: ../fish/guestfish-actions.pod:4888
27154 " write-file path content size\n"
27159 #: ../fish/guestfish-actions.pod:4911
27164 #: ../fish/guestfish-actions.pod:4913
27167 " zegrep regex path\n"
27172 #: ../fish/guestfish-actions.pod:4921
27177 #: ../fish/guestfish-actions.pod:4923
27180 " zegrepi regex path\n"
27185 #: ../fish/guestfish-actions.pod:4931
27190 #: ../fish/guestfish-actions.pod:4933
27198 #: ../fish/guestfish-actions.pod:4941
27199 msgid "See also: L</zero-device>, L</scrub-device>."
27203 #: ../fish/guestfish-actions.pod:4943
27204 msgid "zero-device"
27208 #: ../fish/guestfish-actions.pod:4945
27211 " zero-device device\n"
27216 #: ../fish/guestfish-actions.pod:4947
27218 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27219 "which just zeroes the first few blocks of a device."
27223 #: ../fish/guestfish-actions.pod:4954
27228 #: ../fish/guestfish-actions.pod:4956
27231 " zerofree device\n"
27236 #: ../fish/guestfish-actions.pod:4969
27241 #: ../fish/guestfish-actions.pod:4971
27244 " zfgrep pattern path\n"
27249 #: ../fish/guestfish-actions.pod:4979
27254 #: ../fish/guestfish-actions.pod:4981
27257 " zfgrepi pattern path\n"
27262 #: ../fish/guestfish-actions.pod:4989
27267 #: ../fish/guestfish-actions.pod:4991
27270 " zfile meth path\n"
27275 #: ../fish/guestfish-actions.pod:4998
27276 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27280 #: ../fish/guestfish-actions.pod:5008
27285 #: ../fish/guestfish-actions.pod:5010
27288 " zgrep regex path\n"
27293 #: ../fish/guestfish-actions.pod:5018
27298 #: ../fish/guestfish-actions.pod:5020
27301 " zgrepi regex path\n"
27306 #: ../fish/guestfish-commands.pod:1
27311 #: ../fish/guestfish-commands.pod:3
27316 #: ../fish/guestfish-commands.pod:5
27319 " alloc filename size\n"
27324 #: ../fish/guestfish-commands.pod:7
27326 "This creates an empty (zeroed) file of the given size, and then adds so it "
27327 "can be further examined."
27331 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27332 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27336 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27337 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27341 #: ../fish/guestfish-commands.pod:14
27343 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27344 "image, see L</PREPARED DISK IMAGES>."
27348 #: ../fish/guestfish-commands.pod:17
27353 #: ../fish/guestfish-commands.pod:19
27356 " copy-in local [local ...] /remotedir\n"
27361 #: ../fish/guestfish-commands.pod:21
27363 "C<copy-in> copies local files or directories recursively into the disk "
27364 "image, placing them in the directory called C</remotedir> (which must "
27365 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27366 "other commands as necessary."
27370 #: ../fish/guestfish-commands.pod:26
27372 "Multiple local files and directories can be specified, but the last "
27373 "parameter must always be a remote directory. Wildcards cannot be used."
27377 #: ../fish/guestfish-commands.pod:30
27382 #: ../fish/guestfish-commands.pod:32
27385 " copy-out remote [remote ...] localdir\n"
27390 #: ../fish/guestfish-commands.pod:34
27392 "C<copy-out> copies remote files or directories recursively out of the disk "
27393 "image, placing them on the host disk in a local directory called C<localdir> "
27394 "(which must exist). This guestfish meta-command turns into a sequence of "
27395 "L</download>, L</tar-out> and other commands as necessary."
27399 #: ../fish/guestfish-commands.pod:40
27401 "Multiple remote files and directories can be specified, but the last "
27402 "parameter must always be a local directory. To download to the current "
27403 "directory, use C<.> as in:"
27407 #: ../fish/guestfish-commands.pod:44
27410 " copy-out /home .\n"
27415 #: ../fish/guestfish-commands.pod:46
27417 "Wildcards cannot be used in the ordinary command, but you can use them with "
27418 "the help of L</glob> like this:"
27422 #: ../fish/guestfish-commands.pod:49
27425 " glob copy-out /home/* .\n"
27430 #: ../fish/guestfish-commands.pod:51
27435 #: ../fish/guestfish-commands.pod:53
27438 " echo [params ...]\n"
27443 #: ../fish/guestfish-commands.pod:55
27444 msgid "This echos the parameters to the terminal."
27448 #: ../fish/guestfish-commands.pod:57
27453 #: ../fish/guestfish-commands.pod:59
27458 #: ../fish/guestfish-commands.pod:61
27463 #: ../fish/guestfish-commands.pod:63
27471 #: ../fish/guestfish-commands.pod:65
27473 "This is used to edit a file. It downloads the file, edits it locally using "
27474 "your editor, then uploads the result."
27478 #: ../fish/guestfish-commands.pod:68
27480 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27481 "or C<emacs> you will get those corresponding editors."
27485 #: ../fish/guestfish-commands.pod:72
27490 #: ../fish/guestfish-commands.pod:74
27493 " glob command args...\n"
27498 #: ../fish/guestfish-commands.pod:76
27500 "Expand wildcards in any paths in the args list, and run C<command> "
27501 "repeatedly on each matching path."
27505 #: ../fish/guestfish-commands.pod:79
27506 msgid "See L</WILDCARDS AND GLOBBING>."
27510 #: ../fish/guestfish-commands.pod:81
27515 #: ../fish/guestfish-commands.pod:83
27518 " hexedit <filename|device>\n"
27519 " hexedit <filename|device> <max>\n"
27520 " hexedit <filename|device> <start> <max>\n"
27525 #: ../fish/guestfish-commands.pod:87
27527 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27532 #: ../fish/guestfish-commands.pod:90
27534 "This command works by downloading potentially the whole file or device, "
27535 "editing it locally, then uploading it. If the file or device is large, you "
27536 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27537 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27538 "usual modifiers allowed such as C<1M> (1 megabyte)."
27542 #: ../fish/guestfish-commands.pod:97
27543 msgid "For example to edit the first few sectors of a disk you might do:"
27547 #: ../fish/guestfish-commands.pod:100
27550 " hexedit /dev/sda 1M\n"
27555 #: ../fish/guestfish-commands.pod:102
27557 "which would allow you to edit anywhere within the first megabyte of the "
27562 #: ../fish/guestfish-commands.pod:105
27563 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27567 #: ../fish/guestfish-commands.pod:107
27570 " hexedit /dev/sda1 0x400 0x400\n"
27575 #: ../fish/guestfish-commands.pod:109
27576 msgid "(assuming the superblock is in the standard location)."
27580 #: ../fish/guestfish-commands.pod:111
27582 "This command requires the external L<hexedit(1)> program. You can specify "
27583 "another program to use by setting the C<HEXEDITOR> environment variable."
27587 #: ../fish/guestfish-commands.pod:115
27588 msgid "See also L</hexdump>."
27592 #: ../fish/guestfish-commands.pod:117
27597 #: ../fish/guestfish-commands.pod:119
27605 #: ../fish/guestfish-commands.pod:121
27606 msgid "Change the local directory, ie. the current directory of guestfish itself."
27610 #: ../fish/guestfish-commands.pod:124
27611 msgid "Note that C<!cd> won't do what you might expect."
27615 #: ../fish/guestfish-commands.pod:126
27620 #: ../fish/guestfish-commands.pod:128
27625 #: ../fish/guestfish-commands.pod:130
27633 #: ../fish/guestfish-commands.pod:132
27634 msgid "Opens the manual page for guestfish."
27638 #: ../fish/guestfish-commands.pod:134
27643 #: ../fish/guestfish-commands.pod:136
27648 #: ../fish/guestfish-commands.pod:138
27656 #: ../fish/guestfish-commands.pod:140
27664 #: ../fish/guestfish-commands.pod:142
27665 msgid "This is used to view a file."
27669 #: ../fish/guestfish-commands.pod:144
27671 "The default viewer is C<$PAGER>. However if you use the alternate command "
27672 "C<less> you will get the C<less> command specifically."
27676 #: ../fish/guestfish-commands.pod:147
27681 #: ../fish/guestfish-commands.pod:149
27689 #: ../fish/guestfish-commands.pod:151
27691 "Close and reopen the libguestfs handle. It is not necessary to use this "
27692 "normally, because the handle is closed properly when guestfish exits. "
27693 "However this is occasionally useful for testing."
27697 #: ../fish/guestfish-commands.pod:155
27702 #: ../fish/guestfish-commands.pod:157
27705 " sparse filename size\n"
27710 #: ../fish/guestfish-commands.pod:159
27712 "This creates an empty sparse file of the given size, and then adds so it can "
27713 "be further examined."
27717 #: ../fish/guestfish-commands.pod:162
27719 "In all respects it works the same as the L</alloc> command, except that the "
27720 "image file is allocated sparsely, which means that disk blocks are not "
27721 "assigned to the file until they are needed. Sparse disk files only use "
27722 "space when written to, but they are slower and there is a danger you could "
27723 "run out of real disk space during a write operation."
27727 #: ../fish/guestfish-commands.pod:172
27732 #: ../fish/guestfish-commands.pod:174
27740 #: ../fish/guestfish-commands.pod:176
27742 "This command returns a list of the optional groups known to the daemon, and "
27743 "indicates which ones are supported by this build of the libguestfs "
27748 #: ../fish/guestfish-commands.pod:180
27749 msgid "See also L<guestfs(3)/AVAILABILITY>."
27753 #: ../fish/guestfish-commands.pod:182
27758 #: ../fish/guestfish-commands.pod:184
27761 " time command args...\n"
27766 #: ../fish/guestfish-commands.pod:186
27768 "Run the command as usual, but print the elapsed time afterwards. This can "
27769 "be useful for benchmarking operations."
27773 #: ../test-tool/libguestfs-test-tool.pod:5
27774 msgid "libguestfs-test-tool - End user tests for libguestfs"
27778 #: ../test-tool/libguestfs-test-tool.pod:9
27781 " libguestfs-test-tool [--options]\n"
27786 #: ../test-tool/libguestfs-test-tool.pod:13
27788 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27789 "and developers, to allow them to check basic libguestfs functionality is "
27790 "working. This is needed because libguestfs occasionally breaks for reasons "
27791 "beyond our control: usually because of changes in the underlying qemu or "
27792 "kernel packages, or the host environment."
27796 #: ../test-tool/libguestfs-test-tool.pod:20
27797 msgid "If you suspect a problem in libguestfs, then just run:"
27801 #: ../test-tool/libguestfs-test-tool.pod:22
27804 " libguestfs-test-tool\n"
27809 #: ../test-tool/libguestfs-test-tool.pod:24
27810 msgid "It will print lots of diagnostic messages."
27814 #: ../test-tool/libguestfs-test-tool.pod:26
27815 msgid "If it runs to completion successfully, you will see this near the end:"
27819 #: ../test-tool/libguestfs-test-tool.pod:28
27822 " ===== TEST FINISHED OK =====\n"
27827 #: ../test-tool/libguestfs-test-tool.pod:30
27828 msgid "and the test tool will exit with code 0."
27832 #: ../test-tool/libguestfs-test-tool.pod:32
27834 "If it fails (and/or exits with non-zero error code), please paste the "
27835 "B<complete, unedited> output of the test tool into a bug report. More "
27836 "information about reporting bugs can be found on the "
27837 "L<http://libguestfs.org/> website."
27841 #: ../test-tool/libguestfs-test-tool.pod:41
27846 #: ../test-tool/libguestfs-test-tool.pod:43
27847 msgid "Display short usage information and exit."
27851 #: ../test-tool/libguestfs-test-tool.pod:45
27852 msgid "I<--qemu qemu_binary>"
27856 #: ../test-tool/libguestfs-test-tool.pod:47
27858 "If you have downloaded another qemu binary, point this option at the full "
27859 "path of the binary to try it."
27863 #: ../test-tool/libguestfs-test-tool.pod:50
27864 msgid "I<--qemudir qemu_source_dir>"
27868 #: ../test-tool/libguestfs-test-tool.pod:52
27870 "If you have compiled qemu from source, point this option at the source "
27871 "directory to try it."
27875 #: ../test-tool/libguestfs-test-tool.pod:55
27876 msgid "I<--timeout N>"
27880 #: ../test-tool/libguestfs-test-tool.pod:57
27882 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27883 "does not usually need to be adjusted unless your machine is very slow."
27887 #: ../test-tool/libguestfs-test-tool.pod:63
27888 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27892 #: ../test-tool/libguestfs-test-tool.pod:65
27894 "If you have compiled another version of qemu from source and would like to "
27895 "try that, then you can use the I<--qemudir> option to point to the qemu "
27896 "source directory."
27900 #: ../test-tool/libguestfs-test-tool.pod:69
27902 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27903 "option to point to the binary."
27907 #: ../test-tool/libguestfs-test-tool.pod:72
27909 "When using an alternate qemu with libguestfs, usually you would need to "
27910 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27911 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27912 "when you use either of the I<--qemudir> or I<--qemu> options."
27916 #: ../test-tool/libguestfs-test-tool.pod:79
27918 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27919 "I<1> if there was an error."
27923 #: ../test-tool/libguestfs-test-tool.pod:84
27925 "For the full list of environment variables which may affect libguestfs, "
27926 "please see the L<guestfs(3)> manual page."
27930 #: ../test-tool/libguestfs-test-tool.pod:89
27931 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27935 #: ../fuse/guestmount.pod:5
27936 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27940 #: ../fuse/guestmount.pod:9
27943 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27948 #: ../fuse/guestmount.pod:11
27951 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27956 #: ../fuse/guestmount.pod:13
27959 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27964 #: ../fuse/guestmount.pod:17
27966 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27967 "machines. If you do this, you risk disk corruption in the VM."
27971 #: ../fuse/guestmount.pod:22
27973 "The guestmount program can be used to mount virtual machine filesystems and "
27974 "other disk images on the host. It uses libguestfs for access to the guest "
27975 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27976 "a mountable device."
27980 #: ../fuse/guestmount.pod:27
27982 "Along with other options, you have to give at least one device (I<-a> "
27983 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27984 "option) or use the I<-i> inspection option. How this works is better "
27985 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27990 #: ../fuse/guestmount.pod:33
27992 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27993 "by you, and the filesystem will not be visible to any other users unless you "
27994 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27995 "the filesystem, use the C<fusermount -u> command."
27999 #: ../fuse/guestmount.pod:41
28001 "For a typical Windows guest which has its main filesystem on the first "
28006 #: ../fuse/guestmount.pod:44
28009 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28014 #: ../fuse/guestmount.pod:46
28016 "For a typical Linux guest which has a /boot filesystem on the first "
28017 "partition, and the root filesystem on a logical volume:"
28021 #: ../fuse/guestmount.pod:49
28024 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28029 #: ../fuse/guestmount.pod:51
28030 msgid "To get libguestfs to detect guest mountpoints for you:"
28034 #: ../fuse/guestmount.pod:53
28037 " guestmount -a guest.img -i --ro /mnt\n"
28042 #: ../fuse/guestmount.pod:55
28043 msgid "For a libvirt guest called \"Guest\" you could do:"
28047 #: ../fuse/guestmount.pod:57
28050 " guestmount -d Guest -i --ro /mnt\n"
28055 #: ../fuse/guestmount.pod:59
28057 "If you don't know what filesystems are contained in a guest or disk image, "
28058 "use L<virt-filesystems(1)> first:"
28062 #: ../fuse/guestmount.pod:62
28065 " virt-filesystems MyGuest\n"
28070 #: ../fuse/guestmount.pod:64
28072 "If you want to trace the libguestfs calls but without excessive debugging "
28073 "information, we recommend:"
28077 #: ../fuse/guestmount.pod:67
28080 " guestmount [...] --trace /mnt\n"
28085 #: ../fuse/guestmount.pod:69
28086 msgid "If you want to debug the program, we recommend:"
28090 #: ../fuse/guestmount.pod:71
28093 " guestmount [...] --trace --verbose /mnt\n"
28098 #: ../fuse/guestmount.pod:73
28103 #: ../fuse/guestmount.pod:75
28104 msgid "Other users cannot see the filesystem by default"
28108 #: ../fuse/guestmount.pod:77
28110 "If you mount a filesystem as one user (eg. root), then other users will not "
28111 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28112 "option when mounting:"
28116 #: ../fuse/guestmount.pod:81
28119 " sudo guestmount [...] -o allow_other /mnt\n"
28124 #: ../fuse/guestmount.pod:87
28125 msgid "B<-a image> | B<--add image>"
28129 #: ../fuse/guestmount.pod:89
28130 msgid "Add a block device or virtual machine image."
28134 #: ../fuse/guestmount.pod:94
28135 msgid "B<-c URI> | B<--connect URI>"
28139 #: ../fuse/guestmount.pod:100
28140 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28144 #: ../fuse/guestmount.pod:106
28145 msgid "B<--dir-cache-timeout N>"
28149 #: ../fuse/guestmount.pod:108
28151 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28152 "seconds. The readdir cache [actually, there are several semi-independent "
28153 "caches] is populated after a readdir(2) call with the stat and extended "
28154 "attributes of the files in the directory, in anticipation that they will be "
28155 "requested soon after."
28159 #: ../fuse/guestmount.pod:114
28161 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28162 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28163 "requests, only cache existing ones."
28167 #: ../fuse/guestmount.pod:125
28168 msgid "B<--format=raw|qcow2|..> | B<--format>"
28172 #: ../fuse/guestmount.pod:132
28174 "If you have untrusted raw-format guest disk images, you should use this "
28175 "option to specify the disk format. This avoids a possible security problem "
28176 "with malicious guests (CVE-2010-3851). See also "
28177 "L<guestfs(3)/guestfs_add_drive_opts>."
28181 #: ../fuse/guestmount.pod:137
28182 msgid "B<--fuse-help>"
28186 #: ../fuse/guestmount.pod:139
28187 msgid "Display help on special FUSE options (see I<-o> below)."
28191 #: ../fuse/guestmount.pod:143
28192 msgid "Display brief help and exit."
28196 #: ../fuse/guestmount.pod:145
28197 msgid "B<-i> | B<--inspector>"
28201 #: ../fuse/guestmount.pod:165
28203 "Mount the named partition or logical volume on the given mountpoint B<in the "
28204 "guest> (this has nothing to do with mountpoints in the host)."
28208 #: ../fuse/guestmount.pod:168
28210 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28211 "something on C</>."
28215 #: ../fuse/guestmount.pod:181
28216 msgid "B<-n> | B<--no-sync>"
28220 #: ../fuse/guestmount.pod:183
28222 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28223 "unmounted. If you specify this option, then we don't attempt to sync the "
28224 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28228 #: ../fuse/guestmount.pod:188
28229 msgid "B<-o option> | B<--option option>"
28233 #: ../fuse/guestmount.pod:190
28234 msgid "Pass extra options to FUSE."
28238 #: ../fuse/guestmount.pod:192
28240 "To get a list of all the extra options supported by FUSE, use the command "
28241 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28242 "of them are a good idea."
28246 #: ../fuse/guestmount.pod:196
28249 " guestmount --fuse-help\n"
28254 #: ../fuse/guestmount.pod:198
28255 msgid "Some potentially useful FUSE options:"
28259 #: ../fuse/guestmount.pod:202
28260 msgid "B<-o allow_other>"
28264 #: ../fuse/guestmount.pod:204
28265 msgid "Allow other users to see the filesystem."
28269 #: ../fuse/guestmount.pod:206
28270 msgid "B<-o attr_timeout=N>"
28274 #: ../fuse/guestmount.pod:208
28275 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28279 #: ../fuse/guestmount.pod:210
28280 msgid "B<-o kernel_cache>"
28284 #: ../fuse/guestmount.pod:212
28286 "Allow the kernel to cache files (reduces the number of reads that have to go "
28287 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28288 "afford the extra memory usage."
28292 #: ../fuse/guestmount.pod:216
28293 msgid "B<-o uid=N> B<-o gid=N>"
28297 #: ../fuse/guestmount.pod:218
28299 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28300 "the chosen values."
28304 #: ../fuse/guestmount.pod:223
28305 msgid "B<-r> | B<--ro>"
28309 #: ../fuse/guestmount.pod:225
28311 "Add devices and mount everything read-only. Also disallow writes and make "
28312 "the disk appear read-only to FUSE."
28316 #: ../fuse/guestmount.pod:228
28318 "This is highly recommended if you are not going to edit the guest disk. If "
28319 "the guest is running and this option is I<not> supplied, then there is a "
28320 "strong risk of disk corruption in the guest. We try to prevent this from "
28321 "happening, but it is not always possible."
28325 #: ../fuse/guestmount.pod:233
28326 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28330 #: ../fuse/guestmount.pod:237
28331 msgid "Enable SELinux support for the guest."
28335 #: ../fuse/guestmount.pod:239
28336 msgid "B<-v> | B<--verbose>"
28340 #: ../fuse/guestmount.pod:241
28341 msgid "Enable verbose messages from underlying libguestfs."
28345 #: ../fuse/guestmount.pod:243
28346 msgid "B<-V> | B<--version>"
28350 #: ../fuse/guestmount.pod:245
28351 msgid "Display the program version and exit."
28355 #: ../fuse/guestmount.pod:247
28356 msgid "B<-w> | B<--rw>"
28360 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
28361 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28365 #: ../fuse/guestmount.pod:254
28366 msgid "B<-x> | B<--trace>"
28370 #: ../fuse/guestmount.pod:256
28371 msgid "Trace libguestfs calls and entry into each FUSE function."
28375 #: ../fuse/guestmount.pod:258
28376 msgid "This also stops the daemon from forking into the background."
28380 #: ../fuse/guestmount.pod:279
28382 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28383 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28384 "L<http://fuse.sf.net/>."
28388 #: ../fuse/guestmount.pod:294
28389 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28393 #: ../tools/virt-edit.pl:34
28394 msgid "virt-edit - Edit a file in a virtual machine"
28398 #: ../tools/virt-edit.pl:38
28401 " virt-edit [--options] domname file\n"
28406 #: ../tools/virt-edit.pl:40
28409 " virt-edit [--options] disk.img [disk.img ...] file\n"
28414 #: ../tools/virt-edit.pl:42
28417 " virt-edit [domname|disk.img] file -e 'expr'\n"
28422 #: ../tools/virt-edit.pl:46
28424 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28425 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28426 "doing this, but doesn't catch all cases."
28430 #: ../tools/virt-edit.pl:52
28432 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28433 "the named virtual machine (or disk image)."
28437 #: ../tools/virt-edit.pl:55
28438 msgid "If you want to just view a file, use L<virt-cat(1)>."
28442 #: ../tools/virt-edit.pl:57
28444 "For more complex cases you should look at the L<guestfish(1)> tool (see "
28445 "L</USING GUESTFISH> below)."
28449 #: ../tools/virt-edit.pl:60
28451 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28452 "files. L<guestfish(1)> can do that and much more."
28456 #: ../tools/virt-edit.pl:65
28457 msgid "Edit the named files interactively:"
28461 #: ../tools/virt-edit.pl:67
28464 " virt-edit mydomain /boot/grub/grub.conf\n"
28469 #: ../tools/virt-edit.pl:69
28472 " virt-edit mydomain /etc/passwd\n"
28477 #: ../tools/virt-edit.pl:71
28478 msgid "For Windows guests, some Windows paths are understood:"
28482 #: ../tools/virt-edit.pl:73
28485 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28490 #: ../tools/virt-edit.pl:75
28492 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28493 "below). To change the init default level to 5:"
28497 #: ../tools/virt-edit.pl:79
28500 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28505 #: ../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
28506 msgid "Display brief help."
28510 #: ../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
28511 msgid "Display version number and exit."
28515 #: ../tools/virt-edit.pl:105
28516 msgid "B<--backup extension> | B<-b extension>"
28520 #: ../tools/virt-edit.pl:107
28522 "Create a backup of the original file I<in the guest disk image>. The backup "
28523 "has the original filename with C<extension> added."
28527 #: ../tools/virt-edit.pl:110
28529 "Usually the first character of C<extension> would be a dot C<.> so you would "
28534 #: ../tools/virt-edit.pl:113
28537 " virt-edit -b .orig [etc]\n"
28542 #: ../tools/virt-edit.pl:115
28543 msgid "By default, no backup file is made."
28547 #: ../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
28548 msgid "B<--connect URI> | B<-c URI>"
28552 #: ../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
28554 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28555 "to the default libvirt hypervisor."
28559 #: ../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
28561 "If you specify guest block devices directly, then libvirt is not used at "
28566 #: ../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
28567 msgid "B<--format> raw"
28571 #: ../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
28573 "Specify the format of disk images given on the command line. If this is "
28574 "omitted then the format is autodetected from the content of the disk image."
28578 #: ../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
28580 "If disk images are requested from libvirt, then this program asks libvirt "
28581 "for this information. In this case, the value of the format parameter is "
28586 #: ../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
28588 "If working with untrusted raw-format guest disk images, you should ensure "
28589 "the format is always specified."
28593 #: ../tools/virt-edit.pl:150
28594 msgid "B<--expr EXPR> | B<-e EXPR>"
28598 #: ../tools/virt-edit.pl:152
28600 "Instead of launching the external editor, non-interactively apply the Perl "
28601 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28606 #: ../tools/virt-edit.pl:156
28608 "Be careful to properly quote the expression to prevent it from being altered "
28613 #: ../tools/virt-edit.pl:280
28614 msgid "NON-INTERACTIVE EDITING"
28618 #: ../tools/virt-edit.pl:282
28620 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28621 "administrator can interactively edit the file."
28625 #: ../tools/virt-edit.pl:285
28627 "There are two ways also to use C<virt-edit> from scripts in order to make "
28628 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28629 "like this, it's less error-prone to write scripts directly using the "
28630 "libguestfs API and Augeas for configuration file editing.)"
28634 #: ../tools/virt-edit.pl:291
28636 "The first method is to temporarily set C<$EDITOR> to any script or program "
28637 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28638 "update C<tmpfile> in place however it likes."
28642 #: ../tools/virt-edit.pl:295
28644 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
28645 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28646 "instances of C<foo> with C<bar> in a file:"
28650 #: ../tools/virt-edit.pl:299
28653 " virt-edit domname filename -e 's/foo/bar/'\n"
28658 #: ../tools/virt-edit.pl:301
28660 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28661 "For example to delete root's password you could do:"
28665 #: ../tools/virt-edit.pl:304
28668 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28673 #: ../tools/virt-edit.pl:306
28675 "What really happens is that the snippet is evaluated as a Perl expression "
28676 "for each line of the file. The line, including the final C<\\n>, is passed "
28677 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28681 #: ../tools/virt-edit.pl:311
28683 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28684 "C<apache> user account from the password file you can do:"
28688 #: ../tools/virt-edit.pl:314
28691 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28696 #: ../tools/virt-edit.pl:316
28698 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28699 "the end of the file is rather difficult this way since there is no concept "
28700 "of \"last line of the file\" - your expression just doesn't get called "
28701 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28706 #: ../tools/virt-edit.pl:322
28708 "The variable C<$lineno> contains the current line number. As is "
28709 "traditional, the first line in the file is number C<1>."
28713 #: ../tools/virt-edit.pl:325
28715 "The return value from the expression is ignored, but the expression may call "
28716 "C<die> in order to abort the whole program, leaving the original file "
28721 #: ../tools/virt-edit.pl:329
28723 "Remember when matching the end of a line that C<$_> may contain the final "
28724 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28725 "newline then neither of these. Thus to match or substitute some text at the "
28726 "end of a line, use this regular expression:"
28730 #: ../tools/virt-edit.pl:334
28733 " /some text(\\r?\\n)?$/\n"
28738 #: ../tools/virt-edit.pl:336
28740 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28741 "C<$_> itself (since that would remove all newlines from the file):"
28745 #: ../tools/virt-edit.pl:340
28748 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28753 #: ../tools/virt-edit.pl:344
28755 "C<virt-edit> has a limited ability to understand Windows drive letters and "
28756 "paths (eg. C<E:\\foo\\bar.txt>)."
28760 #: ../tools/virt-edit.pl:347
28761 msgid "If and only if the guest is running Windows then:"
28765 #: ../tools/virt-edit.pl:353
28767 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
28768 "to the correct filesystem."
28772 #: ../tools/virt-edit.pl:358
28774 "Any backslash (C<\\>) characters in the path are replaced with forward "
28775 "slashes so that libguestfs can process it."
28779 #: ../tools/virt-edit.pl:363
28781 "The path is resolved case insensitively to locate the file that should be "
28786 #: ../tools/virt-edit.pl:368
28787 msgid "There are some known shortcomings:"
28791 #: ../tools/virt-edit.pl:374
28792 msgid "Some NTFS symbolic links may not be followed correctly."
28796 #: ../tools/virt-edit.pl:378
28797 msgid "NTFS junction points that cross filesystems are not followed."
28801 #: ../tools/virt-edit.pl:435
28802 msgid "USING GUESTFISH"
28806 #: ../tools/virt-edit.pl:437
28808 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
28809 "C<virt-edit> doesn't work."
28813 #: ../tools/virt-edit.pl:440
28814 msgid "Using C<virt-edit> is approximately equivalent to doing:"
28818 #: ../tools/virt-edit.pl:442
28821 " guestfish --rw -i -d domname edit /file\n"
28826 #: ../tools/virt-edit.pl:444
28828 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
28829 "path to the file."
28833 #: ../tools/virt-edit.pl:447
28835 "The command above uses libguestfs's guest inspection feature and so does not "
28836 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
28837 "disk images that don't contain guests. To edit a file on a disk image "
28842 #: ../tools/virt-edit.pl:452
28845 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
28850 #: ../tools/virt-edit.pl:454
28852 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
28853 "the disk image to edit, and C</file> is the full path to the file."
28857 #: ../tools/virt-edit.pl:458
28859 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
28860 "C<write> or C<upload> instead:"
28864 #: ../tools/virt-edit.pl:461
28867 " guestfish --rw -i -d domname touch /newfile\n"
28872 #: ../tools/virt-edit.pl:463
28875 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
28880 #: ../tools/virt-edit.pl:465
28883 " guestfish --rw -i -d domname upload localfile /newfile\n"
28888 #: ../tools/virt-edit.pl:467
28889 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
28893 #: ../tools/virt-edit.pl:470
28896 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
28901 #: ../tools/virt-edit.pl:480
28906 #: ../tools/virt-edit.pl:482
28908 "If set, this string is used as the editor. It may contain arguments, "
28909 "eg. C<\"emacs -nw\">"
28913 #: ../tools/virt-edit.pl:485
28914 msgid "If not set, C<vi> is used."
28918 #: ../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
28919 msgid "SHELL QUOTING"
28923 #: ../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
28925 "Libvirt guest names can contain arbitrary characters, some of which have "
28926 "meaning to the shell such as C<#> and space. You may need to quote or "
28927 "escape these characters on the command line. See the shell manual page "
28928 "L<sh(1)> for details."
28932 #: ../tools/virt-edit.pl:498
28934 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
28935 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28936 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
28940 #: ../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
28945 #: ../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
28946 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
28950 #: ../tools/virt-edit.pl:516
28951 msgid "Copyright (C) 2009-2011 Red Hat Inc."
28955 #: ../tools/virt-win-reg.pl:37
28957 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28962 #: ../tools/virt-win-reg.pl:41
28965 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28970 #: ../tools/virt-win-reg.pl:43
28973 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28978 #: ../tools/virt-win-reg.pl:45
28981 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28986 #: ../tools/virt-win-reg.pl:47
28989 " virt-win-reg --merge domname [input.reg ...]\n"
28994 #: ../tools/virt-win-reg.pl:49
28997 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29002 #: ../tools/virt-win-reg.pl:53
29004 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29005 "virtual machines. If you do this, you I<will> get irreversible disk "
29006 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29007 "but doesn't catch all cases."
29011 #: ../tools/virt-win-reg.pl:58
29013 "Modifying the Windows Registry is an inherently risky operation. The format "
29014 "is deliberately obscure and undocumented, and Registry changes can leave the "
29015 "system unbootable. Therefore when using the I<--merge> option, make sure "
29016 "you have a reliable backup first."
29020 #: ../tools/virt-win-reg.pl:65
29022 "This program can export and merge Windows Registry entries from a Windows "
29027 #: ../tools/virt-win-reg.pl:68
29029 "The first parameter is the libvirt guest name or the raw disk image of a "
29034 #: ../tools/virt-win-reg.pl:71
29036 "If I<--merge> is I<not> specified, then the chosen registry key is "
29037 "displayed/exported (recursively). For example:"
29041 #: ../tools/virt-win-reg.pl:74
29044 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29049 #: ../tools/virt-win-reg.pl:76
29050 msgid "You can also display single values from within registry keys, for example:"
29054 #: ../tools/virt-win-reg.pl:79
29057 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29058 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29059 " Windows 7 Enterprise\n"
29064 #: ../tools/virt-win-reg.pl:83
29066 "With I<--merge>, you can merge a textual regedit file into the Windows "
29071 #: ../tools/virt-win-reg.pl:86
29074 " $ virt-win-reg --merge Windows7 changes.reg\n"
29079 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29084 #: ../tools/virt-win-reg.pl:90
29086 "This program is only meant for simple access to the registry. If you want "
29087 "to do complicated things with the registry, we suggest you download the "
29088 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29089 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29090 "L<hivexregedit(1)>."
29094 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29099 #: ../tools/virt-win-reg.pl:122
29100 msgid "Enable debugging messages."
29104 #: ../tools/virt-win-reg.pl:157
29109 #: ../tools/virt-win-reg.pl:159
29111 "In merge mode, this merges a textual regedit file into the Windows Registry "
29112 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29113 "displays or exports Registry entries instead."
29117 #: ../tools/virt-win-reg.pl:163
29119 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29120 "result in disk corruption. However exporting (without this flag) is always "
29125 #: ../tools/virt-win-reg.pl:171
29126 msgid "B<--encoding> UTF-16LE|ASCII"
29130 #: ../tools/virt-win-reg.pl:173
29132 "When merging (only), you may need to specify the encoding for strings to be "
29133 "used in the hive file. This is explained in detail in "
29134 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29138 #: ../tools/virt-win-reg.pl:177
29140 "The default is to use UTF-16LE, which should work with recent versions of "
29145 #: ../tools/virt-win-reg.pl:402
29146 msgid "SUPPORTED SYSTEMS"
29150 #: ../tools/virt-win-reg.pl:404
29152 "The program currently supports Windows NT-derived guests starting with "
29153 "Windows XP through to at least Windows 7."
29157 #: ../tools/virt-win-reg.pl:407
29159 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
29160 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
29161 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
29165 #: ../tools/virt-win-reg.pl:411
29167 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29172 #: ../tools/virt-win-reg.pl:414
29174 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29179 #: ../tools/virt-win-reg.pl:417
29184 #: ../tools/virt-win-reg.pl:419
29186 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29187 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29188 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29189 "with Windows-style line endings, you may need to reencode the whole file "
29190 "before or after processing."
29194 #: ../tools/virt-win-reg.pl:425
29196 "To reencode a file from Windows format to Linux (before processing it with "
29197 "the I<--merge> option), you would do something like this:"
29201 #: ../tools/virt-win-reg.pl:428
29204 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29209 #: ../tools/virt-win-reg.pl:430
29211 "To go in the opposite direction, after exporting and before sending the file "
29212 "to a Windows user, do something like this:"
29216 #: ../tools/virt-win-reg.pl:433
29219 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29224 #: ../tools/virt-win-reg.pl:435
29225 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29229 #: ../tools/virt-win-reg.pl:437
29231 "If you are unsure about the current encoding, use the L<file(1)> command. "
29232 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29233 "Windows-style (CRLF) line endings, like this:"
29237 #: ../tools/virt-win-reg.pl:441
29240 " $ file software.reg\n"
29241 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29242 " with CRLF line terminators\n"
29247 #: ../tools/virt-win-reg.pl:445
29248 msgid "This file would need conversion before you could I<--merge> it."
29252 #: ../tools/virt-win-reg.pl:447
29253 msgid "CurrentControlSet etc."
29257 #: ../tools/virt-win-reg.pl:449
29259 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29260 "Registry at the level of the hive file, and therefore you cannot modify "
29265 #: ../tools/virt-win-reg.pl:453
29267 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29268 "circumstances it might refer to another control set. The way to find out is "
29269 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29273 #: ../tools/virt-win-reg.pl:457
29276 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29277 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29278 " \"Current\"=dword:00000001\n"
29279 " \"Default\"=dword:00000001\n"
29280 " \"Failed\"=dword:00000000\n"
29281 " \"LastKnownGood\"=dword:00000002\n"
29286 #: ../tools/virt-win-reg.pl:464
29287 msgid "\"Current\" is the one which Windows will choose when it boots."
29291 #: ../tools/virt-win-reg.pl:466
29292 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29296 #: ../tools/virt-win-reg.pl:469
29297 msgid "WINDOWS TIPS"
29301 #: ../tools/virt-win-reg.pl:471
29303 "Note that some of these tips modify the guest disk image. The guest I<must> "
29304 "be shut off, else you will get disk corruption."
29308 #: ../tools/virt-win-reg.pl:474
29309 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29313 #: ../tools/virt-win-reg.pl:476
29315 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29316 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29317 "is uploaded into C<C:\\>:"
29321 #: ../tools/virt-win-reg.pl:480
29324 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29329 #: ../tools/virt-win-reg.pl:482
29330 msgid "Prepare a regedit file containing the registry change:"
29334 #: ../tools/virt-win-reg.pl:484
29337 " cat > test.reg <<'EOF'\n"
29338 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29339 " \"Test\"=\"c:\\\\test.bat\"\n"
29345 #: ../tools/virt-win-reg.pl:489
29347 "In this example we use the key C<RunOnce> which means that the script will "
29348 "run precisely once when the first user logs in. If you want it to run every "
29349 "time a user logs in, replace C<RunOnce> with C<Run>."
29353 #: ../tools/virt-win-reg.pl:493
29354 msgid "Now update the registry:"
29358 #: ../tools/virt-win-reg.pl:495
29361 " virt-win-reg --merge WindowsGuest test.reg\n"
29366 #: ../tools/virt-win-reg.pl:497
29367 msgid "INSTALLING A SERVICE"
29371 #: ../tools/virt-win-reg.pl:499
29373 "This section assumes you are familiar with Windows services, and you either "
29374 "have a program which handles the Windows Service Control Protocol directly "
29375 "or you want to run any program using a service wrapper like SrvAny or the "
29380 #: ../tools/virt-win-reg.pl:504
29382 "First upload the program and optionally the service wrapper. In this case "
29383 "the test program is called C<test.exe> and we are using the RHSrvAny "
29388 #: ../tools/virt-win-reg.pl:508
29391 " guestfish -i -d WindowsGuest <<EOF\n"
29392 " upload rhsrvany.exe /rhsrvany.exe\n"
29393 " upload test.exe /test.exe\n"
29399 #: ../tools/virt-win-reg.pl:513
29401 "Prepare a regedit file containing the registry changes. In this example, "
29402 "the first registry change is needed for the service itself or the service "
29403 "wrapper (if used). The second registry change is only needed because I am "
29404 "using the RHSrvAny service wrapper."
29408 #: ../tools/virt-win-reg.pl:518
29411 " cat > service.reg <<'EOF'\n"
29412 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29413 " \"Type\"=dword:00000010\n"
29414 " \"Start\"=dword:00000002\n"
29415 " \"ErrorControl\"=dword:00000001\n"
29416 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29417 " \"DisplayName\"=\"RHSrvAny\"\n"
29418 " \"ObjectName\"=\"NetworkService\"\n"
29423 #: ../tools/virt-win-reg.pl:527
29426 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29427 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29428 " \"PWD\"=\"c:\\\\Temp\"\n"
29434 #: ../tools/virt-win-reg.pl:538
29436 "For use of C<ControlSet001> see the section above in this manual page. You "
29437 "may need to adjust this according to the control set that is in use by the "
29442 #: ../tools/virt-win-reg.pl:544
29444 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29445 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29446 "privileged account."
29450 #: ../tools/virt-win-reg.pl:550
29452 "For the meaning of the magic numbers, see this Microsoft KB article: "
29453 "L<http://support.microsoft.com/kb/103000>."
29457 #: ../tools/virt-win-reg.pl:555
29458 msgid "Update the registry:"
29462 #: ../tools/virt-win-reg.pl:557
29465 " virt-win-reg --merge WindowsGuest service.reg\n"
29470 #: ../tools/virt-win-reg.pl:561
29472 "Be careful when passing parameters containing C<\\> (backslash) in the "
29473 "shell. Usually you will have to use 'single quotes' or double backslashes "
29474 "(but not both) to protect them from the shell."
29478 #: ../tools/virt-win-reg.pl:565
29479 msgid "Paths and value names are case-insensitive."
29483 #: ../tools/virt-win-reg.pl:574
29485 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29486 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29487 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29488 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29492 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29494 "When reporting bugs, please enable debugging and capture the I<complete> "
29499 #: ../tools/virt-win-reg.pl:592
29502 " export LIBGUESTFS_DEBUG=1\n"
29503 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29508 #: ../tools/virt-win-reg.pl:595
29510 "Attach /tmp/virt-win-reg.log to a new bug report at "
29511 "L<https://bugzilla.redhat.com/>"
29515 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29516 msgid "Copyright (C) 2010 Red Hat Inc."
29520 #: ../tools/virt-list-filesystems.pl:32
29521 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29525 #: ../tools/virt-list-filesystems.pl:36
29528 " virt-list-filesystems [--options] domname\n"
29533 #: ../tools/virt-list-filesystems.pl:38
29536 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29541 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29543 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29548 #: ../tools/virt-list-filesystems.pl:45
29550 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29551 "are contained in a virtual machine or disk image."
29555 #: ../tools/virt-list-filesystems.pl:49
29557 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29558 "functionality. For more complex cases you should look at the "
29559 "L<guestfish(1)> tool."
29563 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29564 msgid "B<-l> | B<--long>"
29568 #: ../tools/virt-list-filesystems.pl:108
29570 "With this option, C<virt-list-filesystems> displays the type of each "
29571 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29575 #: ../tools/virt-list-filesystems.pl:115
29576 msgid "B<-a> | B<--all>"
29580 #: ../tools/virt-list-filesystems.pl:117
29582 "Normally we only show mountable filesystems. If this option is given then "
29583 "swap devices are shown too."
29587 #: ../tools/virt-list-filesystems.pl:191
29589 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29590 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29591 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29595 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29596 msgid "Copyright (C) 2009 Red Hat Inc."
29600 #: ../tools/virt-tar.pl:33
29601 msgid "virt-tar - Extract or upload files to a virtual machine"
29605 #: ../tools/virt-tar.pl:37
29608 " virt-tar [--options] -x domname directory tarball\n"
29613 #: ../tools/virt-tar.pl:39
29616 " virt-tar [--options] -u domname tarball directory\n"
29621 #: ../tools/virt-tar.pl:41
29624 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29629 #: ../tools/virt-tar.pl:43
29632 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29637 #: ../tools/virt-tar.pl:47
29639 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29640 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29644 #: ../tools/virt-tar.pl:52
29645 msgid "Download C</home> from the VM into a local tarball:"
29649 #: ../tools/virt-tar.pl:54
29652 " virt-tar -x domname /home home.tar\n"
29657 #: ../tools/virt-tar.pl:56
29660 " virt-tar -zx domname /home home.tar.gz\n"
29665 #: ../tools/virt-tar.pl:58
29666 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29670 #: ../tools/virt-tar.pl:60
29673 " virt-tar -u domname uploadstuff.tar /tmp\n"
29678 #: ../tools/virt-tar.pl:62
29681 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29686 #: ../tools/virt-tar.pl:66
29688 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29689 "virtual machines. If you do this, you risk disk corruption in the VM. "
29690 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29694 #: ../tools/virt-tar.pl:71
29696 "You can use I<-x> (extract) on live virtual machines, but you might get "
29697 "inconsistent results or errors if there is filesystem activity inside the "
29698 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29699 "work, but the only way to guarantee consistent results is if the virtual "
29700 "machine is shut down."
29704 #: ../tools/virt-tar.pl:79
29706 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29707 "parts of a guest filesystem. There are many possibilities: making backups, "
29708 "uploading data files, snooping on guest activity, fixing or customizing "
29713 #: ../tools/virt-tar.pl:84
29715 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29716 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29717 "should look at the L<guestfish(1)> tool."
29721 #: ../tools/virt-tar.pl:88
29723 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29724 "its contents (recursively) from the virtual machine into a local tarball. "
29725 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29726 "virtual machine. You cannot use these two options together."
29730 #: ../tools/virt-tar.pl:94
29732 "In addition, you may need to use the I<-z> (gZip) option to enable "
29733 "compression. When uploading, you have to specify I<-z> if the upload file "
29734 "is compressed because virt-tar won't detect this on its own."
29738 #: ../tools/virt-tar.pl:98
29740 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29741 "example it cannot do PKZip files or bzip2 compression. If you want that "
29742 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29743 "the L<libguestfs(3)> API)."
29747 #: ../tools/virt-tar.pl:156
29748 msgid "B<-x> | B<--extract> | B<--download>"
29752 #: ../tools/virt-tar.pl:158
29753 msgid "B<-u> | B<--upload>"
29757 #: ../tools/virt-tar.pl:160
29759 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29764 #: ../tools/virt-tar.pl:163
29766 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29767 "Please read the L</WARNING> section above before using this option."
29771 #: ../tools/virt-tar.pl:167
29772 msgid "You must specify exactly one of these options."
29776 #: ../tools/virt-tar.pl:173
29777 msgid "B<-z> | B<--gzip>"
29781 #: ../tools/virt-tar.pl:175
29782 msgid "Specify that the input or output tarball is gzip-compressed."
29786 #: ../tools/virt-tar.pl:288
29788 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29789 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29790 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29791 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29795 #: ../tools/virt-make-fs.pl:37
29796 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29800 #: ../tools/virt-make-fs.pl:41
29803 " virt-make-fs [--options] input.tar output.img\n"
29808 #: ../tools/virt-make-fs.pl:43
29811 " virt-make-fs [--options] input.tar.gz output.img\n"
29816 #: ../tools/virt-make-fs.pl:45
29819 " virt-make-fs [--options] directory output.img\n"
29824 #: ../tools/virt-make-fs.pl:49
29826 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29827 "archive or some files in a directory. It is similar to tools like "
29828 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29829 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29830 "useful if you want to attach these filesystems to existing virtual machines "
29831 "(eg. to import large amounts of read-only data to a VM)."
29835 #: ../tools/virt-make-fs.pl:57
29836 msgid "Basic usage is:"
29840 #: ../tools/virt-make-fs.pl:59
29843 " virt-make-fs input output\n"
29848 #: ../tools/virt-make-fs.pl:61
29850 "where C<input> is either a directory containing files that you want to add, "
29851 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29852 "C<output> is a disk image. The input type is detected automatically. The "
29853 "output disk image defaults to a raw ext2 image unless you specify extra "
29854 "flags (see L</OPTIONS> below)."
29858 #: ../tools/virt-make-fs.pl:67
29859 msgid "EXTRA SPACE"
29863 #: ../tools/virt-make-fs.pl:69
29865 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29866 "the files that it contains, but might have extra space. Depending on how "
29867 "you are going to use the output, you might think this extra space is wasted "
29868 "and want to minimize it, or you might want to leave space so that more files "
29869 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29870 "but you can use the I<--size> flag to leave space in the filesystem if you "
29875 #: ../tools/virt-make-fs.pl:77
29877 "An alternative way to leave extra space but not make the output image any "
29878 "bigger is to use an alternative disk image format (instead of the default "
29879 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29880 "image format (check your hypervisor supports this before using it). This "
29881 "allows you to choose a large I<--size> but the extra space won't actually be "
29882 "allocated in the image until you try to store something in it."
29886 #: ../tools/virt-make-fs.pl:85
29888 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29889 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29890 "to build another image from scratch."
29894 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29899 #: ../tools/virt-make-fs.pl:91
29902 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29907 #: ../tools/virt-make-fs.pl:93
29908 msgid "FILESYSTEM TYPE"
29912 #: ../tools/virt-make-fs.pl:95
29914 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29915 "libguestfs supports can be used (but I<not> read-only formats like "
29916 "ISO9660). Here are some of the more common choices:"
29920 #: ../tools/virt-make-fs.pl:101
29925 #: ../tools/virt-make-fs.pl:103
29927 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29928 "you are not going to use the filesystem in a way that requires the journal, "
29929 "then this is just wasted overhead."
29933 #: ../tools/virt-make-fs.pl:107
29934 msgid "I<ntfs> or I<vfat>"
29938 #: ../tools/virt-make-fs.pl:109
29939 msgid "Useful if exporting data to a Windows guest."
29943 #: ../tools/virt-make-fs.pl:111
29945 "I<Note for vfat>: The tar archive or local directory must only contain files "
29946 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29947 "program running within libguestfs is unable to change the ownership of "
29948 "non-root files, since vfat itself does not support this."
29952 #: ../tools/virt-make-fs.pl:116
29957 #: ../tools/virt-make-fs.pl:118
29959 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29960 "total filesystem size."
29964 #: ../tools/virt-make-fs.pl:125
29967 " virt-make-fs --type=minix input minixfs.img\n"
29972 #: ../tools/virt-make-fs.pl:127
29973 msgid "TO PARTITION OR NOT TO PARTITION"
29977 #: ../tools/virt-make-fs.pl:129
29978 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29982 #: ../tools/virt-make-fs.pl:131
29984 "Adding a partition can make the disk image more compatible with certain "
29985 "virtualized operating systems which don't expect to see a filesystem "
29986 "directly located on a block device (Linux doesn't care and will happily "
29987 "handle both types)."
29991 #: ../tools/virt-make-fs.pl:136
29993 "On the other hand, if you have a partition table then the output image is no "
29994 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29995 "directly on a partitioned disk image. (However libguestfs tools such as "
29996 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30000 #: ../tools/virt-make-fs.pl:144
30001 msgid "Add an MBR partition:"
30005 #: ../tools/virt-make-fs.pl:146
30008 " virt-make-fs --partition -- input disk.img\n"
30013 #: ../tools/virt-make-fs.pl:148
30015 "If the output disk image could be terabyte-sized or larger, it's better to "
30016 "use an EFI/GPT-compatible partition table:"
30020 #: ../tools/virt-make-fs.pl:151
30023 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30028 #: ../tools/virt-make-fs.pl:179
30029 msgid "Enable debugging information."
30033 #: ../tools/virt-make-fs.pl:185
30034 msgid "B<--size=E<lt>NE<gt>>"
30038 #: ../tools/virt-make-fs.pl:187
30039 msgid "B<--size=+E<lt>NE<gt>>"
30043 #: ../tools/virt-make-fs.pl:189
30044 msgid "B<-s E<lt>NE<gt>>"
30048 #: ../tools/virt-make-fs.pl:191
30049 msgid "B<-s +E<lt>NE<gt>>"
30053 #: ../tools/virt-make-fs.pl:193
30054 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30058 #: ../tools/virt-make-fs.pl:196
30060 "If this option is I<not> given, then the output image will be just large "
30061 "enough to contain all the files, with not much wasted space."
30065 #: ../tools/virt-make-fs.pl:199
30067 "To choose a fixed size output disk, specify an absolute number followed by "
30068 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30069 "Petabytes or Exabytes. This must be large enough to contain all the input "
30070 "files, else you will get an error."
30074 #: ../tools/virt-make-fs.pl:204
30076 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30077 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30078 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30079 "the input files, and (approximately) an extra 200 MB free space."
30083 #: ../tools/virt-make-fs.pl:210
30085 "Note that virt-make-fs estimates free space, and therefore will not produce "
30086 "filesystems containing precisely the free space requested. (It is much more "
30087 "expensive and time-consuming to produce a filesystem which has precisely the "
30088 "desired free space)."
30092 #: ../tools/virt-make-fs.pl:219
30093 msgid "B<--format=E<lt>fmtE<gt>>"
30097 #: ../tools/virt-make-fs.pl:221
30098 msgid "B<-F E<lt>fmtE<gt>>"
30102 #: ../tools/virt-make-fs.pl:223
30103 msgid "Choose the output disk image format."
30107 #: ../tools/virt-make-fs.pl:225
30108 msgid "The default is C<raw> (raw disk image)."
30112 #: ../tools/virt-make-fs.pl:227
30114 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30115 "that would really make sense here is C<qcow2>."
30119 #: ../tools/virt-make-fs.pl:234
30120 msgid "B<--type=E<lt>fsE<gt>>"
30124 #: ../tools/virt-make-fs.pl:236
30125 msgid "B<-t E<lt>fsE<gt>>"
30129 #: ../tools/virt-make-fs.pl:238
30130 msgid "Choose the output filesystem type."
30134 #: ../tools/virt-make-fs.pl:240
30135 msgid "The default is C<ext2>."
30139 #: ../tools/virt-make-fs.pl:242
30140 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30144 #: ../tools/virt-make-fs.pl:249
30145 msgid "B<--partition>"
30149 #: ../tools/virt-make-fs.pl:251
30150 msgid "B<--partition=E<lt>parttypeE<gt>>"
30154 #: ../tools/virt-make-fs.pl:253
30156 "If specified, this flag adds an MBR partition table to the output disk "
30161 #: ../tools/virt-make-fs.pl:256
30163 "You can change the partition table type, eg. I<--partition=gpt> for large "
30168 #: ../tools/virt-make-fs.pl:259
30170 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30171 "might consider the next parameter to be the partition type. For example:"
30175 #: ../tools/virt-make-fs.pl:263
30178 " virt-make-fs --partition input.tar ...\n"
30183 #: ../tools/virt-make-fs.pl:265
30185 "would cause virt-make-fs to think you wanted to use a partition type of "
30186 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30187 "dash) between options and the input file argument:"
30191 #: ../tools/virt-make-fs.pl:269
30194 " virt-make-fs --partition -- input.tar ...\n"
30199 #: ../tools/virt-make-fs.pl:541
30201 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30202 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30203 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30207 #: ../tools/virt-make-fs.pl:558
30210 " export LIBGUESTFS_DEBUG=1\n"
30211 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30216 #: ../tools/virt-make-fs.pl:561
30218 "Attach /tmp/virt-make-fs.log to a new bug report at "
30219 "L<https://bugzilla.redhat.com/>"
30223 #: ../tools/virt-list-partitions.pl:32
30224 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30228 #: ../tools/virt-list-partitions.pl:36
30231 " virt-list-partitions [--options] domname\n"
30236 #: ../tools/virt-list-partitions.pl:38
30239 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30244 #: ../tools/virt-list-partitions.pl:45
30246 "C<virt-list-partitions> is a command line tool to list the partitions that "
30247 "are contained in a virtual machine or disk image. It is mainly useful as a "
30248 "first step to using L<virt-resize(1)>."
30252 #: ../tools/virt-list-partitions.pl:50
30254 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30255 "functionality. For more complex cases you should look at the "
30256 "L<guestfish(1)> tool."
30260 #: ../tools/virt-list-partitions.pl:107
30261 msgid "B<-h> | B<--human-readable>"
30265 #: ../tools/virt-list-partitions.pl:109
30266 msgid "Show sizes in human-readable form (eg. \"1G\")."
30270 #: ../tools/virt-list-partitions.pl:117
30272 "With this option, C<virt-list-partitions> displays the type and size of each "
30273 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30277 #: ../tools/virt-list-partitions.pl:124
30278 msgid "B<-t> | B<--total>"
30282 #: ../tools/virt-list-partitions.pl:126
30283 msgid "Display the total size of each block device (as a separate row or rows)."
30287 #: ../tools/virt-list-partitions.pl:259
30289 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30290 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30291 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30295 #: ../tools/virt-list-partitions.pl:275
30296 msgid "Copyright (C) 2009-2010 Red Hat Inc."