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.3\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-05-18 12:00+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:2962 ../src/guestfs.pod:2966 ../src/guestfs.pod:2970 ../src/guestfs.pod:2974 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620 ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628 ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859 ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868 ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod: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:1855 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../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:5814 ../fish/guestfish-actions.pod:3908
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
5074 msgid "Outside contributions, experimental parts."
5078 #: ../src/guestfs.pod:2664
5083 #: ../src/guestfs.pod:2666
5085 "The daemon that runs inside the libguestfs appliance and carries out "
5090 #: ../src/guestfs.pod:2669
5095 #: ../src/guestfs.pod:2671
5096 msgid "L<virt-df(1)> command and documentation."
5100 #: ../src/guestfs.pod:2673
5105 #: ../src/guestfs.pod:2675
5106 msgid "C API example code."
5110 #: ../src/guestfs.pod:2677
5115 #: ../src/guestfs.pod:2679
5117 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5118 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5119 "L<virt-tar-out(1)>."
5123 #: ../src/guestfs.pod:2683
5128 #: ../src/guestfs.pod:2685
5129 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5133 #: ../src/guestfs.pod:2687
5134 msgid "C<generator>"
5138 #: ../src/guestfs.pod:2689
5140 "The crucially important generator, used to automatically generate large "
5141 "amounts of boilerplate C code for things like RPC and bindings."
5145 #: ../src/guestfs.pod:2692
5150 #: ../src/guestfs.pod:2694
5151 msgid "Files used by the test suite."
5155 #: ../src/guestfs.pod:2696
5156 msgid "Some \"phony\" guest images which we test against."
5160 #: ../src/guestfs.pod:2698
5161 msgid "C<inspector>"
5165 #: ../src/guestfs.pod:2700
5166 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5170 #: ../src/guestfs.pod:2702
5175 #: ../src/guestfs.pod:2704
5176 msgid "Logo used on the website. The fish is called Arthur by the way."
5180 #: ../src/guestfs.pod:2706
5185 #: ../src/guestfs.pod:2708
5186 msgid "M4 macros used by autoconf."
5190 #: ../src/guestfs.pod:2710
5195 #: ../src/guestfs.pod:2712
5196 msgid "Translations of simple gettext strings."
5200 #: ../src/guestfs.pod:2714
5205 #: ../src/guestfs.pod:2716
5207 "The build infrastructure and PO files for translations of manpages and POD "
5208 "files. Eventually this will be combined with the C<po> directory, but that "
5209 "is rather complicated."
5213 #: ../src/guestfs.pod:2720
5214 msgid "C<regressions>"
5218 #: ../src/guestfs.pod:2722
5219 msgid "Regression tests."
5223 #: ../src/guestfs.pod:2724
5228 #: ../src/guestfs.pod:2726
5229 msgid "L<virt-rescue(1)> command and documentation."
5233 #: ../src/guestfs.pod:2728
5238 #: ../src/guestfs.pod:2730
5239 msgid "Source code to the C library."
5243 #: ../src/guestfs.pod:2732
5248 #: ../src/guestfs.pod:2734
5249 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5253 #: ../src/guestfs.pod:2736
5254 msgid "C<test-tool>"
5258 #: ../src/guestfs.pod:2738
5260 "Test tool for end users to test if their qemu/kernel combination will work "
5265 #: ../src/guestfs.pod:2741
5270 #: ../src/guestfs.pod:2743
5275 #: ../src/guestfs.pod:2745
5280 #: ../src/guestfs.pod:2747
5285 #: ../src/guestfs.pod:2749
5290 #: ../src/guestfs.pod:2751
5295 #: ../src/guestfs.pod:2753
5300 #: ../src/guestfs.pod:2755
5305 #: ../src/guestfs.pod:2757
5306 msgid "Language bindings."
5310 #: ../src/guestfs.pod:2761
5315 #: ../src/guestfs.pod:2763
5316 msgid "PROTOCOL LIMITS"
5320 #: ../src/guestfs.pod:2765
5322 "Internally libguestfs uses a message-based protocol to pass API calls and "
5323 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5324 "plenty more detail about this). The maximum message size used by the "
5325 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5326 "aware of this limit. The API calls which may be affected are individually "
5327 "documented, with a link back to this section of the documentation."
5331 #: ../src/guestfs.pod:2773
5333 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5334 "a simple string. Because this string is at some point internally encoded as "
5335 "a message, the maximum size that it can return is slightly under 4 MB. If "
5336 "the requested file is larger than this then you will get an error."
5340 #: ../src/guestfs.pod:2779
5342 "In order to transfer large files into and out of the guest filesystem, you "
5343 "need to use particular calls that support this. The sections L</UPLOADING> "
5344 "and L</DOWNLOADING> document how to do this."
5348 #: ../src/guestfs.pod:2783
5350 "You might also consider mounting the disk image using our FUSE filesystem "
5351 "support (L<guestmount(1)>)."
5355 #: ../src/guestfs.pod:2786
5356 msgid "MAXIMUM NUMBER OF DISKS"
5360 #: ../src/guestfs.pod:2788
5361 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5365 #: ../src/guestfs.pod:2791
5367 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5368 "slots. However febootstrap only understands disks with names C</dev/vda> "
5369 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5374 #: ../src/guestfs.pod:2796
5376 "We are working to substantially raise this limit in future versions but it "
5377 "requires complex changes to qemu."
5381 #: ../src/guestfs.pod:2799
5383 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5384 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5385 "requires changes to qemu."
5389 #: ../src/guestfs.pod:2803
5390 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5394 #: ../src/guestfs.pod:2805
5395 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5399 #: ../src/guestfs.pod:2807
5401 "This is because it reserves 4 bits for the minor device number (thus "
5402 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5406 #: ../src/guestfs.pod:2810
5408 "If you attach a disk with more than 15 partitions, the extra partitions are "
5409 "ignored by libguestfs."
5413 #: ../src/guestfs.pod:2813
5414 msgid "MAXIMUM SIZE OF A DISK"
5418 #: ../src/guestfs.pod:2815
5419 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5423 #: ../src/guestfs.pod:2817
5425 "We have tested block devices up to 1 exabyte (2**60 or "
5426 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5431 #: ../src/guestfs.pod:2821
5433 "Although libguestfs probably does not impose any limit, the underlying host "
5434 "storage will. If you store disk images on a host ext4 filesystem, then the "
5435 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5436 "TB). If you store disk images as host logical volumes then you are limited "
5437 "by the maximum size of an LV."
5441 #: ../src/guestfs.pod:2827
5443 "For the hugest disk image files, we recommend using XFS on the host for "
5448 #: ../src/guestfs.pod:2830
5449 msgid "MAXIMUM SIZE OF A PARTITION"
5453 #: ../src/guestfs.pod:2832
5455 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5456 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5457 "address a partition located beyond 2 TB on the disk."
5461 #: ../src/guestfs.pod:2836
5463 "It is recommended that you use GPT partitions on disks which are larger than "
5464 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5465 "which are theoretically larger than the largest disk we could support."
5469 #: ../src/guestfs.pod:2841
5470 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5474 #: ../src/guestfs.pod:2843
5476 "This depends on the filesystem type. libguestfs itself does not impose any "
5477 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5478 "what these limits are."
5482 #: ../src/guestfs.pod:2847
5483 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5487 #: ../src/guestfs.pod:2849
5489 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5490 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5491 "uploads and downloads."
5495 #: ../src/guestfs.pod:2853
5496 msgid "INSPECTION LIMITS"
5500 #: ../src/guestfs.pod:2855
5502 "The inspection code has several arbitrary limits on things like the size of "
5503 "Windows Registry hive it will read, and the length of product name. These "
5504 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5505 "memory and disk space on the host, and should not be reached in practice. "
5506 "See the source code for more information."
5510 #: ../src/guestfs.pod:2861 ../fish/guestfish.pod:1015 ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5511 msgid "ENVIRONMENT VARIABLES"
5515 #: ../src/guestfs.pod:2865 ../fish/guestfish.pod:1041
5516 msgid "LIBGUESTFS_APPEND"
5520 #: ../src/guestfs.pod:2867 ../fish/guestfish.pod:1043
5521 msgid "Pass additional options to the guest kernel."
5525 #: ../src/guestfs.pod:2869 ../fish/guestfish.pod:1045
5526 msgid "LIBGUESTFS_DEBUG"
5530 #: ../src/guestfs.pod:2871
5532 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5533 "effect as calling C<guestfs_set_verbose (g, 1)>."
5537 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1050
5538 msgid "LIBGUESTFS_MEMSIZE"
5542 #: ../src/guestfs.pod:2876 ../fish/guestfish.pod:1052
5543 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5547 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1055
5550 " LIBGUESTFS_MEMSIZE=700\n"
5555 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1057
5556 msgid "LIBGUESTFS_PATH"
5560 #: ../src/guestfs.pod:2883
5562 "Set the path that libguestfs uses to search for a supermin appliance. See "
5563 "the discussion of paths in section L</PATH> above."
5567 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1062
5568 msgid "LIBGUESTFS_QEMU"
5572 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1064
5574 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5575 "which was found at compile time by the configure script is used."
5579 #: ../src/guestfs.pod:2892
5580 msgid "See also L</QEMU WRAPPERS> above."
5584 #: ../src/guestfs.pod:2894 ../fish/guestfish.pod:1068
5585 msgid "LIBGUESTFS_TRACE"
5589 #: ../src/guestfs.pod:2896
5591 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5592 "effect as calling C<guestfs_set_trace (g, 1)>."
5596 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1077
5601 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1079
5603 "Location of temporary directory, defaults to C</tmp> except for the cached "
5604 "supermin appliance which defaults to C</var/tmp>."
5608 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1082
5610 "If libguestfs was compiled to use the supermin appliance then the real "
5611 "appliance is cached in this directory, shared between all handles belonging "
5612 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5613 "use in case C</var/tmp> is not large enough."
5617 #: ../src/guestfs.pod:2912 ../fish/guestfish.pod:1149 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267 ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5622 #: ../src/guestfs.pod:2914
5624 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5625 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5626 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5627 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5628 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5629 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5630 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5631 "L<http://libguestfs.org/>."
5635 #: ../src/guestfs.pod:2941
5637 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5638 "L<lvm(8)>, L<disktype(1)>."
5642 #: ../src/guestfs.pod:2948 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5647 #: ../src/guestfs.pod:2950
5648 msgid "To get a list of bugs against libguestfs use this link:"
5652 #: ../src/guestfs.pod:2952
5653 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5657 #: ../src/guestfs.pod:2954
5658 msgid "To report a new bug against libguestfs use this link:"
5662 #: ../src/guestfs.pod:2956
5663 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5667 #: ../src/guestfs.pod:2958
5668 msgid "When reporting a bug, please check:"
5672 #: ../src/guestfs.pod:2964
5673 msgid "That the bug hasn't been reported already."
5677 #: ../src/guestfs.pod:2968
5678 msgid "That you are testing a recent version."
5682 #: ../src/guestfs.pod:2972
5683 msgid "Describe the bug accurately, and give a way to reproduce it."
5687 #: ../src/guestfs.pod:2976
5689 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5694 #: ../src/guestfs.pod:2981 ../fish/guestfish.pod:1172 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5699 #: ../src/guestfs.pod:2983 ../fish/guestfish.pod:1174 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5700 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5704 #: ../src/guestfs.pod:2985 ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282 ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5709 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1178 ../test-tool/libguestfs-test-tool.pod:99
5710 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5714 #: ../src/guestfs.pod:2990
5716 "This library is free software; you can redistribute it and/or modify it "
5717 "under the terms of the GNU Lesser General Public License as published by the "
5718 "Free Software Foundation; either version 2 of the License, or (at your "
5719 "option) any later version."
5723 #: ../src/guestfs.pod:2995
5725 "This library is distributed in the hope that it will be useful, but WITHOUT "
5726 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5727 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5732 #: ../src/guestfs.pod:3000
5734 "You should have received a copy of the GNU Lesser General Public License "
5735 "along with this library; if not, write to the Free Software Foundation, "
5736 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5740 #: ../src/guestfs-actions.pod:1
5741 msgid "guestfs_add_cdrom"
5745 #: ../src/guestfs-actions.pod:3
5749 " guestfs_add_cdrom (guestfs_h *g,\n"
5750 " const char *filename);\n"
5755 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5756 msgid "This function adds a virtual CD-ROM disk image to the guest."
5760 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5761 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5765 #: ../src/guestfs-actions.pod:17
5767 "This call checks for the existence of C<filename>. This stops you from "
5768 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5769 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5774 #: ../src/guestfs-actions.pod:24
5776 "If you just want to add an ISO file (often you use this as an efficient way "
5777 "to transfer large files into the guest), then you should probably use "
5778 "C<guestfs_add_drive_ro> instead."
5782 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436 ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541 ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670 ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266 ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471 ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3668 ../src/guestfs-actions.pod:3681 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3933 ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3971 ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4098 ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4208 ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4404 ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4482 ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4731 ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5622 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5684 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5710 ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5780 ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5829 ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868 ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6033 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6076 ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6437 ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6463 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6664 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6889 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7040 ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7186 ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7266 ../src/guestfs-actions.pod:7332 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7380
5783 msgid "This function returns 0 on success or -1 on error."
5787 #: ../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
5789 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5794 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:7274 ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319 ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3008 ../fish/guestfish-actions.pod:4866 ../fish/guestfish-actions.pod:4963
5796 "Deprecated functions will not be removed from the API, but the fact that "
5797 "they are deprecated indicates that there are problems with correct use of "
5802 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6078 ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6666 ../src/guestfs-actions.pod:7188
5803 msgid "(Added in 0.3)"
5807 #: ../src/guestfs-actions.pod:41
5808 msgid "guestfs_add_domain"
5812 #: ../src/guestfs-actions.pod:43
5816 " guestfs_add_domain (guestfs_h *g,\n"
5817 " const char *dom,\n"
5823 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4443
5825 "You may supply a list of optional arguments to this call. Use zero or more "
5826 "of the following pairs of parameters, and terminate the list with C<-1> on "
5827 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5831 #: ../src/guestfs-actions.pod:53
5834 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5835 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5836 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5837 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5842 #: ../src/guestfs-actions.pod:58
5844 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5845 "It works by connecting to libvirt, requesting the domain and domain XML from "
5846 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5851 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5853 "The number of disks added is returned. This operation is atomic: if an "
5854 "error is returned, then no disks are added."
5858 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5860 "This function does some minimal checks to make sure the libvirt domain is "
5861 "not running (unless C<readonly> is true). In a future version we will try "
5862 "to acquire the libvirt lock on each disk."
5866 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5868 "Disks must be accessible locally. This often means that adding disks from a "
5869 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5870 "unless those disks are accessible via the same device path locally too."
5874 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5876 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5877 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5878 "default libvirt URI (or one set through an environment variable, see the "
5879 "libvirt documentation for full details)."
5883 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5885 "The optional C<live> flag controls whether this call will try to connect to "
5886 "a running virtual machine C<guestfsd> process if it sees a suitable "
5887 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5888 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5889 "DAEMONS> for more information."
5893 #: ../src/guestfs-actions.pod:88
5895 "The other optional parameters are passed directly through to "
5896 "C<guestfs_add_drive_opts>."
5900 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5403 ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7212 ../src/guestfs-actions.pod:7225
5901 msgid "On error this function returns -1."
5905 #: ../src/guestfs-actions.pod:93
5906 msgid "(Added in 1.7.4)"
5910 #: ../src/guestfs-actions.pod:95
5911 msgid "guestfs_add_domain_va"
5915 #: ../src/guestfs-actions.pod:97
5919 " guestfs_add_domain_va (guestfs_h *g,\n"
5920 " const char *dom,\n"
5926 #: ../src/guestfs-actions.pod:102
5927 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5931 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508
5932 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5936 #: ../src/guestfs-actions.pod:106
5937 msgid "guestfs_add_domain_argv"
5941 #: ../src/guestfs-actions.pod:108
5945 " guestfs_add_domain_argv (guestfs_h *g,\n"
5946 " const char *dom,\n"
5947 " const struct guestfs_add_domain_argv *optargs);\n"
5952 #: ../src/guestfs-actions.pod:113
5953 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5957 #: ../src/guestfs-actions.pod:117
5958 msgid "guestfs_add_drive"
5962 #: ../src/guestfs-actions.pod:119
5966 " guestfs_add_drive (guestfs_h *g,\n"
5967 " const char *filename);\n"
5972 #: ../src/guestfs-actions.pod:123
5974 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5975 "optional parameters, so the disk is added writable, with the format being "
5976 "detected automatically."
5980 #: ../src/guestfs-actions.pod:127
5982 "Automatic detection of the format opens you up to a potential security hole "
5983 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5984 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5985 "you should think about replacing calls to this function with calls to "
5986 "C<guestfs_add_drive_opts>, and specifying the format."
5990 #: ../src/guestfs-actions.pod:138
5991 msgid "guestfs_add_drive_opts"
5995 #: ../src/guestfs-actions.pod:140
5999 " guestfs_add_drive_opts (guestfs_h *g,\n"
6000 " const char *filename,\n"
6006 #: ../src/guestfs-actions.pod:150
6009 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6010 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6011 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6016 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6018 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6019 "The first time you call this function, the disk appears as C</dev/sda>, the "
6020 "second time as C</dev/sdb>, and so on."
6024 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6026 "You don't necessarily need to be root when using libguestfs. However you "
6027 "obviously do need sufficient permissions to access the filename for whatever "
6028 "operations you want to perform (ie. read access if you just want to read the "
6029 "image or write access if you want to modify the image)."
6033 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6034 msgid "This call checks that C<filename> exists."
6038 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3019
6039 msgid "The optional arguments are:"
6043 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6048 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6050 "If true then the image is treated as read-only. Writes are still allowed, "
6051 "but they are stored in a temporary snapshot overlay which is discarded at "
6052 "the end. The disk that you add is not modified."
6056 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6061 #: ../src/guestfs-actions.pod:179
6063 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6064 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6065 "Possible formats include C<raw> and C<qcow2>."
6069 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6071 "Automatic detection of the format opens you up to a potential security hole "
6072 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6073 "RHBZ#642934. Specifying the format closes this security hole."
6077 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6082 #: ../src/guestfs-actions.pod:190
6084 "This rarely-used option lets you emulate the behaviour of the deprecated "
6085 "C<guestfs_add_drive_with_if> call (q.v.)"
6089 #: ../src/guestfs-actions.pod:197
6090 msgid "(Added in 1.5.23)"
6094 #: ../src/guestfs-actions.pod:199
6095 msgid "guestfs_add_drive_opts_va"
6099 #: ../src/guestfs-actions.pod:201
6103 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6104 " const char *filename,\n"
6110 #: ../src/guestfs-actions.pod:206
6111 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6115 #: ../src/guestfs-actions.pod:210
6116 msgid "guestfs_add_drive_opts_argv"
6120 #: ../src/guestfs-actions.pod:212
6124 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6125 " const char *filename,\n"
6126 " const struct guestfs_add_drive_opts_argv "
6132 #: ../src/guestfs-actions.pod:217
6133 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6137 #: ../src/guestfs-actions.pod:221
6138 msgid "guestfs_add_drive_ro"
6142 #: ../src/guestfs-actions.pod:223
6146 " guestfs_add_drive_ro (guestfs_h *g,\n"
6147 " const char *filename);\n"
6152 #: ../src/guestfs-actions.pod:227
6154 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6155 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6156 "disk is added read-only, with the format being detected automatically."
6160 #: ../src/guestfs-actions.pod:234
6161 msgid "(Added in 1.0.38)"
6165 #: ../src/guestfs-actions.pod:236
6166 msgid "guestfs_add_drive_ro_with_if"
6170 #: ../src/guestfs-actions.pod:238
6174 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6175 " const char *filename,\n"
6176 " const char *iface);\n"
6181 #: ../src/guestfs-actions.pod:243
6183 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6184 "QEMU interface emulation to use at run time."
6188 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2356
6189 msgid "(Added in 1.0.84)"
6193 #: ../src/guestfs-actions.pod:257
6194 msgid "guestfs_add_drive_with_if"
6198 #: ../src/guestfs-actions.pod:259
6202 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6203 " const char *filename,\n"
6204 " const char *iface);\n"
6209 #: ../src/guestfs-actions.pod:264
6211 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6212 "QEMU interface emulation to use at run time."
6216 #: ../src/guestfs-actions.pod:278
6217 msgid "guestfs_aug_clear"
6221 #: ../src/guestfs-actions.pod:280
6225 " guestfs_aug_clear (guestfs_h *g,\n"
6226 " const char *augpath);\n"
6231 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6233 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6234 "L<augtool(1)> C<clear> command."
6238 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6239 msgid "(Added in 1.3.4)"
6243 #: ../src/guestfs-actions.pod:291
6244 msgid "guestfs_aug_close"
6248 #: ../src/guestfs-actions.pod:293
6252 " guestfs_aug_close (guestfs_h *g);\n"
6257 #: ../src/guestfs-actions.pod:296
6259 "Close the current Augeas handle and free up any resources used by it. After "
6260 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6261 "any other Augeas functions."
6265 #: ../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:5480
6266 msgid "(Added in 0.7)"
6270 #: ../src/guestfs-actions.pod:305
6271 msgid "guestfs_aug_defnode"
6275 #: ../src/guestfs-actions.pod:307
6278 " struct guestfs_int_bool *\n"
6279 " guestfs_aug_defnode (guestfs_h *g,\n"
6280 " const char *name,\n"
6281 " const char *expr,\n"
6282 " const char *val);\n"
6287 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6288 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6292 #: ../src/guestfs-actions.pod:316
6294 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6295 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6296 "containing that single node."
6300 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6302 "On success this returns a pair containing the number of nodes in the "
6303 "nodeset, and a boolean flag if a node was created."
6307 #: ../src/guestfs-actions.pod:324
6309 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6310 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6314 #: ../src/guestfs-actions.pod:330
6315 msgid "guestfs_aug_defvar"
6319 #: ../src/guestfs-actions.pod:332
6323 " guestfs_aug_defvar (guestfs_h *g,\n"
6324 " const char *name,\n"
6325 " const char *expr);\n"
6330 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6332 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6333 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6337 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6339 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6340 "evaluates to something which is not a nodeset."
6344 #: ../src/guestfs-actions.pod:348
6345 msgid "guestfs_aug_get"
6349 #: ../src/guestfs-actions.pod:350
6353 " guestfs_aug_get (guestfs_h *g,\n"
6354 " const char *augpath);\n"
6359 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6361 "Look up the value associated with C<path>. If C<path> matches exactly one "
6362 "node, the C<value> is returned."
6366 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354 ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:6217 ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6985 ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7437
6368 "This function returns a string, or NULL on error. I<The caller must free "
6369 "the returned string after use>."
6373 #: ../src/guestfs-actions.pod:362
6374 msgid "guestfs_aug_init"
6378 #: ../src/guestfs-actions.pod:364
6382 " guestfs_aug_init (guestfs_h *g,\n"
6383 " const char *root,\n"
6389 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6391 "Create a new Augeas handle for editing configuration files. If there was "
6392 "any previous Augeas handle associated with this guestfs session, then it is "
6397 #: ../src/guestfs-actions.pod:373
6398 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6402 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6403 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6407 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6409 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6410 "logical I<or> of the following integers:"
6414 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6415 msgid "C<AUG_SAVE_BACKUP> = 1"
6419 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6420 msgid "Keep the original file with a C<.augsave> extension."
6424 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6425 msgid "C<AUG_SAVE_NEWFILE> = 2"
6429 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6431 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6432 "original. Overrides C<AUG_SAVE_BACKUP>."
6436 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6437 msgid "C<AUG_TYPE_CHECK> = 4"
6441 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6442 msgid "Typecheck lenses (can be expensive)."
6446 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6447 msgid "C<AUG_NO_STDINC> = 8"
6451 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6452 msgid "Do not use standard load path for modules."
6456 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6457 msgid "C<AUG_SAVE_NOOP> = 16"
6461 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6462 msgid "Make save a no-op, just record what would have been changed."
6466 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6467 msgid "C<AUG_NO_LOAD> = 32"
6471 #: ../src/guestfs-actions.pod:408
6472 msgid "Do not load the tree in C<guestfs_aug_init>."
6476 #: ../src/guestfs-actions.pod:412
6477 msgid "To close the handle, you can call C<guestfs_aug_close>."
6481 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6482 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6486 #: ../src/guestfs-actions.pod:420
6487 msgid "guestfs_aug_insert"
6491 #: ../src/guestfs-actions.pod:422
6495 " guestfs_aug_insert (guestfs_h *g,\n"
6496 " const char *augpath,\n"
6497 " const char *label,\n"
6503 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6505 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6506 "or after C<path> (depending on the boolean flag C<before>)."
6510 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6512 "C<path> must match exactly one existing node in the tree, and C<label> must "
6513 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6517 #: ../src/guestfs-actions.pod:440
6518 msgid "guestfs_aug_load"
6522 #: ../src/guestfs-actions.pod:442
6526 " guestfs_aug_load (guestfs_h *g);\n"
6531 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6532 msgid "Load files into the tree."
6536 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6537 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6541 #: ../src/guestfs-actions.pod:454
6542 msgid "guestfs_aug_ls"
6546 #: ../src/guestfs-actions.pod:456
6550 " guestfs_aug_ls (guestfs_h *g,\n"
6551 " const char *augpath);\n"
6556 #: ../src/guestfs-actions.pod:460
6558 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6559 "sorting the resulting nodes into alphabetical order."
6563 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388 ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4830 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6406 ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6576 ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7290 ../src/guestfs-actions.pod:7309 ../src/guestfs-actions.pod:7394 ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7478
6565 "This function returns a NULL-terminated array of strings (like "
6566 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6567 "strings and the array after use>."
6571 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4023 ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5686 ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6790 ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:7042 ../src/guestfs-actions.pod:7278
6572 msgid "(Added in 0.8)"
6576 #: ../src/guestfs-actions.pod:469
6577 msgid "guestfs_aug_match"
6581 #: ../src/guestfs-actions.pod:471
6585 " guestfs_aug_match (guestfs_h *g,\n"
6586 " const char *augpath);\n"
6591 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6593 "Returns a list of paths which match the path expression C<path>. The "
6594 "returned paths are sufficiently qualified so that they match exactly one "
6595 "node in the current tree."
6599 #: ../src/guestfs-actions.pod:485
6600 msgid "guestfs_aug_mv"
6604 #: ../src/guestfs-actions.pod:487
6608 " guestfs_aug_mv (guestfs_h *g,\n"
6609 " const char *src,\n"
6610 " const char *dest);\n"
6615 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6617 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6618 "C<dest> is overwritten if it exists."
6622 #: ../src/guestfs-actions.pod:499
6623 msgid "guestfs_aug_rm"
6627 #: ../src/guestfs-actions.pod:501
6631 " guestfs_aug_rm (guestfs_h *g,\n"
6632 " const char *augpath);\n"
6637 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6638 msgid "Remove C<path> and all of its children."
6642 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6643 msgid "On success this returns the number of entries which were removed."
6647 #: ../src/guestfs-actions.pod:513
6648 msgid "guestfs_aug_save"
6652 #: ../src/guestfs-actions.pod:515
6656 " guestfs_aug_save (guestfs_h *g);\n"
6661 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6662 msgid "This writes all pending changes to disk."
6666 #: ../src/guestfs-actions.pod:520
6668 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6673 #: ../src/guestfs-actions.pod:527
6674 msgid "guestfs_aug_set"
6678 #: ../src/guestfs-actions.pod:529
6682 " guestfs_aug_set (guestfs_h *g,\n"
6683 " const char *augpath,\n"
6684 " const char *val);\n"
6689 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6690 msgid "Set the value associated with C<path> to C<val>."
6694 #: ../src/guestfs-actions.pod:536
6696 "In the Augeas API, it is possible to clear a node by setting the value to "
6697 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6698 "this call. Instead you must use the C<guestfs_aug_clear> call."
6702 #: ../src/guestfs-actions.pod:545
6703 msgid "guestfs_available"
6707 #: ../src/guestfs-actions.pod:547
6711 " guestfs_available (guestfs_h *g,\n"
6712 " char *const *groups);\n"
6717 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6719 "This command is used to check the availability of some groups of "
6720 "functionality in the appliance, which not all builds of the libguestfs "
6721 "appliance will be able to provide."
6725 #: ../src/guestfs-actions.pod:555
6727 "The libguestfs groups, and the functions that those groups correspond to, "
6728 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6729 "runtime by calling C<guestfs_available_all_groups>."
6733 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6735 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6736 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6737 "and Augeas (configuration file editing) functions."
6741 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6742 msgid "The command returns no error if I<all> requested groups are available."
6746 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6748 "It fails with an error if one or more of the requested groups is unavailable "
6753 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6755 "If an unknown group name is included in the list of groups then an error is "
6760 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6765 #: ../src/guestfs-actions.pod:579
6766 msgid "You must call C<guestfs_launch> before calling this function."
6770 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6772 "The reason is because we don't know what groups are supported by the "
6773 "appliance/daemon until it is running and can be queried."
6777 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6779 "If a group of functions is available, this does not necessarily mean that "
6780 "they will work. You still have to check for errors when calling individual "
6781 "API functions even if they are available."
6785 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6787 "It is usually the job of distro packagers to build complete functionality "
6788 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6789 "with all requirements satisfied, will support everything."
6793 #: ../src/guestfs-actions.pod:601
6795 "This call was added in version C<1.0.80>. In previous versions of "
6796 "libguestfs all you could do would be to speculatively execute a command to "
6797 "find out if the daemon implemented it. See also C<guestfs_version>."
6801 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6802 msgid "(Added in 1.0.80)"
6806 #: ../src/guestfs-actions.pod:612
6807 msgid "guestfs_available_all_groups"
6811 #: ../src/guestfs-actions.pod:614
6815 " guestfs_available_all_groups (guestfs_h *g);\n"
6820 #: ../src/guestfs-actions.pod:617
6822 "This command returns a list of all optional groups that this daemon knows "
6823 "about. Note this returns both supported and unsupported groups. To find "
6824 "out which ones the daemon can actually support you have to call "
6825 "C<guestfs_available> on each member of the returned list."
6829 #: ../src/guestfs-actions.pod:623
6830 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6834 #: ../src/guestfs-actions.pod:629
6835 msgid "(Added in 1.3.15)"
6839 #: ../src/guestfs-actions.pod:631
6840 msgid "guestfs_base64_in"
6844 #: ../src/guestfs-actions.pod:633
6848 " guestfs_base64_in (guestfs_h *g,\n"
6849 " const char *base64file,\n"
6850 " const char *filename);\n"
6855 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6856 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6860 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6861 msgid "(Added in 1.3.5)"
6865 #: ../src/guestfs-actions.pod:645
6866 msgid "guestfs_base64_out"
6870 #: ../src/guestfs-actions.pod:647
6874 " guestfs_base64_out (guestfs_h *g,\n"
6875 " const char *filename,\n"
6876 " const char *base64file);\n"
6881 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6883 "This command downloads the contents of C<filename>, writing it out to local "
6884 "file C<base64file> encoded as base64."
6888 #: ../src/guestfs-actions.pod:659
6889 msgid "guestfs_blockdev_flushbufs"
6893 #: ../src/guestfs-actions.pod:661
6897 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6898 " const char *device);\n"
6903 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6904 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6908 #: ../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
6909 msgid "This uses the L<blockdev(8)> command."
6913 #: ../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
6914 msgid "(Added in 0.9.3)"
6918 #: ../src/guestfs-actions.pod:674
6919 msgid "guestfs_blockdev_getbsz"
6923 #: ../src/guestfs-actions.pod:676
6927 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6928 " const char *device);\n"
6933 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6934 msgid "This returns the block size of a device."
6938 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6940 "(Note this is different from both I<size in blocks> and I<filesystem block "
6945 #: ../src/guestfs-actions.pod:691
6946 msgid "guestfs_blockdev_getro"
6950 #: ../src/guestfs-actions.pod:693
6954 " guestfs_blockdev_getro (guestfs_h *g,\n"
6955 " const char *device);\n"
6960 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6962 "Returns a boolean indicating if the block device is read-only (true if "
6963 "read-only, false if not)."
6967 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914 ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3433 ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:4979
6968 msgid "This function returns a C truth value on success or -1 on error."
6972 #: ../src/guestfs-actions.pod:706
6973 msgid "guestfs_blockdev_getsize64"
6977 #: ../src/guestfs-actions.pod:708
6981 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6982 " const char *device);\n"
6987 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
6988 msgid "This returns the size of the device in bytes."
6992 #: ../src/guestfs-actions.pod:714
6993 msgid "See also C<guestfs_blockdev_getsz>."
6997 #: ../src/guestfs-actions.pod:722
6998 msgid "guestfs_blockdev_getss"
7002 #: ../src/guestfs-actions.pod:724
7006 " guestfs_blockdev_getss (guestfs_h *g,\n"
7007 " const char *device);\n"
7012 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7014 "This returns the size of sectors on a block device. Usually 512, but can be "
7015 "larger for modern devices."
7019 #: ../src/guestfs-actions.pod:731
7021 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7026 #: ../src/guestfs-actions.pod:740
7027 msgid "guestfs_blockdev_getsz"
7031 #: ../src/guestfs-actions.pod:742
7035 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7036 " const char *device);\n"
7041 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7043 "This returns the size of the device in units of 512-byte sectors (even if "
7044 "the sectorsize isn't 512 bytes ... weird)."
7048 #: ../src/guestfs-actions.pod:749
7050 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7051 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7055 #: ../src/guestfs-actions.pod:759
7056 msgid "guestfs_blockdev_rereadpt"
7060 #: ../src/guestfs-actions.pod:761
7064 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7065 " const char *device);\n"
7070 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7071 msgid "Reread the partition table on C<device>."
7075 #: ../src/guestfs-actions.pod:773
7076 msgid "guestfs_blockdev_setbsz"
7080 #: ../src/guestfs-actions.pod:775
7084 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7085 " const char *device,\n"
7086 " int blocksize);\n"
7091 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7092 msgid "This sets the block size of a device."
7096 #: ../src/guestfs-actions.pod:791
7097 msgid "guestfs_blockdev_setro"
7101 #: ../src/guestfs-actions.pod:793
7105 " guestfs_blockdev_setro (guestfs_h *g,\n"
7106 " const char *device);\n"
7111 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7112 msgid "Sets the block device named C<device> to read-only."
7116 #: ../src/guestfs-actions.pod:805
7117 msgid "guestfs_blockdev_setrw"
7121 #: ../src/guestfs-actions.pod:807
7125 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7126 " const char *device);\n"
7131 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7132 msgid "Sets the block device named C<device> to read-write."
7136 #: ../src/guestfs-actions.pod:819
7137 msgid "guestfs_case_sensitive_path"
7141 #: ../src/guestfs-actions.pod:821
7145 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7146 " const char *path);\n"
7151 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7153 "This can be used to resolve case insensitive paths on a filesystem which is "
7154 "case sensitive. The use case is to resolve paths which you have read from "
7155 "Windows configuration files or the Windows Registry, to the true path."
7159 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7161 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7162 "(and probably others), which is that although the underlying filesystem is "
7163 "case-insensitive, the driver exports the filesystem to Linux as "
7168 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7170 "One consequence of this is that special directories such as C<c:\\windows> "
7171 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7172 "precise details of how they were created. In Windows itself this would not "
7177 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7179 "Bug or feature? You decide: "
7180 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7184 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7186 "This function resolves the true case of each element in the path and returns "
7187 "the case-sensitive path."
7191 #: ../src/guestfs-actions.pod:847
7193 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7194 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7195 "how the directories were originally created under Windows)."
7199 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7200 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7204 #: ../src/guestfs-actions.pod:855
7205 msgid "See also C<guestfs_realpath>."
7209 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6970
7210 msgid "(Added in 1.0.75)"
7214 #: ../src/guestfs-actions.pod:862
7219 #: ../src/guestfs-actions.pod:864
7223 " guestfs_cat (guestfs_h *g,\n"
7224 " const char *path);\n"
7229 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5466 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3667
7230 msgid "Return the contents of the file named C<path>."
7234 #: ../src/guestfs-actions.pod:870
7236 "Note that this function cannot correctly handle binary files (specifically, "
7237 "files containing C<\\0> character which is treated as end of string). For "
7238 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7239 "functions which have a more complex interface."
7243 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495 ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6556 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:7242 ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7294 ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7398 ../src/guestfs-actions.pod:7417 ../src/guestfs-actions.pod:7463 ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:587 ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734 ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920 ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493 ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556 ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3537 ../fish/guestfish-actions.pod:3552 ../fish/guestfish-actions.pod:3628 ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660 ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4332 ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:4842 ../fish/guestfish-actions.pod:4860 ../fish/guestfish-actions.pod:4877 ../fish/guestfish-actions.pod:4887 ../fish/guestfish-actions.pod:4935 ../fish/guestfish-actions.pod:4945 ../fish/guestfish-actions.pod:4974 ../fish/guestfish-actions.pod:4984
7245 "Because of the message protocol, there is a transfer limit of somewhere "
7246 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7250 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:7129 ../src/guestfs-actions.pod:7143
7251 msgid "(Added in 0.4)"
7255 #: ../src/guestfs-actions.pod:883
7256 msgid "guestfs_checksum"
7260 #: ../src/guestfs-actions.pod:885
7264 " guestfs_checksum (guestfs_h *g,\n"
7265 " const char *csumtype,\n"
7266 " const char *path);\n"
7271 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7272 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7276 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7278 "The type of checksum to compute is given by the C<csumtype> parameter which "
7279 "must have one of the following values:"
7283 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7288 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7290 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7295 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7300 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7301 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7305 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7310 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7311 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7315 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7320 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7321 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7325 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7330 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7331 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7335 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7340 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7341 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7345 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7350 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7351 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7355 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7356 msgid "The checksum is returned as a printable string."
7360 #: ../src/guestfs-actions.pod:931
7361 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7365 #: ../src/guestfs-actions.pod:933
7366 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7370 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:6826
7371 msgid "(Added in 1.0.2)"
7375 #: ../src/guestfs-actions.pod:940
7376 msgid "guestfs_checksum_device"
7380 #: ../src/guestfs-actions.pod:942
7384 " guestfs_checksum_device (guestfs_h *g,\n"
7385 " const char *csumtype,\n"
7386 " const char *device);\n"
7391 #: ../src/guestfs-actions.pod:947
7393 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7394 "device named C<device>. For the types of checksums supported see the "
7395 "C<guestfs_checksum> command."
7399 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4885 ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4981 ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6749 ../src/guestfs-actions.pod:7155
7400 msgid "(Added in 1.3.2)"
7404 #: ../src/guestfs-actions.pod:956
7405 msgid "guestfs_checksums_out"
7409 #: ../src/guestfs-actions.pod:958
7413 " guestfs_checksums_out (guestfs_h *g,\n"
7414 " const char *csumtype,\n"
7415 " const char *directory,\n"
7416 " const char *sumsfile);\n"
7421 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7423 "This command computes the checksums of all regular files in C<directory> and "
7424 "then emits a list of those checksums to the local output file C<sumsfile>."
7428 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7430 "This can be used for verifying the integrity of a virtual machine. However "
7431 "to be properly secure you should pay attention to the output of the checksum "
7432 "command (it uses the ones from GNU coreutils). In particular when the "
7433 "filename is not printable, coreutils uses a special backslash syntax. For "
7434 "more information, see the GNU coreutils info file."
7438 #: ../src/guestfs-actions.pod:978
7439 msgid "(Added in 1.3.7)"
7443 #: ../src/guestfs-actions.pod:980
7444 msgid "guestfs_chmod"
7448 #: ../src/guestfs-actions.pod:982
7452 " guestfs_chmod (guestfs_h *g,\n"
7454 " const char *path);\n"
7459 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7461 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7466 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7468 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7469 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7474 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2983 ../fish/guestfish-actions.pod:3112 ../fish/guestfish-actions.pod:3122 ../fish/guestfish-actions.pod:3132
7475 msgid "The mode actually set is affected by the umask."
7479 #: ../src/guestfs-actions.pod:1000
7480 msgid "guestfs_chown"
7484 #: ../src/guestfs-actions.pod:1002
7488 " guestfs_chown (guestfs_h *g,\n"
7491 " const char *path);\n"
7496 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7497 msgid "Change the file owner to C<owner> and group to C<group>."
7501 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3495 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2441
7503 "Only numeric uid and gid are supported. If you want to use names, you will "
7504 "need to locate and parse the password file yourself (Augeas support makes "
7505 "this relatively easy)."
7509 #: ../src/guestfs-actions.pod:1018
7510 msgid "guestfs_command"
7514 #: ../src/guestfs-actions.pod:1020
7518 " guestfs_command (guestfs_h *g,\n"
7519 " char *const *arguments);\n"
7524 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7526 "This call runs a command from the guest filesystem. The filesystem must be "
7527 "mounted, and must contain a compatible operating system (ie. something "
7528 "Linux, with the same or compatible processor architecture)."
7532 #: ../src/guestfs-actions.pod:1029
7534 "The single parameter is an argv-style list of arguments. The first element "
7535 "is the name of the program to run. Subsequent elements are parameters. The "
7536 "list must be non-empty (ie. must contain a program name). Note that the "
7537 "command runs directly, and is I<not> invoked via the shell (see "
7542 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7543 msgid "The return value is anything printed to I<stdout> by the command."
7547 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7549 "If the command returns a non-zero exit status, then this function returns an "
7550 "error message. The error message string is the content of I<stderr> from "
7555 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7557 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7558 "C</bin>. If you require a program from another location, you should provide "
7559 "the full path in the first parameter."
7563 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7565 "Shared libraries and data files required by the program must be available on "
7566 "filesystems which are mounted in the correct places. It is the caller's "
7567 "responsibility to ensure all filesystems that are needed are mounted at the "
7572 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1548
7573 msgid "(Added in 0.9.1)"
7577 #: ../src/guestfs-actions.pod:1062
7578 msgid "guestfs_command_lines"
7582 #: ../src/guestfs-actions.pod:1064
7586 " guestfs_command_lines (guestfs_h *g,\n"
7587 " char *const *arguments);\n"
7592 #: ../src/guestfs-actions.pod:1068
7594 "This is the same as C<guestfs_command>, but splits the result into a list of "
7599 #: ../src/guestfs-actions.pod:1071
7600 msgid "See also: C<guestfs_sh_lines>"
7604 #: ../src/guestfs-actions.pod:1082
7605 msgid "guestfs_config"
7609 #: ../src/guestfs-actions.pod:1084
7613 " guestfs_config (guestfs_h *g,\n"
7614 " const char *qemuparam,\n"
7615 " const char *qemuvalue);\n"
7620 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7622 "This can be used to add arbitrary qemu command line parameters of the form "
7623 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7624 "setting some parameters which would interfere with parameters that we use."
7628 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7629 msgid "The first character of C<param> string must be a C<-> (dash)."
7633 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7634 msgid "C<value> can be NULL."
7638 #: ../src/guestfs-actions.pod:1102
7639 msgid "guestfs_copy_size"
7643 #: ../src/guestfs-actions.pod:1104
7647 " guestfs_copy_size (guestfs_h *g,\n"
7648 " const char *src,\n"
7649 " const char *dest,\n"
7655 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7657 "This command copies exactly C<size> bytes from one source device or file "
7658 "C<src> to another destination device or file C<dest>."
7662 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7664 "Note this will fail if the source is too short or if the destination is not "
7669 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:7334 ../src/guestfs-actions.pod:7353
7671 "This long-running command can generate progress notification messages so "
7672 "that the caller can display a progress bar or indicator. To receive these "
7673 "messages, the caller must register a progress event callback. See "
7674 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7678 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7062 ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7168
7679 msgid "(Added in 1.0.87)"
7683 #: ../src/guestfs-actions.pod:1125
7688 #: ../src/guestfs-actions.pod:1127
7692 " guestfs_cp (guestfs_h *g,\n"
7693 " const char *src,\n"
7694 " const char *dest);\n"
7699 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7701 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7702 "destination filename or destination directory."
7706 #: ../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:4848 ../src/guestfs-actions.pod:5225
7707 msgid "(Added in 1.0.18)"
7711 #: ../src/guestfs-actions.pod:1139
7712 msgid "guestfs_cp_a"
7716 #: ../src/guestfs-actions.pod:1141
7720 " guestfs_cp_a (guestfs_h *g,\n"
7721 " const char *src,\n"
7722 " const char *dest);\n"
7727 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7729 "This copies a file or directory from C<src> to C<dest> recursively using the "
7734 #: ../src/guestfs-actions.pod:1153
7739 #: ../src/guestfs-actions.pod:1155
7743 " guestfs_dd (guestfs_h *g,\n"
7744 " const char *src,\n"
7745 " const char *dest);\n"
7750 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7752 "This command copies from one source device or file C<src> to another "
7753 "destination device or file C<dest>. Normally you would use this to copy to "
7754 "or from a device or partition, for example to duplicate a filesystem."
7758 #: ../src/guestfs-actions.pod:1165
7760 "If the destination is a device, it must be as large or larger than the "
7761 "source file or device, otherwise the copy will fail. This command cannot do "
7762 "partial copies (see C<guestfs_copy_size>)."
7766 #: ../src/guestfs-actions.pod:1173
7771 #: ../src/guestfs-actions.pod:1175
7775 " guestfs_df (guestfs_h *g);\n"
7780 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7781 msgid "This command runs the C<df> command to report disk space used."
7785 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7787 "This command is mostly useful for interactive sessions. It is I<not> "
7788 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7793 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7214 ../src/guestfs-actions.pod:7227
7794 msgid "(Added in 1.0.54)"
7798 #: ../src/guestfs-actions.pod:1189
7799 msgid "guestfs_df_h"
7803 #: ../src/guestfs-actions.pod:1191
7807 " guestfs_df_h (guestfs_h *g);\n"
7812 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7814 "This command runs the C<df -h> command to report disk space used in "
7815 "human-readable format."
7819 #: ../src/guestfs-actions.pod:1206
7820 msgid "guestfs_dmesg"
7824 #: ../src/guestfs-actions.pod:1208
7828 " guestfs_dmesg (guestfs_h *g);\n"
7833 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7835 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7836 "This is sometimes useful for extended debugging of problems."
7840 #: ../src/guestfs-actions.pod:1215
7842 "Another way to get the same information is to enable verbose messages with "
7843 "C<guestfs_set_verbose> or by setting the environment variable "
7844 "C<LIBGUESTFS_DEBUG=1> before running the program."
7848 #: ../src/guestfs-actions.pod:1225
7849 msgid "guestfs_download"
7853 #: ../src/guestfs-actions.pod:1227
7857 " guestfs_download (guestfs_h *g,\n"
7858 " const char *remotefilename,\n"
7859 " const char *filename);\n"
7864 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7866 "Download file C<remotefilename> and save it as C<filename> on the local "
7871 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6815 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4590
7872 msgid "C<filename> can also be a named pipe."
7876 #: ../src/guestfs-actions.pod:1237
7877 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7881 #: ../src/guestfs-actions.pod:1248
7882 msgid "guestfs_download_offset"
7886 #: ../src/guestfs-actions.pod:1250
7890 " guestfs_download_offset (guestfs_h *g,\n"
7891 " const char *remotefilename,\n"
7892 " const char *filename,\n"
7893 " int64_t offset,\n"
7899 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7901 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7902 "region must be within the file or device)."
7906 #: ../src/guestfs-actions.pod:1263
7908 "Note that there is no limit on the amount of data that can be downloaded "
7909 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7910 "full amount unless an error occurs."
7914 #: ../src/guestfs-actions.pod:1268
7915 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7919 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6860
7920 msgid "(Added in 1.5.17)"
7924 #: ../src/guestfs-actions.pod:1279
7925 msgid "guestfs_drop_caches"
7929 #: ../src/guestfs-actions.pod:1281
7933 " guestfs_drop_caches (guestfs_h *g,\n"
7934 " int whattodrop);\n"
7939 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7941 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7942 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7943 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7947 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7948 msgid "Setting C<whattodrop> to 3 should drop everything."
7952 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7954 "This automatically calls L<sync(2)> before the operation, so that the "
7955 "maximum guest memory is freed."
7959 #: ../src/guestfs-actions.pod:1299
7964 #: ../src/guestfs-actions.pod:1301
7968 " guestfs_du (guestfs_h *g,\n"
7969 " const char *path);\n"
7974 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7976 "This command runs the C<du -s> command to estimate file space usage for "
7981 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7983 "C<path> can be a file or a directory. If C<path> is a directory then the "
7984 "estimate includes the contents of the directory and all subdirectories "
7989 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
7990 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7994 #: ../src/guestfs-actions.pod:1324
7995 msgid "guestfs_e2fsck_f"
7999 #: ../src/guestfs-actions.pod:1326
8003 " guestfs_e2fsck_f (guestfs_h *g,\n"
8004 " const char *device);\n"
8009 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8011 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8012 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8017 #: ../src/guestfs-actions.pod:1334
8019 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8020 "Normally you should use C<guestfs_fsck>."
8024 #: ../src/guestfs-actions.pod:1339
8025 msgid "(Added in 1.0.29)"
8029 #: ../src/guestfs-actions.pod:1341
8030 msgid "guestfs_echo_daemon"
8034 #: ../src/guestfs-actions.pod:1343
8038 " guestfs_echo_daemon (guestfs_h *g,\n"
8039 " char *const *words);\n"
8044 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8046 "This command concatenates the list of C<words> passed with single spaces "
8047 "between them and returns the resulting string."
8051 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8052 msgid "You can use this command to test the connection through to the daemon."
8056 #: ../src/guestfs-actions.pod:1352
8057 msgid "See also C<guestfs_ping_daemon>."
8061 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6059
8062 msgid "(Added in 1.0.69)"
8066 #: ../src/guestfs-actions.pod:1359
8067 msgid "guestfs_egrep"
8071 #: ../src/guestfs-actions.pod:1361
8075 " guestfs_egrep (guestfs_h *g,\n"
8076 " const char *regex,\n"
8077 " const char *path);\n"
8082 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8083 msgid "This calls the external C<egrep> program and returns the matching lines."
8087 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395 ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427 ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6465 ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485
8088 msgid "(Added in 1.0.66)"
8092 #: ../src/guestfs-actions.pod:1378
8093 msgid "guestfs_egrepi"
8097 #: ../src/guestfs-actions.pod:1380
8101 " guestfs_egrepi (guestfs_h *g,\n"
8102 " const char *regex,\n"
8103 " const char *path);\n"
8108 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8109 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8113 #: ../src/guestfs-actions.pod:1397
8114 msgid "guestfs_equal"
8118 #: ../src/guestfs-actions.pod:1399
8122 " guestfs_equal (guestfs_h *g,\n"
8123 " const char *file1,\n"
8124 " const char *file2);\n"
8129 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8131 "This compares the two files C<file1> and C<file2> and returns true if their "
8132 "content is exactly equal, or false otherwise."
8136 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8137 msgid "The external L<cmp(1)> program is used for the comparison."
8141 #: ../src/guestfs-actions.pod:1413
8142 msgid "guestfs_exists"
8146 #: ../src/guestfs-actions.pod:1415
8150 " guestfs_exists (guestfs_h *g,\n"
8151 " const char *path);\n"
8156 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8158 "This returns C<true> if and only if there is a file, directory (or anything) "
8159 "with the given C<path> name."
8163 #: ../src/guestfs-actions.pod:1422
8164 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8168 #: ../src/guestfs-actions.pod:1428
8169 msgid "guestfs_fallocate"
8173 #: ../src/guestfs-actions.pod:1430
8177 " guestfs_fallocate (guestfs_h *g,\n"
8178 " const char *path,\n"
8184 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8186 "This command preallocates a file (containing zero bytes) named C<path> of "
8187 "size C<len> bytes. If the file exists already, it is overwritten."
8191 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8193 "Do not confuse this with the guestfish-specific C<alloc> command which "
8194 "allocates a file in the host and attaches it as a device."
8198 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8200 "This function is deprecated. In new code, use the C<fallocate64> call "
8205 #: ../src/guestfs-actions.pod:1454
8206 msgid "guestfs_fallocate64"
8210 #: ../src/guestfs-actions.pod:1456
8214 " guestfs_fallocate64 (guestfs_h *g,\n"
8215 " const char *path,\n"
8221 #: ../src/guestfs-actions.pod:1465
8223 "Note that this call allocates disk blocks for the file. To create a sparse "
8224 "file use C<guestfs_truncate_size> instead."
8228 #: ../src/guestfs-actions.pod:1468
8230 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8231 "oversight it only allowed 30 bit lengths to be specified, effectively "
8232 "limiting the maximum size of files created through that call to 1GB."
8236 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8238 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8239 "commands which create a file in the host and attach it as a device."
8243 #: ../src/guestfs-actions.pod:1479
8244 msgid "(Added in 1.3.17)"
8248 #: ../src/guestfs-actions.pod:1481
8249 msgid "guestfs_fgrep"
8253 #: ../src/guestfs-actions.pod:1483
8257 " guestfs_fgrep (guestfs_h *g,\n"
8258 " const char *pattern,\n"
8259 " const char *path);\n"
8264 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8265 msgid "This calls the external C<fgrep> program and returns the matching lines."
8269 #: ../src/guestfs-actions.pod:1500
8270 msgid "guestfs_fgrepi"
8274 #: ../src/guestfs-actions.pod:1502
8278 " guestfs_fgrepi (guestfs_h *g,\n"
8279 " const char *pattern,\n"
8280 " const char *path);\n"
8285 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8286 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8290 #: ../src/guestfs-actions.pod:1519
8291 msgid "guestfs_file"
8295 #: ../src/guestfs-actions.pod:1521
8299 " guestfs_file (guestfs_h *g,\n"
8300 " const char *path);\n"
8305 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8307 "This call uses the standard L<file(1)> command to determine the type or "
8308 "contents of the file."
8312 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8314 "This call will also transparently look inside various types of compressed "
8319 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8321 "The exact command which runs is C<file -zb path>. Note in particular that "
8322 "the filename is not prepended to the output (the I<-b> option)."
8326 #: ../src/guestfs-actions.pod:1535
8328 "This command can also be used on C</dev/> devices (and partitions, LV "
8329 "names). You can for example use this to determine if a device contains a "
8330 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8334 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8336 "If the C<path> does not begin with C</dev/> then this command only works for "
8337 "the content of regular files. For other file types (directory, symbolic "
8338 "link etc) it will just return the string C<directory> etc."
8342 #: ../src/guestfs-actions.pod:1550
8343 msgid "guestfs_file_architecture"
8347 #: ../src/guestfs-actions.pod:1552
8351 " guestfs_file_architecture (guestfs_h *g,\n"
8352 " const char *filename);\n"
8357 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8359 "This detects the architecture of the binary C<filename>, and returns it if "
8364 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8365 msgid "Currently defined architectures are:"
8369 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8374 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8376 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8377 "irrespective of the precise processor requirements of the binary."
8381 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8386 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8387 msgid "64 bit x86-64."
8391 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8396 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8397 msgid "32 bit SPARC."
8401 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8406 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8407 msgid "64 bit SPARC V9 and above."
8411 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8416 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8417 msgid "Intel Itanium."
8421 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8426 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8427 msgid "32 bit Power PC."
8431 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8436 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8437 msgid "64 bit Power PC."
8441 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8442 msgid "Libguestfs may return other architecture strings in future."
8446 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8447 msgid "The function works on at least the following types of files:"
8451 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8452 msgid "many types of Un*x and Linux binary"
8456 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8457 msgid "many types of Un*x and Linux shared library"
8461 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8462 msgid "Windows Win32 and Win64 binaries"
8466 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8467 msgid "Windows Win32 and Win64 DLLs"
8471 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8472 msgid "Win32 binaries and DLLs return C<i386>."
8476 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8477 msgid "Win64 binaries and DLLs return C<x86_64>."
8481 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8482 msgid "Linux kernel modules"
8486 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8487 msgid "Linux new-style initrd images"
8491 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8492 msgid "some non-x86 Linux vmlinuz kernels"
8496 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8497 msgid "What it can't do currently:"
8501 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8502 msgid "static libraries (libfoo.a)"
8506 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8507 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8511 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8512 msgid "x86 Linux vmlinuz kernels"
8516 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8518 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8519 "compressed code, and are horribly hard to unpack. If you want to find the "
8520 "architecture of a kernel, use the architecture of the associated initrd or "
8521 "kernel module(s) instead."
8525 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3406
8526 msgid "(Added in 1.5.3)"
8530 #: ../src/guestfs-actions.pod:1662
8531 msgid "guestfs_filesize"
8535 #: ../src/guestfs-actions.pod:1664
8539 " guestfs_filesize (guestfs_h *g,\n"
8540 " const char *file);\n"
8545 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8546 msgid "This command returns the size of C<file> in bytes."
8550 #: ../src/guestfs-actions.pod:1670
8552 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8553 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8554 "devices, use C<guestfs_blockdev_getsize64>."
8558 #: ../src/guestfs-actions.pod:1676
8559 msgid "(Added in 1.0.82)"
8563 #: ../src/guestfs-actions.pod:1678
8564 msgid "guestfs_fill"
8568 #: ../src/guestfs-actions.pod:1680
8572 " guestfs_fill (guestfs_h *g,\n"
8575 " const char *path);\n"
8580 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8582 "This command creates a new file called C<path>. The initial content of the "
8583 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8588 #: ../src/guestfs-actions.pod:1690
8590 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8591 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8592 "bytes use C<guestfs_fill_pattern>."
8596 #: ../src/guestfs-actions.pod:1702
8597 msgid "(Added in 1.0.79)"
8601 #: ../src/guestfs-actions.pod:1704
8602 msgid "guestfs_fill_pattern"
8606 #: ../src/guestfs-actions.pod:1706
8610 " guestfs_fill_pattern (guestfs_h *g,\n"
8611 " const char *pattern,\n"
8613 " const char *path);\n"
8618 #: ../src/guestfs-actions.pod:1712
8620 "This function is like C<guestfs_fill> except that it creates a new file of "
8621 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8622 "pattern is truncated if necessary to ensure the length of the file is "
8623 "exactly C<len> bytes."
8627 #: ../src/guestfs-actions.pod:1724
8628 msgid "(Added in 1.3.12)"
8632 #: ../src/guestfs-actions.pod:1726
8633 msgid "guestfs_find"
8637 #: ../src/guestfs-actions.pod:1728
8641 " guestfs_find (guestfs_h *g,\n"
8642 " const char *directory);\n"
8647 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8649 "This command lists out all files and directories, recursively, starting at "
8650 "C<directory>. It is essentially equivalent to running the shell command "
8651 "C<find directory -print> but some post-processing happens on the output, "
8656 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8658 "This returns a list of strings I<without any prefix>. Thus if the directory "
8663 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8673 #: ../src/guestfs-actions.pod:1744
8674 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8678 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8689 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8690 msgid "If C<directory> is not a directory, then this command returns an error."
8694 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8695 msgid "The returned list is sorted."
8699 #: ../src/guestfs-actions.pod:1757
8700 msgid "See also C<guestfs_find0>."
8704 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:5643
8705 msgid "(Added in 1.0.27)"
8709 #: ../src/guestfs-actions.pod:1768
8710 msgid "guestfs_find0"
8714 #: ../src/guestfs-actions.pod:1770
8718 " guestfs_find0 (guestfs_h *g,\n"
8719 " const char *directory,\n"
8720 " const char *files);\n"
8725 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8727 "This command lists out all files and directories, recursively, starting at "
8728 "C<directory>, placing the resulting list in the external file called "
8733 #: ../src/guestfs-actions.pod:1779
8735 "This command works the same way as C<guestfs_find> with the following "
8740 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8741 msgid "The resulting list is written to an external file."
8745 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
8747 "Items (filenames) in the result are separated by C<\\0> characters. See "
8748 "L<find(1)> option I<-print0>."
8752 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
8753 msgid "This command is not limited in the number of names that it can return."
8757 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
8758 msgid "The result list is not sorted."
8762 #: ../src/guestfs-actions.pod:1806
8763 msgid "(Added in 1.0.74)"
8767 #: ../src/guestfs-actions.pod:1808
8768 msgid "guestfs_findfs_label"
8772 #: ../src/guestfs-actions.pod:1810
8776 " guestfs_findfs_label (guestfs_h *g,\n"
8777 " const char *label);\n"
8782 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
8784 "This command searches the filesystems and returns the one which has the "
8785 "given label. An error is returned if no such filesystem can be found."
8789 #: ../src/guestfs-actions.pod:1818
8790 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8794 #: ../src/guestfs-actions.pod:1825
8795 msgid "guestfs_findfs_uuid"
8799 #: ../src/guestfs-actions.pod:1827
8803 " guestfs_findfs_uuid (guestfs_h *g,\n"
8804 " const char *uuid);\n"
8809 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
8811 "This command searches the filesystems and returns the one which has the "
8812 "given UUID. An error is returned if no such filesystem can be found."
8816 #: ../src/guestfs-actions.pod:1835
8817 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8821 #: ../src/guestfs-actions.pod:1842
8822 msgid "guestfs_fsck"
8826 #: ../src/guestfs-actions.pod:1844
8830 " guestfs_fsck (guestfs_h *g,\n"
8831 " const char *fstype,\n"
8832 " const char *device);\n"
8837 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
8839 "This runs the filesystem checker (fsck) on C<device> which should have "
8840 "filesystem type C<fstype>."
8844 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
8846 "The returned integer is the status. See L<fsck(8)> for the list of status "
8847 "codes from C<fsck>."
8851 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
8852 msgid "Multiple status codes can be summed together."
8856 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
8858 "A non-zero return code can mean \"success\", for example if errors have been "
8859 "corrected on the filesystem."
8863 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
8864 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8868 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
8869 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8873 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7339
8874 msgid "(Added in 1.0.16)"
8878 #: ../src/guestfs-actions.pod:1881
8879 msgid "guestfs_get_append"
8883 #: ../src/guestfs-actions.pod:1883
8887 " guestfs_get_append (guestfs_h *g);\n"
8892 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
8894 "Return the additional kernel options which are added to the guest kernel "
8899 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
8900 msgid "If C<NULL> then no options are added."
8904 #: ../src/guestfs-actions.pod:1891
8906 "This function returns a string which may be NULL. There is no way to return "
8907 "an error from this function. The string is owned by the guest handle and "
8908 "must I<not> be freed."
8912 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5321 ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6201 ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7382
8913 msgid "(Added in 1.0.26)"
8917 #: ../src/guestfs-actions.pod:1897
8918 msgid "guestfs_get_attach_method"
8922 #: ../src/guestfs-actions.pod:1899
8926 " guestfs_get_attach_method (guestfs_h *g);\n"
8931 #: ../src/guestfs-actions.pod:1902
8932 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8936 #: ../src/guestfs-actions.pod:1907
8937 msgid "guestfs_get_autosync"
8941 #: ../src/guestfs-actions.pod:1909
8945 " guestfs_get_autosync (guestfs_h *g);\n"
8950 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
8951 msgid "Get the autosync flag."
8955 #: ../src/guestfs-actions.pod:1918
8956 msgid "guestfs_get_direct"
8960 #: ../src/guestfs-actions.pod:1920
8964 " guestfs_get_direct (guestfs_h *g);\n"
8969 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
8970 msgid "Return the direct appliance mode flag."
8974 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5870
8975 msgid "(Added in 1.0.72)"
8979 #: ../src/guestfs-actions.pod:1929
8980 msgid "guestfs_get_e2label"
8984 #: ../src/guestfs-actions.pod:1931
8988 " guestfs_get_e2label (guestfs_h *g,\n"
8989 " const char *device);\n"
8994 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
8995 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8999 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9001 "This function is deprecated. In new code, use the C<vfs_label> call "
9006 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5907
9007 msgid "(Added in 1.0.15)"
9011 #: ../src/guestfs-actions.pod:1950
9012 msgid "guestfs_get_e2uuid"
9016 #: ../src/guestfs-actions.pod:1952
9020 " guestfs_get_e2uuid (guestfs_h *g,\n"
9021 " const char *device);\n"
9026 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9027 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9031 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9032 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9036 #: ../src/guestfs-actions.pod:1971
9037 msgid "guestfs_get_memsize"
9041 #: ../src/guestfs-actions.pod:1973
9045 " guestfs_get_memsize (guestfs_h *g);\n"
9050 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9051 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9055 #: ../src/guestfs-actions.pod:1979
9057 "If C<guestfs_set_memsize> was not called on this handle, and if "
9058 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9059 "value for memsize."
9063 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4080
9064 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9068 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4391 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5928 ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6776
9069 msgid "(Added in 1.0.55)"
9073 #: ../src/guestfs-actions.pod:1990
9074 msgid "guestfs_get_network"
9078 #: ../src/guestfs-actions.pod:1992
9082 " guestfs_get_network (guestfs_h *g);\n"
9087 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9088 msgid "This returns the enable network flag."
9092 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5947
9093 msgid "(Added in 1.5.4)"
9097 #: ../src/guestfs-actions.pod:2001
9098 msgid "guestfs_get_path"
9102 #: ../src/guestfs-actions.pod:2003
9106 " guestfs_get_path (guestfs_h *g);\n"
9111 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9112 msgid "Return the current search path."
9116 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9118 "This is always non-NULL. If it wasn't set already, then this will return "
9123 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9125 "This function returns a string, or NULL on error. The string is owned by "
9126 "the guest handle and must I<not> be freed."
9130 #: ../src/guestfs-actions.pod:2016
9131 msgid "guestfs_get_pid"
9135 #: ../src/guestfs-actions.pod:2018
9139 " guestfs_get_pid (guestfs_h *g);\n"
9144 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9146 "Return the process ID of the qemu subprocess. If there is no qemu "
9147 "subprocess, then this will return an error."
9151 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9152 msgid "This is an internal call used for debugging and testing."
9156 #: ../src/guestfs-actions.pod:2028
9157 msgid "(Added in 1.0.56)"
9161 #: ../src/guestfs-actions.pod:2030
9162 msgid "guestfs_get_qemu"
9166 #: ../src/guestfs-actions.pod:2032
9170 " guestfs_get_qemu (guestfs_h *g);\n"
9175 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9176 msgid "Return the current qemu binary."
9180 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9182 "This is always non-NULL. If it wasn't set already, then this will return "
9183 "the default qemu binary name."
9187 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5992
9188 msgid "(Added in 1.0.6)"
9192 #: ../src/guestfs-actions.pod:2045
9193 msgid "guestfs_get_recovery_proc"
9197 #: ../src/guestfs-actions.pod:2047
9201 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9206 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9207 msgid "Return the recovery process enabled flag."
9211 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3501 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:4198 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:5251 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6891
9212 msgid "(Added in 1.0.77)"
9216 #: ../src/guestfs-actions.pod:2056
9217 msgid "guestfs_get_selinux"
9221 #: ../src/guestfs-actions.pod:2058
9225 " guestfs_get_selinux (guestfs_h *g);\n"
9230 #: ../src/guestfs-actions.pod:2061
9232 "This returns the current setting of the selinux flag which is passed to the "
9233 "appliance at boot time. See C<guestfs_set_selinux>."
9237 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6093
9238 msgid "(Added in 1.0.67)"
9242 #: ../src/guestfs-actions.pod:2071
9243 msgid "guestfs_get_state"
9247 #: ../src/guestfs-actions.pod:2073
9251 " guestfs_get_state (guestfs_h *g);\n"
9256 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9258 "This returns the current state as an opaque integer. This is only useful "
9259 "for printing debug and internal error messages."
9263 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3299 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:1409 ../fish/guestfish-actions.pod:2323 ../fish/guestfish-actions.pod:2341 ../fish/guestfish-actions.pod:2379 ../fish/guestfish-actions.pod:2395
9264 msgid "For more information on states, see L<guestfs(3)>."
9268 #: ../src/guestfs-actions.pod:2085
9269 msgid "guestfs_get_trace"
9273 #: ../src/guestfs-actions.pod:2087
9277 " guestfs_get_trace (guestfs_h *g);\n"
9282 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9283 msgid "Return the command trace flag."
9287 #: ../src/guestfs-actions.pod:2096
9288 msgid "guestfs_get_umask"
9292 #: ../src/guestfs-actions.pod:2098
9296 " guestfs_get_umask (guestfs_h *g);\n"
9301 #: ../src/guestfs-actions.pod:2101
9303 "Return the current umask. By default the umask is C<022> unless it has been "
9304 "set by calling C<guestfs_umask>."
9308 #: ../src/guestfs-actions.pod:2108
9309 msgid "guestfs_get_verbose"
9313 #: ../src/guestfs-actions.pod:2110
9317 " guestfs_get_verbose (guestfs_h *g);\n"
9322 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9323 msgid "This returns the verbose messages flag."
9327 #: ../src/guestfs-actions.pod:2119
9328 msgid "guestfs_getcon"
9332 #: ../src/guestfs-actions.pod:2121
9336 " guestfs_getcon (guestfs_h *g);\n"
9341 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9342 msgid "This gets the SELinux security context of the daemon."
9346 #: ../src/guestfs-actions.pod:2126
9347 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9351 #: ../src/guestfs-actions.pod:2134
9352 msgid "guestfs_getxattr"
9356 #: ../src/guestfs-actions.pod:2136
9360 " guestfs_getxattr (guestfs_h *g,\n"
9361 " const char *path,\n"
9362 " const char *name,\n"
9363 " size_t *size_r);\n"
9368 #: ../src/guestfs-actions.pod:2142
9370 "Get a single extended attribute from file C<path> named C<name>. This call "
9371 "follows symlinks. If you want to lookup an extended attribute for the "
9372 "symlink itself, use C<guestfs_lgetxattr>."
9376 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3515
9378 "Normally it is better to get all extended attributes from a file in one go "
9379 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9380 "implementations are buggy and do not provide a way to list out attributes. "
9381 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9382 "extended attributes you want in advance and call this function."
9386 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3522 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2460
9388 "Extended attribute values are blobs of binary data. If there is no extended "
9389 "attribute named C<name>, this returns an error."
9393 #: ../src/guestfs-actions.pod:2156
9394 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9398 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5244 ../src/guestfs-actions.pod:5270 ../src/guestfs-actions.pod:5451
9400 "This function returns a buffer, or NULL on error. The size of the returned "
9401 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9406 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3531
9407 msgid "(Added in 1.7.24)"
9411 #: ../src/guestfs-actions.pod:2164
9412 msgid "guestfs_getxattrs"
9416 #: ../src/guestfs-actions.pod:2166
9419 " struct guestfs_xattr_list *\n"
9420 " guestfs_getxattrs (guestfs_h *g,\n"
9421 " const char *path);\n"
9426 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9427 msgid "This call lists the extended attributes of the file or directory C<path>."
9431 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9433 "At the system call level, this is a combination of the L<listxattr(2)> and "
9434 "L<getxattr(2)> calls."
9438 #: ../src/guestfs-actions.pod:2176
9439 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9443 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:4194
9445 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9446 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9450 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3547 ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:6112 ../src/guestfs-actions.pod:7447
9451 msgid "(Added in 1.0.59)"
9455 #: ../src/guestfs-actions.pod:2184
9456 msgid "guestfs_glob_expand"
9460 #: ../src/guestfs-actions.pod:2186
9464 " guestfs_glob_expand (guestfs_h *g,\n"
9465 " const char *pattern);\n"
9470 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9472 "This command searches for all the pathnames matching C<pattern> according to "
9473 "the wildcard expansion rules used by the shell."
9477 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9478 msgid "If no paths match, then this returns an empty list (note: not an error)."
9482 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9484 "It is just a wrapper around the C L<glob(3)> function with flags "
9485 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9489 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6277 ../src/guestfs-actions.pod:6294
9490 msgid "(Added in 1.0.50)"
9494 #: ../src/guestfs-actions.pod:2207
9495 msgid "guestfs_grep"
9499 #: ../src/guestfs-actions.pod:2209
9503 " guestfs_grep (guestfs_h *g,\n"
9504 " const char *regex,\n"
9505 " const char *path);\n"
9510 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9511 msgid "This calls the external C<grep> program and returns the matching lines."
9515 #: ../src/guestfs-actions.pod:2226
9516 msgid "guestfs_grepi"
9520 #: ../src/guestfs-actions.pod:2228
9524 " guestfs_grepi (guestfs_h *g,\n"
9525 " const char *regex,\n"
9526 " const char *path);\n"
9531 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9532 msgid "This calls the external C<grep -i> program and returns the matching lines."
9536 #: ../src/guestfs-actions.pod:2245
9537 msgid "guestfs_grub_install"
9541 #: ../src/guestfs-actions.pod:2247
9545 " guestfs_grub_install (guestfs_h *g,\n"
9546 " const char *root,\n"
9547 " const char *device);\n"
9552 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9554 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9555 "the root directory being C<root>."
9559 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9561 "Note: If grub-install reports the error \"No suitable drive was found in the "
9562 "generated device map.\" it may be that you need to create a "
9563 "C</boot/grub/device.map> file first that contains the mapping between grub "
9564 "device names and Linux device names. It is usually sufficient to create a "
9569 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9577 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9578 msgid "replacing C</dev/vda> with the name of the installation device."
9582 #: ../src/guestfs-actions.pod:2268
9583 msgid "(Added in 1.0.17)"
9587 #: ../src/guestfs-actions.pod:2270
9588 msgid "guestfs_head"
9592 #: ../src/guestfs-actions.pod:2272
9596 " guestfs_head (guestfs_h *g,\n"
9597 " const char *path);\n"
9602 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9604 "This command returns up to the first 10 lines of a file as a list of "
9609 #: ../src/guestfs-actions.pod:2288
9610 msgid "guestfs_head_n"
9614 #: ../src/guestfs-actions.pod:2290
9618 " guestfs_head_n (guestfs_h *g,\n"
9620 " const char *path);\n"
9625 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9627 "If the parameter C<nrlines> is a positive number, this returns the first "
9628 "C<nrlines> lines of the file C<path>."
9632 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9634 "If the parameter C<nrlines> is a negative number, this returns lines from "
9635 "the file C<path>, excluding the last C<nrlines> lines."
9639 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4430
9640 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9644 #: ../src/guestfs-actions.pod:2312
9645 msgid "guestfs_hexdump"
9649 #: ../src/guestfs-actions.pod:2314
9653 " guestfs_hexdump (guestfs_h *g,\n"
9654 " const char *path);\n"
9659 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9661 "This runs C<hexdump -C> on the given C<path>. The result is the "
9662 "human-readable, canonical hex dump of the file."
9666 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6413
9667 msgid "(Added in 1.0.22)"
9671 #: ../src/guestfs-actions.pod:2329
9672 msgid "guestfs_initrd_cat"
9676 #: ../src/guestfs-actions.pod:2331
9680 " guestfs_initrd_cat (guestfs_h *g,\n"
9681 " const char *initrdpath,\n"
9682 " const char *filename,\n"
9683 " size_t *size_r);\n"
9688 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9690 "This command unpacks the file C<filename> from the initrd file called "
9691 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9696 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9698 "For example, in guestfish you could use the following command to examine the "
9699 "boot script (usually called C</init>) contained in a Linux initrd or "
9704 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
9707 " initrd-cat /boot/initrd-<version>.img init\n"
9712 #: ../src/guestfs-actions.pod:2347
9713 msgid "See also C<guestfs_initrd_list>."
9717 #: ../src/guestfs-actions.pod:2358
9718 msgid "guestfs_initrd_list"
9722 #: ../src/guestfs-actions.pod:2360
9726 " guestfs_initrd_list (guestfs_h *g,\n"
9727 " const char *path);\n"
9732 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
9733 msgid "This command lists out files contained in an initrd."
9737 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
9739 "The files are listed without any initial C</> character. The files are "
9740 "listed in the order they appear (not necessarily alphabetical). Directory "
9741 "names are listed as separate items."
9745 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
9747 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9748 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9753 #: ../src/guestfs-actions.pod:2380
9754 msgid "guestfs_inotify_add_watch"
9758 #: ../src/guestfs-actions.pod:2382
9762 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9763 " const char *path,\n"
9769 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
9770 msgid "Watch C<path> for the events listed in C<mask>."
9774 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
9776 "Note that if C<path> is a directory then events within that directory are "
9777 "watched, but this does I<not> happen recursively (in subdirectories)."
9781 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
9783 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9784 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9788 #: ../src/guestfs-actions.pod:2401
9789 msgid "guestfs_inotify_close"
9793 #: ../src/guestfs-actions.pod:2403
9797 " guestfs_inotify_close (guestfs_h *g);\n"
9802 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
9804 "This closes the inotify handle which was previously opened by inotify_init. "
9805 "It removes all watches, throws away any pending events, and deallocates all "
9810 #: ../src/guestfs-actions.pod:2414
9811 msgid "guestfs_inotify_files"
9815 #: ../src/guestfs-actions.pod:2416
9819 " guestfs_inotify_files (guestfs_h *g);\n"
9824 #: ../src/guestfs-actions.pod:2419
9826 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9827 "returns a list of pathnames of objects that were touched. The returned "
9828 "pathnames are sorted and deduplicated."
9832 #: ../src/guestfs-actions.pod:2429
9833 msgid "guestfs_inotify_init"
9837 #: ../src/guestfs-actions.pod:2431
9841 " guestfs_inotify_init (guestfs_h *g,\n"
9842 " int maxevents);\n"
9847 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
9849 "This command creates a new inotify handle. The inotify subsystem can be "
9850 "used to notify events which happen to objects in the guest filesystem."
9854 #: ../src/guestfs-actions.pod:2439
9856 "C<maxevents> is the maximum number of events which will be queued up between "
9857 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9858 "passed as C<0>, then the kernel (or previously set) default is used. For "
9859 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9860 "throws away events, but records the fact that it threw them away by setting "
9861 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9862 "C<guestfs_inotify_read>)."
9866 #: ../src/guestfs-actions.pod:2449
9868 "Before any events are generated, you have to add some watches to the "
9869 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9870 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9874 #: ../src/guestfs-actions.pod:2455
9876 "Queued up events should be read periodically by calling "
9877 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9878 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9879 "often enough then you risk the internal queue overflowing."
9883 #: ../src/guestfs-actions.pod:2462
9885 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9886 "This also removes any watches automatically."
9890 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
9892 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9893 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9894 "that there is one global inotify handle per libguestfs instance."
9898 #: ../src/guestfs-actions.pod:2475
9899 msgid "guestfs_inotify_read"
9903 #: ../src/guestfs-actions.pod:2477
9906 " struct guestfs_inotify_event_list *\n"
9907 " guestfs_inotify_read (guestfs_h *g);\n"
9912 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
9914 "Return the complete queue of events that have happened since the previous "
9919 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
9920 msgid "If no events have happened, this returns an empty list."
9924 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
9926 "I<Note>: In order to make sure that all events have been read, you must call "
9927 "this function repeatedly until it returns an empty list. The reason is that "
9928 "the call will read events up to the maximum appliance-to-host message size "
9929 "and leave remaining events in the queue."
9933 #: ../src/guestfs-actions.pod:2491
9935 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9936 "there was an error. I<The caller must call "
9937 "C<guestfs_free_inotify_event_list> after use>."
9941 #: ../src/guestfs-actions.pod:2497
9942 msgid "guestfs_inotify_rm_watch"
9946 #: ../src/guestfs-actions.pod:2499
9950 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9956 #: ../src/guestfs-actions.pod:2503
9958 "Remove a previously defined inotify watch. See "
9959 "C<guestfs_inotify_add_watch>."
9963 #: ../src/guestfs-actions.pod:2510
9964 msgid "guestfs_inspect_get_arch"
9968 #: ../src/guestfs-actions.pod:2512
9972 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9973 " const char *root);\n"
9978 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2676 ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2854 ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2914 ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3132
9980 "This function should only be called with a root device string as returned by "
9981 "C<guestfs_inspect_os>."
9985 #: ../src/guestfs-actions.pod:2519
9987 "This returns the architecture of the inspected operating system. The "
9988 "possible return values are listed under C<guestfs_file_architecture>."
9992 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
9994 "If the architecture could not be determined, then the string C<unknown> is "
9999 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2619 ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3103 ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1784 ../fish/guestfish-actions.pod:1872 ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2002 ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2062 ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2142 ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2170 ../fish/guestfish-actions.pod:2269 ../fish/guestfish-actions.pod:2303
10000 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10004 #: ../src/guestfs-actions.pod:2533
10005 msgid "guestfs_inspect_get_distro"
10009 #: ../src/guestfs-actions.pod:2535
10013 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10014 " const char *root);\n"
10019 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10020 msgid "This returns the distro (distribution) of the inspected operating system."
10024 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10025 msgid "Currently defined distros are:"
10029 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10030 msgid "\"archlinux\""
10034 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10035 msgid "Arch Linux."
10039 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10044 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10049 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10054 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10059 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10064 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10069 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10074 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10079 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10080 msgid "\"linuxmint\""
10084 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10085 msgid "Linux Mint."
10089 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10090 msgid "\"mandriva\""
10094 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10099 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10104 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10109 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10114 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10119 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10120 msgid "\"redhat-based\""
10124 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10125 msgid "Some Red Hat-derived distro."
10129 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10134 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10135 msgid "Red Hat Enterprise Linux."
10139 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10140 msgid "\"scientificlinux\""
10144 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10145 msgid "Scientific Linux."
10149 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10150 msgid "\"slackware\""
10154 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10159 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10164 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10169 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:2088
10170 msgid "\"unknown\""
10174 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
10175 msgid "The distro could not be determined."
10179 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:2080
10180 msgid "\"windows\""
10184 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
10186 "Windows does not have distributions. This string is returned if the OS type "
10191 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:2094
10193 "Future versions of libguestfs may return other strings here. The caller "
10194 "should be prepared to handle any string."
10198 #: ../src/guestfs-actions.pod:2626
10199 msgid "guestfs_inspect_get_drive_mappings"
10203 #: ../src/guestfs-actions.pod:2628
10207 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10208 " const char *root);\n"
10213 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1793
10215 "This call is useful for Windows which uses a primitive system of assigning "
10216 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10217 "Windows Registry to find out how disks/partitions are mapped to drive "
10218 "letters, and returns a hash table as in the example below:"
10222 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10225 " C => /dev/vda2\n"
10226 " E => /dev/vdb1\n"
10227 " F => /dev/vdc1\n"
10232 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1803
10234 "Note that keys are drive letters. For Windows, the key is case insensitive "
10235 "and just contains the drive letter, without the customary colon separator "
10240 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10242 "In future we may support other operating systems that also used drive "
10243 "letters, but the keys for those might not be case insensitive and might be "
10244 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10249 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10251 "For Windows guests, currently only hard drive mappings are returned. "
10252 "Removable disks (eg. DVD-ROMs) are ignored."
10256 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1815
10258 "For guests that do not use drive mappings, or if the drive mappings could "
10259 "not be determined, this returns an empty hash table."
10263 #: ../src/guestfs-actions.pod:2660
10265 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10266 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10270 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:4810 ../src/guestfs-actions.pod:6715
10272 "This function returns a NULL-terminated array of strings, or NULL if there "
10273 "was an error. The array of strings will always have length C<2n+1>, where "
10274 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10275 "caller must free the strings and the array after use>."
10279 #: ../src/guestfs-actions.pod:2670
10280 msgid "guestfs_inspect_get_filesystems"
10284 #: ../src/guestfs-actions.pod:2672
10288 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10289 " const char *root);\n"
10294 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
10296 "This returns a list of all the filesystems that we think are associated with "
10297 "this operating system. This includes the root filesystem, other ordinary "
10298 "filesystems, and non-mounted devices like swap partitions."
10302 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1834
10304 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10305 "to be shared between operating systems."
10309 #: ../src/guestfs-actions.pod:2687
10311 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10312 "C<guestfs_inspect_get_mountpoints>."
10316 #: ../src/guestfs-actions.pod:2696
10317 msgid "guestfs_inspect_get_format"
10321 #: ../src/guestfs-actions.pod:2698
10325 " guestfs_inspect_get_format (guestfs_h *g,\n"
10326 " const char *root);\n"
10331 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10333 "This returns the format of the inspected operating system. You can use it "
10334 "to detect install images, live CDs and similar."
10338 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10339 msgid "Currently defined formats are:"
10343 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1854
10344 msgid "\"installed\""
10348 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
10349 msgid "This is an installed operating system."
10353 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
10354 msgid "\"installer\""
10358 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
10360 "The disk image being inspected is not an installed operating system, but a "
10361 "I<bootable> install disk, live CD, or similar."
10365 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1865
10366 msgid "The format of this disk image is not known."
10370 #: ../src/guestfs-actions.pod:2735
10371 msgid "guestfs_inspect_get_hostname"
10375 #: ../src/guestfs-actions.pod:2737
10379 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10380 " const char *root);\n"
10385 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10387 "This function returns the hostname of the operating system as found by "
10388 "inspection of the guest's configuration files."
10392 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1884
10394 "If the hostname could not be determined, then the string C<unknown> is "
10399 #: ../src/guestfs-actions.pod:2755
10400 msgid "(Added in 1.7.9)"
10404 #: ../src/guestfs-actions.pod:2757
10405 msgid "guestfs_inspect_get_major_version"
10409 #: ../src/guestfs-actions.pod:2759
10413 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10414 " const char *root);\n"
10419 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10420 msgid "This returns the major version number of the inspected operating system."
10424 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1899
10426 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10427 "popular public names used by the operating system. Notably the operating "
10428 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10429 "1). You can find out the real versions corresponding to releases of Windows "
10430 "by consulting Wikipedia or MSDN."
10434 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1920
10435 msgid "If the version could not be determined, then C<0> is returned."
10439 #: ../src/guestfs-actions.pod:2784
10440 msgid "guestfs_inspect_get_minor_version"
10444 #: ../src/guestfs-actions.pod:2786
10448 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10449 " const char *root);\n"
10454 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1917
10455 msgid "This returns the minor version number of the inspected operating system."
10459 #: ../src/guestfs-actions.pod:2798
10461 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10462 "C<guestfs_inspect_get_major_version>."
10466 #: ../src/guestfs-actions.pod:2805
10467 msgid "guestfs_inspect_get_mountpoints"
10471 #: ../src/guestfs-actions.pod:2807
10475 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10476 " const char *root);\n"
10481 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1932
10483 "This returns a hash of where we think the filesystems associated with this "
10484 "operating system should be mounted. Callers should note that this is at "
10485 "best an educated guess made by reading configuration files such as "
10486 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10487 "are non-existent or not mountable and callers should be prepared to handle "
10488 "or ignore failures if they try to mount them."
10492 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:1941
10494 "Each element in the returned hashtable has a key which is the path of the "
10495 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10496 "mounted there (eg. C</dev/sda1>)."
10500 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1946
10501 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10505 #: ../src/guestfs-actions.pod:2831
10507 "For operating systems like Windows which still use drive letters, this call "
10508 "will only return an entry for the first drive \"mounted on\" C</>. For "
10509 "information about the mapping of drive letters to partitions, see "
10510 "C<guestfs_inspect_get_drive_mappings>."
10514 #: ../src/guestfs-actions.pod:2837
10516 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10517 "C<guestfs_inspect_get_filesystems>."
10521 #: ../src/guestfs-actions.pod:2848
10522 msgid "guestfs_inspect_get_package_format"
10526 #: ../src/guestfs-actions.pod:2850
10530 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10531 " const char *root);\n"
10536 #: ../src/guestfs-actions.pod:2857
10538 "This function and C<guestfs_inspect_get_package_management> return the "
10539 "package format and package management tool used by the inspected operating "
10540 "system. For example for Fedora these functions would return C<rpm> (package "
10541 "format) and C<yum> (package management)."
10545 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1971
10547 "This returns the string C<unknown> if we could not determine the package "
10548 "format I<or> if the operating system does not have a real packaging system "
10553 #: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:1975
10555 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10556 "Future versions of libguestfs may return other strings."
10560 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
10561 msgid "(Added in 1.7.5)"
10565 #: ../src/guestfs-actions.pod:2877
10566 msgid "guestfs_inspect_get_package_management"
10570 #: ../src/guestfs-actions.pod:2879
10574 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10575 " const char *root);\n"
10580 #: ../src/guestfs-actions.pod:2886
10582 "C<guestfs_inspect_get_package_format> and this function return the package "
10583 "format and package management tool used by the inspected operating system. "
10584 "For example for Fedora these functions would return C<rpm> (package format) "
10585 "and C<yum> (package management)."
10589 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:1993
10591 "This returns the string C<unknown> if we could not determine the package "
10592 "management tool I<or> if the operating system does not have a real packaging "
10593 "system (eg. Windows)."
10597 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1997
10599 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10600 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10601 "libguestfs may return other strings."
10605 #: ../src/guestfs-actions.pod:2908
10606 msgid "guestfs_inspect_get_product_name"
10610 #: ../src/guestfs-actions.pod:2910
10614 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10615 " const char *root);\n"
10620 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2011
10622 "This returns the product name of the inspected operating system. The "
10623 "product name is generally some freeform string which can be displayed to the "
10624 "user, but should not be parsed by programs."
10628 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2016
10630 "If the product name could not be determined, then the string C<unknown> is "
10635 #: ../src/guestfs-actions.pod:2932
10636 msgid "guestfs_inspect_get_product_variant"
10640 #: ../src/guestfs-actions.pod:2934
10644 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10645 " const char *root);\n"
10650 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
10651 msgid "This returns the product variant of the inspected operating system."
10655 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2031
10657 "For Windows guests, this returns the contents of the Registry key "
10658 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10659 "which is usually a string such as C<Client> or C<Server> (other values are "
10660 "possible). This can be used to distinguish consumer and enterprise versions "
10661 "of Windows that have the same version number (for example, Windows 7 and "
10662 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10663 "the latter is C<Server>)."
10667 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2040
10669 "For enterprise Linux guests, in future we intend this to return the product "
10670 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10671 "implemented at present."
10675 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2044
10677 "If the product variant could not be determined, then the string C<unknown> "
10682 #: ../src/guestfs-actions.pod:2960
10684 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10685 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10689 #: ../src/guestfs-actions.pod:2967
10690 msgid "guestfs_inspect_get_roots"
10694 #: ../src/guestfs-actions.pod:2969
10698 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10703 #: ../src/guestfs-actions.pod:2972
10705 "This function is a convenient way to get the list of root devices, as "
10706 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10707 "the whole inspection process."
10711 #: ../src/guestfs-actions.pod:2976
10713 "This returns an empty list if either no root devices were found or the "
10714 "caller has not called C<guestfs_inspect_os>."
10718 #: ../src/guestfs-actions.pod:2985
10719 msgid "(Added in 1.7.3)"
10723 #: ../src/guestfs-actions.pod:2987
10724 msgid "guestfs_inspect_get_type"
10728 #: ../src/guestfs-actions.pod:2989
10732 " guestfs_inspect_get_type (guestfs_h *g,\n"
10733 " const char *root);\n"
10738 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2071
10740 "This returns the type of the inspected operating system. Currently defined "
10745 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
10750 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
10751 msgid "Any Linux-based operating system."
10755 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
10756 msgid "Any Microsoft Windows operating system."
10760 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
10761 msgid "\"freebsd\""
10765 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
10770 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2090
10771 msgid "The operating system type could not be determined."
10775 #: ../src/guestfs-actions.pod:3029
10776 msgid "guestfs_inspect_get_windows_current_control_set"
10780 #: ../src/guestfs-actions.pod:3031
10784 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10785 " const char *root);\n"
10790 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
10792 "This returns the Windows CurrentControlSet of the inspected guest. The "
10793 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10797 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2109
10799 "This call assumes that the guest is Windows and that the Registry could be "
10800 "examined by inspection. If this is not the case then an error is returned."
10804 #: ../src/guestfs-actions.pod:3050
10805 msgid "guestfs_inspect_get_windows_systemroot"
10809 #: ../src/guestfs-actions.pod:3052
10813 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10814 " const char *root);\n"
10819 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
10821 "This returns the Windows systemroot of the inspected guest. The systemroot "
10822 "is a directory path such as C</WINDOWS>."
10826 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2125
10828 "This call assumes that the guest is Windows and that the systemroot could be "
10829 "determined by inspection. If this is not the case then an error is "
10834 #: ../src/guestfs-actions.pod:3071
10835 msgid "(Added in 1.5.25)"
10839 #: ../src/guestfs-actions.pod:3073
10840 msgid "guestfs_inspect_is_live"
10844 #: ../src/guestfs-actions.pod:3075
10848 " guestfs_inspect_is_live (guestfs_h *g,\n"
10849 " const char *root);\n"
10854 #: ../src/guestfs-actions.pod:3082
10856 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10857 "disk), then this returns true if a live image was detected on the disk."
10861 #: ../src/guestfs-actions.pod:3090
10862 msgid "guestfs_inspect_is_multipart"
10866 #: ../src/guestfs-actions.pod:3092
10870 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10871 " const char *root);\n"
10876 #: ../src/guestfs-actions.pod:3099
10878 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10879 "disk), then this returns true if the disk is part of a set."
10883 #: ../src/guestfs-actions.pod:3107
10884 msgid "guestfs_inspect_is_netinst"
10888 #: ../src/guestfs-actions.pod:3109
10892 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10893 " const char *root);\n"
10898 #: ../src/guestfs-actions.pod:3116
10900 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10901 "disk), then this returns true if the disk is a network installer, ie. not a "
10902 "self-contained install CD but one which is likely to require network access "
10903 "to complete the install."
10907 #: ../src/guestfs-actions.pod:3126
10908 msgid "guestfs_inspect_list_applications"
10912 #: ../src/guestfs-actions.pod:3128
10915 " struct guestfs_application_list *\n"
10916 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10917 " const char *root);\n"
10922 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2179
10923 msgid "Return the list of applications installed in the operating system."
10927 #: ../src/guestfs-actions.pod:3137
10929 "I<Note:> This call works differently from other parts of the inspection "
10930 "API. You have to call C<guestfs_inspect_os>, then "
10931 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10932 "this. Listing applications is a significantly more difficult operation "
10933 "which requires access to the full filesystem. Also note that unlike the "
10934 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10935 "the libguestfs handle, this call actually reads parts of the mounted "
10936 "filesystems during the call."
10940 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
10942 "This returns an empty list if the inspection code was not able to determine "
10943 "the list of applications."
10947 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2194
10948 msgid "The application structure contains the following fields:"
10952 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2198
10953 msgid "C<app_name>"
10957 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
10959 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10960 "guests, this is the package name."
10964 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
10965 msgid "C<app_display_name>"
10969 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
10971 "The display name of the application, sometimes localized to the install "
10972 "language of the guest operating system."
10976 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
10978 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10979 "to display something can use C<app_name> instead."
10983 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2211
10984 msgid "C<app_epoch>"
10988 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
10990 "For package managers which use epochs, this contains the epoch of the "
10991 "package (an integer). If unavailable, this is returned as C<0>."
10995 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2216
10996 msgid "C<app_version>"
11000 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11002 "The version string of the application or package. If unavailable this is "
11003 "returned as an empty string C<\"\">."
11007 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11008 msgid "C<app_release>"
11012 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
11014 "The release string of the application or package, for package managers that "
11015 "use this. If unavailable this is returned as an empty string C<\"\">."
11019 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
11020 msgid "C<app_install_path>"
11024 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11026 "The installation path of the application (on operating systems such as "
11027 "Windows which use installation paths). This path is in the format used by "
11028 "the guest operating system, it is not a libguestfs path."
11032 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2234
11033 msgid "If unavailable this is returned as an empty string C<\"\">."
11037 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
11038 msgid "C<app_trans_path>"
11042 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11044 "The install path translated into a libguestfs path. If unavailable this is "
11045 "returned as an empty string C<\"\">."
11049 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11050 msgid "C<app_publisher>"
11054 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
11056 "The name of the publisher of the application, for package managers that use "
11057 "this. If unavailable this is returned as an empty string C<\"\">."
11061 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
11066 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11068 "The URL (eg. upstream URL) of the application. If unavailable this is "
11069 "returned as an empty string C<\"\">."
11073 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2252
11074 msgid "C<app_source_package>"
11078 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11080 "For packaging systems which support this, the name of the source package. "
11081 "If unavailable this is returned as an empty string C<\"\">."
11085 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2257
11086 msgid "C<app_summary>"
11090 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11092 "A short (usually one line) description of the application or package. If "
11093 "unavailable this is returned as an empty string C<\"\">."
11097 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
11098 msgid "C<app_description>"
11102 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
11104 "A longer description of the application or package. If unavailable this is "
11105 "returned as an empty string C<\"\">."
11109 #: ../src/guestfs-actions.pod:3227
11111 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11112 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11117 #: ../src/guestfs-actions.pod:3231
11118 msgid "(Added in 1.7.8)"
11122 #: ../src/guestfs-actions.pod:3233
11123 msgid "guestfs_inspect_os"
11127 #: ../src/guestfs-actions.pod:3235
11131 " guestfs_inspect_os (guestfs_h *g);\n"
11136 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2275
11138 "This function uses other libguestfs functions and certain heuristics to "
11139 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11140 "for operating systems."
11144 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2279
11145 msgid "The list returned is empty if no operating systems were found."
11149 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
11151 "If one operating system was found, then this returns a list with a single "
11152 "element, which is the name of the root filesystem of this operating system. "
11153 "It is also possible for this function to return a list containing more than "
11154 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11155 "element being the root filesystem of one of the operating systems."
11159 #: ../src/guestfs-actions.pod:3251
11161 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11162 "functions in order to query further information about each operating system, "
11163 "such as the name and version."
11167 #: ../src/guestfs-actions.pod:3256
11169 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11170 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11171 "the contents. This should be called with no disks currently mounted. The "
11172 "function may also use Augeas, so any existing Augeas handle will be closed."
11176 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
11178 "This function cannot decrypt encrypted disks. The caller must do that first "
11179 "(supplying the necessary keys) if the disk is encrypted."
11183 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3558 ../src/guestfs-actions.pod:3620
11184 msgid "See also C<guestfs_list_filesystems>."
11188 #: ../src/guestfs-actions.pod:3276
11189 msgid "guestfs_is_blockdev"
11193 #: ../src/guestfs-actions.pod:3278
11197 " guestfs_is_blockdev (guestfs_h *g,\n"
11198 " const char *path);\n"
11203 #: ../src/guestfs-actions.pod:3282 ../fish/guestfish-actions.pod:2311
11205 "This returns C<true> if and only if there is a block device with the given "
11210 #: ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3359 ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3446
11211 msgid "See also C<guestfs_stat>."
11215 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3318 ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3435 ../src/guestfs-actions.pod:3450
11216 msgid "(Added in 1.5.10)"
11220 #: ../src/guestfs-actions.pod:3291
11221 msgid "guestfs_is_busy"
11225 #: ../src/guestfs-actions.pod:3293
11229 " guestfs_is_busy (guestfs_h *g);\n"
11234 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2320
11236 "This returns true iff this handle is busy processing a command (in the "
11241 #: ../src/guestfs-actions.pod:3305
11242 msgid "guestfs_is_chardev"
11246 #: ../src/guestfs-actions.pod:3307
11250 " guestfs_is_chardev (guestfs_h *g,\n"
11251 " const char *path);\n"
11256 #: ../src/guestfs-actions.pod:3311 ../fish/guestfish-actions.pod:2329
11258 "This returns C<true> if and only if there is a character device with the "
11259 "given C<path> name."
11263 #: ../src/guestfs-actions.pod:3320
11264 msgid "guestfs_is_config"
11268 #: ../src/guestfs-actions.pod:3322
11272 " guestfs_is_config (guestfs_h *g);\n"
11277 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2338
11279 "This returns true iff this handle is being configured (in the C<CONFIG> "
11284 #: ../src/guestfs-actions.pod:3334
11285 msgid "guestfs_is_dir"
11289 #: ../src/guestfs-actions.pod:3336
11293 " guestfs_is_dir (guestfs_h *g,\n"
11294 " const char *path);\n"
11299 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2347
11301 "This returns C<true> if and only if there is a directory with the given "
11302 "C<path> name. Note that it returns false for other objects like files."
11306 #: ../src/guestfs-actions.pod:3350
11307 msgid "guestfs_is_fifo"
11311 #: ../src/guestfs-actions.pod:3352
11315 " guestfs_is_fifo (guestfs_h *g,\n"
11316 " const char *path);\n"
11321 #: ../src/guestfs-actions.pod:3356 ../fish/guestfish-actions.pod:2357
11323 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11324 "given C<path> name."
11328 #: ../src/guestfs-actions.pod:3365
11329 msgid "guestfs_is_file"
11333 #: ../src/guestfs-actions.pod:3367
11337 " guestfs_is_file (guestfs_h *g,\n"
11338 " const char *path);\n"
11343 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2366
11345 "This returns C<true> if and only if there is a regular file with the given "
11346 "C<path> name. Note that it returns false for other objects like "
11351 #: ../src/guestfs-actions.pod:3381
11352 msgid "guestfs_is_launching"
11356 #: ../src/guestfs-actions.pod:3383
11360 " guestfs_is_launching (guestfs_h *g);\n"
11365 #: ../src/guestfs-actions.pod:3386 ../fish/guestfish-actions.pod:2376
11367 "This returns true iff this handle is launching the subprocess (in the "
11368 "C<LAUNCHING> state)."
11372 #: ../src/guestfs-actions.pod:3395
11373 msgid "guestfs_is_lv"
11377 #: ../src/guestfs-actions.pod:3397
11381 " guestfs_is_lv (guestfs_h *g,\n"
11382 " const char *device);\n"
11387 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2385
11389 "This command tests whether C<device> is a logical volume, and returns true "
11390 "iff this is the case."
11394 #: ../src/guestfs-actions.pod:3408
11395 msgid "guestfs_is_ready"
11399 #: ../src/guestfs-actions.pod:3410
11403 " guestfs_is_ready (guestfs_h *g);\n"
11408 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:2392
11410 "This returns true iff this handle is ready to accept commands (in the "
11415 #: ../src/guestfs-actions.pod:3422
11416 msgid "guestfs_is_socket"
11420 #: ../src/guestfs-actions.pod:3424
11424 " guestfs_is_socket (guestfs_h *g,\n"
11425 " const char *path);\n"
11430 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2401
11432 "This returns C<true> if and only if there is a Unix domain socket with the "
11433 "given C<path> name."
11437 #: ../src/guestfs-actions.pod:3437
11438 msgid "guestfs_is_symlink"
11442 #: ../src/guestfs-actions.pod:3439
11446 " guestfs_is_symlink (guestfs_h *g,\n"
11447 " const char *path);\n"
11452 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2410
11454 "This returns C<true> if and only if there is a symbolic link with the given "
11459 #: ../src/guestfs-actions.pod:3452
11460 msgid "guestfs_kill_subprocess"
11464 #: ../src/guestfs-actions.pod:3454
11468 " guestfs_kill_subprocess (guestfs_h *g);\n"
11473 #: ../src/guestfs-actions.pod:3457 ../fish/guestfish-actions.pod:2419
11474 msgid "This kills the qemu subprocess. You should never need to call this."
11478 #: ../src/guestfs-actions.pod:3463
11479 msgid "guestfs_launch"
11483 #: ../src/guestfs-actions.pod:3465
11487 " guestfs_launch (guestfs_h *g);\n"
11492 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
11494 "Internally libguestfs is implemented by running a virtual machine using "
11499 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2430
11501 "You should call this after configuring the handle (eg. adding drives) but "
11502 "before performing any actions."
11506 #: ../src/guestfs-actions.pod:3483
11507 msgid "guestfs_lchown"
11511 #: ../src/guestfs-actions.pod:3485
11515 " guestfs_lchown (guestfs_h *g,\n"
11518 " const char *path);\n"
11523 #: ../src/guestfs-actions.pod:3491
11525 "Change the file owner to C<owner> and group to C<group>. This is like "
11526 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11527 "changed, not the target."
11531 #: ../src/guestfs-actions.pod:3503
11532 msgid "guestfs_lgetxattr"
11536 #: ../src/guestfs-actions.pod:3505
11540 " guestfs_lgetxattr (guestfs_h *g,\n"
11541 " const char *path,\n"
11542 " const char *name,\n"
11543 " size_t *size_r);\n"
11548 #: ../src/guestfs-actions.pod:3511 ../fish/guestfish-actions.pod:2449
11550 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11551 "is a symlink, then this call returns an extended attribute from the symlink."
11555 #: ../src/guestfs-actions.pod:3525
11556 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11560 #: ../src/guestfs-actions.pod:3533
11561 msgid "guestfs_lgetxattrs"
11565 #: ../src/guestfs-actions.pod:3535
11568 " struct guestfs_xattr_list *\n"
11569 " guestfs_lgetxattrs (guestfs_h *g,\n"
11570 " const char *path);\n"
11575 #: ../src/guestfs-actions.pod:3539
11577 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11578 "then it returns the extended attributes of the link itself."
11582 #: ../src/guestfs-actions.pod:3549
11583 msgid "guestfs_list_devices"
11587 #: ../src/guestfs-actions.pod:3551
11591 " guestfs_list_devices (guestfs_h *g);\n"
11596 #: ../src/guestfs-actions.pod:3554 ../fish/guestfish-actions.pod:2477
11597 msgid "List all the block devices."
11601 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
11602 msgid "The full block device names are returned, eg. C</dev/sda>."
11606 #: ../src/guestfs-actions.pod:3566
11607 msgid "guestfs_list_filesystems"
11611 #: ../src/guestfs-actions.pod:3568
11615 " guestfs_list_filesystems (guestfs_h *g);\n"
11620 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11622 "This inspection command looks for filesystems on partitions, block devices "
11623 "and logical volumes, returning a list of devices containing filesystems and "
11628 #: ../src/guestfs-actions.pod:3575 ../fish/guestfish-actions.pod:2491
11630 "The return value is a hash, where the keys are the devices containing "
11631 "filesystems, and the values are the filesystem types. For example:"
11635 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2495
11638 " \"/dev/sda1\" => \"ntfs\"\n"
11639 " \"/dev/sda2\" => \"ext2\"\n"
11640 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11641 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11646 #: ../src/guestfs-actions.pod:3584 ../fish/guestfish-actions.pod:2500
11648 "The value can have the special value \"unknown\", meaning the content of the "
11649 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11653 #: ../src/guestfs-actions.pod:3588
11655 "This command runs other libguestfs commands, which might include "
11656 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11657 "soon after launch and only when nothing is mounted."
11661 #: ../src/guestfs-actions.pod:3592
11663 "Not all of the filesystems returned will be mountable. In particular, swap "
11664 "partitions are returned in the list. Also this command does not check that "
11665 "each filesystem found is valid and mountable, and some filesystems might be "
11666 "mountable but require special options. Filesystems may not all belong to a "
11667 "single logical operating system (use C<guestfs_inspect_os> to look for "
11672 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:5211
11673 msgid "(Added in 1.5.15)"
11677 #: ../src/guestfs-actions.pod:3608
11678 msgid "guestfs_list_partitions"
11682 #: ../src/guestfs-actions.pod:3610
11686 " guestfs_list_partitions (guestfs_h *g);\n"
11691 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2520
11692 msgid "List all the partitions detected on all block devices."
11696 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
11697 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11701 #: ../src/guestfs-actions.pod:3617
11703 "This does not return logical volumes. For that you will need to call "
11708 #: ../src/guestfs-actions.pod:3628
11713 #: ../src/guestfs-actions.pod:3630
11717 " guestfs_ll (guestfs_h *g,\n"
11718 " const char *directory);\n"
11723 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
11725 "List the files in C<directory> (relative to the root directory, there is no "
11726 "cwd) in the format of 'ls -la'."
11730 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2536
11732 "This command is mostly useful for interactive sessions. It is I<not> "
11733 "intended that you try to parse the output string."
11737 #: ../src/guestfs-actions.pod:3645
11742 #: ../src/guestfs-actions.pod:3647
11746 " guestfs_ln (guestfs_h *g,\n"
11747 " const char *target,\n"
11748 " const char *linkname);\n"
11753 #: ../src/guestfs-actions.pod:3652 ../fish/guestfish-actions.pod:2543
11754 msgid "This command creates a hard link using the C<ln> command."
11758 #: ../src/guestfs-actions.pod:3658
11759 msgid "guestfs_ln_f"
11763 #: ../src/guestfs-actions.pod:3660
11767 " guestfs_ln_f (guestfs_h *g,\n"
11768 " const char *target,\n"
11769 " const char *linkname);\n"
11774 #: ../src/guestfs-actions.pod:3665 ../fish/guestfish-actions.pod:2549
11776 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11777 "option removes the link (C<linkname>) if it exists already."
11781 #: ../src/guestfs-actions.pod:3672
11782 msgid "guestfs_ln_s"
11786 #: ../src/guestfs-actions.pod:3674
11790 " guestfs_ln_s (guestfs_h *g,\n"
11791 " const char *target,\n"
11792 " const char *linkname);\n"
11797 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2556
11798 msgid "This command creates a symbolic link using the C<ln -s> command."
11802 #: ../src/guestfs-actions.pod:3685
11803 msgid "guestfs_ln_sf"
11807 #: ../src/guestfs-actions.pod:3687
11811 " guestfs_ln_sf (guestfs_h *g,\n"
11812 " const char *target,\n"
11813 " const char *linkname);\n"
11818 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2562
11820 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11821 "option removes the link (C<linkname>) if it exists already."
11825 #: ../src/guestfs-actions.pod:3699
11826 msgid "guestfs_lremovexattr"
11830 #: ../src/guestfs-actions.pod:3701
11834 " guestfs_lremovexattr (guestfs_h *g,\n"
11835 " const char *xattr,\n"
11836 " const char *path);\n"
11841 #: ../src/guestfs-actions.pod:3706
11843 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11844 "link, then it removes an extended attribute of the link itself."
11848 #: ../src/guestfs-actions.pod:3714
11853 #: ../src/guestfs-actions.pod:3716
11857 " guestfs_ls (guestfs_h *g,\n"
11858 " const char *directory);\n"
11863 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2577
11865 "List the files in C<directory> (relative to the root directory, there is no "
11866 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11871 #: ../src/guestfs-actions.pod:3724
11873 "This command is mostly useful for interactive sessions. Programs should "
11874 "probably use C<guestfs_readdir> instead."
11878 #: ../src/guestfs-actions.pod:3733
11879 msgid "guestfs_lsetxattr"
11883 #: ../src/guestfs-actions.pod:3735
11887 " guestfs_lsetxattr (guestfs_h *g,\n"
11888 " const char *xattr,\n"
11889 " const char *val,\n"
11891 " const char *path);\n"
11896 #: ../src/guestfs-actions.pod:3742
11898 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11899 "then it sets an extended attribute of the link itself."
11903 #: ../src/guestfs-actions.pod:3750
11904 msgid "guestfs_lstat"
11908 #: ../src/guestfs-actions.pod:3752
11911 " struct guestfs_stat *\n"
11912 " guestfs_lstat (guestfs_h *g,\n"
11913 " const char *path);\n"
11918 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:4265
11919 msgid "Returns file information for the given C<path>."
11923 #: ../src/guestfs-actions.pod:3758
11925 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11926 "link, then the link is stat-ed, not the file it refers to."
11930 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2602
11931 msgid "This is the same as the C<lstat(2)> system call."
11935 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:6318
11937 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11938 "error. I<The caller must call C<guestfs_free_stat> after use>."
11942 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6721
11943 msgid "(Added in 0.9.2)"
11947 #: ../src/guestfs-actions.pod:3770
11948 msgid "guestfs_lstatlist"
11952 #: ../src/guestfs-actions.pod:3772
11955 " struct guestfs_stat_list *\n"
11956 " guestfs_lstatlist (guestfs_h *g,\n"
11957 " const char *path,\n"
11958 " char *const *names);\n"
11963 #: ../src/guestfs-actions.pod:3777
11965 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11966 "files, where all files are in the directory C<path>. C<names> is the list "
11967 "of files from this directory."
11971 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2612
11973 "On return you get a list of stat structs, with a one-to-one correspondence "
11974 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11975 "then the C<ino> field of that structure is set to C<-1>."
11979 #: ../src/guestfs-actions.pod:3786
11981 "This call is intended for programs that want to efficiently list a directory "
11982 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11983 "for a similarly efficient call for getting extended attributes. Very long "
11984 "directory listings might cause the protocol message size to be exceeded, "
11985 "causing this call to fail. The caller must split up such requests into "
11986 "smaller groups of names."
11990 #: ../src/guestfs-actions.pod:3794
11992 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11993 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11997 #: ../src/guestfs-actions.pod:3800
11998 msgid "guestfs_luks_add_key"
12002 #: ../src/guestfs-actions.pod:3802
12006 " guestfs_luks_add_key (guestfs_h *g,\n"
12007 " const char *device,\n"
12008 " const char *key,\n"
12009 " const char *newkey,\n"
12015 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2629
12017 "This command adds a new key on LUKS device C<device>. C<key> is any "
12018 "existing key, and is used to access the device. C<newkey> is the new key to "
12019 "add. C<keyslot> is the key slot that will be replaced."
12023 #: ../src/guestfs-actions.pod:3814
12025 "Note that if C<keyslot> already contains a key, then this command will "
12026 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12030 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954
12032 "This function takes a key or passphrase parameter which could contain "
12033 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12038 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3907
12039 msgid "(Added in 1.5.2)"
12043 #: ../src/guestfs-actions.pod:3826
12044 msgid "guestfs_luks_close"
12048 #: ../src/guestfs-actions.pod:3828
12052 " guestfs_luks_close (guestfs_h *g,\n"
12053 " const char *device);\n"
12058 #: ../src/guestfs-actions.pod:3832
12060 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12061 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12062 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12063 "underlying block device."
12067 #: ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4056
12068 msgid "(Added in 1.5.1)"
12072 #: ../src/guestfs-actions.pod:3842
12073 msgid "guestfs_luks_format"
12077 #: ../src/guestfs-actions.pod:3844
12081 " guestfs_luks_format (guestfs_h *g,\n"
12082 " const char *device,\n"
12083 " const char *key,\n"
12089 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2655
12091 "This command erases existing data on C<device> and formats the device as a "
12092 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12093 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12097 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4962 ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:2663 ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2760 ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3854 ../fish/guestfish-actions.pod:4164 ../fish/guestfish-actions.pod:4180 ../fish/guestfish-actions.pod:4195 ../fish/guestfish-actions.pod:4910
12099 "B<This command is dangerous. Without careful use you can easily destroy all "
12104 #: ../src/guestfs-actions.pod:3866
12105 msgid "guestfs_luks_format_cipher"
12109 #: ../src/guestfs-actions.pod:3868
12113 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12114 " const char *device,\n"
12115 " const char *key,\n"
12117 " const char *cipher);\n"
12122 #: ../src/guestfs-actions.pod:3875
12124 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12125 "set the C<cipher> used."
12129 #: ../src/guestfs-actions.pod:3889
12130 msgid "guestfs_luks_kill_slot"
12134 #: ../src/guestfs-actions.pod:3891
12138 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12139 " const char *device,\n"
12140 " const char *key,\n"
12146 #: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2683
12148 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12149 "device C<device>. C<key> must be one of the I<other> keys."
12153 #: ../src/guestfs-actions.pod:3909
12154 msgid "guestfs_luks_open"
12158 #: ../src/guestfs-actions.pod:3911
12162 " guestfs_luks_open (guestfs_h *g,\n"
12163 " const char *device,\n"
12164 " const char *key,\n"
12165 " const char *mapname);\n"
12170 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12172 "This command opens a block device which has been encrypted according to the "
12173 "Linux Unified Key Setup (LUKS) standard."
12177 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2697
12178 msgid "C<device> is the encrypted block device or partition."
12182 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12184 "The caller must supply one of the keys associated with the LUKS block "
12185 "device, in the C<key> parameter."
12189 #: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2702
12191 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12192 "writes to this block device are decrypted from and encrypted to the "
12193 "underlying C<device> respectively."
12197 #: ../src/guestfs-actions.pod:3929
12199 "If this block device contains LVM volume groups, then calling "
12200 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12205 #: ../src/guestfs-actions.pod:3941
12206 msgid "guestfs_luks_open_ro"
12210 #: ../src/guestfs-actions.pod:3943
12214 " guestfs_luks_open_ro (guestfs_h *g,\n"
12215 " const char *device,\n"
12216 " const char *key,\n"
12217 " const char *mapname);\n"
12222 #: ../src/guestfs-actions.pod:3949
12224 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12229 #: ../src/guestfs-actions.pod:3960
12230 msgid "guestfs_lvcreate"
12234 #: ../src/guestfs-actions.pod:3962
12238 " guestfs_lvcreate (guestfs_h *g,\n"
12239 " const char *logvol,\n"
12240 " const char *volgroup,\n"
12246 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2727
12248 "This creates an LVM logical volume called C<logvol> on the volume group "
12249 "C<volgroup>, with C<size> megabytes."
12253 #: ../src/guestfs-actions.pod:3975
12254 msgid "guestfs_lvm_canonical_lv_name"
12258 #: ../src/guestfs-actions.pod:3977
12262 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12263 " const char *lvname);\n"
12268 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2734
12270 "This converts alternative naming schemes for LVs that you might find to the "
12271 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12276 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2738
12278 "This command returns an error if the C<lvname> parameter does not refer to a "
12283 #: ../src/guestfs-actions.pod:3988
12284 msgid "See also C<guestfs_is_lv>."
12288 #: ../src/guestfs-actions.pod:3993
12289 msgid "(Added in 1.5.24)"
12293 #: ../src/guestfs-actions.pod:3995
12294 msgid "guestfs_lvm_clear_filter"
12298 #: ../src/guestfs-actions.pod:3997
12302 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12307 #: ../src/guestfs-actions.pod:4000
12309 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12310 "see every block device."
12314 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2781
12315 msgid "This command also clears the LVM cache and performs a volume group scan."
12319 #: ../src/guestfs-actions.pod:4010
12320 msgid "guestfs_lvm_remove_all"
12324 #: ../src/guestfs-actions.pod:4012
12328 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12333 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2757
12335 "This command removes all LVM logical volumes, volume groups and physical "
12340 #: ../src/guestfs-actions.pod:4025
12341 msgid "guestfs_lvm_set_filter"
12345 #: ../src/guestfs-actions.pod:4027
12349 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12350 " char *const *devices);\n"
12355 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2767
12357 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12358 "block devices in the list C<devices>, and will ignore all other attached "
12363 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2771
12365 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12366 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12367 "there are two types of duplication possible: either cloned PVs/VGs which "
12368 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12369 "same name. In normal operation you cannot create this situation, but you "
12370 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12371 "inside the LVM metadata."
12375 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2784
12376 msgid "You can filter whole block devices or individual partitions."
12380 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
12382 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12383 "filesystem), even if you are not filtering out that VG."
12387 #: ../src/guestfs-actions.pod:4058
12388 msgid "guestfs_lvremove"
12392 #: ../src/guestfs-actions.pod:4060
12396 " guestfs_lvremove (guestfs_h *g,\n"
12397 " const char *device);\n"
12402 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12404 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12405 "LV, such as C</dev/VG/LV>."
12409 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2797
12411 "You can also remove all LVs in a volume group by specifying the VG name, "
12416 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:7097
12417 msgid "(Added in 1.0.13)"
12421 #: ../src/guestfs-actions.pod:4074
12422 msgid "guestfs_lvrename"
12426 #: ../src/guestfs-actions.pod:4076
12430 " guestfs_lvrename (guestfs_h *g,\n"
12431 " const char *logvol,\n"
12432 " const char *newlogvol);\n"
12437 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2804
12438 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12442 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:7110
12443 msgid "(Added in 1.0.83)"
12447 #: ../src/guestfs-actions.pod:4087
12448 msgid "guestfs_lvresize"
12452 #: ../src/guestfs-actions.pod:4089
12456 " guestfs_lvresize (guestfs_h *g,\n"
12457 " const char *device,\n"
12463 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2810
12465 "This resizes (expands or shrinks) an existing LVM logical volume to "
12466 "C<mbytes>. When reducing, data in the reduced part is lost."
12470 #: ../src/guestfs-actions.pod:4102
12471 msgid "guestfs_lvresize_free"
12475 #: ../src/guestfs-actions.pod:4104
12479 " guestfs_lvresize_free (guestfs_h *g,\n"
12480 " const char *lv,\n"
12486 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2818
12488 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12489 "remaining free space in the volume group. Commonly you would call this with "
12490 "pc = 100 which expands the logical volume as much as possible, using all "
12491 "remaining free space in the volume group."
12495 #: ../src/guestfs-actions.pod:4117
12496 msgid "(Added in 1.3.3)"
12500 #: ../src/guestfs-actions.pod:4119
12501 msgid "guestfs_lvs"
12505 #: ../src/guestfs-actions.pod:4121
12509 " guestfs_lvs (guestfs_h *g);\n"
12514 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
12516 "List all the logical volumes detected. This is the equivalent of the "
12517 "L<lvs(8)> command."
12521 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2831
12523 "This returns a list of the logical volume device names "
12524 "(eg. C</dev/VolGroup00/LogVol00>)."
12528 #: ../src/guestfs-actions.pod:4130
12529 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12533 #: ../src/guestfs-actions.pod:4138
12534 msgid "guestfs_lvs_full"
12538 #: ../src/guestfs-actions.pod:4140
12541 " struct guestfs_lvm_lv_list *\n"
12542 " guestfs_lvs_full (guestfs_h *g);\n"
12547 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2840
12549 "List all the logical volumes detected. This is the equivalent of the "
12550 "L<lvs(8)> command. The \"full\" version includes all fields."
12554 #: ../src/guestfs-actions.pod:4146
12556 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12557 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12562 #: ../src/guestfs-actions.pod:4152
12563 msgid "guestfs_lvuuid"
12567 #: ../src/guestfs-actions.pod:4154
12571 " guestfs_lvuuid (guestfs_h *g,\n"
12572 " const char *device);\n"
12577 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2847
12578 msgid "This command returns the UUID of the LVM LV C<device>."
12582 #: ../src/guestfs-actions.pod:4165
12583 msgid "guestfs_lxattrlist"
12587 #: ../src/guestfs-actions.pod:4167
12590 " struct guestfs_xattr_list *\n"
12591 " guestfs_lxattrlist (guestfs_h *g,\n"
12592 " const char *path,\n"
12593 " char *const *names);\n"
12598 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2853
12600 "This call allows you to get the extended attributes of multiple files, where "
12601 "all files are in the directory C<path>. C<names> is the list of files from "
12606 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2857
12608 "On return you get a flat list of xattr structs which must be interpreted "
12609 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12610 "C<attrval> in this struct is zero-length to indicate there was an error "
12611 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12612 "number (the number of following attributes for this file, which could be "
12613 "C<\"0\">). Then after the first xattr struct are the zero or more "
12614 "attributes for the first named file. This repeats for the second and "
12615 "subsequent files."
12619 #: ../src/guestfs-actions.pod:4186
12621 "This call is intended for programs that want to efficiently list a directory "
12622 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12623 "a similarly efficient call for getting standard stats. Very long directory "
12624 "listings might cause the protocol message size to be exceeded, causing this "
12625 "call to fail. The caller must split up such requests into smaller groups of "
12630 #: ../src/guestfs-actions.pod:4200
12631 msgid "guestfs_mkdir"
12635 #: ../src/guestfs-actions.pod:4202
12639 " guestfs_mkdir (guestfs_h *g,\n"
12640 " const char *path);\n"
12645 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2879
12646 msgid "Create a directory named C<path>."
12650 #: ../src/guestfs-actions.pod:4212
12651 msgid "guestfs_mkdir_mode"
12655 #: ../src/guestfs-actions.pod:4214
12659 " guestfs_mkdir_mode (guestfs_h *g,\n"
12660 " const char *path,\n"
12666 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
12668 "This command creates a directory, setting the initial permissions of the "
12669 "directory to C<mode>."
12673 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2888
12675 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12676 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12681 #: ../src/guestfs-actions.pod:4226
12682 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12686 #: ../src/guestfs-actions.pod:4232
12687 msgid "guestfs_mkdir_p"
12691 #: ../src/guestfs-actions.pod:4234
12695 " guestfs_mkdir_p (guestfs_h *g,\n"
12696 " const char *path);\n"
12701 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2898
12703 "Create a directory named C<path>, creating any parent directories as "
12704 "necessary. This is like the C<mkdir -p> shell command."
12708 #: ../src/guestfs-actions.pod:4245
12709 msgid "guestfs_mkdtemp"
12713 #: ../src/guestfs-actions.pod:4247
12717 " guestfs_mkdtemp (guestfs_h *g,\n"
12718 " const char *template);\n"
12723 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
12725 "This command creates a temporary directory. The C<template> parameter "
12726 "should be a full pathname for the temporary directory name with the final "
12727 "six characters being \"XXXXXX\"."
12731 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
12733 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12734 "being suitable for Windows filesystems."
12738 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
12739 msgid "The name of the temporary directory that was created is returned."
12743 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
12744 msgid "The temporary directory is created with mode 0700 and is owned by root."
12748 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
12750 "The caller is responsible for deleting the temporary directory and its "
12751 "contents after use."
12755 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2922
12756 msgid "See also: L<mkdtemp(3)>"
12760 #: ../src/guestfs-actions.pod:4275
12761 msgid "guestfs_mke2fs_J"
12765 #: ../src/guestfs-actions.pod:4277
12769 " guestfs_mke2fs_J (guestfs_h *g,\n"
12770 " const char *fstype,\n"
12771 " int blocksize,\n"
12772 " const char *device,\n"
12773 " const char *journal);\n"
12778 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:2928
12780 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12781 "C<journal>. It is equivalent to the command:"
12785 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2932
12788 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12793 #: ../src/guestfs-actions.pod:4290
12794 msgid "See also C<guestfs_mke2journal>."
12798 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4698
12799 msgid "(Added in 1.0.68)"
12803 #: ../src/guestfs-actions.pod:4296
12804 msgid "guestfs_mke2fs_JL"
12808 #: ../src/guestfs-actions.pod:4298
12812 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12813 " const char *fstype,\n"
12814 " int blocksize,\n"
12815 " const char *device,\n"
12816 " const char *label);\n"
12821 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2940
12823 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12824 "the journal labeled C<label>."
12828 #: ../src/guestfs-actions.pod:4308
12829 msgid "See also C<guestfs_mke2journal_L>."
12833 #: ../src/guestfs-actions.pod:4314
12834 msgid "guestfs_mke2fs_JU"
12838 #: ../src/guestfs-actions.pod:4316
12842 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12843 " const char *fstype,\n"
12844 " int blocksize,\n"
12845 " const char *device,\n"
12846 " const char *uuid);\n"
12851 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2949
12853 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12854 "the journal with UUID C<uuid>."
12858 #: ../src/guestfs-actions.pod:4326
12859 msgid "See also C<guestfs_mke2journal_U>."
12863 #: ../src/guestfs-actions.pod:4332
12864 msgid "guestfs_mke2journal"
12868 #: ../src/guestfs-actions.pod:4334
12872 " guestfs_mke2journal (guestfs_h *g,\n"
12873 " int blocksize,\n"
12874 " const char *device);\n"
12879 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
12881 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12886 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2961
12889 " mke2fs -O journal_dev -b blocksize device\n"
12894 #: ../src/guestfs-actions.pod:4348
12895 msgid "guestfs_mke2journal_L"
12899 #: ../src/guestfs-actions.pod:4350
12903 " guestfs_mke2journal_L (guestfs_h *g,\n"
12904 " int blocksize,\n"
12905 " const char *label,\n"
12906 " const char *device);\n"
12911 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:2967
12912 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12916 #: ../src/guestfs-actions.pod:4362
12917 msgid "guestfs_mke2journal_U"
12921 #: ../src/guestfs-actions.pod:4364
12925 " guestfs_mke2journal_U (guestfs_h *g,\n"
12926 " int blocksize,\n"
12927 " const char *uuid,\n"
12928 " const char *device);\n"
12933 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2973
12934 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12938 #: ../src/guestfs-actions.pod:4376
12939 msgid "guestfs_mkfifo"
12943 #: ../src/guestfs-actions.pod:4378
12947 " guestfs_mkfifo (guestfs_h *g,\n"
12949 " const char *path);\n"
12954 #: ../src/guestfs-actions.pod:4383
12956 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12957 "is just a convenient wrapper around C<guestfs_mknod>."
12961 #: ../src/guestfs-actions.pod:4393
12962 msgid "guestfs_mkfs"
12966 #: ../src/guestfs-actions.pod:4395
12970 " guestfs_mkfs (guestfs_h *g,\n"
12971 " const char *fstype,\n"
12972 " const char *device);\n"
12977 #: ../src/guestfs-actions.pod:4400 ../fish/guestfish-actions.pod:2989
12979 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12980 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12984 #: ../src/guestfs-actions.pod:4408
12985 msgid "guestfs_mkfs_b"
12989 #: ../src/guestfs-actions.pod:4410
12993 " guestfs_mkfs_b (guestfs_h *g,\n"
12994 " const char *fstype,\n"
12995 " int blocksize,\n"
12996 " const char *device);\n"
13001 #: ../src/guestfs-actions.pod:4416
13003 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13004 "block size of the resulting filesystem. Supported block sizes depend on the "
13005 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13009 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3002 ../fish/guestfish-actions.pod:3029
13011 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13016 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3005
13018 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13023 #: ../src/guestfs-actions.pod:4435
13024 msgid "guestfs_mkfs_opts"
13028 #: ../src/guestfs-actions.pod:4437
13032 " guestfs_mkfs_opts (guestfs_h *g,\n"
13033 " const char *fstype,\n"
13034 " const char *device,\n"
13040 #: ../src/guestfs-actions.pod:4448
13043 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13044 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13049 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3016
13051 "This function creates a filesystem on C<device>. The filesystem type is "
13052 "C<fstype>, for example C<ext3>."
13056 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:3023
13057 msgid "C<blocksize>"
13061 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
13063 "The filesystem block size. Supported block sizes depend on the filesystem "
13064 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13069 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:3032
13070 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13074 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13075 msgid "C<features>"
13079 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
13080 msgid "This passes the I<-O> parameter to the external mkfs program."
13084 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
13086 "For certain filesystem types, this allows extra filesystem features to be "
13087 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13091 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3042
13093 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13098 #: ../src/guestfs-actions.pod:4484
13099 msgid "(Added in 1.7.19)"
13103 #: ../src/guestfs-actions.pod:4486
13104 msgid "guestfs_mkfs_opts_va"
13108 #: ../src/guestfs-actions.pod:4488
13112 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13113 " const char *fstype,\n"
13114 " const char *device,\n"
13115 " va_list args);\n"
13120 #: ../src/guestfs-actions.pod:4494
13121 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13125 #: ../src/guestfs-actions.pod:4498
13126 msgid "guestfs_mkfs_opts_argv"
13130 #: ../src/guestfs-actions.pod:4500
13134 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13135 " const char *fstype,\n"
13136 " const char *device,\n"
13137 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13142 #: ../src/guestfs-actions.pod:4506
13143 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13147 #: ../src/guestfs-actions.pod:4510
13148 msgid "guestfs_mkmountpoint"
13152 #: ../src/guestfs-actions.pod:4512
13156 " guestfs_mkmountpoint (guestfs_h *g,\n"
13157 " const char *exemptpath);\n"
13162 #: ../src/guestfs-actions.pod:4516
13164 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13165 "that can be used to create extra mountpoints before mounting the first "
13170 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3057
13172 "These calls are I<only> necessary in some very limited circumstances, mainly "
13173 "the case where you want to mount a mix of unrelated and/or read-only "
13174 "filesystems together."
13178 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3061
13180 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13181 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13182 "inside that. You can unpack this as follows in guestfish:"
13186 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3066
13189 " add-ro Fedora-11-i686-Live.iso\n"
13191 " mkmountpoint /cd\n"
13192 " mkmountpoint /sqsh\n"
13193 " mkmountpoint /ext3fs\n"
13194 " mount /dev/sda /cd\n"
13195 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13196 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13201 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3075
13202 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13206 #: ../src/guestfs-actions.pod:4540
13208 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13209 "may get unexpected errors if you try to mix these calls. It is safest to "
13210 "manually unmount filesystems and remove mountpoints after use."
13214 #: ../src/guestfs-actions.pod:4544
13216 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13217 "first, so for this to work for manual mountpoints, you must ensure that the "
13218 "innermost mountpoints have the longest pathnames, as in the example code "
13223 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3086
13224 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13228 #: ../src/guestfs-actions.pod:4551
13230 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13231 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13232 "can also trigger these issues."
13236 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:5726
13237 msgid "(Added in 1.0.62)"
13241 #: ../src/guestfs-actions.pod:4559
13242 msgid "guestfs_mknod"
13246 #: ../src/guestfs-actions.pod:4561
13250 " guestfs_mknod (guestfs_h *g,\n"
13254 " const char *path);\n"
13259 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13261 "This call creates block or character special devices, or named pipes "
13266 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3099
13268 "The C<mode> parameter should be the mode, using the standard constants. "
13269 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13270 "used when creating block and character special devices."
13274 #: ../src/guestfs-actions.pod:4576
13276 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13277 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13278 "regular file). These constants are available in the standard Linux header "
13279 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13280 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13281 "the appropriate constant for you."
13285 #: ../src/guestfs-actions.pod:4590
13286 msgid "guestfs_mknod_b"
13290 #: ../src/guestfs-actions.pod:4592
13294 " guestfs_mknod_b (guestfs_h *g,\n"
13298 " const char *path);\n"
13303 #: ../src/guestfs-actions.pod:4599
13305 "This call creates a block device node called C<path> with mode C<mode> and "
13306 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13307 "wrapper around C<guestfs_mknod>."
13311 #: ../src/guestfs-actions.pod:4609
13312 msgid "guestfs_mknod_c"
13316 #: ../src/guestfs-actions.pod:4611
13320 " guestfs_mknod_c (guestfs_h *g,\n"
13324 " const char *path);\n"
13329 #: ../src/guestfs-actions.pod:4618
13331 "This call creates a char device node called C<path> with mode C<mode> and "
13332 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13333 "wrapper around C<guestfs_mknod>."
13337 #: ../src/guestfs-actions.pod:4628
13338 msgid "guestfs_mkswap"
13342 #: ../src/guestfs-actions.pod:4630
13346 " guestfs_mkswap (guestfs_h *g,\n"
13347 " const char *device);\n"
13352 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3138
13353 msgid "Create a swap partition on C<device>."
13357 #: ../src/guestfs-actions.pod:4640
13358 msgid "guestfs_mkswap_L"
13362 #: ../src/guestfs-actions.pod:4642
13366 " guestfs_mkswap_L (guestfs_h *g,\n"
13367 " const char *label,\n"
13368 " const char *device);\n"
13373 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3144
13374 msgid "Create a swap partition on C<device> with label C<label>."
13378 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
13380 "Note that you cannot attach a swap label to a block device "
13381 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13382 "the kernel or swap tools."
13386 #: ../src/guestfs-actions.pod:4657
13387 msgid "guestfs_mkswap_U"
13391 #: ../src/guestfs-actions.pod:4659
13395 " guestfs_mkswap_U (guestfs_h *g,\n"
13396 " const char *uuid,\n"
13397 " const char *device);\n"
13402 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3154
13403 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13407 #: ../src/guestfs-actions.pod:4670
13408 msgid "guestfs_mkswap_file"
13412 #: ../src/guestfs-actions.pod:4672
13416 " guestfs_mkswap_file (guestfs_h *g,\n"
13417 " const char *path);\n"
13422 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3160
13423 msgid "Create a swap file."
13427 #: ../src/guestfs-actions.pod:4678
13429 "This command just writes a swap file signature to an existing file. To "
13430 "create the file itself, use something like C<guestfs_fallocate>."
13434 #: ../src/guestfs-actions.pod:4685
13435 msgid "guestfs_modprobe"
13439 #: ../src/guestfs-actions.pod:4687
13443 " guestfs_modprobe (guestfs_h *g,\n"
13444 " const char *modulename);\n"
13449 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3169
13450 msgid "This loads a kernel module in the appliance."
13454 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
13456 "The kernel module must have been whitelisted when libguestfs was built (see "
13457 "C<appliance/kmod.whitelist.in> in the source)."
13461 #: ../src/guestfs-actions.pod:4700
13462 msgid "guestfs_mount"
13466 #: ../src/guestfs-actions.pod:4702
13470 " guestfs_mount (guestfs_h *g,\n"
13471 " const char *device,\n"
13472 " const char *mountpoint);\n"
13477 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3178
13479 "Mount a guest disk at a position in the filesystem. Block devices are named "
13480 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13481 "those block devices contain partitions, they will have the usual names "
13482 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13486 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3184
13488 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13489 "mounted on C</> before others can be mounted. Other filesystems can only be "
13490 "mounted on directories which already exist."
13494 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3189
13496 "The mounted filesystem is writable, if we have sufficient permissions on the "
13497 "underlying device."
13501 #: ../src/guestfs-actions.pod:4721
13503 "B<Important note:> When you use this call, the filesystem options C<sync> "
13504 "and C<noatime> are set implicitly. This was originally done because we "
13505 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13506 "very large negative performance impact and negligible effect on "
13507 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13508 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13509 "(use an empty string for the first parameter if you don't want any options)."
13513 #: ../src/guestfs-actions.pod:4735
13514 msgid "guestfs_mount_loop"
13518 #: ../src/guestfs-actions.pod:4737
13522 " guestfs_mount_loop (guestfs_h *g,\n"
13523 " const char *file,\n"
13524 " const char *mountpoint);\n"
13529 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3206
13531 "This command lets you mount C<file> (a filesystem image in a file) on a "
13532 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13537 #: ../src/guestfs-actions.pod:4750
13538 msgid "guestfs_mount_options"
13542 #: ../src/guestfs-actions.pod:4752
13546 " guestfs_mount_options (guestfs_h *g,\n"
13547 " const char *options,\n"
13548 " const char *device,\n"
13549 " const char *mountpoint);\n"
13554 #: ../src/guestfs-actions.pod:4758
13556 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13557 "the mount options as for the L<mount(8)> I<-o> flag."
13561 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3218
13563 "If the C<options> parameter is an empty string, then no options are passed "
13564 "(all options default to whatever the filesystem uses)."
13568 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:4799
13569 msgid "(Added in 1.0.10)"
13573 #: ../src/guestfs-actions.pod:4770
13574 msgid "guestfs_mount_ro"
13578 #: ../src/guestfs-actions.pod:4772
13582 " guestfs_mount_ro (guestfs_h *g,\n"
13583 " const char *device,\n"
13584 " const char *mountpoint);\n"
13589 #: ../src/guestfs-actions.pod:4777
13591 "This is the same as the C<guestfs_mount> command, but it mounts the "
13592 "filesystem with the read-only (I<-o ro>) flag."
13596 #: ../src/guestfs-actions.pod:4784
13597 msgid "guestfs_mount_vfs"
13601 #: ../src/guestfs-actions.pod:4786
13605 " guestfs_mount_vfs (guestfs_h *g,\n"
13606 " const char *options,\n"
13607 " const char *vfstype,\n"
13608 " const char *device,\n"
13609 " const char *mountpoint);\n"
13614 #: ../src/guestfs-actions.pod:4793
13616 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13617 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13622 #: ../src/guestfs-actions.pod:4801
13623 msgid "guestfs_mountpoints"
13627 #: ../src/guestfs-actions.pod:4803
13631 " guestfs_mountpoints (guestfs_h *g);\n"
13636 #: ../src/guestfs-actions.pod:4806
13638 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13639 "devices. This one returns a hash table (map) of device name to directory "
13640 "where the device is mounted."
13644 #: ../src/guestfs-actions.pod:4818
13645 msgid "guestfs_mounts"
13649 #: ../src/guestfs-actions.pod:4820
13653 " guestfs_mounts (guestfs_h *g);\n"
13658 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3249
13660 "This returns the list of currently mounted filesystems. It returns the list "
13661 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13665 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3252
13666 msgid "Some internal mounts are not shown."
13670 #: ../src/guestfs-actions.pod:4828
13671 msgid "See also: C<guestfs_mountpoints>"
13675 #: ../src/guestfs-actions.pod:4836
13680 #: ../src/guestfs-actions.pod:4838
13684 " guestfs_mv (guestfs_h *g,\n"
13685 " const char *src,\n"
13686 " const char *dest);\n"
13691 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3260
13693 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13694 "destination filename or destination directory."
13698 #: ../src/guestfs-actions.pod:4850
13699 msgid "guestfs_ntfs_3g_probe"
13703 #: ../src/guestfs-actions.pod:4852
13707 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13709 " const char *device);\n"
13714 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
13716 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13717 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13718 "read-write, and some cannot be mounted at all)."
13722 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
13724 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13725 "can be mounted read-write. Set it to false if you want to test if the "
13726 "volume can be mounted read-only."
13730 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
13732 "The return value is an integer which C<0> if the operation would succeed, or "
13733 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13737 #: ../src/guestfs-actions.pod:4871
13738 msgid "(Added in 1.0.43)"
13742 #: ../src/guestfs-actions.pod:4873
13743 msgid "guestfs_ntfsresize"
13747 #: ../src/guestfs-actions.pod:4875
13751 " guestfs_ntfsresize (guestfs_h *g,\n"
13752 " const char *device);\n"
13757 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3283
13759 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13760 "size of the underlying device. See also L<ntfsresize(8)>."
13764 #: ../src/guestfs-actions.pod:4887
13765 msgid "guestfs_ntfsresize_size"
13769 #: ../src/guestfs-actions.pod:4889
13773 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13774 " const char *device,\n"
13775 " int64_t size);\n"
13780 #: ../src/guestfs-actions.pod:4894
13782 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13783 "to specify the new size (in bytes) explicitly."
13787 #: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:7245
13788 msgid "(Added in 1.3.14)"
13792 #: ../src/guestfs-actions.pod:4901
13793 msgid "guestfs_part_add"
13797 #: ../src/guestfs-actions.pod:4903
13801 " guestfs_part_add (guestfs_h *g,\n"
13802 " const char *device,\n"
13803 " const char *prlogex,\n"
13804 " int64_t startsect,\n"
13805 " int64_t endsect);\n"
13810 #: ../src/guestfs-actions.pod:4910
13812 "This command adds a partition to C<device>. If there is no partition table "
13813 "on the device, call C<guestfs_part_init> first."
13817 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3301
13819 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13820 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13821 "C<logical>) and C<e> (or C<extended>) partition types."
13825 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3306
13827 "C<startsect> and C<endsect> are the start and end of the partition in "
13828 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13829 "from the end of the disk (C<-1> is the last sector)."
13833 #: ../src/guestfs-actions.pod:4922
13835 "Creating a partition which covers the whole disk is not so easy. Use "
13836 "C<guestfs_part_disk> to do that."
13840 #: ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:4965 ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153 ../src/guestfs-actions.pod:5193
13841 msgid "(Added in 1.0.78)"
13845 #: ../src/guestfs-actions.pod:4929
13846 msgid "guestfs_part_del"
13850 #: ../src/guestfs-actions.pod:4931
13854 " guestfs_part_del (guestfs_h *g,\n"
13855 " const char *device,\n"
13861 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3317
13862 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13866 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3319
13868 "Note that in the case of MBR partitioning, deleting an extended partition "
13869 "also deletes any logical partitions it contains."
13873 #: ../src/guestfs-actions.pod:4946
13874 msgid "guestfs_part_disk"
13878 #: ../src/guestfs-actions.pod:4948
13882 " guestfs_part_disk (guestfs_h *g,\n"
13883 " const char *device,\n"
13884 " const char *parttype);\n"
13889 #: ../src/guestfs-actions.pod:4953
13891 "This command is simply a combination of C<guestfs_part_init> followed by "
13892 "C<guestfs_part_add> to create a single primary partition covering the whole "
13897 #: ../src/guestfs-actions.pod:4957
13899 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13900 "possible values are described in C<guestfs_part_init>."
13904 #: ../src/guestfs-actions.pod:4967
13905 msgid "guestfs_part_get_bootable"
13909 #: ../src/guestfs-actions.pod:4969
13913 " guestfs_part_get_bootable (guestfs_h *g,\n"
13914 " const char *device,\n"
13920 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3341
13922 "This command returns true if the partition C<partnum> on C<device> has the "
13923 "bootable flag set."
13927 #: ../src/guestfs-actions.pod:4977
13928 msgid "See also C<guestfs_part_set_bootable>."
13932 #: ../src/guestfs-actions.pod:4983
13933 msgid "guestfs_part_get_mbr_id"
13937 #: ../src/guestfs-actions.pod:4985
13941 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13942 " const char *device,\n"
13948 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3350
13950 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13951 "partition C<partnum>."
13955 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5169
13957 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13958 "undefined results for other partition table types (see "
13959 "C<guestfs_part_get_parttype>)."
13963 #: ../src/guestfs-actions.pod:5001
13964 msgid "guestfs_part_get_parttype"
13968 #: ../src/guestfs-actions.pod:5003
13972 " guestfs_part_get_parttype (guestfs_h *g,\n"
13973 " const char *device);\n"
13978 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3361
13980 "This command examines the partition table on C<device> and returns the "
13981 "partition table type (format) being used."
13985 #: ../src/guestfs-actions.pod:5010
13987 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13988 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13989 "possible, although unusual. See C<guestfs_part_init> for a full list."
13993 #: ../src/guestfs-actions.pod:5020
13994 msgid "guestfs_part_init"
13998 #: ../src/guestfs-actions.pod:5022
14002 " guestfs_part_init (guestfs_h *g,\n"
14003 " const char *device,\n"
14004 " const char *parttype);\n"
14009 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3373
14011 "This creates an empty partition table on C<device> of one of the partition "
14012 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14013 "(for large disks)."
14017 #: ../src/guestfs-actions.pod:5031
14019 "Initially there are no partitions. Following this, you should call "
14020 "C<guestfs_part_add> for each partition required."
14024 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14025 msgid "Possible values for C<parttype> are:"
14029 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14030 msgid "B<efi> | B<gpt>"
14034 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14035 msgid "Intel EFI / GPT partition table."
14039 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
14041 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14042 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14043 "the C<mbr> format."
14047 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
14048 msgid "B<mbr> | B<msdos>"
14052 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3394
14054 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14055 "Windows. This partition type will B<only> work for device sizes up to 2 "
14056 "TB. For large disks we recommend using C<gpt>."
14060 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
14061 msgid "Other partition table types that may work but are not supported include:"
14065 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14070 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14071 msgid "AIX disk labels."
14075 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14076 msgid "B<amiga> | B<rdb>"
14080 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14081 msgid "Amiga \"Rigid Disk Block\" format."
14085 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14090 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14091 msgid "BSD disk labels."
14095 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14100 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14101 msgid "DASD, used on IBM mainframes."
14105 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14110 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14111 msgid "MIPS/SGI volumes."
14115 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14120 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14121 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14125 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14130 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14131 msgid "NEC PC-98 format, common in Japan apparently."
14135 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14140 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14141 msgid "Sun disk labels."
14145 #: ../src/guestfs-actions.pod:5098
14146 msgid "guestfs_part_list"
14150 #: ../src/guestfs-actions.pod:5100
14153 " struct guestfs_partition_list *\n"
14154 " guestfs_part_list (guestfs_h *g,\n"
14155 " const char *device);\n"
14160 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3444
14162 "This command parses the partition table on C<device> and returns the list of "
14163 "partitions found."
14167 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14168 msgid "The fields in the returned structure are:"
14172 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
14173 msgid "B<part_num>"
14177 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3453
14178 msgid "Partition number, counting from 1."
14182 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
14183 msgid "B<part_start>"
14187 #: ../src/guestfs-actions.pod:5117
14189 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14190 "the device's sector size, see C<guestfs_blockdev_getss>."
14194 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
14195 msgid "B<part_end>"
14199 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
14200 msgid "End of the partition in bytes."
14204 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14205 msgid "B<part_size>"
14209 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14210 msgid "Size of the partition in bytes."
14214 #: ../src/guestfs-actions.pod:5130
14216 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14217 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14222 #: ../src/guestfs-actions.pod:5136
14223 msgid "guestfs_part_set_bootable"
14227 #: ../src/guestfs-actions.pod:5138
14231 " guestfs_part_set_bootable (guestfs_h *g,\n"
14232 " const char *device,\n"
14234 " int bootable);\n"
14239 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3474
14241 "This sets the bootable flag on partition numbered C<partnum> on device "
14242 "C<device>. Note that partitions are numbered from 1."
14246 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3477
14248 "The bootable flag is used by some operating systems (notably Windows) to "
14249 "determine which partition to boot from. It is by no means universally "
14254 #: ../src/guestfs-actions.pod:5155
14255 msgid "guestfs_part_set_mbr_id"
14259 #: ../src/guestfs-actions.pod:5157
14263 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14264 " const char *device,\n"
14271 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3485
14273 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14274 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14275 "documentation are in fact hexadecimal numbers, but usually documented "
14276 "without any leading \"0x\" which might be confusing."
14280 #: ../src/guestfs-actions.pod:5177
14281 msgid "guestfs_part_set_name"
14285 #: ../src/guestfs-actions.pod:5179
14289 " guestfs_part_set_name (guestfs_h *g,\n"
14290 " const char *device,\n"
14292 " const char *name);\n"
14297 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3499
14299 "This sets the partition name on partition numbered C<partnum> on device "
14300 "C<device>. Note that partitions are numbered from 1."
14304 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3502
14306 "The partition name can only be set on certain types of partition table. "
14307 "This works on C<gpt> but not on C<mbr> partitions."
14311 #: ../src/guestfs-actions.pod:5195
14312 msgid "guestfs_part_to_dev"
14316 #: ../src/guestfs-actions.pod:5197
14320 " guestfs_part_to_dev (guestfs_h *g,\n"
14321 " const char *partition);\n"
14326 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3509
14328 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14329 "partition number, returning the device name (eg. \"/dev/sdb\")."
14333 #: ../src/guestfs-actions.pod:5205
14335 "The named partition must exist, for example as a string returned from "
14336 "C<guestfs_list_partitions>."
14340 #: ../src/guestfs-actions.pod:5213
14341 msgid "guestfs_ping_daemon"
14345 #: ../src/guestfs-actions.pod:5215
14349 " guestfs_ping_daemon (guestfs_h *g);\n"
14354 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3520
14356 "This is a test probe into the guestfs daemon running inside the qemu "
14357 "subprocess. Calling this function checks that the daemon responds to the "
14358 "ping message, without affecting the daemon or attached block device(s) in "
14363 #: ../src/guestfs-actions.pod:5227
14364 msgid "guestfs_pread"
14368 #: ../src/guestfs-actions.pod:5229
14372 " guestfs_pread (guestfs_h *g,\n"
14373 " const char *path,\n"
14375 " int64_t offset,\n"
14376 " size_t *size_r);\n"
14381 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3529
14383 "This command lets you read part of a file. It reads C<count> bytes of the "
14384 "file, starting at C<offset>, from file C<path>."
14388 #: ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547
14390 "This may read fewer bytes than requested. For further details see the "
14391 "L<pread(2)> system call."
14395 #: ../src/guestfs-actions.pod:5242
14396 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14400 #: ../src/guestfs-actions.pod:5253
14401 msgid "guestfs_pread_device"
14405 #: ../src/guestfs-actions.pod:5255
14409 " guestfs_pread_device (guestfs_h *g,\n"
14410 " const char *device,\n"
14412 " int64_t offset,\n"
14413 " size_t *size_r);\n"
14418 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3544
14420 "This command lets you read part of a file. It reads C<count> bytes of "
14421 "C<device>, starting at C<offset>."
14425 #: ../src/guestfs-actions.pod:5268
14426 msgid "See also C<guestfs_pread>."
14430 #: ../src/guestfs-actions.pod:5277
14431 msgid "(Added in 1.5.21)"
14435 #: ../src/guestfs-actions.pod:5279
14436 msgid "guestfs_pvcreate"
14440 #: ../src/guestfs-actions.pod:5281
14444 " guestfs_pvcreate (guestfs_h *g,\n"
14445 " const char *device);\n"
14450 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3559
14452 "This creates an LVM physical volume on the named C<device>, where C<device> "
14453 "should usually be a partition name such as C</dev/sda1>."
14457 #: ../src/guestfs-actions.pod:5293
14458 msgid "guestfs_pvremove"
14462 #: ../src/guestfs-actions.pod:5295
14466 " guestfs_pvremove (guestfs_h *g,\n"
14467 " const char *device);\n"
14472 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3567
14474 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14479 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3570
14481 "The implementation uses the C<pvremove> command which refuses to wipe "
14482 "physical volumes that contain any volume groups, so you have to remove those "
14487 #: ../src/guestfs-actions.pod:5310
14488 msgid "guestfs_pvresize"
14492 #: ../src/guestfs-actions.pod:5312
14496 " guestfs_pvresize (guestfs_h *g,\n"
14497 " const char *device);\n"
14502 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3578
14504 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14505 "the new size of the underlying device."
14509 #: ../src/guestfs-actions.pod:5323
14510 msgid "guestfs_pvresize_size"
14514 #: ../src/guestfs-actions.pod:5325
14518 " guestfs_pvresize_size (guestfs_h *g,\n"
14519 " const char *device,\n"
14520 " int64_t size);\n"
14525 #: ../src/guestfs-actions.pod:5330
14527 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14528 "specify the new size (in bytes) explicitly."
14532 #: ../src/guestfs-actions.pod:5337
14533 msgid "guestfs_pvs"
14537 #: ../src/guestfs-actions.pod:5339
14541 " guestfs_pvs (guestfs_h *g);\n"
14546 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3592
14548 "List all the physical volumes detected. This is the equivalent of the "
14549 "L<pvs(8)> command."
14553 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3595
14555 "This returns a list of just the device names that contain PVs "
14556 "(eg. C</dev/sda2>)."
14560 #: ../src/guestfs-actions.pod:5348
14561 msgid "See also C<guestfs_pvs_full>."
14565 #: ../src/guestfs-actions.pod:5356
14566 msgid "guestfs_pvs_full"
14570 #: ../src/guestfs-actions.pod:5358
14573 " struct guestfs_lvm_pv_list *\n"
14574 " guestfs_pvs_full (guestfs_h *g);\n"
14579 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3604
14581 "List all the physical volumes detected. This is the equivalent of the "
14582 "L<pvs(8)> command. The \"full\" version includes all fields."
14586 #: ../src/guestfs-actions.pod:5364
14588 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14589 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14594 #: ../src/guestfs-actions.pod:5370
14595 msgid "guestfs_pvuuid"
14599 #: ../src/guestfs-actions.pod:5372
14603 " guestfs_pvuuid (guestfs_h *g,\n"
14604 " const char *device);\n"
14609 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3611
14610 msgid "This command returns the UUID of the LVM PV C<device>."
14614 #: ../src/guestfs-actions.pod:5383
14615 msgid "guestfs_pwrite"
14619 #: ../src/guestfs-actions.pod:5385
14623 " guestfs_pwrite (guestfs_h *g,\n"
14624 " const char *path,\n"
14625 " const char *content,\n"
14626 " size_t content_size,\n"
14627 " int64_t offset);\n"
14632 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3617
14634 "This command writes to part of a file. It writes the data buffer C<content> "
14635 "to the file C<path> starting at offset C<offset>."
14639 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3620
14641 "This command implements the L<pwrite(2)> system call, and like that system "
14642 "call it may not write the full data requested. The return value is the "
14643 "number of bytes that were actually written to the file. This could even be "
14644 "0, although short writes are unlikely for regular files in ordinary "
14649 #: ../src/guestfs-actions.pod:5401
14650 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14654 #: ../src/guestfs-actions.pod:5410
14655 msgid "guestfs_pwrite_device"
14659 #: ../src/guestfs-actions.pod:5412
14663 " guestfs_pwrite_device (guestfs_h *g,\n"
14664 " const char *device,\n"
14665 " const char *content,\n"
14666 " size_t content_size,\n"
14667 " int64_t offset);\n"
14672 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3635
14674 "This command writes to part of a device. It writes the data buffer "
14675 "C<content> to C<device> starting at offset C<offset>."
14679 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
14681 "This command implements the L<pwrite(2)> system call, and like that system "
14682 "call it may not write the full data requested (although short writes to disk "
14683 "devices and partitions are probably impossible with standard Linux kernels)."
14687 #: ../src/guestfs-actions.pod:5427
14688 msgid "See also C<guestfs_pwrite>."
14692 #: ../src/guestfs-actions.pod:5434
14693 msgid "(Added in 1.5.20)"
14697 #: ../src/guestfs-actions.pod:5436
14698 msgid "guestfs_read_file"
14702 #: ../src/guestfs-actions.pod:5438
14706 " guestfs_read_file (guestfs_h *g,\n"
14707 " const char *path,\n"
14708 " size_t *size_r);\n"
14713 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:3652
14714 msgid "This calls returns the contents of the file C<path> as a buffer."
14718 #: ../src/guestfs-actions.pod:5446
14720 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14721 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14722 "function is limited in the total size of file that can be handled."
14726 #: ../src/guestfs-actions.pod:5458
14727 msgid "(Added in 1.0.63)"
14731 #: ../src/guestfs-actions.pod:5460
14732 msgid "guestfs_read_lines"
14736 #: ../src/guestfs-actions.pod:5462
14740 " guestfs_read_lines (guestfs_h *g,\n"
14741 " const char *path);\n"
14746 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3669
14748 "The file contents are returned as a list of lines. Trailing C<LF> and "
14749 "C<CRLF> character sequences are I<not> returned."
14753 #: ../src/guestfs-actions.pod:5471
14755 "Note that this function cannot correctly handle binary files (specifically, "
14756 "files containing C<\\0> character which is treated as end of line). For "
14757 "those you need to use the C<guestfs_read_file> function which has a more "
14758 "complex interface."
14762 #: ../src/guestfs-actions.pod:5482
14763 msgid "guestfs_readdir"
14767 #: ../src/guestfs-actions.pod:5484
14770 " struct guestfs_dirent_list *\n"
14771 " guestfs_readdir (guestfs_h *g,\n"
14772 " const char *dir);\n"
14777 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3681
14778 msgid "This returns the list of directory entries in directory C<dir>."
14782 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3683
14784 "All entries in the directory are returned, including C<.> and C<..>. The "
14785 "entries are I<not> sorted, but returned in the same order as the underlying "
14790 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
14792 "Also this call returns basic file type information about each file. The "
14793 "C<ftyp> field will contain one of the following characters:"
14797 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
14802 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
14803 msgid "Block special"
14807 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
14812 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
14813 msgid "Char special"
14817 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
14822 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
14827 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
14832 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
14833 msgid "FIFO (named pipe)"
14837 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
14842 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
14843 msgid "Symbolic link"
14847 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
14852 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
14853 msgid "Regular file"
14857 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
14862 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
14867 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
14872 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
14873 msgid "Unknown file type"
14877 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
14882 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
14883 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14887 #: ../src/guestfs-actions.pod:5538
14889 "This function is primarily intended for use by programs. To get a simple "
14890 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14891 "consumption, use C<guestfs_ll>."
14895 #: ../src/guestfs-actions.pod:5542
14897 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14898 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14903 #: ../src/guestfs-actions.pod:5548
14904 msgid "guestfs_readlink"
14908 #: ../src/guestfs-actions.pod:5550
14912 " guestfs_readlink (guestfs_h *g,\n"
14913 " const char *path);\n"
14918 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3739
14919 msgid "This command reads the target of a symbolic link."
14923 #: ../src/guestfs-actions.pod:5561
14924 msgid "guestfs_readlinklist"
14928 #: ../src/guestfs-actions.pod:5563
14932 " guestfs_readlinklist (guestfs_h *g,\n"
14933 " const char *path,\n"
14934 " char *const *names);\n"
14939 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
14941 "This call allows you to do a C<readlink> operation on multiple files, where "
14942 "all files are in the directory C<path>. C<names> is the list of files from "
14947 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
14949 "On return you get a list of strings, with a one-to-one correspondence to the "
14950 "C<names> list. Each string is the value of the symbolic link."
14954 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
14956 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14957 "result string is the empty string C<\"\">. However the whole operation is "
14958 "completed even if there were C<readlink(2)> errors, and so you can call this "
14959 "function with names where you don't know if they are symbolic links already "
14960 "(albeit slightly less efficient)."
14964 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3760
14966 "This call is intended for programs that want to efficiently list a directory "
14967 "contents without making many round-trips. Very long directory listings "
14968 "might cause the protocol message size to be exceeded, causing this call to "
14969 "fail. The caller must split up such requests into smaller groups of names."
14973 #: ../src/guestfs-actions.pod:5596
14974 msgid "guestfs_realpath"
14978 #: ../src/guestfs-actions.pod:5598
14982 " guestfs_realpath (guestfs_h *g,\n"
14983 " const char *path);\n"
14988 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3771
14990 "Return the canonicalized absolute pathname of C<path>. The returned path "
14991 "has no C<.>, C<..> or symbolic link path elements."
14995 #: ../src/guestfs-actions.pod:5610
14996 msgid "guestfs_removexattr"
15000 #: ../src/guestfs-actions.pod:5612
15004 " guestfs_removexattr (guestfs_h *g,\n"
15005 " const char *xattr,\n"
15006 " const char *path);\n"
15011 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3778
15012 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15016 #: ../src/guestfs-actions.pod:5620
15017 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15021 #: ../src/guestfs-actions.pod:5626
15022 msgid "guestfs_resize2fs"
15026 #: ../src/guestfs-actions.pod:5628
15030 " guestfs_resize2fs (guestfs_h *g,\n"
15031 " const char *device);\n"
15036 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3787
15038 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15039 "underlying device."
15043 #: ../src/guestfs-actions.pod:5635
15045 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15046 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15047 "sometimes gives an error about this and sometimes not. In any case, it is "
15048 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15052 #: ../src/guestfs-actions.pod:5645
15053 msgid "guestfs_resize2fs_M"
15057 #: ../src/guestfs-actions.pod:5647
15061 " guestfs_resize2fs_M (guestfs_h *g,\n"
15062 " const char *device);\n"
15067 #: ../src/guestfs-actions.pod:5651
15069 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15070 "resized to its minimum size. This works like the I<-M> option to the "
15071 "C<resize2fs> command."
15075 #: ../src/guestfs-actions.pod:5655
15077 "To get the resulting size of the filesystem you should call "
15078 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15079 "These two numbers, multiplied together, give the resulting size of the "
15080 "minimal filesystem in bytes."
15084 #: ../src/guestfs-actions.pod:5662
15085 msgid "guestfs_resize2fs_size"
15089 #: ../src/guestfs-actions.pod:5664
15093 " guestfs_resize2fs_size (guestfs_h *g,\n"
15094 " const char *device,\n"
15095 " int64_t size);\n"
15100 #: ../src/guestfs-actions.pod:5669
15102 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15103 "to specify the new size (in bytes) explicitly."
15107 #: ../src/guestfs-actions.pod:5676
15112 #: ../src/guestfs-actions.pod:5678
15116 " guestfs_rm (guestfs_h *g,\n"
15117 " const char *path);\n"
15122 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3820
15123 msgid "Remove the single file C<path>."
15127 #: ../src/guestfs-actions.pod:5688
15128 msgid "guestfs_rm_rf"
15132 #: ../src/guestfs-actions.pod:5690
15136 " guestfs_rm_rf (guestfs_h *g,\n"
15137 " const char *path);\n"
15142 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3826
15144 "Remove the file or directory C<path>, recursively removing the contents if "
15145 "its a directory. This is like the C<rm -rf> shell command."
15149 #: ../src/guestfs-actions.pod:5702
15150 msgid "guestfs_rmdir"
15154 #: ../src/guestfs-actions.pod:5704
15158 " guestfs_rmdir (guestfs_h *g,\n"
15159 " const char *path);\n"
15164 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3834
15165 msgid "Remove the single directory C<path>."
15169 #: ../src/guestfs-actions.pod:5714
15170 msgid "guestfs_rmmountpoint"
15174 #: ../src/guestfs-actions.pod:5716
15178 " guestfs_rmmountpoint (guestfs_h *g,\n"
15179 " const char *exemptpath);\n"
15184 #: ../src/guestfs-actions.pod:5720
15186 "This calls removes a mountpoint that was previously created with "
15187 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15191 #: ../src/guestfs-actions.pod:5728
15192 msgid "guestfs_scrub_device"
15196 #: ../src/guestfs-actions.pod:5730
15200 " guestfs_scrub_device (guestfs_h *g,\n"
15201 " const char *device);\n"
15206 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3848
15208 "This command writes patterns over C<device> to make data retrieval more "
15213 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3851 ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:3879
15215 "It is an interface to the L<scrub(1)> program. See that manual page for "
15220 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5782
15221 msgid "(Added in 1.0.52)"
15225 #: ../src/guestfs-actions.pod:5747
15226 msgid "guestfs_scrub_file"
15230 #: ../src/guestfs-actions.pod:5749
15234 " guestfs_scrub_file (guestfs_h *g,\n"
15235 " const char *file);\n"
15240 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3861
15242 "This command writes patterns over a file to make data retrieval more "
15247 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3864
15248 msgid "The file is I<removed> after scrubbing."
15252 #: ../src/guestfs-actions.pod:5765
15253 msgid "guestfs_scrub_freespace"
15257 #: ../src/guestfs-actions.pod:5767
15261 " guestfs_scrub_freespace (guestfs_h *g,\n"
15262 " const char *dir);\n"
15267 #: ../src/guestfs-actions.pod:5771
15269 "This command creates the directory C<dir> and then fills it with files until "
15270 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15271 "and deletes them. The intention is to scrub any free space on the partition "
15272 "containing C<dir>."
15276 #: ../src/guestfs-actions.pod:5784
15277 msgid "guestfs_set_append"
15281 #: ../src/guestfs-actions.pod:5786
15285 " guestfs_set_append (guestfs_h *g,\n"
15286 " const char *append);\n"
15291 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3888
15293 "This function is used to add additional options to the guest kernel command "
15298 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3891
15300 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15301 "environment variable."
15305 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3894
15307 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15308 "(libguestfs always adds a few of its own)."
15312 #: ../src/guestfs-actions.pod:5803
15313 msgid "guestfs_set_attach_method"
15317 #: ../src/guestfs-actions.pod:5805
15321 " guestfs_set_attach_method (guestfs_h *g,\n"
15322 " const char *attachmethod);\n"
15327 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3903
15329 "Set the method that libguestfs uses to connect to the back end guestfsd "
15330 "daemon. Possible methods are:"
15334 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3910
15336 "Launch an appliance and connect to it. This is the ordinary method and the "
15341 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3913
15342 msgid "C<unix:I<path>>"
15346 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3915
15347 msgid "Connect to the Unix domain socket I<path>."
15351 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
15353 "This method lets you connect to an existing daemon or (using virtio-serial) "
15354 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15355 "RUNNING DAEMONS>."
15359 #: ../src/guestfs-actions.pod:5831
15360 msgid "guestfs_set_autosync"
15364 #: ../src/guestfs-actions.pod:5833
15368 " guestfs_set_autosync (guestfs_h *g,\n"
15369 " int autosync);\n"
15374 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3929
15376 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15377 "effort attempt to make filesystems consistent and synchronized when the "
15378 "handle is closed (also if the program exits without closing handles)."
15382 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3934
15384 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15385 "disabled by default)."
15389 #: ../src/guestfs-actions.pod:5849
15390 msgid "guestfs_set_direct"
15394 #: ../src/guestfs-actions.pod:5851
15398 " guestfs_set_direct (guestfs_h *g,\n"
15404 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15406 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15407 "passed directly through to the appliance once it is launched."
15411 #: ../src/guestfs-actions.pod:5859
15413 "One consequence of this is that log messages aren't caught by the library "
15414 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15419 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3951
15420 msgid "You probably don't want to use this unless you know what you are doing."
15424 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3954
15425 msgid "The default is disabled."
15429 #: ../src/guestfs-actions.pod:5872
15430 msgid "guestfs_set_e2label"
15434 #: ../src/guestfs-actions.pod:5874
15438 " guestfs_set_e2label (guestfs_h *g,\n"
15439 " const char *device,\n"
15440 " const char *label);\n"
15445 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
15447 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15448 "C<label>. Filesystem labels are limited to 16 characters."
15452 #: ../src/guestfs-actions.pod:5883
15454 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15455 "the existing label on a filesystem."
15459 #: ../src/guestfs-actions.pod:5890
15460 msgid "guestfs_set_e2uuid"
15464 #: ../src/guestfs-actions.pod:5892
15468 " guestfs_set_e2uuid (guestfs_h *g,\n"
15469 " const char *device,\n"
15470 " const char *uuid);\n"
15475 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3971
15477 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15478 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15479 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15483 #: ../src/guestfs-actions.pod:5902
15485 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15486 "the existing UUID of a filesystem."
15490 #: ../src/guestfs-actions.pod:5909
15491 msgid "guestfs_set_memsize"
15495 #: ../src/guestfs-actions.pod:5911
15499 " guestfs_set_memsize (guestfs_h *g,\n"
15505 #: ../src/guestfs-actions.pod:5915
15507 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15508 "This only has any effect if called before C<guestfs_launch>."
15512 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3989
15514 "You can also change this by setting the environment variable "
15515 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15519 #: ../src/guestfs-actions.pod:5930
15520 msgid "guestfs_set_network"
15524 #: ../src/guestfs-actions.pod:5932
15528 " guestfs_set_network (guestfs_h *g,\n"
15534 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:4002
15536 "If C<network> is true, then the network is enabled in the libguestfs "
15537 "appliance. The default is false."
15541 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4005
15543 "This affects whether commands are able to access the network (see "
15544 "L<guestfs(3)/RUNNING COMMANDS>)."
15548 #: ../src/guestfs-actions.pod:5942
15550 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15555 #: ../src/guestfs-actions.pod:5949
15556 msgid "guestfs_set_path"
15560 #: ../src/guestfs-actions.pod:5951
15564 " guestfs_set_path (guestfs_h *g,\n"
15565 " const char *searchpath);\n"
15570 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4017
15571 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15575 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4019
15577 "The default is C<$libdir/guestfs> unless overridden by setting "
15578 "C<LIBGUESTFS_PATH> environment variable."
15582 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4022
15583 msgid "Setting C<path> to C<NULL> restores the default path."
15587 #: ../src/guestfs-actions.pod:5966
15588 msgid "guestfs_set_qemu"
15592 #: ../src/guestfs-actions.pod:5968
15596 " guestfs_set_qemu (guestfs_h *g,\n"
15597 " const char *qemu);\n"
15602 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15603 msgid "Set the qemu binary that we will use."
15607 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15608 msgid "The default is chosen when the library was compiled by the configure script."
15612 #: ../src/guestfs-actions.pod:5977 ../fish/guestfish-actions.pod:4035
15614 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15619 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4038
15620 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15624 #: ../src/guestfs-actions.pod:5982 ../fish/guestfish-actions.pod:4040
15626 "Note that you should call this function as early as possible after creating "
15627 "the handle. This is because some pre-launch operations depend on testing "
15628 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15629 "don't retest features, and so you might see inconsistent results. Using the "
15630 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15631 "the qemu binary at the same time as the handle is created."
15635 #: ../src/guestfs-actions.pod:5994
15636 msgid "guestfs_set_recovery_proc"
15640 #: ../src/guestfs-actions.pod:5996
15644 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15645 " int recoveryproc);\n"
15650 #: ../src/guestfs-actions.pod:6000
15652 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15653 "not create a recovery process. The purpose of the recovery process is to "
15654 "stop runaway qemu processes in the case where the main program aborts "
15659 #: ../src/guestfs-actions.pod:6005
15661 "This only has any effect if called before C<guestfs_launch>, and the default "
15666 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4062
15668 "About the only time when you would want to disable this is if the main "
15669 "process will fork itself into the background (\"daemonize\" itself). In "
15670 "this case the recovery process thinks that the main program has disappeared "
15671 "and so kills qemu, which is not very helpful."
15675 #: ../src/guestfs-actions.pod:6018
15676 msgid "guestfs_set_selinux"
15680 #: ../src/guestfs-actions.pod:6020
15684 " guestfs_set_selinux (guestfs_h *g,\n"
15690 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4074
15692 "This sets the selinux flag that is passed to the appliance at boot time. "
15693 "The default is C<selinux=0> (disabled)."
15697 #: ../src/guestfs-actions.pod:6027 ../fish/guestfish-actions.pod:4077
15699 "Note that if SELinux is enabled, it is always in Permissive mode "
15700 "(C<enforcing=0>)."
15704 #: ../src/guestfs-actions.pod:6037
15705 msgid "guestfs_set_trace"
15709 #: ../src/guestfs-actions.pod:6039
15713 " guestfs_set_trace (guestfs_h *g,\n"
15719 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4089
15721 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15722 "return values are traced."
15726 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4092
15728 "If you want to trace C API calls into libguestfs (and other libraries) then "
15729 "possibly a better way is to use the external ltrace(1) command."
15733 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
15735 "Command traces are disabled unless the environment variable "
15736 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15740 #: ../src/guestfs-actions.pod:6053
15742 "Trace messages are normally sent to C<stderr>, unless you register a "
15743 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15747 #: ../src/guestfs-actions.pod:6061
15748 msgid "guestfs_set_verbose"
15752 #: ../src/guestfs-actions.pod:6063
15756 " guestfs_set_verbose (guestfs_h *g,\n"
15762 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4109
15763 msgid "If C<verbose> is true, this turns on verbose messages."
15767 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4111
15769 "Verbose messages are disabled unless the environment variable "
15770 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15774 #: ../src/guestfs-actions.pod:6072
15776 "Verbose 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:6080
15782 msgid "guestfs_setcon"
15786 #: ../src/guestfs-actions.pod:6082
15790 " guestfs_setcon (guestfs_h *g,\n"
15791 " const char *context);\n"
15796 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4122
15798 "This sets the SELinux security context of the daemon to the string "
15803 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4125
15804 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15808 #: ../src/guestfs-actions.pod:6095
15809 msgid "guestfs_setxattr"
15813 #: ../src/guestfs-actions.pod:6097
15817 " guestfs_setxattr (guestfs_h *g,\n"
15818 " const char *xattr,\n"
15819 " const char *val,\n"
15821 " const char *path);\n"
15826 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4131
15828 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15829 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15833 #: ../src/guestfs-actions.pod:6108
15834 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15838 #: ../src/guestfs-actions.pod:6114
15839 msgid "guestfs_sfdisk"
15843 #: ../src/guestfs-actions.pod:6116
15847 " guestfs_sfdisk (guestfs_h *g,\n"
15848 " const char *device,\n"
15852 " char *const *lines);\n"
15857 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4141
15859 "This is a direct interface to the L<sfdisk(8)> program for creating "
15860 "partitions on block devices."
15864 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4144
15865 msgid "C<device> should be a block device, for example C</dev/sda>."
15869 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
15871 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15872 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15873 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15874 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15875 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15876 "the kernel) cannot work out the right geometry and you will need to tell it."
15880 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
15882 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15883 "refer to the L<sfdisk(8)> manpage."
15887 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
15889 "To create a single partition occupying the whole disk, you would pass "
15890 "C<lines> as a single element list, when the single element being the string "
15895 #: ../src/guestfs-actions.pod:6144
15896 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15900 #: ../src/guestfs-actions.pod:6154
15901 msgid "guestfs_sfdiskM"
15905 #: ../src/guestfs-actions.pod:6156
15909 " guestfs_sfdiskM (guestfs_h *g,\n"
15910 " const char *device,\n"
15911 " char *const *lines);\n"
15916 #: ../src/guestfs-actions.pod:6161
15918 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15919 "partition sizes are specified in megabytes only (rounded to the nearest "
15920 "cylinder) and you don't need to specify the cyls, heads and sectors "
15921 "parameters which were rarely if ever used anyway."
15925 #: ../src/guestfs-actions.pod:6167
15927 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15928 "C<guestfs_part_disk>"
15932 #: ../src/guestfs-actions.pod:6177
15933 msgid "guestfs_sfdisk_N"
15937 #: ../src/guestfs-actions.pod:6179
15941 " guestfs_sfdisk_N (guestfs_h *g,\n"
15942 " const char *device,\n"
15947 " const char *line);\n"
15952 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4187
15954 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15955 "(note: C<n> counts from 1)."
15959 #: ../src/guestfs-actions.pod:6191
15961 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15962 "for the cyls/heads/sectors parameters."
15966 #: ../src/guestfs-actions.pod:6194
15967 msgid "See also: C<guestfs_part_add>"
15971 #: ../src/guestfs-actions.pod:6203
15972 msgid "guestfs_sfdisk_disk_geometry"
15976 #: ../src/guestfs-actions.pod:6205
15980 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
15981 " const char *device);\n"
15986 #: ../src/guestfs-actions.pod:6209
15988 "This displays the disk geometry of C<device> read from the partition table. "
15989 "Especially in the case where the underlying block device has been resized, "
15990 "this can be different from the kernel's idea of the geometry (see "
15991 "C<guestfs_sfdisk_kernel_geometry>)."
15995 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4216
15996 msgid "The result is in human-readable format, and not designed to be parsed."
16000 #: ../src/guestfs-actions.pod:6222
16001 msgid "guestfs_sfdisk_kernel_geometry"
16005 #: ../src/guestfs-actions.pod:6224
16009 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16010 " const char *device);\n"
16015 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4214
16016 msgid "This displays the kernel's idea of the geometry of C<device>."
16020 #: ../src/guestfs-actions.pod:6238
16021 msgid "guestfs_sfdisk_l"
16025 #: ../src/guestfs-actions.pod:6240
16029 " guestfs_sfdisk_l (guestfs_h *g,\n"
16030 " const char *device);\n"
16035 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4223
16037 "This displays the partition table on C<device>, in the human-readable output "
16038 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16042 #: ../src/guestfs-actions.pod:6248
16043 msgid "See also: C<guestfs_part_list>"
16047 #: ../src/guestfs-actions.pod:6255
16052 #: ../src/guestfs-actions.pod:6257
16056 " guestfs_sh (guestfs_h *g,\n"
16057 " const char *command);\n"
16062 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4233
16064 "This call runs a command from the guest filesystem via the guest's "
16069 #: ../src/guestfs-actions.pod:6264
16070 msgid "This is like C<guestfs_command>, but passes the command to:"
16074 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4238
16077 " /bin/sh -c \"command\"\n"
16082 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4240
16084 "Depending on the guest's shell, this usually results in wildcards being "
16085 "expanded, shell expressions being interpolated and so on."
16089 #: ../src/guestfs-actions.pod:6272
16090 msgid "All the provisos about C<guestfs_command> apply to this call."
16094 #: ../src/guestfs-actions.pod:6279
16095 msgid "guestfs_sh_lines"
16099 #: ../src/guestfs-actions.pod:6281
16103 " guestfs_sh_lines (guestfs_h *g,\n"
16104 " const char *command);\n"
16109 #: ../src/guestfs-actions.pod:6285
16111 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16116 #: ../src/guestfs-actions.pod:6288
16117 msgid "See also: C<guestfs_command_lines>"
16121 #: ../src/guestfs-actions.pod:6296
16122 msgid "guestfs_sleep"
16126 #: ../src/guestfs-actions.pod:6298
16130 " guestfs_sleep (guestfs_h *g,\n"
16136 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4259
16137 msgid "Sleep for C<secs> seconds."
16141 #: ../src/guestfs-actions.pod:6306
16142 msgid "(Added in 1.0.41)"
16146 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-structs.pod:109
16147 msgid "guestfs_stat"
16151 #: ../src/guestfs-actions.pod:6310
16154 " struct guestfs_stat *\n"
16155 " guestfs_stat (guestfs_h *g,\n"
16156 " const char *path);\n"
16161 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4267
16162 msgid "This is the same as the C<stat(2)> system call."
16166 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-structs.pod:135
16167 msgid "guestfs_statvfs"
16171 #: ../src/guestfs-actions.pod:6326
16174 " struct guestfs_statvfs *\n"
16175 " guestfs_statvfs (guestfs_h *g,\n"
16176 " const char *path);\n"
16181 #: ../src/guestfs-actions.pod:6330 ../fish/guestfish-actions.pod:4273
16183 "Returns file system statistics for any mounted file system. C<path> should "
16184 "be a file or directory in the mounted file system (typically it is the mount "
16185 "point itself, but it doesn't need to be)."
16189 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4277
16190 msgid "This is the same as the C<statvfs(2)> system call."
16194 #: ../src/guestfs-actions.pod:6336
16196 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16197 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16201 #: ../src/guestfs-actions.pod:6342
16202 msgid "guestfs_strings"
16206 #: ../src/guestfs-actions.pod:6344
16210 " guestfs_strings (guestfs_h *g,\n"
16211 " const char *path);\n"
16216 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4283
16218 "This runs the L<strings(1)> command on a file and returns the list of "
16219 "printable strings found."
16223 #: ../src/guestfs-actions.pod:6360
16224 msgid "guestfs_strings_e"
16228 #: ../src/guestfs-actions.pod:6362
16232 " guestfs_strings_e (guestfs_h *g,\n"
16233 " const char *encoding,\n"
16234 " const char *path);\n"
16239 #: ../src/guestfs-actions.pod:6367
16241 "This is like the C<guestfs_strings> command, but allows you to specify the "
16242 "encoding of strings that are looked for in the source file C<path>."
16246 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4297
16247 msgid "Allowed encodings are:"
16251 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4301
16256 #: ../src/guestfs-actions.pod:6377
16258 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16259 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16263 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4306
16268 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4308
16269 msgid "Single 8-bit-byte characters."
16273 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4310
16278 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16279 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16283 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4315
16284 msgid "l (lower case letter L)"
16288 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4317
16290 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16291 "examining binaries in Windows guests."
16295 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4320
16300 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16301 msgid "32-bit big endian such as UCS-4BE."
16305 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4324
16310 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4326
16311 msgid "32-bit little endian such as UCS-4LE."
16315 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4330
16316 msgid "The returned strings are transcoded to UTF-8."
16320 #: ../src/guestfs-actions.pod:6415
16321 msgid "guestfs_swapoff_device"
16325 #: ../src/guestfs-actions.pod:6417
16329 " guestfs_swapoff_device (guestfs_h *g,\n"
16330 " const char *device);\n"
16335 #: ../src/guestfs-actions.pod:6421
16337 "This command disables the libguestfs appliance swap device or partition "
16338 "named C<device>. See C<guestfs_swapon_device>."
16342 #: ../src/guestfs-actions.pod:6429
16343 msgid "guestfs_swapoff_file"
16347 #: ../src/guestfs-actions.pod:6431
16351 " guestfs_swapoff_file (guestfs_h *g,\n"
16352 " const char *file);\n"
16357 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4347
16358 msgid "This command disables the libguestfs appliance swap on file."
16362 #: ../src/guestfs-actions.pod:6441
16363 msgid "guestfs_swapoff_label"
16367 #: ../src/guestfs-actions.pod:6443
16371 " guestfs_swapoff_label (guestfs_h *g,\n"
16372 " const char *label);\n"
16377 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4353
16379 "This command disables the libguestfs appliance swap on labeled swap "
16384 #: ../src/guestfs-actions.pod:6454
16385 msgid "guestfs_swapoff_uuid"
16389 #: ../src/guestfs-actions.pod:6456
16393 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16394 " const char *uuid);\n"
16399 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4360
16401 "This command disables the libguestfs appliance swap partition with the given "
16406 #: ../src/guestfs-actions.pod:6467
16407 msgid "guestfs_swapon_device"
16411 #: ../src/guestfs-actions.pod:6469
16415 " guestfs_swapon_device (guestfs_h *g,\n"
16416 " const char *device);\n"
16421 #: ../src/guestfs-actions.pod:6473
16423 "This command enables the libguestfs appliance to use the swap device or "
16424 "partition named C<device>. The increased memory is made available for all "
16425 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16429 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4372
16431 "Note that you should not swap to existing guest swap partitions unless you "
16432 "know what you are doing. They may contain hibernation information, or other "
16433 "information that the guest doesn't want you to trash. You also risk leaking "
16434 "information about the host to the guest this way. Instead, attach a new "
16435 "host device to the guest and swap on that."
16439 #: ../src/guestfs-actions.pod:6489
16440 msgid "guestfs_swapon_file"
16444 #: ../src/guestfs-actions.pod:6491
16448 " guestfs_swapon_file (guestfs_h *g,\n"
16449 " const char *file);\n"
16454 #: ../src/guestfs-actions.pod:6495
16456 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16461 #: ../src/guestfs-actions.pod:6502
16462 msgid "guestfs_swapon_label"
16466 #: ../src/guestfs-actions.pod:6504
16470 " guestfs_swapon_label (guestfs_h *g,\n"
16471 " const char *label);\n"
16476 #: ../src/guestfs-actions.pod:6508
16478 "This command enables swap to a labeled swap partition. See "
16479 "C<guestfs_swapon_device> for other notes."
16483 #: ../src/guestfs-actions.pod:6515
16484 msgid "guestfs_swapon_uuid"
16488 #: ../src/guestfs-actions.pod:6517
16492 " guestfs_swapon_uuid (guestfs_h *g,\n"
16493 " const char *uuid);\n"
16498 #: ../src/guestfs-actions.pod:6521
16500 "This command enables swap to a swap partition with the given UUID. See "
16501 "C<guestfs_swapon_device> for other notes."
16505 #: ../src/guestfs-actions.pod:6528
16506 msgid "guestfs_sync"
16510 #: ../src/guestfs-actions.pod:6530
16514 " guestfs_sync (guestfs_h *g);\n"
16519 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4404
16521 "This syncs the disk, so that any writes are flushed through to the "
16522 "underlying disk image."
16526 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4407
16528 "You should always call this if you have modified a disk image, before "
16529 "closing the handle."
16533 #: ../src/guestfs-actions.pod:6543
16534 msgid "guestfs_tail"
16538 #: ../src/guestfs-actions.pod:6545
16542 " guestfs_tail (guestfs_h *g,\n"
16543 " const char *path);\n"
16548 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4414
16549 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16553 #: ../src/guestfs-actions.pod:6561
16554 msgid "guestfs_tail_n"
16558 #: ../src/guestfs-actions.pod:6563
16562 " guestfs_tail_n (guestfs_h *g,\n"
16564 " const char *path);\n"
16569 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4424
16571 "If the parameter C<nrlines> is a positive number, this returns the last "
16572 "C<nrlines> lines of the file C<path>."
16576 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4427
16578 "If the parameter C<nrlines> is a negative number, this returns lines from "
16579 "the file C<path>, starting with the C<-nrlines>th line."
16583 #: ../src/guestfs-actions.pod:6585
16584 msgid "guestfs_tar_in"
16588 #: ../src/guestfs-actions.pod:6587
16592 " guestfs_tar_in (guestfs_h *g,\n"
16593 " const char *tarfile,\n"
16594 " const char *directory);\n"
16599 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4439
16601 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16602 "tar file) into C<directory>."
16606 #: ../src/guestfs-actions.pod:6595
16607 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16611 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6649
16612 msgid "(Added in 1.0.3)"
16616 #: ../src/guestfs-actions.pod:6602
16617 msgid "guestfs_tar_out"
16621 #: ../src/guestfs-actions.pod:6604
16625 " guestfs_tar_out (guestfs_h *g,\n"
16626 " const char *directory,\n"
16627 " const char *tarfile);\n"
16632 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4451
16634 "This command packs the contents of C<directory> and downloads it to local "
16639 #: ../src/guestfs-actions.pod:6612
16641 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16642 "C<guestfs_txz_out>."
16646 #: ../src/guestfs-actions.pod:6619
16647 msgid "guestfs_tgz_in"
16651 #: ../src/guestfs-actions.pod:6621
16655 " guestfs_tgz_in (guestfs_h *g,\n"
16656 " const char *tarball,\n"
16657 " const char *directory);\n"
16662 #: ../src/guestfs-actions.pod:6626 ../fish/guestfish-actions.pod:4463
16664 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16665 "tar file) into C<directory>."
16669 #: ../src/guestfs-actions.pod:6629
16670 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16674 #: ../src/guestfs-actions.pod:6635
16675 msgid "guestfs_tgz_out"
16679 #: ../src/guestfs-actions.pod:6637
16683 " guestfs_tgz_out (guestfs_h *g,\n"
16684 " const char *directory,\n"
16685 " const char *tarball);\n"
16690 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4474
16692 "This command packs the contents of C<directory> and downloads it to local "
16697 #: ../src/guestfs-actions.pod:6645
16698 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16702 #: ../src/guestfs-actions.pod:6651
16703 msgid "guestfs_touch"
16707 #: ../src/guestfs-actions.pod:6653
16711 " guestfs_touch (guestfs_h *g,\n"
16712 " const char *path);\n"
16717 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4485
16719 "Touch acts like the L<touch(1)> command. It can be used to update the "
16720 "timestamps on a file, or, if the file does not exist, to create a new "
16721 "zero-length file."
16725 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4489
16727 "This command only works on regular files, and will fail on other file types "
16728 "such as directories, symbolic links, block special etc."
16732 #: ../src/guestfs-actions.pod:6668
16733 msgid "guestfs_truncate"
16737 #: ../src/guestfs-actions.pod:6670
16741 " guestfs_truncate (guestfs_h *g,\n"
16742 " const char *path);\n"
16747 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4496
16749 "This command truncates C<path> to a zero-length file. The file must exist "
16754 #: ../src/guestfs-actions.pod:6681
16755 msgid "guestfs_truncate_size"
16759 #: ../src/guestfs-actions.pod:6683
16763 " guestfs_truncate_size (guestfs_h *g,\n"
16764 " const char *path,\n"
16765 " int64_t size);\n"
16770 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4503
16772 "This command truncates C<path> to size C<size> bytes. The file must exist "
16777 #: ../src/guestfs-actions.pod:6691
16779 "If the current file size is less than C<size> then the file is extended to "
16780 "the required size with zero bytes. This creates a sparse file (ie. disk "
16781 "blocks are not allocated for the file until you write to it). To create a "
16782 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16786 #: ../src/guestfs-actions.pod:6701
16787 msgid "guestfs_tune2fs_l"
16791 #: ../src/guestfs-actions.pod:6703
16795 " guestfs_tune2fs_l (guestfs_h *g,\n"
16796 " const char *device);\n"
16801 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4516
16803 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16808 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4519
16810 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16811 "for more details. The list of fields returned isn't clearly defined, and "
16812 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16813 "and the filesystem itself."
16817 #: ../src/guestfs-actions.pod:6723
16818 msgid "guestfs_txz_in"
16822 #: ../src/guestfs-actions.pod:6725
16826 " guestfs_txz_in (guestfs_h *g,\n"
16827 " const char *tarball,\n"
16828 " const char *directory);\n"
16833 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4528
16835 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16836 "tar file) into C<directory>."
16840 #: ../src/guestfs-actions.pod:6737
16841 msgid "guestfs_txz_out"
16845 #: ../src/guestfs-actions.pod:6739
16849 " guestfs_txz_out (guestfs_h *g,\n"
16850 " const char *directory,\n"
16851 " const char *tarball);\n"
16856 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4537
16858 "This command packs the contents of C<directory> and downloads it to local "
16859 "file C<tarball> (as an xz compressed tar archive)."
16863 #: ../src/guestfs-actions.pod:6751
16864 msgid "guestfs_umask"
16868 #: ../src/guestfs-actions.pod:6753
16872 " guestfs_umask (guestfs_h *g,\n"
16878 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
16880 "This function sets the mask used for creating new files and device nodes to "
16885 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4549
16887 "Typical umask values would be C<022> which creates new files with "
16888 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16889 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16893 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4554
16895 "The default umask is C<022>. This is important because it means that "
16896 "directories and device nodes will be created with C<0644> or C<0755> mode "
16897 "even if you specify C<0777>."
16901 #: ../src/guestfs-actions.pod:6769
16903 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16904 "C<guestfs_mkdir>."
16908 #: ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:4561
16909 msgid "This call returns the previous umask."
16913 #: ../src/guestfs-actions.pod:6778
16914 msgid "guestfs_umount"
16918 #: ../src/guestfs-actions.pod:6780
16922 " guestfs_umount (guestfs_h *g,\n"
16923 " const char *pathordevice);\n"
16928 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4569
16930 "This unmounts the given filesystem. The filesystem may be specified either "
16931 "by its mountpoint (path) or the device which contains the filesystem."
16935 #: ../src/guestfs-actions.pod:6792
16936 msgid "guestfs_umount_all"
16940 #: ../src/guestfs-actions.pod:6794
16944 " guestfs_umount_all (guestfs_h *g);\n"
16949 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4579
16950 msgid "This unmounts all mounted filesystems."
16954 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4581
16955 msgid "Some internal mounts are not unmounted by this call."
16959 #: ../src/guestfs-actions.pod:6805
16960 msgid "guestfs_upload"
16964 #: ../src/guestfs-actions.pod:6807
16968 " guestfs_upload (guestfs_h *g,\n"
16969 " const char *filename,\n"
16970 " const char *remotefilename);\n"
16975 #: ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6836 ../fish/guestfish-actions.pod:4587 ../fish/guestfish-actions.pod:4600
16976 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
16980 #: ../src/guestfs-actions.pod:6817
16981 msgid "See also C<guestfs_download>."
16985 #: ../src/guestfs-actions.pod:6828
16986 msgid "guestfs_upload_offset"
16990 #: ../src/guestfs-actions.pod:6830
16994 " guestfs_upload_offset (guestfs_h *g,\n"
16995 " const char *filename,\n"
16996 " const char *remotefilename,\n"
16997 " int64_t offset);\n"
17002 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4603
17004 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17005 "The intention is to overwrite parts of existing files or devices, although "
17006 "if a non-existant file is specified then it is created with a \"hole\" "
17007 "before C<offset>. The size of the data written is implicit in the size of "
17008 "the source C<filename>."
17012 #: ../src/guestfs-actions.pod:6846
17014 "Note that there is no limit on the amount of data that can be uploaded with "
17015 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17016 "full amount unless an error occurs."
17020 #: ../src/guestfs-actions.pod:6851
17021 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17025 #: ../src/guestfs-actions.pod:6862
17026 msgid "guestfs_utimens"
17030 #: ../src/guestfs-actions.pod:6864
17034 " guestfs_utimens (guestfs_h *g,\n"
17035 " const char *path,\n"
17036 " int64_t atsecs,\n"
17037 " int64_t atnsecs,\n"
17038 " int64_t mtsecs,\n"
17039 " int64_t mtnsecs);\n"
17044 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4623
17045 msgid "This command sets the timestamps of a file with nanosecond precision."
17049 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4626
17051 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17056 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4629
17058 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17059 "nanoseconds from the epoch."
17063 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4632
17065 "If the C<*nsecs> field contains the special value C<-1> then the "
17066 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17067 "ignored in this case)."
17071 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4636
17073 "If the C<*nsecs> field contains the special value C<-2> then the "
17074 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17079 #: ../src/guestfs-actions.pod:6893 ../src/guestfs-structs.pod:175
17080 msgid "guestfs_version"
17084 #: ../src/guestfs-actions.pod:6895
17087 " struct guestfs_version *\n"
17088 " guestfs_version (guestfs_h *g);\n"
17093 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17094 msgid "Return the libguestfs version number that the program is linked against."
17098 #: ../src/guestfs-actions.pod:6901 ../fish/guestfish-actions.pod:4647
17100 "Note that because of dynamic linking this is not necessarily the version of "
17101 "libguestfs that you compiled against. You can compile the program, and then "
17102 "at runtime dynamically link against a completely different C<libguestfs.so> "
17107 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4652
17109 "This call was added in version C<1.0.58>. In previous versions of "
17110 "libguestfs there was no way to get the version number. From C code you can "
17111 "use dynamic linker functions to find out if this symbol exists (if it "
17112 "doesn't, then it's an earlier version)."
17116 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4658
17118 "The call returns a structure with four elements. The first three (C<major>, "
17119 "C<minor> and C<release>) are numbers and correspond to the usual version "
17120 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17121 "but may be used for distro-specific information."
17125 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4664
17126 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17130 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4667
17131 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17135 #: ../src/guestfs-actions.pod:6923
17137 "I<Note:> Don't use this call to test for availability of features. In "
17138 "enterprise distributions we backport features from later versions into "
17139 "earlier versions, making this an unreliable way to test for features. Use "
17140 "C<guestfs_available> instead."
17144 #: ../src/guestfs-actions.pod:6929
17146 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17147 "error. I<The caller must call C<guestfs_free_version> after use>."
17151 #: ../src/guestfs-actions.pod:6933
17152 msgid "(Added in 1.0.58)"
17156 #: ../src/guestfs-actions.pod:6935
17157 msgid "guestfs_vfs_label"
17161 #: ../src/guestfs-actions.pod:6937
17165 " guestfs_vfs_label (guestfs_h *g,\n"
17166 " const char *device);\n"
17171 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4679
17172 msgid "This returns the filesystem label of the filesystem on C<device>."
17176 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4682
17177 msgid "If the filesystem is unlabeled, this returns the empty string."
17181 #: ../src/guestfs-actions.pod:6946
17182 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17186 #: ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6988
17187 msgid "(Added in 1.3.18)"
17191 #: ../src/guestfs-actions.pod:6953
17192 msgid "guestfs_vfs_type"
17196 #: ../src/guestfs-actions.pod:6955
17200 " guestfs_vfs_type (guestfs_h *g,\n"
17201 " const char *device);\n"
17206 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4690
17208 "This command gets the filesystem type corresponding to the filesystem on "
17213 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4693
17215 "For most filesystems, the result is the name of the Linux VFS module which "
17216 "would be used to mount this filesystem if you mounted it without specifying "
17217 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17221 #: ../src/guestfs-actions.pod:6972
17222 msgid "guestfs_vfs_uuid"
17226 #: ../src/guestfs-actions.pod:6974
17230 " guestfs_vfs_uuid (guestfs_h *g,\n"
17231 " const char *device);\n"
17236 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4702
17237 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17241 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4705
17242 msgid "If the filesystem does not have a UUID, this returns the empty string."
17246 #: ../src/guestfs-actions.pod:6983
17247 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17251 #: ../src/guestfs-actions.pod:6990
17252 msgid "guestfs_vg_activate"
17256 #: ../src/guestfs-actions.pod:6992
17260 " guestfs_vg_activate (guestfs_h *g,\n"
17262 " char *const *volgroups);\n"
17267 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17269 "This command activates or (if C<activate> is false) deactivates all logical "
17270 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17271 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17272 "deactivated, then those devices disappear."
17276 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4719
17277 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17281 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4721
17283 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17284 "activated or deactivated."
17288 #: ../src/guestfs-actions.pod:7012
17289 msgid "guestfs_vg_activate_all"
17293 #: ../src/guestfs-actions.pod:7014
17297 " guestfs_vg_activate_all (guestfs_h *g,\n"
17298 " int activate);\n"
17303 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4728
17305 "This command activates or (if C<activate> is false) deactivates all logical "
17306 "volumes in all volume groups. If activated, then they are made known to the "
17307 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17308 "those devices disappear."
17312 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4734
17313 msgid "This command is the same as running C<vgchange -a y|n>"
17317 #: ../src/guestfs-actions.pod:7030
17318 msgid "guestfs_vgcreate"
17322 #: ../src/guestfs-actions.pod:7032
17326 " guestfs_vgcreate (guestfs_h *g,\n"
17327 " const char *volgroup,\n"
17328 " char *const *physvols);\n"
17333 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4740
17335 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17336 "of physical volumes C<physvols>."
17340 #: ../src/guestfs-actions.pod:7044
17341 msgid "guestfs_vglvuuids"
17345 #: ../src/guestfs-actions.pod:7046
17349 " guestfs_vglvuuids (guestfs_h *g,\n"
17350 " const char *vgname);\n"
17355 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4747
17357 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17358 "volumes created in this volume group."
17362 #: ../src/guestfs-actions.pod:7053
17364 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17365 "associate logical volumes and volume groups."
17369 #: ../src/guestfs-actions.pod:7056
17370 msgid "See also C<guestfs_vgpvuuids>."
17374 #: ../src/guestfs-actions.pod:7064
17375 msgid "guestfs_vgpvuuids"
17379 #: ../src/guestfs-actions.pod:7066
17383 " guestfs_vgpvuuids (guestfs_h *g,\n"
17384 " const char *vgname);\n"
17389 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4759
17391 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17392 "volumes that this volume group resides on."
17396 #: ../src/guestfs-actions.pod:7073
17398 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17399 "associate physical volumes and volume groups."
17403 #: ../src/guestfs-actions.pod:7076
17404 msgid "See also C<guestfs_vglvuuids>."
17408 #: ../src/guestfs-actions.pod:7084
17409 msgid "guestfs_vgremove"
17413 #: ../src/guestfs-actions.pod:7086
17417 " guestfs_vgremove (guestfs_h *g,\n"
17418 " const char *vgname);\n"
17423 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4771
17424 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17428 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4773
17429 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17433 #: ../src/guestfs-actions.pod:7099
17434 msgid "guestfs_vgrename"
17438 #: ../src/guestfs-actions.pod:7101
17442 " guestfs_vgrename (guestfs_h *g,\n"
17443 " const char *volgroup,\n"
17444 " const char *newvolgroup);\n"
17449 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4780
17450 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17454 #: ../src/guestfs-actions.pod:7112
17455 msgid "guestfs_vgs"
17459 #: ../src/guestfs-actions.pod:7114
17463 " guestfs_vgs (guestfs_h *g);\n"
17468 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4786
17470 "List all the volumes groups detected. This is the equivalent of the "
17471 "L<vgs(8)> command."
17475 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4789
17477 "This returns a list of just the volume group names that were detected "
17478 "(eg. C<VolGroup00>)."
17482 #: ../src/guestfs-actions.pod:7123
17483 msgid "See also C<guestfs_vgs_full>."
17487 #: ../src/guestfs-actions.pod:7131
17488 msgid "guestfs_vgs_full"
17492 #: ../src/guestfs-actions.pod:7133
17495 " struct guestfs_lvm_vg_list *\n"
17496 " guestfs_vgs_full (guestfs_h *g);\n"
17501 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4798
17503 "List all the volumes groups detected. This is the equivalent of the "
17504 "L<vgs(8)> command. The \"full\" version includes all fields."
17508 #: ../src/guestfs-actions.pod:7139
17510 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17511 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17516 #: ../src/guestfs-actions.pod:7145
17517 msgid "guestfs_vgscan"
17521 #: ../src/guestfs-actions.pod:7147
17525 " guestfs_vgscan (guestfs_h *g);\n"
17530 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:4805
17532 "This rescans all block devices and rebuilds the list of LVM physical "
17533 "volumes, volume groups and logical volumes."
17537 #: ../src/guestfs-actions.pod:7157
17538 msgid "guestfs_vguuid"
17542 #: ../src/guestfs-actions.pod:7159
17546 " guestfs_vguuid (guestfs_h *g,\n"
17547 " const char *vgname);\n"
17552 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4812
17553 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17557 #: ../src/guestfs-actions.pod:7170
17558 msgid "guestfs_wait_ready"
17562 #: ../src/guestfs-actions.pod:7172
17566 " guestfs_wait_ready (guestfs_h *g);\n"
17571 #: ../src/guestfs-actions.pod:7175
17572 msgid "This function is a no op."
17576 #: ../src/guestfs-actions.pod:7177
17578 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17579 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17580 "is no longer necessary because C<guestfs_launch> now does the waiting."
17584 #: ../src/guestfs-actions.pod:7182
17586 "If you see any calls to this function in code then you can just remove them, "
17587 "unless you want to retain compatibility with older versions of the API."
17591 #: ../src/guestfs-actions.pod:7190
17592 msgid "guestfs_wc_c"
17596 #: ../src/guestfs-actions.pod:7192
17600 " guestfs_wc_c (guestfs_h *g,\n"
17601 " const char *path);\n"
17606 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4818
17608 "This command counts the characters in a file, using the C<wc -c> external "
17613 #: ../src/guestfs-actions.pod:7203
17614 msgid "guestfs_wc_l"
17618 #: ../src/guestfs-actions.pod:7205
17622 " guestfs_wc_l (guestfs_h *g,\n"
17623 " const char *path);\n"
17628 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4825
17630 "This command counts the lines in a file, using the C<wc -l> external "
17635 #: ../src/guestfs-actions.pod:7216
17636 msgid "guestfs_wc_w"
17640 #: ../src/guestfs-actions.pod:7218
17644 " guestfs_wc_w (guestfs_h *g,\n"
17645 " const char *path);\n"
17650 #: ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:4832
17652 "This command counts the words in a file, using the C<wc -w> external "
17657 #: ../src/guestfs-actions.pod:7229
17658 msgid "guestfs_write"
17662 #: ../src/guestfs-actions.pod:7231
17666 " guestfs_write (guestfs_h *g,\n"
17667 " const char *path,\n"
17668 " const char *content,\n"
17669 " size_t content_size);\n"
17674 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4839
17676 "This call creates a file called C<path>. The content of the file is the "
17677 "string C<content> (which can contain any 8 bit data)."
17681 #: ../src/guestfs-actions.pod:7247
17682 msgid "guestfs_write_file"
17686 #: ../src/guestfs-actions.pod:7249
17690 " guestfs_write_file (guestfs_h *g,\n"
17691 " const char *path,\n"
17692 " const char *content,\n"
17698 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
17700 "This call creates a file called C<path>. The contents of the file is the "
17701 "string C<content> (which can contain any 8 bit data), with length C<size>."
17705 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4853
17707 "As a special case, if C<size> is C<0> then the length is calculated using "
17708 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17712 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4857
17714 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17715 "I<not> work, even if the length is specified."
17719 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4863
17720 msgid "This function is deprecated. In new code, use the C<write> call instead."
17724 #: ../src/guestfs-actions.pod:7280
17725 msgid "guestfs_zegrep"
17729 #: ../src/guestfs-actions.pod:7282
17733 " guestfs_zegrep (guestfs_h *g,\n"
17734 " const char *regex,\n"
17735 " const char *path);\n"
17740 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4874
17741 msgid "This calls the external C<zegrep> program and returns the matching lines."
17745 #: ../src/guestfs-actions.pod:7299
17746 msgid "guestfs_zegrepi"
17750 #: ../src/guestfs-actions.pod:7301
17754 " guestfs_zegrepi (guestfs_h *g,\n"
17755 " const char *regex,\n"
17756 " const char *path);\n"
17761 #: ../src/guestfs-actions.pod:7306 ../fish/guestfish-actions.pod:4884
17762 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17766 #: ../src/guestfs-actions.pod:7318
17767 msgid "guestfs_zero"
17771 #: ../src/guestfs-actions.pod:7320
17775 " guestfs_zero (guestfs_h *g,\n"
17776 " const char *device);\n"
17781 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4894
17782 msgid "This command writes zeroes over the first few blocks of C<device>."
17786 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4896
17788 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17789 "securely wipe the device). It should be sufficient to remove any partition "
17790 "tables, filesystem superblocks and so on."
17794 #: ../src/guestfs-actions.pod:7330
17795 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17799 #: ../src/guestfs-actions.pod:7341
17800 msgid "guestfs_zero_device"
17804 #: ../src/guestfs-actions.pod:7343
17808 " guestfs_zero_device (guestfs_h *g,\n"
17809 " const char *device);\n"
17814 #: ../src/guestfs-actions.pod:7347
17816 "This command writes zeroes over the entire C<device>. Compare with "
17817 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17821 #: ../src/guestfs-actions.pod:7361
17822 msgid "(Added in 1.3.1)"
17826 #: ../src/guestfs-actions.pod:7363
17827 msgid "guestfs_zerofree"
17831 #: ../src/guestfs-actions.pod:7365
17835 " guestfs_zerofree (guestfs_h *g,\n"
17836 " const char *device);\n"
17841 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
17843 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17844 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17845 "possible to compress the filesystem more effectively."
17849 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4922
17850 msgid "You should B<not> run this program if the filesystem is mounted."
17854 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4925
17856 "It is possible that using this program can damage the filesystem or data on "
17861 #: ../src/guestfs-actions.pod:7384
17862 msgid "guestfs_zfgrep"
17866 #: ../src/guestfs-actions.pod:7386
17870 " guestfs_zfgrep (guestfs_h *g,\n"
17871 " const char *pattern,\n"
17872 " const char *path);\n"
17877 #: ../src/guestfs-actions.pod:7391 ../fish/guestfish-actions.pod:4932
17878 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17882 #: ../src/guestfs-actions.pod:7403
17883 msgid "guestfs_zfgrepi"
17887 #: ../src/guestfs-actions.pod:7405
17891 " guestfs_zfgrepi (guestfs_h *g,\n"
17892 " const char *pattern,\n"
17893 " const char *path);\n"
17898 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4942
17899 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17903 #: ../src/guestfs-actions.pod:7422
17904 msgid "guestfs_zfile"
17908 #: ../src/guestfs-actions.pod:7424
17912 " guestfs_zfile (guestfs_h *g,\n"
17913 " const char *meth,\n"
17914 " const char *path);\n"
17919 #: ../src/guestfs-actions.pod:7429 ../fish/guestfish-actions.pod:4952
17920 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17924 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4955
17925 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17929 #: ../src/guestfs-actions.pod:7434
17931 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17936 #: ../src/guestfs-actions.pod:7440 ../fish/guestfish-actions.pod:4960
17937 msgid "This function is deprecated. In new code, use the C<file> call instead."
17941 #: ../src/guestfs-actions.pod:7449
17942 msgid "guestfs_zgrep"
17946 #: ../src/guestfs-actions.pod:7451
17950 " guestfs_zgrep (guestfs_h *g,\n"
17951 " const char *regex,\n"
17952 " const char *path);\n"
17957 #: ../src/guestfs-actions.pod:7456 ../fish/guestfish-actions.pod:4971
17958 msgid "This calls the external C<zgrep> program and returns the matching lines."
17962 #: ../src/guestfs-actions.pod:7468
17963 msgid "guestfs_zgrepi"
17967 #: ../src/guestfs-actions.pod:7470
17971 " guestfs_zgrepi (guestfs_h *g,\n"
17972 " const char *regex,\n"
17973 " const char *path);\n"
17978 #: ../src/guestfs-actions.pod:7475 ../fish/guestfish-actions.pod:4981
17979 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
17983 #: ../src/guestfs-availability.pod:3
17988 #: ../src/guestfs-availability.pod:5
17990 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
17991 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
17992 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
17993 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
17994 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
17998 #: ../src/guestfs-availability.pod:21
18003 #: ../src/guestfs-availability.pod:23
18005 "The following functions: L</guestfs_inotify_add_watch> "
18006 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18007 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18011 #: ../src/guestfs-availability.pod:31
18012 msgid "B<linuxfsuuid>"
18016 #: ../src/guestfs-availability.pod:33
18018 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18019 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18023 #: ../src/guestfs-availability.pod:40
18024 msgid "B<linuxmodules>"
18028 #: ../src/guestfs-availability.pod:42
18029 msgid "The following functions: L</guestfs_modprobe>"
18033 #: ../src/guestfs-availability.pod:45
18034 msgid "B<linuxxattrs>"
18038 #: ../src/guestfs-availability.pod:47
18040 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18041 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18042 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18043 "L</guestfs_setxattr>"
18047 #: ../src/guestfs-availability.pod:58
18052 #: ../src/guestfs-availability.pod:60
18054 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18055 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18056 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18060 #: ../src/guestfs-availability.pod:69
18065 #: ../src/guestfs-availability.pod:71
18067 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18068 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18069 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18070 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18071 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18072 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18073 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18074 "L</guestfs_vgs_full>"
18078 #: ../src/guestfs-availability.pod:94
18083 #: ../src/guestfs-availability.pod:96
18085 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18086 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18090 #: ../src/guestfs-availability.pod:102
18095 #: ../src/guestfs-availability.pod:104
18096 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18100 #: ../src/guestfs-availability.pod:107
18101 msgid "B<ntfsprogs>"
18105 #: ../src/guestfs-availability.pod:109
18106 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18110 #: ../src/guestfs-availability.pod:113
18111 msgid "B<realpath>"
18115 #: ../src/guestfs-availability.pod:115
18116 msgid "The following functions: L</guestfs_realpath>"
18120 #: ../src/guestfs-availability.pod:118
18125 #: ../src/guestfs-availability.pod:120
18127 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18128 "L</guestfs_scrub_freespace>"
18132 #: ../src/guestfs-availability.pod:125
18137 #: ../src/guestfs-availability.pod:127
18138 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18142 #: ../src/guestfs-availability.pod:131
18147 #: ../src/guestfs-availability.pod:133
18148 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18152 #: ../src/guestfs-availability.pod:137
18153 msgid "B<zerofree>"
18157 #: ../src/guestfs-availability.pod:139
18158 msgid "The following functions: L</guestfs_zerofree>"
18162 #: ../src/guestfs-structs.pod:1
18163 msgid "guestfs_int_bool"
18167 #: ../src/guestfs-structs.pod:3
18170 " struct guestfs_int_bool {\n"
18178 #: ../src/guestfs-structs.pod:8
18181 " struct guestfs_int_bool_list {\n"
18182 " uint32_t len; /* Number of elements in list. */\n"
18183 " struct guestfs_int_bool *val; /* Elements. */\n"
18189 #: ../src/guestfs-structs.pod:13
18192 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18193 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18198 #: ../src/guestfs-structs.pod:16
18199 msgid "guestfs_lvm_pv"
18203 #: ../src/guestfs-structs.pod:18
18206 " struct guestfs_lvm_pv {\n"
18207 " char *pv_name;\n"
18208 " /* The next field is NOT nul-terminated, be careful when printing it: "
18210 " char pv_uuid[32];\n"
18212 " uint64_t pv_size;\n"
18213 " uint64_t dev_size;\n"
18214 " uint64_t pv_free;\n"
18215 " uint64_t pv_used;\n"
18216 " char *pv_attr;\n"
18217 " int64_t pv_pe_count;\n"
18218 " int64_t pv_pe_alloc_count;\n"
18219 " char *pv_tags;\n"
18220 " uint64_t pe_start;\n"
18221 " int64_t pv_mda_count;\n"
18222 " uint64_t pv_mda_free;\n"
18228 #: ../src/guestfs-structs.pod:36
18231 " struct guestfs_lvm_pv_list {\n"
18232 " uint32_t len; /* Number of elements in list. */\n"
18233 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18239 #: ../src/guestfs-structs.pod:41
18242 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18243 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18248 #: ../src/guestfs-structs.pod:44
18249 msgid "guestfs_lvm_vg"
18253 #: ../src/guestfs-structs.pod:46
18256 " struct guestfs_lvm_vg {\n"
18257 " char *vg_name;\n"
18258 " /* The next field is NOT nul-terminated, be careful when printing it: "
18260 " char vg_uuid[32];\n"
18262 " char *vg_attr;\n"
18263 " uint64_t vg_size;\n"
18264 " uint64_t vg_free;\n"
18265 " char *vg_sysid;\n"
18266 " uint64_t vg_extent_size;\n"
18267 " int64_t vg_extent_count;\n"
18268 " int64_t vg_free_count;\n"
18269 " int64_t max_lv;\n"
18270 " int64_t max_pv;\n"
18271 " int64_t pv_count;\n"
18272 " int64_t lv_count;\n"
18273 " int64_t snap_count;\n"
18274 " int64_t vg_seqno;\n"
18275 " char *vg_tags;\n"
18276 " int64_t vg_mda_count;\n"
18277 " uint64_t vg_mda_free;\n"
18283 #: ../src/guestfs-structs.pod:69
18286 " struct guestfs_lvm_vg_list {\n"
18287 " uint32_t len; /* Number of elements in list. */\n"
18288 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18294 #: ../src/guestfs-structs.pod:74
18297 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18298 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18303 #: ../src/guestfs-structs.pod:77
18304 msgid "guestfs_lvm_lv"
18308 #: ../src/guestfs-structs.pod:79
18311 " struct guestfs_lvm_lv {\n"
18312 " char *lv_name;\n"
18313 " /* The next field is NOT nul-terminated, be careful when printing it: "
18315 " char lv_uuid[32];\n"
18316 " char *lv_attr;\n"
18317 " int64_t lv_major;\n"
18318 " int64_t lv_minor;\n"
18319 " int64_t lv_kernel_major;\n"
18320 " int64_t lv_kernel_minor;\n"
18321 " uint64_t lv_size;\n"
18322 " int64_t seg_count;\n"
18324 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18325 " float snap_percent;\n"
18326 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18327 " float copy_percent;\n"
18328 " char *move_pv;\n"
18329 " char *lv_tags;\n"
18330 " char *mirror_log;\n"
18331 " char *modules;\n"
18337 #: ../src/guestfs-structs.pod:101
18340 " struct guestfs_lvm_lv_list {\n"
18341 " uint32_t len; /* Number of elements in list. */\n"
18342 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18348 #: ../src/guestfs-structs.pod:106
18351 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18352 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18357 #: ../src/guestfs-structs.pod:111
18360 " struct guestfs_stat {\n"
18364 " int64_t nlink;\n"
18369 " int64_t blksize;\n"
18370 " int64_t blocks;\n"
18371 " int64_t atime;\n"
18372 " int64_t mtime;\n"
18373 " int64_t ctime;\n"
18379 #: ../src/guestfs-structs.pod:127
18382 " struct guestfs_stat_list {\n"
18383 " uint32_t len; /* Number of elements in list. */\n"
18384 " struct guestfs_stat *val; /* Elements. */\n"
18390 #: ../src/guestfs-structs.pod:132
18393 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18394 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18399 #: ../src/guestfs-structs.pod:137
18402 " struct guestfs_statvfs {\n"
18403 " int64_t bsize;\n"
18404 " int64_t frsize;\n"
18405 " int64_t blocks;\n"
18406 " int64_t bfree;\n"
18407 " int64_t bavail;\n"
18408 " int64_t files;\n"
18409 " int64_t ffree;\n"
18410 " int64_t favail;\n"
18413 " int64_t namemax;\n"
18419 #: ../src/guestfs-structs.pod:151
18422 " struct guestfs_statvfs_list {\n"
18423 " uint32_t len; /* Number of elements in list. */\n"
18424 " struct guestfs_statvfs *val; /* Elements. */\n"
18430 #: ../src/guestfs-structs.pod:156
18433 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18434 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18439 #: ../src/guestfs-structs.pod:159
18440 msgid "guestfs_dirent"
18444 #: ../src/guestfs-structs.pod:161
18447 " struct guestfs_dirent {\n"
18456 #: ../src/guestfs-structs.pod:167
18459 " struct guestfs_dirent_list {\n"
18460 " uint32_t len; /* Number of elements in list. */\n"
18461 " struct guestfs_dirent *val; /* Elements. */\n"
18467 #: ../src/guestfs-structs.pod:172
18470 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18471 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18476 #: ../src/guestfs-structs.pod:177
18479 " struct guestfs_version {\n"
18480 " int64_t major;\n"
18481 " int64_t minor;\n"
18482 " int64_t release;\n"
18489 #: ../src/guestfs-structs.pod:184
18492 " struct guestfs_version_list {\n"
18493 " uint32_t len; /* Number of elements in list. */\n"
18494 " struct guestfs_version *val; /* Elements. */\n"
18500 #: ../src/guestfs-structs.pod:189
18503 " void guestfs_free_version (struct guestfs_free_version *);\n"
18504 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18509 #: ../src/guestfs-structs.pod:192
18510 msgid "guestfs_xattr"
18514 #: ../src/guestfs-structs.pod:194
18517 " struct guestfs_xattr {\n"
18518 " char *attrname;\n"
18519 " /* The next two fields describe a byte array. */\n"
18520 " uint32_t attrval_len;\n"
18521 " char *attrval;\n"
18527 #: ../src/guestfs-structs.pod:201
18530 " struct guestfs_xattr_list {\n"
18531 " uint32_t len; /* Number of elements in list. */\n"
18532 " struct guestfs_xattr *val; /* Elements. */\n"
18538 #: ../src/guestfs-structs.pod:206
18541 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18542 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18547 #: ../src/guestfs-structs.pod:209
18548 msgid "guestfs_inotify_event"
18552 #: ../src/guestfs-structs.pod:211
18555 " struct guestfs_inotify_event {\n"
18556 " int64_t in_wd;\n"
18557 " uint32_t in_mask;\n"
18558 " uint32_t in_cookie;\n"
18559 " char *in_name;\n"
18565 #: ../src/guestfs-structs.pod:218
18568 " struct guestfs_inotify_event_list {\n"
18569 " uint32_t len; /* Number of elements in list. */\n"
18570 " struct guestfs_inotify_event *val; /* Elements. */\n"
18576 #: ../src/guestfs-structs.pod:223
18579 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18580 " void guestfs_free_inotify_event_list (struct "
18581 "guestfs_free_inotify_event_list *);\n"
18586 #: ../src/guestfs-structs.pod:226
18587 msgid "guestfs_partition"
18591 #: ../src/guestfs-structs.pod:228
18594 " struct guestfs_partition {\n"
18595 " int32_t part_num;\n"
18596 " uint64_t part_start;\n"
18597 " uint64_t part_end;\n"
18598 " uint64_t part_size;\n"
18604 #: ../src/guestfs-structs.pod:235
18607 " struct guestfs_partition_list {\n"
18608 " uint32_t len; /* Number of elements in list. */\n"
18609 " struct guestfs_partition *val; /* Elements. */\n"
18615 #: ../src/guestfs-structs.pod:240
18618 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18619 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18624 #: ../src/guestfs-structs.pod:243
18625 msgid "guestfs_application"
18629 #: ../src/guestfs-structs.pod:245
18632 " struct guestfs_application {\n"
18633 " char *app_name;\n"
18634 " char *app_display_name;\n"
18635 " int32_t app_epoch;\n"
18636 " char *app_version;\n"
18637 " char *app_release;\n"
18638 " char *app_install_path;\n"
18639 " char *app_trans_path;\n"
18640 " char *app_publisher;\n"
18641 " char *app_url;\n"
18642 " char *app_source_package;\n"
18643 " char *app_summary;\n"
18644 " char *app_description;\n"
18650 #: ../src/guestfs-structs.pod:260
18653 " struct guestfs_application_list {\n"
18654 " uint32_t len; /* Number of elements in list. */\n"
18655 " struct guestfs_application *val; /* Elements. */\n"
18661 #: ../src/guestfs-structs.pod:265
18664 " void guestfs_free_application (struct guestfs_free_application *);\n"
18665 " void guestfs_free_application_list (struct guestfs_free_application_list "
18671 #: ../fish/guestfish.pod:5
18672 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18676 #: ../fish/guestfish.pod:9
18679 " guestfish [--options] [commands]\n"
18684 #: ../fish/guestfish.pod:11
18692 #: ../fish/guestfish.pod:13
18695 " guestfish [--ro|--rw] -a disk.img\n"
18700 #: ../fish/guestfish.pod:15
18703 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18708 #: ../fish/guestfish.pod:17
18711 " guestfish -d libvirt-domain\n"
18716 #: ../fish/guestfish.pod:19
18719 " guestfish [--ro|--rw] -a disk.img -i\n"
18724 #: ../fish/guestfish.pod:21
18727 " guestfish -d libvirt-domain -i\n"
18732 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18737 #: ../fish/guestfish.pod:25
18739 "Using guestfish in read/write mode on live virtual machines can be "
18740 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18741 "option to use guestfish safely if the disk image or virtual machine might be "
18746 #: ../fish/guestfish.pod:32
18748 "Guestfish is a shell and command-line tool for examining and modifying "
18749 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18750 "functionality of the guestfs API, see L<guestfs(3)>."
18754 #: ../fish/guestfish.pod:36
18756 "Guestfish gives you structured access to the libguestfs API, from shell "
18757 "scripts or the command line or interactively. If you want to rescue a "
18758 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18763 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
18768 #: ../fish/guestfish.pod:43
18769 msgid "As an interactive shell"
18773 #: ../fish/guestfish.pod:45
18781 #: ../fish/guestfish.pod:47
18784 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18785 " editing virtual machine filesystems.\n"
18790 #: ../fish/guestfish.pod:50
18793 " Type: 'help' for a list of commands\n"
18794 " 'man' to read the manual\n"
18795 " 'quit' to quit the shell\n"
18800 #: ../fish/guestfish.pod:54
18803 " ><fs> add-ro disk.img\n"
18805 " ><fs> list-filesystems\n"
18806 " /dev/sda1: ext4\n"
18807 " /dev/vg_guest/lv_root: ext4\n"
18808 " /dev/vg_guest/lv_swap: swap\n"
18809 " ><fs> mount /dev/vg_guest/lv_root /\n"
18810 " ><fs> cat /etc/fstab\n"
18812 " # Created by anaconda\n"
18819 #: ../fish/guestfish.pod:67
18820 msgid "From shell scripts"
18824 #: ../fish/guestfish.pod:69
18825 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18829 #: ../fish/guestfish.pod:71
18832 " guestfish <<_EOF_\n"
18835 " mount /dev/vg_guest/lv_root /\n"
18836 " write /etc/motd \"Welcome, new users\"\n"
18842 #: ../fish/guestfish.pod:78
18843 msgid "List the LVM logical volumes in a disk image:"
18847 #: ../fish/guestfish.pod:80
18850 " guestfish -a disk.img --ro <<_EOF_\n"
18858 #: ../fish/guestfish.pod:85
18859 msgid "List all the filesystems in a disk image:"
18863 #: ../fish/guestfish.pod:87
18866 " guestfish -a disk.img --ro <<_EOF_\n"
18868 " list-filesystems\n"
18874 #: ../fish/guestfish.pod:92
18875 msgid "On one command line"
18879 #: ../fish/guestfish.pod:94
18880 msgid "Update C</etc/resolv.conf> in a guest:"
18884 #: ../fish/guestfish.pod:96
18888 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18889 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18894 #: ../fish/guestfish.pod:100
18895 msgid "Edit C</boot/grub/grub.conf> interactively:"
18899 #: ../fish/guestfish.pod:102
18902 " guestfish --rw --add disk.img \\\n"
18903 " --mount /dev/vg_guest/lv_root \\\n"
18904 " --mount /dev/sda1:/boot \\\n"
18905 " edit /boot/grub/grub.conf\n"
18910 #: ../fish/guestfish.pod:107
18911 msgid "Mount disks automatically"
18915 #: ../fish/guestfish.pod:109
18917 "Use the I<-i> option to automatically mount the disks from a virtual "
18922 #: ../fish/guestfish.pod:112
18925 " guestfish --ro -a disk.img -i cat /etc/group\n"
18930 #: ../fish/guestfish.pod:114
18933 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18938 #: ../fish/guestfish.pod:116
18939 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18943 #: ../fish/guestfish.pod:118
18946 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18951 #: ../fish/guestfish.pod:120
18952 msgid "As a script interpreter"
18956 #: ../fish/guestfish.pod:122
18957 msgid "Create a 100MB disk containing an ext2-formatted partition:"
18961 #: ../fish/guestfish.pod:124
18964 " #!/usr/bin/guestfish -f\n"
18965 " sparse test1.img 100M\n"
18967 " part-disk /dev/sda mbr\n"
18968 " mkfs ext2 /dev/sda1\n"
18973 #: ../fish/guestfish.pod:130
18974 msgid "Start with a prepared disk"
18978 #: ../fish/guestfish.pod:132
18980 "An alternate way to create a 100MB disk called C<test1.img> containing a "
18981 "single ext2-formatted partition:"
18985 #: ../fish/guestfish.pod:135
18988 " guestfish -N fs\n"
18993 #: ../fish/guestfish.pod:137
18994 msgid "To list what is available do:"
18998 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19001 " guestfish -N help | less\n"
19006 #: ../fish/guestfish.pod:141
19007 msgid "Remote control"
19011 #: ../fish/guestfish.pod:143
19014 " eval \"`guestfish --listen`\"\n"
19015 " guestfish --remote add-ro disk.img\n"
19016 " guestfish --remote run\n"
19017 " guestfish --remote lvs\n"
19022 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81 ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19027 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19032 #: ../fish/guestfish.pod:154
19033 msgid "Displays general help on options."
19037 #: ../fish/guestfish.pod:156
19042 #: ../fish/guestfish.pod:158
19043 msgid "B<--cmd-help>"
19047 #: ../fish/guestfish.pod:160
19048 msgid "Lists all available guestfish commands."
19052 #: ../fish/guestfish.pod:162
19057 #: ../fish/guestfish.pod:164
19058 msgid "B<--cmd-help cmd>"
19062 #: ../fish/guestfish.pod:166
19063 msgid "Displays detailed help on a single command C<cmd>."
19067 #: ../fish/guestfish.pod:168
19068 msgid "B<-a image>"
19072 #: ../fish/guestfish.pod:170
19073 msgid "B<--add image>"
19077 #: ../fish/guestfish.pod:172
19078 msgid "Add a block device or virtual machine image to the shell."
19082 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19084 "The format of the disk image is auto-detected. To override this and force a "
19085 "particular format use the I<--format=..> option."
19089 #: ../fish/guestfish.pod:177
19091 "Using this flag is mostly equivalent to using the C<add> command, with "
19092 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19093 "the I<--format=...> flag was given."
19097 #: ../fish/guestfish.pod:181
19102 #: ../fish/guestfish.pod:183
19103 msgid "B<--connect URI>"
19107 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19109 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19110 "URI to use. The default is to use the default libvirt connection."
19114 #: ../fish/guestfish.pod:189
19119 #: ../fish/guestfish.pod:191
19121 "If using the I<--listen> option and a csh-like shell, use this option. See "
19122 "section L</REMOTE CONTROL AND CSH> below."
19126 #: ../fish/guestfish.pod:194
19127 msgid "B<-d libvirt-domain>"
19131 #: ../fish/guestfish.pod:196
19132 msgid "B<--domain libvirt-domain>"
19136 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19138 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19139 "used, then any libvirt domain can be used. However in write mode, only "
19140 "libvirt domains which are shut down can be named here."
19144 #: ../fish/guestfish.pod:202
19146 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19147 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19148 "if the I<--format:...> flag was given."
19152 #: ../fish/guestfish.pod:206
19157 #: ../fish/guestfish.pod:208
19158 msgid "B<--no-dest-paths>"
19162 #: ../fish/guestfish.pod:210
19164 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19165 "to hit the tab key to complete paths on the guest filesystem, but this "
19166 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19167 "allow this feature to be disabled."
19171 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19172 msgid "B<--echo-keys>"
19176 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19178 "When prompting for keys and passphrases, guestfish normally turns echoing "
19179 "off so you cannot see what you are typing. If you are not worried about "
19180 "Tempest attacks and there is no one else in the room you can specify this "
19181 "flag to see what you are typing."
19185 #: ../fish/guestfish.pod:222
19190 #: ../fish/guestfish.pod:224
19191 msgid "B<--file file>"
19195 #: ../fish/guestfish.pod:226
19196 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19200 #: ../fish/guestfish.pod:229
19203 " #!/usr/bin/guestfish -f\n"
19208 #: ../fish/guestfish.pod:231
19209 msgid "B<--format=raw|qcow2|..>"
19213 #: ../fish/guestfish.pod:233
19214 msgid "B<--format>"
19218 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19220 "The default for the I<-a> option is to auto-detect the format of the disk "
19221 "image. Using this forces the disk format for I<-a> options which follow on "
19222 "the command line. Using I<--format> with no argument switches back to "
19223 "auto-detection for subsequent I<-a> options."
19227 #: ../fish/guestfish.pod:242
19230 " guestfish --format=raw -a disk.img\n"
19235 #: ../fish/guestfish.pod:244
19236 msgid "forces raw format (no auto-detection) for C<disk.img>."
19240 #: ../fish/guestfish.pod:246
19243 " guestfish --format=raw -a disk.img --format -a another.img\n"
19248 #: ../fish/guestfish.pod:248
19250 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19251 "auto-detection for C<another.img>."
19255 #: ../fish/guestfish.pod:251
19257 "If you have untrusted raw-format guest disk images, you should use this "
19258 "option to specify the disk format. This avoids a possible security problem "
19259 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19263 #: ../fish/guestfish.pod:256
19268 #: ../fish/guestfish.pod:258
19269 msgid "B<--inspector>"
19273 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19275 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19276 "system and mount filesystems as they would be mounted on the real virtual "
19281 #: ../fish/guestfish.pod:264
19282 msgid "Typical usage is either:"
19286 #: ../fish/guestfish.pod:266
19289 " guestfish -d myguest -i\n"
19294 #: ../fish/guestfish.pod:268
19295 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19299 #: ../fish/guestfish.pod:270
19302 " guestfish --ro -d myguest -i\n"
19307 #: ../fish/guestfish.pod:272
19308 msgid "(for active domains, readonly), or specify the block device directly:"
19312 #: ../fish/guestfish.pod:274
19315 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19320 #: ../fish/guestfish.pod:276
19322 "Note that the command line syntax changed slightly over older versions of "
19323 "guestfish. You can still use the old syntax:"
19327 #: ../fish/guestfish.pod:279
19330 " guestfish [--ro] -i disk.img\n"
19335 #: ../fish/guestfish.pod:281
19338 " guestfish [--ro] -i libvirt-domain\n"
19343 #: ../fish/guestfish.pod:283
19345 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19346 "then using other commands to mount the filesystems that were found."
19350 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19351 msgid "B<--keys-from-stdin>"
19355 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19357 "Read key or passphrase parameters from stdin. The default is to try to read "
19358 "passphrases from the user by opening C</dev/tty>."
19362 #: ../fish/guestfish.pod:292
19363 msgid "B<--listen>"
19367 #: ../fish/guestfish.pod:294
19369 "Fork into the background and listen for remote commands. See section "
19370 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19374 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19379 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19381 "Connect to a live virtual machine. (Experimental, see "
19382 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19386 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19387 msgid "B<-m dev[:mountpoint[:options]]>"
19391 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19392 msgid "B<--mount dev[:mountpoint[:options]]>"
19396 #: ../fish/guestfish.pod:306
19397 msgid "Mount the named partition or logical volume on the given mountpoint."
19401 #: ../fish/guestfish.pod:308
19402 msgid "If the mountpoint is omitted, it defaults to C</>."
19406 #: ../fish/guestfish.pod:310
19407 msgid "You have to mount something on C</> before most commands will work."
19411 #: ../fish/guestfish.pod:312
19413 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19418 #: ../fish/guestfish.pod:315
19420 "If you don't know what filesystems a disk image contains, you can either run "
19421 "guestfish without this option, then list the partitions, filesystems and LVs "
19422 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19423 "commands), or you can use the L<virt-filesystems(1)> program."
19427 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19429 "The third (and rarely used) part of the mount parameter is the list of mount "
19430 "options used to mount the underlying filesystem. If this is not given, then "
19431 "the mount options are either the empty string or C<ro> (the latter if the "
19432 "I<--ro> flag is used). By specifying the mount options, you override this "
19433 "default choice. Probably the only time you would use this is to enable ACLs "
19434 "and/or extended attributes if the filesystem can support them:"
19438 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19441 " -m /dev/sda1:/:acl,user_xattr\n"
19446 #: ../fish/guestfish.pod:331
19447 msgid "Using this flag is equivalent to using the C<mount-options> command."
19451 #: ../fish/guestfish.pod:333
19456 #: ../fish/guestfish.pod:335
19457 msgid "B<--no-sync>"
19461 #: ../fish/guestfish.pod:337
19463 "Disable autosync. This is enabled by default. See the discussion of "
19464 "autosync in the L<guestfs(3)> manpage."
19468 #: ../fish/guestfish.pod:340
19473 #: ../fish/guestfish.pod:342
19474 msgid "B<--new type>"
19478 #: ../fish/guestfish.pod:344
19483 #: ../fish/guestfish.pod:346
19485 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19486 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19487 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19492 #: ../fish/guestfish.pod:351
19493 msgid "B<--progress-bars>"
19497 #: ../fish/guestfish.pod:353
19498 msgid "Enable progress bars, even when guestfish is used non-interactively."
19502 #: ../fish/guestfish.pod:355
19504 "Progress bars are enabled by default when guestfish is used as an "
19505 "interactive shell."
19509 #: ../fish/guestfish.pod:358
19510 msgid "B<--no-progress-bars>"
19514 #: ../fish/guestfish.pod:360
19515 msgid "Disable progress bars."
19519 #: ../fish/guestfish.pod:362
19520 msgid "B<--remote[=pid]>"
19524 #: ../fish/guestfish.pod:364
19526 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19527 "CONTROL GUESTFISH OVER A SOCKET> below."
19531 #: ../fish/guestfish.pod:367
19536 #: ../fish/guestfish.pod:369
19541 #: ../fish/guestfish.pod:371
19543 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19544 "mounts are done read-only."
19548 #: ../fish/guestfish.pod:374
19550 "The option must always be used if the disk image or virtual machine might be "
19551 "running, and is generally recommended in cases where you don't need write "
19552 "access to the disk."
19556 #: ../fish/guestfish.pod:378
19558 "Note that prepared disk images created with I<-N> are not affected by this "
19559 "option. Also commands like C<add> are not affected - you have to specify "
19560 "the C<readonly:true> option explicitly if you need it."
19564 #: ../fish/guestfish.pod:382
19565 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19569 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19570 msgid "B<--selinux>"
19574 #: ../fish/guestfish.pod:386
19575 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19579 #: ../fish/guestfish.pod:388
19584 #: ../fish/guestfish.pod:390
19585 msgid "B<--verbose>"
19589 #: ../fish/guestfish.pod:392
19591 "Enable very verbose messages. This is particularly useful if you find a "
19596 #: ../fish/guestfish.pod:395
19601 #: ../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
19602 msgid "B<--version>"
19606 #: ../fish/guestfish.pod:399
19607 msgid "Display the guestfish / libguestfs version number and exit."
19611 #: ../fish/guestfish.pod:401
19616 #: ../fish/guestfish.pod:403
19621 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19623 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19624 "mounts are done read-write."
19628 #: ../fish/guestfish.pod:408
19629 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19633 #: ../fish/guestfish.pod:410
19638 #: ../fish/guestfish.pod:412
19639 msgid "Echo each command before executing it."
19643 #: ../fish/guestfish.pod:416
19644 msgid "COMMANDS ON COMMAND LINE"
19648 #: ../fish/guestfish.pod:418
19649 msgid "Any additional (non-option) arguments are treated as commands to execute."
19653 #: ../fish/guestfish.pod:421
19655 "Commands to execute should be separated by a colon (C<:>), where the colon "
19656 "is a separate parameter. Thus:"
19660 #: ../fish/guestfish.pod:424
19663 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19668 #: ../fish/guestfish.pod:426
19670 "If there are no additional arguments, then we enter a shell, either an "
19671 "interactive shell with a prompt (if the input is a terminal) or a "
19672 "non-interactive shell."
19676 #: ../fish/guestfish.pod:430
19678 "In either command line mode or non-interactive shell, the first command that "
19679 "gives an error causes the whole shell to exit. In interactive mode (with a "
19680 "prompt) if a command fails, you can continue to enter commands."
19684 #: ../fish/guestfish.pod:435
19685 msgid "USING launch (OR run)"
19689 #: ../fish/guestfish.pod:437
19691 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19692 "then launch it, then mount any disks you need, and finally issue "
19693 "actions/commands. So the general order of the day is:"
19697 #: ../fish/guestfish.pod:445
19698 msgid "add or -a/--add"
19702 #: ../fish/guestfish.pod:449
19703 msgid "launch (aka run)"
19707 #: ../fish/guestfish.pod:453
19708 msgid "mount or -m/--mount"
19712 #: ../fish/guestfish.pod:457
19713 msgid "any other commands"
19717 #: ../fish/guestfish.pod:461
19719 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19720 "guest before mounting or performing any other commands."
19724 #: ../fish/guestfish.pod:464
19726 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19727 "I<--new> options were given then C<run> is done automatically, simply "
19728 "because guestfish can't perform the action you asked for without doing this."
19732 #: ../fish/guestfish.pod:469
19733 msgid "OPENING DISKS FOR READ AND WRITE"
19737 #: ../fish/guestfish.pod:471
19739 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19740 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19741 "I<-i> and I<-m> open disk images read-only or for writing."
19745 #: ../fish/guestfish.pod:476
19747 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19748 "opening disk images supplied on the command line for write. To open a disk "
19749 "image read-only you have to do I<-a image --ro>."
19753 #: ../fish/guestfish.pod:480
19755 "This matters: If you accidentally open a live VM disk image writable then "
19756 "you will cause irreversible disk corruption."
19760 #: ../fish/guestfish.pod:483
19762 "By libguestfs 1.12 we intend to change the default the other way. Disk "
19763 "images will be opened read-only. You will have to either specify "
19764 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19765 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19766 "access for disk images specified by those other command line options."
19770 #: ../fish/guestfish.pod:490
19772 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19773 "which does nothing (it is already the default). However it is highly "
19774 "recommended that you use this option to indicate that you need write access, "
19775 "and prepare your scripts for the day when this option will be required for "
19780 #: ../fish/guestfish.pod:496
19782 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19783 "other libguestfs program apart from guestfish and guestmount."
19787 #: ../fish/guestfish.pod:499
19792 #: ../fish/guestfish.pod:501
19794 "You can quote ordinary parameters using either single or double quotes. For "
19799 #: ../fish/guestfish.pod:504
19802 " add \"file with a space.img\"\n"
19807 #: ../fish/guestfish.pod:506
19810 " rm '/file name'\n"
19815 #: ../fish/guestfish.pod:508
19823 #: ../fish/guestfish.pod:510
19825 "A few commands require a list of strings to be passed. For these, use a "
19826 "whitespace-separated list, enclosed in quotes. Strings containing "
19827 "whitespace to be passed through must be enclosed in single quotes. A "
19828 "literal single quote must be escaped with a backslash."
19832 #: ../fish/guestfish.pod:515
19835 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19836 " command \"/bin/echo 'foo bar'\"\n"
19837 " command \"/bin/echo \\'foo\\'\"\n"
19842 #: ../fish/guestfish.pod:519
19843 msgid "OPTIONAL ARGUMENTS"
19847 #: ../fish/guestfish.pod:521
19849 "Some commands take optional arguments. These arguments appear in this "
19850 "documentation as C<[argname:..]>. You can use them as in these examples:"
19854 #: ../fish/guestfish.pod:525
19857 " add-drive-opts filename\n"
19862 #: ../fish/guestfish.pod:527
19865 " add-drive-opts filename readonly:true\n"
19870 #: ../fish/guestfish.pod:529
19873 " add-drive-opts filename format:qcow2 readonly:false\n"
19878 #: ../fish/guestfish.pod:531
19880 "Each optional argument can appear at most once. All optional arguments must "
19881 "appear after the required ones."
19885 #: ../fish/guestfish.pod:534
19890 #: ../fish/guestfish.pod:536
19891 msgid "This section applies to all commands which can take integers as parameters."
19895 #: ../fish/guestfish.pod:539
19896 msgid "SIZE SUFFIX"
19900 #: ../fish/guestfish.pod:541
19902 "When the command takes a parameter measured in bytes, you can use one of the "
19903 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19907 #: ../fish/guestfish.pod:547
19908 msgid "B<k> or B<K> or B<KiB>"
19912 #: ../fish/guestfish.pod:549
19913 msgid "The size in kilobytes (multiplied by 1024)."
19917 #: ../fish/guestfish.pod:551
19922 #: ../fish/guestfish.pod:553
19923 msgid "The size in SI 1000 byte units."
19927 #: ../fish/guestfish.pod:555
19928 msgid "B<M> or B<MiB>"
19932 #: ../fish/guestfish.pod:557
19933 msgid "The size in megabytes (multiplied by 1048576)."
19937 #: ../fish/guestfish.pod:559
19942 #: ../fish/guestfish.pod:561
19943 msgid "The size in SI 1000000 byte units."
19947 #: ../fish/guestfish.pod:563
19948 msgid "B<G> or B<GiB>"
19952 #: ../fish/guestfish.pod:565
19953 msgid "The size in gigabytes (multiplied by 2**30)."
19957 #: ../fish/guestfish.pod:567
19962 #: ../fish/guestfish.pod:569
19963 msgid "The size in SI 10**9 byte units."
19967 #: ../fish/guestfish.pod:571
19968 msgid "B<T> or B<TiB>"
19972 #: ../fish/guestfish.pod:573
19973 msgid "The size in terabytes (multiplied by 2**40)."
19977 #: ../fish/guestfish.pod:575
19982 #: ../fish/guestfish.pod:577
19983 msgid "The size in SI 10**12 byte units."
19987 #: ../fish/guestfish.pod:579
19988 msgid "B<P> or B<PiB>"
19992 #: ../fish/guestfish.pod:581
19993 msgid "The size in petabytes (multiplied by 2**50)."
19997 #: ../fish/guestfish.pod:583
20002 #: ../fish/guestfish.pod:585
20003 msgid "The size in SI 10**15 byte units."
20007 #: ../fish/guestfish.pod:587
20008 msgid "B<E> or B<EiB>"
20012 #: ../fish/guestfish.pod:589
20013 msgid "The size in exabytes (multiplied by 2**60)."
20017 #: ../fish/guestfish.pod:591
20022 #: ../fish/guestfish.pod:593
20023 msgid "The size in SI 10**18 byte units."
20027 #: ../fish/guestfish.pod:595
20028 msgid "B<Z> or B<ZiB>"
20032 #: ../fish/guestfish.pod:597
20033 msgid "The size in zettabytes (multiplied by 2**70)."
20037 #: ../fish/guestfish.pod:599
20042 #: ../fish/guestfish.pod:601
20043 msgid "The size in SI 10**21 byte units."
20047 #: ../fish/guestfish.pod:603
20048 msgid "B<Y> or B<YiB>"
20052 #: ../fish/guestfish.pod:605
20053 msgid "The size in yottabytes (multiplied by 2**80)."
20057 #: ../fish/guestfish.pod:607
20062 #: ../fish/guestfish.pod:609
20063 msgid "The size in SI 10**24 byte units."
20067 #: ../fish/guestfish.pod:615
20070 " truncate-size /file 1G\n"
20075 #: ../fish/guestfish.pod:617
20076 msgid "would truncate the file to 1 gigabyte."
20080 #: ../fish/guestfish.pod:619
20082 "Be careful because a few commands take sizes in kilobytes or megabytes "
20083 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20084 "Adding a suffix will probably not do what you expect."
20088 #: ../fish/guestfish.pod:623
20089 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20093 #: ../fish/guestfish.pod:625
20095 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20096 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20100 #: ../fish/guestfish.pod:628
20103 " 1234 decimal number 1234\n"
20104 " 02322 octal number, equivalent to decimal 1234\n"
20105 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20110 #: ../fish/guestfish.pod:632
20112 "When using the C<chmod> command, you almost always want to specify an octal "
20113 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20114 "L<chmod(1)> program):"
20118 #: ../fish/guestfish.pod:636
20121 " chmod 0777 /public # OK\n"
20122 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20127 #: ../fish/guestfish.pod:639
20129 "Commands that return numbers usually print them in decimal, but some "
20130 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20131 "octal, preceeded by C<0>)."
20135 #: ../fish/guestfish.pod:643
20136 msgid "WILDCARDS AND GLOBBING"
20140 #: ../fish/guestfish.pod:645
20142 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20143 "(globbing) by default. So for example the following will not do what you "
20148 #: ../fish/guestfish.pod:649
20156 #: ../fish/guestfish.pod:651
20158 "Assuming you don't have a directory called literally C</home/*> then the "
20159 "above command will return an error."
20163 #: ../fish/guestfish.pod:654
20164 msgid "To perform wildcard expansion, use the C<glob> command."
20168 #: ../fish/guestfish.pod:656
20171 " glob rm-rf /home/*\n"
20176 #: ../fish/guestfish.pod:658
20178 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20179 "many times), equivalent to:"
20183 #: ../fish/guestfish.pod:661
20186 " rm-rf /home/jim\n"
20187 " rm-rf /home/joe\n"
20188 " rm-rf /home/mary\n"
20193 #: ../fish/guestfish.pod:665
20194 msgid "C<glob> only works on simple guest paths and not on device names."
20198 #: ../fish/guestfish.pod:667
20200 "If you have several parameters, each containing a wildcard, then glob will "
20201 "perform a Cartesian product."
20205 #: ../fish/guestfish.pod:670
20210 #: ../fish/guestfish.pod:672
20212 "Any line which starts with a I<#> character is treated as a comment and "
20213 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20214 "a command. For example:"
20218 #: ../fish/guestfish.pod:676
20221 " # this is a comment\n"
20222 " # this is a comment\n"
20223 " foo # NOT a comment\n"
20228 #: ../fish/guestfish.pod:680
20229 msgid "Blank lines are also ignored."
20233 #: ../fish/guestfish.pod:682
20234 msgid "RUNNING COMMANDS LOCALLY"
20238 #: ../fish/guestfish.pod:684
20240 "Any line which starts with a I<!> character is treated as a command sent to "
20241 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20245 #: ../fish/guestfish.pod:688
20249 " tgz-out /remote local/remote-data.tar.gz\n"
20254 #: ../fish/guestfish.pod:691
20256 "will create a directory C<local> on the host, and then export the contents "
20257 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20258 "(See C<tgz-out>)."
20262 #: ../fish/guestfish.pod:695
20264 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20265 "effect, due to the way that subprocesses work in Unix."
20269 #: ../fish/guestfish.pod:698
20270 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20274 #: ../fish/guestfish.pod:700
20276 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20277 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20278 "and executed as guestfish commands."
20282 #: ../fish/guestfish.pod:704
20284 "Thus you can use shell script to construct arbitrary guestfish commands "
20285 "which are then parsed by guestfish."
20289 #: ../fish/guestfish.pod:707
20291 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20292 "through C</foo.100>) using guestfish commands alone. However this is simple "
20293 "if we use a shell script to create the guestfish commands for us:"
20297 #: ../fish/guestfish.pod:712
20300 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20305 #: ../fish/guestfish.pod:714
20306 msgid "or with names like C</foo.001>:"
20310 #: ../fish/guestfish.pod:716
20313 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20318 #: ../fish/guestfish.pod:718
20320 "When using guestfish interactively it can be helpful to just run the shell "
20321 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20322 "ordinary I<!> local command), see what guestfish commands it would run, and "
20323 "when you are happy with those prepend the C<E<lt>> character to run the "
20324 "guestfish commands for real."
20328 #: ../fish/guestfish.pod:724
20333 #: ../fish/guestfish.pod:726
20335 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20336 "command (a guestfish command) to the second command (any host command). For "
20341 #: ../fish/guestfish.pod:730
20344 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20349 #: ../fish/guestfish.pod:732
20351 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20352 "program). The above command would list all accounts in the guest filesystem "
20353 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20357 #: ../fish/guestfish.pod:737
20360 " hexdump /bin/ls | head\n"
20361 " list-devices | tail -1\n"
20362 " tgz-out / - | tar ztf -\n"
20367 #: ../fish/guestfish.pod:741
20369 "The space before the pipe symbol is required, any space after the pipe "
20370 "symbol is optional. Everything after the pipe symbol is just passed "
20371 "straight to the host shell, so it can contain redirections, globs and "
20372 "anything else that makes sense on the host side."
20376 #: ../fish/guestfish.pod:746
20378 "To use a literal argument which begins with a pipe symbol, you have to quote "
20383 #: ../fish/guestfish.pod:749
20391 #: ../fish/guestfish.pod:751
20392 msgid "HOME DIRECTORIES"
20396 #: ../fish/guestfish.pod:753
20398 "If a parameter starts with the character C<~> then the tilde may be expanded "
20399 "as a home directory path (either C<~> for the current user's home directory, "
20400 "or C<~user> for another user)."
20404 #: ../fish/guestfish.pod:757
20406 "Note that home directory expansion happens for users known I<on the host>, "
20407 "not in the guest filesystem."
20411 #: ../fish/guestfish.pod:760
20413 "To use a literal argument which begins with a tilde, you have to quote it, "
20418 #: ../fish/guestfish.pod:763
20426 #: ../fish/guestfish.pod:767
20428 "Libguestfs has some support for Linux guests encrypted according to the "
20429 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20430 "disk encryption systems used by modern Linux guests. Currently only "
20431 "LVM-on-LUKS is supported."
20435 #: ../fish/guestfish.pod:772
20436 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20440 #: ../fish/guestfish.pod:774
20443 " ><fs> vfs-type /dev/sda2\n"
20449 #: ../fish/guestfish.pod:777
20451 "Then open those devices using L</luks-open>. This creates a device-mapper "
20452 "device called C</dev/mapper/luksdev>."
20456 #: ../fish/guestfish.pod:780
20459 " ><fs> luks-open /dev/sda2 luksdev\n"
20460 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20465 #: ../fish/guestfish.pod:783
20467 "Finally you have to tell LVM to scan for volume groups on the newly created "
20472 #: ../fish/guestfish.pod:786
20476 " vg-activate-all true\n"
20481 #: ../fish/guestfish.pod:789
20482 msgid "The logical volume(s) can now be mounted in the usual way."
20486 #: ../fish/guestfish.pod:791
20488 "Before closing a LUKS device you must unmount any logical volumes on it and "
20489 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20490 "one. Then you can close the mapper device:"
20494 #: ../fish/guestfish.pod:795
20497 " vg-activate false /dev/VG\n"
20498 " luks-close /dev/mapper/luksdev\n"
20503 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20504 msgid "WINDOWS PATHS"
20508 #: ../fish/guestfish.pod:800
20510 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20511 "letters and paths (with some limitations). The following commands are "
20516 #: ../fish/guestfish.pod:804
20519 " file /WINDOWS/system32/config/system.LOG\n"
20524 #: ../fish/guestfish.pod:806
20527 " file win:\\windows\\system32\\config\\system.log\n"
20532 #: ../fish/guestfish.pod:808
20535 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20540 #: ../fish/guestfish.pod:810
20542 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20543 "where the drive is mounted, prepending that to the path, changing all "
20544 "backslash characters to forward slash, then resolving the result using "
20545 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20546 "then the parameter might be rewritten like this:"
20550 #: ../fish/guestfish.pod:816
20553 " win:e:\\foo\\bar => /e/FOO/bar\n"
20558 #: ../fish/guestfish.pod:818
20559 msgid "This only works in argument positions that expect a path."
20563 #: ../fish/guestfish.pod:820
20564 msgid "UPLOADING AND DOWNLOADING FILES"
20568 #: ../fish/guestfish.pod:822
20570 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20571 "others which upload from or download to a local file, you can use the "
20572 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20576 #: ../fish/guestfish.pod:826
20584 #: ../fish/guestfish.pod:828
20585 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20589 #: ../fish/guestfish.pod:831
20592 " tar-out /etc - | tar tf -\n"
20597 #: ../fish/guestfish.pod:833
20599 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20600 "command (see L</PIPES>)."
20604 #: ../fish/guestfish.pod:836
20606 "When using C<-> to read from stdin, the input is read up to the end of "
20607 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20608 "some arbitrary end marker:"
20612 #: ../fish/guestfish.pod:840
20615 " upload -<<END /foo\n"
20624 #: ../fish/guestfish.pod:846
20626 "Any string of characters can be used instead of C<END>. The end marker must "
20627 "appear on a line of its own, without any preceeding or following characters "
20628 "(not even spaces)."
20632 #: ../fish/guestfish.pod:850
20634 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20635 "upload local files (so-called \"FileIn\" parameters in the generator)."
20639 #: ../fish/guestfish.pod:853
20640 msgid "EXIT ON ERROR BEHAVIOUR"
20644 #: ../fish/guestfish.pod:855
20646 "By default, guestfish will ignore any errors when in interactive mode "
20647 "(ie. taking commands from a human over a tty), and will exit on the first "
20648 "error in non-interactive mode (scripts, commands given on the command line)."
20652 #: ../fish/guestfish.pod:860
20654 "If you prefix a command with a I<-> character, then that command will not "
20655 "cause guestfish to exit, even if that (one) command returns an error."
20659 #: ../fish/guestfish.pod:864
20660 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20664 #: ../fish/guestfish.pod:866
20666 "Guestfish can be remote-controlled over a socket. This is useful "
20667 "particularly in shell scripts where you want to make several different "
20668 "changes to a filesystem, but you don't want the overhead of starting up a "
20669 "guestfish process each time."
20673 #: ../fish/guestfish.pod:871
20674 msgid "Start a guestfish server process using:"
20678 #: ../fish/guestfish.pod:873
20681 " eval \"`guestfish --listen`\"\n"
20686 #: ../fish/guestfish.pod:875
20687 msgid "and then send it commands by doing:"
20691 #: ../fish/guestfish.pod:877
20694 " guestfish --remote cmd [...]\n"
20699 #: ../fish/guestfish.pod:879
20700 msgid "To cause the server to exit, send it the exit command:"
20704 #: ../fish/guestfish.pod:881
20707 " guestfish --remote exit\n"
20712 #: ../fish/guestfish.pod:883
20714 "Note that the server will normally exit if there is an error in a command. "
20715 "You can change this in the usual way. See section L</EXIT ON ERROR "
20720 #: ../fish/guestfish.pod:887
20721 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20725 #: ../fish/guestfish.pod:889
20727 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20728 "is how the I<--remote> option knows where to send the commands. You can "
20729 "have several guestfish listener processes running using:"
20733 #: ../fish/guestfish.pod:893
20736 " eval \"`guestfish --listen`\"\n"
20737 " pid1=$GUESTFISH_PID\n"
20738 " eval \"`guestfish --listen`\"\n"
20739 " pid2=$GUESTFISH_PID\n"
20741 " guestfish --remote=$pid1 cmd\n"
20742 " guestfish --remote=$pid2 cmd\n"
20747 #: ../fish/guestfish.pod:901
20748 msgid "REMOTE CONTROL AND CSH"
20752 #: ../fish/guestfish.pod:903
20754 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20759 #: ../fish/guestfish.pod:906
20762 " eval \"`guestfish --listen --csh`\"\n"
20767 #: ../fish/guestfish.pod:908
20768 msgid "REMOTE CONTROL DETAILS"
20772 #: ../fish/guestfish.pod:910
20774 "Remote control happens over a Unix domain socket called "
20775 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20776 "of the process, and C<$PID> is the process ID of the server."
20780 #: ../fish/guestfish.pod:914
20781 msgid "Guestfish client and server versions must match exactly."
20785 #: ../fish/guestfish.pod:916
20786 msgid "PREPARED DISK IMAGES"
20790 #: ../fish/guestfish.pod:918
20792 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20793 "preformatted disk images that guestfish can make for you to save typing. "
20794 "This is particularly useful for testing purposes. This option is used "
20795 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20796 "can be mixed with I<-a>)."
20800 #: ../fish/guestfish.pod:924
20802 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20803 "the second and so on. Existing files in the current directory are "
20808 #: ../fish/guestfish.pod:928
20810 "The type briefly describes how the disk should be sized, partitioned, how "
20811 "filesystem(s) should be created, and how content should be added. "
20812 "Optionally the type can be followed by extra parameters, separated by C<:> "
20813 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20814 "sparsely-allocated disk, containing a single partition, with the partition "
20815 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20816 "on a 1GB disk instead."
20820 #: ../fish/guestfish.pod:936
20821 msgid "To list the available types and any extra parameters they take, run:"
20825 #: ../fish/guestfish.pod:940
20827 "Note that the prepared filesystem is not mounted. You would usually have to "
20828 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20832 #: ../fish/guestfish.pod:944
20834 "If any I<-N> or I<--new> options are given, the guest is automatically "
20839 #: ../fish/guestfish.pod:949
20840 msgid "Create a 100MB disk with an ext4-formatted partition:"
20844 #: ../fish/guestfish.pod:951
20847 " guestfish -N fs:ext4\n"
20852 #: ../fish/guestfish.pod:953
20853 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20857 #: ../fish/guestfish.pod:955
20860 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20865 #: ../fish/guestfish.pod:957
20866 msgid "Create a blank 200MB disk:"
20870 #: ../fish/guestfish.pod:959
20873 " guestfish -N disk:200M\n"
20878 #: ../fish/guestfish.pod:961
20879 msgid "PROGRESS BARS"
20883 #: ../fish/guestfish.pod:963
20885 "Some (not all) long-running commands send progress notification messages as "
20886 "they are running. Guestfish turns these messages into progress bars."
20890 #: ../fish/guestfish.pod:967
20892 "When a command that supports progress bars takes longer than two seconds to "
20893 "run, and if progress bars are enabled, then you will see one appearing below "
20898 #: ../fish/guestfish.pod:971
20901 " ><fs> copy-size /large-file /another-file 2048M\n"
20902 " / 10% [#####-----------------------------------------] 00:30\n"
20907 #: ../fish/guestfish.pod:974
20909 "The spinner on the left hand side moves round once for every progress "
20910 "notification received from the backend. This is a (reasonably) golden "
20911 "assurance that the command is \"doing something\" even if the progress bar "
20912 "is not moving, because the command is able to send the progress "
20913 "notifications. When the bar reaches 100% and the command finishes, the "
20914 "spinner disappears."
20918 #: ../fish/guestfish.pod:981
20920 "Progress bars are enabled by default when guestfish is used interactively. "
20921 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20922 "and you can disable them completely using I<--no-progress-bars>."
20926 #: ../fish/guestfish.pod:986
20927 msgid "GUESTFISH COMMANDS"
20931 #: ../fish/guestfish.pod:988
20933 "The commands in this section are guestfish convenience commands, in other "
20934 "words, they are not part of the L<guestfs(3)> API."
20938 #: ../fish/guestfish.pod:991
20943 #: ../fish/guestfish.pod:993
20952 #: ../fish/guestfish.pod:996
20953 msgid "Without any parameter, this provides general help."
20957 #: ../fish/guestfish.pod:998
20958 msgid "With a C<cmd> parameter, this displays detailed help for that command."
20962 #: ../fish/guestfish.pod:1000
20963 msgid "quit | exit"
20967 #: ../fish/guestfish.pod:1002
20968 msgid "This exits guestfish. You can also use C<^D> key."
20972 #: ../fish/guestfish.pod:1004
20973 msgid "@FISH_COMMANDS@"
20977 #: ../fish/guestfish.pod:1006
20982 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
20987 #: ../fish/guestfish.pod:1012
20989 "guestfish returns 0 if the commands completed without error, or 1 if there "
20994 #: ../fish/guestfish.pod:1019
20999 #: ../fish/guestfish.pod:1021
21001 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21006 #: ../fish/guestfish.pod:1024
21007 msgid "GUESTFISH_PID"
21011 #: ../fish/guestfish.pod:1026
21013 "Used with the I<--remote> option to specify the remote guestfish process to "
21014 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21018 #: ../fish/guestfish.pod:1030
21023 #: ../fish/guestfish.pod:1032
21025 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21026 "not specified, the external L<hexedit(1)> program is used."
21030 #: ../fish/guestfish.pod:1036
21035 #: ../fish/guestfish.pod:1038
21037 "If compiled with GNU readline support, various files in the home directory "
21038 "can be used. See L</FILES>."
21042 #: ../fish/guestfish.pod:1047
21044 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21045 "effect as using the B<-v> option."
21049 #: ../fish/guestfish.pod:1059
21051 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21052 "the discussion of paths in L<guestfs(3)>."
21056 #: ../fish/guestfish.pod:1070
21057 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21061 #: ../fish/guestfish.pod:1072
21066 #: ../fish/guestfish.pod:1074
21068 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21073 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
21078 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
21079 msgid "$HOME/.libguestfs-tools.rc"
21083 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21084 msgid "/etc/libguestfs-tools.conf"
21088 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21090 "This configuration file controls the default read-only or read-write mode "
21091 "(I<--ro> or I<--rw>)."
21095 #: ../fish/guestfish.pod:1101
21096 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21100 #: ../fish/guestfish.pod:1103
21101 msgid "$HOME/.guestfish"
21105 #: ../fish/guestfish.pod:1105
21107 "If compiled with GNU readline support, then the command history is saved in "
21112 #: ../fish/guestfish.pod:1108
21113 msgid "$HOME/.inputrc"
21117 #: ../fish/guestfish.pod:1110
21118 msgid "/etc/inputrc"
21122 #: ../fish/guestfish.pod:1112
21124 "If compiled with GNU readline support, then these files can be used to "
21125 "configure readline. For further information, please see "
21126 "L<readline(3)/INITIALIZATION FILE>."
21130 #: ../fish/guestfish.pod:1116
21131 msgid "To write rules which only apply to guestfish, use:"
21135 #: ../fish/guestfish.pod:1118
21145 #: ../fish/guestfish.pod:1122
21147 "Variables that you can set in inputrc that change the behaviour of guestfish "
21148 "in useful ways include:"
21152 #: ../fish/guestfish.pod:1127
21153 msgid "completion-ignore-case (default: on)"
21157 #: ../fish/guestfish.pod:1129
21159 "By default, guestfish will ignore case when tab-completing paths on the "
21164 #: ../fish/guestfish.pod:1132
21167 " set completion-ignore-case off\n"
21172 #: ../fish/guestfish.pod:1134
21173 msgid "to make guestfish case sensitive."
21177 #: ../fish/guestfish.pod:1138
21182 #: ../fish/guestfish.pod:1140
21183 msgid "test2.img (etc)"
21187 #: ../fish/guestfish.pod:1142
21189 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21190 "will be created in the file C<test1.img> in the current directory. The "
21191 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21192 "the same name will be overwritten."
21196 #: ../fish/guestfish.pod:1151
21198 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21199 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21200 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21201 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21202 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21203 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21207 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518 ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21209 "This program is free software; you can redistribute it and/or modify it "
21210 "under the terms of the GNU General Public License as published by the Free "
21211 "Software Foundation; either version 2 of the License, or (at your option) "
21212 "any later version."
21216 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523 ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21218 "This program is distributed in the hope that it will be useful, but WITHOUT "
21219 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21220 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21225 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528 ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21227 "You should have received a copy of the GNU General Public License along with "
21228 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21229 "Ave, Cambridge, MA 02139, USA."
21233 #: ../fish/guestfish-actions.pod:1
21238 #: ../fish/guestfish-actions.pod:3
21241 " add-cdrom filename\n"
21246 #: ../fish/guestfish-actions.pod:15
21248 "This call checks for the existence of C<filename>. This stops you from "
21249 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21250 "and C<http:> URLs. To specify those, use the general L</config> call "
21255 #: ../fish/guestfish-actions.pod:22
21257 "If you just want to add an ISO file (often you use this as an efficient way "
21258 "to transfer large files into the guest), then you should probably use "
21259 "L</add-drive-ro> instead."
21263 #: ../fish/guestfish-actions.pod:35
21268 #: ../fish/guestfish-actions.pod:37
21273 #: ../fish/guestfish-actions.pod:39
21276 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21281 #: ../fish/guestfish-actions.pod:41
21283 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21284 "It works by connecting to libvirt, requesting the domain and domain XML from "
21285 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21289 #: ../fish/guestfish-actions.pod:71
21291 "The other optional parameters are passed directly through to "
21292 "L</add-drive-opts>."
21296 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:3047
21298 "This command has one or more optional arguments. See L</OPTIONAL "
21303 #: ../fish/guestfish-actions.pod:76
21308 #: ../fish/guestfish-actions.pod:78
21311 " add-drive filename\n"
21316 #: ../fish/guestfish-actions.pod:80
21318 "This function is the equivalent of calling L</add-drive-opts> with no "
21319 "optional parameters, so the disk is added writable, with the format being "
21320 "detected automatically."
21324 #: ../fish/guestfish-actions.pod:84
21326 "Automatic detection of the format opens you up to a potential security hole "
21327 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21328 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21329 "you should think about replacing calls to this function with calls to "
21330 "L</add-drive-opts>, and specifying the format."
21334 #: ../fish/guestfish-actions.pod:91
21335 msgid "add-drive-opts"
21339 #: ../fish/guestfish-actions.pod:93
21344 #: ../fish/guestfish-actions.pod:95
21347 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21352 #: ../fish/guestfish-actions.pod:122
21354 "This forces the image format. If you omit this (or use L</add-drive> or "
21355 "L</add-drive-ro>) then the format is automatically detected. Possible "
21356 "formats include C<raw> and C<qcow2>."
21360 #: ../fish/guestfish-actions.pod:133
21362 "This rarely-used option lets you emulate the behaviour of the deprecated "
21363 "L</add-drive-with-if> call (q.v.)"
21367 #: ../fish/guestfish-actions.pod:140
21368 msgid "add-drive-ro"
21372 #: ../fish/guestfish-actions.pod:142
21377 #: ../fish/guestfish-actions.pod:144
21380 " add-drive-ro filename\n"
21385 #: ../fish/guestfish-actions.pod:146
21387 "This function is the equivalent of calling L</add-drive-opts> with the "
21388 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21389 "is added read-only, with the format being detected automatically."
21393 #: ../fish/guestfish-actions.pod:151
21394 msgid "add-drive-ro-with-if"
21398 #: ../fish/guestfish-actions.pod:153
21401 " add-drive-ro-with-if filename iface\n"
21406 #: ../fish/guestfish-actions.pod:155
21408 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21409 "interface emulation to use at run time."
21413 #: ../fish/guestfish-actions.pod:165
21414 msgid "add-drive-with-if"
21418 #: ../fish/guestfish-actions.pod:167
21421 " add-drive-with-if filename iface\n"
21426 #: ../fish/guestfish-actions.pod:169
21428 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21429 "interface emulation to use at run time."
21433 #: ../fish/guestfish-actions.pod:179
21438 #: ../fish/guestfish-actions.pod:181
21441 " aug-clear augpath\n"
21446 #: ../fish/guestfish-actions.pod:186
21451 #: ../fish/guestfish-actions.pod:188
21459 #: ../fish/guestfish-actions.pod:190
21461 "Close the current Augeas handle and free up any resources used by it. After "
21462 "calling this, you have to call L</aug-init> again before you can use any "
21463 "other Augeas functions."
21467 #: ../fish/guestfish-actions.pod:195
21468 msgid "aug-defnode"
21472 #: ../fish/guestfish-actions.pod:197
21475 " aug-defnode name expr val\n"
21480 #: ../fish/guestfish-actions.pod:202
21482 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21483 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21484 "containing that single node."
21488 #: ../fish/guestfish-actions.pod:210
21493 #: ../fish/guestfish-actions.pod:212
21496 " aug-defvar name expr\n"
21501 #: ../fish/guestfish-actions.pod:221
21506 #: ../fish/guestfish-actions.pod:223
21509 " aug-get augpath\n"
21514 #: ../fish/guestfish-actions.pod:228
21519 #: ../fish/guestfish-actions.pod:230
21522 " aug-init root flags\n"
21527 #: ../fish/guestfish-actions.pod:236
21528 msgid "You must call this before using any other L</aug-*> commands."
21532 #: ../fish/guestfish-actions.pod:271
21533 msgid "Do not load the tree in L</aug-init>."
21537 #: ../fish/guestfish-actions.pod:275
21538 msgid "To close the handle, you can call L</aug-close>."
21542 #: ../fish/guestfish-actions.pod:279
21547 #: ../fish/guestfish-actions.pod:281
21550 " aug-insert augpath label true|false\n"
21555 #: ../fish/guestfish-actions.pod:291
21560 #: ../fish/guestfish-actions.pod:293
21568 #: ../fish/guestfish-actions.pod:300
21573 #: ../fish/guestfish-actions.pod:302
21576 " aug-ls augpath\n"
21581 #: ../fish/guestfish-actions.pod:304
21583 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21584 "resulting nodes into alphabetical order."
21588 #: ../fish/guestfish-actions.pod:307
21593 #: ../fish/guestfish-actions.pod:309
21596 " aug-match augpath\n"
21601 #: ../fish/guestfish-actions.pod:315
21606 #: ../fish/guestfish-actions.pod:317
21609 " aug-mv src dest\n"
21614 #: ../fish/guestfish-actions.pod:322
21619 #: ../fish/guestfish-actions.pod:324
21622 " aug-rm augpath\n"
21627 #: ../fish/guestfish-actions.pod:330
21632 #: ../fish/guestfish-actions.pod:332
21640 #: ../fish/guestfish-actions.pod:336
21642 "The flags which were passed to L</aug-init> affect exactly how files are "
21647 #: ../fish/guestfish-actions.pod:339
21652 #: ../fish/guestfish-actions.pod:341
21655 " aug-set augpath val\n"
21660 #: ../fish/guestfish-actions.pod:345
21662 "In the Augeas API, it is possible to clear a node by setting the value to "
21663 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21664 "this call. Instead you must use the L</aug-clear> call."
21668 #: ../fish/guestfish-actions.pod:350
21673 #: ../fish/guestfish-actions.pod:352
21676 " available 'groups ...'\n"
21681 #: ../fish/guestfish-actions.pod:358
21683 "The libguestfs groups, and the functions that those groups correspond to, "
21684 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21685 "runtime by calling L</available-all-groups>."
21689 #: ../fish/guestfish-actions.pod:382
21690 msgid "You must call L</launch> before calling this function."
21694 #: ../fish/guestfish-actions.pod:404
21696 "This call was added in version C<1.0.80>. In previous versions of "
21697 "libguestfs all you could do would be to speculatively execute a command to "
21698 "find out if the daemon implemented it. See also L</version>."
21702 #: ../fish/guestfish-actions.pod:411
21703 msgid "available-all-groups"
21707 #: ../fish/guestfish-actions.pod:413
21710 " available-all-groups\n"
21715 #: ../fish/guestfish-actions.pod:415
21717 "This command returns a list of all optional groups that this daemon knows "
21718 "about. Note this returns both supported and unsupported groups. To find "
21719 "out which ones the daemon can actually support you have to call "
21720 "L</available> on each member of the returned list."
21724 #: ../fish/guestfish-actions.pod:421
21725 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21729 #: ../fish/guestfish-actions.pod:423
21734 #: ../fish/guestfish-actions.pod:425
21737 " base64-in (base64file|-) filename\n"
21742 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439 ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832 ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228 ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4457 ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:4479 ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4540 ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4617
21743 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21747 #: ../fish/guestfish-actions.pod:432
21752 #: ../fish/guestfish-actions.pod:434
21755 " base64-out filename (base64file|-)\n"
21760 #: ../fish/guestfish-actions.pod:441
21761 msgid "blockdev-flushbufs"
21765 #: ../fish/guestfish-actions.pod:443
21768 " blockdev-flushbufs device\n"
21773 #: ../fish/guestfish-actions.pod:450
21774 msgid "blockdev-getbsz"
21778 #: ../fish/guestfish-actions.pod:452
21781 " blockdev-getbsz device\n"
21786 #: ../fish/guestfish-actions.pod:461
21787 msgid "blockdev-getro"
21791 #: ../fish/guestfish-actions.pod:463
21794 " blockdev-getro device\n"
21799 #: ../fish/guestfish-actions.pod:470
21800 msgid "blockdev-getsize64"
21804 #: ../fish/guestfish-actions.pod:472
21807 " blockdev-getsize64 device\n"
21812 #: ../fish/guestfish-actions.pod:476
21813 msgid "See also L</blockdev-getsz>."
21817 #: ../fish/guestfish-actions.pod:480
21818 msgid "blockdev-getss"
21822 #: ../fish/guestfish-actions.pod:482
21825 " blockdev-getss device\n"
21830 #: ../fish/guestfish-actions.pod:487
21831 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21835 #: ../fish/guestfish-actions.pod:492
21836 msgid "blockdev-getsz"
21840 #: ../fish/guestfish-actions.pod:494
21843 " blockdev-getsz device\n"
21848 #: ../fish/guestfish-actions.pod:499
21850 "See also L</blockdev-getss> for the real sector size of the device, and "
21851 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21855 #: ../fish/guestfish-actions.pod:505
21856 msgid "blockdev-rereadpt"
21860 #: ../fish/guestfish-actions.pod:507
21863 " blockdev-rereadpt device\n"
21868 #: ../fish/guestfish-actions.pod:513
21869 msgid "blockdev-setbsz"
21873 #: ../fish/guestfish-actions.pod:515
21876 " blockdev-setbsz device blocksize\n"
21881 #: ../fish/guestfish-actions.pod:524
21882 msgid "blockdev-setro"
21886 #: ../fish/guestfish-actions.pod:526
21889 " blockdev-setro device\n"
21894 #: ../fish/guestfish-actions.pod:532
21895 msgid "blockdev-setrw"
21899 #: ../fish/guestfish-actions.pod:534
21902 " blockdev-setrw device\n"
21907 #: ../fish/guestfish-actions.pod:540
21908 msgid "case-sensitive-path"
21912 #: ../fish/guestfish-actions.pod:542
21915 " case-sensitive-path path\n"
21920 #: ../fish/guestfish-actions.pod:566
21922 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21923 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21924 "how the directories were originally created under Windows)."
21928 #: ../fish/guestfish-actions.pod:574
21929 msgid "See also L</realpath>."
21933 #: ../fish/guestfish-actions.pod:576
21938 #: ../fish/guestfish-actions.pod:578
21946 #: ../fish/guestfish-actions.pod:582
21948 "Note that this function cannot correctly handle binary files (specifically, "
21949 "files containing C<\\0> character which is treated as end of string). For "
21950 "those you need to use the L</read-file> or L</download> functions which have "
21951 "a more complex interface."
21955 #: ../fish/guestfish-actions.pod:590
21960 #: ../fish/guestfish-actions.pod:592
21963 " checksum csumtype path\n"
21968 #: ../fish/guestfish-actions.pod:635
21969 msgid "To get the checksum for a device, use L</checksum-device>."
21973 #: ../fish/guestfish-actions.pod:637
21974 msgid "To get the checksums for many files, use L</checksums-out>."
21978 #: ../fish/guestfish-actions.pod:639
21979 msgid "checksum-device"
21983 #: ../fish/guestfish-actions.pod:641
21986 " checksum-device csumtype device\n"
21991 #: ../fish/guestfish-actions.pod:643
21993 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
21994 "device named C<device>. For the types of checksums supported see the "
21995 "L</checksum> command."
21999 #: ../fish/guestfish-actions.pod:647
22000 msgid "checksums-out"
22004 #: ../fish/guestfish-actions.pod:649
22007 " checksums-out csumtype directory (sumsfile|-)\n"
22012 #: ../fish/guestfish-actions.pod:665
22017 #: ../fish/guestfish-actions.pod:667
22020 " chmod mode path\n"
22025 #: ../fish/guestfish-actions.pod:678
22030 #: ../fish/guestfish-actions.pod:680
22033 " chown owner group path\n"
22038 #: ../fish/guestfish-actions.pod:688
22043 #: ../fish/guestfish-actions.pod:690
22046 " command 'arguments ...'\n"
22051 #: ../fish/guestfish-actions.pod:697
22053 "The single parameter is an argv-style list of arguments. The first element "
22054 "is the name of the program to run. Subsequent elements are parameters. The "
22055 "list must be non-empty (ie. must contain a program name). Note that the "
22056 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22060 #: ../fish/guestfish-actions.pod:725
22061 msgid "command-lines"
22065 #: ../fish/guestfish-actions.pod:727
22068 " command-lines 'arguments ...'\n"
22073 #: ../fish/guestfish-actions.pod:729
22074 msgid "This is the same as L</command>, but splits the result into a list of lines."
22078 #: ../fish/guestfish-actions.pod:732
22079 msgid "See also: L</sh-lines>"
22083 #: ../fish/guestfish-actions.pod:737
22088 #: ../fish/guestfish-actions.pod:739
22091 " config qemuparam qemuvalue\n"
22096 #: ../fish/guestfish-actions.pod:750
22101 #: ../fish/guestfish-actions.pod:752
22104 " copy-size src dest size\n"
22109 #: ../fish/guestfish-actions.pod:760
22114 #: ../fish/guestfish-actions.pod:762
22122 #: ../fish/guestfish-actions.pod:767
22127 #: ../fish/guestfish-actions.pod:769
22135 #: ../fish/guestfish-actions.pod:774
22140 #: ../fish/guestfish-actions.pod:776
22148 #: ../fish/guestfish-actions.pod:783
22150 "If the destination is a device, it must be as large or larger than the "
22151 "source file or device, otherwise the copy will fail. This command cannot do "
22152 "partial copies (see L</copy-size>)."
22156 #: ../fish/guestfish-actions.pod:787
22161 #: ../fish/guestfish-actions.pod:789
22169 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22171 "This command is mostly useful for interactive sessions. It is I<not> "
22172 "intended that you try to parse the output string. Use L</statvfs> from "
22177 #: ../fish/guestfish-actions.pod:797
22182 #: ../fish/guestfish-actions.pod:799
22190 #: ../fish/guestfish-actions.pod:808
22195 #: ../fish/guestfish-actions.pod:810
22203 #: ../fish/guestfish-actions.pod:816
22205 "Another way to get the same information is to enable verbose messages with "
22206 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22207 "before running the program."
22211 #: ../fish/guestfish-actions.pod:821
22216 #: ../fish/guestfish-actions.pod:823
22219 " download remotefilename (filename|-)\n"
22224 #: ../fish/guestfish-actions.pod:830
22225 msgid "See also L</upload>, L</cat>."
22229 #: ../fish/guestfish-actions.pod:834
22230 msgid "download-offset"
22234 #: ../fish/guestfish-actions.pod:836
22237 " download-offset remotefilename (filename|-) offset size\n"
22242 #: ../fish/guestfish-actions.pod:844
22244 "Note that there is no limit on the amount of data that can be downloaded "
22245 "with this call, unlike with L</pread>, and this call always reads the full "
22246 "amount unless an error occurs."
22250 #: ../fish/guestfish-actions.pod:849
22251 msgid "See also L</download>, L</pread>."
22255 #: ../fish/guestfish-actions.pod:853
22256 msgid "drop-caches"
22260 #: ../fish/guestfish-actions.pod:855
22263 " drop-caches whattodrop\n"
22268 #: ../fish/guestfish-actions.pod:867
22273 #: ../fish/guestfish-actions.pod:869
22281 #: ../fish/guestfish-actions.pod:881
22286 #: ../fish/guestfish-actions.pod:883
22289 " e2fsck-f device\n"
22294 #: ../fish/guestfish-actions.pod:889
22296 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22297 "should use L</fsck>."
22301 #: ../fish/guestfish-actions.pod:892
22302 msgid "echo-daemon"
22306 #: ../fish/guestfish-actions.pod:894
22309 " echo-daemon 'words ...'\n"
22314 #: ../fish/guestfish-actions.pod:901
22315 msgid "See also L</ping-daemon>."
22319 #: ../fish/guestfish-actions.pod:903
22324 #: ../fish/guestfish-actions.pod:905
22327 " egrep regex path\n"
22332 #: ../fish/guestfish-actions.pod:913
22337 #: ../fish/guestfish-actions.pod:915
22340 " egrepi regex path\n"
22345 #: ../fish/guestfish-actions.pod:923
22350 #: ../fish/guestfish-actions.pod:925
22353 " equal file1 file2\n"
22358 #: ../fish/guestfish-actions.pod:932
22363 #: ../fish/guestfish-actions.pod:934
22371 #: ../fish/guestfish-actions.pod:939
22372 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22376 #: ../fish/guestfish-actions.pod:941
22381 #: ../fish/guestfish-actions.pod:943
22384 " fallocate path len\n"
22389 #: ../fish/guestfish-actions.pod:960
22390 msgid "fallocate64"
22394 #: ../fish/guestfish-actions.pod:962
22397 " fallocate64 path len\n"
22402 #: ../fish/guestfish-actions.pod:968
22404 "Note that this call allocates disk blocks for the file. To create a sparse "
22405 "file use L</truncate-size> instead."
22409 #: ../fish/guestfish-actions.pod:971
22411 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22412 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22413 "maximum size of files created through that call to 1GB."
22417 #: ../fish/guestfish-actions.pod:980
22422 #: ../fish/guestfish-actions.pod:982
22425 " fgrep pattern path\n"
22430 #: ../fish/guestfish-actions.pod:990
22435 #: ../fish/guestfish-actions.pod:992
22438 " fgrepi pattern path\n"
22443 #: ../fish/guestfish-actions.pod:1000
22448 #: ../fish/guestfish-actions.pod:1002
22456 #: ../fish/guestfish-actions.pod:1014
22458 "This command can also be used on C</dev/> devices (and partitions, LV "
22459 "names). You can for example use this to determine if a device contains a "
22460 "filesystem, although it's usually better to use L</vfs-type>."
22464 #: ../fish/guestfish-actions.pod:1024
22465 msgid "file-architecture"
22469 #: ../fish/guestfish-actions.pod:1026
22472 " file-architecture filename\n"
22477 #: ../fish/guestfish-actions.pod:1129
22482 #: ../fish/guestfish-actions.pod:1131
22490 #: ../fish/guestfish-actions.pod:1135
22492 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22493 "L</is-file> etc. To get the size of block devices, use "
22494 "L</blockdev-getsize64>."
22498 #: ../fish/guestfish-actions.pod:1139
22503 #: ../fish/guestfish-actions.pod:1141
22506 " fill c len path\n"
22511 #: ../fish/guestfish-actions.pod:1147
22513 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22514 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22515 "L</fill-pattern>."
22519 #: ../fish/guestfish-actions.pod:1152
22520 msgid "fill-pattern"
22524 #: ../fish/guestfish-actions.pod:1154
22527 " fill-pattern pattern len path\n"
22532 #: ../fish/guestfish-actions.pod:1156
22534 "This function is like L</fill> except that it creates a new file of length "
22535 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22536 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22541 #: ../fish/guestfish-actions.pod:1161
22546 #: ../fish/guestfish-actions.pod:1163
22549 " find directory\n"
22554 #: ../fish/guestfish-actions.pod:1177
22555 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22559 #: ../fish/guestfish-actions.pod:1190
22560 msgid "See also L</find0>."
22564 #: ../fish/guestfish-actions.pod:1195
22569 #: ../fish/guestfish-actions.pod:1197
22572 " find0 directory (files|-)\n"
22577 #: ../fish/guestfish-actions.pod:1203
22578 msgid "This command works the same way as L</find> with the following exceptions:"
22582 #: ../fish/guestfish-actions.pod:1230
22583 msgid "findfs-label"
22587 #: ../fish/guestfish-actions.pod:1232
22590 " findfs-label label\n"
22595 #: ../fish/guestfish-actions.pod:1238
22596 msgid "To find the label of a filesystem, use L</vfs-label>."
22600 #: ../fish/guestfish-actions.pod:1240
22601 msgid "findfs-uuid"
22605 #: ../fish/guestfish-actions.pod:1242
22608 " findfs-uuid uuid\n"
22613 #: ../fish/guestfish-actions.pod:1248
22614 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22618 #: ../fish/guestfish-actions.pod:1250
22623 #: ../fish/guestfish-actions.pod:1252
22626 " fsck fstype device\n"
22631 #: ../fish/guestfish-actions.pod:1282
22636 #: ../fish/guestfish-actions.pod:1284
22644 #: ../fish/guestfish-actions.pod:1291
22645 msgid "get-attach-method"
22649 #: ../fish/guestfish-actions.pod:1293
22652 " get-attach-method\n"
22657 #: ../fish/guestfish-actions.pod:1295
22658 msgid "Return the current attach method. See L</set-attach-method>."
22662 #: ../fish/guestfish-actions.pod:1297
22663 msgid "get-autosync"
22667 #: ../fish/guestfish-actions.pod:1299
22675 #: ../fish/guestfish-actions.pod:1303
22680 #: ../fish/guestfish-actions.pod:1305
22688 #: ../fish/guestfish-actions.pod:1309
22689 msgid "get-e2label"
22693 #: ../fish/guestfish-actions.pod:1311
22696 " get-e2label device\n"
22701 #: ../fish/guestfish-actions.pod:1323
22706 #: ../fish/guestfish-actions.pod:1325
22709 " get-e2uuid device\n"
22714 #: ../fish/guestfish-actions.pod:1337
22715 msgid "get-memsize"
22719 #: ../fish/guestfish-actions.pod:1339
22727 #: ../fish/guestfish-actions.pod:1344
22729 "If L</set-memsize> was not called on this handle, and if "
22730 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22731 "value for memsize."
22735 #: ../fish/guestfish-actions.pod:1351
22736 msgid "get-network"
22740 #: ../fish/guestfish-actions.pod:1353
22748 #: ../fish/guestfish-actions.pod:1357
22753 #: ../fish/guestfish-actions.pod:1359
22761 #: ../fish/guestfish-actions.pod:1366
22766 #: ../fish/guestfish-actions.pod:1368
22771 #: ../fish/guestfish-actions.pod:1370
22779 #: ../fish/guestfish-actions.pod:1377
22784 #: ../fish/guestfish-actions.pod:1379
22792 #: ../fish/guestfish-actions.pod:1386
22793 msgid "get-recovery-proc"
22797 #: ../fish/guestfish-actions.pod:1388
22800 " get-recovery-proc\n"
22805 #: ../fish/guestfish-actions.pod:1392
22806 msgid "get-selinux"
22810 #: ../fish/guestfish-actions.pod:1394
22818 #: ../fish/guestfish-actions.pod:1396
22820 "This returns the current setting of the selinux flag which is passed to the "
22821 "appliance at boot time. See L</set-selinux>."
22825 #: ../fish/guestfish-actions.pod:1402
22830 #: ../fish/guestfish-actions.pod:1404
22838 #: ../fish/guestfish-actions.pod:1411
22843 #: ../fish/guestfish-actions.pod:1413
22851 #: ../fish/guestfish-actions.pod:1417
22856 #: ../fish/guestfish-actions.pod:1419
22864 #: ../fish/guestfish-actions.pod:1421
22866 "Return the current umask. By default the umask is C<022> unless it has been "
22867 "set by calling L</umask>."
22871 #: ../fish/guestfish-actions.pod:1424
22872 msgid "get-verbose"
22876 #: ../fish/guestfish-actions.pod:1426
22884 #: ../fish/guestfish-actions.pod:1430
22889 #: ../fish/guestfish-actions.pod:1432
22897 #: ../fish/guestfish-actions.pod:1436
22898 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22902 #: ../fish/guestfish-actions.pod:1439
22907 #: ../fish/guestfish-actions.pod:1441
22910 " getxattr path name\n"
22915 #: ../fish/guestfish-actions.pod:1443
22917 "Get a single extended attribute from file C<path> named C<name>. This call "
22918 "follows symlinks. If you want to lookup an extended attribute for the "
22919 "symlink itself, use L</lgetxattr>."
22923 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2453
22925 "Normally it is better to get all extended attributes from a file in one go "
22926 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22927 "buggy and do not provide a way to list out attributes. For these "
22928 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22929 "attributes you want in advance and call this function."
22933 #: ../fish/guestfish-actions.pod:1457
22934 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22938 #: ../fish/guestfish-actions.pod:1459
22943 #: ../fish/guestfish-actions.pod:1461
22946 " getxattrs path\n"
22951 #: ../fish/guestfish-actions.pod:1469
22952 msgid "See also: L</lgetxattrs>, L<attr(5)>."
22956 #: ../fish/guestfish-actions.pod:1471
22957 msgid "glob-expand"
22961 #: ../fish/guestfish-actions.pod:1473
22964 " glob-expand pattern\n"
22969 #: ../fish/guestfish-actions.pod:1486
22974 #: ../fish/guestfish-actions.pod:1488
22977 " grep regex path\n"
22982 #: ../fish/guestfish-actions.pod:1496
22987 #: ../fish/guestfish-actions.pod:1498
22990 " grepi regex path\n"
22995 #: ../fish/guestfish-actions.pod:1506
22996 msgid "grub-install"
23000 #: ../fish/guestfish-actions.pod:1508
23003 " grub-install root device\n"
23008 #: ../fish/guestfish-actions.pod:1524
23013 #: ../fish/guestfish-actions.pod:1526
23021 #: ../fish/guestfish-actions.pod:1534
23026 #: ../fish/guestfish-actions.pod:1536
23029 " head-n nrlines path\n"
23034 #: ../fish/guestfish-actions.pod:1549
23039 #: ../fish/guestfish-actions.pod:1551
23047 #: ../fish/guestfish-actions.pod:1559
23052 #: ../fish/guestfish-actions.pod:1561
23055 " initrd-cat initrdpath filename\n"
23060 #: ../fish/guestfish-actions.pod:1573
23061 msgid "See also L</initrd-list>."
23065 #: ../fish/guestfish-actions.pod:1578
23066 msgid "initrd-list"
23070 #: ../fish/guestfish-actions.pod:1580
23073 " initrd-list path\n"
23078 #: ../fish/guestfish-actions.pod:1592
23079 msgid "inotify-add-watch"
23083 #: ../fish/guestfish-actions.pod:1594
23086 " inotify-add-watch path mask\n"
23091 #: ../fish/guestfish-actions.pod:1606
23092 msgid "inotify-close"
23096 #: ../fish/guestfish-actions.pod:1608
23104 #: ../fish/guestfish-actions.pod:1614
23105 msgid "inotify-files"
23109 #: ../fish/guestfish-actions.pod:1616
23117 #: ../fish/guestfish-actions.pod:1618
23119 "This function is a helpful wrapper around L</inotify-read> which just "
23120 "returns a list of pathnames of objects that were touched. The returned "
23121 "pathnames are sorted and deduplicated."
23125 #: ../fish/guestfish-actions.pod:1622
23126 msgid "inotify-init"
23130 #: ../fish/guestfish-actions.pod:1624
23133 " inotify-init maxevents\n"
23138 #: ../fish/guestfish-actions.pod:1630
23140 "C<maxevents> is the maximum number of events which will be queued up between "
23141 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23142 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23143 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23144 "but records the fact that it threw them away by setting a flag "
23145 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23149 #: ../fish/guestfish-actions.pod:1640
23151 "Before any events are generated, you have to add some watches to the "
23152 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23153 "L</inotify-watch-all>."
23157 #: ../fish/guestfish-actions.pod:1646
23159 "Queued up events should be read periodically by calling L</inotify-read> (or "
23160 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23161 "If you don't read the events out often enough then you risk the internal "
23162 "queue overflowing."
23166 #: ../fish/guestfish-actions.pod:1653
23168 "The handle should be closed after use by calling L</inotify-close>. This "
23169 "also removes any watches automatically."
23173 #: ../fish/guestfish-actions.pod:1662
23174 msgid "inotify-read"
23178 #: ../fish/guestfish-actions.pod:1664
23186 #: ../fish/guestfish-actions.pod:1677
23187 msgid "inotify-rm-watch"
23191 #: ../fish/guestfish-actions.pod:1679
23194 " inotify-rm-watch wd\n"
23199 #: ../fish/guestfish-actions.pod:1681
23200 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23204 #: ../fish/guestfish-actions.pod:1684
23205 msgid "inspect-get-arch"
23209 #: ../fish/guestfish-actions.pod:1686
23212 " inspect-get-arch root\n"
23217 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1790 ../fish/guestfish-actions.pod:1826 ../fish/guestfish-actions.pod:1844 ../fish/guestfish-actions.pod:1878 ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:1914 ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2008 ../fish/guestfish-actions.pod:2025 ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2103 ../fish/guestfish-actions.pod:2119 ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2148 ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2176
23219 "This function should only be called with a root device string as returned by "
23224 #: ../fish/guestfish-actions.pod:1691
23226 "This returns the architecture of the inspected operating system. The "
23227 "possible return values are listed under L</file-architecture>."
23231 #: ../fish/guestfish-actions.pod:1700
23232 msgid "inspect-get-distro"
23236 #: ../fish/guestfish-actions.pod:1702
23239 " inspect-get-distro root\n"
23244 #: ../fish/guestfish-actions.pod:1786
23245 msgid "inspect-get-drive-mappings"
23249 #: ../fish/guestfish-actions.pod:1788
23252 " inspect-get-drive-mappings root\n"
23257 #: ../fish/guestfish-actions.pod:1818
23259 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23260 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23264 #: ../fish/guestfish-actions.pod:1822
23265 msgid "inspect-get-filesystems"
23269 #: ../fish/guestfish-actions.pod:1824
23272 " inspect-get-filesystems root\n"
23277 #: ../fish/guestfish-actions.pod:1837
23279 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23280 "L</inspect-get-mountpoints>."
23284 #: ../fish/guestfish-actions.pod:1840
23285 msgid "inspect-get-format"
23289 #: ../fish/guestfish-actions.pod:1842
23292 " inspect-get-format root\n"
23297 #: ../fish/guestfish-actions.pod:1874
23298 msgid "inspect-get-hostname"
23302 #: ../fish/guestfish-actions.pod:1876
23305 " inspect-get-hostname root\n"
23310 #: ../fish/guestfish-actions.pod:1889
23311 msgid "inspect-get-major-version"
23315 #: ../fish/guestfish-actions.pod:1891
23318 " inspect-get-major-version root\n"
23323 #: ../fish/guestfish-actions.pod:1910
23324 msgid "inspect-get-minor-version"
23328 #: ../fish/guestfish-actions.pod:1912
23331 " inspect-get-minor-version root\n"
23336 #: ../fish/guestfish-actions.pod:1922
23338 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23339 "L</inspect-get-major-version>."
23343 #: ../fish/guestfish-actions.pod:1925
23344 msgid "inspect-get-mountpoints"
23348 #: ../fish/guestfish-actions.pod:1927
23351 " inspect-get-mountpoints root\n"
23356 #: ../fish/guestfish-actions.pod:1949
23358 "For operating systems like Windows which still use drive letters, this call "
23359 "will only return an entry for the first drive \"mounted on\" C</>. For "
23360 "information about the mapping of drive letters to partitions, see "
23361 "L</inspect-get-drive-mappings>."
23365 #: ../fish/guestfish-actions.pod:1955
23367 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23368 "L</inspect-get-filesystems>."
23372 #: ../fish/guestfish-actions.pod:1958
23373 msgid "inspect-get-package-format"
23377 #: ../fish/guestfish-actions.pod:1960
23380 " inspect-get-package-format root\n"
23385 #: ../fish/guestfish-actions.pod:1965
23387 "This function and L</inspect-get-package-management> return the package "
23388 "format and package management tool used by the inspected operating system. "
23389 "For example for Fedora these functions would return C<rpm> (package format) "
23390 "and C<yum> (package management)."
23394 #: ../fish/guestfish-actions.pod:1980
23395 msgid "inspect-get-package-management"
23399 #: ../fish/guestfish-actions.pod:1982
23402 " inspect-get-package-management root\n"
23407 #: ../fish/guestfish-actions.pod:1987
23409 "L</inspect-get-package-format> and this function return the package format "
23410 "and package management tool used by the inspected operating system. For "
23411 "example for Fedora these functions would return C<rpm> (package format) and "
23412 "C<yum> (package management)."
23416 #: ../fish/guestfish-actions.pod:2004
23417 msgid "inspect-get-product-name"
23421 #: ../fish/guestfish-actions.pod:2006
23424 " inspect-get-product-name root\n"
23429 #: ../fish/guestfish-actions.pod:2021
23430 msgid "inspect-get-product-variant"
23434 #: ../fish/guestfish-actions.pod:2023
23437 " inspect-get-product-variant root\n"
23442 #: ../fish/guestfish-actions.pod:2047
23444 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23445 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23449 #: ../fish/guestfish-actions.pod:2051
23450 msgid "inspect-get-roots"
23454 #: ../fish/guestfish-actions.pod:2053
23457 " inspect-get-roots\n"
23462 #: ../fish/guestfish-actions.pod:2055
23464 "This function is a convenient way to get the list of root devices, as "
23465 "returned from a previous call to L</inspect-os>, but without redoing the "
23466 "whole inspection process."
23470 #: ../fish/guestfish-actions.pod:2059
23472 "This returns an empty list if either no root devices were found or the "
23473 "caller has not called L</inspect-os>."
23477 #: ../fish/guestfish-actions.pod:2064
23478 msgid "inspect-get-type"
23482 #: ../fish/guestfish-actions.pod:2066
23485 " inspect-get-type root\n"
23490 #: ../fish/guestfish-actions.pod:2099
23491 msgid "inspect-get-windows-current-control-set"
23495 #: ../fish/guestfish-actions.pod:2101
23498 " inspect-get-windows-current-control-set root\n"
23503 #: ../fish/guestfish-actions.pod:2115
23504 msgid "inspect-get-windows-systemroot"
23508 #: ../fish/guestfish-actions.pod:2117
23511 " inspect-get-windows-systemroot root\n"
23516 #: ../fish/guestfish-actions.pod:2131
23517 msgid "inspect-is-live"
23521 #: ../fish/guestfish-actions.pod:2133
23524 " inspect-is-live root\n"
23529 #: ../fish/guestfish-actions.pod:2138
23531 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23532 "then this returns true if a live image was detected on the disk."
23536 #: ../fish/guestfish-actions.pod:2144
23537 msgid "inspect-is-multipart"
23541 #: ../fish/guestfish-actions.pod:2146
23544 " inspect-is-multipart root\n"
23549 #: ../fish/guestfish-actions.pod:2151
23551 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23552 "then this returns true if the disk is part of a set."
23556 #: ../fish/guestfish-actions.pod:2157
23557 msgid "inspect-is-netinst"
23561 #: ../fish/guestfish-actions.pod:2159
23564 " inspect-is-netinst root\n"
23569 #: ../fish/guestfish-actions.pod:2164
23571 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23572 "then this returns true if the disk is a network installer, ie. not a "
23573 "self-contained install CD but one which is likely to require network access "
23574 "to complete the install."
23578 #: ../fish/guestfish-actions.pod:2172
23579 msgid "inspect-list-applications"
23583 #: ../fish/guestfish-actions.pod:2174
23586 " inspect-list-applications root\n"
23591 #: ../fish/guestfish-actions.pod:2181
23593 "I<Note:> This call works differently from other parts of the inspection "
23594 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23595 "then mount up the disks, before calling this. Listing applications is a "
23596 "significantly more difficult operation which requires access to the full "
23597 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23598 "are just returning data cached in the libguestfs handle, this call actually "
23599 "reads parts of the mounted filesystems during the call."
23603 #: ../fish/guestfish-actions.pod:2271
23608 #: ../fish/guestfish-actions.pod:2273
23616 #: ../fish/guestfish-actions.pod:2288
23618 "You can pass the root string(s) returned to other L</inspect-get-*> "
23619 "functions in order to query further information about each operating system, "
23620 "such as the name and version."
23624 #: ../fish/guestfish-actions.pod:2293
23626 "This function uses other libguestfs features such as L</mount-ro> and "
23627 "L</umount-all> in order to mount and unmount filesystems and look at the "
23628 "contents. This should be called with no disks currently mounted. The "
23629 "function may also use Augeas, so any existing Augeas handle will be closed."
23633 #: ../fish/guestfish-actions.pod:2305 ../fish/guestfish-actions.pod:2481 ../fish/guestfish-actions.pod:2527
23634 msgid "See also L</list-filesystems>."
23638 #: ../fish/guestfish-actions.pod:2307
23639 msgid "is-blockdev"
23643 #: ../fish/guestfish-actions.pod:2309
23646 " is-blockdev path\n"
23651 #: ../fish/guestfish-actions.pod:2314 ../fish/guestfish-actions.pod:2332 ../fish/guestfish-actions.pod:2351 ../fish/guestfish-actions.pod:2360 ../fish/guestfish-actions.pod:2370 ../fish/guestfish-actions.pod:2404 ../fish/guestfish-actions.pod:2413
23652 msgid "See also L</stat>."
23656 #: ../fish/guestfish-actions.pod:2316
23661 #: ../fish/guestfish-actions.pod:2318
23669 #: ../fish/guestfish-actions.pod:2325
23674 #: ../fish/guestfish-actions.pod:2327
23677 " is-chardev path\n"
23682 #: ../fish/guestfish-actions.pod:2334
23687 #: ../fish/guestfish-actions.pod:2336
23695 #: ../fish/guestfish-actions.pod:2343
23700 #: ../fish/guestfish-actions.pod:2345
23708 #: ../fish/guestfish-actions.pod:2353
23713 #: ../fish/guestfish-actions.pod:2355
23721 #: ../fish/guestfish-actions.pod:2362
23726 #: ../fish/guestfish-actions.pod:2364
23734 #: ../fish/guestfish-actions.pod:2372
23735 msgid "is-launching"
23739 #: ../fish/guestfish-actions.pod:2374
23747 #: ../fish/guestfish-actions.pod:2381
23752 #: ../fish/guestfish-actions.pod:2383
23760 #: ../fish/guestfish-actions.pod:2388
23765 #: ../fish/guestfish-actions.pod:2390
23773 #: ../fish/guestfish-actions.pod:2397
23778 #: ../fish/guestfish-actions.pod:2399
23781 " is-socket path\n"
23786 #: ../fish/guestfish-actions.pod:2406
23791 #: ../fish/guestfish-actions.pod:2408
23794 " is-symlink path\n"
23799 #: ../fish/guestfish-actions.pod:2415
23800 msgid "kill-subprocess"
23804 #: ../fish/guestfish-actions.pod:2417
23807 " kill-subprocess\n"
23812 #: ../fish/guestfish-actions.pod:2421
23817 #: ../fish/guestfish-actions.pod:2423
23822 #: ../fish/guestfish-actions.pod:2425
23830 #: ../fish/guestfish-actions.pod:2433
23835 #: ../fish/guestfish-actions.pod:2435
23838 " lchown owner group path\n"
23843 #: ../fish/guestfish-actions.pod:2437
23845 "Change the file owner to C<owner> and group to C<group>. This is like "
23846 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23851 #: ../fish/guestfish-actions.pod:2445
23856 #: ../fish/guestfish-actions.pod:2447
23859 " lgetxattr path name\n"
23864 #: ../fish/guestfish-actions.pod:2463
23865 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23869 #: ../fish/guestfish-actions.pod:2465
23874 #: ../fish/guestfish-actions.pod:2467
23877 " lgetxattrs path\n"
23882 #: ../fish/guestfish-actions.pod:2469
23884 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23885 "it returns the extended attributes of the link itself."
23889 #: ../fish/guestfish-actions.pod:2473
23890 msgid "list-devices"
23894 #: ../fish/guestfish-actions.pod:2475
23902 #: ../fish/guestfish-actions.pod:2483
23903 msgid "list-filesystems"
23907 #: ../fish/guestfish-actions.pod:2485
23910 " list-filesystems\n"
23915 #: ../fish/guestfish-actions.pod:2504
23917 "This command runs other libguestfs commands, which might include L</mount> "
23918 "and L</umount>, and therefore you should use this soon after launch and only "
23919 "when nothing is mounted."
23923 #: ../fish/guestfish-actions.pod:2508
23925 "Not all of the filesystems returned will be mountable. In particular, swap "
23926 "partitions are returned in the list. Also this command does not check that "
23927 "each filesystem found is valid and mountable, and some filesystems might be "
23928 "mountable but require special options. Filesystems may not all belong to a "
23929 "single logical operating system (use L</inspect-os> to look for OSes)."
23933 #: ../fish/guestfish-actions.pod:2516
23934 msgid "list-partitions"
23938 #: ../fish/guestfish-actions.pod:2518
23941 " list-partitions\n"
23946 #: ../fish/guestfish-actions.pod:2524
23948 "This does not return logical volumes. For that you will need to call "
23953 #: ../fish/guestfish-actions.pod:2529
23958 #: ../fish/guestfish-actions.pod:2531
23966 #: ../fish/guestfish-actions.pod:2539
23971 #: ../fish/guestfish-actions.pod:2541
23974 " ln target linkname\n"
23979 #: ../fish/guestfish-actions.pod:2545
23984 #: ../fish/guestfish-actions.pod:2547
23987 " ln-f target linkname\n"
23992 #: ../fish/guestfish-actions.pod:2552
23997 #: ../fish/guestfish-actions.pod:2554
24000 " ln-s target linkname\n"
24005 #: ../fish/guestfish-actions.pod:2558
24010 #: ../fish/guestfish-actions.pod:2560
24013 " ln-sf target linkname\n"
24018 #: ../fish/guestfish-actions.pod:2565
24019 msgid "lremovexattr"
24023 #: ../fish/guestfish-actions.pod:2567
24026 " lremovexattr xattr path\n"
24031 #: ../fish/guestfish-actions.pod:2569
24033 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24034 "it removes an extended attribute of the link itself."
24038 #: ../fish/guestfish-actions.pod:2573
24043 #: ../fish/guestfish-actions.pod:2575
24051 #: ../fish/guestfish-actions.pod:2581
24053 "This command is mostly useful for interactive sessions. Programs should "
24054 "probably use L</readdir> instead."
24058 #: ../fish/guestfish-actions.pod:2584
24063 #: ../fish/guestfish-actions.pod:2586
24066 " lsetxattr xattr val vallen path\n"
24071 #: ../fish/guestfish-actions.pod:2588
24073 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24074 "sets an extended attribute of the link itself."
24078 #: ../fish/guestfish-actions.pod:2592
24083 #: ../fish/guestfish-actions.pod:2594
24091 #: ../fish/guestfish-actions.pod:2598
24093 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24094 "the link is stat-ed, not the file it refers to."
24098 #: ../fish/guestfish-actions.pod:2604
24103 #: ../fish/guestfish-actions.pod:2606
24106 " lstatlist path 'names ...'\n"
24111 #: ../fish/guestfish-actions.pod:2608
24113 "This call allows you to perform the L</lstat> operation on multiple files, "
24114 "where all files are in the directory C<path>. C<names> is the list of files "
24115 "from this directory."
24119 #: ../fish/guestfish-actions.pod:2617
24121 "This call is intended for programs that want to efficiently list a directory "
24122 "contents without making many round-trips. See also L</lxattrlist> for a "
24123 "similarly efficient call for getting extended attributes. Very long "
24124 "directory listings might cause the protocol message size to be exceeded, "
24125 "causing this call to fail. The caller must split up such requests into "
24126 "smaller groups of names."
24130 #: ../fish/guestfish-actions.pod:2625
24131 msgid "luks-add-key"
24135 #: ../fish/guestfish-actions.pod:2627
24138 " luks-add-key device keyslot\n"
24143 #: ../fish/guestfish-actions.pod:2634
24145 "Note that if C<keyslot> already contains a key, then this command will "
24146 "fail. You have to use L</luks-kill-slot> first to remove that key."
24150 #: ../fish/guestfish-actions.pod:2638 ../fish/guestfish-actions.pod:2660 ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2687 ../fish/guestfish-actions.pod:2710 ../fish/guestfish-actions.pod:2720
24152 "This command has one or more key or passphrase parameters. Guestfish will "
24153 "prompt for these separately."
24157 #: ../fish/guestfish-actions.pod:2641
24162 #: ../fish/guestfish-actions.pod:2643
24165 " luks-close device\n"
24170 #: ../fish/guestfish-actions.pod:2645
24172 "This closes a LUKS device that was created earlier by L</luks-open> or "
24173 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24174 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24175 "underlying block device."
24179 #: ../fish/guestfish-actions.pod:2651
24180 msgid "luks-format"
24184 #: ../fish/guestfish-actions.pod:2653
24187 " luks-format device keyslot\n"
24192 #: ../fish/guestfish-actions.pod:2666
24193 msgid "luks-format-cipher"
24197 #: ../fish/guestfish-actions.pod:2668
24200 " luks-format-cipher device keyslot cipher\n"
24205 #: ../fish/guestfish-actions.pod:2670
24207 "This command is the same as L</luks-format> but it also allows you to set "
24208 "the C<cipher> used."
24212 #: ../fish/guestfish-actions.pod:2679
24213 msgid "luks-kill-slot"
24217 #: ../fish/guestfish-actions.pod:2681
24220 " luks-kill-slot device keyslot\n"
24225 #: ../fish/guestfish-actions.pod:2690
24230 #: ../fish/guestfish-actions.pod:2692
24233 " luks-open device mapname\n"
24238 #: ../fish/guestfish-actions.pod:2706
24240 "If this block device contains LVM volume groups, then calling L</vgscan> "
24241 "followed by L</vg-activate-all> will make them visible."
24245 #: ../fish/guestfish-actions.pod:2713
24246 msgid "luks-open-ro"
24250 #: ../fish/guestfish-actions.pod:2715
24253 " luks-open-ro device mapname\n"
24258 #: ../fish/guestfish-actions.pod:2717
24260 "This is the same as L</luks-open> except that a read-only mapping is "
24265 #: ../fish/guestfish-actions.pod:2723
24270 #: ../fish/guestfish-actions.pod:2725
24273 " lvcreate logvol volgroup mbytes\n"
24278 #: ../fish/guestfish-actions.pod:2730
24279 msgid "lvm-canonical-lv-name"
24283 #: ../fish/guestfish-actions.pod:2732
24286 " lvm-canonical-lv-name lvname\n"
24291 #: ../fish/guestfish-actions.pod:2741
24292 msgid "See also L</is-lv>."
24296 #: ../fish/guestfish-actions.pod:2743
24297 msgid "lvm-clear-filter"
24301 #: ../fish/guestfish-actions.pod:2745
24304 " lvm-clear-filter\n"
24309 #: ../fish/guestfish-actions.pod:2747
24311 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24316 #: ../fish/guestfish-actions.pod:2753
24317 msgid "lvm-remove-all"
24321 #: ../fish/guestfish-actions.pod:2755
24324 " lvm-remove-all\n"
24329 #: ../fish/guestfish-actions.pod:2763
24330 msgid "lvm-set-filter"
24334 #: ../fish/guestfish-actions.pod:2765
24337 " lvm-set-filter 'devices ...'\n"
24342 #: ../fish/guestfish-actions.pod:2790
24347 #: ../fish/guestfish-actions.pod:2792
24350 " lvremove device\n"
24355 #: ../fish/guestfish-actions.pod:2800
24360 #: ../fish/guestfish-actions.pod:2802
24363 " lvrename logvol newlogvol\n"
24368 #: ../fish/guestfish-actions.pod:2806
24373 #: ../fish/guestfish-actions.pod:2808
24376 " lvresize device mbytes\n"
24381 #: ../fish/guestfish-actions.pod:2814
24382 msgid "lvresize-free"
24386 #: ../fish/guestfish-actions.pod:2816
24389 " lvresize-free lv percent\n"
24394 #: ../fish/guestfish-actions.pod:2824
24399 #: ../fish/guestfish-actions.pod:2826
24407 #: ../fish/guestfish-actions.pod:2834
24408 msgid "See also L</lvs-full>, L</list-filesystems>."
24412 #: ../fish/guestfish-actions.pod:2836
24417 #: ../fish/guestfish-actions.pod:2838
24425 #: ../fish/guestfish-actions.pod:2843
24430 #: ../fish/guestfish-actions.pod:2845
24438 #: ../fish/guestfish-actions.pod:2849
24443 #: ../fish/guestfish-actions.pod:2851
24446 " lxattrlist path 'names ...'\n"
24451 #: ../fish/guestfish-actions.pod:2867
24453 "This call is intended for programs that want to efficiently list a directory "
24454 "contents without making many round-trips. See also L</lstatlist> for a "
24455 "similarly efficient call for getting standard stats. Very long directory "
24456 "listings might cause the protocol message size to be exceeded, causing this "
24457 "call to fail. The caller must split up such requests into smaller groups of "
24462 #: ../fish/guestfish-actions.pod:2875
24467 #: ../fish/guestfish-actions.pod:2877
24475 #: ../fish/guestfish-actions.pod:2881
24480 #: ../fish/guestfish-actions.pod:2883
24483 " mkdir-mode path mode\n"
24488 #: ../fish/guestfish-actions.pod:2892
24489 msgid "See also L</mkdir>, L</umask>"
24493 #: ../fish/guestfish-actions.pod:2894
24498 #: ../fish/guestfish-actions.pod:2896
24506 #: ../fish/guestfish-actions.pod:2901
24511 #: ../fish/guestfish-actions.pod:2903
24514 " mkdtemp template\n"
24519 #: ../fish/guestfish-actions.pod:2924
24524 #: ../fish/guestfish-actions.pod:2926
24527 " mke2fs-J fstype blocksize device journal\n"
24532 #: ../fish/guestfish-actions.pod:2934
24533 msgid "See also L</mke2journal>."
24537 #: ../fish/guestfish-actions.pod:2936
24542 #: ../fish/guestfish-actions.pod:2938
24545 " mke2fs-JL fstype blocksize device label\n"
24550 #: ../fish/guestfish-actions.pod:2943
24551 msgid "See also L</mke2journal-L>."
24555 #: ../fish/guestfish-actions.pod:2945
24560 #: ../fish/guestfish-actions.pod:2947
24563 " mke2fs-JU fstype blocksize device uuid\n"
24568 #: ../fish/guestfish-actions.pod:2952
24569 msgid "See also L</mke2journal-U>."
24573 #: ../fish/guestfish-actions.pod:2954
24574 msgid "mke2journal"
24578 #: ../fish/guestfish-actions.pod:2956
24581 " mke2journal blocksize device\n"
24586 #: ../fish/guestfish-actions.pod:2963
24587 msgid "mke2journal-L"
24591 #: ../fish/guestfish-actions.pod:2965
24594 " mke2journal-L blocksize label device\n"
24599 #: ../fish/guestfish-actions.pod:2969
24600 msgid "mke2journal-U"
24604 #: ../fish/guestfish-actions.pod:2971
24607 " mke2journal-U blocksize uuid device\n"
24612 #: ../fish/guestfish-actions.pod:2975
24617 #: ../fish/guestfish-actions.pod:2977
24620 " mkfifo mode path\n"
24625 #: ../fish/guestfish-actions.pod:2979
24627 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24628 "is just a convenient wrapper around L</mknod>."
24632 #: ../fish/guestfish-actions.pod:2985
24637 #: ../fish/guestfish-actions.pod:2987
24640 " mkfs fstype device\n"
24645 #: ../fish/guestfish-actions.pod:2993
24650 #: ../fish/guestfish-actions.pod:2995
24653 " mkfs-b fstype blocksize device\n"
24658 #: ../fish/guestfish-actions.pod:2997
24660 "This call is similar to L</mkfs>, but it allows you to control the block "
24661 "size of the resulting filesystem. Supported block sizes depend on the "
24662 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24666 #: ../fish/guestfish-actions.pod:3012
24671 #: ../fish/guestfish-actions.pod:3014
24674 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24679 #: ../fish/guestfish-actions.pod:3049
24680 msgid "mkmountpoint"
24684 #: ../fish/guestfish-actions.pod:3051
24687 " mkmountpoint exemptpath\n"
24692 #: ../fish/guestfish-actions.pod:3053
24694 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24695 "to create extra mountpoints before mounting the first filesystem."
24699 #: ../fish/guestfish-actions.pod:3077
24701 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24702 "unexpected errors if you try to mix these calls. It is safest to manually "
24703 "unmount filesystems and remove mountpoints after use."
24707 #: ../fish/guestfish-actions.pod:3081
24709 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24710 "for this to work for manual mountpoints, you must ensure that the innermost "
24711 "mountpoints have the longest pathnames, as in the example code above."
24715 #: ../fish/guestfish-actions.pod:3088
24717 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24718 "L</umount-all> to be called when the handle is closed which can also trigger "
24723 #: ../fish/guestfish-actions.pod:3092
24728 #: ../fish/guestfish-actions.pod:3094
24731 " mknod mode devmajor devminor path\n"
24736 #: ../fish/guestfish-actions.pod:3104
24738 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24739 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24740 "regular file). These constants are available in the standard Linux header "
24741 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24742 "wrappers around this command which bitwise OR in the appropriate constant "
24747 #: ../fish/guestfish-actions.pod:3114
24752 #: ../fish/guestfish-actions.pod:3116
24755 " mknod-b mode devmajor devminor path\n"
24760 #: ../fish/guestfish-actions.pod:3118
24762 "This call creates a block device node called C<path> with mode C<mode> and "
24763 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24764 "wrapper around L</mknod>."
24768 #: ../fish/guestfish-actions.pod:3124
24773 #: ../fish/guestfish-actions.pod:3126
24776 " mknod-c mode devmajor devminor path\n"
24781 #: ../fish/guestfish-actions.pod:3128
24783 "This call creates a char device node called C<path> with mode C<mode> and "
24784 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24785 "wrapper around L</mknod>."
24789 #: ../fish/guestfish-actions.pod:3134
24794 #: ../fish/guestfish-actions.pod:3136
24802 #: ../fish/guestfish-actions.pod:3140
24807 #: ../fish/guestfish-actions.pod:3142
24810 " mkswap-L label device\n"
24815 #: ../fish/guestfish-actions.pod:3150
24820 #: ../fish/guestfish-actions.pod:3152
24823 " mkswap-U uuid device\n"
24828 #: ../fish/guestfish-actions.pod:3156
24829 msgid "mkswap-file"
24833 #: ../fish/guestfish-actions.pod:3158
24836 " mkswap-file path\n"
24841 #: ../fish/guestfish-actions.pod:3162
24843 "This command just writes a swap file signature to an existing file. To "
24844 "create the file itself, use something like L</fallocate>."
24848 #: ../fish/guestfish-actions.pod:3165
24853 #: ../fish/guestfish-actions.pod:3167
24856 " modprobe modulename\n"
24861 #: ../fish/guestfish-actions.pod:3174
24866 #: ../fish/guestfish-actions.pod:3176
24869 " mount device mountpoint\n"
24874 #: ../fish/guestfish-actions.pod:3192
24876 "B<Important note:> When you use this call, the filesystem options C<sync> "
24877 "and C<noatime> are set implicitly. This was originally done because we "
24878 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24879 "very large negative performance impact and negligible effect on "
24880 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24881 "code that needs performance, and instead use L</mount-options> (use an empty "
24882 "string for the first parameter if you don't want any options)."
24886 #: ../fish/guestfish-actions.pod:3202
24891 #: ../fish/guestfish-actions.pod:3204
24894 " mount-loop file mountpoint\n"
24899 #: ../fish/guestfish-actions.pod:3210
24900 msgid "mount-options"
24904 #: ../fish/guestfish-actions.pod:3212
24907 " mount-options options device mountpoint\n"
24912 #: ../fish/guestfish-actions.pod:3214
24914 "This is the same as the L</mount> command, but it allows you to set the "
24915 "mount options as for the L<mount(8)> I<-o> flag."
24919 #: ../fish/guestfish-actions.pod:3222
24924 #: ../fish/guestfish-actions.pod:3224
24927 " mount-ro device mountpoint\n"
24932 #: ../fish/guestfish-actions.pod:3226
24934 "This is the same as the L</mount> command, but it mounts the filesystem with "
24935 "the read-only (I<-o ro>) flag."
24939 #: ../fish/guestfish-actions.pod:3229
24944 #: ../fish/guestfish-actions.pod:3231
24947 " mount-vfs options vfstype device mountpoint\n"
24952 #: ../fish/guestfish-actions.pod:3233
24954 "This is the same as the L</mount> command, but it allows you to set both the "
24955 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
24959 #: ../fish/guestfish-actions.pod:3237
24960 msgid "mountpoints"
24964 #: ../fish/guestfish-actions.pod:3239
24972 #: ../fish/guestfish-actions.pod:3241
24974 "This call is similar to L</mounts>. That call returns a list of devices. "
24975 "This one returns a hash table (map) of device name to directory where the "
24976 "device is mounted."
24980 #: ../fish/guestfish-actions.pod:3245
24985 #: ../fish/guestfish-actions.pod:3247
24993 #: ../fish/guestfish-actions.pod:3254
24994 msgid "See also: L</mountpoints>"
24998 #: ../fish/guestfish-actions.pod:3256
25003 #: ../fish/guestfish-actions.pod:3258
25011 #: ../fish/guestfish-actions.pod:3263
25012 msgid "ntfs-3g-probe"
25016 #: ../fish/guestfish-actions.pod:3265
25019 " ntfs-3g-probe true|false device\n"
25024 #: ../fish/guestfish-actions.pod:3279
25029 #: ../fish/guestfish-actions.pod:3281
25032 " ntfsresize device\n"
25037 #: ../fish/guestfish-actions.pod:3287
25038 msgid "ntfsresize-size"
25042 #: ../fish/guestfish-actions.pod:3289
25045 " ntfsresize-size device size\n"
25050 #: ../fish/guestfish-actions.pod:3291
25052 "This command is the same as L</ntfsresize> except that it allows you to "
25053 "specify the new size (in bytes) explicitly."
25057 #: ../fish/guestfish-actions.pod:3294
25062 #: ../fish/guestfish-actions.pod:3296
25065 " part-add device prlogex startsect endsect\n"
25070 #: ../fish/guestfish-actions.pod:3298
25072 "This command adds a partition to C<device>. If there is no partition table "
25073 "on the device, call L</part-init> first."
25077 #: ../fish/guestfish-actions.pod:3310
25079 "Creating a partition which covers the whole disk is not so easy. Use "
25080 "L</part-disk> to do that."
25084 #: ../fish/guestfish-actions.pod:3313
25089 #: ../fish/guestfish-actions.pod:3315
25092 " part-del device partnum\n"
25097 #: ../fish/guestfish-actions.pod:3323
25102 #: ../fish/guestfish-actions.pod:3325
25105 " part-disk device parttype\n"
25110 #: ../fish/guestfish-actions.pod:3327
25112 "This command is simply a combination of L</part-init> followed by "
25113 "L</part-add> to create a single primary partition covering the whole disk."
25117 #: ../fish/guestfish-actions.pod:3331
25119 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25120 "possible values are described in L</part-init>."
25124 #: ../fish/guestfish-actions.pod:3337
25125 msgid "part-get-bootable"
25129 #: ../fish/guestfish-actions.pod:3339
25132 " part-get-bootable device partnum\n"
25137 #: ../fish/guestfish-actions.pod:3344
25138 msgid "See also L</part-set-bootable>."
25142 #: ../fish/guestfish-actions.pod:3346
25143 msgid "part-get-mbr-id"
25147 #: ../fish/guestfish-actions.pod:3348
25150 " part-get-mbr-id device partnum\n"
25155 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3491
25157 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25158 "undefined results for other partition table types (see "
25159 "L</part-get-parttype>)."
25163 #: ../fish/guestfish-actions.pod:3357
25164 msgid "part-get-parttype"
25168 #: ../fish/guestfish-actions.pod:3359
25171 " part-get-parttype device\n"
25176 #: ../fish/guestfish-actions.pod:3364
25178 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25179 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25180 "possible, although unusual. See L</part-init> for a full list."
25184 #: ../fish/guestfish-actions.pod:3369
25189 #: ../fish/guestfish-actions.pod:3371
25192 " part-init device parttype\n"
25197 #: ../fish/guestfish-actions.pod:3377
25199 "Initially there are no partitions. Following this, you should call "
25200 "L</part-add> for each partition required."
25204 #: ../fish/guestfish-actions.pod:3440
25209 #: ../fish/guestfish-actions.pod:3442
25212 " part-list device\n"
25217 #: ../fish/guestfish-actions.pod:3457
25219 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25220 "the device's sector size, see L</blockdev-getss>."
25224 #: ../fish/guestfish-actions.pod:3470
25225 msgid "part-set-bootable"
25229 #: ../fish/guestfish-actions.pod:3472
25232 " part-set-bootable device partnum true|false\n"
25237 #: ../fish/guestfish-actions.pod:3481
25238 msgid "part-set-mbr-id"
25242 #: ../fish/guestfish-actions.pod:3483
25245 " part-set-mbr-id device partnum idbyte\n"
25250 #: ../fish/guestfish-actions.pod:3495
25251 msgid "part-set-name"
25255 #: ../fish/guestfish-actions.pod:3497
25258 " part-set-name device partnum name\n"
25263 #: ../fish/guestfish-actions.pod:3505
25264 msgid "part-to-dev"
25268 #: ../fish/guestfish-actions.pod:3507
25271 " part-to-dev partition\n"
25276 #: ../fish/guestfish-actions.pod:3513
25278 "The named partition must exist, for example as a string returned from "
25279 "L</list-partitions>."
25283 #: ../fish/guestfish-actions.pod:3516
25284 msgid "ping-daemon"
25288 #: ../fish/guestfish-actions.pod:3518
25296 #: ../fish/guestfish-actions.pod:3525
25301 #: ../fish/guestfish-actions.pod:3527
25304 " pread path count offset\n"
25309 #: ../fish/guestfish-actions.pod:3535
25310 msgid "See also L</pwrite>, L</pread-device>."
25314 #: ../fish/guestfish-actions.pod:3540
25315 msgid "pread-device"
25319 #: ../fish/guestfish-actions.pod:3542
25322 " pread-device device count offset\n"
25327 #: ../fish/guestfish-actions.pod:3550
25328 msgid "See also L</pread>."
25332 #: ../fish/guestfish-actions.pod:3555
25337 #: ../fish/guestfish-actions.pod:3557
25340 " pvcreate device\n"
25345 #: ../fish/guestfish-actions.pod:3563
25350 #: ../fish/guestfish-actions.pod:3565
25353 " pvremove device\n"
25358 #: ../fish/guestfish-actions.pod:3574
25363 #: ../fish/guestfish-actions.pod:3576
25366 " pvresize device\n"
25371 #: ../fish/guestfish-actions.pod:3581
25372 msgid "pvresize-size"
25376 #: ../fish/guestfish-actions.pod:3583
25379 " pvresize-size device size\n"
25384 #: ../fish/guestfish-actions.pod:3585
25386 "This command is the same as L</pvresize> except that it allows you to "
25387 "specify the new size (in bytes) explicitly."
25391 #: ../fish/guestfish-actions.pod:3588
25396 #: ../fish/guestfish-actions.pod:3590
25404 #: ../fish/guestfish-actions.pod:3598
25405 msgid "See also L</pvs-full>."
25409 #: ../fish/guestfish-actions.pod:3600
25414 #: ../fish/guestfish-actions.pod:3602
25422 #: ../fish/guestfish-actions.pod:3607
25427 #: ../fish/guestfish-actions.pod:3609
25435 #: ../fish/guestfish-actions.pod:3613
25440 #: ../fish/guestfish-actions.pod:3615
25443 " pwrite path content offset\n"
25448 #: ../fish/guestfish-actions.pod:3626
25449 msgid "See also L</pread>, L</pwrite-device>."
25453 #: ../fish/guestfish-actions.pod:3631
25454 msgid "pwrite-device"
25458 #: ../fish/guestfish-actions.pod:3633
25461 " pwrite-device device content offset\n"
25466 #: ../fish/guestfish-actions.pod:3643
25467 msgid "See also L</pwrite>."
25471 #: ../fish/guestfish-actions.pod:3648
25476 #: ../fish/guestfish-actions.pod:3650
25479 " read-file path\n"
25484 #: ../fish/guestfish-actions.pod:3655
25486 "Unlike L</cat>, this function can correctly handle files that contain "
25487 "embedded ASCII NUL characters. However unlike L</download>, this function "
25488 "is limited in the total size of file that can be handled."
25492 #: ../fish/guestfish-actions.pod:3663
25497 #: ../fish/guestfish-actions.pod:3665
25500 " read-lines path\n"
25505 #: ../fish/guestfish-actions.pod:3672
25507 "Note that this function cannot correctly handle binary files (specifically, "
25508 "files containing C<\\0> character which is treated as end of line). For "
25509 "those you need to use the L</read-file> function which has a more complex "
25514 #: ../fish/guestfish-actions.pod:3677
25519 #: ../fish/guestfish-actions.pod:3679
25527 #: ../fish/guestfish-actions.pod:3731
25529 "This function is primarily intended for use by programs. To get a simple "
25530 "list of names, use L</ls>. To get a printable directory for human "
25531 "consumption, use L</ll>."
25535 #: ../fish/guestfish-actions.pod:3735
25540 #: ../fish/guestfish-actions.pod:3737
25548 #: ../fish/guestfish-actions.pod:3741
25549 msgid "readlinklist"
25553 #: ../fish/guestfish-actions.pod:3743
25556 " readlinklist path 'names ...'\n"
25561 #: ../fish/guestfish-actions.pod:3767
25566 #: ../fish/guestfish-actions.pod:3769
25574 #: ../fish/guestfish-actions.pod:3774
25575 msgid "removexattr"
25579 #: ../fish/guestfish-actions.pod:3776
25582 " removexattr xattr path\n"
25587 #: ../fish/guestfish-actions.pod:3781
25588 msgid "See also: L</lremovexattr>, L<attr(5)>."
25592 #: ../fish/guestfish-actions.pod:3783
25597 #: ../fish/guestfish-actions.pod:3785
25600 " resize2fs device\n"
25605 #: ../fish/guestfish-actions.pod:3790
25607 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25608 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25609 "gives an error about this and sometimes not. In any case, it is always safe "
25610 "to call L</e2fsck-f> before calling this function."
25614 #: ../fish/guestfish-actions.pod:3796
25615 msgid "resize2fs-M"
25619 #: ../fish/guestfish-actions.pod:3798
25622 " resize2fs-M device\n"
25627 #: ../fish/guestfish-actions.pod:3800
25629 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25630 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
25635 #: ../fish/guestfish-actions.pod:3804
25637 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25638 "and read the C<Block size> and C<Block count> values. These two numbers, "
25639 "multiplied together, give the resulting size of the minimal filesystem in "
25644 #: ../fish/guestfish-actions.pod:3809
25645 msgid "resize2fs-size"
25649 #: ../fish/guestfish-actions.pod:3811
25652 " resize2fs-size device size\n"
25657 #: ../fish/guestfish-actions.pod:3813
25659 "This command is the same as L</resize2fs> except that it allows you to "
25660 "specify the new size (in bytes) explicitly."
25664 #: ../fish/guestfish-actions.pod:3816
25669 #: ../fish/guestfish-actions.pod:3818
25677 #: ../fish/guestfish-actions.pod:3822
25682 #: ../fish/guestfish-actions.pod:3824
25690 #: ../fish/guestfish-actions.pod:3830
25695 #: ../fish/guestfish-actions.pod:3832
25703 #: ../fish/guestfish-actions.pod:3836
25704 msgid "rmmountpoint"
25708 #: ../fish/guestfish-actions.pod:3838
25711 " rmmountpoint exemptpath\n"
25716 #: ../fish/guestfish-actions.pod:3840
25718 "This calls removes a mountpoint that was previously created with "
25719 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25723 #: ../fish/guestfish-actions.pod:3844
25724 msgid "scrub-device"
25728 #: ../fish/guestfish-actions.pod:3846
25731 " scrub-device device\n"
25736 #: ../fish/guestfish-actions.pod:3857
25741 #: ../fish/guestfish-actions.pod:3859
25744 " scrub-file file\n"
25749 #: ../fish/guestfish-actions.pod:3869
25750 msgid "scrub-freespace"
25754 #: ../fish/guestfish-actions.pod:3871
25757 " scrub-freespace dir\n"
25762 #: ../fish/guestfish-actions.pod:3873
25764 "This command creates the directory C<dir> and then fills it with files until "
25765 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25766 "deletes them. The intention is to scrub any free space on the partition "
25767 "containing C<dir>."
25771 #: ../fish/guestfish-actions.pod:3882
25776 #: ../fish/guestfish-actions.pod:3884
25781 #: ../fish/guestfish-actions.pod:3886
25784 " set-append append\n"
25789 #: ../fish/guestfish-actions.pod:3897
25790 msgid "set-attach-method"
25794 #: ../fish/guestfish-actions.pod:3899
25795 msgid "attach-method"
25799 #: ../fish/guestfish-actions.pod:3901
25802 " set-attach-method attachmethod\n"
25807 #: ../fish/guestfish-actions.pod:3923
25808 msgid "set-autosync"
25812 #: ../fish/guestfish-actions.pod:3925
25817 #: ../fish/guestfish-actions.pod:3927
25820 " set-autosync true|false\n"
25825 #: ../fish/guestfish-actions.pod:3937
25830 #: ../fish/guestfish-actions.pod:3939
25835 #: ../fish/guestfish-actions.pod:3941
25838 " set-direct true|false\n"
25843 #: ../fish/guestfish-actions.pod:3947
25845 "One consequence of this is that log messages aren't caught by the library "
25846 "and handled by L</set-log-message-callback>, but go straight to stdout."
25850 #: ../fish/guestfish-actions.pod:3956
25851 msgid "set-e2label"
25855 #: ../fish/guestfish-actions.pod:3958
25858 " set-e2label device label\n"
25863 #: ../fish/guestfish-actions.pod:3964
25865 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25866 "label on a filesystem."
25870 #: ../fish/guestfish-actions.pod:3967
25875 #: ../fish/guestfish-actions.pod:3969
25878 " set-e2uuid device uuid\n"
25883 #: ../fish/guestfish-actions.pod:3976
25885 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25886 "UUID of a filesystem."
25890 #: ../fish/guestfish-actions.pod:3979
25891 msgid "set-memsize"
25895 #: ../fish/guestfish-actions.pod:3981
25900 #: ../fish/guestfish-actions.pod:3983
25903 " set-memsize memsize\n"
25908 #: ../fish/guestfish-actions.pod:3985
25910 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25911 "This only has any effect if called before L</launch>."
25915 #: ../fish/guestfish-actions.pod:3996
25916 msgid "set-network"
25920 #: ../fish/guestfish-actions.pod:3998
25925 #: ../fish/guestfish-actions.pod:4000
25928 " set-network true|false\n"
25933 #: ../fish/guestfish-actions.pod:4008
25934 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25938 #: ../fish/guestfish-actions.pod:4011
25943 #: ../fish/guestfish-actions.pod:4013
25948 #: ../fish/guestfish-actions.pod:4015
25951 " set-path searchpath\n"
25956 #: ../fish/guestfish-actions.pod:4024
25961 #: ../fish/guestfish-actions.pod:4026
25966 #: ../fish/guestfish-actions.pod:4028
25974 #: ../fish/guestfish-actions.pod:4048
25975 msgid "set-recovery-proc"
25979 #: ../fish/guestfish-actions.pod:4050
25980 msgid "recovery-proc"
25984 #: ../fish/guestfish-actions.pod:4052
25987 " set-recovery-proc true|false\n"
25992 #: ../fish/guestfish-actions.pod:4054
25994 "If this is called with the parameter C<false> then L</launch> does not "
25995 "create a recovery process. The purpose of the recovery process is to stop "
25996 "runaway qemu processes in the case where the main program aborts abruptly."
26000 #: ../fish/guestfish-actions.pod:4059
26002 "This only has any effect if called before L</launch>, and the default is "
26007 #: ../fish/guestfish-actions.pod:4068
26008 msgid "set-selinux"
26012 #: ../fish/guestfish-actions.pod:4070
26017 #: ../fish/guestfish-actions.pod:4072
26020 " set-selinux true|false\n"
26025 #: ../fish/guestfish-actions.pod:4083
26030 #: ../fish/guestfish-actions.pod:4085
26035 #: ../fish/guestfish-actions.pod:4087
26038 " set-trace true|false\n"
26043 #: ../fish/guestfish-actions.pod:4099
26045 "Trace messages are normally sent to C<stderr>, unless you register a "
26046 "callback to send them somewhere else (see L</set-event-callback>)."
26050 #: ../fish/guestfish-actions.pod:4103
26051 msgid "set-verbose"
26055 #: ../fish/guestfish-actions.pod:4105
26060 #: ../fish/guestfish-actions.pod:4107
26063 " set-verbose true|false\n"
26068 #: ../fish/guestfish-actions.pod:4114
26070 "Verbose messages are normally sent to C<stderr>, unless you register a "
26071 "callback to send them somewhere else (see L</set-event-callback>)."
26075 #: ../fish/guestfish-actions.pod:4118
26080 #: ../fish/guestfish-actions.pod:4120
26083 " setcon context\n"
26088 #: ../fish/guestfish-actions.pod:4127
26093 #: ../fish/guestfish-actions.pod:4129
26096 " setxattr xattr val vallen path\n"
26101 #: ../fish/guestfish-actions.pod:4135
26102 msgid "See also: L</lsetxattr>, L<attr(5)>."
26106 #: ../fish/guestfish-actions.pod:4137
26111 #: ../fish/guestfish-actions.pod:4139
26114 " sfdisk device cyls heads sectors 'lines ...'\n"
26119 #: ../fish/guestfish-actions.pod:4161
26120 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26124 #: ../fish/guestfish-actions.pod:4167
26129 #: ../fish/guestfish-actions.pod:4169
26132 " sfdiskM device 'lines ...'\n"
26137 #: ../fish/guestfish-actions.pod:4171
26139 "This is a simplified interface to the L</sfdisk> command, where partition "
26140 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26141 "you don't need to specify the cyls, heads and sectors parameters which were "
26142 "rarely if ever used anyway."
26146 #: ../fish/guestfish-actions.pod:4177
26147 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26151 #: ../fish/guestfish-actions.pod:4183
26156 #: ../fish/guestfish-actions.pod:4185
26159 " sfdisk-N device partnum cyls heads sectors line\n"
26164 #: ../fish/guestfish-actions.pod:4190
26166 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26167 "cyls/heads/sectors parameters."
26171 #: ../fish/guestfish-actions.pod:4193
26172 msgid "See also: L</part-add>"
26176 #: ../fish/guestfish-actions.pod:4198
26177 msgid "sfdisk-disk-geometry"
26181 #: ../fish/guestfish-actions.pod:4200
26184 " sfdisk-disk-geometry device\n"
26189 #: ../fish/guestfish-actions.pod:4202
26191 "This displays the disk geometry of C<device> read from the partition table. "
26192 "Especially in the case where the underlying block device has been resized, "
26193 "this can be different from the kernel's idea of the geometry (see "
26194 "L</sfdisk-kernel-geometry>)."
26198 #: ../fish/guestfish-actions.pod:4210
26199 msgid "sfdisk-kernel-geometry"
26203 #: ../fish/guestfish-actions.pod:4212
26206 " sfdisk-kernel-geometry device\n"
26211 #: ../fish/guestfish-actions.pod:4219
26216 #: ../fish/guestfish-actions.pod:4221
26219 " sfdisk-l device\n"
26224 #: ../fish/guestfish-actions.pod:4227
26225 msgid "See also: L</part-list>"
26229 #: ../fish/guestfish-actions.pod:4229
26234 #: ../fish/guestfish-actions.pod:4231
26242 #: ../fish/guestfish-actions.pod:4236
26243 msgid "This is like L</command>, but passes the command to:"
26247 #: ../fish/guestfish-actions.pod:4244
26248 msgid "All the provisos about L</command> apply to this call."
26252 #: ../fish/guestfish-actions.pod:4246
26257 #: ../fish/guestfish-actions.pod:4248
26260 " sh-lines command\n"
26265 #: ../fish/guestfish-actions.pod:4250
26266 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26270 #: ../fish/guestfish-actions.pod:4253
26271 msgid "See also: L</command-lines>"
26275 #: ../fish/guestfish-actions.pod:4255
26280 #: ../fish/guestfish-actions.pod:4257
26288 #: ../fish/guestfish-actions.pod:4261
26293 #: ../fish/guestfish-actions.pod:4263
26301 #: ../fish/guestfish-actions.pod:4269
26306 #: ../fish/guestfish-actions.pod:4271
26314 #: ../fish/guestfish-actions.pod:4279
26319 #: ../fish/guestfish-actions.pod:4281
26327 #: ../fish/guestfish-actions.pod:4289
26332 #: ../fish/guestfish-actions.pod:4291
26335 " strings-e encoding path\n"
26340 #: ../fish/guestfish-actions.pod:4293
26342 "This is like the L</strings> command, but allows you to specify the encoding "
26343 "of strings that are looked for in the source file C<path>."
26347 #: ../fish/guestfish-actions.pod:4303
26349 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26350 "ISO-8859-X (this is what L</strings> uses)."
26354 #: ../fish/guestfish-actions.pod:4335
26355 msgid "swapoff-device"
26359 #: ../fish/guestfish-actions.pod:4337
26362 " swapoff-device device\n"
26367 #: ../fish/guestfish-actions.pod:4339
26369 "This command disables the libguestfs appliance swap device or partition "
26370 "named C<device>. See L</swapon-device>."
26374 #: ../fish/guestfish-actions.pod:4343
26375 msgid "swapoff-file"
26379 #: ../fish/guestfish-actions.pod:4345
26382 " swapoff-file file\n"
26387 #: ../fish/guestfish-actions.pod:4349
26388 msgid "swapoff-label"
26392 #: ../fish/guestfish-actions.pod:4351
26395 " swapoff-label label\n"
26400 #: ../fish/guestfish-actions.pod:4356
26401 msgid "swapoff-uuid"
26405 #: ../fish/guestfish-actions.pod:4358
26408 " swapoff-uuid uuid\n"
26413 #: ../fish/guestfish-actions.pod:4363
26414 msgid "swapon-device"
26418 #: ../fish/guestfish-actions.pod:4365
26421 " swapon-device device\n"
26426 #: ../fish/guestfish-actions.pod:4367
26428 "This command enables the libguestfs appliance to use the swap device or "
26429 "partition named C<device>. The increased memory is made available for all "
26430 "commands, for example those run using L</command> or L</sh>."
26434 #: ../fish/guestfish-actions.pod:4379
26435 msgid "swapon-file"
26439 #: ../fish/guestfish-actions.pod:4381
26442 " swapon-file file\n"
26447 #: ../fish/guestfish-actions.pod:4383
26448 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26452 #: ../fish/guestfish-actions.pod:4386
26453 msgid "swapon-label"
26457 #: ../fish/guestfish-actions.pod:4388
26460 " swapon-label label\n"
26465 #: ../fish/guestfish-actions.pod:4390
26467 "This command enables swap to a labeled swap partition. See "
26468 "L</swapon-device> for other notes."
26472 #: ../fish/guestfish-actions.pod:4393
26473 msgid "swapon-uuid"
26477 #: ../fish/guestfish-actions.pod:4395
26480 " swapon-uuid uuid\n"
26485 #: ../fish/guestfish-actions.pod:4397
26487 "This command enables swap to a swap partition with the given UUID. See "
26488 "L</swapon-device> for other notes."
26492 #: ../fish/guestfish-actions.pod:4400
26497 #: ../fish/guestfish-actions.pod:4402
26505 #: ../fish/guestfish-actions.pod:4410
26510 #: ../fish/guestfish-actions.pod:4412
26518 #: ../fish/guestfish-actions.pod:4420
26523 #: ../fish/guestfish-actions.pod:4422
26526 " tail-n nrlines path\n"
26531 #: ../fish/guestfish-actions.pod:4435
26536 #: ../fish/guestfish-actions.pod:4437
26539 " tar-in (tarfile|-) directory\n"
26544 #: ../fish/guestfish-actions.pod:4442
26545 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26549 #: ../fish/guestfish-actions.pod:4447
26554 #: ../fish/guestfish-actions.pod:4449
26557 " tar-out directory (tarfile|-)\n"
26562 #: ../fish/guestfish-actions.pod:4454
26563 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26567 #: ../fish/guestfish-actions.pod:4459
26572 #: ../fish/guestfish-actions.pod:4461
26575 " tgz-in (tarball|-) directory\n"
26580 #: ../fish/guestfish-actions.pod:4466
26581 msgid "To upload an uncompressed tarball, use L</tar-in>."
26585 #: ../fish/guestfish-actions.pod:4470
26590 #: ../fish/guestfish-actions.pod:4472
26593 " tgz-out directory (tarball|-)\n"
26598 #: ../fish/guestfish-actions.pod:4477
26599 msgid "To download an uncompressed tarball, use L</tar-out>."
26603 #: ../fish/guestfish-actions.pod:4481
26608 #: ../fish/guestfish-actions.pod:4483
26616 #: ../fish/guestfish-actions.pod:4492
26621 #: ../fish/guestfish-actions.pod:4494
26629 #: ../fish/guestfish-actions.pod:4499
26630 msgid "truncate-size"
26634 #: ../fish/guestfish-actions.pod:4501
26637 " truncate-size path size\n"
26642 #: ../fish/guestfish-actions.pod:4506
26644 "If the current file size is less than C<size> then the file is extended to "
26645 "the required size with zero bytes. This creates a sparse file (ie. disk "
26646 "blocks are not allocated for the file until you write to it). To create a "
26647 "non-sparse file of zeroes, use L</fallocate64> instead."
26651 #: ../fish/guestfish-actions.pod:4512
26656 #: ../fish/guestfish-actions.pod:4514
26659 " tune2fs-l device\n"
26664 #: ../fish/guestfish-actions.pod:4524
26669 #: ../fish/guestfish-actions.pod:4526
26672 " txz-in (tarball|-) directory\n"
26677 #: ../fish/guestfish-actions.pod:4533
26682 #: ../fish/guestfish-actions.pod:4535
26685 " txz-out directory (tarball|-)\n"
26690 #: ../fish/guestfish-actions.pod:4542
26695 #: ../fish/guestfish-actions.pod:4544
26703 #: ../fish/guestfish-actions.pod:4558
26704 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26708 #: ../fish/guestfish-actions.pod:4563
26713 #: ../fish/guestfish-actions.pod:4565
26718 #: ../fish/guestfish-actions.pod:4567
26721 " umount pathordevice\n"
26726 #: ../fish/guestfish-actions.pod:4573
26731 #: ../fish/guestfish-actions.pod:4575
26732 msgid "unmount-all"
26736 #: ../fish/guestfish-actions.pod:4577
26744 #: ../fish/guestfish-actions.pod:4583
26749 #: ../fish/guestfish-actions.pod:4585
26752 " upload (filename|-) remotefilename\n"
26757 #: ../fish/guestfish-actions.pod:4592
26758 msgid "See also L</download>."
26762 #: ../fish/guestfish-actions.pod:4596
26763 msgid "upload-offset"
26767 #: ../fish/guestfish-actions.pod:4598
26770 " upload-offset (filename|-) remotefilename offset\n"
26775 #: ../fish/guestfish-actions.pod:4610
26777 "Note that there is no limit on the amount of data that can be uploaded with "
26778 "this call, unlike with L</pwrite>, and this call always writes the full "
26779 "amount unless an error occurs."
26783 #: ../fish/guestfish-actions.pod:4615
26784 msgid "See also L</upload>, L</pwrite>."
26788 #: ../fish/guestfish-actions.pod:4619
26793 #: ../fish/guestfish-actions.pod:4621
26796 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26801 #: ../fish/guestfish-actions.pod:4640
26806 #: ../fish/guestfish-actions.pod:4642
26814 #: ../fish/guestfish-actions.pod:4669
26816 "I<Note:> Don't use this call to test for availability of features. In "
26817 "enterprise distributions we backport features from later versions into "
26818 "earlier versions, making this an unreliable way to test for features. Use "
26819 "L</available> instead."
26823 #: ../fish/guestfish-actions.pod:4675
26828 #: ../fish/guestfish-actions.pod:4677
26831 " vfs-label device\n"
26836 #: ../fish/guestfish-actions.pod:4684
26837 msgid "To find a filesystem from the label, use L</findfs-label>."
26841 #: ../fish/guestfish-actions.pod:4686
26846 #: ../fish/guestfish-actions.pod:4688
26849 " vfs-type device\n"
26854 #: ../fish/guestfish-actions.pod:4698
26859 #: ../fish/guestfish-actions.pod:4700
26862 " vfs-uuid device\n"
26867 #: ../fish/guestfish-actions.pod:4707
26868 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26872 #: ../fish/guestfish-actions.pod:4709
26873 msgid "vg-activate"
26877 #: ../fish/guestfish-actions.pod:4711
26880 " vg-activate true|false 'volgroups ...'\n"
26885 #: ../fish/guestfish-actions.pod:4724
26886 msgid "vg-activate-all"
26890 #: ../fish/guestfish-actions.pod:4726
26893 " vg-activate-all true|false\n"
26898 #: ../fish/guestfish-actions.pod:4736
26903 #: ../fish/guestfish-actions.pod:4738
26906 " vgcreate volgroup 'physvols ...'\n"
26911 #: ../fish/guestfish-actions.pod:4743
26916 #: ../fish/guestfish-actions.pod:4745
26919 " vglvuuids vgname\n"
26924 #: ../fish/guestfish-actions.pod:4750
26926 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26927 "logical volumes and volume groups."
26931 #: ../fish/guestfish-actions.pod:4753
26932 msgid "See also L</vgpvuuids>."
26936 #: ../fish/guestfish-actions.pod:4755
26941 #: ../fish/guestfish-actions.pod:4757
26944 " vgpvuuids vgname\n"
26949 #: ../fish/guestfish-actions.pod:4762
26951 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
26952 "physical volumes and volume groups."
26956 #: ../fish/guestfish-actions.pod:4765
26957 msgid "See also L</vglvuuids>."
26961 #: ../fish/guestfish-actions.pod:4767
26966 #: ../fish/guestfish-actions.pod:4769
26969 " vgremove vgname\n"
26974 #: ../fish/guestfish-actions.pod:4776
26979 #: ../fish/guestfish-actions.pod:4778
26982 " vgrename volgroup newvolgroup\n"
26987 #: ../fish/guestfish-actions.pod:4782
26992 #: ../fish/guestfish-actions.pod:4784
27000 #: ../fish/guestfish-actions.pod:4792
27001 msgid "See also L</vgs-full>."
27005 #: ../fish/guestfish-actions.pod:4794
27010 #: ../fish/guestfish-actions.pod:4796
27018 #: ../fish/guestfish-actions.pod:4801
27023 #: ../fish/guestfish-actions.pod:4803
27031 #: ../fish/guestfish-actions.pod:4808
27036 #: ../fish/guestfish-actions.pod:4810
27044 #: ../fish/guestfish-actions.pod:4814
27049 #: ../fish/guestfish-actions.pod:4816
27057 #: ../fish/guestfish-actions.pod:4821
27062 #: ../fish/guestfish-actions.pod:4823
27070 #: ../fish/guestfish-actions.pod:4828
27075 #: ../fish/guestfish-actions.pod:4830
27083 #: ../fish/guestfish-actions.pod:4835
27088 #: ../fish/guestfish-actions.pod:4837
27091 " write path content\n"
27096 #: ../fish/guestfish-actions.pod:4845
27101 #: ../fish/guestfish-actions.pod:4847
27104 " write-file path content size\n"
27109 #: ../fish/guestfish-actions.pod:4870
27114 #: ../fish/guestfish-actions.pod:4872
27117 " zegrep regex path\n"
27122 #: ../fish/guestfish-actions.pod:4880
27127 #: ../fish/guestfish-actions.pod:4882
27130 " zegrepi regex path\n"
27135 #: ../fish/guestfish-actions.pod:4890
27140 #: ../fish/guestfish-actions.pod:4892
27148 #: ../fish/guestfish-actions.pod:4900
27149 msgid "See also: L</zero-device>, L</scrub-device>."
27153 #: ../fish/guestfish-actions.pod:4902
27154 msgid "zero-device"
27158 #: ../fish/guestfish-actions.pod:4904
27161 " zero-device device\n"
27166 #: ../fish/guestfish-actions.pod:4906
27168 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27169 "which just zeroes the first few blocks of a device."
27173 #: ../fish/guestfish-actions.pod:4913
27178 #: ../fish/guestfish-actions.pod:4915
27181 " zerofree device\n"
27186 #: ../fish/guestfish-actions.pod:4928
27191 #: ../fish/guestfish-actions.pod:4930
27194 " zfgrep pattern path\n"
27199 #: ../fish/guestfish-actions.pod:4938
27204 #: ../fish/guestfish-actions.pod:4940
27207 " zfgrepi pattern path\n"
27212 #: ../fish/guestfish-actions.pod:4948
27217 #: ../fish/guestfish-actions.pod:4950
27220 " zfile meth path\n"
27225 #: ../fish/guestfish-actions.pod:4957
27226 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27230 #: ../fish/guestfish-actions.pod:4967
27235 #: ../fish/guestfish-actions.pod:4969
27238 " zgrep regex path\n"
27243 #: ../fish/guestfish-actions.pod:4977
27248 #: ../fish/guestfish-actions.pod:4979
27251 " zgrepi regex path\n"
27256 #: ../fish/guestfish-commands.pod:1
27261 #: ../fish/guestfish-commands.pod:3
27266 #: ../fish/guestfish-commands.pod:5
27269 " alloc filename size\n"
27274 #: ../fish/guestfish-commands.pod:7
27276 "This creates an empty (zeroed) file of the given size, and then adds so it "
27277 "can be further examined."
27281 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27282 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27286 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27287 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27291 #: ../fish/guestfish-commands.pod:14
27293 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27294 "image, see L</PREPARED DISK IMAGES>."
27298 #: ../fish/guestfish-commands.pod:17
27303 #: ../fish/guestfish-commands.pod:19
27306 " copy-in local [local ...] /remotedir\n"
27311 #: ../fish/guestfish-commands.pod:21
27313 "C<copy-in> copies local files or directories recursively into the disk "
27314 "image, placing them in the directory called C</remotedir> (which must "
27315 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27316 "other commands as necessary."
27320 #: ../fish/guestfish-commands.pod:26
27322 "Multiple local files and directories can be specified, but the last "
27323 "parameter must always be a remote directory. Wildcards cannot be used."
27327 #: ../fish/guestfish-commands.pod:30
27332 #: ../fish/guestfish-commands.pod:32
27335 " copy-out remote [remote ...] localdir\n"
27340 #: ../fish/guestfish-commands.pod:34
27342 "C<copy-out> copies remote files or directories recursively out of the disk "
27343 "image, placing them on the host disk in a local directory called C<localdir> "
27344 "(which must exist). This guestfish meta-command turns into a sequence of "
27345 "L</download>, L</tar-out> and other commands as necessary."
27349 #: ../fish/guestfish-commands.pod:40
27351 "Multiple remote files and directories can be specified, but the last "
27352 "parameter must always be a local directory. To download to the current "
27353 "directory, use C<.> as in:"
27357 #: ../fish/guestfish-commands.pod:44
27360 " copy-out /home .\n"
27365 #: ../fish/guestfish-commands.pod:46
27367 "Wildcards cannot be used in the ordinary command, but you can use them with "
27368 "the help of L</glob> like this:"
27372 #: ../fish/guestfish-commands.pod:49
27375 " glob copy-out /home/* .\n"
27380 #: ../fish/guestfish-commands.pod:51
27385 #: ../fish/guestfish-commands.pod:53
27388 " echo [params ...]\n"
27393 #: ../fish/guestfish-commands.pod:55
27394 msgid "This echos the parameters to the terminal."
27398 #: ../fish/guestfish-commands.pod:57
27403 #: ../fish/guestfish-commands.pod:59
27408 #: ../fish/guestfish-commands.pod:61
27413 #: ../fish/guestfish-commands.pod:63
27421 #: ../fish/guestfish-commands.pod:65
27423 "This is used to edit a file. It downloads the file, edits it locally using "
27424 "your editor, then uploads the result."
27428 #: ../fish/guestfish-commands.pod:68
27430 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27431 "or C<emacs> you will get those corresponding editors."
27435 #: ../fish/guestfish-commands.pod:72
27440 #: ../fish/guestfish-commands.pod:74
27443 " glob command args...\n"
27448 #: ../fish/guestfish-commands.pod:76
27450 "Expand wildcards in any paths in the args list, and run C<command> "
27451 "repeatedly on each matching path."
27455 #: ../fish/guestfish-commands.pod:79
27456 msgid "See L</WILDCARDS AND GLOBBING>."
27460 #: ../fish/guestfish-commands.pod:81
27465 #: ../fish/guestfish-commands.pod:83
27468 " hexedit <filename|device>\n"
27469 " hexedit <filename|device> <max>\n"
27470 " hexedit <filename|device> <start> <max>\n"
27475 #: ../fish/guestfish-commands.pod:87
27477 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27482 #: ../fish/guestfish-commands.pod:90
27484 "This command works by downloading potentially the whole file or device, "
27485 "editing it locally, then uploading it. If the file or device is large, you "
27486 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27487 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27488 "usual modifiers allowed such as C<1M> (1 megabyte)."
27492 #: ../fish/guestfish-commands.pod:97
27493 msgid "For example to edit the first few sectors of a disk you might do:"
27497 #: ../fish/guestfish-commands.pod:100
27500 " hexedit /dev/sda 1M\n"
27505 #: ../fish/guestfish-commands.pod:102
27507 "which would allow you to edit anywhere within the first megabyte of the "
27512 #: ../fish/guestfish-commands.pod:105
27513 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27517 #: ../fish/guestfish-commands.pod:107
27520 " hexedit /dev/sda1 0x400 0x400\n"
27525 #: ../fish/guestfish-commands.pod:109
27526 msgid "(assuming the superblock is in the standard location)."
27530 #: ../fish/guestfish-commands.pod:111
27532 "This command requires the external L<hexedit(1)> program. You can specify "
27533 "another program to use by setting the C<HEXEDITOR> environment variable."
27537 #: ../fish/guestfish-commands.pod:115
27538 msgid "See also L</hexdump>."
27542 #: ../fish/guestfish-commands.pod:117
27547 #: ../fish/guestfish-commands.pod:119
27555 #: ../fish/guestfish-commands.pod:121
27556 msgid "Change the local directory, ie. the current directory of guestfish itself."
27560 #: ../fish/guestfish-commands.pod:124
27561 msgid "Note that C<!cd> won't do what you might expect."
27565 #: ../fish/guestfish-commands.pod:126
27570 #: ../fish/guestfish-commands.pod:128
27575 #: ../fish/guestfish-commands.pod:130
27583 #: ../fish/guestfish-commands.pod:132
27584 msgid "Opens the manual page for guestfish."
27588 #: ../fish/guestfish-commands.pod:134
27593 #: ../fish/guestfish-commands.pod:136
27598 #: ../fish/guestfish-commands.pod:138
27606 #: ../fish/guestfish-commands.pod:140
27614 #: ../fish/guestfish-commands.pod:142
27615 msgid "This is used to view a file."
27619 #: ../fish/guestfish-commands.pod:144
27621 "The default viewer is C<$PAGER>. However if you use the alternate command "
27622 "C<less> you will get the C<less> command specifically."
27626 #: ../fish/guestfish-commands.pod:147
27631 #: ../fish/guestfish-commands.pod:149
27639 #: ../fish/guestfish-commands.pod:151
27641 "Close and reopen the libguestfs handle. It is not necessary to use this "
27642 "normally, because the handle is closed properly when guestfish exits. "
27643 "However this is occasionally useful for testing."
27647 #: ../fish/guestfish-commands.pod:155
27652 #: ../fish/guestfish-commands.pod:157
27655 " sparse filename size\n"
27660 #: ../fish/guestfish-commands.pod:159
27662 "This creates an empty sparse file of the given size, and then adds so it can "
27663 "be further examined."
27667 #: ../fish/guestfish-commands.pod:162
27669 "In all respects it works the same as the L</alloc> command, except that the "
27670 "image file is allocated sparsely, which means that disk blocks are not "
27671 "assigned to the file until they are needed. Sparse disk files only use "
27672 "space when written to, but they are slower and there is a danger you could "
27673 "run out of real disk space during a write operation."
27677 #: ../fish/guestfish-commands.pod:172
27682 #: ../fish/guestfish-commands.pod:174
27690 #: ../fish/guestfish-commands.pod:176
27692 "This command returns a list of the optional groups known to the daemon, and "
27693 "indicates which ones are supported by this build of the libguestfs "
27698 #: ../fish/guestfish-commands.pod:180
27699 msgid "See also L<guestfs(3)/AVAILABILITY>."
27703 #: ../fish/guestfish-commands.pod:182
27708 #: ../fish/guestfish-commands.pod:184
27711 " time command args...\n"
27716 #: ../fish/guestfish-commands.pod:186
27718 "Run the command as usual, but print the elapsed time afterwards. This can "
27719 "be useful for benchmarking operations."
27723 #: ../test-tool/libguestfs-test-tool.pod:5
27724 msgid "libguestfs-test-tool - End user tests for libguestfs"
27728 #: ../test-tool/libguestfs-test-tool.pod:9
27731 " libguestfs-test-tool [--options]\n"
27736 #: ../test-tool/libguestfs-test-tool.pod:13
27738 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27739 "and developers, to allow them to check basic libguestfs functionality is "
27740 "working. This is needed because libguestfs occasionally breaks for reasons "
27741 "beyond our control: usually because of changes in the underlying qemu or "
27742 "kernel packages, or the host environment."
27746 #: ../test-tool/libguestfs-test-tool.pod:20
27747 msgid "If you suspect a problem in libguestfs, then just run:"
27751 #: ../test-tool/libguestfs-test-tool.pod:22
27754 " libguestfs-test-tool\n"
27759 #: ../test-tool/libguestfs-test-tool.pod:24
27760 msgid "It will print lots of diagnostic messages."
27764 #: ../test-tool/libguestfs-test-tool.pod:26
27765 msgid "If it runs to completion successfully, you will see this near the end:"
27769 #: ../test-tool/libguestfs-test-tool.pod:28
27772 " ===== TEST FINISHED OK =====\n"
27777 #: ../test-tool/libguestfs-test-tool.pod:30
27778 msgid "and the test tool will exit with code 0."
27782 #: ../test-tool/libguestfs-test-tool.pod:32
27784 "If it fails (and/or exits with non-zero error code), please paste the "
27785 "B<complete, unedited> output of the test tool into a bug report. More "
27786 "information about reporting bugs can be found on the "
27787 "L<http://libguestfs.org/> website."
27791 #: ../test-tool/libguestfs-test-tool.pod:41
27796 #: ../test-tool/libguestfs-test-tool.pod:43
27797 msgid "Display short usage information and exit."
27801 #: ../test-tool/libguestfs-test-tool.pod:45
27802 msgid "I<--qemu qemu_binary>"
27806 #: ../test-tool/libguestfs-test-tool.pod:47
27808 "If you have downloaded another qemu binary, point this option at the full "
27809 "path of the binary to try it."
27813 #: ../test-tool/libguestfs-test-tool.pod:50
27814 msgid "I<--qemudir qemu_source_dir>"
27818 #: ../test-tool/libguestfs-test-tool.pod:52
27820 "If you have compiled qemu from source, point this option at the source "
27821 "directory to try it."
27825 #: ../test-tool/libguestfs-test-tool.pod:55
27826 msgid "I<--timeout N>"
27830 #: ../test-tool/libguestfs-test-tool.pod:57
27832 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27833 "does not usually need to be adjusted unless your machine is very slow."
27837 #: ../test-tool/libguestfs-test-tool.pod:63
27838 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27842 #: ../test-tool/libguestfs-test-tool.pod:65
27844 "If you have compiled another version of qemu from source and would like to "
27845 "try that, then you can use the I<--qemudir> option to point to the qemu "
27846 "source directory."
27850 #: ../test-tool/libguestfs-test-tool.pod:69
27852 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27853 "option to point to the binary."
27857 #: ../test-tool/libguestfs-test-tool.pod:72
27859 "When using an alternate qemu with libguestfs, usually you would need to "
27860 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27861 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27862 "when you use either of the I<--qemudir> or I<--qemu> options."
27866 #: ../test-tool/libguestfs-test-tool.pod:79
27868 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27869 "I<1> if there was an error."
27873 #: ../test-tool/libguestfs-test-tool.pod:84
27875 "For the full list of environment variables which may affect libguestfs, "
27876 "please see the L<guestfs(3)> manual page."
27880 #: ../test-tool/libguestfs-test-tool.pod:89
27881 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27885 #: ../fuse/guestmount.pod:5
27886 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27890 #: ../fuse/guestmount.pod:9
27893 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27898 #: ../fuse/guestmount.pod:11
27901 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27906 #: ../fuse/guestmount.pod:13
27909 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27914 #: ../fuse/guestmount.pod:17
27916 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27917 "machines. If you do this, you risk disk corruption in the VM."
27921 #: ../fuse/guestmount.pod:22
27923 "The guestmount program can be used to mount virtual machine filesystems and "
27924 "other disk images on the host. It uses libguestfs for access to the guest "
27925 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27926 "a mountable device."
27930 #: ../fuse/guestmount.pod:27
27932 "Along with other options, you have to give at least one device (I<-a> "
27933 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27934 "option) or use the I<-i> inspection option. How this works is better "
27935 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27940 #: ../fuse/guestmount.pod:33
27942 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27943 "by you, and the filesystem will not be visible to any other users unless you "
27944 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27945 "the filesystem, use the C<fusermount -u> command."
27949 #: ../fuse/guestmount.pod:41
27951 "For a typical Windows guest which has its main filesystem on the first "
27956 #: ../fuse/guestmount.pod:44
27959 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
27964 #: ../fuse/guestmount.pod:46
27966 "For a typical Linux guest which has a /boot filesystem on the first "
27967 "partition, and the root filesystem on a logical volume:"
27971 #: ../fuse/guestmount.pod:49
27974 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
27979 #: ../fuse/guestmount.pod:51
27980 msgid "To get libguestfs to detect guest mountpoints for you:"
27984 #: ../fuse/guestmount.pod:53
27987 " guestmount -a guest.img -i --ro /mnt\n"
27992 #: ../fuse/guestmount.pod:55
27993 msgid "For a libvirt guest called \"Guest\" you could do:"
27997 #: ../fuse/guestmount.pod:57
28000 " guestmount -d Guest -i --ro /mnt\n"
28005 #: ../fuse/guestmount.pod:59
28007 "If you don't know what filesystems are contained in a guest or disk image, "
28008 "use L<virt-filesystems(1)> first:"
28012 #: ../fuse/guestmount.pod:62
28015 " virt-filesystems MyGuest\n"
28020 #: ../fuse/guestmount.pod:64
28022 "If you want to trace the libguestfs calls but without excessive debugging "
28023 "information, we recommend:"
28027 #: ../fuse/guestmount.pod:67
28030 " guestmount [...] --trace /mnt\n"
28035 #: ../fuse/guestmount.pod:69
28036 msgid "If you want to debug the program, we recommend:"
28040 #: ../fuse/guestmount.pod:71
28043 " guestmount [...] --trace --verbose /mnt\n"
28048 #: ../fuse/guestmount.pod:77
28049 msgid "B<-a image> | B<--add image>"
28053 #: ../fuse/guestmount.pod:79
28054 msgid "Add a block device or virtual machine image."
28058 #: ../fuse/guestmount.pod:84
28059 msgid "B<-c URI> | B<--connect URI>"
28063 #: ../fuse/guestmount.pod:90
28064 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28068 #: ../fuse/guestmount.pod:96
28069 msgid "B<--dir-cache-timeout N>"
28073 #: ../fuse/guestmount.pod:98
28075 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28076 "seconds. The readdir cache [actually, there are several semi-independent "
28077 "caches] is populated after a readdir(2) call with the stat and extended "
28078 "attributes of the files in the directory, in anticipation that they will be "
28079 "requested soon after."
28083 #: ../fuse/guestmount.pod:104
28085 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28086 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28087 "requests, only cache existing ones."
28091 #: ../fuse/guestmount.pod:115
28092 msgid "B<--format=raw|qcow2|..> | B<--format>"
28096 #: ../fuse/guestmount.pod:122
28098 "If you have untrusted raw-format guest disk images, you should use this "
28099 "option to specify the disk format. This avoids a possible security problem "
28100 "with malicious guests (CVE-2010-3851). See also "
28101 "L<guestfs(3)/guestfs_add_drive_opts>."
28105 #: ../fuse/guestmount.pod:127
28106 msgid "B<--fuse-help>"
28110 #: ../fuse/guestmount.pod:129
28111 msgid "Display help on special FUSE options (see I<-o> below)."
28115 #: ../fuse/guestmount.pod:133
28116 msgid "Display brief help and exit."
28120 #: ../fuse/guestmount.pod:135
28121 msgid "B<-i> | B<--inspector>"
28125 #: ../fuse/guestmount.pod:155
28127 "Mount the named partition or logical volume on the given mountpoint B<in the "
28128 "guest> (this has nothing to do with mountpoints in the host)."
28132 #: ../fuse/guestmount.pod:158
28134 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28135 "something on C</>."
28139 #: ../fuse/guestmount.pod:171
28140 msgid "B<-n> | B<--no-sync>"
28144 #: ../fuse/guestmount.pod:173
28146 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28147 "unmounted. If you specify this option, then we don't attempt to sync the "
28148 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28152 #: ../fuse/guestmount.pod:178
28153 msgid "B<-o option> | B<--option option>"
28157 #: ../fuse/guestmount.pod:180
28158 msgid "Pass extra options to FUSE."
28162 #: ../fuse/guestmount.pod:182
28164 "To get a list of all the extra options supported by FUSE, use the command "
28165 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28166 "of them are a good idea."
28170 #: ../fuse/guestmount.pod:186
28173 " guestmount --fuse-help\n"
28178 #: ../fuse/guestmount.pod:188
28179 msgid "Some potentially useful FUSE options:"
28183 #: ../fuse/guestmount.pod:192
28184 msgid "B<-o allow_other>"
28188 #: ../fuse/guestmount.pod:194
28189 msgid "Allow other users to see the filesystem."
28193 #: ../fuse/guestmount.pod:196
28194 msgid "B<-o attr_timeout=N>"
28198 #: ../fuse/guestmount.pod:198
28199 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28203 #: ../fuse/guestmount.pod:200
28204 msgid "B<-o kernel_cache>"
28208 #: ../fuse/guestmount.pod:202
28210 "Allow the kernel to cache files (reduces the number of reads that have to go "
28211 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28212 "afford the extra memory usage."
28216 #: ../fuse/guestmount.pod:206
28217 msgid "B<-o uid=N> B<-o gid=N>"
28221 #: ../fuse/guestmount.pod:208
28223 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28224 "the chosen values."
28228 #: ../fuse/guestmount.pod:213
28229 msgid "B<-r> | B<--ro>"
28233 #: ../fuse/guestmount.pod:215
28235 "Add devices and mount everything read-only. Also disallow writes and make "
28236 "the disk appear read-only to FUSE."
28240 #: ../fuse/guestmount.pod:218
28242 "This is highly recommended if you are not going to edit the guest disk. If "
28243 "the guest is running and this option is I<not> supplied, then there is a "
28244 "strong risk of disk corruption in the guest. We try to prevent this from "
28245 "happening, but it is not always possible."
28249 #: ../fuse/guestmount.pod:223
28250 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28254 #: ../fuse/guestmount.pod:227
28255 msgid "Enable SELinux support for the guest."
28259 #: ../fuse/guestmount.pod:229
28260 msgid "B<-v> | B<--verbose>"
28264 #: ../fuse/guestmount.pod:231
28265 msgid "Enable verbose messages from underlying libguestfs."
28269 #: ../fuse/guestmount.pod:233
28270 msgid "B<-V> | B<--version>"
28274 #: ../fuse/guestmount.pod:235
28275 msgid "Display the program version and exit."
28279 #: ../fuse/guestmount.pod:237
28280 msgid "B<-w> | B<--rw>"
28284 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28285 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28289 #: ../fuse/guestmount.pod:244
28290 msgid "B<-x> | B<--trace>"
28294 #: ../fuse/guestmount.pod:246
28295 msgid "Trace libguestfs calls and entry into each FUSE function."
28299 #: ../fuse/guestmount.pod:248
28300 msgid "This also stops the daemon from forking into the background."
28304 #: ../fuse/guestmount.pod:269
28306 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28307 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28308 "L<http://fuse.sf.net/>."
28312 #: ../fuse/guestmount.pod:284
28313 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28317 #: ../tools/virt-edit.pl:34
28318 msgid "virt-edit - Edit a file in a virtual machine"
28322 #: ../tools/virt-edit.pl:38
28325 " virt-edit [--options] domname file\n"
28330 #: ../tools/virt-edit.pl:40
28333 " virt-edit [--options] disk.img [disk.img ...] file\n"
28338 #: ../tools/virt-edit.pl:42
28341 " virt-edit [domname|disk.img] file -e 'expr'\n"
28346 #: ../tools/virt-edit.pl:46
28348 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28349 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28350 "doing this, but doesn't catch all cases."
28354 #: ../tools/virt-edit.pl:52
28356 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28357 "the named virtual machine (or disk image)."
28361 #: ../tools/virt-edit.pl:55
28362 msgid "If you want to just view a file, use L<virt-cat(1)>."
28366 #: ../tools/virt-edit.pl:57
28368 "For more complex cases you should look at the L<guestfish(1)> tool (see "
28369 "L</USING GUESTFISH> below)."
28373 #: ../tools/virt-edit.pl:60
28375 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28376 "files. L<guestfish(1)> can do that and much more."
28380 #: ../tools/virt-edit.pl:65
28381 msgid "Edit the named files interactively:"
28385 #: ../tools/virt-edit.pl:67
28388 " virt-edit mydomain /boot/grub/grub.conf\n"
28393 #: ../tools/virt-edit.pl:69
28396 " virt-edit mydomain /etc/passwd\n"
28401 #: ../tools/virt-edit.pl:71
28402 msgid "For Windows guests, some Windows paths are understood:"
28406 #: ../tools/virt-edit.pl:73
28409 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28414 #: ../tools/virt-edit.pl:75
28416 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28417 "below). To change the init default level to 5:"
28421 #: ../tools/virt-edit.pl:79
28424 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28429 #: ../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
28430 msgid "Display brief help."
28434 #: ../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
28435 msgid "Display version number and exit."
28439 #: ../tools/virt-edit.pl:105
28440 msgid "B<--backup extension> | B<-b extension>"
28444 #: ../tools/virt-edit.pl:107
28446 "Create a backup of the original file I<in the guest disk image>. The backup "
28447 "has the original filename with C<extension> added."
28451 #: ../tools/virt-edit.pl:110
28453 "Usually the first character of C<extension> would be a dot C<.> so you would "
28458 #: ../tools/virt-edit.pl:113
28461 " virt-edit -b .orig [etc]\n"
28466 #: ../tools/virt-edit.pl:115
28467 msgid "By default, no backup file is made."
28471 #: ../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
28472 msgid "B<--connect URI> | B<-c URI>"
28476 #: ../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
28478 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28479 "to the default libvirt hypervisor."
28483 #: ../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
28485 "If you specify guest block devices directly, then libvirt is not used at "
28490 #: ../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
28491 msgid "B<--format> raw"
28495 #: ../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
28497 "Specify the format of disk images given on the command line. If this is "
28498 "omitted then the format is autodetected from the content of the disk image."
28502 #: ../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
28504 "If disk images are requested from libvirt, then this program asks libvirt "
28505 "for this information. In this case, the value of the format parameter is "
28510 #: ../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
28512 "If working with untrusted raw-format guest disk images, you should ensure "
28513 "the format is always specified."
28517 #: ../tools/virt-edit.pl:150
28518 msgid "B<--expr EXPR> | B<-e EXPR>"
28522 #: ../tools/virt-edit.pl:152
28524 "Instead of launching the external editor, non-interactively apply the Perl "
28525 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28530 #: ../tools/virt-edit.pl:156
28532 "Be careful to properly quote the expression to prevent it from being altered "
28537 #: ../tools/virt-edit.pl:280
28538 msgid "NON-INTERACTIVE EDITING"
28542 #: ../tools/virt-edit.pl:282
28544 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28545 "administrator can interactively edit the file."
28549 #: ../tools/virt-edit.pl:285
28551 "There are two ways also to use C<virt-edit> from scripts in order to make "
28552 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28553 "like this, it's less error-prone to write scripts directly using the "
28554 "libguestfs API and Augeas for configuration file editing.)"
28558 #: ../tools/virt-edit.pl:291
28560 "The first method is to temporarily set C<$EDITOR> to any script or program "
28561 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28562 "update C<tmpfile> in place however it likes."
28566 #: ../tools/virt-edit.pl:295
28568 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
28569 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28570 "instances of C<foo> with C<bar> in a file:"
28574 #: ../tools/virt-edit.pl:299
28577 " virt-edit domname filename -e 's/foo/bar/'\n"
28582 #: ../tools/virt-edit.pl:301
28584 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28585 "For example to delete root's password you could do:"
28589 #: ../tools/virt-edit.pl:304
28592 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28597 #: ../tools/virt-edit.pl:306
28599 "What really happens is that the snippet is evaluated as a Perl expression "
28600 "for each line of the file. The line, including the final C<\\n>, is passed "
28601 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28605 #: ../tools/virt-edit.pl:311
28607 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28608 "C<apache> user account from the password file you can do:"
28612 #: ../tools/virt-edit.pl:314
28615 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28620 #: ../tools/virt-edit.pl:316
28622 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28623 "the end of the file is rather difficult this way since there is no concept "
28624 "of \"last line of the file\" - your expression just doesn't get called "
28625 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28630 #: ../tools/virt-edit.pl:322
28632 "The variable C<$lineno> contains the current line number. As is "
28633 "traditional, the first line in the file is number C<1>."
28637 #: ../tools/virt-edit.pl:325
28639 "The return value from the expression is ignored, but the expression may call "
28640 "C<die> in order to abort the whole program, leaving the original file "
28645 #: ../tools/virt-edit.pl:329
28647 "Remember when matching the end of a line that C<$_> may contain the final "
28648 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28649 "newline then neither of these. Thus to match or substitute some text at the "
28650 "end of a line, use this regular expression:"
28654 #: ../tools/virt-edit.pl:334
28657 " /some text(\\r?\\n)?$/\n"
28662 #: ../tools/virt-edit.pl:336
28664 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28665 "C<$_> itself (since that would remove all newlines from the file):"
28669 #: ../tools/virt-edit.pl:340
28672 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28677 #: ../tools/virt-edit.pl:344
28679 "C<virt-edit> has a limited ability to understand Windows drive letters and "
28680 "paths (eg. C<E:\\foo\\bar.txt>)."
28684 #: ../tools/virt-edit.pl:347
28685 msgid "If and only if the guest is running Windows then:"
28689 #: ../tools/virt-edit.pl:353
28691 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
28692 "to the correct filesystem."
28696 #: ../tools/virt-edit.pl:358
28698 "Any backslash (C<\\>) characters in the path are replaced with forward "
28699 "slashes so that libguestfs can process it."
28703 #: ../tools/virt-edit.pl:363
28705 "The path is resolved case insensitively to locate the file that should be "
28710 #: ../tools/virt-edit.pl:368
28711 msgid "There are some known shortcomings:"
28715 #: ../tools/virt-edit.pl:374
28716 msgid "Some NTFS symbolic links may not be followed correctly."
28720 #: ../tools/virt-edit.pl:378
28721 msgid "NTFS junction points that cross filesystems are not followed."
28725 #: ../tools/virt-edit.pl:435
28726 msgid "USING GUESTFISH"
28730 #: ../tools/virt-edit.pl:437
28732 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
28733 "C<virt-edit> doesn't work."
28737 #: ../tools/virt-edit.pl:440
28738 msgid "Using C<virt-edit> is approximately equivalent to doing:"
28742 #: ../tools/virt-edit.pl:442
28745 " guestfish --rw -i -d domname edit /file\n"
28750 #: ../tools/virt-edit.pl:444
28752 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
28753 "path to the file."
28757 #: ../tools/virt-edit.pl:447
28759 "The command above uses libguestfs's guest inspection feature and so does not "
28760 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
28761 "disk images that don't contain guests. To edit a file on a disk image "
28766 #: ../tools/virt-edit.pl:452
28769 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
28774 #: ../tools/virt-edit.pl:454
28776 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
28777 "the disk image to edit, and C</file> is the full path to the file."
28781 #: ../tools/virt-edit.pl:458
28783 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
28784 "C<write> or C<upload> instead:"
28788 #: ../tools/virt-edit.pl:461
28791 " guestfish --rw -i -d domname touch /newfile\n"
28796 #: ../tools/virt-edit.pl:463
28799 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
28804 #: ../tools/virt-edit.pl:465
28807 " guestfish --rw -i -d domname upload localfile /newfile\n"
28812 #: ../tools/virt-edit.pl:467
28813 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
28817 #: ../tools/virt-edit.pl:470
28820 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
28825 #: ../tools/virt-edit.pl:480
28830 #: ../tools/virt-edit.pl:482
28832 "If set, this string is used as the editor. It may contain arguments, "
28833 "eg. C<\"emacs -nw\">"
28837 #: ../tools/virt-edit.pl:485
28838 msgid "If not set, C<vi> is used."
28842 #: ../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
28843 msgid "SHELL QUOTING"
28847 #: ../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
28849 "Libvirt guest names can contain arbitrary characters, some of which have "
28850 "meaning to the shell such as C<#> and space. You may need to quote or "
28851 "escape these characters on the command line. See the shell manual page "
28852 "L<sh(1)> for details."
28856 #: ../tools/virt-edit.pl:498
28858 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
28859 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28860 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
28864 #: ../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
28869 #: ../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
28870 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
28874 #: ../tools/virt-edit.pl:516
28875 msgid "Copyright (C) 2009-2011 Red Hat Inc."
28879 #: ../tools/virt-win-reg.pl:37
28881 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28886 #: ../tools/virt-win-reg.pl:41
28889 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28894 #: ../tools/virt-win-reg.pl:43
28897 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28902 #: ../tools/virt-win-reg.pl:45
28905 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28910 #: ../tools/virt-win-reg.pl:47
28913 " virt-win-reg --merge domname [input.reg ...]\n"
28918 #: ../tools/virt-win-reg.pl:49
28921 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28926 #: ../tools/virt-win-reg.pl:53
28928 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28929 "virtual machines. If you do this, you I<will> get irreversible disk "
28930 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28931 "but doesn't catch all cases."
28935 #: ../tools/virt-win-reg.pl:58
28937 "Modifying the Windows Registry is an inherently risky operation. The format "
28938 "is deliberately obscure and undocumented, and Registry changes can leave the "
28939 "system unbootable. Therefore when using the I<--merge> option, make sure "
28940 "you have a reliable backup first."
28944 #: ../tools/virt-win-reg.pl:65
28946 "This program can export and merge Windows Registry entries from a Windows "
28951 #: ../tools/virt-win-reg.pl:68
28953 "The first parameter is the libvirt guest name or the raw disk image of a "
28958 #: ../tools/virt-win-reg.pl:71
28960 "If I<--merge> is I<not> specified, then the chosen registry key is "
28961 "displayed/exported (recursively). For example:"
28965 #: ../tools/virt-win-reg.pl:74
28968 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28973 #: ../tools/virt-win-reg.pl:76
28974 msgid "You can also display single values from within registry keys, for example:"
28978 #: ../tools/virt-win-reg.pl:79
28981 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28982 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28983 " Windows 7 Enterprise\n"
28988 #: ../tools/virt-win-reg.pl:83
28990 "With I<--merge>, you can merge a textual regedit file into the Windows "
28995 #: ../tools/virt-win-reg.pl:86
28998 " $ virt-win-reg --merge Windows7 changes.reg\n"
29003 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29008 #: ../tools/virt-win-reg.pl:90
29010 "This program is only meant for simple access to the registry. If you want "
29011 "to do complicated things with the registry, we suggest you download the "
29012 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29013 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29014 "L<hivexregedit(1)>."
29018 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29023 #: ../tools/virt-win-reg.pl:122
29024 msgid "Enable debugging messages."
29028 #: ../tools/virt-win-reg.pl:157
29033 #: ../tools/virt-win-reg.pl:159
29035 "In merge mode, this merges a textual regedit file into the Windows Registry "
29036 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29037 "displays or exports Registry entries instead."
29041 #: ../tools/virt-win-reg.pl:163
29043 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29044 "result in disk corruption. However exporting (without this flag) is always "
29049 #: ../tools/virt-win-reg.pl:171
29050 msgid "B<--encoding> UTF-16LE|ASCII"
29054 #: ../tools/virt-win-reg.pl:173
29056 "When merging (only), you may need to specify the encoding for strings to be "
29057 "used in the hive file. This is explained in detail in "
29058 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29062 #: ../tools/virt-win-reg.pl:177
29064 "The default is to use UTF-16LE, which should work with recent versions of "
29069 #: ../tools/virt-win-reg.pl:402
29070 msgid "SUPPORTED SYSTEMS"
29074 #: ../tools/virt-win-reg.pl:404
29076 "The program currently supports Windows NT-derived guests starting with "
29077 "Windows XP through to at least Windows 7."
29081 #: ../tools/virt-win-reg.pl:407
29083 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
29084 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
29085 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
29089 #: ../tools/virt-win-reg.pl:411
29091 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29096 #: ../tools/virt-win-reg.pl:414
29098 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29103 #: ../tools/virt-win-reg.pl:417
29108 #: ../tools/virt-win-reg.pl:419
29110 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29111 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29112 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29113 "with Windows-style line endings, you may need to reencode the whole file "
29114 "before or after processing."
29118 #: ../tools/virt-win-reg.pl:425
29120 "To reencode a file from Windows format to Linux (before processing it with "
29121 "the I<--merge> option), you would do something like this:"
29125 #: ../tools/virt-win-reg.pl:428
29128 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29133 #: ../tools/virt-win-reg.pl:430
29135 "To go in the opposite direction, after exporting and before sending the file "
29136 "to a Windows user, do something like this:"
29140 #: ../tools/virt-win-reg.pl:433
29143 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29148 #: ../tools/virt-win-reg.pl:435
29149 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29153 #: ../tools/virt-win-reg.pl:437
29155 "If you are unsure about the current encoding, use the L<file(1)> command. "
29156 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29157 "Windows-style (CRLF) line endings, like this:"
29161 #: ../tools/virt-win-reg.pl:441
29164 " $ file software.reg\n"
29165 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29166 " with CRLF line terminators\n"
29171 #: ../tools/virt-win-reg.pl:445
29172 msgid "This file would need conversion before you could I<--merge> it."
29176 #: ../tools/virt-win-reg.pl:447
29177 msgid "CurrentControlSet etc."
29181 #: ../tools/virt-win-reg.pl:449
29183 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29184 "Registry at the level of the hive file, and therefore you cannot modify "
29189 #: ../tools/virt-win-reg.pl:453
29191 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29192 "circumstances it might refer to another control set. The way to find out is "
29193 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29197 #: ../tools/virt-win-reg.pl:457
29200 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29201 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29202 " \"Current\"=dword:00000001\n"
29203 " \"Default\"=dword:00000001\n"
29204 " \"Failed\"=dword:00000000\n"
29205 " \"LastKnownGood\"=dword:00000002\n"
29210 #: ../tools/virt-win-reg.pl:464
29211 msgid "\"Current\" is the one which Windows will choose when it boots."
29215 #: ../tools/virt-win-reg.pl:466
29216 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29220 #: ../tools/virt-win-reg.pl:469
29221 msgid "WINDOWS TIPS"
29225 #: ../tools/virt-win-reg.pl:471
29227 "Note that some of these tips modify the guest disk image. The guest I<must> "
29228 "be shut off, else you will get disk corruption."
29232 #: ../tools/virt-win-reg.pl:474
29233 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29237 #: ../tools/virt-win-reg.pl:476
29239 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29240 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29241 "is uploaded into C<C:\\>:"
29245 #: ../tools/virt-win-reg.pl:480
29248 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29253 #: ../tools/virt-win-reg.pl:482
29254 msgid "Prepare a regedit file containing the registry change:"
29258 #: ../tools/virt-win-reg.pl:484
29261 " cat > test.reg <<'EOF'\n"
29262 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29263 " \"Test\"=\"c:\\\\test.bat\"\n"
29269 #: ../tools/virt-win-reg.pl:489
29271 "In this example we use the key C<RunOnce> which means that the script will "
29272 "run precisely once when the first user logs in. If you want it to run every "
29273 "time a user logs in, replace C<RunOnce> with C<Run>."
29277 #: ../tools/virt-win-reg.pl:493
29278 msgid "Now update the registry:"
29282 #: ../tools/virt-win-reg.pl:495
29285 " virt-win-reg --merge WindowsGuest test.reg\n"
29290 #: ../tools/virt-win-reg.pl:497
29291 msgid "INSTALLING A SERVICE"
29295 #: ../tools/virt-win-reg.pl:499
29297 "This section assumes you are familiar with Windows services, and you either "
29298 "have a program which handles the Windows Service Control Protocol directly "
29299 "or you want to run any program using a service wrapper like SrvAny or the "
29304 #: ../tools/virt-win-reg.pl:504
29306 "First upload the program and optionally the service wrapper. In this case "
29307 "the test program is called C<test.exe> and we are using the RHSrvAny "
29312 #: ../tools/virt-win-reg.pl:508
29315 " guestfish -i -d WindowsGuest <<EOF\n"
29316 " upload rhsrvany.exe /rhsrvany.exe\n"
29317 " upload test.exe /test.exe\n"
29323 #: ../tools/virt-win-reg.pl:513
29325 "Prepare a regedit file containing the registry changes. In this example, "
29326 "the first registry change is needed for the service itself or the service "
29327 "wrapper (if used). The second registry change is only needed because I am "
29328 "using the RHSrvAny service wrapper."
29332 #: ../tools/virt-win-reg.pl:518
29335 " cat > service.reg <<'EOF'\n"
29336 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29337 " \"Type\"=dword:00000010\n"
29338 " \"Start\"=dword:00000002\n"
29339 " \"ErrorControl\"=dword:00000001\n"
29340 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29341 " \"DisplayName\"=\"RHSrvAny\"\n"
29342 " \"ObjectName\"=\"NetworkService\"\n"
29347 #: ../tools/virt-win-reg.pl:527
29350 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29351 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29352 " \"PWD\"=\"c:\\\\Temp\"\n"
29358 #: ../tools/virt-win-reg.pl:538
29360 "For use of C<ControlSet001> see the section above in this manual page. You "
29361 "may need to adjust this according to the control set that is in use by the "
29366 #: ../tools/virt-win-reg.pl:544
29368 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29369 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29370 "privileged account."
29374 #: ../tools/virt-win-reg.pl:550
29376 "For the meaning of the magic numbers, see this Microsoft KB article: "
29377 "L<http://support.microsoft.com/kb/103000>."
29381 #: ../tools/virt-win-reg.pl:555
29382 msgid "Update the registry:"
29386 #: ../tools/virt-win-reg.pl:557
29389 " virt-win-reg --merge WindowsGuest service.reg\n"
29394 #: ../tools/virt-win-reg.pl:561
29396 "Be careful when passing parameters containing C<\\> (backslash) in the "
29397 "shell. Usually you will have to use 'single quotes' or double backslashes "
29398 "(but not both) to protect them from the shell."
29402 #: ../tools/virt-win-reg.pl:565
29403 msgid "Paths and value names are case-insensitive."
29407 #: ../tools/virt-win-reg.pl:574
29409 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29410 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29411 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29412 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29416 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29418 "When reporting bugs, please enable debugging and capture the I<complete> "
29423 #: ../tools/virt-win-reg.pl:592
29426 " export LIBGUESTFS_DEBUG=1\n"
29427 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29432 #: ../tools/virt-win-reg.pl:595
29434 "Attach /tmp/virt-win-reg.log to a new bug report at "
29435 "L<https://bugzilla.redhat.com/>"
29439 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29440 msgid "Copyright (C) 2010 Red Hat Inc."
29444 #: ../tools/virt-list-filesystems.pl:32
29445 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29449 #: ../tools/virt-list-filesystems.pl:36
29452 " virt-list-filesystems [--options] domname\n"
29457 #: ../tools/virt-list-filesystems.pl:38
29460 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29465 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29467 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29472 #: ../tools/virt-list-filesystems.pl:45
29474 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29475 "are contained in a virtual machine or disk image."
29479 #: ../tools/virt-list-filesystems.pl:49
29481 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29482 "functionality. For more complex cases you should look at the "
29483 "L<guestfish(1)> tool."
29487 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29488 msgid "B<-l> | B<--long>"
29492 #: ../tools/virt-list-filesystems.pl:108
29494 "With this option, C<virt-list-filesystems> displays the type of each "
29495 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29499 #: ../tools/virt-list-filesystems.pl:115
29500 msgid "B<-a> | B<--all>"
29504 #: ../tools/virt-list-filesystems.pl:117
29506 "Normally we only show mountable filesystems. If this option is given then "
29507 "swap devices are shown too."
29511 #: ../tools/virt-list-filesystems.pl:191
29513 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29514 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29515 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29519 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29520 msgid "Copyright (C) 2009 Red Hat Inc."
29524 #: ../tools/virt-tar.pl:33
29525 msgid "virt-tar - Extract or upload files to a virtual machine"
29529 #: ../tools/virt-tar.pl:37
29532 " virt-tar [--options] -x domname directory tarball\n"
29537 #: ../tools/virt-tar.pl:39
29540 " virt-tar [--options] -u domname tarball directory\n"
29545 #: ../tools/virt-tar.pl:41
29548 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29553 #: ../tools/virt-tar.pl:43
29556 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29561 #: ../tools/virt-tar.pl:47
29563 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29564 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29568 #: ../tools/virt-tar.pl:52
29569 msgid "Download C</home> from the VM into a local tarball:"
29573 #: ../tools/virt-tar.pl:54
29576 " virt-tar -x domname /home home.tar\n"
29581 #: ../tools/virt-tar.pl:56
29584 " virt-tar -zx domname /home home.tar.gz\n"
29589 #: ../tools/virt-tar.pl:58
29590 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29594 #: ../tools/virt-tar.pl:60
29597 " virt-tar -u domname uploadstuff.tar /tmp\n"
29602 #: ../tools/virt-tar.pl:62
29605 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29610 #: ../tools/virt-tar.pl:66
29612 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29613 "virtual machines. If you do this, you risk disk corruption in the VM. "
29614 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29618 #: ../tools/virt-tar.pl:71
29620 "You can use I<-x> (extract) on live virtual machines, but you might get "
29621 "inconsistent results or errors if there is filesystem activity inside the "
29622 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29623 "work, but the only way to guarantee consistent results is if the virtual "
29624 "machine is shut down."
29628 #: ../tools/virt-tar.pl:79
29630 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29631 "parts of a guest filesystem. There are many possibilities: making backups, "
29632 "uploading data files, snooping on guest activity, fixing or customizing "
29637 #: ../tools/virt-tar.pl:84
29639 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29640 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29641 "should look at the L<guestfish(1)> tool."
29645 #: ../tools/virt-tar.pl:88
29647 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29648 "its contents (recursively) from the virtual machine into a local tarball. "
29649 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29650 "virtual machine. You cannot use these two options together."
29654 #: ../tools/virt-tar.pl:94
29656 "In addition, you may need to use the I<-z> (gZip) option to enable "
29657 "compression. When uploading, you have to specify I<-z> if the upload file "
29658 "is compressed because virt-tar won't detect this on its own."
29662 #: ../tools/virt-tar.pl:98
29664 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29665 "example it cannot do PKZip files or bzip2 compression. If you want that "
29666 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29667 "the L<libguestfs(3)> API)."
29671 #: ../tools/virt-tar.pl:156
29672 msgid "B<-x> | B<--extract> | B<--download>"
29676 #: ../tools/virt-tar.pl:158
29677 msgid "B<-u> | B<--upload>"
29681 #: ../tools/virt-tar.pl:160
29683 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29688 #: ../tools/virt-tar.pl:163
29690 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29691 "Please read the L</WARNING> section above before using this option."
29695 #: ../tools/virt-tar.pl:167
29696 msgid "You must specify exactly one of these options."
29700 #: ../tools/virt-tar.pl:173
29701 msgid "B<-z> | B<--gzip>"
29705 #: ../tools/virt-tar.pl:175
29706 msgid "Specify that the input or output tarball is gzip-compressed."
29710 #: ../tools/virt-tar.pl:288
29712 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29713 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29714 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29715 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29719 #: ../tools/virt-make-fs.pl:37
29720 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29724 #: ../tools/virt-make-fs.pl:41
29727 " virt-make-fs [--options] input.tar output.img\n"
29732 #: ../tools/virt-make-fs.pl:43
29735 " virt-make-fs [--options] input.tar.gz output.img\n"
29740 #: ../tools/virt-make-fs.pl:45
29743 " virt-make-fs [--options] directory output.img\n"
29748 #: ../tools/virt-make-fs.pl:49
29750 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29751 "archive or some files in a directory. It is similar to tools like "
29752 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29753 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29754 "useful if you want to attach these filesystems to existing virtual machines "
29755 "(eg. to import large amounts of read-only data to a VM)."
29759 #: ../tools/virt-make-fs.pl:57
29760 msgid "Basic usage is:"
29764 #: ../tools/virt-make-fs.pl:59
29767 " virt-make-fs input output\n"
29772 #: ../tools/virt-make-fs.pl:61
29774 "where C<input> is either a directory containing files that you want to add, "
29775 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29776 "C<output> is a disk image. The input type is detected automatically. The "
29777 "output disk image defaults to a raw ext2 image unless you specify extra "
29778 "flags (see L</OPTIONS> below)."
29782 #: ../tools/virt-make-fs.pl:67
29783 msgid "EXTRA SPACE"
29787 #: ../tools/virt-make-fs.pl:69
29789 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29790 "the files that it contains, but might have extra space. Depending on how "
29791 "you are going to use the output, you might think this extra space is wasted "
29792 "and want to minimize it, or you might want to leave space so that more files "
29793 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29794 "but you can use the I<--size> flag to leave space in the filesystem if you "
29799 #: ../tools/virt-make-fs.pl:77
29801 "An alternative way to leave extra space but not make the output image any "
29802 "bigger is to use an alternative disk image format (instead of the default "
29803 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29804 "image format (check your hypervisor supports this before using it). This "
29805 "allows you to choose a large I<--size> but the extra space won't actually be "
29806 "allocated in the image until you try to store something in it."
29810 #: ../tools/virt-make-fs.pl:85
29812 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29813 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29814 "to build another image from scratch."
29818 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29823 #: ../tools/virt-make-fs.pl:91
29826 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29831 #: ../tools/virt-make-fs.pl:93
29832 msgid "FILESYSTEM TYPE"
29836 #: ../tools/virt-make-fs.pl:95
29838 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29839 "libguestfs supports can be used (but I<not> read-only formats like "
29840 "ISO9660). Here are some of the more common choices:"
29844 #: ../tools/virt-make-fs.pl:101
29849 #: ../tools/virt-make-fs.pl:103
29851 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29852 "you are not going to use the filesystem in a way that requires the journal, "
29853 "then this is just wasted overhead."
29857 #: ../tools/virt-make-fs.pl:107
29858 msgid "I<ntfs> or I<vfat>"
29862 #: ../tools/virt-make-fs.pl:109
29863 msgid "Useful if exporting data to a Windows guest."
29867 #: ../tools/virt-make-fs.pl:111
29869 "I<Note for vfat>: The tar archive or local directory must only contain files "
29870 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29871 "program running within libguestfs is unable to change the ownership of "
29872 "non-root files, since vfat itself does not support this."
29876 #: ../tools/virt-make-fs.pl:116
29881 #: ../tools/virt-make-fs.pl:118
29883 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29884 "total filesystem size."
29888 #: ../tools/virt-make-fs.pl:125
29891 " virt-make-fs --type=minix input minixfs.img\n"
29896 #: ../tools/virt-make-fs.pl:127
29897 msgid "TO PARTITION OR NOT TO PARTITION"
29901 #: ../tools/virt-make-fs.pl:129
29902 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29906 #: ../tools/virt-make-fs.pl:131
29908 "Adding a partition can make the disk image more compatible with certain "
29909 "virtualized operating systems which don't expect to see a filesystem "
29910 "directly located on a block device (Linux doesn't care and will happily "
29911 "handle both types)."
29915 #: ../tools/virt-make-fs.pl:136
29917 "On the other hand, if you have a partition table then the output image is no "
29918 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29919 "directly on a partitioned disk image. (However libguestfs tools such as "
29920 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29924 #: ../tools/virt-make-fs.pl:144
29925 msgid "Add an MBR partition:"
29929 #: ../tools/virt-make-fs.pl:146
29932 " virt-make-fs --partition -- input disk.img\n"
29937 #: ../tools/virt-make-fs.pl:148
29939 "If the output disk image could be terabyte-sized or larger, it's better to "
29940 "use an EFI/GPT-compatible partition table:"
29944 #: ../tools/virt-make-fs.pl:151
29947 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29952 #: ../tools/virt-make-fs.pl:179
29953 msgid "Enable debugging information."
29957 #: ../tools/virt-make-fs.pl:185
29958 msgid "B<--size=E<lt>NE<gt>>"
29962 #: ../tools/virt-make-fs.pl:187
29963 msgid "B<--size=+E<lt>NE<gt>>"
29967 #: ../tools/virt-make-fs.pl:189
29968 msgid "B<-s E<lt>NE<gt>>"
29972 #: ../tools/virt-make-fs.pl:191
29973 msgid "B<-s +E<lt>NE<gt>>"
29977 #: ../tools/virt-make-fs.pl:193
29978 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
29982 #: ../tools/virt-make-fs.pl:196
29984 "If this option is I<not> given, then the output image will be just large "
29985 "enough to contain all the files, with not much wasted space."
29989 #: ../tools/virt-make-fs.pl:199
29991 "To choose a fixed size output disk, specify an absolute number followed by "
29992 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29993 "Petabytes or Exabytes. This must be large enough to contain all the input "
29994 "files, else you will get an error."
29998 #: ../tools/virt-make-fs.pl:204
30000 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30001 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30002 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30003 "the input files, and (approximately) an extra 200 MB free space."
30007 #: ../tools/virt-make-fs.pl:210
30009 "Note that virt-make-fs estimates free space, and therefore will not produce "
30010 "filesystems containing precisely the free space requested. (It is much more "
30011 "expensive and time-consuming to produce a filesystem which has precisely the "
30012 "desired free space)."
30016 #: ../tools/virt-make-fs.pl:219
30017 msgid "B<--format=E<lt>fmtE<gt>>"
30021 #: ../tools/virt-make-fs.pl:221
30022 msgid "B<-F E<lt>fmtE<gt>>"
30026 #: ../tools/virt-make-fs.pl:223
30027 msgid "Choose the output disk image format."
30031 #: ../tools/virt-make-fs.pl:225
30032 msgid "The default is C<raw> (raw disk image)."
30036 #: ../tools/virt-make-fs.pl:227
30038 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30039 "that would really make sense here is C<qcow2>."
30043 #: ../tools/virt-make-fs.pl:234
30044 msgid "B<--type=E<lt>fsE<gt>>"
30048 #: ../tools/virt-make-fs.pl:236
30049 msgid "B<-t E<lt>fsE<gt>>"
30053 #: ../tools/virt-make-fs.pl:238
30054 msgid "Choose the output filesystem type."
30058 #: ../tools/virt-make-fs.pl:240
30059 msgid "The default is C<ext2>."
30063 #: ../tools/virt-make-fs.pl:242
30064 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30068 #: ../tools/virt-make-fs.pl:249
30069 msgid "B<--partition>"
30073 #: ../tools/virt-make-fs.pl:251
30074 msgid "B<--partition=E<lt>parttypeE<gt>>"
30078 #: ../tools/virt-make-fs.pl:253
30080 "If specified, this flag adds an MBR partition table to the output disk "
30085 #: ../tools/virt-make-fs.pl:256
30087 "You can change the partition table type, eg. I<--partition=gpt> for large "
30092 #: ../tools/virt-make-fs.pl:259
30094 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30095 "might consider the next parameter to be the partition type. For example:"
30099 #: ../tools/virt-make-fs.pl:263
30102 " virt-make-fs --partition input.tar ...\n"
30107 #: ../tools/virt-make-fs.pl:265
30109 "would cause virt-make-fs to think you wanted to use a partition type of "
30110 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30111 "dash) between options and the input file argument:"
30115 #: ../tools/virt-make-fs.pl:269
30118 " virt-make-fs --partition -- input.tar ...\n"
30123 #: ../tools/virt-make-fs.pl:541
30125 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30126 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30127 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30131 #: ../tools/virt-make-fs.pl:558
30134 " export LIBGUESTFS_DEBUG=1\n"
30135 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30140 #: ../tools/virt-make-fs.pl:561
30142 "Attach /tmp/virt-make-fs.log to a new bug report at "
30143 "L<https://bugzilla.redhat.com/>"
30147 #: ../tools/virt-list-partitions.pl:32
30148 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30152 #: ../tools/virt-list-partitions.pl:36
30155 " virt-list-partitions [--options] domname\n"
30160 #: ../tools/virt-list-partitions.pl:38
30163 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30168 #: ../tools/virt-list-partitions.pl:45
30170 "C<virt-list-partitions> is a command line tool to list the partitions that "
30171 "are contained in a virtual machine or disk image. It is mainly useful as a "
30172 "first step to using L<virt-resize(1)>."
30176 #: ../tools/virt-list-partitions.pl:50
30178 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30179 "functionality. For more complex cases you should look at the "
30180 "L<guestfish(1)> tool."
30184 #: ../tools/virt-list-partitions.pl:107
30185 msgid "B<-h> | B<--human-readable>"
30189 #: ../tools/virt-list-partitions.pl:109
30190 msgid "Show sizes in human-readable form (eg. \"1G\")."
30194 #: ../tools/virt-list-partitions.pl:117
30196 "With this option, C<virt-list-partitions> displays the type and size of each "
30197 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30201 #: ../tools/virt-list-partitions.pl:124
30202 msgid "B<-t> | B<--total>"
30206 #: ../tools/virt-list-partitions.pl:126
30207 msgid "Display the total size of each block device (as a separate row or rows)."
30211 #: ../tools/virt-list-partitions.pl:259
30213 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30214 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30215 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30219 #: ../tools/virt-list-partitions.pl:275
30220 msgid "Copyright (C) 2009-2010 Red Hat Inc."