1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-07-14 14:07+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
24 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
25 #: ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
37 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
38 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
39 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
40 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
41 #: ../tools/virt-list-partitions.pl:34
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
56 #: ../src/guestfs.pod:11
59 " guestfs_h *g = guestfs_create ();\n"
60 " guestfs_add_drive (g, \"guest.img\");\n"
61 " guestfs_launch (g);\n"
62 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
63 " guestfs_touch (g, \"/hello\");\n"
64 " guestfs_umount (g, \"/\");\n"
65 " guestfs_close (g);\n"
71 #: ../src/guestfs.pod:19
74 " cc prog.c -o prog -lguestfs\n"
76 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
82 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
83 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
84 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
85 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
86 #: ../tools/virt-list-partitions.pl:40
92 #: ../src/guestfs.pod:25
94 "Libguestfs is a library for accessing and modifying guest disk images. "
95 "Amongst the things this is good for: making batch configuration changes to "
96 "guests, getting disk used/free statistics (see also: virt-df), migrating "
97 "between virtualization systems (see also: virt-p2v), performing partial "
98 "backups, performing partial guest clones, cloning guests and changing "
99 "registry/UUID/hostname info, and much else besides."
104 #: ../src/guestfs.pod:33
106 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
107 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
108 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
114 #: ../src/guestfs.pod:38
116 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
117 "what filesystem is in each LV, etc.). It can also run commands in the "
118 "context of the guest. Also you can access filesystems over FUSE."
123 #: ../src/guestfs.pod:43
125 "Libguestfs is a library that can be linked with C and C++ management "
126 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
127 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
133 #: ../src/guestfs.pod:48
135 "You don't need to be root to use libguestfs, although obviously you do need "
136 "enough permissions to access the disk images."
141 #: ../src/guestfs.pod:51
143 "Libguestfs is a large API because it can do many things. For a gentle "
144 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:54
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
157 #: ../src/guestfs.pod:57
163 #: ../src/guestfs.pod:59
165 "This section provides a gentler overview of the libguestfs API. We also try "
166 "to group API calls together, where that may not be obvious from reading "
167 "about the individual calls in the main section of this manual."
172 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
189 #: ../src/guestfs.pod:73
190 msgid "The general structure of all libguestfs-using programs looks like this:"
195 #: ../src/guestfs.pod:76
198 " guestfs_h *g = guestfs_create ();\n"
204 #: ../src/guestfs.pod:78
207 " /* Call guestfs_add_drive additional times if there are\n"
208 " * multiple disk images.\n"
210 " guestfs_add_drive (g, \"guest.img\");\n"
216 #: ../src/guestfs.pod:83
219 " /* Most manipulation calls won't work until you've launched\n"
220 " * the handle 'g'. You have to do this _after_ adding drives\n"
221 " * and _before_ other commands.\n"
223 " guestfs_launch (g);\n"
229 #: ../src/guestfs.pod:89
232 " /* Now you can examine what partitions, LVs etc are available.\n"
234 " char **partitions = guestfs_list_partitions (g);\n"
235 " char **logvols = guestfs_lvs (g);\n"
241 #: ../src/guestfs.pod:94
244 " /* To access a filesystem in the image, you must mount it.\n"
246 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 " /* Now you can perform filesystem actions on the guest\n"
257 " guestfs_touch (g, \"/hello\");\n"
263 #: ../src/guestfs.pod:103
266 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
267 " * it is done automatically when you close the handle. See\n"
268 " * discussion of autosync in this page.\n"
270 " guestfs_sync (g);\n"
276 #: ../src/guestfs.pod:109
279 " /* Close the handle 'g'. */\n"
280 " guestfs_close (g);\n"
286 #: ../src/guestfs.pod:112
288 "The code above doesn't include any error checking. In real code you should "
289 "check return values carefully for errors. In general all functions that "
290 "return integers return C<-1> on error, and all functions that return "
291 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
292 "how to handle errors, and consult the documentation for each function call "
293 "below to see precisely how they return error indications. See L<guestfs-"
294 "examples(3)> for fully worked examples."
299 #: ../src/guestfs.pod:121
305 #: ../src/guestfs.pod:123
307 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
308 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
309 "actual block device, or simply an empty file of zeroes that you have created "
310 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
316 #: ../src/guestfs.pod:129
318 "The call you should use in modern code for adding drives is L</"
319 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
320 "specifying that the format is raw, do:"
325 #: ../src/guestfs.pod:133
328 " guestfs_add_drive_opts (g, filename,\n"
329 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
336 #: ../src/guestfs.pod:137
337 msgid "You can add a disk read-only using:"
342 #: ../src/guestfs.pod:139
345 " guestfs_add_drive_opts (g, filename,\n"
346 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
347 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
354 #: ../src/guestfs.pod:144
356 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
357 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
371 #: ../src/guestfs.pod:151
373 "You must add at least one disk image, and you may add multiple disk images. "
374 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
375 "first one you added), C</dev/sdb> (for the second one you added), etc."
380 #: ../src/guestfs.pod:156
382 "Once L</guestfs_launch> has been called you cannot add any more images. You "
383 "can call L</guestfs_list_devices> to get a list of the device names, in the "
384 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
389 #: ../src/guestfs.pod:161
394 #: ../src/guestfs.pod:163
396 "Before you can read or write files, create directories and so on in a disk "
397 "image that contains filesystems, you have to mount those filesystems using "
398 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
399 "a disk image contains (for example) one partition with a filesystem on that "
400 "partition, then you can mount it directly:"
404 #: ../src/guestfs.pod:170
407 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
412 #: ../src/guestfs.pod:172
414 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
415 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
416 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
417 "that these are libguestfs virtual devices, and are nothing to do with host "
422 #: ../src/guestfs.pod:178
424 "If you are given a disk image and you don't know what it contains then you "
425 "have to find out. Libguestfs can do that too: use L</"
426 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
427 "LVs, and either try mounting each to see what is mountable, or else examine "
428 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
429 "filesystems, use L</guestfs_list_filesystems>."
433 #: ../src/guestfs.pod:186
435 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
436 "L</INSPECTION> below). But you might find it easier to look at higher level "
437 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
441 #: ../src/guestfs.pod:191
443 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
444 "several other variations of the C<guestfs_mount_*> call."
449 #: ../src/guestfs.pod:194
450 msgid "FILESYSTEM ACCESS AND MODIFICATION"
455 #: ../src/guestfs.pod:196
457 "The majority of the libguestfs API consists of fairly low-level calls for "
458 "accessing and modifying the files, directories, symlinks etc on mounted "
459 "filesystems. There are over a hundred such calls which you can find listed "
460 "in detail below in this man page, and we don't even pretend to cover them "
461 "all in this overview."
466 #: ../src/guestfs.pod:202
468 "Specify filenames as full paths, starting with C<\"/\"> and including the "
474 #: ../src/guestfs.pod:205
476 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
477 "the file called C<\"etc/passwd\"> then you could do:"
482 #: ../src/guestfs.pod:208
485 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
491 #: ../src/guestfs.pod:210
493 "This would return C<data> as a newly allocated buffer containing the full "
494 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
495 "or C<NULL> if there was an error."
500 #: ../src/guestfs.pod:214
502 "As another example, to create a top-level directory on that filesystem "
503 "called C<\"var\"> you would do:"
508 #: ../src/guestfs.pod:217
511 " guestfs_mkdir (g, \"/var\");\n"
517 #: ../src/guestfs.pod:219
518 msgid "To create a symlink you could do:"
523 #: ../src/guestfs.pod:221
526 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
527 " \"/etc/rc3.d/S30portmap\");\n"
533 #: ../src/guestfs.pod:224
535 "Libguestfs will reject attempts to use relative paths and there is no "
536 "concept of a current working directory."
541 #: ../src/guestfs.pod:227
543 "Libguestfs can return errors in many situations: for example if the "
544 "filesystem isn't writable, or if a file or directory that you requested "
545 "doesn't exist. If you are using the C API (documented here) you have to "
546 "check for those error conditions after each call. (Other language bindings "
547 "turn these errors into exceptions)."
552 #: ../src/guestfs.pod:233
554 "File writes are affected by the per-handle umask, set by calling L</"
555 "guestfs_umask> and defaulting to 022. See L</UMASK>."
560 #: ../src/guestfs.pod:236
566 #: ../src/guestfs.pod:238
568 "Libguestfs contains API calls to read, create and modify partition tables on "
574 #: ../src/guestfs.pod:241
576 "In the common case where you want to create a single partition covering the "
577 "whole disk, you should use the L</guestfs_part_disk> call:"
582 #: ../src/guestfs.pod:245
585 " const char *parttype = \"mbr\";\n"
586 " if (disk_is_larger_than_2TB)\n"
587 " parttype = \"gpt\";\n"
588 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
594 #: ../src/guestfs.pod:250
596 "Obviously this effectively wipes anything that was on that disk image before."
601 #: ../src/guestfs.pod:253
607 #: ../src/guestfs.pod:255
609 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
610 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
611 "you familiarize yourself with the concepts of physical volumes, volume "
612 "groups and logical volumes."
617 #: ../src/guestfs.pod:260
619 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
620 "tldp.org/HOWTO/LVM-HOWTO/>."
625 #: ../src/guestfs.pod:263
630 #: ../src/guestfs.pod:265
632 "Use L</guestfs_cat> to download small, text only files. This call is "
633 "limited to files which are less than 2 MB and which cannot contain any ASCII "
634 "NUL (C<\\0>) characters. However the API is very simple to use."
639 #: ../src/guestfs.pod:269
641 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
642 "bit data, since it returns a (pointer, size) pair. However it is still "
643 "limited to \"small\" files, less than 2 MB."
648 #: ../src/guestfs.pod:273
650 "L</guestfs_download> can be used to download any file, with no limits on "
651 "content or size (even files larger than 4 GB)."
656 #: ../src/guestfs.pod:276
658 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
663 #: ../src/guestfs.pod:279
669 #: ../src/guestfs.pod:281
671 "It's often the case that you want to write a file or files to the disk image."
676 #: ../src/guestfs.pod:284
678 "To write a small file with fixed content, use L</guestfs_write>. To create "
679 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
680 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
681 "of other functions for creating test files, for example L</guestfs_fill> and "
682 "L</guestfs_fill_pattern>."
687 #: ../src/guestfs.pod:290
689 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
690 "file content or size (even files larger than 4 GB)."
695 #: ../src/guestfs.pod:293
697 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
702 #: ../src/guestfs.pod:295
704 "However the fastest way to upload I<large numbers of arbitrary files> is to "
705 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
706 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
707 "in a predictable way (eg. adding it last after all other drives) then you "
708 "can get the device name from L</guestfs_list_devices> and mount it directly "
709 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
710 "portable between kernel versions, and they don't support labels or UUIDs. "
711 "If you want to pre-build an image or you need to mount it using a label or "
712 "UUID, use an ISO image instead."
717 #: ../src/guestfs.pod:306
723 #: ../src/guestfs.pod:308
725 "There are various different commands for copying between files and devices "
726 "and in and out of the guest filesystem. These are summarised in the table "
732 #: ../src/guestfs.pod:314
733 msgid "B<file> to B<file>"
738 #: ../src/guestfs.pod:316
740 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
741 "directories recursively."
746 #: ../src/guestfs.pod:319
747 msgid "B<file or device> to B<file or device>"
752 #: ../src/guestfs.pod:321
754 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
755 "devices in the guest."
760 #: ../src/guestfs.pod:324
761 msgid "Example: duplicate the contents of an LV:"
766 #: ../src/guestfs.pod:326
769 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
775 #: ../src/guestfs.pod:328
777 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
778 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
779 "guestfs_copy_size>."
784 #: ../src/guestfs.pod:332
785 msgid "B<file on the host> to B<file or device>"
790 #: ../src/guestfs.pod:334
791 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
796 #: ../src/guestfs.pod:336
797 msgid "B<file or device> to B<file on the host>"
802 #: ../src/guestfs.pod:338
803 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
808 #: ../src/guestfs.pod:342
809 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
814 #: ../src/guestfs.pod:344
816 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
817 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
818 "appears you can only upload and download to files. However many Un*x-like "
819 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
820 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
821 "and arbitrary file descriptor N."
826 #: ../src/guestfs.pod:352
827 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
831 #: ../src/guestfs.pod:355
834 " guestfs_download (g, filename, \"/dev/stdout\");\n"
839 #: ../src/guestfs.pod:357
840 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
844 #: ../src/guestfs.pod:359
848 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
849 " guestfs_tar_out (g, \"/\", devfd);\n"
855 #: ../src/guestfs.pod:363
856 msgid "LISTING FILES"
861 #: ../src/guestfs.pod:365
863 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
864 "L<guestfish(1)>-equivalent command C<ll>)."
869 #: ../src/guestfs.pod:368
871 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
872 "programs, as a flat list of strings."
877 #: ../src/guestfs.pod:371
879 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
880 "directory, plus additional information about each one. It is more "
881 "equivalent to using the L<readdir(3)> call on a local filesystem."
886 #: ../src/guestfs.pod:375
888 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
893 #: ../src/guestfs.pod:378
894 msgid "RUNNING COMMANDS"
899 #: ../src/guestfs.pod:380
901 "Although libguestfs is primarily an API for manipulating files inside guest "
902 "images, we also provide some limited facilities for running commands inside "
908 #: ../src/guestfs.pod:384
909 msgid "There are many limitations to this:"
914 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
915 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
916 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
917 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
918 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
919 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
920 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
921 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
922 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
923 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
924 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
925 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
926 #: ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980
927 #: ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
929 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
930 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1660
931 #: ../src/guestfs-actions.pod:1664 ../src/guestfs-actions.pod:1668
932 #: ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1680
933 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1688
934 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1702
935 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1844
936 #: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1853
937 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1919
938 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1928
939 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2852
940 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2867
941 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish.pod:445
942 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
943 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
944 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
945 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
946 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099
947 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
948 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
949 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
950 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
951 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
952 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
953 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
954 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
955 #: ../fish/guestfish-actions.pod:1927 ../fish/guestfish-actions.pod:1933
956 #: ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1948
957 #: ../fish/guestfish-actions.pod:1955 ../tools/virt-win-reg.pl:195
958 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
959 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
960 #: ../tools/virt-win-reg.pl:720
966 #: ../src/guestfs.pod:390
968 "The kernel version that the command runs under will be different from what "
974 #: ../src/guestfs.pod:395
976 "If the command needs to communicate with daemons, then most likely they "
982 #: ../src/guestfs.pod:400
983 msgid "The command will be running in limited memory."
988 #: ../src/guestfs.pod:404
990 "The network may not be available unless you enable it (see L</"
991 "guestfs_set_network>)."
996 #: ../src/guestfs.pod:409
997 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1002 #: ../src/guestfs.pod:413
1004 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1009 #: ../src/guestfs.pod:418
1011 "For SELinux guests, you may need to enable SELinux and load policy first. "
1012 "See L</SELINUX> in this manpage."
1017 #: ../src/guestfs.pod:423
1019 "I<Security:> It is not safe to run commands from untrusted, possibly "
1020 "malicious guests. These commands may attempt to exploit your program by "
1021 "sending unexpected output. They could also try to exploit the Linux kernel "
1022 "or qemu provided by the libguestfs appliance. They could use the network "
1023 "provided by the libguestfs appliance to bypass ordinary network partitions "
1024 "and firewalls. They could use the elevated privileges or different SELinux "
1025 "context of your program to their advantage."
1030 #: ../src/guestfs.pod:432
1032 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1033 "(a script which runs when the guest next boots normally), and to have this "
1034 "script run the commands you want in the normal context of the running guest, "
1035 "network security and so on. For information about other security issues, "
1041 #: ../src/guestfs.pod:440
1043 "The two main API calls to run commands are L</guestfs_command> and L</"
1044 "guestfs_sh> (there are also variations)."
1049 #: ../src/guestfs.pod:443
1051 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1052 "shell globs, redirections, etc will work."
1057 #: ../src/guestfs.pod:446
1058 msgid "CONFIGURATION FILES"
1063 #: ../src/guestfs.pod:448
1065 "To read and write configuration files in Linux guest filesystems, we "
1066 "strongly recommend using Augeas. For example, Augeas understands how to "
1067 "read and write, say, a Linux shadow password file or X.org configuration "
1068 "file, and so avoids you having to write that code."
1073 #: ../src/guestfs.pod:453
1075 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1076 "document Augeas itself here because there is excellent documentation on the "
1077 "L<http://augeas.net/> website."
1082 #: ../src/guestfs.pod:457
1084 "If you don't want to use Augeas (you fool!) then try calling L</"
1085 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1091 #: ../src/guestfs.pod:461
1097 #: ../src/guestfs.pod:463
1099 "We support SELinux guests. To ensure that labeling happens correctly in "
1100 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1105 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1106 #: ../src/guestfs.pod:2426
1112 #: ../src/guestfs.pod:471
1113 msgid "Before launching, do:"
1118 #: ../src/guestfs.pod:473
1121 " guestfs_set_selinux (g, 1);\n"
1127 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1128 #: ../src/guestfs.pod:2451
1134 #: ../src/guestfs.pod:477
1136 "After mounting the guest's filesystem(s), load the policy. This is best "
1137 "done by running the L<load_policy(8)> command in the guest itself:"
1142 #: ../src/guestfs.pod:481
1145 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1151 #: ../src/guestfs.pod:483
1153 "(Older versions of C<load_policy> require you to specify the name of the "
1159 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1165 #: ../src/guestfs.pod:488
1167 "Optionally, set the security context for the API. The correct security "
1168 "context to use can only be known by inspecting the guest. As an example:"
1173 #: ../src/guestfs.pod:492
1176 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1182 #: ../src/guestfs.pod:496
1183 msgid "This will work for running commands and editing existing files."
1188 #: ../src/guestfs.pod:498
1190 "When new files are created, you may need to label them explicitly, for "
1191 "example by running the external command C<restorecon pathname>."
1196 #: ../src/guestfs.pod:502
1202 #: ../src/guestfs.pod:504
1204 "Certain calls are affected by the current file mode creation mask (the "
1205 "\"umask\"). In particular ones which create files or directories, such as "
1206 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1207 "either the default mode that the file is created with or modifies the mode "
1213 #: ../src/guestfs.pod:510
1215 "The default umask is C<022>, so files are created with modes such as C<0644> "
1216 "and directories with C<0755>."
1221 #: ../src/guestfs.pod:513
1223 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1224 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1225 "guestfs_chmod> after creating each file or directory."
1230 #: ../src/guestfs.pod:517
1231 msgid "For more information about umask, see L<umask(2)>."
1236 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1237 msgid "ENCRYPTED DISKS"
1242 #: ../src/guestfs.pod:521
1244 "Libguestfs allows you to access Linux guests which have been encrypted using "
1245 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1246 "standard. This includes nearly all whole disk encryption systems used by "
1247 "modern Linux guests."
1252 #: ../src/guestfs.pod:527
1254 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1255 "returns the string C<crypto_LUKS>)."
1260 #: ../src/guestfs.pod:530
1262 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1263 "will require the passphrase!"
1268 #: ../src/guestfs.pod:533
1270 "Opening a LUKS device creates a new device mapper device called C</dev/"
1271 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1272 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1273 "from and encrypted to the underlying block device respectively."
1278 #: ../src/guestfs.pod:539
1280 "LVM volume groups on the device can be made visible by calling L</"
1281 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1282 "(s) can now be mounted in the usual way."
1287 #: ../src/guestfs.pod:543
1289 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1290 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1291 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1292 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1293 "underlying encrypted block device)."
1298 #: ../src/guestfs.pod:550
1303 #: ../src/guestfs.pod:552
1305 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1306 "contains operating systems, an install CD or a live CD. (These APIs used to "
1307 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1308 "version 1.5.3 the most frequently used part of this library has been "
1309 "rewritten in C and moved into the core code)."
1314 #: ../src/guestfs.pod:559
1316 "Add all disks belonging to the unknown virtual machine and call L</"
1317 "guestfs_launch> in the usual way."
1322 #: ../src/guestfs.pod:562
1324 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1325 "and certain heuristics, and returns a list of operating systems that were "
1326 "found. An empty list means none were found. A single element is the root "
1327 "filesystem of the operating system. For dual- or multi-boot guests, "
1328 "multiple roots can be returned, each one corresponding to a separate "
1329 "operating system. (Multi-boot virtual machines are extremely rare in the "
1330 "world of virtualization, but since this scenario can happen, we have built "
1331 "libguestfs to deal with it.)"
1336 #: ../src/guestfs.pod:571
1338 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1339 "to get additional details about that operating system. For example, call L</"
1340 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1341 "Windows and Linux-based operating systems respectively."
1346 #: ../src/guestfs.pod:577
1348 "Un*x-like and Linux-based operating systems usually consist of several "
1349 "filesystems which are mounted at boot time (for example, a separate boot "
1350 "partition mounted on C</boot>). The inspection rules are able to detect how "
1351 "filesystems correspond to mount points. Call "
1352 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1353 "hash table like this example:"
1358 #: ../src/guestfs.pod:584
1361 " /boot => /dev/sda1\n"
1362 " / => /dev/vg_guest/lv_root\n"
1363 " /usr => /dev/vg_guest/lv_usr\n"
1369 #: ../src/guestfs.pod:588
1371 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1372 "filesystems as suggested."
1377 #: ../src/guestfs.pod:591
1379 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1380 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1385 #: ../src/guestfs.pod:595
1387 "Inspection currently only works for some common operating systems. "
1388 "Contributors are welcome to send patches for other operating systems that we "
1389 "currently cannot detect."
1394 #: ../src/guestfs.pod:599
1396 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1397 "for more details. The L</guestfs_inspect_os> function just ignores any "
1398 "encrypted devices."
1403 #: ../src/guestfs.pod:603
1405 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1406 "inspection and caches the results in the guest handle. Subsequent calls to "
1407 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1408 "read the disks. If you change the content of the guest disks, you can redo "
1409 "inspection by calling L</guestfs_inspect_os> again. (L</"
1410 "guestfs_inspect_list_applications> works a little differently from the other "
1411 "calls and does read the disks. See documentation for that function for "
1416 #: ../src/guestfs.pod:612
1417 msgid "INSPECTING INSTALL DISKS"
1421 #: ../src/guestfs.pod:614
1423 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1428 #: ../src/guestfs.pod:617
1430 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1431 "system, which currently can be C<installed> (a regular operating system) or "
1432 "C<installer> (some sort of install disk)."
1436 #: ../src/guestfs.pod:621
1438 "Further information is available about the operating system that can be "
1439 "installed using the regular inspection APIs like L</"
1440 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1444 #: ../src/guestfs.pod:626
1446 "Some additional information specific to installer disks is also available "
1447 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1448 "guestfs_inspect_is_multipart> calls."
1453 #: ../src/guestfs.pod:631
1454 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1459 #: ../src/guestfs.pod:633
1461 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1462 "ntfs-3g.org/> driver."
1467 #: ../src/guestfs.pod:636
1468 msgid "DRIVE LETTERS AND PATHS"
1473 #: ../src/guestfs.pod:638
1475 "DOS and Windows still use drive letters, and the filesystems are always "
1476 "treated as case insensitive by Windows itself, and therefore you might find "
1477 "a Windows configuration file referring to a path like C<c:\\windows"
1478 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1479 "might be referred to as C</WINDOWS/System32>."
1483 #: ../src/guestfs.pod:644
1485 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1486 "L</guestfs_inspect_get_drive_mappings>)"
1490 #: ../src/guestfs.pod:647
1492 "Dealing with separator characters (backslash vs forward slash) is outside "
1493 "the scope of libguestfs, but usually a simple character replacement will "
1498 #: ../src/guestfs.pod:651
1500 "To resolve the case insensitivity of paths, call L</"
1501 "guestfs_case_sensitive_path>."
1506 #: ../src/guestfs.pod:654
1507 msgid "ACCESSING THE WINDOWS REGISTRY"
1512 #: ../src/guestfs.pod:656
1514 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1515 "files, through the library C<hivex> which is part of the libguestfs project "
1516 "although ships as a separate tarball. You have to locate and download the "
1517 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1518 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1519 "reg(1)> for more help on this issue."
1524 #: ../src/guestfs.pod:664
1525 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1530 #: ../src/guestfs.pod:666
1532 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1533 "provide something which looks like a Linux symlink. The way it tries to do "
1534 "the rewriting is described here:"
1539 #: ../src/guestfs.pod:670
1541 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1547 #: ../src/guestfs.pod:672
1549 "The essential problem is that ntfs-3g simply does not have enough "
1550 "information to do a correct job. NTFS links can contain drive letters and "
1551 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1552 "It is almost certainly the case that libguestfs callers should ignore what "
1553 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1558 #: ../src/guestfs.pod:679
1560 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1561 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1562 "attribute, and read the raw reparse data from that (you can find the format "
1563 "documented in various places around the web)."
1568 #: ../src/guestfs.pod:684
1569 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1574 #: ../src/guestfs.pod:686
1576 "There are other useful extended attributes that can be read from ntfs-3g "
1577 "filesystems (using L</guestfs_getxattr>). See:"
1582 #: ../src/guestfs.pod:689
1584 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1589 #: ../src/guestfs.pod:691
1590 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1595 #: ../src/guestfs.pod:693
1597 "Although we don't want to discourage you from using the C API, we will "
1598 "mention here that the same API is also available in other languages."
1602 #: ../src/guestfs.pod:696
1604 "The API is broadly identical in all supported languages. This means that "
1605 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1606 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1607 "OCaml. In other words, a straightforward, predictable isomorphism between "
1613 #: ../src/guestfs.pod:702
1615 "Error messages are automatically transformed into exceptions if the language "
1621 #: ../src/guestfs.pod:705
1623 "We don't try to \"object orientify\" parts of the API in OO languages, "
1624 "although contributors are welcome to write higher level APIs above what we "
1625 "provide in their favourite languages if they wish."
1630 #: ../src/guestfs.pod:711
1636 #: ../src/guestfs.pod:713
1638 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1639 "identical to the C API. C++ classes and exceptions are not used."
1644 #: ../src/guestfs.pod:717
1650 #: ../src/guestfs.pod:719
1652 "The C# bindings are highly experimental. Please read the warnings at the "
1653 "top of C<csharp/Libguestfs.cs>."
1658 #: ../src/guestfs.pod:722
1664 #: ../src/guestfs.pod:724
1666 "This is the only language binding that is working but incomplete. Only "
1667 "calls which return simple integers have been bound in Haskell, and we are "
1668 "looking for help to complete this binding."
1673 #: ../src/guestfs.pod:728
1679 #: ../src/guestfs.pod:730
1681 "Full documentation is contained in the Javadoc which is distributed with "
1687 #: ../src/guestfs.pod:733
1692 #: ../src/guestfs.pod:735
1693 msgid "See L<guestfs-ocaml(3)>."
1698 #: ../src/guestfs.pod:737
1703 #: ../src/guestfs.pod:739
1704 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1709 #: ../src/guestfs.pod:741
1715 #: ../src/guestfs.pod:743
1717 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1718 "the php-libguestfs package for your distribution."
1723 #: ../src/guestfs.pod:746
1724 msgid "The PHP binding only works correctly on 64 bit machines."
1729 #: ../src/guestfs.pod:748
1734 #: ../src/guestfs.pod:750
1735 msgid "See L<guestfs-python(3)>."
1740 #: ../src/guestfs.pod:752
1745 #: ../src/guestfs.pod:754
1746 msgid "See L<guestfs-ruby(3)>."
1751 #: ../src/guestfs.pod:756
1752 msgid "B<shell scripts>"
1756 #: ../src/guestfs.pod:758
1757 msgid "See L<guestfish(1)>."
1762 #: ../src/guestfs.pod:762
1763 msgid "LIBGUESTFS GOTCHAS"
1768 #: ../src/guestfs.pod:764
1770 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1771 "system [...] that works in the way it is documented but is counterintuitive "
1772 "and almost invites mistakes.\""
1777 #: ../src/guestfs.pod:768
1779 "Since we developed libguestfs and the associated tools, there are several "
1780 "things we would have designed differently, but are now stuck with for "
1781 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1782 "release, you can expect these to change. Beware of them."
1787 #: ../src/guestfs.pod:776
1788 msgid "Autosync / forgetting to sync."
1792 #: ../src/guestfs.pod:778
1794 "I<Update:> Autosync is enabled by default for all API users starting from "
1795 "libguestfs 1.5.24. This section only applies to older versions."
1800 #: ../src/guestfs.pod:781
1802 "When modifying a filesystem from C or another language, you B<must> unmount "
1803 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1804 "libguestfs handle. You can also call:"
1809 #: ../src/guestfs.pod:785
1812 " guestfs_set_autosync (g, 1);\n"
1818 #: ../src/guestfs.pod:787
1820 "to have the unmount/sync done automatically for you when the handle 'g' is "
1821 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1826 #: ../src/guestfs.pod:791
1828 "If you forget to do this, then it is entirely possible that your changes "
1829 "won't be written out, or will be partially written, or (very rarely) that "
1830 "you'll get disk corruption."
1835 #: ../src/guestfs.pod:795
1837 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1838 "guestfish scripts that forget to sync will work just fine, which can make "
1839 "this very puzzling if you are trying to debug a problem."
1844 #: ../src/guestfs.pod:799
1845 msgid "Mount option C<-o sync> should not be the default."
1850 #: ../src/guestfs.pod:801
1852 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1853 "However C<-o sync> does not add any reliability benefit, but does have a "
1854 "very large performance impact."
1859 #: ../src/guestfs.pod:805
1861 "The work around is to use L</guestfs_mount_options> and set the mount "
1862 "options that you actually want to use."
1867 #: ../src/guestfs.pod:808
1868 msgid "Read-only should be the default."
1873 #: ../src/guestfs.pod:810
1875 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1876 "specify I<--rw> if you want to make changes to the image."
1881 #: ../src/guestfs.pod:813
1882 msgid "This would reduce the potential to corrupt live VM images."
1887 #: ../src/guestfs.pod:815
1889 "Note that many filesystems change the disk when you just mount and unmount, "
1890 "even if you didn't perform any writes. You need to use L</"
1891 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1896 #: ../src/guestfs.pod:819
1897 msgid "guestfish command line is hard to use."
1902 #: ../src/guestfs.pod:821
1904 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1905 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1906 "exist, so it fails. In earlier versions of guestfish the error message was "
1907 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1908 "we should have used C<guestfish -c command> to run commands."
1913 #: ../src/guestfs.pod:828
1914 msgid "guestfish megabyte modifiers don't work right on all commands"
1919 #: ../src/guestfs.pod:830
1921 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1922 "other modifiers). What guestfish actually does is to multiply the number "
1923 "part by the modifier part and pass the result to the C API. However this "
1924 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1925 "expecting some other unit (eg. megabytes)."
1930 #: ../src/guestfs.pod:837
1931 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1936 #: ../src/guestfs.pod:839
1939 " lvcreate LV VG 100M\n"
1945 #: ../src/guestfs.pod:841
1947 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1948 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1949 "megabytes * megabytes) logical volume. The error message you get from this "
1950 "is also a little obscure."
1955 #: ../src/guestfs.pod:846
1957 "This could be fixed in the generator by specially marking parameters and "
1958 "return values which take bytes or other units."
1963 #: ../src/guestfs.pod:849
1964 msgid "Ambiguity between devices and paths"
1969 #: ../src/guestfs.pod:851
1971 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1972 "sdb2>) and a similar pathname. A file might just happen to be called "
1973 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1978 #: ../src/guestfs.pod:856
1980 "In the current API we usually resolve this ambiguity by having two separate "
1981 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1982 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1983 "detecting if the path supplied begins with C</dev/>."
1988 #: ../src/guestfs.pod:862
1990 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1991 "make paths/devices into structured names. One way to do this would be to "
1992 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1993 "aspect of grub. Another way would be to use a structured type, equivalent "
1994 "to this OCaml type:"
1999 #: ../src/guestfs.pod:868
2002 " type path = Path of string | Device of int | Partition of int * int\n"
2008 #: ../src/guestfs.pod:870
2009 msgid "which would allow you to pass arguments like:"
2014 #: ../src/guestfs.pod:872
2017 " Path \"/foo/bar\"\n"
2018 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2019 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2020 " Path \"/dev/sdb2\" (* not a device *)\n"
2026 #: ../src/guestfs.pod:877
2028 "As you can see there are still problems to resolve even with this "
2029 "representation. Also consider how it might work in guestfish."
2034 #: ../src/guestfs.pod:882
2035 msgid "KEYS AND PASSPHRASES"
2040 #: ../src/guestfs.pod:884
2042 "Certain libguestfs calls take a parameter that contains sensitive key "
2043 "material, passed in as a C string."
2048 #: ../src/guestfs.pod:887
2050 "In the future we would hope to change the libguestfs implementation so that "
2051 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2052 "swap. However this is I<not> done at the moment, because of the complexity "
2053 "of such an implementation."
2058 #: ../src/guestfs.pod:892
2060 "Therefore you should be aware that any key parameter you pass to libguestfs "
2061 "might end up being written out to the swap partition. If this is a concern, "
2062 "scrub the swap partition or don't use libguestfs on encrypted devices."
2067 #: ../src/guestfs.pod:897
2068 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2073 #: ../src/guestfs.pod:899
2075 "All high-level libguestfs actions are synchronous. If you want to use "
2076 "libguestfs asynchronously then you must create a thread."
2081 #: ../src/guestfs.pod:902
2083 "Only use the handle from a single thread. Either use the handle exclusively "
2084 "from one thread, or provide your own mutex so that two threads cannot issue "
2085 "calls on the same handle at the same time."
2090 #: ../src/guestfs.pod:906
2092 "See the graphical program guestfs-browser for one possible architecture for "
2093 "multithreaded programs using libvirt and libguestfs."
2098 #: ../src/guestfs.pod:909
2103 #: ../src/guestfs.pod:911
2105 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2111 #: ../src/guestfs.pod:914
2113 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2114 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2119 #: ../src/guestfs.pod:917
2121 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2122 "to change the directories that libguestfs will search in. The value is a "
2123 "colon-separated list of paths. The current directory is I<not> searched "
2124 "unless the path contains an empty element or C<.>. For example "
2125 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2126 "then C</usr/lib/guestfs>."
2131 #: ../src/guestfs.pod:924
2132 msgid "QEMU WRAPPERS"
2137 #: ../src/guestfs.pod:926
2139 "If you want to compile your own qemu, run qemu from a non-standard location, "
2140 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2146 #: ../src/guestfs.pod:930
2148 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2149 "last command in the shell script (so that qemu replaces the shell and "
2150 "becomes the direct child of the libguestfs-using program). If you don't do "
2151 "this, then the qemu process won't be cleaned up correctly."
2156 #: ../src/guestfs.pod:935
2158 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2164 #: ../src/guestfs.pod:938
2168 " qemudir=/home/rjones/d/qemu\n"
2169 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2175 #: ../src/guestfs.pod:942
2177 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2178 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2184 #: ../src/guestfs.pod:946
2187 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2193 #: ../src/guestfs.pod:948
2195 "Note that libguestfs also calls qemu with the -help and -version options in "
2196 "order to determine features."
2200 #: ../src/guestfs.pod:951
2201 msgid "ATTACHING TO RUNNING DAEMONS"
2205 #: ../src/guestfs.pod:953
2207 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2208 "babies. Use with caution."
2212 #: ../src/guestfs.pod:956
2214 "I<Note (2):> This section explains how to attach to a running daemon from a "
2215 "low level perspective. For most users, simply using virt tools such as "
2216 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2220 #: ../src/guestfs.pod:960
2221 msgid "Using guestfs_set_attach_method"
2225 #: ../src/guestfs.pod:962
2227 "By calling L</guestfs_set_attach_method> you can change how the library "
2228 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2229 "ARCHITECTURE> for some background)."
2233 #: ../src/guestfs.pod:966
2235 "The normal attach method is C<appliance>, where a small appliance is created "
2236 "containing the daemon, and then the library connects to this."
2240 #: ../src/guestfs.pod:969
2242 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2243 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2244 "daemon over the Unix domain socket."
2248 #: ../src/guestfs.pod:973
2250 "The normal use for this is to connect to a running virtual machine that "
2251 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2252 "files inside the live virtual machine."
2256 #: ../src/guestfs.pod:977
2257 msgid "Using guestfs_add_domain with live flag"
2261 #: ../src/guestfs.pod:979
2263 "L</guestfs_add_domain> provides some help for getting the correct attach "
2264 "method. If you pass the C<live> option to this function, then (if the "
2265 "virtual machine is running) it will examine the libvirt XML looking for a "
2266 "virtio-serial channel to connect to:"
2270 #: ../src/guestfs.pod:985
2277 " <channel type='unix'>\n"
2278 " <source mode='bind' path='/path/to/socket'/>\n"
2279 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2288 #: ../src/guestfs.pod:997
2290 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2291 "method to C<unix:/path/to/socket>."
2295 #: ../src/guestfs.pod:1000
2297 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2298 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2299 "to attach to and modify live virtual machines."
2303 #: ../src/guestfs.pod:1004
2305 "The virtual machine needs to have been set up beforehand so that it has the "
2306 "virtio-serial channel and so that guestfsd is running inside it."
2311 #: ../src/guestfs.pod:1008
2312 msgid "ABI GUARANTEE"
2317 #: ../src/guestfs.pod:1010
2319 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2320 "actions as outlined in this section. Although we will deprecate some "
2321 "actions, for example if they get replaced by newer calls, we will keep the "
2322 "old actions forever. This allows you the developer to program in confidence "
2323 "against the libguestfs API."
2328 #: ../src/guestfs.pod:1016
2329 msgid "BLOCK DEVICE NAMING"
2334 #: ../src/guestfs.pod:1018
2336 "In the kernel there is now quite a profusion of schemata for naming block "
2337 "devices (in this context, by I<block device> I mean a physical or virtual "
2338 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2339 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2340 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2341 "for the old IDE driver (particularly for SATA devices) those devices also "
2342 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2343 "paravirtualized drivers. This has created several different naming systems, "
2344 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2349 #: ../src/guestfs.pod:1030
2351 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2352 "Linux kernel to access block devices. We can run a variety of appliances "
2353 "based on a variety of Linux kernels."
2358 #: ../src/guestfs.pod:1034
2360 "This causes a problem for libguestfs because many API calls use device or "
2361 "partition names. Working scripts and the recipe (example) scripts that we "
2362 "make available over the internet could fail if the naming scheme changes."
2367 #: ../src/guestfs.pod:1039
2369 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2370 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2371 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2372 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2377 #: ../src/guestfs.pod:1045
2379 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2380 "L</guestfs_list_partitions> and similar calls return the true names of the "
2381 "devices and partitions as known to the appliance."
2386 #: ../src/guestfs.pod:1050
2387 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2392 #: ../src/guestfs.pod:1052
2394 "Usually this translation is transparent. However in some (very rare) cases "
2395 "you may need to know the exact algorithm. Such cases include where you use "
2396 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2397 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2402 #: ../src/guestfs.pod:1058
2404 "The algorithm is applied only to I<parameters> which are known to be either "
2405 "device or partition names. Return values from functions such as L</"
2406 "guestfs_list_devices> are never changed."
2411 #: ../src/guestfs.pod:1066
2412 msgid "Is the string a parameter which is a device or partition name?"
2417 #: ../src/guestfs.pod:1070
2418 msgid "Does the string begin with C</dev/sd>?"
2423 #: ../src/guestfs.pod:1074
2425 "Does the named device exist? If so, we use that device. However if I<not> "
2426 "then we continue with this algorithm."
2431 #: ../src/guestfs.pod:1079
2432 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2437 #: ../src/guestfs.pod:1081
2438 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2443 #: ../src/guestfs.pod:1083
2444 msgid "If that named device exists, use it. If not, continue."
2449 #: ../src/guestfs.pod:1087
2450 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2455 #: ../src/guestfs.pod:1089
2456 msgid "If that named device exists, use it. If not, return an error."
2461 #: ../src/guestfs.pod:1093
2462 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2467 #: ../src/guestfs.pod:1095
2469 "Although the standard naming scheme and automatic translation is useful for "
2470 "simple programs and guestfish scripts, for larger programs it is best not to "
2471 "rely on this mechanism."
2476 #: ../src/guestfs.pod:1099
2478 "Where possible for maximum future portability programs using libguestfs "
2479 "should use these future-proof techniques:"
2484 #: ../src/guestfs.pod:1106
2486 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2487 "device names, and then use those names directly."
2492 #: ../src/guestfs.pod:1109
2494 "Since those device names exist by definition, they will never be translated."
2499 #: ../src/guestfs.pod:1114
2501 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2502 "filesystem labels."
2507 #: ../src/guestfs.pod:1119
2513 #: ../src/guestfs.pod:1121
2515 "This section discusses security implications of using libguestfs, "
2516 "particularly with untrusted or malicious guests or disk images."
2521 #: ../src/guestfs.pod:1124
2522 msgid "GENERAL SECURITY CONSIDERATIONS"
2527 #: ../src/guestfs.pod:1126
2529 "Be careful with any files or data that you download from a guest (by "
2530 "\"download\" we mean not just the L</guestfs_download> command but any "
2531 "command that reads files, filenames, directories or anything else from a "
2532 "disk image). An attacker could manipulate the data to fool your program "
2533 "into doing the wrong thing. Consider cases such as:"
2538 #: ../src/guestfs.pod:1136
2539 msgid "the data (file etc) not being present"
2544 #: ../src/guestfs.pod:1140
2545 msgid "being present but empty"
2550 #: ../src/guestfs.pod:1144
2551 msgid "being much larger than normal"
2556 #: ../src/guestfs.pod:1148
2557 msgid "containing arbitrary 8 bit data"
2562 #: ../src/guestfs.pod:1152
2563 msgid "being in an unexpected character encoding"
2568 #: ../src/guestfs.pod:1156
2569 msgid "containing homoglyphs."
2574 #: ../src/guestfs.pod:1160
2575 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2580 #: ../src/guestfs.pod:1162
2582 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2583 "(VFS) module can sometimes be escalated into exploits by deliberately "
2584 "creating a malicious, malformed filesystem. These exploits are very severe "
2585 "for two reasons. Firstly there are very many filesystem drivers in the "
2586 "kernel, and many of them are infrequently used and not much developer "
2587 "attention has been paid to the code. Linux userspace helps potential "
2588 "crackers by detecting the filesystem type and automatically choosing the "
2589 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2590 "the administrator. Secondly, a kernel-level exploit is like a local root "
2591 "exploit (worse in some ways), giving immediate and total access to the "
2592 "system right down to the hardware level."
2597 #: ../src/guestfs.pod:1175
2599 "That explains why you should never mount a filesystem from an untrusted "
2600 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2601 "inside a qemu virtual machine, usually running as a non-root user. The "
2602 "attacker would need to write a filesystem which first exploited the kernel, "
2603 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2604 "the libguestfs protocol, and finally to be as serious as the host kernel "
2605 "exploit it would need to escalate its privileges to root. This multi-step "
2606 "escalation, performed by a static piece of data, is thought to be extremely "
2607 "hard to do, although we never say 'never' about security issues."
2612 #: ../src/guestfs.pod:1186
2614 "In any case callers can reduce the attack surface by forcing the filesystem "
2615 "type when mounting (use L</guestfs_mount_vfs>)."
2620 #: ../src/guestfs.pod:1189
2621 msgid "PROTOCOL SECURITY"
2626 #: ../src/guestfs.pod:1191
2628 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2629 "defined upper message size. However a program that uses libguestfs must "
2630 "also take care - for example you can write a program that downloads a binary "
2631 "from a disk image and executes it locally, and no amount of protocol "
2632 "security will save you from the consequences."
2637 #: ../src/guestfs.pod:1197
2638 msgid "INSPECTION SECURITY"
2643 #: ../src/guestfs.pod:1199
2645 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2646 "directly from the guest, and these could contain any 8 bit data. Callers "
2647 "should be careful to escape these before printing them to a structured file "
2648 "(for example, use HTML escaping if creating a web page)."
2653 #: ../src/guestfs.pod:1205
2655 "Guest configuration may be altered in unusual ways by the administrator of "
2656 "the virtual machine, and may not reflect reality (particularly for untrusted "
2657 "or actively malicious guests). For example we parse the hostname from "
2658 "configuration files like C</etc/sysconfig/network> that we find in the "
2659 "guest, but the guest administrator can easily manipulate these files to "
2660 "provide the wrong hostname."
2665 #: ../src/guestfs.pod:1213
2667 "The inspection API parses guest configuration using two external libraries: "
2668 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2669 "designed to be robust in the face of malicious data, although denial of "
2670 "service attacks are still possible, for example with oversized configuration "
2676 #: ../src/guestfs.pod:1219
2677 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2682 #: ../src/guestfs.pod:1221
2684 "Be very cautious about running commands from the guest. By running a "
2685 "command in the guest, you are giving CPU time to a binary that you do not "
2686 "control, under the same user account as the library, albeit wrapped in qemu "
2687 "virtualization. More information and alternatives can be found in the "
2688 "section L</RUNNING COMMANDS>."
2693 #: ../src/guestfs.pod:1227
2694 msgid "CVE-2010-3851"
2699 #: ../src/guestfs.pod:1229
2700 msgid "https://bugzilla.redhat.com/642934"
2705 #: ../src/guestfs.pod:1231
2707 "This security bug concerns the automatic disk format detection that qemu "
2708 "does on disk images."
2713 #: ../src/guestfs.pod:1234
2715 "A raw disk image is just the raw bytes, there is no header. Other disk "
2716 "images like qcow2 contain a special header. Qemu deals with this by looking "
2717 "for one of the known headers, and if none is found then assuming the disk "
2718 "image must be raw."
2723 #: ../src/guestfs.pod:1239
2725 "This allows a guest which has been given a raw disk image to write some "
2726 "other header. At next boot (or when the disk image is accessed by "
2727 "libguestfs) qemu would do autodetection and think the disk image format was, "
2728 "say, qcow2 based on the header written by the guest."
2733 #: ../src/guestfs.pod:1244
2735 "This in itself would not be a problem, but qcow2 offers many features, one "
2736 "of which is to allow a disk image to refer to another image (called the "
2737 "\"backing disk\"). It does this by placing the path to the backing disk "
2738 "into the qcow2 header. This path is not validated and could point to any "
2739 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2740 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2741 "control of the attacker."
2746 #: ../src/guestfs.pod:1252
2748 "In libguestfs this is rather hard to exploit except under two circumstances:"
2753 #: ../src/guestfs.pod:1259
2754 msgid "You have enabled the network or have opened the disk in write mode."
2759 #: ../src/guestfs.pod:1263
2761 "You are also running untrusted code from the guest (see L</RUNNING "
2767 #: ../src/guestfs.pod:1268
2769 "The way to avoid this is to specify the expected disk format when adding "
2770 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2771 "should always do this if the disk is raw format, and it's a good idea for "
2777 #: ../src/guestfs.pod:1273
2779 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2780 "format is fetched from libvirt and passed through."
2785 #: ../src/guestfs.pod:1276
2787 "For libguestfs tools, use the I<--format> command line parameter as "
2793 #: ../src/guestfs.pod:1279
2794 msgid "CONNECTION MANAGEMENT"
2799 #: ../src/guestfs.pod:1281
2805 #: ../src/guestfs.pod:1283
2807 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2808 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2809 "handle and release all resources used."
2813 #: ../src/guestfs.pod:1287
2815 "For information on using multiple handles and threads, see the section L</"
2816 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2821 #: ../src/guestfs.pod:1290
2822 msgid "guestfs_create"
2827 #: ../src/guestfs.pod:1292
2830 " guestfs_h *guestfs_create (void);\n"
2836 #: ../src/guestfs.pod:1294
2837 msgid "Create a connection handle."
2841 #: ../src/guestfs.pod:1296
2843 "On success this returns a non-NULL pointer to a handle. On error it returns "
2848 #: ../src/guestfs.pod:1299
2850 "You have to \"configure\" the handle after creating it. This includes "
2851 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2852 "handle at least once."
2857 #: ../src/guestfs.pod:1303
2858 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2862 #: ../src/guestfs.pod:1305
2864 "You may also want to configure error handling for the handle. See the L</"
2865 "ERROR HANDLING> section below."
2870 #: ../src/guestfs.pod:1308
2871 msgid "guestfs_close"
2876 #: ../src/guestfs.pod:1310
2879 " void guestfs_close (guestfs_h *g);\n"
2885 #: ../src/guestfs.pod:1312
2886 msgid "This closes the connection handle and frees up all resources used."
2890 #: ../src/guestfs.pod:1314
2892 "If autosync was set on the handle and the handle was launched, then this "
2893 "implicitly calls various functions to unmount filesystems and sync the "
2894 "disk. See L</guestfs_set_autosync> for more details."
2898 #: ../src/guestfs.pod:1318
2899 msgid "If a close callback was set on the handle, then it is called."
2904 #: ../src/guestfs.pod:1320
2905 msgid "ERROR HANDLING"
2910 #: ../src/guestfs.pod:1322
2912 "API functions can return errors. For example, almost all functions that "
2913 "return C<int> will return C<-1> to indicate an error."
2918 #: ../src/guestfs.pod:1325
2920 "Additional information is available for errors: an error message string and "
2921 "optionally an error number (errno) if the thing that failed was a system "
2927 #: ../src/guestfs.pod:1329
2929 "You can get at the additional information about the last error on the handle "
2930 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2931 "up an error handler with L</guestfs_set_error_handler>."
2936 #: ../src/guestfs.pod:1334
2938 "When the handle is created, a default error handler is installed which "
2939 "prints the error message string to C<stderr>. For small short-running "
2940 "command line programs it is sufficient to do:"
2945 #: ../src/guestfs.pod:1338
2948 " if (guestfs_launch (g) == -1)\n"
2949 " exit (EXIT_FAILURE);\n"
2955 #: ../src/guestfs.pod:1341
2957 "since the default error handler will ensure that an error message has been "
2958 "printed to C<stderr> before the program exits."
2963 #: ../src/guestfs.pod:1344
2965 "For other programs the caller will almost certainly want to install an "
2966 "alternate error handler or do error handling in-line like this:"
2971 #: ../src/guestfs.pod:1347
2974 " g = guestfs_create ();\n"
2980 #: ../src/guestfs.pod:1349
2983 " /* This disables the default behaviour of printing errors\n"
2985 " guestfs_set_error_handler (g, NULL, NULL);\n"
2991 #: ../src/guestfs.pod:1353
2994 " if (guestfs_launch (g) == -1) {\n"
2995 " /* Examine the error message and print it etc. */\n"
2996 " char *msg = guestfs_last_error (g);\n"
2997 " int errnum = guestfs_last_errno (g);\n"
2998 " fprintf (stderr, \"%s\\n\", msg);\n"
3006 #: ../src/guestfs.pod:1361
3008 "Out of memory errors are handled differently. The default action is to call "
3009 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3010 "guestfs_set_out_of_memory_handler>."
3015 #: ../src/guestfs.pod:1365
3017 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3018 "because there is no handle if this happens there is no way to get additional "
3019 "error information. However L</guestfs_create> is supposed to be a "
3020 "lightweight operation which can only fail because of insufficient memory (it "
3021 "returns NULL in this case)."
3026 #: ../src/guestfs.pod:1371
3027 msgid "guestfs_last_error"
3032 #: ../src/guestfs.pod:1373
3035 " const char *guestfs_last_error (guestfs_h *g);\n"
3041 #: ../src/guestfs.pod:1375
3043 "This returns the last error message that happened on C<g>. If there has not "
3044 "been an error since the handle was created, then this returns C<NULL>."
3049 #: ../src/guestfs.pod:1379
3051 "The lifetime of the returned string is until the next error occurs, or L</"
3052 "guestfs_close> is called."
3057 #: ../src/guestfs.pod:1382
3058 msgid "guestfs_last_errno"
3063 #: ../src/guestfs.pod:1384
3066 " int guestfs_last_errno (guestfs_h *g);\n"
3072 #: ../src/guestfs.pod:1386
3073 msgid "This returns the last error number (errno) that happened on C<g>."
3078 #: ../src/guestfs.pod:1388
3079 msgid "If successful, an errno integer not equal to zero is returned."
3084 #: ../src/guestfs.pod:1390
3086 "If no error, this returns 0. This call can return 0 in three situations:"
3091 #: ../src/guestfs.pod:1397
3092 msgid "There has not been any error on the handle."
3097 #: ../src/guestfs.pod:1401
3099 "There has been an error but the errno was meaningless. This corresponds to "
3100 "the case where the error did not come from a failed system call, but for "
3101 "some other reason."
3106 #: ../src/guestfs.pod:1407
3108 "There was an error from a failed system call, but for some reason the errno "
3109 "was not captured and returned. This usually indicates a bug in libguestfs."
3114 #: ../src/guestfs.pod:1413
3116 "Libguestfs tries to convert the errno from inside the applicance into a "
3117 "corresponding errno for the caller (not entirely trivial: the appliance "
3118 "might be running a completely different operating system from the library "
3119 "and error numbers are not standardized across Un*xen). If this could not be "
3120 "done, then the error is translated to C<EINVAL>. In practice this should "
3121 "only happen in very rare circumstances."
3126 #: ../src/guestfs.pod:1421
3127 msgid "guestfs_set_error_handler"
3132 #: ../src/guestfs.pod:1423
3135 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3137 " const char *msg);\n"
3138 " void guestfs_set_error_handler (guestfs_h *g,\n"
3139 " guestfs_error_handler_cb cb,\n"
3146 #: ../src/guestfs.pod:1430
3148 "The callback C<cb> will be called if there is an error. The parameters "
3149 "passed to the callback are an opaque data pointer and the error message "
3155 #: ../src/guestfs.pod:1434
3157 "C<errno> is not passed to the callback. To get that the callback must call "
3158 "L</guestfs_last_errno>."
3163 #: ../src/guestfs.pod:1437
3165 "Note that the message string C<msg> is freed as soon as the callback "
3166 "function returns, so if you want to stash it somewhere you must make your "
3172 #: ../src/guestfs.pod:1441
3173 msgid "The default handler prints messages on C<stderr>."
3178 #: ../src/guestfs.pod:1443
3179 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3184 #: ../src/guestfs.pod:1445
3185 msgid "guestfs_get_error_handler"
3190 #: ../src/guestfs.pod:1447
3193 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3194 " void **opaque_rtn);\n"
3200 #: ../src/guestfs.pod:1450
3201 msgid "Returns the current error handler callback."
3206 #: ../src/guestfs.pod:1452
3207 msgid "guestfs_set_out_of_memory_handler"
3212 #: ../src/guestfs.pod:1454
3215 " typedef void (*guestfs_abort_cb) (void);\n"
3216 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3217 " guestfs_abort_cb);\n"
3223 #: ../src/guestfs.pod:1458
3225 "The callback C<cb> will be called if there is an out of memory situation. "
3226 "I<Note this callback must not return>."
3231 #: ../src/guestfs.pod:1461
3232 msgid "The default is to call L<abort(3)>."
3237 #: ../src/guestfs.pod:1463
3239 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3244 #: ../src/guestfs.pod:1466
3245 msgid "guestfs_get_out_of_memory_handler"
3250 #: ../src/guestfs.pod:1468
3253 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3259 #: ../src/guestfs.pod:1470
3260 msgid "This returns the current out of memory handler."
3265 #: ../src/guestfs.pod:1472
3271 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
3277 #: ../src/guestfs.pod:1476
3283 #: ../src/guestfs.pod:1478
3289 #: ../src/guestfs.pod:1480
3290 msgid "AVAILABILITY"
3295 #: ../src/guestfs.pod:1482
3296 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3301 #: ../src/guestfs.pod:1484
3303 "Using L</guestfs_available> you can test availability of the following "
3304 "groups of functions. This test queries the appliance to see if the "
3305 "appliance you are currently using supports the functionality."
3310 #: ../src/guestfs.pod:1489
3311 msgid "@AVAILABILITY@"
3316 #: ../src/guestfs.pod:1491
3317 msgid "GUESTFISH supported COMMAND"
3322 #: ../src/guestfs.pod:1493
3324 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3325 "prints out the available groups and whether they are supported by this build "
3326 "of libguestfs. Note however that you have to do C<run> first."
3331 #: ../src/guestfs.pod:1498
3332 msgid "SINGLE CALLS AT COMPILE TIME"
3337 #: ../src/guestfs.pod:1500
3339 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3340 "function, such as:"
3345 #: ../src/guestfs.pod:1503
3348 " #define LIBGUESTFS_HAVE_DD 1\n"
3354 #: ../src/guestfs.pod:1505
3355 msgid "if L</guestfs_dd> is available."
3360 #: ../src/guestfs.pod:1507
3362 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3363 "function is available at compile time, we recommended using build tools such "
3364 "as autoconf or cmake. For example in autotools you could use:"
3369 #: ../src/guestfs.pod:1512
3372 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3373 " AC_CHECK_FUNCS([guestfs_dd])\n"
3379 #: ../src/guestfs.pod:1515
3381 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3387 #: ../src/guestfs.pod:1518
3388 msgid "SINGLE CALLS AT RUN TIME"
3393 #: ../src/guestfs.pod:1520
3395 "Testing at compile time doesn't guarantee that a function really exists in "
3396 "the library. The reason is that you might be dynamically linked against a "
3397 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3398 "This situation unfortunately results in a segmentation fault, which is a "
3399 "shortcoming of the C dynamic linking system itself."
3404 #: ../src/guestfs.pod:1527
3406 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3407 "in this example program (note that you still need the compile time check as "
3413 #: ../src/guestfs.pod:1531
3416 " #include <stdio.h>\n"
3417 " #include <stdlib.h>\n"
3418 " #include <unistd.h>\n"
3419 " #include <dlfcn.h>\n"
3420 " #include <guestfs.h>\n"
3426 #: ../src/guestfs.pod:1537
3431 " #ifdef LIBGUESTFS_HAVE_DD\n"
3433 " int has_function;\n"
3439 #: ../src/guestfs.pod:1543
3442 " /* Test if the function guestfs_dd is really available. */\n"
3443 " dl = dlopen (NULL, RTLD_LAZY);\n"
3445 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3446 " exit (EXIT_FAILURE);\n"
3448 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3455 #: ../src/guestfs.pod:1552
3458 " if (!has_function)\n"
3459 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3461 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3462 " /* Now it's safe to call\n"
3463 " guestfs_dd (g, \"foo\", \"bar\");\n"
3467 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3475 #: ../src/guestfs.pod:1565
3477 "You may think the above is an awful lot of hassle, and it is. There are "
3478 "other ways outside of the C linking system to ensure that this kind of "
3479 "incompatibility never arises, such as using package versioning:"
3484 #: ../src/guestfs.pod:1570
3487 " Requires: libguestfs >= 1.0.80\n"
3493 #: ../src/guestfs.pod:1572
3494 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3499 #: ../src/guestfs.pod:1574
3501 "A recent feature of the API is the introduction of calls which take optional "
3502 "arguments. In C these are declared 3 ways. The main way is as a call which "
3503 "takes variable arguments (ie. C<...>), as in this example:"
3508 #: ../src/guestfs.pod:1579
3511 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3517 #: ../src/guestfs.pod:1581
3519 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3520 "call with no optional arguments specified:"
3525 #: ../src/guestfs.pod:1584
3528 " guestfs_add_drive_opts (g, filename, -1);\n"
3534 #: ../src/guestfs.pod:1586
3535 msgid "With a single optional argument:"
3540 #: ../src/guestfs.pod:1588
3543 " guestfs_add_drive_opts (g, filename,\n"
3544 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3551 #: ../src/guestfs.pod:1592
3557 #: ../src/guestfs.pod:1594
3560 " guestfs_add_drive_opts (g, filename,\n"
3561 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3562 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3569 #: ../src/guestfs.pod:1599
3571 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3577 #: ../src/guestfs.pod:1602
3578 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3583 #: ../src/guestfs.pod:1604
3585 "The second variant has the same name with the suffix C<_va>, which works the "
3586 "same way but takes a C<va_list>. See the C manual for details. For the "
3587 "example function, this is declared:"
3592 #: ../src/guestfs.pod:1608
3595 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3602 #: ../src/guestfs.pod:1611
3603 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3608 #: ../src/guestfs.pod:1613
3610 "The third variant is useful where you need to construct these calls. You "
3611 "pass in a structure where you fill in the optional fields. The structure "
3612 "has a bitmask as the first element which you must set to indicate which "
3613 "fields you have filled in. For our example function the structure and call "
3619 #: ../src/guestfs.pod:1619
3622 " struct guestfs_add_drive_opts_argv {\n"
3623 " uint64_t bitmask;\n"
3625 " const char *format;\n"
3628 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3629 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3635 #: ../src/guestfs.pod:1628
3636 msgid "You could call it like this:"
3641 #: ../src/guestfs.pod:1630
3644 " struct guestfs_add_drive_opts_argv optargs = {\n"
3645 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3646 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3648 " .format = \"qcow2\"\n"
3655 #: ../src/guestfs.pod:1637
3658 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3664 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3665 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:2842
3666 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3667 #: ../fish/guestfish-actions.pod:1923 ../tools/virt-win-reg.pl:704
3673 #: ../src/guestfs.pod:1645
3674 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3679 #: ../src/guestfs.pod:1650
3680 msgid "You do not need to fill in all fields of the structure."
3685 #: ../src/guestfs.pod:1654
3687 "There must be a one-to-one correspondence between fields of the structure "
3688 "that are filled in, and bits set in the bitmask."
3693 #: ../src/guestfs.pod:1659
3694 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3699 #: ../src/guestfs.pod:1661
3701 "In other languages, optional arguments are expressed in the way that is "
3702 "natural for that language. We refer you to the language-specific "
3703 "documentation for more details on that."
3708 #: ../src/guestfs.pod:1665
3709 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3714 #: ../src/guestfs.pod:1667
3715 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3719 #: ../src/guestfs.pod:1669
3721 "B<Note:> This section documents the generic event mechanism introduced in "
3722 "libguestfs 1.10, which you should use in new code if possible. The old "
3723 "functions C<guestfs_set_log_message_callback>, "
3724 "C<guestfs_set_subprocess_quit_callback>, "
3725 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3726 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3727 "page. Because of the ABI guarantee, the old functions continue to work."
3731 #: ../src/guestfs.pod:1678
3733 "Handles generate events when certain things happen, such as log messages "
3734 "being generated, progress messages during long-running operations, or the "
3735 "handle being closed. The API calls described below let you register a "
3736 "callback to be called when events happen. You can register multiple "
3737 "callbacks (for the same, different or overlapping sets of events), and "
3738 "individually remove callbacks. If callbacks are not removed, then they "
3739 "remain in force until the handle is closed."
3743 #: ../src/guestfs.pod:1686
3745 "In the current implementation, events are only generated synchronously: that "
3746 "means that events (and hence callbacks) can only happen while you are in the "
3747 "middle of making another libguestfs call. The callback is called in the "
3752 #: ../src/guestfs.pod:1691
3754 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3755 "unsigned integers, or a message buffer. Payloads are discussed later on."
3759 #: ../src/guestfs.pod:1695
3760 msgid "CLASSES OF EVENTS"
3764 #: ../src/guestfs.pod:1699
3765 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3769 #: ../src/guestfs.pod:1702
3771 "The callback function will be called while the handle is being closed "
3772 "(synchronously from L</guestfs_close>)."
3777 #: ../src/guestfs.pod:1705
3779 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3780 "handles that are open when the program exits. This means that this callback "
3781 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3782 "problems in higher-level languages (eg. if your HLL interpreter has already "
3783 "been cleaned up by the time this is called, and if your callback then jumps "
3784 "into some HLL function)."
3788 #: ../src/guestfs.pod:1712
3790 "If no callback is registered: the handle is closed without any callback "
3795 #: ../src/guestfs.pod:1715
3796 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3800 #: ../src/guestfs.pod:1718
3802 "The callback function will be called when the child process quits, either "
3803 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3804 "corresponds to a transition from any state to the CONFIG state)."
3808 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3809 msgid "If no callback is registered: the event is ignored."
3813 #: ../src/guestfs.pod:1724
3814 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3818 #: ../src/guestfs.pod:1727
3820 "The callback function will be called when the child process becomes ready "
3821 "first time after it has been launched. (This corresponds to a transition "
3822 "from LAUNCHING to the READY state)."
3826 #: ../src/guestfs.pod:1733
3827 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3832 #: ../src/guestfs.pod:1736
3834 "Some long-running operations can generate progress messages. If this "
3835 "callback is registered, then it will be called each time a progress message "
3836 "is generated (usually two seconds after the operation started, and three "
3837 "times per second thereafter until it completes, although the frequency may "
3838 "change in future versions)."
3842 #: ../src/guestfs.pod:1742
3844 "The callback receives in the payload four unsigned 64 bit numbers which are "
3845 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3849 #: ../src/guestfs.pod:1745
3851 "The units of C<total> are not defined, although for some operations C<total> "
3852 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3853 "or megabytes), and C<position> may be the portion which has been transferred."
3858 #: ../src/guestfs.pod:1750
3859 msgid "The only defined and stable parts of the API are:"
3864 #: ../src/guestfs.pod:1756
3866 "The callback can display to the user some type of progress bar or indicator "
3867 "which shows the ratio of C<position>:C<total>."
3872 #: ../src/guestfs.pod:1761
3873 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3877 #: ../src/guestfs.pod:1765
3879 "If any progress notification is sent during a call, then a final progress "
3880 "notification is always sent when C<position> = C<total> (I<unless> the call "
3881 "fails with an error)."
3886 #: ../src/guestfs.pod:1769
3888 "This is to simplify caller code, so callers can easily set the progress "
3889 "indicator to \"100%\" at the end of the operation, without requiring special "
3890 "code to detect this case."
3894 #: ../src/guestfs.pod:1775
3896 "For some calls we are unable to estimate the progress of the call, but we "
3897 "can still generate progress messages to indicate activity. This is known as "
3898 "\"pulse mode\", and is directly supported by certain progress bar "
3899 "implementations (eg. GtkProgressBar)."
3903 #: ../src/guestfs.pod:1780
3905 "For these calls, zero or more progress messages are generated with "
3906 "C<position = 0> and C<total = 1>, followed by a final message with "
3907 "C<position = total = 1>."
3911 #: ../src/guestfs.pod:1784
3913 "As noted above, if the call fails with an error then the final message may "
3918 #: ../src/guestfs.pod:1789
3920 "The callback also receives the procedure number (C<proc_nr>) and serial "
3921 "number (C<serial>) of the call. These are only useful for debugging "
3922 "protocol issues, and the callback can normally ignore them. The callback "
3923 "may want to print these numbers in error messages or debugging messages."
3927 #: ../src/guestfs.pod:1795
3928 msgid "If no callback is registered: progress messages are discarded."
3932 #: ../src/guestfs.pod:1797
3933 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3937 #: ../src/guestfs.pod:1800
3939 "The callback function is called whenever a log message is generated by qemu, "
3940 "the appliance kernel, guestfsd (daemon), or utility programs."
3944 #: ../src/guestfs.pod:1803
3946 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3947 "guestfs_launch>) then additional debug messages are generated."
3951 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3953 "If no callback is registered: the messages are discarded unless the verbose "
3954 "flag is set in which case they are sent to stderr. You can override the "
3955 "printing of verbose messages to stderr by setting up a callback."
3959 #: ../src/guestfs.pod:1811
3960 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3964 #: ../src/guestfs.pod:1814
3966 "The callback function is called whenever a log message is generated by the "
3967 "library part of libguestfs."
3971 #: ../src/guestfs.pod:1817
3973 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3974 "messages are generated."
3978 #: ../src/guestfs.pod:1825
3979 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3983 #: ../src/guestfs.pod:1828
3985 "The callback function is called whenever a trace message is generated. This "
3986 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3990 #: ../src/guestfs.pod:1831
3992 "If no callback is registered: the messages are sent to stderr. You can "
3993 "override the printing of trace messages to stderr by setting up a callback."
3997 #: ../src/guestfs.pod:1837
3998 msgid "guestfs_set_event_callback"
4002 #: ../src/guestfs.pod:1839
4005 " int guestfs_set_event_callback (guestfs_h *g,\n"
4006 " guestfs_event_callback cb,\n"
4007 " uint64_t event_bitmask,\n"
4014 #: ../src/guestfs.pod:1845
4016 "This function registers a callback (C<cb>) for all event classes in the "
4021 #: ../src/guestfs.pod:1848
4023 "For example, to register for all log message events, you could call this "
4024 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4025 "To register a single callback for all possible classes of events, use "
4026 "C<GUESTFS_EVENT_ALL>."
4030 #: ../src/guestfs.pod:1854
4031 msgid "C<flags> should always be passed as 0."
4035 #: ../src/guestfs.pod:1856
4037 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4038 "it for any purpose."
4042 #: ../src/guestfs.pod:1859
4044 "The return value is the event handle (an integer) which you can use to "
4045 "delete the callback (see below)."
4049 #: ../src/guestfs.pod:1862
4051 "If there is an error, this function returns C<-1>, and sets the error in the "
4052 "handle in the usual way (see L</guestfs_last_error> etc.)"
4056 #: ../src/guestfs.pod:1865
4058 "Callbacks remain in effect until they are deleted, or until the handle is "
4063 #: ../src/guestfs.pod:1868
4065 "In the case where multiple callbacks are registered for a particular event "
4066 "class, all of the callbacks are called. The order in which multiple "
4067 "callbacks are called is not defined."
4071 #: ../src/guestfs.pod:1872
4072 msgid "guestfs_delete_event_callback"
4076 #: ../src/guestfs.pod:1874
4079 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4084 #: ../src/guestfs.pod:1876
4086 "Delete a callback that was previously registered. C<event_handle> should be "
4087 "the integer that was returned by a previous call to "
4088 "C<guestfs_set_event_callback> on the same handle."
4092 #: ../src/guestfs.pod:1880
4093 msgid "guestfs_event_callback"
4097 #: ../src/guestfs.pod:1882
4100 " typedef void (*guestfs_event_callback) (\n"
4103 " uint64_t event,\n"
4104 " int event_handle,\n"
4106 " const char *buf, size_t buf_len,\n"
4107 " const uint64_t *array, size_t array_len);\n"
4112 #: ../src/guestfs.pod:1891
4114 "This is the type of the event callback function that you have to provide."
4118 #: ../src/guestfs.pod:1894
4120 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4121 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4122 "handle, and C<flags> which in the current API you should ignore."
4126 #: ../src/guestfs.pod:1898
4128 "The remaining parameters contain the event payload (if any). Each event may "
4129 "contain a payload, which usually relates to the event class, but for future "
4130 "proofing your code should be written to handle any payload for any event "
4135 #: ../src/guestfs.pod:1903
4137 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4138 "there is no message buffer). Note that this message buffer can contain "
4139 "arbitrary 8 bit data, including NUL bytes."
4143 #: ../src/guestfs.pod:1907
4145 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4146 "moment this is only used for progress messages."
4150 #: ../src/guestfs.pod:1910
4151 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4155 #: ../src/guestfs.pod:1912
4157 "One motivation for the generic event API was to allow GUI programs to "
4158 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4159 "unconditionally to C<stderr>."
4163 #: ../src/guestfs.pod:1916
4165 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4166 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4167 "messages are not events; you must capture error messages separately)."
4171 #: ../src/guestfs.pod:1921
4173 "Programs have to set up a callback to capture the classes of events of "
4178 #: ../src/guestfs.pod:1924
4182 " guestfs_set_event_callback\n"
4183 " (g, message_callback,\n"
4184 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4185 " GUESTFS_EVENT_TRACE,\n"
4186 " 0, NULL) == -1)\n"
4187 " if (eh == -1) {\n"
4188 " // handle error in the usual way\n"
4194 #: ../src/guestfs.pod:1934
4196 "The callback can then direct messages to the appropriate place. In this "
4197 "example, messages are directed to syslog:"
4201 #: ../src/guestfs.pod:1937
4205 " message_callback (\n"
4208 " uint64_t event,\n"
4209 " int event_handle,\n"
4211 " const char *buf, size_t buf_len,\n"
4212 " const uint64_t *array, size_t array_len)\n"
4214 " const int priority = LOG_USER|LOG_INFO;\n"
4215 " if (buf_len > 0)\n"
4216 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4223 #: ../src/guestfs.pod:1952
4224 msgid "PRIVATE DATA AREA"
4228 #: ../src/guestfs.pod:1954
4230 "You can attach named pieces of private data to the libguestfs handle, fetch "
4231 "them by name, and walk over them, for the lifetime of the handle. This is "
4232 "called the private data area and is only available from the C API."
4237 #: ../src/guestfs.pod:1959
4238 msgid "To attach a named piece of data, use the following call:"
4243 #: ../src/guestfs.pod:1961
4246 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4251 #: ../src/guestfs.pod:1963
4253 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4254 "pointer (which can be C<NULL>). Any previous item with the same key is "
4259 #: ../src/guestfs.pod:1967
4261 "You can use any C<key> you want, but your key should I<not> start with an "
4262 "underscore character. Keys beginning with an underscore character are "
4263 "reserved for internal libguestfs purposes (eg. for implementing language "
4264 "bindings). It is recommended that you prefix the key with some unique "
4265 "string to avoid collisions with other users."
4270 #: ../src/guestfs.pod:1973
4271 msgid "To retrieve the pointer, use:"
4276 #: ../src/guestfs.pod:1975
4279 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4285 #: ../src/guestfs.pod:1977
4287 "This function returns C<NULL> if either no data is found associated with "
4288 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4293 #: ../src/guestfs.pod:1981
4295 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4296 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4297 "all. In particular, libguestfs does I<not> try to free the data when the "
4298 "handle is closed. If the data must be freed, then the caller must either "
4299 "free it before calling L</guestfs_close> or must set up a close callback to "
4300 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4304 #: ../src/guestfs.pod:1988
4305 msgid "To walk over all entries, use these two functions:"
4309 #: ../src/guestfs.pod:1990
4312 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4317 #: ../src/guestfs.pod:1992
4320 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4325 #: ../src/guestfs.pod:1994
4327 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4328 "not have any particular meaning -- keys are not returned in any defined "
4329 "order). A pointer to the key is returned in C<*key_rtn> and the "
4330 "corresponding data pointer is returned from the function. C<NULL> is "
4331 "returned if there are no keys stored in the handle."
4335 #: ../src/guestfs.pod:2000
4337 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4338 "value of this function is also C<NULL> is there are no further entries to "
4343 #: ../src/guestfs.pod:2004
4344 msgid "Notes about walking over entries:"
4348 #: ../src/guestfs.pod:2010
4350 "You must not call C<guestfs_set_private> while walking over the entries."
4354 #: ../src/guestfs.pod:2015
4356 "The handle maintains an internal iterator which is reset when you call "
4357 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4358 "call C<guestfs_set_private>."
4362 #: ../src/guestfs.pod:2021
4363 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4367 #: ../src/guestfs.pod:2023
4370 " guestfs_set_private (g, key, NULL);\n"
4375 #: ../src/guestfs.pod:2025
4376 msgid "then that C<key> is not returned when walking."
4380 #: ../src/guestfs.pod:2029
4382 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4383 "C<guestfs_next_private> or C<guestfs_set_private>."
4387 #: ../src/guestfs.pod:2035
4389 "The following example code shows how to print all keys and data pointers "
4390 "that are associated with the handle C<g>:"
4394 #: ../src/guestfs.pod:2038
4397 " const char *key;\n"
4398 " void *data = guestfs_first_private (g, &key);\n"
4399 " while (data != NULL)\n"
4401 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4402 " data = guestfs_next_private (g, &key);\n"
4408 #: ../src/guestfs.pod:2046
4410 "More commonly you are only interested in keys that begin with an application-"
4411 "specific prefix C<foo_>. Modify the loop like so:"
4415 #: ../src/guestfs.pod:2049
4418 " const char *key;\n"
4419 " void *data = guestfs_first_private (g, &key);\n"
4420 " while (data != NULL)\n"
4422 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4423 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4424 " data = guestfs_next_private (g, &key);\n"
4430 #: ../src/guestfs.pod:2058
4432 "If you need to modify keys while walking, then you have to jump back to the "
4433 "beginning of the loop. For example, to delete all keys prefixed with "
4438 #: ../src/guestfs.pod:2062
4441 " const char *key;\n"
4444 " data = guestfs_first_private (g, &key);\n"
4445 " while (data != NULL)\n"
4447 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4449 " guestfs_set_private (g, key, NULL);\n"
4450 " /* note that 'key' pointer is now invalid, and so is\n"
4451 " the internal iterator */\n"
4454 " data = guestfs_next_private (g, &key);\n"
4460 #: ../src/guestfs.pod:2078
4462 "Note that the above loop is guaranteed to terminate because the keys are "
4463 "being deleted, but other manipulations of keys within the loop might not "
4464 "terminate unless you also maintain an indication of which keys have been "
4470 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4476 #: ../src/guestfs.pod:2085
4478 "<!-- old anchor for the next section --> <a name="
4479 "\"state_machine_and_low_level_event_api\"/>"
4484 #: ../src/guestfs.pod:2090
4485 msgid "ARCHITECTURE"
4490 #: ../src/guestfs.pod:2092
4492 "Internally, libguestfs is implemented by running an appliance (a special "
4493 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4494 "process of the main program."
4499 #: ../src/guestfs.pod:2096
4502 " ___________________\n"
4504 " | main program |\n"
4506 " | | child process / appliance\n"
4507 " | | __________________________\n"
4509 " +-------------------+ RPC | +-----------------+ |\n"
4510 " | libguestfs <--------------------> guestfsd | |\n"
4511 " | | | +-----------------+ |\n"
4512 " \\___________________/ | | Linux kernel | |\n"
4513 " | +--^--------------+ |\n"
4514 " \\_________|________________/\n"
4520 " \\______________/\n"
4526 #: ../src/guestfs.pod:2116
4528 "The library, linked to the main program, creates the child process and hence "
4529 "the appliance in the L</guestfs_launch> function."
4534 #: ../src/guestfs.pod:2119
4536 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4537 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4538 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4539 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4540 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4541 "attached to the qemu process which translates device access by the "
4542 "appliance's Linux kernel into accesses to the image."
4547 #: ../src/guestfs.pod:2128
4549 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4550 "Although the disk image you are attached to might also be used by some "
4551 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4552 "care if both libguestfs's qemu process and your virtual machine are trying "
4553 "to update the disk image at the same time, since these usually results in "
4554 "massive disk corruption)."
4559 #: ../src/guestfs.pod:2135
4560 msgid "STATE MACHINE"
4565 #: ../src/guestfs.pod:2137
4566 msgid "libguestfs uses a state machine to model the child process:"
4571 #: ../src/guestfs.pod:2139
4583 " / | \\ \\ guestfs_launch\n"
4584 " / | _\\__V______\n"
4586 " / | | LAUNCHING |\n"
4587 " / | \\___________/\n"
4589 " / | guestfs_launch\n"
4591 " ______ / __|____V\n"
4592 " / \\ ------> / \\\n"
4593 " | BUSY | | READY |\n"
4594 " \\______/ <------ \\________/\n"
4600 #: ../src/guestfs.pod:2161
4602 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4603 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4604 "(3) alternating between READY and BUSY as commands are issued to, and "
4605 "carried out by, the child process."
4610 #: ../src/guestfs.pod:2166
4612 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4613 "asynchronously at any time (eg. due to some internal error), and that causes "
4614 "the state to transition back to CONFIG."
4619 #: ../src/guestfs.pod:2170
4621 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4622 "issued when in the CONFIG state."
4627 #: ../src/guestfs.pod:2173
4629 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4630 "L</guestfs_launch> blocks until the child process is READY to accept "
4631 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4632 "moves the state from CONFIG to LAUNCHING while it is running."
4637 #: ../src/guestfs.pod:2179
4639 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4640 "state. These API calls block waiting for the command to be carried out (ie. "
4641 "the state to transition to BUSY and then back to READY). There are no non-"
4642 "blocking versions, and no way to issue more than one command per handle at "
4648 #: ../src/guestfs.pod:2185
4650 "Finally, the child process sends asynchronous messages back to the main "
4651 "program, such as kernel log messages. You can register a callback to "
4652 "receive these messages."
4657 #: ../src/guestfs.pod:2189
4663 #: ../src/guestfs.pod:2191
4664 msgid "COMMUNICATION PROTOCOL"
4669 #: ../src/guestfs.pod:2193
4671 "Don't rely on using this protocol directly. This section documents how it "
4672 "currently works, but it may change at any time."
4677 #: ../src/guestfs.pod:2196
4679 "The protocol used to talk between the library and the daemon running inside "
4680 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4681 "1014, RFC 1832, RFC 4506)."
4686 #: ../src/guestfs.pod:2200
4688 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4689 "this file is automatically generated)."
4694 #: ../src/guestfs.pod:2203
4696 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4697 "and C<FileOut> parameters, which are handled with very simple request/reply "
4698 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4699 "parameters, which use the same request and reply messages, but they may also "
4700 "be followed by files sent using a chunked encoding."
4705 #: ../src/guestfs.pod:2210
4706 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4711 #: ../src/guestfs.pod:2212
4712 msgid "For ordinary functions, the request message is:"
4717 #: ../src/guestfs.pod:2214
4720 " total length (header + arguments,\n"
4721 " but not including the length word itself)\n"
4722 " struct guestfs_message_header (encoded as XDR)\n"
4723 " struct guestfs_<foo>_args (encoded as XDR)\n"
4729 #: ../src/guestfs.pod:2219
4731 "The total length field allows the daemon to allocate a fixed size buffer "
4732 "into which it slurps the rest of the message. As a result, the total length "
4733 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4734 "effective size of any request is limited to somewhere under this size."
4739 #: ../src/guestfs.pod:2225
4741 "Note also that many functions don't take any arguments, in which case the "
4742 "C<guestfs_I<foo>_args> is completely omitted."
4747 #: ../src/guestfs.pod:2228
4749 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4750 "receiver knows what type of args structure to expect, or none at all."
4755 #: ../src/guestfs.pod:2232
4757 "For functions that take optional arguments, the optional arguments are "
4758 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4759 "arguments. A bitmask in the header indicates which optional arguments are "
4760 "meaningful. The bitmask is also checked to see if it contains bits set "
4761 "which the daemon does not know about (eg. if more optional arguments were "
4762 "added in a later version of the library), and this causes the call to be "
4768 #: ../src/guestfs.pod:2240
4769 msgid "The reply message for ordinary functions is:"
4774 #: ../src/guestfs.pod:2242
4777 " total length (header + ret,\n"
4778 " but not including the length word itself)\n"
4779 " struct guestfs_message_header (encoded as XDR)\n"
4780 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4786 #: ../src/guestfs.pod:2247
4788 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4789 "functions that return no formal return values."
4794 #: ../src/guestfs.pod:2250
4796 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4801 #: ../src/guestfs.pod:2253
4803 "In the case of an error, a flag is set in the header, and the reply message "
4804 "is slightly changed:"
4809 #: ../src/guestfs.pod:2256
4812 " total length (header + error,\n"
4813 " but not including the length word itself)\n"
4814 " struct guestfs_message_header (encoded as XDR)\n"
4815 " struct guestfs_message_error (encoded as XDR)\n"
4821 #: ../src/guestfs.pod:2261
4823 "The C<guestfs_message_error> structure contains the error message as a "
4829 #: ../src/guestfs.pod:2264
4830 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4835 #: ../src/guestfs.pod:2266
4837 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4838 "The normal request message is sent (see above). However this is followed by "
4839 "a sequence of file chunks."
4844 #: ../src/guestfs.pod:2270
4847 " total length (header + arguments,\n"
4848 " but not including the length word itself,\n"
4849 " and not including the chunks)\n"
4850 " struct guestfs_message_header (encoded as XDR)\n"
4851 " struct guestfs_<foo>_args (encoded as XDR)\n"
4852 " sequence of chunks for FileIn param #0\n"
4853 " sequence of chunks for FileIn param #1 etc.\n"
4859 #: ../src/guestfs.pod:2278
4860 msgid "The \"sequence of chunks\" is:"
4865 #: ../src/guestfs.pod:2280
4868 " length of chunk (not including length word itself)\n"
4869 " struct guestfs_chunk (encoded as XDR)\n"
4870 " length of chunk\n"
4871 " struct guestfs_chunk (encoded as XDR)\n"
4873 " length of chunk\n"
4874 " struct guestfs_chunk (with data.data_len == 0)\n"
4880 #: ../src/guestfs.pod:2288
4882 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4883 "is set in the final chunk to indicate either successful completion or early "
4889 #: ../src/guestfs.pod:2292
4891 "At time of writing there are no functions that have more than one FileIn "
4892 "parameter. However this is (theoretically) supported, by sending the "
4893 "sequence of chunks for each FileIn parameter one after another (from left to "
4899 #: ../src/guestfs.pod:2297
4901 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4902 "transfer. The library does this by sending a chunk with a special flag set "
4903 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4904 "RPC, does I<not> send any reply, and goes back to reading the next request."
4909 #: ../src/guestfs.pod:2303
4911 "The daemon may also cancel. It does this by writing a special word "
4912 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4913 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4914 "cancel chunk). The special word is chosen so that even if cancellation "
4915 "happens right at the end of the transfer (after the library has finished "
4916 "writing and has started listening for the reply), the \"spurious\" cancel "
4917 "flag will not be confused with the reply message."
4922 #: ../src/guestfs.pod:2312
4924 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4925 "limit), and also files where the size is not known in advance (eg. from "
4926 "pipes or sockets). However the chunks are rather small "
4927 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4928 "to keep much in memory."
4933 #: ../src/guestfs.pod:2318
4934 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4939 #: ../src/guestfs.pod:2320
4941 "The protocol for FileOut parameters is exactly the same as for FileIn "
4942 "parameters, but with the roles of daemon and library reversed."
4947 #: ../src/guestfs.pod:2323
4950 " total length (header + ret,\n"
4951 " but not including the length word itself,\n"
4952 " and not including the chunks)\n"
4953 " struct guestfs_message_header (encoded as XDR)\n"
4954 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4955 " sequence of chunks for FileOut param #0\n"
4956 " sequence of chunks for FileOut param #1 etc.\n"
4962 #: ../src/guestfs.pod:2331
4963 msgid "INITIAL MESSAGE"
4968 #: ../src/guestfs.pod:2333
4970 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4971 "which indicates that the guest and daemon is alive. This is what L</"
4972 "guestfs_launch> waits for."
4977 #: ../src/guestfs.pod:2337
4978 msgid "PROGRESS NOTIFICATION MESSAGES"
4983 #: ../src/guestfs.pod:2339
4985 "The daemon may send progress notification messages at any time. These are "
4986 "distinguished by the normal length word being replaced by "
4987 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4991 #: ../src/guestfs.pod:2343
4993 "The library turns them into progress callbacks (see L</"
4994 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5000 #: ../src/guestfs.pod:2347
5002 "The daemon self-limits the frequency of progress messages it sends (see "
5003 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5009 #: ../src/guestfs.pod:2351
5010 msgid "LIBGUESTFS VERSION NUMBERS"
5015 #: ../src/guestfs.pod:2353
5017 "Since April 2010, libguestfs has started to make separate development and "
5018 "stable releases, along with corresponding branches in our git repository. "
5019 "These separate releases can be identified by version number:"
5024 #: ../src/guestfs.pod:2358
5027 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5028 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5034 " | `-------- sub-version\n"
5036 " `------ always '1' because we don't change the ABI\n"
5042 #: ../src/guestfs.pod:2369
5043 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5048 #: ../src/guestfs.pod:2371
5050 "As time passes we cherry pick fixes from the development branch and backport "
5051 "those into the stable branch, the effect being that the stable branch should "
5052 "get more stable and less buggy over time. So the stable releases are ideal "
5053 "for people who don't need new features but would just like the software to "
5059 #: ../src/guestfs.pod:2377
5060 msgid "Our criteria for backporting changes are:"
5065 #: ../src/guestfs.pod:2383
5067 "Documentation changes which don't affect any code are backported unless the "
5068 "documentation refers to a future feature which is not in stable."
5073 #: ../src/guestfs.pod:2389
5075 "Bug fixes which are not controversial, fix obvious problems, and have been "
5076 "well tested are backported."
5081 #: ../src/guestfs.pod:2394
5083 "Simple rearrangements of code which shouldn't affect how it works get "
5084 "backported. This is so that the code in the two branches doesn't get too "
5085 "far out of step, allowing us to backport future fixes more easily."
5090 #: ../src/guestfs.pod:2400
5092 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5093 "exceptional case: the new feature is required in order to implement an "
5094 "important bug fix."
5099 #: ../src/guestfs.pod:2406
5101 "A new stable branch starts when we think the new features in development are "
5102 "substantial and compelling enough over the current stable branch to warrant "
5103 "it. When that happens we create new stable and development versions 1.N.0 "
5104 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5105 "stable at this point, but by backporting fixes from development, that branch "
5106 "will stabilize over time."
5110 #: ../src/guestfs.pod:2414
5111 msgid "EXTENDING LIBGUESTFS"
5115 #: ../src/guestfs.pod:2416
5116 msgid "ADDING A NEW API ACTION"
5120 #: ../src/guestfs.pod:2418
5122 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5123 "documentation) are generated, and this makes it easy to extend the "
5128 #: ../src/guestfs.pod:2422
5129 msgid "To add a new API action there are two changes:"
5133 #: ../src/guestfs.pod:2428
5135 "You need to add a description of the call (name, parameters, return type, "
5136 "tests, documentation) to C<generator/generator_actions.ml>."
5140 #: ../src/guestfs.pod:2431
5142 "There are two sorts of API action, depending on whether the call goes "
5143 "through to the daemon in the appliance, or is serviced entirely by the "
5144 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5145 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5146 "an example of the latter, since a trace flag is maintained in the handle and "
5147 "all tracing is done on the library side."
5151 #: ../src/guestfs.pod:2439
5153 "Most new actions are of the first type, and get added to the "
5154 "C<daemon_functions> list. Each function has a unique procedure number used "
5155 "in the RPC protocol which is assigned to that action when we publish "
5156 "libguestfs and cannot be reused. Take the latest procedure number and "
5161 #: ../src/guestfs.pod:2445
5163 "For library-only actions of the second type, add to the "
5164 "C<non_daemon_functions> list. Since these functions are serviced by the "
5165 "library and do not travel over the RPC mechanism to the daemon, these "
5166 "functions do not need a procedure number, and so the procedure number is set "
5171 #: ../src/guestfs.pod:2453
5172 msgid "Implement the action (in C):"
5176 #: ../src/guestfs.pod:2455
5178 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5179 "C<daemon/> directory."
5183 #: ../src/guestfs.pod:2458
5185 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5186 "(note: double underscore) in the C<src/> directory."
5190 #: ../src/guestfs.pod:2461
5191 msgid "In either case, use another function as an example of what to do."
5195 #: ../src/guestfs.pod:2465
5196 msgid "After making these changes, use C<make> to compile."
5200 #: ../src/guestfs.pod:2467
5202 "Note that you don't need to implement the RPC, language bindings, manual "
5203 "pages or anything else. It's all automatically generated from the OCaml "
5208 #: ../src/guestfs.pod:2471
5209 msgid "ADDING TESTS FOR AN API ACTION"
5213 #: ../src/guestfs.pod:2473
5215 "You can supply zero or as many tests as you want per API call. The tests "
5216 "can either be added as part of the API description (C<generator/"
5217 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5218 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5219 "slower, so if possible use the first method."
5223 #: ../src/guestfs.pod:2479
5225 "The following describes the test environment used when you add an API test "
5226 "in C<generator_actions.ml>."
5230 #: ../src/guestfs.pod:2482
5231 msgid "The test environment has 4 block devices:"
5235 #: ../src/guestfs.pod:2486
5236 msgid "C</dev/sda> 500MB"
5240 #: ../src/guestfs.pod:2488
5241 msgid "General block device for testing."
5245 #: ../src/guestfs.pod:2490
5246 msgid "C</dev/sdb> 50MB"
5250 #: ../src/guestfs.pod:2492
5252 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5257 #: ../src/guestfs.pod:2495
5258 msgid "C</dev/sdc> 10MB"
5262 #: ../src/guestfs.pod:2497
5263 msgid "Used in a few tests where two block devices are needed."
5267 #: ../src/guestfs.pod:2499
5272 #: ../src/guestfs.pod:2501
5273 msgid "ISO with fixed content (see C<images/test.iso>)."
5277 #: ../src/guestfs.pod:2505
5279 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5280 "appliance and block devices are reused between tests. So don't try testing "
5281 "L</guestfs_kill_subprocess> :-x"
5285 #: ../src/guestfs.pod:2509
5287 "Each test starts with an initial scenario, selected using one of the "
5288 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5289 "initialize the disks mentioned above in a particular way as documented in "
5290 "C<generator_types.ml>. You should not assume anything about the previous "
5291 "contents of other disks that are not initialized."
5295 #: ../src/guestfs.pod:2515
5297 "You can add a prerequisite clause to any individual test. This is a run-"
5298 "time check, which, if it fails, causes the test to be skipped. Useful if "
5299 "testing a command which might not work on all variations of libguestfs "
5300 "builds. A test that has prerequisite of C<Always> means to run "
5305 #: ../src/guestfs.pod:2521
5307 "In addition, packagers can skip individual tests by setting environment "
5308 "variables before running C<make check>."
5312 #: ../src/guestfs.pod:2524
5315 " SKIP_TEST_<CMD>_<NUM>=1\n"
5320 #: ../src/guestfs.pod:2526
5321 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5325 #: ../src/guestfs.pod:2528
5330 #: ../src/guestfs.pod:2530
5333 " SKIP_TEST_<CMD>=1\n"
5338 #: ../src/guestfs.pod:2532
5339 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5343 #: ../src/guestfs.pod:2534
5344 msgid "Packagers can run only certain tests by setting for example:"
5348 #: ../src/guestfs.pod:2536
5351 " TEST_ONLY=\"vfs_type zerofree\"\n"
5356 #: ../src/guestfs.pod:2538
5358 "See C<capitests/tests.c> for more details of how these environment variables "
5363 #: ../src/guestfs.pod:2541
5364 msgid "DEBUGGING NEW API ACTIONS"
5368 #: ../src/guestfs.pod:2543
5369 msgid "Test new actions work before submitting them."
5373 #: ../src/guestfs.pod:2545
5374 msgid "You can use guestfish to try out new commands."
5378 #: ../src/guestfs.pod:2547
5380 "Debugging the daemon is a problem because it runs inside a minimal "
5381 "environment. However you can fprintf messages in the daemon to stderr, and "
5382 "they will show up if you use C<guestfish -v>."
5386 #: ../src/guestfs.pod:2551
5387 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5391 #: ../src/guestfs.pod:2553
5393 "Our C source code generally adheres to some basic code-formatting "
5394 "conventions. The existing code base is not totally consistent on this "
5395 "front, but we do prefer that contributed code be formatted similarly. In "
5396 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5397 "indentation level, and other than that, follow the K&R style."
5401 #: ../src/guestfs.pod:2559
5403 "If you use Emacs, add the following to one of one of your start-up files (e."
5404 "g., ~/.emacs), to help ensure that you get indentation right:"
5408 #: ../src/guestfs.pod:2562
5411 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5412 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5413 " (add-hook 'find-file-hook\n"
5414 " '(lambda () (if (and buffer-file-name\n"
5415 " (string-match \"/libguestfs\\\\>\"\n"
5416 " (buffer-file-name))\n"
5417 " (not (string-equal mode-name \"Change Log\"))\n"
5418 " (not (string-equal mode-name \"Makefile\")))\n"
5419 " (setq indent-tabs-mode nil))))\n"
5424 #: ../src/guestfs.pod:2572
5427 " ;;; When editing C sources in libguestfs, use this style.\n"
5428 " (defun libguestfs-c-mode ()\n"
5429 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5431 " (c-set-style \"K&R\")\n"
5432 " (setq c-indent-level 2)\n"
5433 " (setq c-basic-offset 2))\n"
5434 " (add-hook 'c-mode-hook\n"
5435 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5436 " (buffer-file-name))\n"
5437 " (libguestfs-c-mode))))\n"
5442 #: ../src/guestfs.pod:2584
5443 msgid "Enable warnings when compiling (and fix any problems this finds):"
5447 #: ../src/guestfs.pod:2587
5450 " ./configure --enable-gcc-warnings\n"
5455 #: ../src/guestfs.pod:2589
5456 msgid "Useful targets are:"
5460 #: ../src/guestfs.pod:2591
5463 " make syntax-check # checks the syntax of the C code\n"
5464 " make check # runs the test suite\n"
5469 #: ../src/guestfs.pod:2594
5470 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5474 #: ../src/guestfs.pod:2596
5476 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5477 "which are used to do shell quoting."
5481 #: ../src/guestfs.pod:2601
5486 #: ../src/guestfs.pod:2603
5488 "Simple shell quoted string. Any spaces or other shell characters are "
5493 #: ../src/guestfs.pod:2606
5498 #: ../src/guestfs.pod:2608
5500 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5506 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5507 msgid "For example:"
5511 #: ../src/guestfs.pod:2615
5514 " asprintf (&cmd, \"cat %R\", path);\n"
5519 #: ../src/guestfs.pod:2617
5520 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5524 #: ../src/guestfs.pod:2619
5526 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5527 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5528 "they are not passed via the shell (instead, straight to exec). You probably "
5529 "want to use the C<sysroot_path()> function however."
5533 #: ../src/guestfs.pod:2625
5534 msgid "SUBMITTING YOUR NEW API ACTIONS"
5538 #: ../src/guestfs.pod:2627
5540 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5541 "libguestfs> and CC to L<rjones@redhat.com>."
5545 #: ../src/guestfs.pod:2631
5546 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5550 #: ../src/guestfs.pod:2633
5551 msgid "We support i18n (gettext anyhow) in the library."
5555 #: ../src/guestfs.pod:2635
5557 "However many messages come from the daemon, and we don't translate those at "
5558 "the moment. One reason is that the appliance generally has all locale files "
5559 "removed from it, because they take up a lot of space. So we'd have to readd "
5560 "some of those, as well as copying our PO files into the appliance."
5564 #: ../src/guestfs.pod:2641
5566 "Debugging messages are never translated, since they are intended for the "
5571 #: ../src/guestfs.pod:2644
5572 msgid "SOURCE CODE SUBDIRECTORIES"
5576 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:6163
5577 #: ../fish/guestfish-actions.pod:4066
5578 msgid "C<appliance>"
5582 #: ../src/guestfs.pod:2650
5583 msgid "The libguestfs appliance, build scripts and so on."
5587 #: ../src/guestfs.pod:2652
5588 msgid "C<capitests>"
5592 #: ../src/guestfs.pod:2654
5593 msgid "Automated tests of the C API."
5597 #: ../src/guestfs.pod:2656
5602 #: ../src/guestfs.pod:2658
5604 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5609 #: ../src/guestfs.pod:2661
5614 #: ../src/guestfs.pod:2663
5616 "Safety and liveness tests of components that libguestfs depends upon (not of "
5617 "libguestfs itself). Mainly this is for qemu and the kernel."
5621 #: ../src/guestfs.pod:2666
5626 #: ../src/guestfs.pod:2668
5627 msgid "Outside contributions, experimental parts."
5631 #: ../src/guestfs.pod:2670
5636 #: ../src/guestfs.pod:2672
5638 "The daemon that runs inside the libguestfs appliance and carries out actions."
5642 #: ../src/guestfs.pod:2675
5647 #: ../src/guestfs.pod:2677
5648 msgid "L<virt-df(1)> command and documentation."
5652 #: ../src/guestfs.pod:2679
5657 #: ../src/guestfs.pod:2681
5658 msgid "L<virt-edit(1)> command and documentation."
5662 #: ../src/guestfs.pod:2683
5667 #: ../src/guestfs.pod:2685
5668 msgid "C API example code."
5672 #: ../src/guestfs.pod:2687
5677 #: ../src/guestfs.pod:2689
5679 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5680 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5681 "L<virt-tar-out(1)>."
5685 #: ../src/guestfs.pod:2693
5690 #: ../src/guestfs.pod:2695
5692 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5696 #: ../src/guestfs.pod:2697
5697 msgid "C<generator>"
5701 #: ../src/guestfs.pod:2699
5703 "The crucially important generator, used to automatically generate large "
5704 "amounts of boilerplate C code for things like RPC and bindings."
5708 #: ../src/guestfs.pod:2702
5713 #: ../src/guestfs.pod:2704
5714 msgid "Files used by the test suite."
5718 #: ../src/guestfs.pod:2706
5719 msgid "Some \"phony\" guest images which we test against."
5723 #: ../src/guestfs.pod:2708
5724 msgid "C<inspector>"
5728 #: ../src/guestfs.pod:2710
5729 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5733 #: ../src/guestfs.pod:2712
5738 #: ../src/guestfs.pod:2714
5739 msgid "Logo used on the website. The fish is called Arthur by the way."
5743 #: ../src/guestfs.pod:2716
5748 #: ../src/guestfs.pod:2718
5749 msgid "M4 macros used by autoconf."
5753 #: ../src/guestfs.pod:2720
5758 #: ../src/guestfs.pod:2722
5759 msgid "Translations of simple gettext strings."
5763 #: ../src/guestfs.pod:2724
5768 #: ../src/guestfs.pod:2726
5770 "The build infrastructure and PO files for translations of manpages and POD "
5771 "files. Eventually this will be combined with the C<po> directory, but that "
5772 "is rather complicated."
5776 #: ../src/guestfs.pod:2730
5777 msgid "C<regressions>"
5781 #: ../src/guestfs.pod:2732
5782 msgid "Regression tests."
5786 #: ../src/guestfs.pod:2734
5791 #: ../src/guestfs.pod:2736
5792 msgid "L<virt-rescue(1)> command and documentation."
5796 #: ../src/guestfs.pod:2738
5801 #: ../src/guestfs.pod:2740
5802 msgid "Source code to the C library."
5806 #: ../src/guestfs.pod:2742
5811 #: ../src/guestfs.pod:2744
5812 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5816 #: ../src/guestfs.pod:2746
5817 msgid "C<test-tool>"
5821 #: ../src/guestfs.pod:2748
5823 "Test tool for end users to test if their qemu/kernel combination will work "
5828 #: ../src/guestfs.pod:2751
5833 #: ../src/guestfs.pod:2753
5838 #: ../src/guestfs.pod:2755
5843 #: ../src/guestfs.pod:2757
5848 #: ../src/guestfs.pod:2759
5853 #: ../src/guestfs.pod:2761
5858 #: ../src/guestfs.pod:2763
5863 #: ../src/guestfs.pod:2765
5868 #: ../src/guestfs.pod:2767
5869 msgid "Language bindings."
5873 #: ../src/guestfs.pod:2771
5879 #: ../src/guestfs.pod:2773
5880 msgid "PROTOCOL LIMITS"
5885 #: ../src/guestfs.pod:2775
5887 "Internally libguestfs uses a message-based protocol to pass API calls and "
5888 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5889 "plenty more detail about this). The maximum message size used by the "
5890 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5891 "aware of this limit. The API calls which may be affected are individually "
5892 "documented, with a link back to this section of the documentation."
5897 #: ../src/guestfs.pod:2783
5899 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5900 "a simple string. Because this string is at some point internally encoded as "
5901 "a message, the maximum size that it can return is slightly under 4 MB. If "
5902 "the requested file is larger than this then you will get an error."
5907 #: ../src/guestfs.pod:2789
5909 "In order to transfer large files into and out of the guest filesystem, you "
5910 "need to use particular calls that support this. The sections L</UPLOADING> "
5911 "and L</DOWNLOADING> document how to do this."
5916 #: ../src/guestfs.pod:2793
5918 "You might also consider mounting the disk image using our FUSE filesystem "
5919 "support (L<guestmount(1)>)."
5923 #: ../src/guestfs.pod:2796
5924 msgid "MAXIMUM NUMBER OF DISKS"
5928 #: ../src/guestfs.pod:2798
5929 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5933 #: ../src/guestfs.pod:2801
5935 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5936 "slots. However febootstrap only understands disks with names C</dev/vda> "
5937 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5942 #: ../src/guestfs.pod:2806
5944 "We are working to substantially raise this limit in future versions but it "
5945 "requires complex changes to qemu."
5949 #: ../src/guestfs.pod:2809
5951 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5952 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5953 "requires changes to qemu."
5957 #: ../src/guestfs.pod:2813
5958 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5962 #: ../src/guestfs.pod:2815
5963 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5967 #: ../src/guestfs.pod:2817
5969 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5970 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5974 #: ../src/guestfs.pod:2820
5976 "If you attach a disk with more than 15 partitions, the extra partitions are "
5977 "ignored by libguestfs."
5981 #: ../src/guestfs.pod:2823
5982 msgid "MAXIMUM SIZE OF A DISK"
5986 #: ../src/guestfs.pod:2825
5987 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5991 #: ../src/guestfs.pod:2827
5993 "We have tested block devices up to 1 exabyte (2**60 or "
5994 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5999 #: ../src/guestfs.pod:2831
6001 "Although libguestfs probably does not impose any limit, the underlying host "
6002 "storage will. If you store disk images on a host ext4 filesystem, then the "
6003 "maximum size will be limited by the maximum ext4 file size (currently 16 "
6004 "TB). If you store disk images as host logical volumes then you are limited "
6005 "by the maximum size of an LV."
6009 #: ../src/guestfs.pod:2837
6011 "For the hugest disk image files, we recommend using XFS on the host for "
6016 #: ../src/guestfs.pod:2840
6017 msgid "MAXIMUM SIZE OF A PARTITION"
6021 #: ../src/guestfs.pod:2842
6023 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6024 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6025 "address a partition located beyond 2 TB on the disk."
6029 #: ../src/guestfs.pod:2846
6031 "It is recommended that you use GPT partitions on disks which are larger than "
6032 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6033 "which are theoretically larger than the largest disk we could support."
6037 #: ../src/guestfs.pod:2851
6038 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6042 #: ../src/guestfs.pod:2853
6044 "This depends on the filesystem type. libguestfs itself does not impose any "
6045 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6046 "what these limits are."
6050 #: ../src/guestfs.pod:2857
6051 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6055 #: ../src/guestfs.pod:2859
6057 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6058 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6059 "uploads and downloads."
6063 #: ../src/guestfs.pod:2863
6064 msgid "INSPECTION LIMITS"
6068 #: ../src/guestfs.pod:2865
6070 "The inspection code has several arbitrary limits on things like the size of "
6071 "Windows Registry hive it will read, and the length of product name. These "
6072 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6073 "memory and disk space on the host, and should not be reached in practice. "
6074 "See the source code for more information."
6079 #: ../src/guestfs.pod:2871 ../fish/guestfish.pod:1017
6080 #: ../test-tool/libguestfs-test-tool.pod:82
6081 msgid "ENVIRONMENT VARIABLES"
6086 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1048
6087 msgid "LIBGUESTFS_APPEND"
6092 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1050
6093 msgid "Pass additional options to the guest kernel."
6098 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
6099 msgid "LIBGUESTFS_DEBUG"
6104 #: ../src/guestfs.pod:2881
6106 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6107 "effect as calling C<guestfs_set_verbose (g, 1)>."
6112 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
6113 msgid "LIBGUESTFS_MEMSIZE"
6118 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
6120 "Set the memory allocated to the qemu process, in megabytes. For example:"
6125 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1062
6128 " LIBGUESTFS_MEMSIZE=700\n"
6134 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
6135 msgid "LIBGUESTFS_PATH"
6139 #: ../src/guestfs.pod:2893
6141 "Set the path that libguestfs uses to search for a supermin appliance. See "
6142 "the discussion of paths in section L</PATH> above."
6147 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1069
6148 msgid "LIBGUESTFS_QEMU"
6153 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1071
6155 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6156 "which was found at compile time by the configure script is used."
6161 #: ../src/guestfs.pod:2902
6162 msgid "See also L</QEMU WRAPPERS> above."
6167 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1075
6168 msgid "LIBGUESTFS_TRACE"
6173 #: ../src/guestfs.pod:2906
6175 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6176 "effect as calling C<guestfs_set_trace (g, 1)>."
6181 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
6186 #: ../src/guestfs.pod:2911 ../fish/guestfish.pod:1086
6188 "Location of temporary directory, defaults to C</tmp> except for the cached "
6189 "supermin appliance which defaults to C</var/tmp>."
6193 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1089
6195 "If libguestfs was compiled to use the supermin appliance then the real "
6196 "appliance is cached in this directory, shared between all handles belonging "
6197 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6198 "use in case C</var/tmp> is not large enough."
6203 #: ../src/guestfs.pod:2922 ../fish/guestfish.pod:1156
6204 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
6205 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
6206 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6207 #: ../tools/virt-list-partitions.pl:257
6212 #: ../src/guestfs.pod:2924
6214 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6215 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6216 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6217 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6218 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6219 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6220 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6225 #: ../src/guestfs.pod:2951
6227 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6228 "(8)>, L<disktype(1)>."
6233 #: ../src/guestfs.pod:2958 ../tools/virt-win-reg.pl:759
6234 #: ../tools/virt-make-fs.pl:553
6240 #: ../src/guestfs.pod:2960
6241 msgid "To get a list of bugs against libguestfs use this link:"
6246 #: ../src/guestfs.pod:2962
6248 "L<https://bugzilla.redhat.com/buglist.cgi?"
6249 "component=libguestfs&product=Virtualization+Tools>"
6254 #: ../src/guestfs.pod:2964
6255 msgid "To report a new bug against libguestfs use this link:"
6260 #: ../src/guestfs.pod:2966
6262 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6263 "component=libguestfs&product=Virtualization+Tools>"
6268 #: ../src/guestfs.pod:2968
6269 msgid "When reporting a bug, please check:"
6274 #: ../src/guestfs.pod:2974
6275 msgid "That the bug hasn't been reported already."
6280 #: ../src/guestfs.pod:2978
6281 msgid "That you are testing a recent version."
6286 #: ../src/guestfs.pod:2982
6287 msgid "Describe the bug accurately, and give a way to reproduce it."
6292 #: ../src/guestfs.pod:2986
6294 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6300 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1180
6301 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
6307 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1182
6308 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
6309 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6314 #: ../src/guestfs.pod:2995 ../fish/guestfish.pod:1184
6315 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
6316 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
6317 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6318 #: ../tools/virt-list-partitions.pl:273
6323 #: ../src/guestfs.pod:2997 ../fish/guestfish.pod:1186
6324 #: ../test-tool/libguestfs-test-tool.pod:99
6325 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6330 #: ../src/guestfs.pod:3000
6332 "This library is free software; you can redistribute it and/or modify it "
6333 "under the terms of the GNU Lesser General Public License as published by the "
6334 "Free Software Foundation; either version 2 of the License, or (at your "
6335 "option) any later version."
6340 #: ../src/guestfs.pod:3005
6342 "This library is distributed in the hope that it will be useful, but WITHOUT "
6343 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6344 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6350 #: ../src/guestfs.pod:3010
6352 "You should have received a copy of the GNU Lesser General Public License "
6353 "along with this library; if not, write to the Free Software Foundation, "
6354 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6359 #: ../src/guestfs-actions.pod:1
6360 msgid "guestfs_add_cdrom"
6365 #: ../src/guestfs-actions.pod:3
6369 " guestfs_add_cdrom (guestfs_h *g,\n"
6370 " const char *filename);\n"
6376 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6377 msgid "This function adds a virtual CD-ROM disk image to the guest."
6381 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6382 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6387 #: ../src/guestfs-actions.pod:17
6389 "This call checks for the existence of C<filename>. This stops you from "
6390 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6391 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6397 #: ../src/guestfs-actions.pod:24
6399 "If you just want to add an ISO file (often you use this as an efficient way "
6400 "to transfer large files into the guest), then you should probably use "
6401 "C<guestfs_add_drive_ro> instead."
6406 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6407 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6408 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6409 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6410 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6411 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6412 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6413 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6414 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6415 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6416 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6417 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1039
6418 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1077
6419 #: ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1179
6420 #: ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1212
6421 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1302
6422 #: ../src/guestfs-actions.pod:1333 ../src/guestfs-actions.pod:1358
6423 #: ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1506
6424 #: ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1755
6425 #: ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1864
6426 #: ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:2472
6427 #: ../src/guestfs-actions.pod:2533 ../src/guestfs-actions.pod:2568
6428 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:3623
6429 #: ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3837
6430 #: ../src/guestfs-actions.pod:3851 ../src/guestfs-actions.pod:3864
6431 #: ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3893
6432 #: ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:4001
6433 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4038
6434 #: ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4084
6435 #: ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4138
6436 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4192
6437 #: ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4240
6438 #: ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4269
6439 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4301
6440 #: ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4414
6441 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4478
6442 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4514
6443 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4544
6444 #: ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4575
6445 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4610
6446 #: ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4753
6447 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4803
6448 #: ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:4834
6449 #: ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:4864
6450 #: ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:4894
6451 #: ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4962
6452 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5021
6453 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5052
6454 #: ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5147
6455 #: ../src/guestfs-actions.pod:5201 ../src/guestfs-actions.pod:5237
6456 #: ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5289
6457 #: ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5441
6458 #: ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5520
6459 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5570
6460 #: ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5653
6461 #: ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5680
6462 #: ../src/guestfs-actions.pod:5969 ../src/guestfs-actions.pod:5988
6463 #: ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6021
6464 #: ../src/guestfs-actions.pod:6033 ../src/guestfs-actions.pod:6047
6465 #: ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073
6466 #: ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6110
6467 #: ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6148
6468 #: ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6196
6469 #: ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6237
6470 #: ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6277
6471 #: ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6313
6472 #: ../src/guestfs-actions.pod:6341 ../src/guestfs-actions.pod:6365
6473 #: ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6408
6474 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6442
6475 #: ../src/guestfs-actions.pod:6461 ../src/guestfs-actions.pod:6498
6476 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6561
6477 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6804
6478 #: ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6829
6479 #: ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6864
6480 #: ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6890
6481 #: ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6918
6482 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:6994
6483 #: ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7026
6484 #: ../src/guestfs-actions.pod:7043 ../src/guestfs-actions.pod:7056
6485 #: ../src/guestfs-actions.pod:7076 ../src/guestfs-actions.pod:7112
6486 #: ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:7167
6487 #: ../src/guestfs-actions.pod:7180 ../src/guestfs-actions.pod:7198
6488 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7268
6489 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7399
6490 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7468
6491 #: ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7526
6492 #: ../src/guestfs-actions.pod:7559 ../src/guestfs-actions.pod:7620
6493 #: ../src/guestfs-actions.pod:7646 ../src/guestfs-actions.pod:7713
6494 #: ../src/guestfs-actions.pod:7732 ../src/guestfs-actions.pod:7761
6495 msgid "This function returns 0 on success or -1 on error."
6500 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6501 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6502 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6504 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6510 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6511 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1511
6512 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2027
6513 #: ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:4934
6514 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5242
6515 #: ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:6536
6516 #: ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6628
6517 #: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7654
6518 #: ../src/guestfs-actions.pod:7824 ../fish/guestfish-actions.pod:31
6519 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6520 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
6521 #: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3079
6522 #: ../fish/guestfish-actions.pod:3286 ../fish/guestfish-actions.pod:3400
6523 #: ../fish/guestfish-actions.pod:3448 ../fish/guestfish-actions.pod:4328
6524 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4373
6525 #: ../fish/guestfish-actions.pod:4411 ../fish/guestfish-actions.pod:5046
6526 #: ../fish/guestfish-actions.pod:5144
6528 "Deprecated functions will not be removed from the API, but the fact that "
6529 "they are deprecated indicates that there are problems with correct use of "
6535 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6536 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1978
6537 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2179
6538 #: ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3630
6539 #: ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:6198
6540 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6429
6541 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:7045
6542 #: ../src/guestfs-actions.pod:7568
6543 msgid "(Added in 0.3)"
6548 #: ../src/guestfs-actions.pod:41
6549 msgid "guestfs_add_domain"
6554 #: ../src/guestfs-actions.pod:43
6558 " guestfs_add_domain (guestfs_h *g,\n"
6559 " const char *dom,\n"
6566 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6567 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2813
6568 #: ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4948
6569 #: ../src/guestfs-actions.pod:5165
6571 "You may supply a list of optional arguments to this call. Use zero or more "
6572 "of the following pairs of parameters, and terminate the list with C<-1> on "
6573 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6577 #: ../src/guestfs-actions.pod:53
6580 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6581 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6582 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6583 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6584 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6590 #: ../src/guestfs-actions.pod:59
6592 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6593 "It works by connecting to libvirt, requesting the domain and domain XML from "
6594 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6600 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6602 "The number of disks added is returned. This operation is atomic: if an "
6603 "error is returned, then no disks are added."
6608 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6610 "This function does some minimal checks to make sure the libvirt domain is "
6611 "not running (unless C<readonly> is true). In a future version we will try "
6612 "to acquire the libvirt lock on each disk."
6617 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6619 "Disks must be accessible locally. This often means that adding disks from a "
6620 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6621 "unless those disks are accessible via the same device path locally too."
6625 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6627 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6628 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6629 "libvirt URI (or one set through an environment variable, see the libvirt "
6630 "documentation for full details)."
6634 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6636 "The optional C<live> flag controls whether this call will try to connect to "
6637 "a running virtual machine C<guestfsd> process if it sees a suitable "
6638 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6639 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6640 "DAEMONS> for more information."
6644 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6646 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6647 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6648 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6654 #: ../src/guestfs-actions.pod:94
6656 "The other optional parameters are passed directly through to "
6657 "C<guestfs_add_drive_opts>."
6662 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6663 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6664 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6665 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1378
6666 #: ../src/guestfs-actions.pod:1734 ../src/guestfs-actions.pod:1937
6667 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2088
6668 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2166
6669 #: ../src/guestfs-actions.pod:2459 ../src/guestfs-actions.pod:2931
6670 #: ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:5124
6671 #: ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5750
6672 #: ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:7153
6673 #: ../src/guestfs-actions.pod:7579 ../src/guestfs-actions.pod:7592
6674 #: ../src/guestfs-actions.pod:7605
6675 msgid "On error this function returns -1."
6680 #: ../src/guestfs-actions.pod:99
6681 msgid "(Added in 1.7.4)"
6686 #: ../src/guestfs-actions.pod:101
6687 msgid "guestfs_add_domain_va"
6692 #: ../src/guestfs-actions.pod:103
6696 " guestfs_add_domain_va (guestfs_h *g,\n"
6697 " const char *dom,\n"
6704 #: ../src/guestfs-actions.pod:108
6705 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6710 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6711 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6712 #: ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:880
6713 #: ../src/guestfs-actions.pod:2897 ../src/guestfs-actions.pod:2909
6714 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4706
6715 #: ../src/guestfs-actions.pod:4976 ../src/guestfs-actions.pod:4988
6716 #: ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5225
6717 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6722 #: ../src/guestfs-actions.pod:112
6723 msgid "guestfs_add_domain_argv"
6728 #: ../src/guestfs-actions.pod:114
6732 " guestfs_add_domain_argv (guestfs_h *g,\n"
6733 " const char *dom,\n"
6734 " const struct guestfs_add_domain_argv *optargs);\n"
6740 #: ../src/guestfs-actions.pod:119
6741 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6746 #: ../src/guestfs-actions.pod:123
6747 msgid "guestfs_add_drive"
6752 #: ../src/guestfs-actions.pod:125
6756 " guestfs_add_drive (guestfs_h *g,\n"
6757 " const char *filename);\n"
6763 #: ../src/guestfs-actions.pod:129
6765 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6766 "optional parameters, so the disk is added writable, with the format being "
6767 "detected automatically."
6772 #: ../src/guestfs-actions.pod:133
6774 "Automatic detection of the format opens you up to a potential security hole "
6775 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6776 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6777 "you should think about replacing calls to this function with calls to "
6778 "C<guestfs_add_drive_opts>, and specifying the format."
6783 #: ../src/guestfs-actions.pod:144
6784 msgid "guestfs_add_drive_opts"
6789 #: ../src/guestfs-actions.pod:146
6793 " guestfs_add_drive_opts (guestfs_h *g,\n"
6794 " const char *filename,\n"
6801 #: ../src/guestfs-actions.pod:156
6804 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6805 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6806 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6812 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6814 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6815 "The first time you call this function, the disk appears as C</dev/sda>, the "
6816 "second time as C</dev/sdb>, and so on."
6821 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6823 "You don't necessarily need to be root when using libguestfs. However you "
6824 "obviously do need sufficient permissions to access the filename for whatever "
6825 "operations you want to perform (ie. read access if you just want to read the "
6826 "image or write access if you want to modify the image)."
6831 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6832 msgid "This call checks that C<filename> exists."
6837 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4642
6838 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3090
6839 msgid "The optional arguments are:"
6844 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6850 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6852 "If true then the image is treated as read-only. Writes are still allowed, "
6853 "but they are stored in a temporary snapshot overlay which is discarded at "
6854 "the end. The disk that you add is not modified."
6859 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6865 #: ../src/guestfs-actions.pod:185
6867 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6868 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6869 "Possible formats include C<raw> and C<qcow2>."
6874 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6876 "Automatic detection of the format opens you up to a potential security hole "
6877 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6878 "RHBZ#642934. Specifying the format closes this security hole."
6883 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6889 #: ../src/guestfs-actions.pod:196
6891 "This rarely-used option lets you emulate the behaviour of the deprecated "
6892 "C<guestfs_add_drive_with_if> call (q.v.)"
6897 #: ../src/guestfs-actions.pod:203
6898 msgid "(Added in 1.5.23)"
6903 #: ../src/guestfs-actions.pod:205
6904 msgid "guestfs_add_drive_opts_va"
6909 #: ../src/guestfs-actions.pod:207
6913 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6914 " const char *filename,\n"
6921 #: ../src/guestfs-actions.pod:212
6922 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6927 #: ../src/guestfs-actions.pod:216
6928 msgid "guestfs_add_drive_opts_argv"
6933 #: ../src/guestfs-actions.pod:218
6937 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6938 " const char *filename,\n"
6939 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6945 #: ../src/guestfs-actions.pod:223
6946 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6951 #: ../src/guestfs-actions.pod:227
6952 msgid "guestfs_add_drive_ro"
6957 #: ../src/guestfs-actions.pod:229
6961 " guestfs_add_drive_ro (guestfs_h *g,\n"
6962 " const char *filename);\n"
6968 #: ../src/guestfs-actions.pod:233
6970 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6971 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6972 "disk is added read-only, with the format being detected automatically."
6977 #: ../src/guestfs-actions.pod:240
6978 msgid "(Added in 1.0.38)"
6983 #: ../src/guestfs-actions.pod:242
6984 msgid "guestfs_add_drive_ro_with_if"
6989 #: ../src/guestfs-actions.pod:244
6993 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6994 " const char *filename,\n"
6995 " const char *iface);\n"
7001 #: ../src/guestfs-actions.pod:249
7003 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
7004 "QEMU interface emulation to use at run time."
7009 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
7010 #: ../src/guestfs-actions.pod:2418
7011 msgid "(Added in 1.0.84)"
7016 #: ../src/guestfs-actions.pod:263
7017 msgid "guestfs_add_drive_with_if"
7022 #: ../src/guestfs-actions.pod:265
7026 " guestfs_add_drive_with_if (guestfs_h *g,\n"
7027 " const char *filename,\n"
7028 " const char *iface);\n"
7034 #: ../src/guestfs-actions.pod:270
7036 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7037 "QEMU interface emulation to use at run time."
7042 #: ../src/guestfs-actions.pod:284
7043 msgid "guestfs_aug_clear"
7048 #: ../src/guestfs-actions.pod:286
7052 " guestfs_aug_clear (guestfs_h *g,\n"
7053 " const char *augpath);\n"
7059 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7061 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7062 "L<augtool(1)> C<clear> command."
7067 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2168
7068 msgid "(Added in 1.3.4)"
7073 #: ../src/guestfs-actions.pod:297
7074 msgid "guestfs_aug_close"
7079 #: ../src/guestfs-actions.pod:299
7083 " guestfs_aug_close (guestfs_h *g);\n"
7089 #: ../src/guestfs-actions.pod:302
7091 "Close the current Augeas handle and free up any resources used by it. After "
7092 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7093 "any other Augeas functions."
7098 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7099 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7100 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7101 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7102 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7103 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7104 #: ../src/guestfs-actions.pod:5827
7105 msgid "(Added in 0.7)"
7110 #: ../src/guestfs-actions.pod:311
7111 msgid "guestfs_aug_defnode"
7116 #: ../src/guestfs-actions.pod:313
7119 " struct guestfs_int_bool *\n"
7120 " guestfs_aug_defnode (guestfs_h *g,\n"
7121 " const char *name,\n"
7122 " const char *expr,\n"
7123 " const char *val);\n"
7129 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7131 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7136 #: ../src/guestfs-actions.pod:322
7138 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7139 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7140 "containing that single node."
7145 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7147 "On success this returns a pair containing the number of nodes in the "
7148 "nodeset, and a boolean flag if a node was created."
7153 #: ../src/guestfs-actions.pod:330
7155 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7156 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7161 #: ../src/guestfs-actions.pod:336
7162 msgid "guestfs_aug_defvar"
7167 #: ../src/guestfs-actions.pod:338
7171 " guestfs_aug_defvar (guestfs_h *g,\n"
7172 " const char *name,\n"
7173 " const char *expr);\n"
7179 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7181 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7182 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7187 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7189 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7190 "evaluates to something which is not a nodeset."
7195 #: ../src/guestfs-actions.pod:354
7196 msgid "guestfs_aug_get"
7201 #: ../src/guestfs-actions.pod:356
7205 " guestfs_aug_get (guestfs_h *g,\n"
7206 " const char *augpath);\n"
7212 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7214 "Look up the value associated with C<path>. If C<path> matches exactly one "
7215 "node, the C<value> is returned."
7220 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:920
7221 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:998
7222 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1117
7223 #: ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1264
7224 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:1417
7225 #: ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1717
7226 #: ../src/guestfs-actions.pod:1880 ../src/guestfs-actions.pod:1897
7227 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2000
7228 #: ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2191
7229 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2587
7230 #: ../src/guestfs-actions.pod:2677 ../src/guestfs-actions.pod:2781
7231 #: ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:3014
7232 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
7233 #: ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3156
7234 #: ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3196
7235 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:4176
7236 #: ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4456
7237 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5555
7238 #: ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5903
7239 #: ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6589
7240 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6622
7241 #: ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:7327
7242 #: ../src/guestfs-actions.pod:7346 ../src/guestfs-actions.pod:7364
7243 #: ../src/guestfs-actions.pod:7538 ../src/guestfs-actions.pod:7818
7245 "This function returns a string, or NULL on error. I<The caller must free "
7246 "the returned string after use>."
7251 #: ../src/guestfs-actions.pod:368
7252 msgid "guestfs_aug_init"
7257 #: ../src/guestfs-actions.pod:370
7261 " guestfs_aug_init (guestfs_h *g,\n"
7262 " const char *root,\n"
7269 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7271 "Create a new Augeas handle for editing configuration files. If there was "
7272 "any previous Augeas handle associated with this guestfs session, then it is "
7278 #: ../src/guestfs-actions.pod:379
7279 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7284 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7286 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7291 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7293 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7294 "logical I<or> of the following integers:"
7299 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7300 msgid "C<AUG_SAVE_BACKUP> = 1"
7305 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7306 msgid "Keep the original file with a C<.augsave> extension."
7311 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7312 msgid "C<AUG_SAVE_NEWFILE> = 2"
7317 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7319 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7320 "original. Overrides C<AUG_SAVE_BACKUP>."
7325 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7326 msgid "C<AUG_TYPE_CHECK> = 4"
7331 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7332 msgid "Typecheck lenses (can be expensive)."
7337 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7338 msgid "C<AUG_NO_STDINC> = 8"
7343 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7344 msgid "Do not use standard load path for modules."
7349 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7350 msgid "C<AUG_SAVE_NOOP> = 16"
7355 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7356 msgid "Make save a no-op, just record what would have been changed."
7361 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7362 msgid "C<AUG_NO_LOAD> = 32"
7367 #: ../src/guestfs-actions.pod:414
7368 msgid "Do not load the tree in C<guestfs_aug_init>."
7373 #: ../src/guestfs-actions.pod:418
7374 msgid "To close the handle, you can call C<guestfs_aug_close>."
7379 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7380 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7385 #: ../src/guestfs-actions.pod:426
7386 msgid "guestfs_aug_insert"
7391 #: ../src/guestfs-actions.pod:428
7395 " guestfs_aug_insert (guestfs_h *g,\n"
7396 " const char *augpath,\n"
7397 " const char *label,\n"
7404 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7406 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7407 "or after C<path> (depending on the boolean flag C<before>)."
7412 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7414 "C<path> must match exactly one existing node in the tree, and C<label> must "
7415 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7420 #: ../src/guestfs-actions.pod:446
7421 msgid "guestfs_aug_load"
7426 #: ../src/guestfs-actions.pod:448
7430 " guestfs_aug_load (guestfs_h *g);\n"
7436 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7437 msgid "Load files into the tree."
7442 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7443 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7448 #: ../src/guestfs-actions.pod:460
7449 msgid "guestfs_aug_ls"
7454 #: ../src/guestfs-actions.pod:462
7458 " guestfs_aug_ls (guestfs_h *g,\n"
7459 " const char *augpath);\n"
7465 #: ../src/guestfs-actions.pod:466
7467 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7468 "sorting the resulting nodes into alphabetical order."
7473 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7474 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1136
7475 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1451
7476 #: ../src/guestfs-actions.pod:1554 ../src/guestfs-actions.pod:1573
7477 #: ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:2263
7478 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2298
7479 #: ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2365
7480 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2485
7481 #: ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:3116
7482 #: ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:3706
7483 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3743
7484 #: ../src/guestfs-actions.pod:3805 ../src/guestfs-actions.pod:3910
7485 #: ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:5085
7486 #: ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5823
7487 #: ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:6669
7488 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6785
7489 #: ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6955
7490 #: ../src/guestfs-actions.pod:7431 ../src/guestfs-actions.pod:7451
7491 #: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7670
7492 #: ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7775
7493 #: ../src/guestfs-actions.pod:7794 ../src/guestfs-actions.pod:7840
7494 #: ../src/guestfs-actions.pod:7859
7496 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7497 ">), or NULL if there was an error. I<The caller must free the strings and "
7498 "the array after use>."
7503 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1061
7504 #: ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1489
7505 #: ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3501
7506 #: ../src/guestfs-actions.pod:4159 ../src/guestfs-actions.pod:4209
7507 #: ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4429
7508 #: ../src/guestfs-actions.pod:4592 ../src/guestfs-actions.pod:5089
7509 #: ../src/guestfs-actions.pod:5638 ../src/guestfs-actions.pod:6035
7510 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6061
7511 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:7169
7512 #: ../src/guestfs-actions.pod:7182 ../src/guestfs-actions.pod:7415
7513 #: ../src/guestfs-actions.pod:7658
7514 msgid "(Added in 0.8)"
7519 #: ../src/guestfs-actions.pod:475
7520 msgid "guestfs_aug_match"
7525 #: ../src/guestfs-actions.pod:477
7529 " guestfs_aug_match (guestfs_h *g,\n"
7530 " const char *augpath);\n"
7536 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7538 "Returns a list of paths which match the path expression C<path>. The "
7539 "returned paths are sufficiently qualified so that they match exactly one "
7540 "node in the current tree."
7545 #: ../src/guestfs-actions.pod:491
7546 msgid "guestfs_aug_mv"
7551 #: ../src/guestfs-actions.pod:493
7555 " guestfs_aug_mv (guestfs_h *g,\n"
7556 " const char *src,\n"
7557 " const char *dest);\n"
7563 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7565 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7566 "C<dest> is overwritten if it exists."
7571 #: ../src/guestfs-actions.pod:505
7572 msgid "guestfs_aug_rm"
7577 #: ../src/guestfs-actions.pod:507
7581 " guestfs_aug_rm (guestfs_h *g,\n"
7582 " const char *augpath);\n"
7588 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7589 msgid "Remove C<path> and all of its children."
7594 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7595 msgid "On success this returns the number of entries which were removed."
7600 #: ../src/guestfs-actions.pod:519
7601 msgid "guestfs_aug_save"
7606 #: ../src/guestfs-actions.pod:521
7610 " guestfs_aug_save (guestfs_h *g);\n"
7616 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7617 msgid "This writes all pending changes to disk."
7622 #: ../src/guestfs-actions.pod:526
7624 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7630 #: ../src/guestfs-actions.pod:533
7631 msgid "guestfs_aug_set"
7636 #: ../src/guestfs-actions.pod:535
7640 " guestfs_aug_set (guestfs_h *g,\n"
7641 " const char *augpath,\n"
7642 " const char *val);\n"
7648 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7649 msgid "Set the value associated with C<path> to C<val>."
7654 #: ../src/guestfs-actions.pod:542
7656 "In the Augeas API, it is possible to clear a node by setting the value to "
7657 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7658 "this call. Instead you must use the C<guestfs_aug_clear> call."
7663 #: ../src/guestfs-actions.pod:551
7664 msgid "guestfs_available"
7669 #: ../src/guestfs-actions.pod:553
7673 " guestfs_available (guestfs_h *g,\n"
7674 " char *const *groups);\n"
7680 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7682 "This command is used to check the availability of some groups of "
7683 "functionality in the appliance, which not all builds of the libguestfs "
7684 "appliance will be able to provide."
7689 #: ../src/guestfs-actions.pod:561
7691 "The libguestfs groups, and the functions that those groups correspond to, "
7692 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7693 "runtime by calling C<guestfs_available_all_groups>."
7698 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7700 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7701 "\"]> would check for the availability of the Linux inotify functions and "
7702 "Augeas (configuration file editing) functions."
7707 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7708 msgid "The command returns no error if I<all> requested groups are available."
7713 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7715 "It fails with an error if one or more of the requested groups is unavailable "
7721 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7723 "If an unknown group name is included in the list of groups then an error is "
7729 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7735 #: ../src/guestfs-actions.pod:585
7736 msgid "You must call C<guestfs_launch> before calling this function."
7741 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7743 "The reason is because we don't know what groups are supported by the "
7744 "appliance/daemon until it is running and can be queried."
7749 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7751 "If a group of functions is available, this does not necessarily mean that "
7752 "they will work. You still have to check for errors when calling individual "
7753 "API functions even if they are available."
7758 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7760 "It is usually the job of distro packagers to build complete functionality "
7761 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7762 "with all requirements satisfied, will support everything."
7767 #: ../src/guestfs-actions.pod:607
7769 "This call was added in version C<1.0.80>. In previous versions of "
7770 "libguestfs all you could do would be to speculatively execute a command to "
7771 "find out if the daemon implemented it. See also C<guestfs_version>."
7776 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1234
7777 msgid "(Added in 1.0.80)"
7782 #: ../src/guestfs-actions.pod:618
7783 msgid "guestfs_available_all_groups"
7788 #: ../src/guestfs-actions.pod:620
7792 " guestfs_available_all_groups (guestfs_h *g);\n"
7798 #: ../src/guestfs-actions.pod:623
7800 "This command returns a list of all optional groups that this daemon knows "
7801 "about. Note this returns both supported and unsupported groups. To find "
7802 "out which ones the daemon can actually support you have to call "
7803 "C<guestfs_available> on each member of the returned list."
7808 #: ../src/guestfs-actions.pod:629
7809 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7814 #: ../src/guestfs-actions.pod:635
7815 msgid "(Added in 1.3.15)"
7820 #: ../src/guestfs-actions.pod:637
7821 msgid "guestfs_base64_in"
7826 #: ../src/guestfs-actions.pod:639
7830 " guestfs_base64_in (guestfs_h *g,\n"
7831 " const char *base64file,\n"
7832 " const char *filename);\n"
7838 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7840 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7845 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7846 msgid "(Added in 1.3.5)"
7851 #: ../src/guestfs-actions.pod:651
7852 msgid "guestfs_base64_out"
7857 #: ../src/guestfs-actions.pod:653
7861 " guestfs_base64_out (guestfs_h *g,\n"
7862 " const char *filename,\n"
7863 " const char *base64file);\n"
7869 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7871 "This command downloads the contents of C<filename>, writing it out to local "
7872 "file C<base64file> encoded as base64."
7877 #: ../src/guestfs-actions.pod:665
7878 msgid "guestfs_blockdev_flushbufs"
7883 #: ../src/guestfs-actions.pod:667
7887 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7888 " const char *device);\n"
7894 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7896 "This tells the kernel to flush internal buffers associated with C<device>."
7901 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7902 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7903 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7904 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7905 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7906 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7907 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7908 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7909 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7910 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7911 msgid "This uses the L<blockdev(8)> command."
7916 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7917 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7918 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7919 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7920 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7921 msgid "(Added in 0.9.3)"
7926 #: ../src/guestfs-actions.pod:680
7927 msgid "guestfs_blockdev_getbsz"
7932 #: ../src/guestfs-actions.pod:682
7936 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7937 " const char *device);\n"
7943 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7944 msgid "This returns the block size of a device."
7949 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7950 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7952 "(Note this is different from both I<size in blocks> and I<filesystem block "
7958 #: ../src/guestfs-actions.pod:697
7959 msgid "guestfs_blockdev_getro"
7964 #: ../src/guestfs-actions.pod:699
7968 " guestfs_blockdev_getro (guestfs_h *g,\n"
7969 " const char *device);\n"
7975 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7977 "Returns a boolean indicating if the block device is read-only (true if read-"
7978 "only, false if not)."
7983 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1472
7984 #: ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1976
7985 #: ../src/guestfs-actions.pod:1987 ../src/guestfs-actions.pod:2059
7986 #: ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:2129
7987 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
7988 #: ../src/guestfs-actions.pod:3213 ../src/guestfs-actions.pod:3229
7989 #: ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3409
7990 #: ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3438
7991 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3468
7992 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3499
7993 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7994 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3555
7995 #: ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3583
7996 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:5326
7997 msgid "This function returns a C truth value on success or -1 on error."
8002 #: ../src/guestfs-actions.pod:712
8003 msgid "guestfs_blockdev_getsize64"
8008 #: ../src/guestfs-actions.pod:714
8012 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
8013 " const char *device);\n"
8019 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
8020 msgid "This returns the size of the device in bytes."
8025 #: ../src/guestfs-actions.pod:720
8026 msgid "See also C<guestfs_blockdev_getsz>."
8031 #: ../src/guestfs-actions.pod:728
8032 msgid "guestfs_blockdev_getss"
8037 #: ../src/guestfs-actions.pod:730
8041 " guestfs_blockdev_getss (guestfs_h *g,\n"
8042 " const char *device);\n"
8048 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8050 "This returns the size of sectors on a block device. Usually 512, but can be "
8051 "larger for modern devices."
8056 #: ../src/guestfs-actions.pod:737
8058 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8064 #: ../src/guestfs-actions.pod:746
8065 msgid "guestfs_blockdev_getsz"
8070 #: ../src/guestfs-actions.pod:748
8074 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8075 " const char *device);\n"
8081 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8083 "This returns the size of the device in units of 512-byte sectors (even if "
8084 "the sectorsize isn't 512 bytes ... weird)."
8089 #: ../src/guestfs-actions.pod:755
8091 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8092 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8097 #: ../src/guestfs-actions.pod:765
8098 msgid "guestfs_blockdev_rereadpt"
8103 #: ../src/guestfs-actions.pod:767
8107 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8108 " const char *device);\n"
8114 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8115 msgid "Reread the partition table on C<device>."
8120 #: ../src/guestfs-actions.pod:779
8121 msgid "guestfs_blockdev_setbsz"
8126 #: ../src/guestfs-actions.pod:781
8130 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8131 " const char *device,\n"
8132 " int blocksize);\n"
8138 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8139 msgid "This sets the block size of a device."
8144 #: ../src/guestfs-actions.pod:797
8145 msgid "guestfs_blockdev_setro"
8150 #: ../src/guestfs-actions.pod:799
8154 " guestfs_blockdev_setro (guestfs_h *g,\n"
8155 " const char *device);\n"
8161 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8162 msgid "Sets the block device named C<device> to read-only."
8167 #: ../src/guestfs-actions.pod:811
8168 msgid "guestfs_blockdev_setrw"
8173 #: ../src/guestfs-actions.pod:813
8177 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8178 " const char *device);\n"
8184 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8185 msgid "Sets the block device named C<device> to read-write."
8189 #: ../src/guestfs-actions.pod:825
8190 msgid "guestfs_btrfs_filesystem_resize"
8194 #: ../src/guestfs-actions.pod:827
8198 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
8199 " const char *mountpoint,\n"
8205 #: ../src/guestfs-actions.pod:837
8208 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
8213 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
8214 msgid "This command resizes a btrfs filesystem."
8218 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
8220 "Note that unlike other resize calls, the filesystem has to be mounted and "
8221 "the parameter is the mountpoint not the device (this is a requirement of "
8226 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5176
8227 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3411
8228 msgid "The optional parameters are:"
8232 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5180
8233 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3415
8238 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
8240 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
8241 "resized to the maximum size."
8245 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
8246 msgid "See also L<btrfs(8)>."
8250 #: ../src/guestfs-actions.pod:860
8251 msgid "guestfs_btrfs_filesystem_resize_va"
8255 #: ../src/guestfs-actions.pod:862
8259 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
8260 " const char *mountpoint,\n"
8266 #: ../src/guestfs-actions.pod:867
8267 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
8271 #: ../src/guestfs-actions.pod:871
8272 msgid "guestfs_btrfs_filesystem_resize_argv"
8276 #: ../src/guestfs-actions.pod:873
8280 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
8281 " const char *mountpoint,\n"
8282 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
8287 #: ../src/guestfs-actions.pod:878
8288 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
8293 #: ../src/guestfs-actions.pod:882
8294 msgid "guestfs_case_sensitive_path"
8299 #: ../src/guestfs-actions.pod:884
8303 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8304 " const char *path);\n"
8310 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:574
8312 "This can be used to resolve case insensitive paths on a filesystem which is "
8313 "case sensitive. The use case is to resolve paths which you have read from "
8314 "Windows configuration files or the Windows Registry, to the true path."
8319 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:579
8321 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8322 "(and probably others), which is that although the underlying filesystem is "
8323 "case-insensitive, the driver exports the filesystem to Linux as case-"
8329 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:584
8331 "One consequence of this is that special directories such as C<c:\\windows> "
8332 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8333 "precise details of how they were created. In Windows itself this would not "
8339 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:590
8341 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8347 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:593
8349 "This function resolves the true case of each element in the path and returns "
8350 "the case-sensitive path."
8355 #: ../src/guestfs-actions.pod:910
8357 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8358 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8359 "how the directories were originally created under Windows)."
8364 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:601
8365 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8370 #: ../src/guestfs-actions.pod:918
8371 msgid "See also C<guestfs_realpath>."
8376 #: ../src/guestfs-actions.pod:923 ../src/guestfs-actions.pod:7349
8377 msgid "(Added in 1.0.75)"
8382 #: ../src/guestfs-actions.pod:925
8388 #: ../src/guestfs-actions.pod:927
8392 " guestfs_cat (guestfs_h *g,\n"
8393 " const char *path);\n"
8399 #: ../src/guestfs-actions.pod:931 ../src/guestfs-actions.pod:5813
8400 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3825
8401 msgid "Return the contents of the file named C<path>."
8406 #: ../src/guestfs-actions.pod:933
8408 "Note that this function cannot correctly handle binary files (specifically, "
8409 "files containing C<\\0> character which is treated as end of string). For "
8410 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8411 "functions which have a more complex interface."
8416 #: ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:1120
8417 #: ../src/guestfs-actions.pod:1140 ../src/guestfs-actions.pod:1436
8418 #: ../src/guestfs-actions.pod:1455 ../src/guestfs-actions.pod:1558
8419 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1823
8420 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2302
8421 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2369
8422 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2415
8423 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5621
8424 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5778
8425 #: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6734
8426 #: ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6935
8427 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:7622
8428 #: ../src/guestfs-actions.pod:7648 ../src/guestfs-actions.pod:7674
8429 #: ../src/guestfs-actions.pod:7693 ../src/guestfs-actions.pod:7779
8430 #: ../src/guestfs-actions.pod:7798 ../src/guestfs-actions.pod:7844
8431 #: ../src/guestfs-actions.pod:7863 ../fish/guestfish-actions.pod:617
8432 #: ../fish/guestfish-actions.pod:752 ../fish/guestfish-actions.pod:764
8433 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:950
8434 #: ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1027
8435 #: ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1520
8436 #: ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1558
8437 #: ../fish/guestfish-actions.pod:1573 ../fish/guestfish-actions.pod:1583
8438 #: ../fish/guestfish-actions.pod:1602 ../fish/guestfish-actions.pod:3695
8439 #: ../fish/guestfish-actions.pod:3710 ../fish/guestfish-actions.pod:3786
8440 #: ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3818
8441 #: ../fish/guestfish-actions.pod:4472 ../fish/guestfish-actions.pod:4518
8442 #: ../fish/guestfish-actions.pod:4603 ../fish/guestfish-actions.pod:4618
8443 #: ../fish/guestfish-actions.pod:5022 ../fish/guestfish-actions.pod:5040
8444 #: ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5067
8445 #: ../fish/guestfish-actions.pod:5116 ../fish/guestfish-actions.pod:5126
8446 #: ../fish/guestfish-actions.pod:5155 ../fish/guestfish-actions.pod:5165
8448 "Because of the message protocol, there is a transfer limit of somewhere "
8449 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8454 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:3727
8455 #: ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:3826
8456 #: ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:4322
8457 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5701
8458 #: ../src/guestfs-actions.pod:5715 ../src/guestfs-actions.pod:7502
8459 #: ../src/guestfs-actions.pod:7516
8460 msgid "(Added in 0.4)"
8465 #: ../src/guestfs-actions.pod:946
8466 msgid "guestfs_checksum"
8471 #: ../src/guestfs-actions.pod:948
8475 " guestfs_checksum (guestfs_h *g,\n"
8476 " const char *csumtype,\n"
8477 " const char *path);\n"
8483 #: ../src/guestfs-actions.pod:953 ../fish/guestfish-actions.pod:624
8485 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8490 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:627
8492 "The type of checksum to compute is given by the C<csumtype> parameter which "
8493 "must have one of the following values:"
8498 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:632
8504 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:634
8506 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8512 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:637
8518 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:639
8519 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8524 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:641
8530 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:643
8531 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8536 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:645
8542 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:647
8543 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8548 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:649
8554 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:651
8555 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8560 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:653
8566 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:655
8567 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8572 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:657
8578 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:659
8579 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8584 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:663
8585 msgid "The checksum is returned as a printable string."
8590 #: ../src/guestfs-actions.pod:994
8591 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8596 #: ../src/guestfs-actions.pod:996
8597 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8602 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1309
8603 #: ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:3425
8604 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3515
8605 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:7205
8606 msgid "(Added in 1.0.2)"
8611 #: ../src/guestfs-actions.pod:1003
8612 msgid "guestfs_checksum_device"
8617 #: ../src/guestfs-actions.pod:1005
8621 " guestfs_checksum_device (guestfs_h *g,\n"
8622 " const char *csumtype,\n"
8623 " const char *device);\n"
8629 #: ../src/guestfs-actions.pod:1010
8631 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8632 "device named C<device>. For the types of checksums supported see the "
8633 "C<guestfs_checksum> command."
8638 #: ../src/guestfs-actions.pod:1017 ../src/guestfs-actions.pod:5156
8639 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5328
8640 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5522
8641 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7128
8642 #: ../src/guestfs-actions.pod:7528
8643 msgid "(Added in 1.3.2)"
8648 #: ../src/guestfs-actions.pod:1019
8649 msgid "guestfs_checksums_out"
8654 #: ../src/guestfs-actions.pod:1021
8658 " guestfs_checksums_out (guestfs_h *g,\n"
8659 " const char *csumtype,\n"
8660 " const char *directory,\n"
8661 " const char *sumsfile);\n"
8667 #: ../src/guestfs-actions.pod:1027 ../fish/guestfish-actions.pod:681
8669 "This command computes the checksums of all regular files in C<directory> and "
8670 "then emits a list of those checksums to the local output file C<sumsfile>."
8675 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:685
8677 "This can be used for verifying the integrity of a virtual machine. However "
8678 "to be properly secure you should pay attention to the output of the checksum "
8679 "command (it uses the ones from GNU coreutils). In particular when the "
8680 "filename is not printable, coreutils uses a special backslash syntax. For "
8681 "more information, see the GNU coreutils info file."
8686 #: ../src/guestfs-actions.pod:1041
8687 msgid "(Added in 1.3.7)"
8692 #: ../src/guestfs-actions.pod:1043
8693 msgid "guestfs_chmod"
8698 #: ../src/guestfs-actions.pod:1045
8702 " guestfs_chmod (guestfs_h *g,\n"
8704 " const char *path);\n"
8710 #: ../src/guestfs-actions.pod:1050 ../fish/guestfish-actions.pod:699
8712 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8718 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:702
8720 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8721 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8727 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:4573
8728 #: ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:4801
8729 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:706
8730 #: ../fish/guestfish-actions.pod:3054 ../fish/guestfish-actions.pod:3193
8731 #: ../fish/guestfish-actions.pod:3203 ../fish/guestfish-actions.pod:3213
8732 msgid "The mode actually set is affected by the umask."
8737 #: ../src/guestfs-actions.pod:1063
8738 msgid "guestfs_chown"
8743 #: ../src/guestfs-actions.pod:1065
8747 " guestfs_chown (guestfs_h *g,\n"
8750 " const char *path);\n"
8756 #: ../src/guestfs-actions.pod:1071 ../fish/guestfish-actions.pod:712
8757 msgid "Change the file owner to C<owner> and group to C<group>."
8762 #: ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:3644
8763 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2489
8765 "Only numeric uid and gid are supported. If you want to use names, you will "
8766 "need to locate and parse the password file yourself (Augeas support makes "
8767 "this relatively easy)."
8772 #: ../src/guestfs-actions.pod:1081
8773 msgid "guestfs_command"
8778 #: ../src/guestfs-actions.pod:1083
8782 " guestfs_command (guestfs_h *g,\n"
8783 " char *const *arguments);\n"
8789 #: ../src/guestfs-actions.pod:1087 ../fish/guestfish-actions.pod:722
8791 "This call runs a command from the guest filesystem. The filesystem must be "
8792 "mounted, and must contain a compatible operating system (ie. something "
8793 "Linux, with the same or compatible processor architecture)."
8798 #: ../src/guestfs-actions.pod:1092
8800 "The single parameter is an argv-style list of arguments. The first element "
8801 "is the name of the program to run. Subsequent elements are parameters. The "
8802 "list must be non-empty (ie. must contain a program name). Note that the "
8803 "command runs directly, and is I<not> invoked via the shell (see "
8809 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:734
8810 msgid "The return value is anything printed to I<stdout> by the command."
8815 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:737
8817 "If the command returns a non-zero exit status, then this function returns an "
8818 "error message. The error message string is the content of I<stderr> from "
8824 #: ../src/guestfs-actions.pod:1106 ../fish/guestfish-actions.pod:741
8826 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8827 "bin>. If you require a program from another location, you should provide "
8828 "the full path in the first parameter."
8833 #: ../src/guestfs-actions.pod:1111 ../fish/guestfish-actions.pod:746
8835 "Shared libraries and data files required by the program must be available on "
8836 "filesystems which are mounted in the correct places. It is the caller's "
8837 "responsibility to ensure all filesystems that are needed are mounted at the "
8843 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1143
8844 #: ../src/guestfs-actions.pod:1608
8845 msgid "(Added in 0.9.1)"
8850 #: ../src/guestfs-actions.pod:1125
8851 msgid "guestfs_command_lines"
8856 #: ../src/guestfs-actions.pod:1127
8860 " guestfs_command_lines (guestfs_h *g,\n"
8861 " char *const *arguments);\n"
8867 #: ../src/guestfs-actions.pod:1131
8869 "This is the same as C<guestfs_command>, but splits the result into a list of "
8875 #: ../src/guestfs-actions.pod:1134
8876 msgid "See also: C<guestfs_sh_lines>"
8881 #: ../src/guestfs-actions.pod:1145
8882 msgid "guestfs_config"
8887 #: ../src/guestfs-actions.pod:1147
8891 " guestfs_config (guestfs_h *g,\n"
8892 " const char *qemuparam,\n"
8893 " const char *qemuvalue);\n"
8898 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
8900 "This can be used to add arbitrary qemu command line parameters of the form "
8901 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8902 "setting some parameters which would interfere with parameters that we use."
8907 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
8908 msgid "The first character of C<param> string must be a C<-> (dash)."
8913 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:778
8914 msgid "C<value> can be NULL."
8919 #: ../src/guestfs-actions.pod:1165
8920 msgid "guestfs_copy_size"
8925 #: ../src/guestfs-actions.pod:1167
8929 " guestfs_copy_size (guestfs_h *g,\n"
8930 " const char *src,\n"
8931 " const char *dest,\n"
8938 #: ../src/guestfs-actions.pod:1173 ../fish/guestfish-actions.pod:784
8940 "This command copies exactly C<size> bytes from one source device or file "
8941 "C<src> to another destination device or file C<dest>."
8946 #: ../src/guestfs-actions.pod:1176 ../fish/guestfish-actions.pod:787
8948 "Note this will fail if the source is too short or if the destination is not "
8953 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1304
8954 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1380
8955 #: ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:1779
8956 #: ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:7200
8957 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7715
8958 #: ../src/guestfs-actions.pod:7734
8960 "This long-running command can generate progress notification messages so "
8961 "that the caller can display a progress bar or indicator. To receive these "
8962 "messages, the caller must register a progress event callback. See L<guestfs"
8963 "(3)/GUESTFS_EVENT_PROGRESS>."
8968 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:4349
8969 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:7435
8970 #: ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7541
8971 msgid "(Added in 1.0.87)"
8976 #: ../src/guestfs-actions.pod:1188
8982 #: ../src/guestfs-actions.pod:1190
8986 " guestfs_cp (guestfs_h *g,\n"
8987 " const char *src,\n"
8988 " const char *dest);\n"
8994 #: ../src/guestfs-actions.pod:1195 ../fish/guestfish-actions.pod:794
8996 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8997 "destination filename or destination directory."
9002 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
9003 #: ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1360
9004 #: ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:5103
9005 #: ../src/guestfs-actions.pod:5572
9006 msgid "(Added in 1.0.18)"
9011 #: ../src/guestfs-actions.pod:1202
9012 msgid "guestfs_cp_a"
9017 #: ../src/guestfs-actions.pod:1204
9021 " guestfs_cp_a (guestfs_h *g,\n"
9022 " const char *src,\n"
9023 " const char *dest);\n"
9029 #: ../src/guestfs-actions.pod:1209 ../fish/guestfish-actions.pod:801
9031 "This copies a file or directory from C<src> to C<dest> recursively using the "
9037 #: ../src/guestfs-actions.pod:1216
9043 #: ../src/guestfs-actions.pod:1218
9047 " guestfs_dd (guestfs_h *g,\n"
9048 " const char *src,\n"
9049 " const char *dest);\n"
9055 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:808
9057 "This command copies from one source device or file C<src> to another "
9058 "destination device or file C<dest>. Normally you would use this to copy to "
9059 "or from a device or partition, for example to duplicate a filesystem."
9064 #: ../src/guestfs-actions.pod:1228
9066 "If the destination is a device, it must be as large or larger than the "
9067 "source file or device, otherwise the copy will fail. This command cannot do "
9068 "partial copies (see C<guestfs_copy_size>)."
9073 #: ../src/guestfs-actions.pod:1236
9079 #: ../src/guestfs-actions.pod:1238
9083 " guestfs_df (guestfs_h *g);\n"
9089 #: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:821
9090 msgid "This command runs the C<df> command to report disk space used."
9095 #: ../src/guestfs-actions.pod:1243 ../src/guestfs-actions.pod:1260
9097 "This command is mostly useful for interactive sessions. It is I<not> "
9098 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
9104 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
9105 #: ../src/guestfs-actions.pod:1385 ../src/guestfs-actions.pod:2348
9106 #: ../src/guestfs-actions.pod:2372 ../src/guestfs-actions.pod:2440
9107 #: ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:5003
9108 #: ../src/guestfs-actions.pod:6938 ../src/guestfs-actions.pod:6962
9109 #: ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7594
9110 #: ../src/guestfs-actions.pod:7607
9111 msgid "(Added in 1.0.54)"
9116 #: ../src/guestfs-actions.pod:1252
9117 msgid "guestfs_df_h"
9122 #: ../src/guestfs-actions.pod:1254
9126 " guestfs_df_h (guestfs_h *g);\n"
9132 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:831
9134 "This command runs the C<df -h> command to report disk space used in human-"
9140 #: ../src/guestfs-actions.pod:1269
9141 msgid "guestfs_dmesg"
9146 #: ../src/guestfs-actions.pod:1271
9150 " guestfs_dmesg (guestfs_h *g);\n"
9156 #: ../src/guestfs-actions.pod:1274 ../fish/guestfish-actions.pod:842
9158 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9159 "This is sometimes useful for extended debugging of problems."
9164 #: ../src/guestfs-actions.pod:1278
9166 "Another way to get the same information is to enable verbose messages with "
9167 "C<guestfs_set_verbose> or by setting the environment variable "
9168 "C<LIBGUESTFS_DEBUG=1> before running the program."
9173 #: ../src/guestfs-actions.pod:1288
9174 msgid "guestfs_download"
9179 #: ../src/guestfs-actions.pod:1290
9183 " guestfs_download (guestfs_h *g,\n"
9184 " const char *remotefilename,\n"
9185 " const char *filename);\n"
9191 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1320
9192 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
9194 "Download file C<remotefilename> and save it as C<filename> on the local "
9200 #: ../src/guestfs-actions.pod:1298 ../src/guestfs-actions.pod:7194
9201 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4776
9202 msgid "C<filename> can also be a named pipe."
9207 #: ../src/guestfs-actions.pod:1300
9208 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9213 #: ../src/guestfs-actions.pod:1311
9214 msgid "guestfs_download_offset"
9219 #: ../src/guestfs-actions.pod:1313
9223 " guestfs_download_offset (guestfs_h *g,\n"
9224 " const char *remotefilename,\n"
9225 " const char *filename,\n"
9226 " int64_t offset,\n"
9233 #: ../src/guestfs-actions.pod:1323 ../fish/guestfish-actions.pod:871
9235 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9236 "region must be within the file or device)."
9241 #: ../src/guestfs-actions.pod:1326
9243 "Note that there is no limit on the amount of data that can be downloaded "
9244 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9245 "full amount unless an error occurs."
9250 #: ../src/guestfs-actions.pod:1331
9251 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9256 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:7239
9257 msgid "(Added in 1.5.17)"
9262 #: ../src/guestfs-actions.pod:1342
9263 msgid "guestfs_drop_caches"
9268 #: ../src/guestfs-actions.pod:1344
9272 " guestfs_drop_caches (guestfs_h *g,\n"
9273 " int whattodrop);\n"
9279 #: ../src/guestfs-actions.pod:1348 ../fish/guestfish-actions.pod:887
9281 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9282 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9283 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9288 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:892
9289 msgid "Setting C<whattodrop> to 3 should drop everything."
9294 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:894
9296 "This automatically calls L<sync(2)> before the operation, so that the "
9297 "maximum guest memory is freed."
9302 #: ../src/guestfs-actions.pod:1362
9308 #: ../src/guestfs-actions.pod:1364
9312 " guestfs_du (guestfs_h *g,\n"
9313 " const char *path);\n"
9319 #: ../src/guestfs-actions.pod:1368 ../fish/guestfish-actions.pod:901
9321 "This command runs the C<du -s> command to estimate file space usage for "
9327 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:904
9329 "C<path> can be a file or a directory. If C<path> is a directory then the "
9330 "estimate includes the contents of the directory and all subdirectories "
9336 #: ../src/guestfs-actions.pod:1375 ../fish/guestfish-actions.pod:908
9338 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9343 #: ../src/guestfs-actions.pod:1387
9344 msgid "guestfs_e2fsck_f"
9349 #: ../src/guestfs-actions.pod:1389
9353 " guestfs_e2fsck_f (guestfs_h *g,\n"
9354 " const char *device);\n"
9359 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:915
9361 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9362 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9368 #: ../src/guestfs-actions.pod:1397
9370 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9371 "Normally you should use C<guestfs_fsck>."
9376 #: ../src/guestfs-actions.pod:1402
9377 msgid "(Added in 1.0.29)"
9382 #: ../src/guestfs-actions.pod:1404
9383 msgid "guestfs_echo_daemon"
9388 #: ../src/guestfs-actions.pod:1406
9392 " guestfs_echo_daemon (guestfs_h *g,\n"
9393 " char *const *words);\n"
9399 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:926
9401 "This command concatenates the list of C<words> passed with single spaces "
9402 "between them and returns the resulting string."
9407 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:929
9408 msgid "You can use this command to test the connection through to the daemon."
9413 #: ../src/guestfs-actions.pod:1415
9414 msgid "See also C<guestfs_ping_daemon>."
9419 #: ../src/guestfs-actions.pod:1420 ../src/guestfs-actions.pod:2156
9420 #: ../src/guestfs-actions.pod:6410
9421 msgid "(Added in 1.0.69)"
9426 #: ../src/guestfs-actions.pod:1422
9427 msgid "guestfs_egrep"
9432 #: ../src/guestfs-actions.pod:1424
9436 " guestfs_egrep (guestfs_h *g,\n"
9437 " const char *regex,\n"
9438 " const char *path);\n"
9444 #: ../src/guestfs-actions.pod:1429 ../fish/guestfish-actions.pod:937
9446 "This calls the external C<egrep> program and returns the matching lines."
9451 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
9452 #: ../src/guestfs-actions.pod:1515 ../src/guestfs-actions.pod:1561
9453 #: ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:2286
9454 #: ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2461
9455 #: ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2489
9456 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:2557
9457 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:3839
9458 #: ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3866
9459 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4881
9460 #: ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5955
9461 #: ../src/guestfs-actions.pod:6806 ../src/guestfs-actions.pod:6818
9462 #: ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6844
9463 #: ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:6879
9464 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
9465 #: ../src/guestfs-actions.pod:7677 ../src/guestfs-actions.pod:7696
9466 #: ../src/guestfs-actions.pod:7782 ../src/guestfs-actions.pod:7801
9467 #: ../src/guestfs-actions.pod:7847 ../src/guestfs-actions.pod:7866
9468 msgid "(Added in 1.0.66)"
9473 #: ../src/guestfs-actions.pod:1441
9474 msgid "guestfs_egrepi"
9479 #: ../src/guestfs-actions.pod:1443
9483 " guestfs_egrepi (guestfs_h *g,\n"
9484 " const char *regex,\n"
9485 " const char *path);\n"
9491 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:947
9493 "This calls the external C<egrep -i> program and returns the matching lines."
9498 #: ../src/guestfs-actions.pod:1460
9499 msgid "guestfs_equal"
9504 #: ../src/guestfs-actions.pod:1462
9508 " guestfs_equal (guestfs_h *g,\n"
9509 " const char *file1,\n"
9510 " const char *file2);\n"
9516 #: ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:957
9518 "This compares the two files C<file1> and C<file2> and returns true if their "
9519 "content is exactly equal, or false otherwise."
9524 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:960
9525 msgid "The external L<cmp(1)> program is used for the comparison."
9530 #: ../src/guestfs-actions.pod:1476
9531 msgid "guestfs_exists"
9536 #: ../src/guestfs-actions.pod:1478
9540 " guestfs_exists (guestfs_h *g,\n"
9541 " const char *path);\n"
9547 #: ../src/guestfs-actions.pod:1482 ../fish/guestfish-actions.pod:966
9549 "This returns C<true> if and only if there is a file, directory (or anything) "
9550 "with the given C<path> name."
9555 #: ../src/guestfs-actions.pod:1485
9556 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9561 #: ../src/guestfs-actions.pod:1491
9562 msgid "guestfs_fallocate"
9567 #: ../src/guestfs-actions.pod:1493
9571 " guestfs_fallocate (guestfs_h *g,\n"
9572 " const char *path,\n"
9579 #: ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1524
9580 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
9582 "This command preallocates a file (containing zero bytes) named C<path> of "
9583 "size C<len> bytes. If the file exists already, it is overwritten."
9588 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:979
9590 "Do not confuse this with the guestfish-specific C<alloc> command which "
9591 "allocates a file in the host and attaches it as a device."
9596 #: ../src/guestfs-actions.pod:1508 ../fish/guestfish-actions.pod:983
9598 "This function is deprecated. In new code, use the C<fallocate64> call "
9604 #: ../src/guestfs-actions.pod:1517
9605 msgid "guestfs_fallocate64"
9610 #: ../src/guestfs-actions.pod:1519
9614 " guestfs_fallocate64 (guestfs_h *g,\n"
9615 " const char *path,\n"
9622 #: ../src/guestfs-actions.pod:1528
9624 "Note that this call allocates disk blocks for the file. To create a sparse "
9625 "file use C<guestfs_truncate_size> instead."
9630 #: ../src/guestfs-actions.pod:1531
9632 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9633 "oversight it only allowed 30 bit lengths to be specified, effectively "
9634 "limiting the maximum size of files created through that call to 1GB."
9639 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1006
9641 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9642 "commands which create a file in the host and attach it as a device."
9647 #: ../src/guestfs-actions.pod:1542
9648 msgid "(Added in 1.3.17)"
9653 #: ../src/guestfs-actions.pod:1544
9654 msgid "guestfs_fgrep"
9659 #: ../src/guestfs-actions.pod:1546
9663 " guestfs_fgrep (guestfs_h *g,\n"
9664 " const char *pattern,\n"
9665 " const char *path);\n"
9671 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1014
9673 "This calls the external C<fgrep> program and returns the matching lines."
9678 #: ../src/guestfs-actions.pod:1563
9679 msgid "guestfs_fgrepi"
9684 #: ../src/guestfs-actions.pod:1565
9688 " guestfs_fgrepi (guestfs_h *g,\n"
9689 " const char *pattern,\n"
9690 " const char *path);\n"
9696 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1024
9698 "This calls the external C<fgrep -i> program and returns the matching lines."
9703 #: ../src/guestfs-actions.pod:1582
9704 msgid "guestfs_file"
9709 #: ../src/guestfs-actions.pod:1584
9713 " guestfs_file (guestfs_h *g,\n"
9714 " const char *path);\n"
9720 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1034
9722 "This call uses the standard L<file(1)> command to determine the type or "
9723 "contents of the file."
9728 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1037
9730 "This call will also transparently look inside various types of compressed "
9735 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1040
9737 "The exact command which runs is C<file -zb path>. Note in particular that "
9738 "the filename is not prepended to the output (the I<-b> option)."
9742 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1044
9744 "The output depends on the output of the underlying L<file(1)> command and it "
9745 "can change in future in ways beyond our control. In other words, the output "
9746 "is not guaranteed by the ABI."
9750 #: ../src/guestfs-actions.pod:1602
9752 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9753 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
9758 #: ../src/guestfs-actions.pod:1610
9759 msgid "guestfs_file_architecture"
9764 #: ../src/guestfs-actions.pod:1612
9768 " guestfs_file_architecture (guestfs_h *g,\n"
9769 " const char *filename);\n"
9775 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1055
9777 "This detects the architecture of the binary C<filename>, and returns it if "
9783 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1058
9784 msgid "Currently defined architectures are:"
9789 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1062
9795 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1064
9797 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9798 "irrespective of the precise processor requirements of the binary."
9803 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1067
9809 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1069
9810 msgid "64 bit x86-64."
9815 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1071
9821 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1073
9822 msgid "32 bit SPARC."
9827 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1075
9833 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1077
9834 msgid "64 bit SPARC V9 and above."
9839 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1079
9845 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1081
9846 msgid "Intel Itanium."
9851 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1083
9857 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1085
9858 msgid "32 bit Power PC."
9863 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1087
9869 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1089
9870 msgid "64 bit Power PC."
9875 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1093
9876 msgid "Libguestfs may return other architecture strings in future."
9881 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1095
9882 msgid "The function works on at least the following types of files:"
9887 #: ../src/guestfs-actions.pod:1662 ../fish/guestfish-actions.pod:1101
9888 msgid "many types of Un*x and Linux binary"
9893 #: ../src/guestfs-actions.pod:1666 ../fish/guestfish-actions.pod:1105
9894 msgid "many types of Un*x and Linux shared library"
9899 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1109
9900 msgid "Windows Win32 and Win64 binaries"
9905 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1113
9906 msgid "Windows Win32 and Win64 DLLs"
9911 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1115
9912 msgid "Win32 binaries and DLLs return C<i386>."
9917 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1117
9918 msgid "Win64 binaries and DLLs return C<x86_64>."
9923 #: ../src/guestfs-actions.pod:1682 ../fish/guestfish-actions.pod:1121
9924 msgid "Linux kernel modules"
9929 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1125
9930 msgid "Linux new-style initrd images"
9935 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1129
9936 msgid "some non-x86 Linux vmlinuz kernels"
9941 #: ../src/guestfs-actions.pod:1694 ../fish/guestfish-actions.pod:1133
9942 msgid "What it can't do currently:"
9947 #: ../src/guestfs-actions.pod:1700 ../fish/guestfish-actions.pod:1139
9948 msgid "static libraries (libfoo.a)"
9953 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1143
9954 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9959 #: ../src/guestfs-actions.pod:1708 ../fish/guestfish-actions.pod:1147
9960 msgid "x86 Linux vmlinuz kernels"
9965 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1149
9967 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9968 "compressed code, and are horribly hard to unpack. If you want to find the "
9969 "architecture of a kernel, use the architecture of the associated initrd or "
9970 "kernel module(s) instead."
9975 #: ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1883
9976 #: ../src/guestfs-actions.pod:1900 ../src/guestfs-actions.pod:2590
9977 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2746
9978 #: ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2951
9979 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3066
9980 #: ../src/guestfs-actions.pod:3159 ../src/guestfs-actions.pod:3396
9981 #: ../src/guestfs-actions.pod:3528
9982 msgid "(Added in 1.5.3)"
9987 #: ../src/guestfs-actions.pod:1722
9988 msgid "guestfs_filesize"
9993 #: ../src/guestfs-actions.pod:1724
9997 " guestfs_filesize (guestfs_h *g,\n"
9998 " const char *file);\n"
10004 #: ../src/guestfs-actions.pod:1728 ../fish/guestfish-actions.pod:1160
10005 msgid "This command returns the size of C<file> in bytes."
10010 #: ../src/guestfs-actions.pod:1730
10012 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
10013 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
10014 "devices, use C<guestfs_blockdev_getsize64>."
10019 #: ../src/guestfs-actions.pod:1736
10020 msgid "(Added in 1.0.82)"
10025 #: ../src/guestfs-actions.pod:1738
10026 msgid "guestfs_fill"
10031 #: ../src/guestfs-actions.pod:1740
10035 " guestfs_fill (guestfs_h *g,\n"
10038 " const char *path);\n"
10044 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1170
10046 "This command creates a new file called C<path>. The initial content of the "
10047 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
10053 #: ../src/guestfs-actions.pod:1750
10055 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
10056 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
10057 "bytes use C<guestfs_fill_pattern>."
10062 #: ../src/guestfs-actions.pod:1762
10063 msgid "(Added in 1.0.79)"
10068 #: ../src/guestfs-actions.pod:1764
10069 msgid "guestfs_fill_pattern"
10074 #: ../src/guestfs-actions.pod:1766
10078 " guestfs_fill_pattern (guestfs_h *g,\n"
10079 " const char *pattern,\n"
10081 " const char *path);\n"
10087 #: ../src/guestfs-actions.pod:1772
10089 "This function is like C<guestfs_fill> except that it creates a new file of "
10090 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
10091 "pattern is truncated if necessary to ensure the length of the file is "
10092 "exactly C<len> bytes."
10097 #: ../src/guestfs-actions.pod:1784
10098 msgid "(Added in 1.3.12)"
10103 #: ../src/guestfs-actions.pod:1786
10104 msgid "guestfs_find"
10109 #: ../src/guestfs-actions.pod:1788
10113 " guestfs_find (guestfs_h *g,\n"
10114 " const char *directory);\n"
10120 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1192
10122 "This command lists out all files and directories, recursively, starting at "
10123 "C<directory>. It is essentially equivalent to running the shell command "
10124 "C<find directory -print> but some post-processing happens on the output, "
10130 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1197
10132 "This returns a list of strings I<without any prefix>. Thus if the directory "
10138 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1200
10149 #: ../src/guestfs-actions.pod:1804
10151 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10156 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1207
10168 #: ../src/guestfs-actions.pod:1812 ../fish/guestfish-actions.pod:1212
10169 msgid "If C<directory> is not a directory, then this command returns an error."
10174 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1215
10175 msgid "The returned list is sorted."
10180 #: ../src/guestfs-actions.pod:1817
10181 msgid "See also C<guestfs_find0>."
10186 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:4286
10187 #: ../src/guestfs-actions.pod:5990
10188 msgid "(Added in 1.0.27)"
10193 #: ../src/guestfs-actions.pod:1828
10194 msgid "guestfs_find0"
10199 #: ../src/guestfs-actions.pod:1830
10203 " guestfs_find0 (guestfs_h *g,\n"
10204 " const char *directory,\n"
10205 " const char *files);\n"
10211 #: ../src/guestfs-actions.pod:1835 ../fish/guestfish-actions.pod:1226
10213 "This command lists out all files and directories, recursively, starting at "
10214 "C<directory>, placing the resulting list in the external file called "
10220 #: ../src/guestfs-actions.pod:1839
10222 "This command works the same way as C<guestfs_find> with the following "
10228 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1237
10229 msgid "The resulting list is written to an external file."
10234 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1241
10236 "Items (filenames) in the result are separated by C<\\0> characters. See "
10237 "L<find(1)> option I<-print0>."
10242 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1246
10243 msgid "This command is not limited in the number of names that it can return."
10248 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1251
10249 msgid "The result list is not sorted."
10254 #: ../src/guestfs-actions.pod:1866
10255 msgid "(Added in 1.0.74)"
10260 #: ../src/guestfs-actions.pod:1868
10261 msgid "guestfs_findfs_label"
10266 #: ../src/guestfs-actions.pod:1870
10270 " guestfs_findfs_label (guestfs_h *g,\n"
10271 " const char *label);\n"
10277 #: ../src/guestfs-actions.pod:1874 ../fish/guestfish-actions.pod:1261
10279 "This command searches the filesystems and returns the one which has the "
10280 "given label. An error is returned if no such filesystem can be found."
10285 #: ../src/guestfs-actions.pod:1878
10286 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10291 #: ../src/guestfs-actions.pod:1885
10292 msgid "guestfs_findfs_uuid"
10297 #: ../src/guestfs-actions.pod:1887
10301 " guestfs_findfs_uuid (guestfs_h *g,\n"
10302 " const char *uuid);\n"
10308 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1271
10310 "This command searches the filesystems and returns the one which has the "
10311 "given UUID. An error is returned if no such filesystem can be found."
10316 #: ../src/guestfs-actions.pod:1895
10317 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10322 #: ../src/guestfs-actions.pod:1902
10323 msgid "guestfs_fsck"
10328 #: ../src/guestfs-actions.pod:1904
10332 " guestfs_fsck (guestfs_h *g,\n"
10333 " const char *fstype,\n"
10334 " const char *device);\n"
10340 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1281
10342 "This runs the filesystem checker (fsck) on C<device> which should have "
10343 "filesystem type C<fstype>."
10348 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1284
10350 "The returned integer is the status. See L<fsck(8)> for the list of status "
10351 "codes from C<fsck>."
10356 #: ../src/guestfs-actions.pod:1921 ../fish/guestfish-actions.pod:1293
10357 msgid "Multiple status codes can be summed together."
10362 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1297
10364 "A non-zero return code can mean \"success\", for example if errors have been "
10365 "corrected on the filesystem."
10370 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1302
10371 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10376 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1307
10378 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10383 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:7720
10384 msgid "(Added in 1.0.16)"
10389 #: ../src/guestfs-actions.pod:1941
10390 msgid "guestfs_get_append"
10395 #: ../src/guestfs-actions.pod:1943
10399 " guestfs_get_append (guestfs_h *g);\n"
10405 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1313
10407 "Return the additional kernel options which are added to the guest kernel "
10413 #: ../src/guestfs-actions.pod:1949 ../fish/guestfish-actions.pod:1316
10414 msgid "If C<NULL> then no options are added."
10419 #: ../src/guestfs-actions.pod:1951
10421 "This function returns a string which may be NULL. There is no way to return "
10422 "an error from this function. The string is owned by the guest handle and "
10423 "must I<not> be freed."
10428 #: ../src/guestfs-actions.pod:1955 ../src/guestfs-actions.pod:5668
10429 #: ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6573
10430 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6608
10431 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:7386
10432 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7763
10433 msgid "(Added in 1.0.26)"
10437 #: ../src/guestfs-actions.pod:1957
10438 msgid "guestfs_get_attach_method"
10442 #: ../src/guestfs-actions.pod:1959
10446 " guestfs_get_attach_method (guestfs_h *g);\n"
10451 #: ../src/guestfs-actions.pod:1962
10452 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10456 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:6180
10457 msgid "(Added in 1.9.8)"
10462 #: ../src/guestfs-actions.pod:1969
10463 msgid "guestfs_get_autosync"
10468 #: ../src/guestfs-actions.pod:1971
10472 " guestfs_get_autosync (guestfs_h *g);\n"
10478 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1328
10479 msgid "Get the autosync flag."
10484 #: ../src/guestfs-actions.pod:1980
10485 msgid "guestfs_get_direct"
10490 #: ../src/guestfs-actions.pod:1982
10494 " guestfs_get_direct (guestfs_h *g);\n"
10500 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1334
10501 msgid "Return the direct appliance mode flag."
10506 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:6221
10507 msgid "(Added in 1.0.72)"
10512 #: ../src/guestfs-actions.pod:1991
10513 msgid "guestfs_get_e2label"
10518 #: ../src/guestfs-actions.pod:1993
10522 " guestfs_get_e2label (guestfs_h *g,\n"
10523 " const char *device);\n"
10529 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1340
10531 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10536 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1343
10538 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10543 #: ../src/guestfs-actions.pod:2010 ../src/guestfs-actions.pod:2031
10544 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6258
10545 msgid "(Added in 1.0.15)"
10550 #: ../src/guestfs-actions.pod:2012
10551 msgid "guestfs_get_e2uuid"
10556 #: ../src/guestfs-actions.pod:2014
10560 " guestfs_get_e2uuid (guestfs_h *g,\n"
10561 " const char *device);\n"
10567 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1354
10569 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10574 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1357
10576 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10581 #: ../src/guestfs-actions.pod:2033
10582 msgid "guestfs_get_memsize"
10587 #: ../src/guestfs-actions.pod:2035
10591 " guestfs_get_memsize (guestfs_h *g);\n"
10597 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1368
10599 "This gets the memory size in megabytes allocated to the qemu subprocess."
10604 #: ../src/guestfs-actions.pod:2041
10606 "If C<guestfs_set_memsize> was not called on this handle, and if "
10607 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10608 "value for memsize."
10613 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:2126
10614 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6381
10615 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1426
10616 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4238
10618 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10623 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:4577
10624 #: ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4805
10625 #: ../src/guestfs-actions.pod:4824 ../src/guestfs-actions.pod:4836
10626 #: ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:4866
10627 #: ../src/guestfs-actions.pod:5893 ../src/guestfs-actions.pod:6279
10628 #: ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:7155
10629 msgid "(Added in 1.0.55)"
10634 #: ../src/guestfs-actions.pod:2052
10635 msgid "guestfs_get_network"
10640 #: ../src/guestfs-actions.pod:2054
10644 " guestfs_get_network (guestfs_h *g);\n"
10650 #: ../src/guestfs-actions.pod:2057 ../fish/guestfish-actions.pod:1382
10651 msgid "This returns the enable network flag."
10656 #: ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:6298
10657 msgid "(Added in 1.5.4)"
10662 #: ../src/guestfs-actions.pod:2063
10663 msgid "guestfs_get_path"
10668 #: ../src/guestfs-actions.pod:2065
10672 " guestfs_get_path (guestfs_h *g);\n"
10678 #: ../src/guestfs-actions.pod:2068 ../fish/guestfish-actions.pod:1388
10679 msgid "Return the current search path."
10684 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1390
10686 "This is always non-NULL. If it wasn't set already, then this will return "
10687 "the default path."
10692 #: ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:2102
10694 "This function returns a string, or NULL on error. The string is owned by "
10695 "the guest handle and must I<not> be freed."
10700 #: ../src/guestfs-actions.pod:2078
10701 msgid "guestfs_get_pid"
10706 #: ../src/guestfs-actions.pod:2080
10710 " guestfs_get_pid (guestfs_h *g);\n"
10716 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1399
10718 "Return the process ID of the qemu subprocess. If there is no qemu "
10719 "subprocess, then this will return an error."
10724 #: ../src/guestfs-actions.pod:2086 ../fish/guestfish-actions.pod:1402
10725 msgid "This is an internal call used for debugging and testing."
10730 #: ../src/guestfs-actions.pod:2090
10731 msgid "(Added in 1.0.56)"
10736 #: ../src/guestfs-actions.pod:2092
10737 msgid "guestfs_get_qemu"
10742 #: ../src/guestfs-actions.pod:2094
10746 " guestfs_get_qemu (guestfs_h *g);\n"
10752 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
10753 msgid "Return the current qemu binary."
10758 #: ../src/guestfs-actions.pod:2099 ../fish/guestfish-actions.pod:1410
10760 "This is always non-NULL. If it wasn't set already, then this will return "
10761 "the default qemu binary name."
10766 #: ../src/guestfs-actions.pod:2105 ../src/guestfs-actions.pod:6343
10767 msgid "(Added in 1.0.6)"
10772 #: ../src/guestfs-actions.pod:2107
10773 msgid "guestfs_get_recovery_proc"
10778 #: ../src/guestfs-actions.pod:2109
10782 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10788 #: ../src/guestfs-actions.pod:2112 ../fish/guestfish-actions.pod:1417
10789 msgid "Return the recovery process enabled flag."
10794 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:3650
10795 #: ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4384
10796 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:5598
10797 #: ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6367
10798 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
10799 #: ../src/guestfs-actions.pod:7270
10800 msgid "(Added in 1.0.77)"
10805 #: ../src/guestfs-actions.pod:2118
10806 msgid "guestfs_get_selinux"
10811 #: ../src/guestfs-actions.pod:2120
10815 " guestfs_get_selinux (guestfs_h *g);\n"
10821 #: ../src/guestfs-actions.pod:2123
10823 "This returns the current setting of the selinux flag which is passed to the "
10824 "appliance at boot time. See C<guestfs_set_selinux>."
10829 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:2194
10830 #: ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6444
10831 msgid "(Added in 1.0.67)"
10836 #: ../src/guestfs-actions.pod:2133
10837 msgid "guestfs_get_state"
10842 #: ../src/guestfs-actions.pod:2135
10846 " guestfs_get_state (guestfs_h *g);\n"
10852 #: ../src/guestfs-actions.pod:2138 ../fish/guestfish-actions.pod:1433
10854 "This returns the current state as an opaque integer. This is only useful "
10855 "for printing debug and internal error messages."
10860 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3421
10861 #: ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:3511
10862 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:1436
10863 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2374
10864 #: ../fish/guestfish-actions.pod:2412 ../fish/guestfish-actions.pod:2428
10865 msgid "For more information on states, see L<guestfs(3)>."
10870 #: ../src/guestfs-actions.pod:2147
10871 msgid "guestfs_get_trace"
10876 #: ../src/guestfs-actions.pod:2149
10880 " guestfs_get_trace (guestfs_h *g);\n"
10886 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1442
10887 msgid "Return the command trace flag."
10892 #: ../src/guestfs-actions.pod:2158
10893 msgid "guestfs_get_umask"
10898 #: ../src/guestfs-actions.pod:2160
10902 " guestfs_get_umask (guestfs_h *g);\n"
10908 #: ../src/guestfs-actions.pod:2163
10910 "Return the current umask. By default the umask is C<022> unless it has been "
10911 "set by calling C<guestfs_umask>."
10916 #: ../src/guestfs-actions.pod:2170
10917 msgid "guestfs_get_verbose"
10922 #: ../src/guestfs-actions.pod:2172
10926 " guestfs_get_verbose (guestfs_h *g);\n"
10932 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1455
10933 msgid "This returns the verbose messages flag."
10938 #: ../src/guestfs-actions.pod:2181
10939 msgid "guestfs_getcon"
10944 #: ../src/guestfs-actions.pod:2183
10948 " guestfs_getcon (guestfs_h *g);\n"
10954 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
10955 msgid "This gets the SELinux security context of the daemon."
10960 #: ../src/guestfs-actions.pod:2188
10962 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10967 #: ../src/guestfs-actions.pod:2196
10968 msgid "guestfs_getxattr"
10973 #: ../src/guestfs-actions.pod:2198
10977 " guestfs_getxattr (guestfs_h *g,\n"
10978 " const char *path,\n"
10979 " const char *name,\n"
10980 " size_t *size_r);\n"
10986 #: ../src/guestfs-actions.pod:2204
10988 "Get a single extended attribute from file C<path> named C<name>. This call "
10989 "follows symlinks. If you want to lookup an extended attribute for the "
10990 "symlink itself, use C<guestfs_lgetxattr>."
10995 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:3664
10997 "Normally it is better to get all extended attributes from a file in one go "
10998 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10999 "implementations are buggy and do not provide a way to list out attributes. "
11000 "For these filesystems (notably ntfs-3g) you have to know the names of the "
11001 "extended attributes you want in advance and call this function."
11006 #: ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:3671
11007 #: ../fish/guestfish-actions.pod:1481 ../fish/guestfish-actions.pod:2508
11009 "Extended attribute values are blobs of binary data. If there is no extended "
11010 "attribute named C<name>, this returns an error."
11015 #: ../src/guestfs-actions.pod:2218
11016 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
11021 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2411
11022 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:3676
11023 #: ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5617
11024 #: ../src/guestfs-actions.pod:5798
11026 "This function returns a buffer, or NULL on error. The size of the returned "
11027 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
11032 #: ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:3680
11033 msgid "(Added in 1.7.24)"
11038 #: ../src/guestfs-actions.pod:2226
11039 msgid "guestfs_getxattrs"
11044 #: ../src/guestfs-actions.pod:2228
11047 " struct guestfs_xattr_list *\n"
11048 " guestfs_getxattrs (guestfs_h *g,\n"
11049 " const char *path);\n"
11055 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1490
11057 "This call lists the extended attributes of the file or directory C<path>."
11062 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1493
11064 "At the system call level, this is a combination of the L<listxattr(2)> and "
11065 "L<getxattr(2)> calls."
11070 #: ../src/guestfs-actions.pod:2238
11071 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
11076 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:3692
11077 #: ../src/guestfs-actions.pod:4380
11079 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
11080 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
11085 #: ../src/guestfs-actions.pod:2244 ../src/guestfs-actions.pod:3696
11086 #: ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3931
11087 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6463
11088 #: ../src/guestfs-actions.pod:7828
11089 msgid "(Added in 1.0.59)"
11094 #: ../src/guestfs-actions.pod:2246
11095 msgid "guestfs_glob_expand"
11100 #: ../src/guestfs-actions.pod:2248
11104 " guestfs_glob_expand (guestfs_h *g,\n"
11105 " const char *pattern);\n"
11111 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1502
11113 "This command searches for all the pathnames matching C<pattern> according to "
11114 "the wildcard expansion rules used by the shell."
11119 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1506
11121 "If no paths match, then this returns an empty list (note: not an error)."
11126 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1509
11128 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
11129 "GLOB_BRACE>. See that manual page for more details."
11134 #: ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:6656
11135 #: ../src/guestfs-actions.pod:6673
11136 msgid "(Added in 1.0.50)"
11141 #: ../src/guestfs-actions.pod:2269
11142 msgid "guestfs_grep"
11147 #: ../src/guestfs-actions.pod:2271
11151 " guestfs_grep (guestfs_h *g,\n"
11152 " const char *regex,\n"
11153 " const char *path);\n"
11159 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1517
11160 msgid "This calls the external C<grep> program and returns the matching lines."
11165 #: ../src/guestfs-actions.pod:2288
11166 msgid "guestfs_grepi"
11171 #: ../src/guestfs-actions.pod:2290
11175 " guestfs_grepi (guestfs_h *g,\n"
11176 " const char *regex,\n"
11177 " const char *path);\n"
11183 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1527
11185 "This calls the external C<grep -i> program and returns the matching lines."
11190 #: ../src/guestfs-actions.pod:2307
11191 msgid "guestfs_grub_install"
11196 #: ../src/guestfs-actions.pod:2309
11200 " guestfs_grub_install (guestfs_h *g,\n"
11201 " const char *root,\n"
11202 " const char *device);\n"
11208 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1537
11210 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11211 "the root directory being C<root>."
11216 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1540
11218 "Note: If grub-install reports the error \"No suitable drive was found in the "
11219 "generated device map.\" it may be that you need to create a C</boot/grub/"
11220 "device.map> file first that contains the mapping between grub device names "
11221 "and Linux device names. It is usually sufficient to create a file "
11227 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1547
11230 " (hd0) /dev/vda\n"
11236 #: ../src/guestfs-actions.pod:2326 ../fish/guestfish-actions.pod:1549
11237 msgid "replacing C</dev/vda> with the name of the installation device."
11242 #: ../src/guestfs-actions.pod:2330
11243 msgid "(Added in 1.0.17)"
11248 #: ../src/guestfs-actions.pod:2332
11249 msgid "guestfs_head"
11254 #: ../src/guestfs-actions.pod:2334
11258 " guestfs_head (guestfs_h *g,\n"
11259 " const char *path);\n"
11265 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1555
11267 "This command returns up to the first 10 lines of a file as a list of strings."
11272 #: ../src/guestfs-actions.pod:2350
11273 msgid "guestfs_head_n"
11278 #: ../src/guestfs-actions.pod:2352
11282 " guestfs_head_n (guestfs_h *g,\n"
11284 " const char *path);\n"
11290 #: ../src/guestfs-actions.pod:2357 ../fish/guestfish-actions.pod:1565
11292 "If the parameter C<nrlines> is a positive number, this returns the first "
11293 "C<nrlines> lines of the file C<path>."
11298 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1568
11300 "If the parameter C<nrlines> is a negative number, this returns lines from "
11301 "the file C<path>, excluding the last C<nrlines> lines."
11306 #: ../src/guestfs-actions.pod:2363 ../src/guestfs-actions.pod:6953
11307 #: ../fish/guestfish-actions.pod:1571 ../fish/guestfish-actions.pod:4616
11308 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11313 #: ../src/guestfs-actions.pod:2374
11314 msgid "guestfs_hexdump"
11319 #: ../src/guestfs-actions.pod:2376
11323 " guestfs_hexdump (guestfs_h *g,\n"
11324 " const char *path);\n"
11330 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1580
11332 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11333 "readable, canonical hex dump of the file."
11338 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:6737
11339 #: ../src/guestfs-actions.pod:6792
11340 msgid "(Added in 1.0.22)"
11345 #: ../src/guestfs-actions.pod:2391
11346 msgid "guestfs_initrd_cat"
11351 #: ../src/guestfs-actions.pod:2393
11355 " guestfs_initrd_cat (guestfs_h *g,\n"
11356 " const char *initrdpath,\n"
11357 " const char *filename,\n"
11358 " size_t *size_r);\n"
11364 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1590
11366 "This command unpacks the file C<filename> from the initrd file called "
11367 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11373 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1594
11375 "For example, in guestfish you could use the following command to examine the "
11376 "boot script (usually called C</init>) contained in a Linux initrd or "
11382 #: ../src/guestfs-actions.pod:2407 ../fish/guestfish-actions.pod:1598
11385 " initrd-cat /boot/initrd-<version>.img init\n"
11391 #: ../src/guestfs-actions.pod:2409
11392 msgid "See also C<guestfs_initrd_list>."
11397 #: ../src/guestfs-actions.pod:2420
11398 msgid "guestfs_initrd_list"
11403 #: ../src/guestfs-actions.pod:2422
11407 " guestfs_initrd_list (guestfs_h *g,\n"
11408 " const char *path);\n"
11414 #: ../src/guestfs-actions.pod:2426 ../fish/guestfish-actions.pod:1609
11415 msgid "This command lists out files contained in an initrd."
11420 #: ../src/guestfs-actions.pod:2428 ../fish/guestfish-actions.pod:1611
11422 "The files are listed without any initial C</> character. The files are "
11423 "listed in the order they appear (not necessarily alphabetical). Directory "
11424 "names are listed as separate items."
11429 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1615
11431 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11432 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11438 #: ../src/guestfs-actions.pod:2442
11439 msgid "guestfs_inotify_add_watch"
11444 #: ../src/guestfs-actions.pod:2444
11448 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11449 " const char *path,\n"
11456 #: ../src/guestfs-actions.pod:2449 ../fish/guestfish-actions.pod:1623
11457 msgid "Watch C<path> for the events listed in C<mask>."
11462 #: ../src/guestfs-actions.pod:2451 ../fish/guestfish-actions.pod:1625
11464 "Note that if C<path> is a directory then events within that directory are "
11465 "watched, but this does I<not> happen recursively (in subdirectories)."
11470 #: ../src/guestfs-actions.pod:2455 ../fish/guestfish-actions.pod:1629
11472 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11473 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11478 #: ../src/guestfs-actions.pod:2463
11479 msgid "guestfs_inotify_close"
11484 #: ../src/guestfs-actions.pod:2465
11488 " guestfs_inotify_close (guestfs_h *g);\n"
11494 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1637
11496 "This closes the inotify handle which was previously opened by inotify_init. "
11497 "It removes all watches, throws away any pending events, and deallocates all "
11503 #: ../src/guestfs-actions.pod:2476
11504 msgid "guestfs_inotify_files"
11509 #: ../src/guestfs-actions.pod:2478
11513 " guestfs_inotify_files (guestfs_h *g);\n"
11519 #: ../src/guestfs-actions.pod:2481
11521 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11522 "returns a list of pathnames of objects that were touched. The returned "
11523 "pathnames are sorted and deduplicated."
11528 #: ../src/guestfs-actions.pod:2491
11529 msgid "guestfs_inotify_init"
11534 #: ../src/guestfs-actions.pod:2493
11538 " guestfs_inotify_init (guestfs_h *g,\n"
11539 " int maxevents);\n"
11545 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1653
11547 "This command creates a new inotify handle. The inotify subsystem can be "
11548 "used to notify events which happen to objects in the guest filesystem."
11553 #: ../src/guestfs-actions.pod:2501
11555 "C<maxevents> is the maximum number of events which will be queued up between "
11556 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11557 "passed as C<0>, then the kernel (or previously set) default is used. For "
11558 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11559 "throws away events, but records the fact that it threw them away by setting "
11560 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11561 "C<guestfs_inotify_read>)."
11566 #: ../src/guestfs-actions.pod:2511
11568 "Before any events are generated, you have to add some watches to the "
11569 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11570 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11575 #: ../src/guestfs-actions.pod:2517
11577 "Queued up events should be read periodically by calling "
11578 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11579 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11580 "often enough then you risk the internal queue overflowing."
11585 #: ../src/guestfs-actions.pod:2524
11587 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11588 "This also removes any watches automatically."
11593 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1684
11595 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11596 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11597 "that there is one global inotify handle per libguestfs instance."
11602 #: ../src/guestfs-actions.pod:2537
11603 msgid "guestfs_inotify_read"
11608 #: ../src/guestfs-actions.pod:2539
11611 " struct guestfs_inotify_event_list *\n"
11612 " guestfs_inotify_read (guestfs_h *g);\n"
11618 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1693
11620 "Return the complete queue of events that have happened since the previous "
11626 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1696
11627 msgid "If no events have happened, this returns an empty list."
11632 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1698
11634 "I<Note>: In order to make sure that all events have been read, you must call "
11635 "this function repeatedly until it returns an empty list. The reason is that "
11636 "the call will read events up to the maximum appliance-to-host message size "
11637 "and leave remaining events in the queue."
11642 #: ../src/guestfs-actions.pod:2553
11644 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11645 "there was an error. I<The caller must call "
11646 "C<guestfs_free_inotify_event_list> after use>."
11651 #: ../src/guestfs-actions.pod:2559
11652 msgid "guestfs_inotify_rm_watch"
11657 #: ../src/guestfs-actions.pod:2561
11661 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11668 #: ../src/guestfs-actions.pod:2565
11670 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11675 #: ../src/guestfs-actions.pod:2572
11676 msgid "guestfs_inspect_get_arch"
11681 #: ../src/guestfs-actions.pod:2574
11685 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11686 " const char *root);\n"
11692 #: ../src/guestfs-actions.pod:2578
11694 "This returns the architecture of the inspected operating system. The "
11695 "possible return values are listed under C<guestfs_file_architecture>."
11700 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1719
11702 "If the architecture could not be determined, then the string C<unknown> is "
11708 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2675
11709 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2798
11710 #: ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:3012
11711 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3061
11712 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3154
11713 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3194
11714 #: ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3227
11715 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3347
11716 #: ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:1722
11717 #: ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1884
11718 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1980
11719 #: ../fish/guestfish-actions.pod:2041 ../fish/guestfish-actions.pod:2062
11720 #: ../fish/guestfish-actions.pod:2076 ../fish/guestfish-actions.pod:2116
11721 #: ../fish/guestfish-actions.pod:2148 ../fish/guestfish-actions.pod:2161
11722 #: ../fish/guestfish-actions.pod:2174 ../fish/guestfish-actions.pod:2184
11723 #: ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2206
11724 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2336
11725 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11730 #: ../src/guestfs-actions.pod:2592
11731 msgid "guestfs_inspect_get_distro"
11736 #: ../src/guestfs-actions.pod:2594
11740 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11741 " const char *root);\n"
11747 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1728
11749 "This returns the distro (distribution) of the inspected operating system."
11754 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1731
11755 msgid "Currently defined distros are:"
11760 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1735
11761 msgid "\"archlinux\""
11766 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1737
11767 msgid "Arch Linux."
11771 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1739
11776 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1741
11782 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1743
11788 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1745
11794 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1747
11800 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1749
11806 #: ../src/guestfs-actions.pod:2621 ../fish/guestfish-actions.pod:1751
11812 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1753
11818 #: ../src/guestfs-actions.pod:2625 ../fish/guestfish-actions.pod:1755
11819 msgid "\"linuxmint\""
11824 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1757
11825 msgid "Linux Mint."
11830 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1759
11831 msgid "\"mandriva\""
11836 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1761
11842 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1763
11848 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1765
11854 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1767
11860 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1769
11866 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1771
11867 msgid "\"redhat-based\""
11872 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1773
11873 msgid "Some Red Hat-derived distro."
11878 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1775
11883 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1777
11884 msgid "Red Hat Enterprise Linux."
11888 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1779
11889 msgid "\"scientificlinux\""
11893 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1781
11894 msgid "Scientific Linux."
11898 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1783
11899 msgid "\"slackware\""
11903 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1785
11909 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1787
11915 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1789
11921 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2770
11922 #: ../src/guestfs-actions.pod:3145 ../fish/guestfish-actions.pod:1791
11923 #: ../fish/guestfish-actions.pod:1875 ../fish/guestfish-actions.pod:2139
11924 msgid "\"unknown\""
11929 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1793
11930 msgid "The distro could not be determined."
11935 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:3137
11936 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:2131
11937 msgid "\"windows\""
11942 #: ../src/guestfs-actions.pod:2667 ../fish/guestfish-actions.pod:1797
11944 "Windows does not have distributions. This string is returned if the OS type "
11950 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2776
11951 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1802
11952 #: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
11954 "Future versions of libguestfs may return other strings here. The caller "
11955 "should be prepared to handle any string."
11959 #: ../src/guestfs-actions.pod:2682
11960 msgid "guestfs_inspect_get_drive_mappings"
11964 #: ../src/guestfs-actions.pod:2684
11968 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11969 " const char *root);\n"
11974 #: ../src/guestfs-actions.pod:2688 ../fish/guestfish-actions.pod:1811
11976 "This call is useful for Windows which uses a primitive system of assigning "
11977 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11978 "Windows Registry to find out how disks/partitions are mapped to drive "
11979 "letters, and returns a hash table as in the example below:"
11983 #: ../src/guestfs-actions.pod:2694 ../fish/guestfish-actions.pod:1817
11986 " C => /dev/vda2\n"
11987 " E => /dev/vdb1\n"
11988 " F => /dev/vdc1\n"
11993 #: ../src/guestfs-actions.pod:2698 ../fish/guestfish-actions.pod:1821
11995 "Note that keys are drive letters. For Windows, the key is case insensitive "
11996 "and just contains the drive letter, without the customary colon separator "
12001 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1825
12003 "In future we may support other operating systems that also used drive "
12004 "letters, but the keys for those might not be case insensitive and might be "
12005 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
12010 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1830
12012 "For Windows guests, currently only hard drive mappings are returned. "
12013 "Removable disks (eg. DVD-ROMs) are ignored."
12017 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1833
12019 "For guests that do not use drive mappings, or if the drive mappings could "
12020 "not be determined, this returns an empty hash table."
12024 #: ../src/guestfs-actions.pod:2713
12026 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12027 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
12032 #: ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2985
12033 #: ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:5065
12034 #: ../src/guestfs-actions.pod:7094
12036 "This function returns a NULL-terminated array of strings, or NULL if there "
12037 "was an error. The array of strings will always have length C<2n+1>, where "
12038 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
12039 "caller must free the strings and the array after use>."
12043 #: ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3179
12044 msgid "(Added in 1.9.17)"
12049 #: ../src/guestfs-actions.pod:2725
12050 msgid "guestfs_inspect_get_filesystems"
12055 #: ../src/guestfs-actions.pod:2727
12059 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
12060 " const char *root);\n"
12066 #: ../src/guestfs-actions.pod:2731 ../fish/guestfish-actions.pod:1844
12068 "This returns a list of all the filesystems that we think are associated with "
12069 "this operating system. This includes the root filesystem, other ordinary "
12070 "filesystems, and non-mounted devices like swap partitions."
12075 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1849
12077 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
12078 "to be shared between operating systems."
12083 #: ../src/guestfs-actions.pod:2739
12085 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12086 "C<guestfs_inspect_get_mountpoints>."
12090 #: ../src/guestfs-actions.pod:2748
12091 msgid "guestfs_inspect_get_format"
12095 #: ../src/guestfs-actions.pod:2750
12099 " guestfs_inspect_get_format (guestfs_h *g,\n"
12100 " const char *root);\n"
12105 #: ../src/guestfs-actions.pod:2754 ../fish/guestfish-actions.pod:1859
12107 "This returns the format of the inspected operating system. You can use it "
12108 "to detect install images, live CDs and similar."
12112 #: ../src/guestfs-actions.pod:2757 ../fish/guestfish-actions.pod:1862
12113 msgid "Currently defined formats are:"
12117 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1866
12118 msgid "\"installed\""
12122 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1868
12123 msgid "This is an installed operating system."
12127 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1870
12128 msgid "\"installer\""
12132 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1872
12134 "The disk image being inspected is not an installed operating system, but a "
12135 "I<bootable> install disk, live CD, or similar."
12139 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1877
12140 msgid "The format of this disk image is not known."
12144 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:3215
12145 #: ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3249
12146 #: ../src/guestfs-actions.pod:6009
12147 msgid "(Added in 1.9.4)"
12152 #: ../src/guestfs-actions.pod:2786
12153 msgid "guestfs_inspect_get_hostname"
12158 #: ../src/guestfs-actions.pod:2788
12162 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12163 " const char *root);\n"
12169 #: ../src/guestfs-actions.pod:2792 ../fish/guestfish-actions.pod:1890
12171 "This function returns the hostname of the operating system as found by "
12172 "inspection of the guest's configuration files."
12177 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1893
12179 "If the hostname could not be determined, then the string C<unknown> is "
12185 #: ../src/guestfs-actions.pod:2803
12186 msgid "(Added in 1.7.9)"
12190 #: ../src/guestfs-actions.pod:2805
12191 msgid "guestfs_inspect_get_icon"
12195 #: ../src/guestfs-actions.pod:2807
12199 " guestfs_inspect_get_icon (guestfs_h *g,\n"
12200 " const char *root,\n"
12201 " size_t *size_r,\n"
12207 #: ../src/guestfs-actions.pod:2818
12210 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
12211 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
12216 #: ../src/guestfs-actions.pod:2821 ../fish/guestfish-actions.pod:1902
12218 "This function returns an icon corresponding to the inspected operating "
12219 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
12220 "to PNG if necessary)."
12224 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1906
12226 "If it was not possible to get an icon this function returns a zero-length "
12227 "(non-NULL) buffer. I<Callers must check for this case>."
12231 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1909
12233 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
12234 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
12235 "this file will be returned. You can disable favicons by passing the "
12236 "optional C<favicon> boolean as false (default is true)."
12240 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1915
12242 "If finding the favicon fails, then we look in other places in the guest for "
12247 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1918
12249 "If the optional C<highquality> boolean is true then only high quality icons "
12250 "are returned, which means only icons of high resolution with an alpha "
12251 "channel. The default (false) is to return any icon we can, even if it is of "
12252 "substandard quality."
12256 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1929
12258 "Unlike most other inspection API calls, the guest's disks must be mounted up "
12259 "before you call this, since it needs to read information from the guest "
12260 "filesystem during the call."
12264 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1935
12266 "B<Security:> The icon data comes from the untrusted guest, and should be "
12267 "treated with caution. PNG files have been known to contain exploits. "
12268 "Ensure that libpng (or other relevant libraries) are fully up to date before "
12269 "trying to process or display the icon."
12273 #: ../src/guestfs-actions.pod:2862 ../fish/guestfish-actions.pod:1943
12275 "The PNG image returned can be any size. It might not be square. Libguestfs "
12276 "tries to return the largest, highest quality icon available. The "
12277 "application must scale the icon to the required size."
12281 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1950
12283 "Extracting icons from Windows guests requires the external C<wrestool> "
12284 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
12285 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
12286 "installed separately."
12290 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1957
12292 "Operating system icons are usually trademarks. Seek legal advice before "
12293 "using trademarks in applications."
12297 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3710
12298 #: ../src/guestfs-actions.pod:4964
12299 msgid "(Added in 1.11.12)"
12303 #: ../src/guestfs-actions.pod:2887
12304 msgid "guestfs_inspect_get_icon_va"
12308 #: ../src/guestfs-actions.pod:2889
12312 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
12313 " const char *root,\n"
12314 " size_t *size_r,\n"
12315 " va_list args);\n"
12320 #: ../src/guestfs-actions.pod:2895
12321 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
12325 #: ../src/guestfs-actions.pod:2899
12326 msgid "guestfs_inspect_get_icon_argv"
12330 #: ../src/guestfs-actions.pod:2901
12334 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
12335 " const char *root,\n"
12336 " size_t *size_r,\n"
12337 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
12342 #: ../src/guestfs-actions.pod:2907
12343 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
12348 #: ../src/guestfs-actions.pod:2911
12349 msgid "guestfs_inspect_get_major_version"
12354 #: ../src/guestfs-actions.pod:2913
12358 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12359 " const char *root);\n"
12365 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:1968
12367 "This returns the major version number of the inspected operating system."
12372 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:1971
12374 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12375 "popular public names used by the operating system. Notably the operating "
12376 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12377 "1). You can find out the real versions corresponding to releases of Windows "
12378 "by consulting Wikipedia or MSDN."
12383 #: ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2944
12384 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1989
12385 msgid "If the version could not be determined, then C<0> is returned."
12390 #: ../src/guestfs-actions.pod:2935
12391 msgid "guestfs_inspect_get_minor_version"
12396 #: ../src/guestfs-actions.pod:2937
12400 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12401 " const char *root);\n"
12407 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:1986
12409 "This returns the minor version number of the inspected operating system."
12414 #: ../src/guestfs-actions.pod:2946
12416 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12417 "C<guestfs_inspect_get_major_version>."
12422 #: ../src/guestfs-actions.pod:2953
12423 msgid "guestfs_inspect_get_mountpoints"
12428 #: ../src/guestfs-actions.pod:2955
12432 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12433 " const char *root);\n"
12438 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:1998
12440 "This returns a hash of where we think the filesystems associated with this "
12441 "operating system should be mounted. Callers should note that this is at "
12442 "best an educated guess made by reading configuration files such as C</etc/"
12443 "fstab>. I<In particular note> that this may return filesystems which are "
12444 "non-existent or not mountable and callers should be prepared to handle or "
12445 "ignore failures if they try to mount them."
12450 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2007
12452 "Each element in the returned hashtable has a key which is the path of the "
12453 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12454 "mounted there (eg. C</dev/sda1>)."
12459 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2012
12461 "Non-mounted devices such as swap devices are I<not> returned in this list."
12465 #: ../src/guestfs-actions.pod:2976
12467 "For operating systems like Windows which still use drive letters, this call "
12468 "will only return an entry for the first drive \"mounted on\" C</>. For "
12469 "information about the mapping of drive letters to partitions, see "
12470 "C<guestfs_inspect_get_drive_mappings>."
12475 #: ../src/guestfs-actions.pod:2982
12477 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12478 "C<guestfs_inspect_get_filesystems>."
12483 #: ../src/guestfs-actions.pod:2993
12484 msgid "guestfs_inspect_get_package_format"
12489 #: ../src/guestfs-actions.pod:2995
12493 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12494 " const char *root);\n"
12500 #: ../src/guestfs-actions.pod:2999
12502 "This function and C<guestfs_inspect_get_package_management> return the "
12503 "package format and package management tool used by the inspected operating "
12504 "system. For example for Fedora these functions would return C<rpm> (package "
12505 "format) and C<yum> (package management)."
12510 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2034
12512 "This returns the string C<unknown> if we could not determine the package "
12513 "format I<or> if the operating system does not have a real packaging system "
12519 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2038
12521 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12522 "Future versions of libguestfs may return other strings."
12527 #: ../src/guestfs-actions.pod:3017 ../src/guestfs-actions.pod:3045
12528 msgid "(Added in 1.7.5)"
12533 #: ../src/guestfs-actions.pod:3019
12534 msgid "guestfs_inspect_get_package_management"
12539 #: ../src/guestfs-actions.pod:3021
12543 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12544 " const char *root);\n"
12550 #: ../src/guestfs-actions.pod:3025
12552 "C<guestfs_inspect_get_package_format> and this function return the package "
12553 "format and package management tool used by the inspected operating system. "
12554 "For example for Fedora these functions would return C<rpm> (package format) "
12555 "and C<yum> (package management)."
12560 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2053
12562 "This returns the string C<unknown> if we could not determine the package "
12563 "management tool I<or> if the operating system does not have a real packaging "
12564 "system (eg. Windows)."
12569 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2057
12571 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12572 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12573 "libguestfs may return other strings."
12578 #: ../src/guestfs-actions.pod:3047
12579 msgid "guestfs_inspect_get_product_name"
12584 #: ../src/guestfs-actions.pod:3049
12588 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12589 " const char *root);\n"
12595 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2068
12597 "This returns the product name of the inspected operating system. The "
12598 "product name is generally some freeform string which can be displayed to the "
12599 "user, but should not be parsed by programs."
12604 #: ../src/guestfs-actions.pod:3058 ../fish/guestfish-actions.pod:2073
12606 "If the product name could not be determined, then the string C<unknown> is "
12611 #: ../src/guestfs-actions.pod:3068
12612 msgid "guestfs_inspect_get_product_variant"
12616 #: ../src/guestfs-actions.pod:3070
12620 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12621 " const char *root);\n"
12626 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2082
12627 msgid "This returns the product variant of the inspected operating system."
12631 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2085
12633 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12634 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12635 "is usually a string such as C<Client> or C<Server> (other values are "
12636 "possible). This can be used to distinguish consumer and enterprise versions "
12637 "of Windows that have the same version number (for example, Windows 7 and "
12638 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12639 "the latter is C<Server>)."
12643 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2094
12645 "For enterprise Linux guests, in future we intend this to return the product "
12646 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12647 "implemented at present."
12651 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2098
12653 "If the product variant could not be determined, then the string C<unknown> "
12658 #: ../src/guestfs-actions.pod:3093
12660 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12661 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12665 #: ../src/guestfs-actions.pod:3100
12666 msgid "(Added in 1.9.13)"
12671 #: ../src/guestfs-actions.pod:3102
12672 msgid "guestfs_inspect_get_roots"
12677 #: ../src/guestfs-actions.pod:3104
12681 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12687 #: ../src/guestfs-actions.pod:3107
12689 "This function is a convenient way to get the list of root devices, as "
12690 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12691 "the whole inspection process."
12696 #: ../src/guestfs-actions.pod:3111
12698 "This returns an empty list if either no root devices were found or the "
12699 "caller has not called C<guestfs_inspect_os>."
12704 #: ../src/guestfs-actions.pod:3120
12705 msgid "(Added in 1.7.3)"
12710 #: ../src/guestfs-actions.pod:3122
12711 msgid "guestfs_inspect_get_type"
12716 #: ../src/guestfs-actions.pod:3124
12720 " guestfs_inspect_get_type (guestfs_h *g,\n"
12721 " const char *root);\n"
12727 #: ../src/guestfs-actions.pod:3128 ../fish/guestfish-actions.pod:2122
12729 "This returns the type of the inspected operating system. Currently defined "
12735 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2127
12741 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2129
12742 msgid "Any Linux-based operating system."
12747 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2133
12748 msgid "Any Microsoft Windows operating system."
12753 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2135
12754 msgid "\"freebsd\""
12759 #: ../src/guestfs-actions.pod:3143 ../fish/guestfish-actions.pod:2137
12765 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2141
12766 msgid "The operating system type could not be determined."
12770 #: ../src/guestfs-actions.pod:3161
12771 msgid "guestfs_inspect_get_windows_current_control_set"
12775 #: ../src/guestfs-actions.pod:3163
12779 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12780 " const char *root);\n"
12785 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2154
12787 "This returns the Windows CurrentControlSet of the inspected guest. The "
12788 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12792 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2157
12794 "This call assumes that the guest is Windows and that the Registry could be "
12795 "examined by inspection. If this is not the case then an error is returned."
12800 #: ../src/guestfs-actions.pod:3181
12801 msgid "guestfs_inspect_get_windows_systemroot"
12806 #: ../src/guestfs-actions.pod:3183
12810 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12811 " const char *root);\n"
12817 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2167
12819 "This returns the Windows systemroot of the inspected guest. The systemroot "
12820 "is a directory path such as C</WINDOWS>."
12825 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2170
12827 "This call assumes that the guest is Windows and that the systemroot could be "
12828 "determined by inspection. If this is not the case then an error is returned."
12833 #: ../src/guestfs-actions.pod:3199
12834 msgid "(Added in 1.5.25)"
12838 #: ../src/guestfs-actions.pod:3201
12839 msgid "guestfs_inspect_is_live"
12843 #: ../src/guestfs-actions.pod:3203
12847 " guestfs_inspect_is_live (guestfs_h *g,\n"
12848 " const char *root);\n"
12853 #: ../src/guestfs-actions.pod:3207
12855 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12856 "disk), then this returns true if a live image was detected on the disk."
12860 #: ../src/guestfs-actions.pod:3217
12861 msgid "guestfs_inspect_is_multipart"
12865 #: ../src/guestfs-actions.pod:3219
12869 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12870 " const char *root);\n"
12875 #: ../src/guestfs-actions.pod:3223
12877 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12878 "disk), then this returns true if the disk is part of a set."
12882 #: ../src/guestfs-actions.pod:3233
12883 msgid "guestfs_inspect_is_netinst"
12887 #: ../src/guestfs-actions.pod:3235
12891 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12892 " const char *root);\n"
12897 #: ../src/guestfs-actions.pod:3239
12899 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12900 "disk), then this returns true if the disk is a network installer, ie. not a "
12901 "self-contained install CD but one which is likely to require network access "
12902 "to complete the install."
12907 #: ../src/guestfs-actions.pod:3251
12908 msgid "guestfs_inspect_list_applications"
12913 #: ../src/guestfs-actions.pod:3253
12916 " struct guestfs_application_list *\n"
12917 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12918 " const char *root);\n"
12924 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2212
12925 msgid "Return the list of applications installed in the operating system."
12930 #: ../src/guestfs-actions.pod:3259
12932 "I<Note:> This call works differently from other parts of the inspection "
12933 "API. You have to call C<guestfs_inspect_os>, then "
12934 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12935 "this. Listing applications is a significantly more difficult operation "
12936 "which requires access to the full filesystem. Also note that unlike the "
12937 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12938 "the libguestfs handle, this call actually reads parts of the mounted "
12939 "filesystems during the call."
12944 #: ../src/guestfs-actions.pod:3269 ../fish/guestfish-actions.pod:2224
12946 "This returns an empty list if the inspection code was not able to determine "
12947 "the list of applications."
12952 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2227
12953 msgid "The application structure contains the following fields:"
12958 #: ../src/guestfs-actions.pod:3276 ../fish/guestfish-actions.pod:2231
12959 msgid "C<app_name>"
12964 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2233
12966 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12967 "guests, this is the package name."
12972 #: ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:2236
12973 msgid "C<app_display_name>"
12978 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2238
12980 "The display name of the application, sometimes localized to the install "
12981 "language of the guest operating system."
12986 #: ../src/guestfs-actions.pod:3286 ../fish/guestfish-actions.pod:2241
12988 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12989 "to display something can use C<app_name> instead."
12994 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2244
12995 msgid "C<app_epoch>"
13000 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2246
13002 "For package managers which use epochs, this contains the epoch of the "
13003 "package (an integer). If unavailable, this is returned as C<0>."
13008 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2249
13009 msgid "C<app_version>"
13014 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2251
13016 "The version string of the application or package. If unavailable this is "
13017 "returned as an empty string C<\"\">."
13022 #: ../src/guestfs-actions.pod:3299 ../fish/guestfish-actions.pod:2254
13023 msgid "C<app_release>"
13028 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2256
13030 "The release string of the application or package, for package managers that "
13031 "use this. If unavailable this is returned as an empty string C<\"\">."
13036 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2260
13037 msgid "C<app_install_path>"
13042 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2262
13044 "The installation path of the application (on operating systems such as "
13045 "Windows which use installation paths). This path is in the format used by "
13046 "the guest operating system, it is not a libguestfs path."
13051 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2267
13052 msgid "If unavailable this is returned as an empty string C<\"\">."
13057 #: ../src/guestfs-actions.pod:3314 ../fish/guestfish-actions.pod:2269
13058 msgid "C<app_trans_path>"
13063 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2271
13065 "The install path translated into a libguestfs path. If unavailable this is "
13066 "returned as an empty string C<\"\">."
13071 #: ../src/guestfs-actions.pod:3319 ../fish/guestfish-actions.pod:2274
13072 msgid "C<app_publisher>"
13077 #: ../src/guestfs-actions.pod:3321 ../fish/guestfish-actions.pod:2276
13079 "The name of the publisher of the application, for package managers that use "
13080 "this. If unavailable this is returned as an empty string C<\"\">."
13085 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2280
13091 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2282
13093 "The URL (eg. upstream URL) of the application. If unavailable this is "
13094 "returned as an empty string C<\"\">."
13099 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2285
13100 msgid "C<app_source_package>"
13105 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2287
13107 "For packaging systems which support this, the name of the source package. "
13108 "If unavailable this is returned as an empty string C<\"\">."
13113 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2290
13114 msgid "C<app_summary>"
13119 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2292
13121 "A short (usually one line) description of the application or package. If "
13122 "unavailable this is returned as an empty string C<\"\">."
13127 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2295
13128 msgid "C<app_description>"
13133 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2297
13135 "A longer description of the application or package. If unavailable this is "
13136 "returned as an empty string C<\"\">."
13141 #: ../src/guestfs-actions.pod:3349
13143 "This function returns a C<struct guestfs_application_list *>, or NULL if "
13144 "there was an error. I<The caller must call C<guestfs_free_application_list> "
13150 #: ../src/guestfs-actions.pod:3353
13151 msgid "(Added in 1.7.8)"
13156 #: ../src/guestfs-actions.pod:3355
13157 msgid "guestfs_inspect_os"
13162 #: ../src/guestfs-actions.pod:3357
13166 " guestfs_inspect_os (guestfs_h *g);\n"
13172 #: ../src/guestfs-actions.pod:3360 ../fish/guestfish-actions.pod:2308
13174 "This function uses other libguestfs functions and certain heuristics to "
13175 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
13176 "for operating systems."
13181 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2312
13182 msgid "The list returned is empty if no operating systems were found."
13187 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2314
13189 "If one operating system was found, then this returns a list with a single "
13190 "element, which is the name of the root filesystem of this operating system. "
13191 "It is also possible for this function to return a list containing more than "
13192 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
13193 "element being the root filesystem of one of the operating systems."
13198 #: ../src/guestfs-actions.pod:3373
13200 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
13201 "functions in order to query further information about each operating system, "
13202 "such as the name and version."
13207 #: ../src/guestfs-actions.pod:3378
13209 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
13210 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
13211 "the contents. This should be called with no disks currently mounted. The "
13212 "function may also use Augeas, so any existing Augeas handle will be closed."
13217 #: ../src/guestfs-actions.pod:3384 ../fish/guestfish-actions.pod:2332
13219 "This function cannot decrypt encrypted disks. The caller must do that first "
13220 "(supplying the necessary keys) if the disk is encrypted."
13225 #: ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3721
13226 #: ../src/guestfs-actions.pod:3803
13227 msgid "See also C<guestfs_list_filesystems>."
13232 #: ../src/guestfs-actions.pod:3398
13233 msgid "guestfs_is_blockdev"
13238 #: ../src/guestfs-actions.pod:3400
13242 " guestfs_is_blockdev (guestfs_h *g,\n"
13243 " const char *path);\n"
13249 #: ../src/guestfs-actions.pod:3404 ../fish/guestfish-actions.pod:2344
13251 "This returns C<true> if and only if there is a block device with the given "
13257 #: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3436
13258 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3481
13259 #: ../src/guestfs-actions.pod:3497 ../src/guestfs-actions.pod:3553
13260 #: ../src/guestfs-actions.pod:3568
13261 msgid "See also C<guestfs_stat>."
13266 #: ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3440
13267 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3557
13268 #: ../src/guestfs-actions.pod:3572
13269 msgid "(Added in 1.5.10)"
13274 #: ../src/guestfs-actions.pod:3413
13275 msgid "guestfs_is_busy"
13280 #: ../src/guestfs-actions.pod:3415
13284 " guestfs_is_busy (guestfs_h *g);\n"
13290 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2353
13292 "This returns true iff this handle is busy processing a command (in the "
13298 #: ../src/guestfs-actions.pod:3427
13299 msgid "guestfs_is_chardev"
13304 #: ../src/guestfs-actions.pod:3429
13308 " guestfs_is_chardev (guestfs_h *g,\n"
13309 " const char *path);\n"
13315 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2362
13317 "This returns C<true> if and only if there is a character device with the "
13318 "given C<path> name."
13323 #: ../src/guestfs-actions.pod:3442
13324 msgid "guestfs_is_config"
13329 #: ../src/guestfs-actions.pod:3444
13333 " guestfs_is_config (guestfs_h *g);\n"
13339 #: ../src/guestfs-actions.pod:3447 ../fish/guestfish-actions.pod:2371
13341 "This returns true iff this handle is being configured (in the C<CONFIG> "
13347 #: ../src/guestfs-actions.pod:3456
13348 msgid "guestfs_is_dir"
13353 #: ../src/guestfs-actions.pod:3458
13357 " guestfs_is_dir (guestfs_h *g,\n"
13358 " const char *path);\n"
13364 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2380
13366 "This returns C<true> if and only if there is a directory with the given "
13367 "C<path> name. Note that it returns false for other objects like files."
13372 #: ../src/guestfs-actions.pod:3472
13373 msgid "guestfs_is_fifo"
13378 #: ../src/guestfs-actions.pod:3474
13382 " guestfs_is_fifo (guestfs_h *g,\n"
13383 " const char *path);\n"
13389 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2390
13391 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13392 "given C<path> name."
13397 #: ../src/guestfs-actions.pod:3487
13398 msgid "guestfs_is_file"
13403 #: ../src/guestfs-actions.pod:3489
13407 " guestfs_is_file (guestfs_h *g,\n"
13408 " const char *path);\n"
13414 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2399
13416 "This returns C<true> if and only if there is a regular file with the given "
13417 "C<path> name. Note that it returns false for other objects like directories."
13422 #: ../src/guestfs-actions.pod:3503
13423 msgid "guestfs_is_launching"
13428 #: ../src/guestfs-actions.pod:3505
13432 " guestfs_is_launching (guestfs_h *g);\n"
13438 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2409
13440 "This returns true iff this handle is launching the subprocess (in the "
13441 "C<LAUNCHING> state)."
13446 #: ../src/guestfs-actions.pod:3517
13447 msgid "guestfs_is_lv"
13452 #: ../src/guestfs-actions.pod:3519
13456 " guestfs_is_lv (guestfs_h *g,\n"
13457 " const char *device);\n"
13463 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2418
13465 "This command tests whether C<device> is a logical volume, and returns true "
13466 "iff this is the case."
13471 #: ../src/guestfs-actions.pod:3530
13472 msgid "guestfs_is_ready"
13477 #: ../src/guestfs-actions.pod:3532
13481 " guestfs_is_ready (guestfs_h *g);\n"
13487 #: ../src/guestfs-actions.pod:3535 ../fish/guestfish-actions.pod:2425
13489 "This returns true iff this handle is ready to accept commands (in the "
13495 #: ../src/guestfs-actions.pod:3544
13496 msgid "guestfs_is_socket"
13501 #: ../src/guestfs-actions.pod:3546
13505 " guestfs_is_socket (guestfs_h *g,\n"
13506 " const char *path);\n"
13512 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2434
13514 "This returns C<true> if and only if there is a Unix domain socket with the "
13515 "given C<path> name."
13520 #: ../src/guestfs-actions.pod:3559
13521 msgid "guestfs_is_symlink"
13526 #: ../src/guestfs-actions.pod:3561
13530 " guestfs_is_symlink (guestfs_h *g,\n"
13531 " const char *path);\n"
13537 #: ../src/guestfs-actions.pod:3565 ../fish/guestfish-actions.pod:2443
13539 "This returns C<true> if and only if there is a symbolic link with the given "
13544 #: ../src/guestfs-actions.pod:3574
13545 msgid "guestfs_is_zero"
13549 #: ../src/guestfs-actions.pod:3576
13553 " guestfs_is_zero (guestfs_h *g,\n"
13554 " const char *path);\n"
13559 #: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2452
13561 "This returns true iff the file exists and the file is empty or it contains "
13566 #: ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3599
13567 msgid "(Added in 1.11.8)"
13571 #: ../src/guestfs-actions.pod:3587
13572 msgid "guestfs_is_zero_device"
13576 #: ../src/guestfs-actions.pod:3589
13580 " guestfs_is_zero_device (guestfs_h *g,\n"
13581 " const char *device);\n"
13586 #: ../src/guestfs-actions.pod:3593 ../fish/guestfish-actions.pod:2459
13587 msgid "This returns true iff the device exists and contains all zero bytes."
13591 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2461
13592 msgid "Note that for large devices this can take a long time to run."
13597 #: ../src/guestfs-actions.pod:3601
13598 msgid "guestfs_kill_subprocess"
13603 #: ../src/guestfs-actions.pod:3603
13607 " guestfs_kill_subprocess (guestfs_h *g);\n"
13613 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
13614 msgid "This kills the qemu subprocess. You should never need to call this."
13619 #: ../src/guestfs-actions.pod:3612
13620 msgid "guestfs_launch"
13625 #: ../src/guestfs-actions.pod:3614
13629 " guestfs_launch (guestfs_h *g);\n"
13635 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2475
13637 "Internally libguestfs is implemented by running a virtual machine using "
13643 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2478
13645 "You should call this after configuring the handle (eg. adding drives) but "
13646 "before performing any actions."
13651 #: ../src/guestfs-actions.pod:3632
13652 msgid "guestfs_lchown"
13657 #: ../src/guestfs-actions.pod:3634
13661 " guestfs_lchown (guestfs_h *g,\n"
13664 " const char *path);\n"
13670 #: ../src/guestfs-actions.pod:3640
13672 "Change the file owner to C<owner> and group to C<group>. This is like "
13673 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13674 "changed, not the target."
13679 #: ../src/guestfs-actions.pod:3652
13680 msgid "guestfs_lgetxattr"
13685 #: ../src/guestfs-actions.pod:3654
13689 " guestfs_lgetxattr (guestfs_h *g,\n"
13690 " const char *path,\n"
13691 " const char *name,\n"
13692 " size_t *size_r);\n"
13698 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2497
13700 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13701 "is a symlink, then this call returns an extended attribute from the symlink."
13706 #: ../src/guestfs-actions.pod:3674
13707 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13712 #: ../src/guestfs-actions.pod:3682
13713 msgid "guestfs_lgetxattrs"
13718 #: ../src/guestfs-actions.pod:3684
13721 " struct guestfs_xattr_list *\n"
13722 " guestfs_lgetxattrs (guestfs_h *g,\n"
13723 " const char *path);\n"
13729 #: ../src/guestfs-actions.pod:3688
13731 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13732 "then it returns the extended attributes of the link itself."
13736 #: ../src/guestfs-actions.pod:3698
13737 msgid "guestfs_list_9p"
13741 #: ../src/guestfs-actions.pod:3700
13745 " guestfs_list_9p (guestfs_h *g);\n"
13750 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2525
13752 "List all 9p filesystems attached to the guest. A list of mount tags is "
13758 #: ../src/guestfs-actions.pod:3712
13759 msgid "guestfs_list_devices"
13764 #: ../src/guestfs-actions.pod:3714
13768 " guestfs_list_devices (guestfs_h *g);\n"
13774 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2532
13775 msgid "List all the block devices."
13780 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2534
13781 msgid "The full block device names are returned, eg. C</dev/sda>."
13785 #: ../src/guestfs-actions.pod:3729
13786 msgid "guestfs_list_dm_devices"
13790 #: ../src/guestfs-actions.pod:3731
13794 " guestfs_list_dm_devices (guestfs_h *g);\n"
13799 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2542
13800 msgid "List all device mapper devices."
13804 #: ../src/guestfs-actions.pod:3736
13806 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
13807 "previous call to C<guestfs_luks_open>."
13811 #: ../src/guestfs-actions.pod:3739
13813 "Device mapper devices which correspond to logical volumes are I<not> "
13814 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
13819 #: ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:5203
13820 msgid "(Added in 1.11.15)"
13825 #: ../src/guestfs-actions.pod:3749
13826 msgid "guestfs_list_filesystems"
13831 #: ../src/guestfs-actions.pod:3751
13835 " guestfs_list_filesystems (guestfs_h *g);\n"
13841 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2555
13843 "This inspection command looks for filesystems on partitions, block devices "
13844 "and logical volumes, returning a list of devices containing filesystems and "
13850 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2559
13852 "The return value is a hash, where the keys are the devices containing "
13853 "filesystems, and the values are the filesystem types. For example:"
13858 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2563
13861 " \"/dev/sda1\" => \"ntfs\"\n"
13862 " \"/dev/sda2\" => \"ext2\"\n"
13863 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13864 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13870 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2568
13872 "The value can have the special value \"unknown\", meaning the content of the "
13873 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13878 #: ../src/guestfs-actions.pod:3771
13880 "This command runs other libguestfs commands, which might include "
13881 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13882 "soon after launch and only when nothing is mounted."
13887 #: ../src/guestfs-actions.pod:3775
13889 "Not all of the filesystems returned will be mountable. In particular, swap "
13890 "partitions are returned in the list. Also this command does not check that "
13891 "each filesystem found is valid and mountable, and some filesystems might be "
13892 "mountable but require special options. Filesystems may not all belong to a "
13893 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13898 #: ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:5558
13899 msgid "(Added in 1.5.15)"
13904 #: ../src/guestfs-actions.pod:3791
13905 msgid "guestfs_list_partitions"
13910 #: ../src/guestfs-actions.pod:3793
13914 " guestfs_list_partitions (guestfs_h *g);\n"
13920 #: ../src/guestfs-actions.pod:3796 ../fish/guestfish-actions.pod:2588
13921 msgid "List all the partitions detected on all block devices."
13926 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2590
13927 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13932 #: ../src/guestfs-actions.pod:3800
13934 "This does not return logical volumes. For that you will need to call "
13940 #: ../src/guestfs-actions.pod:3811
13946 #: ../src/guestfs-actions.pod:3813
13950 " guestfs_ll (guestfs_h *g,\n"
13951 " const char *directory);\n"
13957 #: ../src/guestfs-actions.pod:3817 ../fish/guestfish-actions.pod:2601
13959 "List the files in C<directory> (relative to the root directory, there is no "
13960 "cwd) in the format of 'ls -la'."
13965 #: ../src/guestfs-actions.pod:3820 ../fish/guestfish-actions.pod:2604
13967 "This command is mostly useful for interactive sessions. It is I<not> "
13968 "intended that you try to parse the output string."
13973 #: ../src/guestfs-actions.pod:3828
13979 #: ../src/guestfs-actions.pod:3830
13983 " guestfs_ln (guestfs_h *g,\n"
13984 " const char *target,\n"
13985 " const char *linkname);\n"
13991 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2611
13992 msgid "This command creates a hard link using the C<ln> command."
13997 #: ../src/guestfs-actions.pod:3841
13998 msgid "guestfs_ln_f"
14003 #: ../src/guestfs-actions.pod:3843
14007 " guestfs_ln_f (guestfs_h *g,\n"
14008 " const char *target,\n"
14009 " const char *linkname);\n"
14014 #: ../src/guestfs-actions.pod:3848 ../fish/guestfish-actions.pod:2617
14016 "This command creates a hard link using the C<ln -f> command. The I<-f> "
14017 "option removes the link (C<linkname>) if it exists already."
14022 #: ../src/guestfs-actions.pod:3855
14023 msgid "guestfs_ln_s"
14028 #: ../src/guestfs-actions.pod:3857
14032 " guestfs_ln_s (guestfs_h *g,\n"
14033 " const char *target,\n"
14034 " const char *linkname);\n"
14040 #: ../src/guestfs-actions.pod:3862 ../fish/guestfish-actions.pod:2624
14041 msgid "This command creates a symbolic link using the C<ln -s> command."
14046 #: ../src/guestfs-actions.pod:3868
14047 msgid "guestfs_ln_sf"
14052 #: ../src/guestfs-actions.pod:3870
14056 " guestfs_ln_sf (guestfs_h *g,\n"
14057 " const char *target,\n"
14058 " const char *linkname);\n"
14063 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2630
14065 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
14066 "option removes the link (C<linkname>) if it exists already."
14071 #: ../src/guestfs-actions.pod:3882
14072 msgid "guestfs_lremovexattr"
14077 #: ../src/guestfs-actions.pod:3884
14081 " guestfs_lremovexattr (guestfs_h *g,\n"
14082 " const char *xattr,\n"
14083 " const char *path);\n"
14089 #: ../src/guestfs-actions.pod:3889
14091 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
14092 "link, then it removes an extended attribute of the link itself."
14097 #: ../src/guestfs-actions.pod:3897
14103 #: ../src/guestfs-actions.pod:3899
14107 " guestfs_ls (guestfs_h *g,\n"
14108 " const char *directory);\n"
14114 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2645
14116 "List the files in C<directory> (relative to the root directory, there is no "
14117 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
14122 #: ../src/guestfs-actions.pod:3907
14124 "This command is mostly useful for interactive sessions. Programs should "
14125 "probably use C<guestfs_readdir> instead."
14130 #: ../src/guestfs-actions.pod:3916
14131 msgid "guestfs_lsetxattr"
14136 #: ../src/guestfs-actions.pod:3918
14140 " guestfs_lsetxattr (guestfs_h *g,\n"
14141 " const char *xattr,\n"
14142 " const char *val,\n"
14144 " const char *path);\n"
14150 #: ../src/guestfs-actions.pod:3925
14152 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
14153 "then it sets an extended attribute of the link itself."
14158 #: ../src/guestfs-actions.pod:3933
14159 msgid "guestfs_lstat"
14164 #: ../src/guestfs-actions.pod:3935
14167 " struct guestfs_stat *\n"
14168 " guestfs_lstat (guestfs_h *g,\n"
14169 " const char *path);\n"
14175 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:6693
14176 #: ../fish/guestfish-actions.pod:2664 ../fish/guestfish-actions.pod:4451
14177 msgid "Returns file information for the given C<path>."
14182 #: ../src/guestfs-actions.pod:3941
14184 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
14185 "link, then the link is stat-ed, not the file it refers to."
14190 #: ../src/guestfs-actions.pod:3945 ../fish/guestfish-actions.pod:2670
14191 msgid "This is the same as the C<lstat(2)> system call."
14196 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:6697
14198 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
14199 "error. I<The caller must call C<guestfs_free_stat> after use>."
14204 #: ../src/guestfs-actions.pod:3951 ../src/guestfs-actions.pod:6701
14205 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:7100
14206 msgid "(Added in 0.9.2)"
14211 #: ../src/guestfs-actions.pod:3953
14212 msgid "guestfs_lstatlist"
14217 #: ../src/guestfs-actions.pod:3955
14220 " struct guestfs_stat_list *\n"
14221 " guestfs_lstatlist (guestfs_h *g,\n"
14222 " const char *path,\n"
14223 " char *const *names);\n"
14229 #: ../src/guestfs-actions.pod:3960
14231 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
14232 "files, where all files are in the directory C<path>. C<names> is the list "
14233 "of files from this directory."
14238 #: ../src/guestfs-actions.pod:3964 ../fish/guestfish-actions.pod:2680
14240 "On return you get a list of stat structs, with a one-to-one correspondence "
14241 "to the C<names> list. If any name did not exist or could not be lstat'd, "
14242 "then the C<ino> field of that structure is set to C<-1>."
14247 #: ../src/guestfs-actions.pod:3969
14249 "This call is intended for programs that want to efficiently list a directory "
14250 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
14251 "for a similarly efficient call for getting extended attributes. Very long "
14252 "directory listings might cause the protocol message size to be exceeded, "
14253 "causing this call to fail. The caller must split up such requests into "
14254 "smaller groups of names."
14259 #: ../src/guestfs-actions.pod:3977
14261 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
14262 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
14267 #: ../src/guestfs-actions.pod:3983
14268 msgid "guestfs_luks_add_key"
14273 #: ../src/guestfs-actions.pod:3985
14277 " guestfs_luks_add_key (guestfs_h *g,\n"
14278 " const char *device,\n"
14279 " const char *key,\n"
14280 " const char *newkey,\n"
14287 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2697
14289 "This command adds a new key on LUKS device C<device>. C<key> is any "
14290 "existing key, and is used to access the device. C<newkey> is the new key to "
14291 "add. C<keyslot> is the key slot that will be replaced."
14296 #: ../src/guestfs-actions.pod:3997
14298 "Note that if C<keyslot> already contains a key, then this command will "
14299 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
14304 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4043
14305 #: ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4086
14306 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4140
14308 "This function takes a key or passphrase parameter which could contain "
14309 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
14315 #: ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4047
14316 #: ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4090
14317 msgid "(Added in 1.5.2)"
14322 #: ../src/guestfs-actions.pod:4009
14323 msgid "guestfs_luks_close"
14328 #: ../src/guestfs-actions.pod:4011
14332 " guestfs_luks_close (guestfs_h *g,\n"
14333 " const char *device);\n"
14339 #: ../src/guestfs-actions.pod:4015
14341 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
14342 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
14343 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
14344 "underlying block device."
14349 #: ../src/guestfs-actions.pod:4023 ../src/guestfs-actions.pod:4125
14350 #: ../src/guestfs-actions.pod:4144 ../src/guestfs-actions.pod:4194
14351 #: ../src/guestfs-actions.pod:4242
14352 msgid "(Added in 1.5.1)"
14357 #: ../src/guestfs-actions.pod:4025
14358 msgid "guestfs_luks_format"
14363 #: ../src/guestfs-actions.pod:4027
14367 " guestfs_luks_format (guestfs_h *g,\n"
14368 " const char *device,\n"
14369 " const char *key,\n"
14376 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2723
14378 "This command erases existing data on C<device> and formats the device as a "
14379 "LUKS encrypted device. C<key> is the initial key, which is added to key "
14380 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
14385 #: ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4063
14386 #: ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5309
14387 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6500
14388 #: ../src/guestfs-actions.pod:6530 ../src/guestfs-actions.pod:6563
14389 #: ../src/guestfs-actions.pod:7739 ../fish/guestfish-actions.pod:2731
14390 #: ../fish/guestfish-actions.pod:2744 ../fish/guestfish-actions.pod:2831
14391 #: ../fish/guestfish-actions.pod:3492 ../fish/guestfish-actions.pod:4012
14392 #: ../fish/guestfish-actions.pod:4322 ../fish/guestfish-actions.pod:4345
14393 #: ../fish/guestfish-actions.pod:4367 ../fish/guestfish-actions.pod:5091
14395 "B<This command is dangerous. Without careful use you can easily destroy all "
14401 #: ../src/guestfs-actions.pod:4049
14402 msgid "guestfs_luks_format_cipher"
14407 #: ../src/guestfs-actions.pod:4051
14411 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14412 " const char *device,\n"
14413 " const char *key,\n"
14415 " const char *cipher);\n"
14421 #: ../src/guestfs-actions.pod:4058
14423 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14424 "set the C<cipher> used."
14429 #: ../src/guestfs-actions.pod:4072
14430 msgid "guestfs_luks_kill_slot"
14435 #: ../src/guestfs-actions.pod:4074
14439 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14440 " const char *device,\n"
14441 " const char *key,\n"
14448 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2751
14450 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14451 "device C<device>. C<key> must be one of the I<other> keys."
14456 #: ../src/guestfs-actions.pod:4092
14457 msgid "guestfs_luks_open"
14462 #: ../src/guestfs-actions.pod:4094
14466 " guestfs_luks_open (guestfs_h *g,\n"
14467 " const char *device,\n"
14468 " const char *key,\n"
14469 " const char *mapname);\n"
14475 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2762
14477 "This command opens a block device which has been encrypted according to the "
14478 "Linux Unified Key Setup (LUKS) standard."
14483 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2765
14484 msgid "C<device> is the encrypted block device or partition."
14489 #: ../src/guestfs-actions.pod:4105 ../fish/guestfish-actions.pod:2767
14491 "The caller must supply one of the keys associated with the LUKS block "
14492 "device, in the C<key> parameter."
14497 #: ../src/guestfs-actions.pod:4108 ../fish/guestfish-actions.pod:2770
14499 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14500 "writes to this block device are decrypted from and encrypted to the "
14501 "underlying C<device> respectively."
14506 #: ../src/guestfs-actions.pod:4112
14508 "If this block device contains LVM volume groups, then calling "
14509 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14514 #: ../src/guestfs-actions.pod:4116
14515 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
14520 #: ../src/guestfs-actions.pod:4127
14521 msgid "guestfs_luks_open_ro"
14526 #: ../src/guestfs-actions.pod:4129
14530 " guestfs_luks_open_ro (guestfs_h *g,\n"
14531 " const char *device,\n"
14532 " const char *key,\n"
14533 " const char *mapname);\n"
14539 #: ../src/guestfs-actions.pod:4135
14541 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14547 #: ../src/guestfs-actions.pod:4146
14548 msgid "guestfs_lvcreate"
14553 #: ../src/guestfs-actions.pod:4148
14557 " guestfs_lvcreate (guestfs_h *g,\n"
14558 " const char *logvol,\n"
14559 " const char *volgroup,\n"
14566 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2798
14568 "This creates an LVM logical volume called C<logvol> on the volume group "
14569 "C<volgroup>, with C<size> megabytes."
14574 #: ../src/guestfs-actions.pod:4161
14575 msgid "guestfs_lvm_canonical_lv_name"
14580 #: ../src/guestfs-actions.pod:4163
14584 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14585 " const char *lvname);\n"
14591 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2805
14593 "This converts alternative naming schemes for LVs that you might find to the "
14594 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14600 #: ../src/guestfs-actions.pod:4171 ../fish/guestfish-actions.pod:2809
14602 "This command returns an error if the C<lvname> parameter does not refer to a "
14608 #: ../src/guestfs-actions.pod:4174
14609 msgid "See also C<guestfs_is_lv>."
14614 #: ../src/guestfs-actions.pod:4179
14615 msgid "(Added in 1.5.24)"
14620 #: ../src/guestfs-actions.pod:4181
14621 msgid "guestfs_lvm_clear_filter"
14626 #: ../src/guestfs-actions.pod:4183
14630 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14636 #: ../src/guestfs-actions.pod:4186
14638 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14639 "see every block device."
14644 #: ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4231
14645 #: ../fish/guestfish-actions.pod:2821 ../fish/guestfish-actions.pod:2852
14647 "This command also clears the LVM cache and performs a volume group scan."
14652 #: ../src/guestfs-actions.pod:4196
14653 msgid "guestfs_lvm_remove_all"
14658 #: ../src/guestfs-actions.pod:4198
14662 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14668 #: ../src/guestfs-actions.pod:4201 ../fish/guestfish-actions.pod:2828
14670 "This command removes all LVM logical volumes, volume groups and physical "
14676 #: ../src/guestfs-actions.pod:4211
14677 msgid "guestfs_lvm_set_filter"
14682 #: ../src/guestfs-actions.pod:4213
14686 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14687 " char *const *devices);\n"
14693 #: ../src/guestfs-actions.pod:4217 ../fish/guestfish-actions.pod:2838
14695 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14696 "block devices in the list C<devices>, and will ignore all other attached "
14702 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2842
14704 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14705 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14706 "there are two types of duplication possible: either cloned PVs/VGs which "
14707 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14708 "same name. In normal operation you cannot create this situation, but you "
14709 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14710 "inside the LVM metadata."
14715 #: ../src/guestfs-actions.pod:4234 ../fish/guestfish-actions.pod:2855
14716 msgid "You can filter whole block devices or individual partitions."
14721 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:2857
14723 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14724 "filesystem), even if you are not filtering out that VG."
14729 #: ../src/guestfs-actions.pod:4244
14730 msgid "guestfs_lvremove"
14735 #: ../src/guestfs-actions.pod:4246
14739 " guestfs_lvremove (guestfs_h *g,\n"
14740 " const char *device);\n"
14746 #: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:2865
14748 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14749 "LV, such as C</dev/VG/LV>."
14754 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2868
14756 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14762 #: ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:5655
14763 #: ../src/guestfs-actions.pod:7470
14764 msgid "(Added in 1.0.13)"
14769 #: ../src/guestfs-actions.pod:4260
14770 msgid "guestfs_lvrename"
14775 #: ../src/guestfs-actions.pod:4262
14779 " guestfs_lvrename (guestfs_h *g,\n"
14780 " const char *logvol,\n"
14781 " const char *newlogvol);\n"
14787 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2875
14788 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14793 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:7483
14794 msgid "(Added in 1.0.83)"
14799 #: ../src/guestfs-actions.pod:4273
14800 msgid "guestfs_lvresize"
14805 #: ../src/guestfs-actions.pod:4275
14809 " guestfs_lvresize (guestfs_h *g,\n"
14810 " const char *device,\n"
14817 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2881
14819 "This resizes (expands or shrinks) an existing LVM logical volume to "
14820 "C<mbytes>. When reducing, data in the reduced part is lost."
14825 #: ../src/guestfs-actions.pod:4288
14826 msgid "guestfs_lvresize_free"
14831 #: ../src/guestfs-actions.pod:4290
14835 " guestfs_lvresize_free (guestfs_h *g,\n"
14836 " const char *lv,\n"
14843 #: ../src/guestfs-actions.pod:4295 ../fish/guestfish-actions.pod:2889
14845 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14846 "remaining free space in the volume group. Commonly you would call this with "
14847 "pc = 100 which expands the logical volume as much as possible, using all "
14848 "remaining free space in the volume group."
14853 #: ../src/guestfs-actions.pod:4303
14854 msgid "(Added in 1.3.3)"
14859 #: ../src/guestfs-actions.pod:4305
14860 msgid "guestfs_lvs"
14865 #: ../src/guestfs-actions.pod:4307
14869 " guestfs_lvs (guestfs_h *g);\n"
14875 #: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:2899
14877 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14883 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2902
14885 "This returns a list of the logical volume device names (eg. C</dev/"
14886 "VolGroup00/LogVol00>)."
14891 #: ../src/guestfs-actions.pod:4316
14892 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14897 #: ../src/guestfs-actions.pod:4324
14898 msgid "guestfs_lvs_full"
14903 #: ../src/guestfs-actions.pod:4326
14906 " struct guestfs_lvm_lv_list *\n"
14907 " guestfs_lvs_full (guestfs_h *g);\n"
14913 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2911
14915 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14916 "(8)> command. The \"full\" version includes all fields."
14921 #: ../src/guestfs-actions.pod:4332
14923 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14924 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14929 #: ../src/guestfs-actions.pod:4338
14930 msgid "guestfs_lvuuid"
14935 #: ../src/guestfs-actions.pod:4340
14939 " guestfs_lvuuid (guestfs_h *g,\n"
14940 " const char *device);\n"
14946 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2918
14947 msgid "This command returns the UUID of the LVM LV C<device>."
14952 #: ../src/guestfs-actions.pod:4351
14953 msgid "guestfs_lxattrlist"
14958 #: ../src/guestfs-actions.pod:4353
14961 " struct guestfs_xattr_list *\n"
14962 " guestfs_lxattrlist (guestfs_h *g,\n"
14963 " const char *path,\n"
14964 " char *const *names);\n"
14970 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2924
14972 "This call allows you to get the extended attributes of multiple files, where "
14973 "all files are in the directory C<path>. C<names> is the list of files from "
14979 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2928
14981 "On return you get a flat list of xattr structs which must be interpreted "
14982 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14983 "C<attrval> in this struct is zero-length to indicate there was an error "
14984 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14985 "number (the number of following attributes for this file, which could be C<"
14986 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14987 "for the first named file. This repeats for the second and subsequent files."
14992 #: ../src/guestfs-actions.pod:4372
14994 "This call is intended for programs that want to efficiently list a directory "
14995 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14996 "a similarly efficient call for getting standard stats. Very long directory "
14997 "listings might cause the protocol message size to be exceeded, causing this "
14998 "call to fail. The caller must split up such requests into smaller groups of "
15004 #: ../src/guestfs-actions.pod:4386
15005 msgid "guestfs_mkdir"
15010 #: ../src/guestfs-actions.pod:4388
15014 " guestfs_mkdir (guestfs_h *g,\n"
15015 " const char *path);\n"
15021 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2950
15022 msgid "Create a directory named C<path>."
15027 #: ../src/guestfs-actions.pod:4398
15028 msgid "guestfs_mkdir_mode"
15033 #: ../src/guestfs-actions.pod:4400
15037 " guestfs_mkdir_mode (guestfs_h *g,\n"
15038 " const char *path,\n"
15045 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2956
15047 "This command creates a directory, setting the initial permissions of the "
15048 "directory to C<mode>."
15053 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:2959
15055 "For common Linux filesystems, the actual mode which is set will be C<mode & "
15056 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
15062 #: ../src/guestfs-actions.pod:4412
15063 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
15068 #: ../src/guestfs-actions.pod:4418
15069 msgid "guestfs_mkdir_p"
15074 #: ../src/guestfs-actions.pod:4420
15078 " guestfs_mkdir_p (guestfs_h *g,\n"
15079 " const char *path);\n"
15085 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2969
15087 "Create a directory named C<path>, creating any parent directories as "
15088 "necessary. This is like the C<mkdir -p> shell command."
15093 #: ../src/guestfs-actions.pod:4431
15094 msgid "guestfs_mkdtemp"
15099 #: ../src/guestfs-actions.pod:4433
15103 " guestfs_mkdtemp (guestfs_h *g,\n"
15104 " const char *template);\n"
15110 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:2976
15112 "This command creates a temporary directory. The C<template> parameter "
15113 "should be a full pathname for the temporary directory name with the final "
15114 "six characters being \"XXXXXX\"."
15119 #: ../src/guestfs-actions.pod:4442 ../fish/guestfish-actions.pod:2981
15121 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
15122 "being suitable for Windows filesystems."
15127 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2984
15128 msgid "The name of the temporary directory that was created is returned."
15133 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2987
15134 msgid "The temporary directory is created with mode 0700 and is owned by root."
15139 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:2990
15141 "The caller is responsible for deleting the temporary directory and its "
15142 "contents after use."
15147 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2993
15148 msgid "See also: L<mkdtemp(3)>"
15153 #: ../src/guestfs-actions.pod:4461
15154 msgid "guestfs_mke2fs_J"
15159 #: ../src/guestfs-actions.pod:4463
15163 " guestfs_mke2fs_J (guestfs_h *g,\n"
15164 " const char *fstype,\n"
15165 " int blocksize,\n"
15166 " const char *device,\n"
15167 " const char *journal);\n"
15173 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2999
15175 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15176 "C<journal>. It is equivalent to the command:"
15181 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3003
15184 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
15190 #: ../src/guestfs-actions.pod:4476
15191 msgid "See also C<guestfs_mke2journal>."
15196 #: ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:4498
15197 #: ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4532
15198 #: ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4560
15199 #: ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4896
15200 msgid "(Added in 1.0.68)"
15205 #: ../src/guestfs-actions.pod:4482
15206 msgid "guestfs_mke2fs_JL"
15211 #: ../src/guestfs-actions.pod:4484
15215 " guestfs_mke2fs_JL (guestfs_h *g,\n"
15216 " const char *fstype,\n"
15217 " int blocksize,\n"
15218 " const char *device,\n"
15219 " const char *label);\n"
15225 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3011
15227 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15228 "the journal labeled C<label>."
15233 #: ../src/guestfs-actions.pod:4494
15234 msgid "See also C<guestfs_mke2journal_L>."
15239 #: ../src/guestfs-actions.pod:4500
15240 msgid "guestfs_mke2fs_JU"
15245 #: ../src/guestfs-actions.pod:4502
15249 " guestfs_mke2fs_JU (guestfs_h *g,\n"
15250 " const char *fstype,\n"
15251 " int blocksize,\n"
15252 " const char *device,\n"
15253 " const char *uuid);\n"
15259 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3020
15261 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15262 "the journal with UUID C<uuid>."
15267 #: ../src/guestfs-actions.pod:4512
15268 msgid "See also C<guestfs_mke2journal_U>."
15273 #: ../src/guestfs-actions.pod:4518
15274 msgid "guestfs_mke2journal"
15279 #: ../src/guestfs-actions.pod:4520
15283 " guestfs_mke2journal (guestfs_h *g,\n"
15284 " int blocksize,\n"
15285 " const char *device);\n"
15291 #: ../src/guestfs-actions.pod:4525 ../fish/guestfish-actions.pod:3029
15293 "This creates an ext2 external journal on C<device>. It is equivalent to the "
15299 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3032
15302 " mke2fs -O journal_dev -b blocksize device\n"
15308 #: ../src/guestfs-actions.pod:4534
15309 msgid "guestfs_mke2journal_L"
15314 #: ../src/guestfs-actions.pod:4536
15318 " guestfs_mke2journal_L (guestfs_h *g,\n"
15319 " int blocksize,\n"
15320 " const char *label,\n"
15321 " const char *device);\n"
15327 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3038
15328 msgid "This creates an ext2 external journal on C<device> with label C<label>."
15333 #: ../src/guestfs-actions.pod:4548
15334 msgid "guestfs_mke2journal_U"
15339 #: ../src/guestfs-actions.pod:4550
15343 " guestfs_mke2journal_U (guestfs_h *g,\n"
15344 " int blocksize,\n"
15345 " const char *uuid,\n"
15346 " const char *device);\n"
15352 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3044
15353 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
15358 #: ../src/guestfs-actions.pod:4562
15359 msgid "guestfs_mkfifo"
15364 #: ../src/guestfs-actions.pod:4564
15368 " guestfs_mkfifo (guestfs_h *g,\n"
15370 " const char *path);\n"
15376 #: ../src/guestfs-actions.pod:4569
15378 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
15379 "is just a convenient wrapper around C<guestfs_mknod>."
15384 #: ../src/guestfs-actions.pod:4579
15385 msgid "guestfs_mkfs"
15390 #: ../src/guestfs-actions.pod:4581
15394 " guestfs_mkfs (guestfs_h *g,\n"
15395 " const char *fstype,\n"
15396 " const char *device);\n"
15402 #: ../src/guestfs-actions.pod:4586 ../fish/guestfish-actions.pod:3060
15404 "This creates a filesystem on C<device> (usually a partition or LVM logical "
15405 "volume). The filesystem type is C<fstype>, for example C<ext3>."
15410 #: ../src/guestfs-actions.pod:4594
15411 msgid "guestfs_mkfs_b"
15416 #: ../src/guestfs-actions.pod:4596
15420 " guestfs_mkfs_b (guestfs_h *g,\n"
15421 " const char *fstype,\n"
15422 " int blocksize,\n"
15423 " const char *device);\n"
15429 #: ../src/guestfs-actions.pod:4602
15431 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15432 "block size of the resulting filesystem. Supported block sizes depend on the "
15433 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15438 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4652
15439 #: ../fish/guestfish-actions.pod:3073 ../fish/guestfish-actions.pod:3100
15441 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15447 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3076
15449 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15454 #: ../src/guestfs-actions.pod:4621
15455 msgid "guestfs_mkfs_opts"
15460 #: ../src/guestfs-actions.pod:4623
15464 " guestfs_mkfs_opts (guestfs_h *g,\n"
15465 " const char *fstype,\n"
15466 " const char *device,\n"
15472 #: ../src/guestfs-actions.pod:4634
15475 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15476 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15477 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
15478 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
15484 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3087
15486 "This function creates a filesystem on C<device>. The filesystem type is "
15487 "C<fstype>, for example C<ext3>."
15492 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3094
15493 msgid "C<blocksize>"
15498 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3096
15500 "The filesystem block size. Supported block sizes depend on the filesystem "
15501 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15506 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3103
15507 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15511 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3105
15512 msgid "C<features>"
15516 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3107
15517 msgid "This passes the I<-O> parameter to the external mkfs program."
15521 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3109
15523 "For certain filesystem types, this allows extra filesystem features to be "
15524 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15528 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3113
15530 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15535 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3116
15540 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3118
15542 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
15543 "sets the inode size (only for ext2/3/4 filesystems at present)."
15547 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3121
15548 msgid "C<sectorsize>"
15552 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3123
15554 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
15555 "sets sector size for ufs filesystem."
15559 #: ../src/guestfs-actions.pod:4682
15560 msgid "(Added in 1.7.19)"
15565 #: ../src/guestfs-actions.pod:4684
15566 msgid "guestfs_mkfs_opts_va"
15571 #: ../src/guestfs-actions.pod:4686
15575 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15576 " const char *fstype,\n"
15577 " const char *device,\n"
15578 " va_list args);\n"
15584 #: ../src/guestfs-actions.pod:4692
15585 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15590 #: ../src/guestfs-actions.pod:4696
15591 msgid "guestfs_mkfs_opts_argv"
15596 #: ../src/guestfs-actions.pod:4698
15600 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15601 " const char *fstype,\n"
15602 " const char *device,\n"
15603 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15609 #: ../src/guestfs-actions.pod:4704
15610 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15615 #: ../src/guestfs-actions.pod:4708
15616 msgid "guestfs_mkmountpoint"
15621 #: ../src/guestfs-actions.pod:4710
15625 " guestfs_mkmountpoint (guestfs_h *g,\n"
15626 " const char *exemptpath);\n"
15632 #: ../src/guestfs-actions.pod:4714
15634 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15635 "that can be used to create extra mountpoints before mounting the first "
15641 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3138
15643 "These calls are I<only> necessary in some very limited circumstances, mainly "
15644 "the case where you want to mount a mix of unrelated and/or read-only "
15645 "filesystems together."
15650 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3142
15652 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15653 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15654 "inside that. You can unpack this as follows in guestfish:"
15659 #: ../src/guestfs-actions.pod:4727 ../fish/guestfish-actions.pod:3147
15662 " add-ro Fedora-11-i686-Live.iso\n"
15664 " mkmountpoint /cd\n"
15665 " mkmountpoint /sqsh\n"
15666 " mkmountpoint /ext3fs\n"
15667 " mount /dev/sda /cd\n"
15668 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15669 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15675 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3156
15676 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15681 #: ../src/guestfs-actions.pod:4738
15683 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15684 "may get unexpected errors if you try to mix these calls. It is safest to "
15685 "manually unmount filesystems and remove mountpoints after use."
15690 #: ../src/guestfs-actions.pod:4742
15692 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15693 "first, so for this to work for manual mountpoints, you must ensure that the "
15694 "innermost mountpoints have the longest pathnames, as in the example code "
15700 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3167
15702 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15706 #: ../src/guestfs-actions.pod:4749
15708 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15709 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15710 "can also trigger these issues."
15715 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:5071
15716 #: ../src/guestfs-actions.pod:6075
15717 msgid "(Added in 1.0.62)"
15722 #: ../src/guestfs-actions.pod:4757
15723 msgid "guestfs_mknod"
15728 #: ../src/guestfs-actions.pod:4759
15732 " guestfs_mknod (guestfs_h *g,\n"
15736 " const char *path);\n"
15742 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3177
15744 "This call creates block or character special devices, or named pipes (FIFOs)."
15749 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3180
15751 "The C<mode> parameter should be the mode, using the standard constants. "
15752 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15753 "used when creating block and character special devices."
15758 #: ../src/guestfs-actions.pod:4774
15760 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15761 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15762 "regular file). These constants are available in the standard Linux header "
15763 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15764 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15765 "the appropriate constant for you."
15770 #: ../src/guestfs-actions.pod:4788
15771 msgid "guestfs_mknod_b"
15776 #: ../src/guestfs-actions.pod:4790
15780 " guestfs_mknod_b (guestfs_h *g,\n"
15784 " const char *path);\n"
15790 #: ../src/guestfs-actions.pod:4797
15792 "This call creates a block device node called C<path> with mode C<mode> and "
15793 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15794 "wrapper around C<guestfs_mknod>."
15799 #: ../src/guestfs-actions.pod:4807
15800 msgid "guestfs_mknod_c"
15805 #: ../src/guestfs-actions.pod:4809
15809 " guestfs_mknod_c (guestfs_h *g,\n"
15813 " const char *path);\n"
15819 #: ../src/guestfs-actions.pod:4816
15821 "This call creates a char device node called C<path> with mode C<mode> and "
15822 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15823 "wrapper around C<guestfs_mknod>."
15828 #: ../src/guestfs-actions.pod:4826
15829 msgid "guestfs_mkswap"
15834 #: ../src/guestfs-actions.pod:4828
15838 " guestfs_mkswap (guestfs_h *g,\n"
15839 " const char *device);\n"
15845 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3219
15846 msgid "Create a swap partition on C<device>."
15851 #: ../src/guestfs-actions.pod:4838
15852 msgid "guestfs_mkswap_L"
15857 #: ../src/guestfs-actions.pod:4840
15861 " guestfs_mkswap_L (guestfs_h *g,\n"
15862 " const char *label,\n"
15863 " const char *device);\n"
15869 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3225
15870 msgid "Create a swap partition on C<device> with label C<label>."
15875 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3227
15877 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15878 "sda>), just to a partition. This appears to be a limitation of the kernel "
15884 #: ../src/guestfs-actions.pod:4855
15885 msgid "guestfs_mkswap_U"
15890 #: ../src/guestfs-actions.pod:4857
15894 " guestfs_mkswap_U (guestfs_h *g,\n"
15895 " const char *uuid,\n"
15896 " const char *device);\n"
15902 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3235
15903 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15908 #: ../src/guestfs-actions.pod:4868
15909 msgid "guestfs_mkswap_file"
15914 #: ../src/guestfs-actions.pod:4870
15918 " guestfs_mkswap_file (guestfs_h *g,\n"
15919 " const char *path);\n"
15925 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3241
15926 msgid "Create a swap file."
15931 #: ../src/guestfs-actions.pod:4876
15933 "This command just writes a swap file signature to an existing file. To "
15934 "create the file itself, use something like C<guestfs_fallocate>."
15939 #: ../src/guestfs-actions.pod:4883
15940 msgid "guestfs_modprobe"
15945 #: ../src/guestfs-actions.pod:4885
15949 " guestfs_modprobe (guestfs_h *g,\n"
15950 " const char *modulename);\n"
15956 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3250
15957 msgid "This loads a kernel module in the appliance."
15962 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3252
15964 "The kernel module must have been whitelisted when libguestfs was built (see "
15965 "C<appliance/kmod.whitelist.in> in the source)."
15970 #: ../src/guestfs-actions.pod:4898
15971 msgid "guestfs_mount"
15976 #: ../src/guestfs-actions.pod:4900
15980 " guestfs_mount (guestfs_h *g,\n"
15981 " const char *device,\n"
15982 " const char *mountpoint);\n"
15988 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3259
15990 "Mount a guest disk at a position in the filesystem. Block devices are named "
15991 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15992 "those block devices contain partitions, they will have the usual names (eg. "
15993 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15998 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3265
16000 "The rules are the same as for L<mount(2)>: A filesystem must first be "
16001 "mounted on C</> before others can be mounted. Other filesystems can only be "
16002 "mounted on directories which already exist."
16007 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3270
16009 "The mounted filesystem is writable, if we have sufficient permissions on the "
16010 "underlying device."
16015 #: ../src/guestfs-actions.pod:4919
16017 "B<Important note:> When you use this call, the filesystem options C<sync> "
16018 "and C<noatime> are set implicitly. This was originally done because we "
16019 "thought it would improve reliability, but it turns out that I<-o sync> has a "
16020 "very large negative performance impact and negligible effect on "
16021 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
16022 "in any code that needs performance, and instead use C<guestfs_mount_options> "
16023 "(use an empty string for the first parameter if you don't want any options)."
16027 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3283
16029 "This function is deprecated. In new code, use the C<mount_options> call "
16034 #: ../src/guestfs-actions.pod:4940
16035 msgid "guestfs_mount_9p"
16039 #: ../src/guestfs-actions.pod:4942
16043 " guestfs_mount_9p (guestfs_h *g,\n"
16044 " const char *mounttag,\n"
16045 " const char *mountpoint,\n"
16051 #: ../src/guestfs-actions.pod:4953
16054 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
16059 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3294
16061 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
16066 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3297
16068 "If required, C<trans=virtio> will be automatically added to the options. "
16069 "Any other options required can be passed in the optional C<options> "
16074 #: ../src/guestfs-actions.pod:4966
16075 msgid "guestfs_mount_9p_va"
16079 #: ../src/guestfs-actions.pod:4968
16083 " guestfs_mount_9p_va (guestfs_h *g,\n"
16084 " const char *mounttag,\n"
16085 " const char *mountpoint,\n"
16086 " va_list args);\n"
16091 #: ../src/guestfs-actions.pod:4974
16092 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
16096 #: ../src/guestfs-actions.pod:4978
16097 msgid "guestfs_mount_9p_argv"
16101 #: ../src/guestfs-actions.pod:4980
16105 " guestfs_mount_9p_argv (guestfs_h *g,\n"
16106 " const char *mounttag,\n"
16107 " const char *mountpoint,\n"
16108 " const struct guestfs_mount_9p_argv *optargs);\n"
16113 #: ../src/guestfs-actions.pod:4986
16114 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
16119 #: ../src/guestfs-actions.pod:4990
16120 msgid "guestfs_mount_loop"
16125 #: ../src/guestfs-actions.pod:4992
16129 " guestfs_mount_loop (guestfs_h *g,\n"
16130 " const char *file,\n"
16131 " const char *mountpoint);\n"
16137 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3307
16139 "This command lets you mount C<file> (a filesystem image in a file) on a "
16140 "mount point. It is entirely equivalent to the command C<mount -o loop file "
16146 #: ../src/guestfs-actions.pod:5005
16147 msgid "guestfs_mount_options"
16152 #: ../src/guestfs-actions.pod:5007
16156 " guestfs_mount_options (guestfs_h *g,\n"
16157 " const char *options,\n"
16158 " const char *device,\n"
16159 " const char *mountpoint);\n"
16165 #: ../src/guestfs-actions.pod:5013
16167 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16168 "the mount options as for the L<mount(8)> I<-o> flag."
16173 #: ../src/guestfs-actions.pod:5017 ../fish/guestfish-actions.pod:3319
16175 "If the C<options> parameter is an empty string, then no options are passed "
16176 "(all options default to whatever the filesystem uses)."
16181 #: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5037
16182 #: ../src/guestfs-actions.pod:5054
16183 msgid "(Added in 1.0.10)"
16188 #: ../src/guestfs-actions.pod:5025
16189 msgid "guestfs_mount_ro"
16194 #: ../src/guestfs-actions.pod:5027
16198 " guestfs_mount_ro (guestfs_h *g,\n"
16199 " const char *device,\n"
16200 " const char *mountpoint);\n"
16206 #: ../src/guestfs-actions.pod:5032
16208 "This is the same as the C<guestfs_mount> command, but it mounts the "
16209 "filesystem with the read-only (I<-o ro>) flag."
16214 #: ../src/guestfs-actions.pod:5039
16215 msgid "guestfs_mount_vfs"
16220 #: ../src/guestfs-actions.pod:5041
16224 " guestfs_mount_vfs (guestfs_h *g,\n"
16225 " const char *options,\n"
16226 " const char *vfstype,\n"
16227 " const char *device,\n"
16228 " const char *mountpoint);\n"
16234 #: ../src/guestfs-actions.pod:5048
16236 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16237 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
16243 #: ../src/guestfs-actions.pod:5056
16244 msgid "guestfs_mountpoints"
16249 #: ../src/guestfs-actions.pod:5058
16253 " guestfs_mountpoints (guestfs_h *g);\n"
16259 #: ../src/guestfs-actions.pod:5061
16261 "This call is similar to C<guestfs_mounts>. That call returns a list of "
16262 "devices. This one returns a hash table (map) of device name to directory "
16263 "where the device is mounted."
16268 #: ../src/guestfs-actions.pod:5073
16269 msgid "guestfs_mounts"
16274 #: ../src/guestfs-actions.pod:5075
16278 " guestfs_mounts (guestfs_h *g);\n"
16284 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3350
16286 "This returns the list of currently mounted filesystems. It returns the list "
16287 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
16292 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3353
16293 msgid "Some internal mounts are not shown."
16298 #: ../src/guestfs-actions.pod:5083
16299 msgid "See also: C<guestfs_mountpoints>"
16304 #: ../src/guestfs-actions.pod:5091
16310 #: ../src/guestfs-actions.pod:5093
16314 " guestfs_mv (guestfs_h *g,\n"
16315 " const char *src,\n"
16316 " const char *dest);\n"
16322 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3361
16324 "This moves a file from C<src> to C<dest> where C<dest> is either a "
16325 "destination filename or destination directory."
16330 #: ../src/guestfs-actions.pod:5105
16331 msgid "guestfs_ntfs_3g_probe"
16336 #: ../src/guestfs-actions.pod:5107
16340 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
16342 " const char *device);\n"
16348 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3368
16350 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
16351 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
16352 "write, and some cannot be mounted at all)."
16357 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3372
16359 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
16360 "can be mounted read-write. Set it to false if you want to test if the "
16361 "volume can be mounted read-only."
16366 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3376
16368 "The return value is an integer which C<0> if the operation would succeed, or "
16369 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
16374 #: ../src/guestfs-actions.pod:5126
16375 msgid "(Added in 1.0.43)"
16380 #: ../src/guestfs-actions.pod:5128
16381 msgid "guestfs_ntfsresize"
16386 #: ../src/guestfs-actions.pod:5130
16390 " guestfs_ntfsresize (guestfs_h *g,\n"
16391 " const char *device);\n"
16396 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5173
16397 #: ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3408
16399 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
16400 "size of the underlying device."
16404 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3387
16406 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
16407 "consistency check (for safety). You have to boot into Windows to perform "
16408 "this check and clear this condition. Furthermore, ntfsresize refuses to "
16409 "resize filesystems which have been marked in this way. So in effect it is "
16410 "not possible to call ntfsresize multiple times on a single filesystem "
16411 "without booting into Windows between each resize."
16415 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5199
16416 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3434
16417 msgid "See also L<ntfsresize(8)>."
16421 #: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5239
16422 #: ../fish/guestfish-actions.pod:3397 ../fish/guestfish-actions.pod:3445
16424 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
16429 #: ../src/guestfs-actions.pod:5158
16430 msgid "guestfs_ntfsresize_opts"
16434 #: ../src/guestfs-actions.pod:5160
16438 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
16439 " const char *device,\n"
16445 #: ../src/guestfs-actions.pod:5170
16448 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
16449 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
16454 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3417
16456 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
16457 "resized to fit the container (eg. partition)."
16461 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3420
16466 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3422
16468 "If this option is true, then force the resize of the filesystem even if the "
16469 "filesystem is marked as requiring a consistency check."
16473 #: ../src/guestfs-actions.pod:5190
16475 "After the resize operation, the filesystem is always marked as requiring a "
16476 "consistency check (for safety). You have to boot into Windows to perform "
16477 "this check and clear this condition. If you I<don't> set the C<force> "
16478 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
16479 "times on a single filesystem without booting into Windows between each "
16484 #: ../src/guestfs-actions.pod:5205
16485 msgid "guestfs_ntfsresize_opts_va"
16489 #: ../src/guestfs-actions.pod:5207
16493 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
16494 " const char *device,\n"
16495 " va_list args);\n"
16500 #: ../src/guestfs-actions.pod:5212
16501 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
16505 #: ../src/guestfs-actions.pod:5216
16506 msgid "guestfs_ntfsresize_opts_argv"
16510 #: ../src/guestfs-actions.pod:5218
16514 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
16515 " const char *device,\n"
16516 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
16521 #: ../src/guestfs-actions.pod:5223
16522 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
16527 #: ../src/guestfs-actions.pod:5227
16528 msgid "guestfs_ntfsresize_size"
16533 #: ../src/guestfs-actions.pod:5229
16537 " guestfs_ntfsresize_size (guestfs_h *g,\n"
16538 " const char *device,\n"
16539 " int64_t size);\n"
16545 #: ../src/guestfs-actions.pod:5234
16547 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
16548 "to specify the new size (in bytes) explicitly."
16553 #: ../src/guestfs-actions.pod:5246 ../src/guestfs-actions.pod:5682
16554 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6023
16555 #: ../src/guestfs-actions.pod:7625
16556 msgid "(Added in 1.3.14)"
16561 #: ../src/guestfs-actions.pod:5248
16562 msgid "guestfs_part_add"
16567 #: ../src/guestfs-actions.pod:5250
16571 " guestfs_part_add (guestfs_h *g,\n"
16572 " const char *device,\n"
16573 " const char *prlogex,\n"
16574 " int64_t startsect,\n"
16575 " int64_t endsect);\n"
16581 #: ../src/guestfs-actions.pod:5257
16583 "This command adds a partition to C<device>. If there is no partition table "
16584 "on the device, call C<guestfs_part_init> first."
16589 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3459
16591 "The C<prlogex> parameter is the type of partition. Normally you should pass "
16592 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
16593 "C<logical>) and C<e> (or C<extended>) partition types."
16598 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3464
16600 "C<startsect> and C<endsect> are the start and end of the partition in "
16601 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
16602 "from the end of the disk (C<-1> is the last sector)."
16607 #: ../src/guestfs-actions.pod:5269
16609 "Creating a partition which covers the whole disk is not so easy. Use "
16610 "C<guestfs_part_disk> to do that."
16615 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5312
16616 #: ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5443
16617 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5500
16618 #: ../src/guestfs-actions.pod:5540
16619 msgid "(Added in 1.0.78)"
16624 #: ../src/guestfs-actions.pod:5276
16625 msgid "guestfs_part_del"
16630 #: ../src/guestfs-actions.pod:5278
16634 " guestfs_part_del (guestfs_h *g,\n"
16635 " const char *device,\n"
16642 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3475
16643 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16648 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3477
16650 "Note that in the case of MBR partitioning, deleting an extended partition "
16651 "also deletes any logical partitions it contains."
16656 #: ../src/guestfs-actions.pod:5293
16657 msgid "guestfs_part_disk"
16662 #: ../src/guestfs-actions.pod:5295
16666 " guestfs_part_disk (guestfs_h *g,\n"
16667 " const char *device,\n"
16668 " const char *parttype);\n"
16674 #: ../src/guestfs-actions.pod:5300
16676 "This command is simply a combination of C<guestfs_part_init> followed by "
16677 "C<guestfs_part_add> to create a single primary partition covering the whole "
16683 #: ../src/guestfs-actions.pod:5304
16685 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16686 "possible values are described in C<guestfs_part_init>."
16691 #: ../src/guestfs-actions.pod:5314
16692 msgid "guestfs_part_get_bootable"
16697 #: ../src/guestfs-actions.pod:5316
16701 " guestfs_part_get_bootable (guestfs_h *g,\n"
16702 " const char *device,\n"
16709 #: ../src/guestfs-actions.pod:5321 ../fish/guestfish-actions.pod:3499
16711 "This command returns true if the partition C<partnum> on C<device> has the "
16712 "bootable flag set."
16717 #: ../src/guestfs-actions.pod:5324
16718 msgid "See also C<guestfs_part_set_bootable>."
16723 #: ../src/guestfs-actions.pod:5330
16724 msgid "guestfs_part_get_mbr_id"
16729 #: ../src/guestfs-actions.pod:5332
16733 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16734 " const char *device,\n"
16741 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3508
16743 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16744 "partition C<partnum>."
16749 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5516
16751 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16752 "undefined results for other partition table types (see "
16753 "C<guestfs_part_get_parttype>)."
16758 #: ../src/guestfs-actions.pod:5348
16759 msgid "guestfs_part_get_parttype"
16764 #: ../src/guestfs-actions.pod:5350
16768 " guestfs_part_get_parttype (guestfs_h *g,\n"
16769 " const char *device);\n"
16775 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3519
16777 "This command examines the partition table on C<device> and returns the "
16778 "partition table type (format) being used."
16783 #: ../src/guestfs-actions.pod:5357
16785 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16786 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16787 "possible, although unusual. See C<guestfs_part_init> for a full list."
16792 #: ../src/guestfs-actions.pod:5367
16793 msgid "guestfs_part_init"
16798 #: ../src/guestfs-actions.pod:5369
16802 " guestfs_part_init (guestfs_h *g,\n"
16803 " const char *device,\n"
16804 " const char *parttype);\n"
16810 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3531
16812 "This creates an empty partition table on C<device> of one of the partition "
16813 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16814 "(for large disks)."
16819 #: ../src/guestfs-actions.pod:5378
16821 "Initially there are no partitions. Following this, you should call "
16822 "C<guestfs_part_add> for each partition required."
16827 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3538
16828 msgid "Possible values for C<parttype> are:"
16833 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3542
16834 msgid "B<efi> | B<gpt>"
16839 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3544
16840 msgid "Intel EFI / GPT partition table."
16845 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3546
16847 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16848 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16849 "the C<mbr> format."
16854 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3550
16855 msgid "B<mbr> | B<msdos>"
16860 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3552
16862 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16863 "Windows. This partition type will B<only> work for device sizes up to 2 "
16864 "TB. For large disks we recommend using C<gpt>."
16869 #: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3559
16871 "Other partition table types that may work but are not supported include:"
16876 #: ../src/guestfs-actions.pod:5407 ../fish/guestfish-actions.pod:3564
16882 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3566
16883 msgid "AIX disk labels."
16888 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3568
16889 msgid "B<amiga> | B<rdb>"
16894 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3570
16895 msgid "Amiga \"Rigid Disk Block\" format."
16900 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3572
16906 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3574
16907 msgid "BSD disk labels."
16912 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3576
16918 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3578
16919 msgid "DASD, used on IBM mainframes."
16924 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3580
16930 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3582
16931 msgid "MIPS/SGI volumes."
16936 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3584
16942 #: ../src/guestfs-actions.pod:5429 ../fish/guestfish-actions.pod:3586
16943 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16948 #: ../src/guestfs-actions.pod:5431 ../fish/guestfish-actions.pod:3588
16954 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3590
16955 msgid "NEC PC-98 format, common in Japan apparently."
16960 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3592
16966 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3594
16967 msgid "Sun disk labels."
16972 #: ../src/guestfs-actions.pod:5445
16973 msgid "guestfs_part_list"
16978 #: ../src/guestfs-actions.pod:5447
16981 " struct guestfs_partition_list *\n"
16982 " guestfs_part_list (guestfs_h *g,\n"
16983 " const char *device);\n"
16989 #: ../src/guestfs-actions.pod:5451 ../fish/guestfish-actions.pod:3602
16991 "This command parses the partition table on C<device> and returns the list of "
16992 "partitions found."
16997 #: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:3605
16998 msgid "The fields in the returned structure are:"
17003 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3609
17004 msgid "B<part_num>"
17009 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3611
17010 msgid "Partition number, counting from 1."
17015 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3613
17016 msgid "B<part_start>"
17021 #: ../src/guestfs-actions.pod:5464
17023 "Start of the partition I<in bytes>. To get sectors you have to divide by "
17024 "the device's sector size, see C<guestfs_blockdev_getss>."
17029 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3618
17030 msgid "B<part_end>"
17035 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3620
17036 msgid "End of the partition in bytes."
17041 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3622
17042 msgid "B<part_size>"
17047 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3624
17048 msgid "Size of the partition in bytes."
17053 #: ../src/guestfs-actions.pod:5477
17055 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
17056 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
17062 #: ../src/guestfs-actions.pod:5483
17063 msgid "guestfs_part_set_bootable"
17068 #: ../src/guestfs-actions.pod:5485
17072 " guestfs_part_set_bootable (guestfs_h *g,\n"
17073 " const char *device,\n"
17075 " int bootable);\n"
17081 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3632
17083 "This sets the bootable flag on partition numbered C<partnum> on device "
17084 "C<device>. Note that partitions are numbered from 1."
17089 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3635
17091 "The bootable flag is used by some operating systems (notably Windows) to "
17092 "determine which partition to boot from. It is by no means universally "
17098 #: ../src/guestfs-actions.pod:5502
17099 msgid "guestfs_part_set_mbr_id"
17104 #: ../src/guestfs-actions.pod:5504
17108 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
17109 " const char *device,\n"
17117 #: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3643
17119 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
17120 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
17121 "documentation are in fact hexadecimal numbers, but usually documented "
17122 "without any leading \"0x\" which might be confusing."
17127 #: ../src/guestfs-actions.pod:5524
17128 msgid "guestfs_part_set_name"
17133 #: ../src/guestfs-actions.pod:5526
17137 " guestfs_part_set_name (guestfs_h *g,\n"
17138 " const char *device,\n"
17140 " const char *name);\n"
17146 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3657
17148 "This sets the partition name on partition numbered C<partnum> on device "
17149 "C<device>. Note that partitions are numbered from 1."
17154 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3660
17156 "The partition name can only be set on certain types of partition table. "
17157 "This works on C<gpt> but not on C<mbr> partitions."
17162 #: ../src/guestfs-actions.pod:5542
17163 msgid "guestfs_part_to_dev"
17168 #: ../src/guestfs-actions.pod:5544
17172 " guestfs_part_to_dev (guestfs_h *g,\n"
17173 " const char *partition);\n"
17179 #: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3667
17181 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
17182 "partition number, returning the device name (eg. \"/dev/sdb\")."
17187 #: ../src/guestfs-actions.pod:5552
17189 "The named partition must exist, for example as a string returned from "
17190 "C<guestfs_list_partitions>."
17195 #: ../src/guestfs-actions.pod:5560
17196 msgid "guestfs_ping_daemon"
17201 #: ../src/guestfs-actions.pod:5562
17205 " guestfs_ping_daemon (guestfs_h *g);\n"
17211 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3678
17213 "This is a test probe into the guestfs daemon running inside the qemu "
17214 "subprocess. Calling this function checks that the daemon responds to the "
17215 "ping message, without affecting the daemon or attached block device(s) in "
17221 #: ../src/guestfs-actions.pod:5574
17222 msgid "guestfs_pread"
17227 #: ../src/guestfs-actions.pod:5576
17231 " guestfs_pread (guestfs_h *g,\n"
17232 " const char *path,\n"
17234 " int64_t offset,\n"
17235 " size_t *size_r);\n"
17241 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3687
17243 "This command lets you read part of a file. It reads C<count> bytes of the "
17244 "file, starting at C<offset>, from file C<path>."
17249 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:5612
17250 #: ../fish/guestfish-actions.pod:3690 ../fish/guestfish-actions.pod:3705
17252 "This may read fewer bytes than requested. For further details see the "
17253 "L<pread(2)> system call."
17258 #: ../src/guestfs-actions.pod:5589
17259 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
17264 #: ../src/guestfs-actions.pod:5600
17265 msgid "guestfs_pread_device"
17270 #: ../src/guestfs-actions.pod:5602
17274 " guestfs_pread_device (guestfs_h *g,\n"
17275 " const char *device,\n"
17277 " int64_t offset,\n"
17278 " size_t *size_r);\n"
17284 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3702
17286 "This command lets you read part of a file. It reads C<count> bytes of "
17287 "C<device>, starting at C<offset>."
17292 #: ../src/guestfs-actions.pod:5615
17293 msgid "See also C<guestfs_pread>."
17298 #: ../src/guestfs-actions.pod:5624
17299 msgid "(Added in 1.5.21)"
17304 #: ../src/guestfs-actions.pod:5626
17305 msgid "guestfs_pvcreate"
17310 #: ../src/guestfs-actions.pod:5628
17314 " guestfs_pvcreate (guestfs_h *g,\n"
17315 " const char *device);\n"
17321 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3717
17323 "This creates an LVM physical volume on the named C<device>, where C<device> "
17324 "should usually be a partition name such as C</dev/sda1>."
17329 #: ../src/guestfs-actions.pod:5640
17330 msgid "guestfs_pvremove"
17335 #: ../src/guestfs-actions.pod:5642
17339 " guestfs_pvremove (guestfs_h *g,\n"
17340 " const char *device);\n"
17346 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3725
17348 "This wipes a physical volume C<device> so that LVM will no longer recognise "
17354 #: ../src/guestfs-actions.pod:5649 ../fish/guestfish-actions.pod:3728
17356 "The implementation uses the C<pvremove> command which refuses to wipe "
17357 "physical volumes that contain any volume groups, so you have to remove those "
17363 #: ../src/guestfs-actions.pod:5657
17364 msgid "guestfs_pvresize"
17369 #: ../src/guestfs-actions.pod:5659
17373 " guestfs_pvresize (guestfs_h *g,\n"
17374 " const char *device);\n"
17380 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3736
17382 "This resizes (expands or shrinks) an existing LVM physical volume to match "
17383 "the new size of the underlying device."
17388 #: ../src/guestfs-actions.pod:5670
17389 msgid "guestfs_pvresize_size"
17394 #: ../src/guestfs-actions.pod:5672
17398 " guestfs_pvresize_size (guestfs_h *g,\n"
17399 " const char *device,\n"
17400 " int64_t size);\n"
17406 #: ../src/guestfs-actions.pod:5677
17408 "This command is the same as C<guestfs_pvresize> except that it allows you to "
17409 "specify the new size (in bytes) explicitly."
17414 #: ../src/guestfs-actions.pod:5684
17415 msgid "guestfs_pvs"
17420 #: ../src/guestfs-actions.pod:5686
17424 " guestfs_pvs (guestfs_h *g);\n"
17430 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3750
17432 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17438 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3753
17440 "This returns a list of just the device names that contain PVs (eg. C</dev/"
17446 #: ../src/guestfs-actions.pod:5695
17447 msgid "See also C<guestfs_pvs_full>."
17452 #: ../src/guestfs-actions.pod:5703
17453 msgid "guestfs_pvs_full"
17458 #: ../src/guestfs-actions.pod:5705
17461 " struct guestfs_lvm_pv_list *\n"
17462 " guestfs_pvs_full (guestfs_h *g);\n"
17468 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3762
17470 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17471 "(8)> command. The \"full\" version includes all fields."
17476 #: ../src/guestfs-actions.pod:5711
17478 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
17479 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
17484 #: ../src/guestfs-actions.pod:5717
17485 msgid "guestfs_pvuuid"
17490 #: ../src/guestfs-actions.pod:5719
17494 " guestfs_pvuuid (guestfs_h *g,\n"
17495 " const char *device);\n"
17501 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3769
17502 msgid "This command returns the UUID of the LVM PV C<device>."
17507 #: ../src/guestfs-actions.pod:5730
17508 msgid "guestfs_pwrite"
17513 #: ../src/guestfs-actions.pod:5732
17517 " guestfs_pwrite (guestfs_h *g,\n"
17518 " const char *path,\n"
17519 " const char *content,\n"
17520 " size_t content_size,\n"
17521 " int64_t offset);\n"
17527 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3775
17529 "This command writes to part of a file. It writes the data buffer C<content> "
17530 "to the file C<path> starting at offset C<offset>."
17535 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3778
17537 "This command implements the L<pwrite(2)> system call, and like that system "
17538 "call it may not write the full data requested. The return value is the "
17539 "number of bytes that were actually written to the file. This could even be "
17540 "0, although short writes are unlikely for regular files in ordinary "
17546 #: ../src/guestfs-actions.pod:5748
17547 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
17552 #: ../src/guestfs-actions.pod:5757
17553 msgid "guestfs_pwrite_device"
17558 #: ../src/guestfs-actions.pod:5759
17562 " guestfs_pwrite_device (guestfs_h *g,\n"
17563 " const char *device,\n"
17564 " const char *content,\n"
17565 " size_t content_size,\n"
17566 " int64_t offset);\n"
17572 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3793
17574 "This command writes to part of a device. It writes the data buffer "
17575 "C<content> to C<device> starting at offset C<offset>."
17580 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3796
17582 "This command implements the L<pwrite(2)> system call, and like that system "
17583 "call it may not write the full data requested (although short writes to disk "
17584 "devices and partitions are probably impossible with standard Linux kernels)."
17589 #: ../src/guestfs-actions.pod:5774
17590 msgid "See also C<guestfs_pwrite>."
17595 #: ../src/guestfs-actions.pod:5781
17596 msgid "(Added in 1.5.20)"
17601 #: ../src/guestfs-actions.pod:5783
17602 msgid "guestfs_read_file"
17607 #: ../src/guestfs-actions.pod:5785
17611 " guestfs_read_file (guestfs_h *g,\n"
17612 " const char *path,\n"
17613 " size_t *size_r);\n"
17619 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3810
17620 msgid "This calls returns the contents of the file C<path> as a buffer."
17625 #: ../src/guestfs-actions.pod:5793
17627 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
17628 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
17629 "function is limited in the total size of file that can be handled."
17634 #: ../src/guestfs-actions.pod:5805
17635 msgid "(Added in 1.0.63)"
17640 #: ../src/guestfs-actions.pod:5807
17641 msgid "guestfs_read_lines"
17646 #: ../src/guestfs-actions.pod:5809
17650 " guestfs_read_lines (guestfs_h *g,\n"
17651 " const char *path);\n"
17657 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3827
17659 "The file contents are returned as a list of lines. Trailing C<LF> and "
17660 "C<CRLF> character sequences are I<not> returned."
17665 #: ../src/guestfs-actions.pod:5818
17667 "Note that this function cannot correctly handle binary files (specifically, "
17668 "files containing C<\\0> character which is treated as end of line). For "
17669 "those you need to use the C<guestfs_read_file> function which has a more "
17670 "complex interface."
17675 #: ../src/guestfs-actions.pod:5829
17676 msgid "guestfs_readdir"
17681 #: ../src/guestfs-actions.pod:5831
17684 " struct guestfs_dirent_list *\n"
17685 " guestfs_readdir (guestfs_h *g,\n"
17686 " const char *dir);\n"
17692 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3839
17693 msgid "This returns the list of directory entries in directory C<dir>."
17698 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3841
17700 "All entries in the directory are returned, including C<.> and C<..>. The "
17701 "entries are I<not> sorted, but returned in the same order as the underlying "
17707 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3845
17709 "Also this call returns basic file type information about each file. The "
17710 "C<ftyp> field will contain one of the following characters:"
17715 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3850
17721 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3852
17722 msgid "Block special"
17727 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3854
17733 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3856
17734 msgid "Char special"
17739 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3858
17745 #: ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:3860
17751 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3862
17757 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3864
17758 msgid "FIFO (named pipe)"
17763 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3866
17769 #: ../src/guestfs-actions.pod:5864 ../fish/guestfish-actions.pod:3868
17770 msgid "Symbolic link"
17775 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3870
17781 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3872
17782 msgid "Regular file"
17787 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3874
17793 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3876
17799 #: ../src/guestfs-actions.pod:5874 ../fish/guestfish-actions.pod:3878
17805 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3880
17806 msgid "Unknown file type"
17811 #: ../src/guestfs-actions.pod:5878 ../fish/guestfish-actions.pod:3882
17817 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3884
17819 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17824 #: ../src/guestfs-actions.pod:5885
17826 "This function is primarily intended for use by programs. To get a simple "
17827 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17828 "consumption, use C<guestfs_ll>."
17833 #: ../src/guestfs-actions.pod:5889
17835 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17836 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17841 #: ../src/guestfs-actions.pod:5895
17842 msgid "guestfs_readlink"
17847 #: ../src/guestfs-actions.pod:5897
17851 " guestfs_readlink (guestfs_h *g,\n"
17852 " const char *path);\n"
17858 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3897
17859 msgid "This command reads the target of a symbolic link."
17864 #: ../src/guestfs-actions.pod:5908
17865 msgid "guestfs_readlinklist"
17870 #: ../src/guestfs-actions.pod:5910
17874 " guestfs_readlinklist (guestfs_h *g,\n"
17875 " const char *path,\n"
17876 " char *const *names);\n"
17882 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3903
17884 "This call allows you to do a C<readlink> operation on multiple files, where "
17885 "all files are in the directory C<path>. C<names> is the list of files from "
17891 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3907
17893 "On return you get a list of strings, with a one-to-one correspondence to the "
17894 "C<names> list. Each string is the value of the symbolic link."
17899 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3911
17901 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17902 "result string is the empty string C<\"\">. However the whole operation is "
17903 "completed even if there were C<readlink(2)> errors, and so you can call this "
17904 "function with names where you don't know if they are symbolic links already "
17905 "(albeit slightly less efficient)."
17910 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3918
17912 "This call is intended for programs that want to efficiently list a directory "
17913 "contents without making many round-trips. Very long directory listings "
17914 "might cause the protocol message size to be exceeded, causing this call to "
17915 "fail. The caller must split up such requests into smaller groups of names."
17920 #: ../src/guestfs-actions.pod:5943
17921 msgid "guestfs_realpath"
17926 #: ../src/guestfs-actions.pod:5945
17930 " guestfs_realpath (guestfs_h *g,\n"
17931 " const char *path);\n"
17937 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3929
17939 "Return the canonicalized absolute pathname of C<path>. The returned path "
17940 "has no C<.>, C<..> or symbolic link path elements."
17945 #: ../src/guestfs-actions.pod:5957
17946 msgid "guestfs_removexattr"
17951 #: ../src/guestfs-actions.pod:5959
17955 " guestfs_removexattr (guestfs_h *g,\n"
17956 " const char *xattr,\n"
17957 " const char *path);\n"
17963 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:3936
17965 "This call removes the extended attribute named C<xattr> of the file C<path>."
17970 #: ../src/guestfs-actions.pod:5967
17971 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17976 #: ../src/guestfs-actions.pod:5973
17977 msgid "guestfs_resize2fs"
17982 #: ../src/guestfs-actions.pod:5975
17986 " guestfs_resize2fs (guestfs_h *g,\n"
17987 " const char *device);\n"
17993 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3945
17995 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17996 "underlying device."
18001 #: ../src/guestfs-actions.pod:5982
18003 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
18004 "C<device> before calling this command. For unknown reasons C<resize2fs> "
18005 "sometimes gives an error about this and sometimes not. In any case, it is "
18006 "always safe to call C<guestfs_e2fsck_f> before calling this function."
18010 #: ../src/guestfs-actions.pod:5992
18011 msgid "guestfs_resize2fs_M"
18015 #: ../src/guestfs-actions.pod:5994
18019 " guestfs_resize2fs_M (guestfs_h *g,\n"
18020 " const char *device);\n"
18025 #: ../src/guestfs-actions.pod:5998
18027 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
18028 "resized to its minimum size. This works like the I<-M> option to the "
18029 "C<resize2fs> command."
18033 #: ../src/guestfs-actions.pod:6002
18035 "To get the resulting size of the filesystem you should call "
18036 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
18037 "These two numbers, multiplied together, give the resulting size of the "
18038 "minimal filesystem in bytes."
18043 #: ../src/guestfs-actions.pod:6011
18044 msgid "guestfs_resize2fs_size"
18049 #: ../src/guestfs-actions.pod:6013
18053 " guestfs_resize2fs_size (guestfs_h *g,\n"
18054 " const char *device,\n"
18055 " int64_t size);\n"
18061 #: ../src/guestfs-actions.pod:6018
18063 "This command is the same as C<guestfs_resize2fs> except that it allows you "
18064 "to specify the new size (in bytes) explicitly."
18069 #: ../src/guestfs-actions.pod:6025
18075 #: ../src/guestfs-actions.pod:6027
18079 " guestfs_rm (guestfs_h *g,\n"
18080 " const char *path);\n"
18086 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:3978
18087 msgid "Remove the single file C<path>."
18092 #: ../src/guestfs-actions.pod:6037
18093 msgid "guestfs_rm_rf"
18098 #: ../src/guestfs-actions.pod:6039
18102 " guestfs_rm_rf (guestfs_h *g,\n"
18103 " const char *path);\n"
18109 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:3984
18111 "Remove the file or directory C<path>, recursively removing the contents if "
18112 "its a directory. This is like the C<rm -rf> shell command."
18117 #: ../src/guestfs-actions.pod:6051
18118 msgid "guestfs_rmdir"
18123 #: ../src/guestfs-actions.pod:6053
18127 " guestfs_rmdir (guestfs_h *g,\n"
18128 " const char *path);\n"
18134 #: ../src/guestfs-actions.pod:6057 ../fish/guestfish-actions.pod:3992
18135 msgid "Remove the single directory C<path>."
18140 #: ../src/guestfs-actions.pod:6063
18141 msgid "guestfs_rmmountpoint"
18146 #: ../src/guestfs-actions.pod:6065
18150 " guestfs_rmmountpoint (guestfs_h *g,\n"
18151 " const char *exemptpath);\n"
18157 #: ../src/guestfs-actions.pod:6069
18159 "This calls removes a mountpoint that was previously created with "
18160 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
18165 #: ../src/guestfs-actions.pod:6077
18166 msgid "guestfs_scrub_device"
18171 #: ../src/guestfs-actions.pod:6079
18175 " guestfs_scrub_device (guestfs_h *g,\n"
18176 " const char *device);\n"
18182 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4006
18184 "This command writes patterns over C<device> to make data retrieval more "
18190 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6107
18191 #: ../src/guestfs-actions.pod:6126 ../fish/guestfish-actions.pod:4009
18192 #: ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4037
18194 "It is an interface to the L<scrub(1)> program. See that manual page for "
18200 #: ../src/guestfs-actions.pod:6094 ../src/guestfs-actions.pod:6112
18201 #: ../src/guestfs-actions.pod:6131
18202 msgid "(Added in 1.0.52)"
18207 #: ../src/guestfs-actions.pod:6096
18208 msgid "guestfs_scrub_file"
18213 #: ../src/guestfs-actions.pod:6098
18217 " guestfs_scrub_file (guestfs_h *g,\n"
18218 " const char *file);\n"
18224 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4019
18226 "This command writes patterns over a file to make data retrieval more "
18232 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4022
18233 msgid "The file is I<removed> after scrubbing."
18238 #: ../src/guestfs-actions.pod:6114
18239 msgid "guestfs_scrub_freespace"
18244 #: ../src/guestfs-actions.pod:6116
18248 " guestfs_scrub_freespace (guestfs_h *g,\n"
18249 " const char *dir);\n"
18255 #: ../src/guestfs-actions.pod:6120
18257 "This command creates the directory C<dir> and then fills it with files until "
18258 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
18259 "and deletes them. The intention is to scrub any free space on the partition "
18260 "containing C<dir>."
18265 #: ../src/guestfs-actions.pod:6133
18266 msgid "guestfs_set_append"
18271 #: ../src/guestfs-actions.pod:6135
18275 " guestfs_set_append (guestfs_h *g,\n"
18276 " const char *append);\n"
18282 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4046
18284 "This function is used to add additional options to the guest kernel command "
18290 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4049
18292 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
18293 "environment variable."
18298 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4052
18300 "Setting C<append> to C<NULL> means I<no> additional options are passed "
18301 "(libguestfs always adds a few of its own)."
18305 #: ../src/guestfs-actions.pod:6152
18306 msgid "guestfs_set_attach_method"
18310 #: ../src/guestfs-actions.pod:6154
18314 " guestfs_set_attach_method (guestfs_h *g,\n"
18315 " const char *attachmethod);\n"
18320 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4061
18322 "Set the method that libguestfs uses to connect to the back end guestfsd "
18323 "daemon. Possible methods are:"
18327 #: ../src/guestfs-actions.pod:6165 ../fish/guestfish-actions.pod:4068
18329 "Launch an appliance and connect to it. This is the ordinary method and the "
18334 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4071
18335 msgid "C<unix:I<path>>"
18339 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4073
18340 msgid "Connect to the Unix domain socket I<path>."
18344 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4075
18346 "This method lets you connect to an existing daemon or (using virtio-serial) "
18347 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
18348 "RUNNING DAEMONS>."
18353 #: ../src/guestfs-actions.pod:6182
18354 msgid "guestfs_set_autosync"
18359 #: ../src/guestfs-actions.pod:6184
18363 " guestfs_set_autosync (guestfs_h *g,\n"
18364 " int autosync);\n"
18369 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4087
18371 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
18372 "effort attempt to make filesystems consistent and synchronized when the "
18373 "handle is closed (also if the program exits without closing handles)."
18378 #: ../src/guestfs-actions.pod:6193 ../fish/guestfish-actions.pod:4092
18380 "This is enabled by default (since libguestfs 1.5.24, previously it was "
18381 "disabled by default)."
18386 #: ../src/guestfs-actions.pod:6200
18387 msgid "guestfs_set_direct"
18392 #: ../src/guestfs-actions.pod:6202
18396 " guestfs_set_direct (guestfs_h *g,\n"
18403 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4101
18405 "If the direct appliance mode flag is enabled, then stdin and stdout are "
18406 "passed directly through to the appliance once it is launched."
18411 #: ../src/guestfs-actions.pod:6210
18413 "One consequence of this is that log messages aren't caught by the library "
18414 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
18420 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4109
18421 msgid "You probably don't want to use this unless you know what you are doing."
18426 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4112
18427 msgid "The default is disabled."
18432 #: ../src/guestfs-actions.pod:6223
18433 msgid "guestfs_set_e2label"
18438 #: ../src/guestfs-actions.pod:6225
18442 " guestfs_set_e2label (guestfs_h *g,\n"
18443 " const char *device,\n"
18444 " const char *label);\n"
18450 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4118
18452 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
18453 "C<label>. Filesystem labels are limited to 16 characters."
18458 #: ../src/guestfs-actions.pod:6234
18460 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
18461 "the existing label on a filesystem."
18466 #: ../src/guestfs-actions.pod:6241
18467 msgid "guestfs_set_e2uuid"
18472 #: ../src/guestfs-actions.pod:6243
18476 " guestfs_set_e2uuid (guestfs_h *g,\n"
18477 " const char *device,\n"
18478 " const char *uuid);\n"
18484 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4129
18486 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
18487 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
18488 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
18493 #: ../src/guestfs-actions.pod:6253
18495 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
18496 "the existing UUID of a filesystem."
18501 #: ../src/guestfs-actions.pod:6260
18502 msgid "guestfs_set_memsize"
18507 #: ../src/guestfs-actions.pod:6262
18511 " guestfs_set_memsize (guestfs_h *g,\n"
18518 #: ../src/guestfs-actions.pod:6266
18520 "This sets the memory size in megabytes allocated to the qemu subprocess. "
18521 "This only has any effect if called before C<guestfs_launch>."
18526 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4147
18528 "You can also change this by setting the environment variable "
18529 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
18534 #: ../src/guestfs-actions.pod:6281
18535 msgid "guestfs_set_network"
18540 #: ../src/guestfs-actions.pod:6283
18544 " guestfs_set_network (guestfs_h *g,\n"
18551 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4160
18553 "If C<network> is true, then the network is enabled in the libguestfs "
18554 "appliance. The default is false."
18559 #: ../src/guestfs-actions.pod:6290 ../fish/guestfish-actions.pod:4163
18561 "This affects whether commands are able to access the network (see L<guestfs"
18562 "(3)/RUNNING COMMANDS>)."
18567 #: ../src/guestfs-actions.pod:6293
18569 "You must call this before calling C<guestfs_launch>, otherwise it has no "
18575 #: ../src/guestfs-actions.pod:6300
18576 msgid "guestfs_set_path"
18581 #: ../src/guestfs-actions.pod:6302
18585 " guestfs_set_path (guestfs_h *g,\n"
18586 " const char *searchpath);\n"
18592 #: ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:4175
18593 msgid "Set the path that libguestfs searches for kernel and initrd.img."
18598 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4177
18600 "The default is C<$libdir/guestfs> unless overridden by setting "
18601 "C<LIBGUESTFS_PATH> environment variable."
18606 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4180
18607 msgid "Setting C<path> to C<NULL> restores the default path."
18612 #: ../src/guestfs-actions.pod:6317
18613 msgid "guestfs_set_qemu"
18618 #: ../src/guestfs-actions.pod:6319
18622 " guestfs_set_qemu (guestfs_h *g,\n"
18623 " const char *qemu);\n"
18629 #: ../src/guestfs-actions.pod:6323 ../fish/guestfish-actions.pod:4188
18630 msgid "Set the qemu binary that we will use."
18635 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4190
18637 "The default is chosen when the library was compiled by the configure script."
18642 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4193
18644 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18650 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4196
18651 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18656 #: ../src/guestfs-actions.pod:6333 ../fish/guestfish-actions.pod:4198
18658 "Note that you should call this function as early as possible after creating "
18659 "the handle. This is because some pre-launch operations depend on testing "
18660 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18661 "don't retest features, and so you might see inconsistent results. Using the "
18662 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18663 "the qemu binary at the same time as the handle is created."
18668 #: ../src/guestfs-actions.pod:6345
18669 msgid "guestfs_set_recovery_proc"
18674 #: ../src/guestfs-actions.pod:6347
18678 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18679 " int recoveryproc);\n"
18685 #: ../src/guestfs-actions.pod:6351
18687 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18688 "not create a recovery process. The purpose of the recovery process is to "
18689 "stop runaway qemu processes in the case where the main program aborts "
18695 #: ../src/guestfs-actions.pod:6356
18697 "This only has any effect if called before C<guestfs_launch>, and the default "
18703 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4220
18705 "About the only time when you would want to disable this is if the main "
18706 "process will fork itself into the background (\"daemonize\" itself). In "
18707 "this case the recovery process thinks that the main program has disappeared "
18708 "and so kills qemu, which is not very helpful."
18713 #: ../src/guestfs-actions.pod:6369
18714 msgid "guestfs_set_selinux"
18719 #: ../src/guestfs-actions.pod:6371
18723 " guestfs_set_selinux (guestfs_h *g,\n"
18730 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4232
18732 "This sets the selinux flag that is passed to the appliance at boot time. "
18733 "The default is C<selinux=0> (disabled)."
18738 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4235
18740 "Note that if SELinux is enabled, it is always in Permissive mode "
18741 "(C<enforcing=0>)."
18746 #: ../src/guestfs-actions.pod:6388
18747 msgid "guestfs_set_trace"
18752 #: ../src/guestfs-actions.pod:6390
18756 " guestfs_set_trace (guestfs_h *g,\n"
18762 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4247
18764 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18765 "return values are traced."
18770 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4250
18772 "If you want to trace C API calls into libguestfs (and other libraries) then "
18773 "possibly a better way is to use the external ltrace(1) command."
18778 #: ../src/guestfs-actions.pod:6401 ../fish/guestfish-actions.pod:4254
18780 "Command traces are disabled unless the environment variable "
18781 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18785 #: ../src/guestfs-actions.pod:6404
18787 "Trace messages are normally sent to C<stderr>, unless you register a "
18788 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18793 #: ../src/guestfs-actions.pod:6412
18794 msgid "guestfs_set_verbose"
18799 #: ../src/guestfs-actions.pod:6414
18803 " guestfs_set_verbose (guestfs_h *g,\n"
18809 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4267
18810 msgid "If C<verbose> is true, this turns on verbose messages."
18815 #: ../src/guestfs-actions.pod:6420 ../fish/guestfish-actions.pod:4269
18817 "Verbose messages are disabled unless the environment variable "
18818 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18822 #: ../src/guestfs-actions.pod:6423
18824 "Verbose messages are normally sent to C<stderr>, unless you register a "
18825 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18830 #: ../src/guestfs-actions.pod:6431
18831 msgid "guestfs_setcon"
18836 #: ../src/guestfs-actions.pod:6433
18840 " guestfs_setcon (guestfs_h *g,\n"
18841 " const char *context);\n"
18847 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4280
18849 "This sets the SELinux security context of the daemon to the string "
18855 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4283
18856 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18861 #: ../src/guestfs-actions.pod:6446
18862 msgid "guestfs_setxattr"
18867 #: ../src/guestfs-actions.pod:6448
18871 " guestfs_setxattr (guestfs_h *g,\n"
18872 " const char *xattr,\n"
18873 " const char *val,\n"
18875 " const char *path);\n"
18881 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4289
18883 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18884 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18889 #: ../src/guestfs-actions.pod:6459
18890 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18895 #: ../src/guestfs-actions.pod:6465
18896 msgid "guestfs_sfdisk"
18901 #: ../src/guestfs-actions.pod:6467
18905 " guestfs_sfdisk (guestfs_h *g,\n"
18906 " const char *device,\n"
18910 " char *const *lines);\n"
18916 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4299
18918 "This is a direct interface to the L<sfdisk(8)> program for creating "
18919 "partitions on block devices."
18924 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4302
18925 msgid "C<device> should be a block device, for example C</dev/sda>."
18930 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4304
18932 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18933 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18934 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18935 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18936 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18937 "the kernel) cannot work out the right geometry and you will need to tell it."
18942 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4312
18944 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18945 "refer to the L<sfdisk(8)> manpage."
18950 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4315
18952 "To create a single partition occupying the whole disk, you would pass "
18953 "C<lines> as a single element list, when the single element being the string "
18959 #: ../src/guestfs-actions.pod:6495
18961 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18965 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6533
18966 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4325
18967 #: ../fish/guestfish-actions.pod:4348 ../fish/guestfish-actions.pod:4370
18969 "This function is deprecated. In new code, use the C<part_add> call instead."
18974 #: ../src/guestfs-actions.pod:6512
18975 msgid "guestfs_sfdiskM"
18980 #: ../src/guestfs-actions.pod:6514
18984 " guestfs_sfdiskM (guestfs_h *g,\n"
18985 " const char *device,\n"
18986 " char *const *lines);\n"
18992 #: ../src/guestfs-actions.pod:6519
18994 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18995 "partition sizes are specified in megabytes only (rounded to the nearest "
18996 "cylinder) and you don't need to specify the cyls, heads and sectors "
18997 "parameters which were rarely if ever used anyway."
19002 #: ../src/guestfs-actions.pod:6525
19004 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
19005 "C<guestfs_part_disk>"
19010 #: ../src/guestfs-actions.pod:6542
19011 msgid "guestfs_sfdisk_N"
19016 #: ../src/guestfs-actions.pod:6544
19020 " guestfs_sfdisk_N (guestfs_h *g,\n"
19021 " const char *device,\n"
19026 " const char *line);\n"
19032 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4359
19034 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
19035 "(note: C<n> counts from 1)."
19040 #: ../src/guestfs-actions.pod:6556
19042 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
19043 "for the cyls/heads/sectors parameters."
19048 #: ../src/guestfs-actions.pod:6559
19049 msgid "See also: C<guestfs_part_add>"
19054 #: ../src/guestfs-actions.pod:6575
19055 msgid "guestfs_sfdisk_disk_geometry"
19060 #: ../src/guestfs-actions.pod:6577
19064 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
19065 " const char *device);\n"
19071 #: ../src/guestfs-actions.pod:6581
19073 "This displays the disk geometry of C<device> read from the partition table. "
19074 "Especially in the case where the underlying block device has been resized, "
19075 "this can be different from the kernel's idea of the geometry (see "
19076 "C<guestfs_sfdisk_kernel_geometry>)."
19081 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6602
19082 #: ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:4395
19083 msgid "The result is in human-readable format, and not designed to be parsed."
19088 #: ../src/guestfs-actions.pod:6594
19089 msgid "guestfs_sfdisk_kernel_geometry"
19094 #: ../src/guestfs-actions.pod:6596
19098 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
19099 " const char *device);\n"
19105 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4393
19106 msgid "This displays the kernel's idea of the geometry of C<device>."
19111 #: ../src/guestfs-actions.pod:6610
19112 msgid "guestfs_sfdisk_l"
19117 #: ../src/guestfs-actions.pod:6612
19121 " guestfs_sfdisk_l (guestfs_h *g,\n"
19122 " const char *device);\n"
19128 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4402
19130 "This displays the partition table on C<device>, in the human-readable output "
19131 "of the L<sfdisk(8)> command. It is not intended to be parsed."
19136 #: ../src/guestfs-actions.pod:6620
19137 msgid "See also: C<guestfs_part_list>"
19141 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4408
19143 "This function is deprecated. In new code, use the C<part_list> call instead."
19148 #: ../src/guestfs-actions.pod:6634
19154 #: ../src/guestfs-actions.pod:6636
19158 " guestfs_sh (guestfs_h *g,\n"
19159 " const char *command);\n"
19165 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4419
19167 "This call runs a command from the guest filesystem via the guest's C</bin/"
19173 #: ../src/guestfs-actions.pod:6643
19174 msgid "This is like C<guestfs_command>, but passes the command to:"
19179 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4424
19182 " /bin/sh -c \"command\"\n"
19188 #: ../src/guestfs-actions.pod:6647 ../fish/guestfish-actions.pod:4426
19190 "Depending on the guest's shell, this usually results in wildcards being "
19191 "expanded, shell expressions being interpolated and so on."
19196 #: ../src/guestfs-actions.pod:6651
19197 msgid "All the provisos about C<guestfs_command> apply to this call."
19202 #: ../src/guestfs-actions.pod:6658
19203 msgid "guestfs_sh_lines"
19208 #: ../src/guestfs-actions.pod:6660
19212 " guestfs_sh_lines (guestfs_h *g,\n"
19213 " const char *command);\n"
19219 #: ../src/guestfs-actions.pod:6664
19221 "This is the same as C<guestfs_sh>, but splits the result into a list of "
19227 #: ../src/guestfs-actions.pod:6667
19228 msgid "See also: C<guestfs_command_lines>"
19233 #: ../src/guestfs-actions.pod:6675
19234 msgid "guestfs_sleep"
19239 #: ../src/guestfs-actions.pod:6677
19243 " guestfs_sleep (guestfs_h *g,\n"
19250 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4445
19251 msgid "Sleep for C<secs> seconds."
19256 #: ../src/guestfs-actions.pod:6685
19257 msgid "(Added in 1.0.41)"
19262 #: ../src/guestfs-actions.pod:6687 ../src/guestfs-structs.pod:109
19263 msgid "guestfs_stat"
19268 #: ../src/guestfs-actions.pod:6689
19271 " struct guestfs_stat *\n"
19272 " guestfs_stat (guestfs_h *g,\n"
19273 " const char *path);\n"
19279 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4453
19280 msgid "This is the same as the C<stat(2)> system call."
19285 #: ../src/guestfs-actions.pod:6703 ../src/guestfs-structs.pod:135
19286 msgid "guestfs_statvfs"
19291 #: ../src/guestfs-actions.pod:6705
19294 " struct guestfs_statvfs *\n"
19295 " guestfs_statvfs (guestfs_h *g,\n"
19296 " const char *path);\n"
19302 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4459
19304 "Returns file system statistics for any mounted file system. C<path> should "
19305 "be a file or directory in the mounted file system (typically it is the mount "
19306 "point itself, but it doesn't need to be)."
19311 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4463
19312 msgid "This is the same as the C<statvfs(2)> system call."
19317 #: ../src/guestfs-actions.pod:6715
19319 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
19320 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
19325 #: ../src/guestfs-actions.pod:6721
19326 msgid "guestfs_strings"
19331 #: ../src/guestfs-actions.pod:6723
19335 " guestfs_strings (guestfs_h *g,\n"
19336 " const char *path);\n"
19342 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4469
19344 "This runs the L<strings(1)> command on a file and returns the list of "
19345 "printable strings found."
19350 #: ../src/guestfs-actions.pod:6739
19351 msgid "guestfs_strings_e"
19356 #: ../src/guestfs-actions.pod:6741
19360 " guestfs_strings_e (guestfs_h *g,\n"
19361 " const char *encoding,\n"
19362 " const char *path);\n"
19368 #: ../src/guestfs-actions.pod:6746
19370 "This is like the C<guestfs_strings> command, but allows you to specify the "
19371 "encoding of strings that are looked for in the source file C<path>."
19376 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4483
19377 msgid "Allowed encodings are:"
19382 #: ../src/guestfs-actions.pod:6754 ../fish/guestfish-actions.pod:4487
19388 #: ../src/guestfs-actions.pod:6756
19390 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
19391 "ISO-8859-X (this is what C<guestfs_strings> uses)."
19396 #: ../src/guestfs-actions.pod:6759 ../fish/guestfish-actions.pod:4492
19402 #: ../src/guestfs-actions.pod:6761 ../fish/guestfish-actions.pod:4494
19403 msgid "Single 8-bit-byte characters."
19408 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4496
19414 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4498
19415 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
19420 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4501
19421 msgid "l (lower case letter L)"
19426 #: ../src/guestfs-actions.pod:6770 ../fish/guestfish-actions.pod:4503
19428 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
19429 "examining binaries in Windows guests."
19434 #: ../src/guestfs-actions.pod:6773 ../fish/guestfish-actions.pod:4506
19440 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4508
19441 msgid "32-bit big endian such as UCS-4BE."
19446 #: ../src/guestfs-actions.pod:6777 ../fish/guestfish-actions.pod:4510
19452 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4512
19453 msgid "32-bit little endian such as UCS-4LE."
19458 #: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4516
19459 msgid "The returned strings are transcoded to UTF-8."
19464 #: ../src/guestfs-actions.pod:6794
19465 msgid "guestfs_swapoff_device"
19470 #: ../src/guestfs-actions.pod:6796
19474 " guestfs_swapoff_device (guestfs_h *g,\n"
19475 " const char *device);\n"
19481 #: ../src/guestfs-actions.pod:6800
19483 "This command disables the libguestfs appliance swap device or partition "
19484 "named C<device>. See C<guestfs_swapon_device>."
19489 #: ../src/guestfs-actions.pod:6808
19490 msgid "guestfs_swapoff_file"
19495 #: ../src/guestfs-actions.pod:6810
19499 " guestfs_swapoff_file (guestfs_h *g,\n"
19500 " const char *file);\n"
19506 #: ../src/guestfs-actions.pod:6814 ../fish/guestfish-actions.pod:4533
19507 msgid "This command disables the libguestfs appliance swap on file."
19512 #: ../src/guestfs-actions.pod:6820
19513 msgid "guestfs_swapoff_label"
19518 #: ../src/guestfs-actions.pod:6822
19522 " guestfs_swapoff_label (guestfs_h *g,\n"
19523 " const char *label);\n"
19529 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4539
19531 "This command disables the libguestfs appliance swap on labeled swap "
19537 #: ../src/guestfs-actions.pod:6833
19538 msgid "guestfs_swapoff_uuid"
19543 #: ../src/guestfs-actions.pod:6835
19547 " guestfs_swapoff_uuid (guestfs_h *g,\n"
19548 " const char *uuid);\n"
19554 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4546
19556 "This command disables the libguestfs appliance swap partition with the given "
19562 #: ../src/guestfs-actions.pod:6846
19563 msgid "guestfs_swapon_device"
19568 #: ../src/guestfs-actions.pod:6848
19572 " guestfs_swapon_device (guestfs_h *g,\n"
19573 " const char *device);\n"
19579 #: ../src/guestfs-actions.pod:6852
19581 "This command enables the libguestfs appliance to use the swap device or "
19582 "partition named C<device>. The increased memory is made available for all "
19583 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
19588 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4558
19590 "Note that you should not swap to existing guest swap partitions unless you "
19591 "know what you are doing. They may contain hibernation information, or other "
19592 "information that the guest doesn't want you to trash. You also risk leaking "
19593 "information about the host to the guest this way. Instead, attach a new "
19594 "host device to the guest and swap on that."
19599 #: ../src/guestfs-actions.pod:6868
19600 msgid "guestfs_swapon_file"
19605 #: ../src/guestfs-actions.pod:6870
19609 " guestfs_swapon_file (guestfs_h *g,\n"
19610 " const char *file);\n"
19616 #: ../src/guestfs-actions.pod:6874
19618 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
19624 #: ../src/guestfs-actions.pod:6881
19625 msgid "guestfs_swapon_label"
19630 #: ../src/guestfs-actions.pod:6883
19634 " guestfs_swapon_label (guestfs_h *g,\n"
19635 " const char *label);\n"
19641 #: ../src/guestfs-actions.pod:6887
19643 "This command enables swap to a labeled swap partition. See "
19644 "C<guestfs_swapon_device> for other notes."
19649 #: ../src/guestfs-actions.pod:6894
19650 msgid "guestfs_swapon_uuid"
19655 #: ../src/guestfs-actions.pod:6896
19659 " guestfs_swapon_uuid (guestfs_h *g,\n"
19660 " const char *uuid);\n"
19666 #: ../src/guestfs-actions.pod:6900
19668 "This command enables swap to a swap partition with the given UUID. See "
19669 "C<guestfs_swapon_device> for other notes."
19674 #: ../src/guestfs-actions.pod:6907
19675 msgid "guestfs_sync"
19680 #: ../src/guestfs-actions.pod:6909
19684 " guestfs_sync (guestfs_h *g);\n"
19690 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4590
19692 "This syncs the disk, so that any writes are flushed through to the "
19693 "underlying disk image."
19698 #: ../src/guestfs-actions.pod:6915 ../fish/guestfish-actions.pod:4593
19700 "You should always call this if you have modified a disk image, before "
19701 "closing the handle."
19706 #: ../src/guestfs-actions.pod:6922
19707 msgid "guestfs_tail"
19712 #: ../src/guestfs-actions.pod:6924
19716 " guestfs_tail (guestfs_h *g,\n"
19717 " const char *path);\n"
19723 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4600
19725 "This command returns up to the last 10 lines of a file as a list of strings."
19730 #: ../src/guestfs-actions.pod:6940
19731 msgid "guestfs_tail_n"
19736 #: ../src/guestfs-actions.pod:6942
19740 " guestfs_tail_n (guestfs_h *g,\n"
19742 " const char *path);\n"
19748 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4610
19750 "If the parameter C<nrlines> is a positive number, this returns the last "
19751 "C<nrlines> lines of the file C<path>."
19756 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4613
19758 "If the parameter C<nrlines> is a negative number, this returns lines from "
19759 "the file C<path>, starting with the C<-nrlines>th line."
19764 #: ../src/guestfs-actions.pod:6964
19765 msgid "guestfs_tar_in"
19770 #: ../src/guestfs-actions.pod:6966
19774 " guestfs_tar_in (guestfs_h *g,\n"
19775 " const char *tarfile,\n"
19776 " const char *directory);\n"
19782 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4625
19784 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19785 "tar file) into C<directory>."
19790 #: ../src/guestfs-actions.pod:6974
19792 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19797 #: ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:6996
19798 #: ../src/guestfs-actions.pod:7012 ../src/guestfs-actions.pod:7028
19799 msgid "(Added in 1.0.3)"
19804 #: ../src/guestfs-actions.pod:6981
19805 msgid "guestfs_tar_out"
19810 #: ../src/guestfs-actions.pod:6983
19814 " guestfs_tar_out (guestfs_h *g,\n"
19815 " const char *directory,\n"
19816 " const char *tarfile);\n"
19822 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4637
19824 "This command packs the contents of C<directory> and downloads it to local "
19830 #: ../src/guestfs-actions.pod:6991
19832 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19833 "C<guestfs_txz_out>."
19838 #: ../src/guestfs-actions.pod:6998
19839 msgid "guestfs_tgz_in"
19844 #: ../src/guestfs-actions.pod:7000
19848 " guestfs_tgz_in (guestfs_h *g,\n"
19849 " const char *tarball,\n"
19850 " const char *directory);\n"
19856 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4649
19858 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19859 "tar file) into C<directory>."
19864 #: ../src/guestfs-actions.pod:7008
19865 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19870 #: ../src/guestfs-actions.pod:7014
19871 msgid "guestfs_tgz_out"
19876 #: ../src/guestfs-actions.pod:7016
19880 " guestfs_tgz_out (guestfs_h *g,\n"
19881 " const char *directory,\n"
19882 " const char *tarball);\n"
19888 #: ../src/guestfs-actions.pod:7021 ../fish/guestfish-actions.pod:4660
19890 "This command packs the contents of C<directory> and downloads it to local "
19896 #: ../src/guestfs-actions.pod:7024
19897 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19902 #: ../src/guestfs-actions.pod:7030
19903 msgid "guestfs_touch"
19908 #: ../src/guestfs-actions.pod:7032
19912 " guestfs_touch (guestfs_h *g,\n"
19913 " const char *path);\n"
19919 #: ../src/guestfs-actions.pod:7036 ../fish/guestfish-actions.pod:4671
19921 "Touch acts like the L<touch(1)> command. It can be used to update the "
19922 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19928 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4675
19930 "This command only works on regular files, and will fail on other file types "
19931 "such as directories, symbolic links, block special etc."
19936 #: ../src/guestfs-actions.pod:7047
19937 msgid "guestfs_truncate"
19942 #: ../src/guestfs-actions.pod:7049
19946 " guestfs_truncate (guestfs_h *g,\n"
19947 " const char *path);\n"
19953 #: ../src/guestfs-actions.pod:7053 ../fish/guestfish-actions.pod:4682
19955 "This command truncates C<path> to a zero-length file. The file must exist "
19961 #: ../src/guestfs-actions.pod:7060
19962 msgid "guestfs_truncate_size"
19967 #: ../src/guestfs-actions.pod:7062
19971 " guestfs_truncate_size (guestfs_h *g,\n"
19972 " const char *path,\n"
19973 " int64_t size);\n"
19979 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4689
19981 "This command truncates C<path> to size C<size> bytes. The file must exist "
19987 #: ../src/guestfs-actions.pod:7070
19989 "If the current file size is less than C<size> then the file is extended to "
19990 "the required size with zero bytes. This creates a sparse file (ie. disk "
19991 "blocks are not allocated for the file until you write to it). To create a "
19992 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19997 #: ../src/guestfs-actions.pod:7080
19998 msgid "guestfs_tune2fs_l"
20003 #: ../src/guestfs-actions.pod:7082
20007 " guestfs_tune2fs_l (guestfs_h *g,\n"
20008 " const char *device);\n"
20014 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4702
20016 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
20022 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4705
20024 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
20025 "for more details. The list of fields returned isn't clearly defined, and "
20026 "depends on both the version of C<tune2fs> that libguestfs was built against, "
20027 "and the filesystem itself."
20032 #: ../src/guestfs-actions.pod:7102
20033 msgid "guestfs_txz_in"
20038 #: ../src/guestfs-actions.pod:7104
20042 " guestfs_txz_in (guestfs_h *g,\n"
20043 " const char *tarball,\n"
20044 " const char *directory);\n"
20050 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4714
20052 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
20053 "tar file) into C<directory>."
20058 #: ../src/guestfs-actions.pod:7116
20059 msgid "guestfs_txz_out"
20064 #: ../src/guestfs-actions.pod:7118
20068 " guestfs_txz_out (guestfs_h *g,\n"
20069 " const char *directory,\n"
20070 " const char *tarball);\n"
20076 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4723
20078 "This command packs the contents of C<directory> and downloads it to local "
20079 "file C<tarball> (as an xz compressed tar archive)."
20084 #: ../src/guestfs-actions.pod:7130
20085 msgid "guestfs_umask"
20090 #: ../src/guestfs-actions.pod:7132
20094 " guestfs_umask (guestfs_h *g,\n"
20101 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4732
20103 "This function sets the mask used for creating new files and device nodes to "
20109 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4735
20111 "Typical umask values would be C<022> which creates new files with "
20112 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
20113 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
20118 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4740
20120 "The default umask is C<022>. This is important because it means that "
20121 "directories and device nodes will be created with C<0644> or C<0755> mode "
20122 "even if you specify C<0777>."
20127 #: ../src/guestfs-actions.pod:7148
20129 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
20130 "C<guestfs_mkdir>."
20135 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4747
20136 msgid "This call returns the previous umask."
20141 #: ../src/guestfs-actions.pod:7157
20142 msgid "guestfs_umount"
20147 #: ../src/guestfs-actions.pod:7159
20151 " guestfs_umount (guestfs_h *g,\n"
20152 " const char *pathordevice);\n"
20158 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4755
20160 "This unmounts the given filesystem. The filesystem may be specified either "
20161 "by its mountpoint (path) or the device which contains the filesystem."
20166 #: ../src/guestfs-actions.pod:7171
20167 msgid "guestfs_umount_all"
20172 #: ../src/guestfs-actions.pod:7173
20176 " guestfs_umount_all (guestfs_h *g);\n"
20182 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4765
20183 msgid "This unmounts all mounted filesystems."
20188 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4767
20189 msgid "Some internal mounts are not unmounted by this call."
20194 #: ../src/guestfs-actions.pod:7184
20195 msgid "guestfs_upload"
20200 #: ../src/guestfs-actions.pod:7186
20204 " guestfs_upload (guestfs_h *g,\n"
20205 " const char *filename,\n"
20206 " const char *remotefilename);\n"
20212 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7215
20213 #: ../fish/guestfish-actions.pod:4773 ../fish/guestfish-actions.pod:4786
20214 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
20219 #: ../src/guestfs-actions.pod:7196
20220 msgid "See also C<guestfs_download>."
20225 #: ../src/guestfs-actions.pod:7207
20226 msgid "guestfs_upload_offset"
20231 #: ../src/guestfs-actions.pod:7209
20235 " guestfs_upload_offset (guestfs_h *g,\n"
20236 " const char *filename,\n"
20237 " const char *remotefilename,\n"
20238 " int64_t offset);\n"
20244 #: ../src/guestfs-actions.pod:7218 ../fish/guestfish-actions.pod:4789
20246 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
20247 "The intention is to overwrite parts of existing files or devices, although "
20248 "if a non-existant file is specified then it is created with a \"hole\" "
20249 "before C<offset>. The size of the data written is implicit in the size of "
20250 "the source C<filename>."
20255 #: ../src/guestfs-actions.pod:7225
20257 "Note that there is no limit on the amount of data that can be uploaded with "
20258 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
20259 "full amount unless an error occurs."
20264 #: ../src/guestfs-actions.pod:7230
20265 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
20270 #: ../src/guestfs-actions.pod:7241
20271 msgid "guestfs_utimens"
20276 #: ../src/guestfs-actions.pod:7243
20280 " guestfs_utimens (guestfs_h *g,\n"
20281 " const char *path,\n"
20282 " int64_t atsecs,\n"
20283 " int64_t atnsecs,\n"
20284 " int64_t mtsecs,\n"
20285 " int64_t mtnsecs);\n"
20291 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4809
20292 msgid "This command sets the timestamps of a file with nanosecond precision."
20297 #: ../src/guestfs-actions.pod:7254 ../fish/guestfish-actions.pod:4812
20299 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
20305 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4815
20307 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
20308 "nanoseconds from the epoch."
20313 #: ../src/guestfs-actions.pod:7260 ../fish/guestfish-actions.pod:4818
20315 "If the C<*nsecs> field contains the special value C<-1> then the "
20316 "corresponding timestamp is set to the current time. (The C<*secs> field is "
20317 "ignored in this case)."
20322 #: ../src/guestfs-actions.pod:7264 ../fish/guestfish-actions.pod:4822
20324 "If the C<*nsecs> field contains the special value C<-2> then the "
20325 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
20331 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-structs.pod:175
20332 msgid "guestfs_version"
20337 #: ../src/guestfs-actions.pod:7274
20340 " struct guestfs_version *\n"
20341 " guestfs_version (guestfs_h *g);\n"
20347 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4830
20349 "Return the libguestfs version number that the program is linked against."
20354 #: ../src/guestfs-actions.pod:7280 ../fish/guestfish-actions.pod:4833
20356 "Note that because of dynamic linking this is not necessarily the version of "
20357 "libguestfs that you compiled against. You can compile the program, and then "
20358 "at runtime dynamically link against a completely different C<libguestfs.so> "
20364 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4838
20366 "This call was added in version C<1.0.58>. In previous versions of "
20367 "libguestfs there was no way to get the version number. From C code you can "
20368 "use dynamic linker functions to find out if this symbol exists (if it "
20369 "doesn't, then it's an earlier version)."
20374 #: ../src/guestfs-actions.pod:7291 ../fish/guestfish-actions.pod:4844
20376 "The call returns a structure with four elements. The first three (C<major>, "
20377 "C<minor> and C<release>) are numbers and correspond to the usual version "
20378 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
20379 "but may be used for distro-specific information."
20384 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4850
20386 "To construct the original version string: C<$major.$minor.$release$extra>"
20391 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4853
20392 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
20397 #: ../src/guestfs-actions.pod:7302
20399 "I<Note:> Don't use this call to test for availability of features. In "
20400 "enterprise distributions we backport features from later versions into "
20401 "earlier versions, making this an unreliable way to test for features. Use "
20402 "C<guestfs_available> instead."
20407 #: ../src/guestfs-actions.pod:7308
20409 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
20410 "error. I<The caller must call C<guestfs_free_version> after use>."
20415 #: ../src/guestfs-actions.pod:7312
20416 msgid "(Added in 1.0.58)"
20421 #: ../src/guestfs-actions.pod:7314
20422 msgid "guestfs_vfs_label"
20427 #: ../src/guestfs-actions.pod:7316
20431 " guestfs_vfs_label (guestfs_h *g,\n"
20432 " const char *device);\n"
20438 #: ../src/guestfs-actions.pod:7320 ../fish/guestfish-actions.pod:4865
20439 msgid "This returns the filesystem label of the filesystem on C<device>."
20444 #: ../src/guestfs-actions.pod:7323 ../fish/guestfish-actions.pod:4868
20445 msgid "If the filesystem is unlabeled, this returns the empty string."
20450 #: ../src/guestfs-actions.pod:7325
20451 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
20456 #: ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7367
20457 msgid "(Added in 1.3.18)"
20462 #: ../src/guestfs-actions.pod:7332
20463 msgid "guestfs_vfs_type"
20468 #: ../src/guestfs-actions.pod:7334
20472 " guestfs_vfs_type (guestfs_h *g,\n"
20473 " const char *device);\n"
20479 #: ../src/guestfs-actions.pod:7338 ../fish/guestfish-actions.pod:4876
20481 "This command gets the filesystem type corresponding to the filesystem on "
20487 #: ../src/guestfs-actions.pod:7341 ../fish/guestfish-actions.pod:4879
20489 "For most filesystems, the result is the name of the Linux VFS module which "
20490 "would be used to mount this filesystem if you mounted it without specifying "
20491 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
20496 #: ../src/guestfs-actions.pod:7351
20497 msgid "guestfs_vfs_uuid"
20502 #: ../src/guestfs-actions.pod:7353
20506 " guestfs_vfs_uuid (guestfs_h *g,\n"
20507 " const char *device);\n"
20513 #: ../src/guestfs-actions.pod:7357 ../fish/guestfish-actions.pod:4888
20514 msgid "This returns the filesystem UUID of the filesystem on C<device>."
20519 #: ../src/guestfs-actions.pod:7360 ../fish/guestfish-actions.pod:4891
20520 msgid "If the filesystem does not have a UUID, this returns the empty string."
20525 #: ../src/guestfs-actions.pod:7362
20526 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
20531 #: ../src/guestfs-actions.pod:7369
20532 msgid "guestfs_vg_activate"
20537 #: ../src/guestfs-actions.pod:7371
20541 " guestfs_vg_activate (guestfs_h *g,\n"
20543 " char *const *volgroups);\n"
20548 #: ../src/guestfs-actions.pod:7376 ../fish/guestfish-actions.pod:4899
20550 "This command activates or (if C<activate> is false) deactivates all logical "
20551 "volumes in the listed volume groups C<volgroups>."
20556 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4902
20557 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
20562 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4904
20564 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
20565 "activated or deactivated."
20570 #: ../src/guestfs-actions.pod:7388
20571 msgid "guestfs_vg_activate_all"
20576 #: ../src/guestfs-actions.pod:7390
20580 " guestfs_vg_activate_all (guestfs_h *g,\n"
20581 " int activate);\n"
20586 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4911
20588 "This command activates or (if C<activate> is false) deactivates all logical "
20589 "volumes in all volume groups."
20594 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4914
20595 msgid "This command is the same as running C<vgchange -a y|n>"
20600 #: ../src/guestfs-actions.pod:7403
20601 msgid "guestfs_vgcreate"
20606 #: ../src/guestfs-actions.pod:7405
20610 " guestfs_vgcreate (guestfs_h *g,\n"
20611 " const char *volgroup,\n"
20612 " char *const *physvols);\n"
20618 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4920
20620 "This creates an LVM volume group called C<volgroup> from the non-empty list "
20621 "of physical volumes C<physvols>."
20626 #: ../src/guestfs-actions.pod:7417
20627 msgid "guestfs_vglvuuids"
20632 #: ../src/guestfs-actions.pod:7419
20636 " guestfs_vglvuuids (guestfs_h *g,\n"
20637 " const char *vgname);\n"
20643 #: ../src/guestfs-actions.pod:7423 ../fish/guestfish-actions.pod:4927
20645 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20646 "volumes created in this volume group."
20651 #: ../src/guestfs-actions.pod:7426
20653 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20654 "associate logical volumes and volume groups."
20659 #: ../src/guestfs-actions.pod:7429
20660 msgid "See also C<guestfs_vgpvuuids>."
20665 #: ../src/guestfs-actions.pod:7437
20666 msgid "guestfs_vgpvuuids"
20671 #: ../src/guestfs-actions.pod:7439
20675 " guestfs_vgpvuuids (guestfs_h *g,\n"
20676 " const char *vgname);\n"
20682 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4939
20684 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20685 "volumes that this volume group resides on."
20690 #: ../src/guestfs-actions.pod:7446
20692 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20693 "associate physical volumes and volume groups."
20698 #: ../src/guestfs-actions.pod:7449
20699 msgid "See also C<guestfs_vglvuuids>."
20704 #: ../src/guestfs-actions.pod:7457
20705 msgid "guestfs_vgremove"
20710 #: ../src/guestfs-actions.pod:7459
20714 " guestfs_vgremove (guestfs_h *g,\n"
20715 " const char *vgname);\n"
20721 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4951
20722 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20727 #: ../src/guestfs-actions.pod:7465 ../fish/guestfish-actions.pod:4953
20729 "This also forcibly removes all logical volumes in the volume group (if any)."
20734 #: ../src/guestfs-actions.pod:7472
20735 msgid "guestfs_vgrename"
20740 #: ../src/guestfs-actions.pod:7474
20744 " guestfs_vgrename (guestfs_h *g,\n"
20745 " const char *volgroup,\n"
20746 " const char *newvolgroup);\n"
20752 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4960
20753 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20758 #: ../src/guestfs-actions.pod:7485
20759 msgid "guestfs_vgs"
20764 #: ../src/guestfs-actions.pod:7487
20768 " guestfs_vgs (guestfs_h *g);\n"
20774 #: ../src/guestfs-actions.pod:7490 ../fish/guestfish-actions.pod:4966
20776 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20782 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4969
20784 "This returns a list of just the volume group names that were detected (eg. "
20790 #: ../src/guestfs-actions.pod:7496
20791 msgid "See also C<guestfs_vgs_full>."
20796 #: ../src/guestfs-actions.pod:7504
20797 msgid "guestfs_vgs_full"
20802 #: ../src/guestfs-actions.pod:7506
20805 " struct guestfs_lvm_vg_list *\n"
20806 " guestfs_vgs_full (guestfs_h *g);\n"
20812 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:4978
20814 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20815 "> command. The \"full\" version includes all fields."
20820 #: ../src/guestfs-actions.pod:7512
20822 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20823 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20828 #: ../src/guestfs-actions.pod:7518
20829 msgid "guestfs_vgscan"
20834 #: ../src/guestfs-actions.pod:7520
20838 " guestfs_vgscan (guestfs_h *g);\n"
20844 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:4985
20846 "This rescans all block devices and rebuilds the list of LVM physical "
20847 "volumes, volume groups and logical volumes."
20852 #: ../src/guestfs-actions.pod:7530
20853 msgid "guestfs_vguuid"
20858 #: ../src/guestfs-actions.pod:7532
20862 " guestfs_vguuid (guestfs_h *g,\n"
20863 " const char *vgname);\n"
20869 #: ../src/guestfs-actions.pod:7536 ../fish/guestfish-actions.pod:4992
20870 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20875 #: ../src/guestfs-actions.pod:7543
20876 msgid "guestfs_wait_ready"
20881 #: ../src/guestfs-actions.pod:7545
20885 " guestfs_wait_ready (guestfs_h *g);\n"
20891 #: ../src/guestfs-actions.pod:7548
20892 msgid "This function is a no op."
20897 #: ../src/guestfs-actions.pod:7550
20899 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20900 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20901 "is no longer necessary because C<guestfs_launch> now does the waiting."
20906 #: ../src/guestfs-actions.pod:7555
20908 "If you see any calls to this function in code then you can just remove them, "
20909 "unless you want to retain compatibility with older versions of the API."
20913 #: ../src/guestfs-actions.pod:7561
20915 "This function is deprecated. In new code, use the C<launch> call instead."
20920 #: ../src/guestfs-actions.pod:7570
20921 msgid "guestfs_wc_c"
20926 #: ../src/guestfs-actions.pod:7572
20930 " guestfs_wc_c (guestfs_h *g,\n"
20931 " const char *path);\n"
20937 #: ../src/guestfs-actions.pod:7576 ../fish/guestfish-actions.pod:4998
20939 "This command counts the characters in a file, using the C<wc -c> external "
20945 #: ../src/guestfs-actions.pod:7583
20946 msgid "guestfs_wc_l"
20951 #: ../src/guestfs-actions.pod:7585
20955 " guestfs_wc_l (guestfs_h *g,\n"
20956 " const char *path);\n"
20962 #: ../src/guestfs-actions.pod:7589 ../fish/guestfish-actions.pod:5005
20964 "This command counts the lines in a file, using the C<wc -l> external command."
20969 #: ../src/guestfs-actions.pod:7596
20970 msgid "guestfs_wc_w"
20975 #: ../src/guestfs-actions.pod:7598
20979 " guestfs_wc_w (guestfs_h *g,\n"
20980 " const char *path);\n"
20986 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5012
20988 "This command counts the words in a file, using the C<wc -w> external command."
20993 #: ../src/guestfs-actions.pod:7609
20994 msgid "guestfs_write"
20999 #: ../src/guestfs-actions.pod:7611
21003 " guestfs_write (guestfs_h *g,\n"
21004 " const char *path,\n"
21005 " const char *content,\n"
21006 " size_t content_size);\n"
21012 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5019
21014 "This call creates a file called C<path>. The content of the file is the "
21015 "string C<content> (which can contain any 8 bit data)."
21020 #: ../src/guestfs-actions.pod:7627
21021 msgid "guestfs_write_file"
21026 #: ../src/guestfs-actions.pod:7629
21030 " guestfs_write_file (guestfs_h *g,\n"
21031 " const char *path,\n"
21032 " const char *content,\n"
21039 #: ../src/guestfs-actions.pod:7635 ../fish/guestfish-actions.pod:5029
21041 "This call creates a file called C<path>. The contents of the file is the "
21042 "string C<content> (which can contain any 8 bit data), with length C<size>."
21047 #: ../src/guestfs-actions.pod:7639 ../fish/guestfish-actions.pod:5033
21049 "As a special case, if C<size> is C<0> then the length is calculated using "
21050 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
21055 #: ../src/guestfs-actions.pod:7643 ../fish/guestfish-actions.pod:5037
21057 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
21058 "I<not> work, even if the length is specified."
21063 #: ../src/guestfs-actions.pod:7651 ../fish/guestfish-actions.pod:5043
21065 "This function is deprecated. In new code, use the C<write> call instead."
21070 #: ../src/guestfs-actions.pod:7660
21071 msgid "guestfs_zegrep"
21076 #: ../src/guestfs-actions.pod:7662
21080 " guestfs_zegrep (guestfs_h *g,\n"
21081 " const char *regex,\n"
21082 " const char *path);\n"
21088 #: ../src/guestfs-actions.pod:7667 ../fish/guestfish-actions.pod:5054
21090 "This calls the external C<zegrep> program and returns the matching lines."
21095 #: ../src/guestfs-actions.pod:7679
21096 msgid "guestfs_zegrepi"
21101 #: ../src/guestfs-actions.pod:7681
21105 " guestfs_zegrepi (guestfs_h *g,\n"
21106 " const char *regex,\n"
21107 " const char *path);\n"
21113 #: ../src/guestfs-actions.pod:7686 ../fish/guestfish-actions.pod:5064
21115 "This calls the external C<zegrep -i> program and returns the matching lines."
21120 #: ../src/guestfs-actions.pod:7698
21121 msgid "guestfs_zero"
21126 #: ../src/guestfs-actions.pod:7700
21130 " guestfs_zero (guestfs_h *g,\n"
21131 " const char *device);\n"
21137 #: ../src/guestfs-actions.pod:7704 ../fish/guestfish-actions.pod:5074
21138 msgid "This command writes zeroes over the first few blocks of C<device>."
21143 #: ../src/guestfs-actions.pod:7706 ../fish/guestfish-actions.pod:5076
21145 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
21146 "securely wipe the device). It should be sufficient to remove any partition "
21147 "tables, filesystem superblocks and so on."
21151 #: ../src/guestfs-actions.pod:7710
21153 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
21154 "C<guestfs_is_zero_device>"
21159 #: ../src/guestfs-actions.pod:7722
21160 msgid "guestfs_zero_device"
21165 #: ../src/guestfs-actions.pod:7724
21169 " guestfs_zero_device (guestfs_h *g,\n"
21170 " const char *device);\n"
21176 #: ../src/guestfs-actions.pod:7728
21178 "This command writes zeroes over the entire C<device>. Compare with "
21179 "C<guestfs_zero> which just zeroes the first few blocks of a device."
21184 #: ../src/guestfs-actions.pod:7742
21185 msgid "(Added in 1.3.1)"
21190 #: ../src/guestfs-actions.pod:7744
21191 msgid "guestfs_zerofree"
21196 #: ../src/guestfs-actions.pod:7746
21200 " guestfs_zerofree (guestfs_h *g,\n"
21201 " const char *device);\n"
21207 #: ../src/guestfs-actions.pod:7750 ../fish/guestfish-actions.pod:5098
21209 "This runs the I<zerofree> program on C<device>. This program claims to zero "
21210 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
21211 "possible to compress the filesystem more effectively."
21216 #: ../src/guestfs-actions.pod:7755 ../fish/guestfish-actions.pod:5103
21217 msgid "You should B<not> run this program if the filesystem is mounted."
21222 #: ../src/guestfs-actions.pod:7758 ../fish/guestfish-actions.pod:5106
21224 "It is possible that using this program can damage the filesystem or data on "
21230 #: ../src/guestfs-actions.pod:7765
21231 msgid "guestfs_zfgrep"
21236 #: ../src/guestfs-actions.pod:7767
21240 " guestfs_zfgrep (guestfs_h *g,\n"
21241 " const char *pattern,\n"
21242 " const char *path);\n"
21248 #: ../src/guestfs-actions.pod:7772 ../fish/guestfish-actions.pod:5113
21250 "This calls the external C<zfgrep> program and returns the matching lines."
21255 #: ../src/guestfs-actions.pod:7784
21256 msgid "guestfs_zfgrepi"
21261 #: ../src/guestfs-actions.pod:7786
21265 " guestfs_zfgrepi (guestfs_h *g,\n"
21266 " const char *pattern,\n"
21267 " const char *path);\n"
21273 #: ../src/guestfs-actions.pod:7791 ../fish/guestfish-actions.pod:5123
21275 "This calls the external C<zfgrep -i> program and returns the matching lines."
21280 #: ../src/guestfs-actions.pod:7803
21281 msgid "guestfs_zfile"
21286 #: ../src/guestfs-actions.pod:7805
21290 " guestfs_zfile (guestfs_h *g,\n"
21291 " const char *meth,\n"
21292 " const char *path);\n"
21298 #: ../src/guestfs-actions.pod:7810 ../fish/guestfish-actions.pod:5133
21300 "This command runs C<file> after first decompressing C<path> using C<method>."
21305 #: ../src/guestfs-actions.pod:7813 ../fish/guestfish-actions.pod:5136
21306 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
21311 #: ../src/guestfs-actions.pod:7815
21313 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
21319 #: ../src/guestfs-actions.pod:7821 ../fish/guestfish-actions.pod:5141
21321 "This function is deprecated. In new code, use the C<file> call instead."
21326 #: ../src/guestfs-actions.pod:7830
21327 msgid "guestfs_zgrep"
21332 #: ../src/guestfs-actions.pod:7832
21336 " guestfs_zgrep (guestfs_h *g,\n"
21337 " const char *regex,\n"
21338 " const char *path);\n"
21344 #: ../src/guestfs-actions.pod:7837 ../fish/guestfish-actions.pod:5152
21346 "This calls the external C<zgrep> program and returns the matching lines."
21351 #: ../src/guestfs-actions.pod:7849
21352 msgid "guestfs_zgrepi"
21357 #: ../src/guestfs-actions.pod:7851
21361 " guestfs_zgrepi (guestfs_h *g,\n"
21362 " const char *regex,\n"
21363 " const char *path);\n"
21369 #: ../src/guestfs-actions.pod:7856 ../fish/guestfish-actions.pod:5162
21371 "This calls the external C<zgrep -i> program and returns the matching lines."
21376 #: ../src/guestfs-availability.pod:3
21382 #: ../src/guestfs-availability.pod:5
21384 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
21385 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
21386 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
21387 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
21388 "L</guestfs_aug_save> L</guestfs_aug_set>"
21392 #: ../src/guestfs-availability.pod:21
21397 #: ../src/guestfs-availability.pod:23
21398 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
21403 #: ../src/guestfs-availability.pod:26
21409 #: ../src/guestfs-availability.pod:28
21411 "The following functions: L</guestfs_inotify_add_watch> L</"
21412 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
21413 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
21418 #: ../src/guestfs-availability.pod:36
21419 msgid "B<linuxfsuuid>"
21424 #: ../src/guestfs-availability.pod:38
21426 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
21427 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
21432 #: ../src/guestfs-availability.pod:45
21433 msgid "B<linuxmodules>"
21438 #: ../src/guestfs-availability.pod:47
21439 msgid "The following functions: L</guestfs_modprobe>"
21444 #: ../src/guestfs-availability.pod:50
21445 msgid "B<linuxxattrs>"
21450 #: ../src/guestfs-availability.pod:52
21452 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
21453 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
21454 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
21455 "guestfs_setxattr>"
21460 #: ../src/guestfs-availability.pod:63
21466 #: ../src/guestfs-availability.pod:65
21468 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
21469 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
21470 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
21475 #: ../src/guestfs-availability.pod:74
21481 #: ../src/guestfs-availability.pod:76
21483 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
21484 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
21485 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
21486 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
21487 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
21488 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
21489 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
21494 #: ../src/guestfs-availability.pod:99
21500 #: ../src/guestfs-availability.pod:101
21502 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
21503 "guestfs_mknod_b> L</guestfs_mknod_c>"
21508 #: ../src/guestfs-availability.pod:107
21514 #: ../src/guestfs-availability.pod:109
21515 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
21520 #: ../src/guestfs-availability.pod:112
21521 msgid "B<ntfsprogs>"
21525 #: ../src/guestfs-availability.pod:114
21527 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
21528 "L</guestfs_ntfsresize_size>"
21533 #: ../src/guestfs-availability.pod:119
21534 msgid "B<realpath>"
21539 #: ../src/guestfs-availability.pod:121
21540 msgid "The following functions: L</guestfs_realpath>"
21545 #: ../src/guestfs-availability.pod:124
21551 #: ../src/guestfs-availability.pod:126
21553 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
21554 "guestfs_scrub_freespace>"
21559 #: ../src/guestfs-availability.pod:131
21565 #: ../src/guestfs-availability.pod:133
21566 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
21571 #: ../src/guestfs-availability.pod:137
21577 #: ../src/guestfs-availability.pod:139
21578 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
21583 #: ../src/guestfs-availability.pod:143
21584 msgid "B<zerofree>"
21589 #: ../src/guestfs-availability.pod:145
21590 msgid "The following functions: L</guestfs_zerofree>"
21595 #: ../src/guestfs-structs.pod:1
21596 msgid "guestfs_int_bool"
21601 #: ../src/guestfs-structs.pod:3
21604 " struct guestfs_int_bool {\n"
21613 #: ../src/guestfs-structs.pod:8
21616 " struct guestfs_int_bool_list {\n"
21617 " uint32_t len; /* Number of elements in list. */\n"
21618 " struct guestfs_int_bool *val; /* Elements. */\n"
21625 #: ../src/guestfs-structs.pod:13
21628 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
21629 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
21635 #: ../src/guestfs-structs.pod:16
21636 msgid "guestfs_lvm_pv"
21641 #: ../src/guestfs-structs.pod:18
21644 " struct guestfs_lvm_pv {\n"
21645 " char *pv_name;\n"
21646 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21647 " char pv_uuid[32];\n"
21649 " uint64_t pv_size;\n"
21650 " uint64_t dev_size;\n"
21651 " uint64_t pv_free;\n"
21652 " uint64_t pv_used;\n"
21653 " char *pv_attr;\n"
21654 " int64_t pv_pe_count;\n"
21655 " int64_t pv_pe_alloc_count;\n"
21656 " char *pv_tags;\n"
21657 " uint64_t pe_start;\n"
21658 " int64_t pv_mda_count;\n"
21659 " uint64_t pv_mda_free;\n"
21666 #: ../src/guestfs-structs.pod:36
21669 " struct guestfs_lvm_pv_list {\n"
21670 " uint32_t len; /* Number of elements in list. */\n"
21671 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21678 #: ../src/guestfs-structs.pod:41
21681 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21682 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21688 #: ../src/guestfs-structs.pod:44
21689 msgid "guestfs_lvm_vg"
21694 #: ../src/guestfs-structs.pod:46
21697 " struct guestfs_lvm_vg {\n"
21698 " char *vg_name;\n"
21699 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21700 " char vg_uuid[32];\n"
21702 " char *vg_attr;\n"
21703 " uint64_t vg_size;\n"
21704 " uint64_t vg_free;\n"
21705 " char *vg_sysid;\n"
21706 " uint64_t vg_extent_size;\n"
21707 " int64_t vg_extent_count;\n"
21708 " int64_t vg_free_count;\n"
21709 " int64_t max_lv;\n"
21710 " int64_t max_pv;\n"
21711 " int64_t pv_count;\n"
21712 " int64_t lv_count;\n"
21713 " int64_t snap_count;\n"
21714 " int64_t vg_seqno;\n"
21715 " char *vg_tags;\n"
21716 " int64_t vg_mda_count;\n"
21717 " uint64_t vg_mda_free;\n"
21724 #: ../src/guestfs-structs.pod:69
21727 " struct guestfs_lvm_vg_list {\n"
21728 " uint32_t len; /* Number of elements in list. */\n"
21729 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21736 #: ../src/guestfs-structs.pod:74
21739 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21740 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21746 #: ../src/guestfs-structs.pod:77
21747 msgid "guestfs_lvm_lv"
21752 #: ../src/guestfs-structs.pod:79
21755 " struct guestfs_lvm_lv {\n"
21756 " char *lv_name;\n"
21757 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21758 " char lv_uuid[32];\n"
21759 " char *lv_attr;\n"
21760 " int64_t lv_major;\n"
21761 " int64_t lv_minor;\n"
21762 " int64_t lv_kernel_major;\n"
21763 " int64_t lv_kernel_minor;\n"
21764 " uint64_t lv_size;\n"
21765 " int64_t seg_count;\n"
21767 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21768 " float snap_percent;\n"
21769 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21770 " float copy_percent;\n"
21771 " char *move_pv;\n"
21772 " char *lv_tags;\n"
21773 " char *mirror_log;\n"
21774 " char *modules;\n"
21781 #: ../src/guestfs-structs.pod:101
21784 " struct guestfs_lvm_lv_list {\n"
21785 " uint32_t len; /* Number of elements in list. */\n"
21786 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21793 #: ../src/guestfs-structs.pod:106
21796 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21797 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21803 #: ../src/guestfs-structs.pod:111
21806 " struct guestfs_stat {\n"
21810 " int64_t nlink;\n"
21815 " int64_t blksize;\n"
21816 " int64_t blocks;\n"
21817 " int64_t atime;\n"
21818 " int64_t mtime;\n"
21819 " int64_t ctime;\n"
21826 #: ../src/guestfs-structs.pod:127
21829 " struct guestfs_stat_list {\n"
21830 " uint32_t len; /* Number of elements in list. */\n"
21831 " struct guestfs_stat *val; /* Elements. */\n"
21838 #: ../src/guestfs-structs.pod:132
21841 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21842 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21848 #: ../src/guestfs-structs.pod:137
21851 " struct guestfs_statvfs {\n"
21852 " int64_t bsize;\n"
21853 " int64_t frsize;\n"
21854 " int64_t blocks;\n"
21855 " int64_t bfree;\n"
21856 " int64_t bavail;\n"
21857 " int64_t files;\n"
21858 " int64_t ffree;\n"
21859 " int64_t favail;\n"
21862 " int64_t namemax;\n"
21869 #: ../src/guestfs-structs.pod:151
21872 " struct guestfs_statvfs_list {\n"
21873 " uint32_t len; /* Number of elements in list. */\n"
21874 " struct guestfs_statvfs *val; /* Elements. */\n"
21881 #: ../src/guestfs-structs.pod:156
21884 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21885 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21891 #: ../src/guestfs-structs.pod:159
21892 msgid "guestfs_dirent"
21897 #: ../src/guestfs-structs.pod:161
21900 " struct guestfs_dirent {\n"
21910 #: ../src/guestfs-structs.pod:167
21913 " struct guestfs_dirent_list {\n"
21914 " uint32_t len; /* Number of elements in list. */\n"
21915 " struct guestfs_dirent *val; /* Elements. */\n"
21922 #: ../src/guestfs-structs.pod:172
21925 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21926 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21932 #: ../src/guestfs-structs.pod:177
21935 " struct guestfs_version {\n"
21936 " int64_t major;\n"
21937 " int64_t minor;\n"
21938 " int64_t release;\n"
21946 #: ../src/guestfs-structs.pod:184
21949 " struct guestfs_version_list {\n"
21950 " uint32_t len; /* Number of elements in list. */\n"
21951 " struct guestfs_version *val; /* Elements. */\n"
21958 #: ../src/guestfs-structs.pod:189
21961 " void guestfs_free_version (struct guestfs_free_version *);\n"
21962 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21968 #: ../src/guestfs-structs.pod:192
21969 msgid "guestfs_xattr"
21974 #: ../src/guestfs-structs.pod:194
21977 " struct guestfs_xattr {\n"
21978 " char *attrname;\n"
21979 " /* The next two fields describe a byte array. */\n"
21980 " uint32_t attrval_len;\n"
21981 " char *attrval;\n"
21988 #: ../src/guestfs-structs.pod:201
21991 " struct guestfs_xattr_list {\n"
21992 " uint32_t len; /* Number of elements in list. */\n"
21993 " struct guestfs_xattr *val; /* Elements. */\n"
22000 #: ../src/guestfs-structs.pod:206
22003 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
22004 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
22010 #: ../src/guestfs-structs.pod:209
22011 msgid "guestfs_inotify_event"
22016 #: ../src/guestfs-structs.pod:211
22019 " struct guestfs_inotify_event {\n"
22020 " int64_t in_wd;\n"
22021 " uint32_t in_mask;\n"
22022 " uint32_t in_cookie;\n"
22023 " char *in_name;\n"
22030 #: ../src/guestfs-structs.pod:218
22033 " struct guestfs_inotify_event_list {\n"
22034 " uint32_t len; /* Number of elements in list. */\n"
22035 " struct guestfs_inotify_event *val; /* Elements. */\n"
22042 #: ../src/guestfs-structs.pod:223
22045 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
22046 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
22052 #: ../src/guestfs-structs.pod:226
22053 msgid "guestfs_partition"
22058 #: ../src/guestfs-structs.pod:228
22061 " struct guestfs_partition {\n"
22062 " int32_t part_num;\n"
22063 " uint64_t part_start;\n"
22064 " uint64_t part_end;\n"
22065 " uint64_t part_size;\n"
22072 #: ../src/guestfs-structs.pod:235
22075 " struct guestfs_partition_list {\n"
22076 " uint32_t len; /* Number of elements in list. */\n"
22077 " struct guestfs_partition *val; /* Elements. */\n"
22084 #: ../src/guestfs-structs.pod:240
22087 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
22088 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
22094 #: ../src/guestfs-structs.pod:243
22095 msgid "guestfs_application"
22100 #: ../src/guestfs-structs.pod:245
22103 " struct guestfs_application {\n"
22104 " char *app_name;\n"
22105 " char *app_display_name;\n"
22106 " int32_t app_epoch;\n"
22107 " char *app_version;\n"
22108 " char *app_release;\n"
22109 " char *app_install_path;\n"
22110 " char *app_trans_path;\n"
22111 " char *app_publisher;\n"
22112 " char *app_url;\n"
22113 " char *app_source_package;\n"
22114 " char *app_summary;\n"
22115 " char *app_description;\n"
22122 #: ../src/guestfs-structs.pod:260
22125 " struct guestfs_application_list {\n"
22126 " uint32_t len; /* Number of elements in list. */\n"
22127 " struct guestfs_application *val; /* Elements. */\n"
22134 #: ../src/guestfs-structs.pod:265
22137 " void guestfs_free_application (struct guestfs_free_application *);\n"
22138 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
22144 #: ../fish/guestfish.pod:5
22145 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
22150 #: ../fish/guestfish.pod:9
22153 " guestfish [--options] [commands]\n"
22159 #: ../fish/guestfish.pod:11
22168 #: ../fish/guestfish.pod:13
22171 " guestfish [--ro|--rw] -a disk.img\n"
22177 #: ../fish/guestfish.pod:15
22180 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
22186 #: ../fish/guestfish.pod:17
22189 " guestfish -d libvirt-domain\n"
22195 #: ../fish/guestfish.pod:19
22198 " guestfish [--ro|--rw] -a disk.img -i\n"
22204 #: ../fish/guestfish.pod:21
22207 " guestfish -d libvirt-domain -i\n"
22213 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
22214 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
22220 #: ../fish/guestfish.pod:25
22222 "Using guestfish in read/write mode on live virtual machines can be "
22223 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
22224 "option to use guestfish safely if the disk image or virtual machine might be "
22230 #: ../fish/guestfish.pod:32
22232 "Guestfish is a shell and command-line tool for examining and modifying "
22233 "virtual machine filesystems. It uses libguestfs and exposes all of the "
22234 "functionality of the guestfs API, see L<guestfs(3)>."
22239 #: ../fish/guestfish.pod:36
22241 "Guestfish gives you structured access to the libguestfs API, from shell "
22242 "scripts or the command line or interactively. If you want to rescue a "
22243 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
22249 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
22250 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
22256 #: ../fish/guestfish.pod:43
22257 msgid "As an interactive shell"
22262 #: ../fish/guestfish.pod:45
22271 #: ../fish/guestfish.pod:47
22274 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
22275 " editing virtual machine filesystems.\n"
22281 #: ../fish/guestfish.pod:50
22284 " Type: 'help' for a list of commands\n"
22285 " 'man' to read the manual\n"
22286 " 'quit' to quit the shell\n"
22292 #: ../fish/guestfish.pod:54
22295 " ><fs> add-ro disk.img\n"
22297 " ><fs> list-filesystems\n"
22298 " /dev/sda1: ext4\n"
22299 " /dev/vg_guest/lv_root: ext4\n"
22300 " /dev/vg_guest/lv_swap: swap\n"
22301 " ><fs> mount /dev/vg_guest/lv_root /\n"
22302 " ><fs> cat /etc/fstab\n"
22304 " # Created by anaconda\n"
22312 #: ../fish/guestfish.pod:67
22313 msgid "From shell scripts"
22318 #: ../fish/guestfish.pod:69
22319 msgid "Create a new C</etc/motd> file in a guest or disk image:"
22324 #: ../fish/guestfish.pod:71
22327 " guestfish <<_EOF_\n"
22330 " mount /dev/vg_guest/lv_root /\n"
22331 " write /etc/motd \"Welcome, new users\"\n"
22338 #: ../fish/guestfish.pod:78
22339 msgid "List the LVM logical volumes in a disk image:"
22344 #: ../fish/guestfish.pod:80
22347 " guestfish -a disk.img --ro <<_EOF_\n"
22356 #: ../fish/guestfish.pod:85
22357 msgid "List all the filesystems in a disk image:"
22362 #: ../fish/guestfish.pod:87
22365 " guestfish -a disk.img --ro <<_EOF_\n"
22367 " list-filesystems\n"
22374 #: ../fish/guestfish.pod:92
22375 msgid "On one command line"
22380 #: ../fish/guestfish.pod:94
22381 msgid "Update C</etc/resolv.conf> in a guest:"
22386 #: ../fish/guestfish.pod:96
22390 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
22391 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
22397 #: ../fish/guestfish.pod:100
22398 msgid "Edit C</boot/grub/grub.conf> interactively:"
22403 #: ../fish/guestfish.pod:102
22406 " guestfish --rw --add disk.img \\\n"
22407 " --mount /dev/vg_guest/lv_root \\\n"
22408 " --mount /dev/sda1:/boot \\\n"
22409 " edit /boot/grub/grub.conf\n"
22415 #: ../fish/guestfish.pod:107
22416 msgid "Mount disks automatically"
22421 #: ../fish/guestfish.pod:109
22423 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
22428 #: ../fish/guestfish.pod:112
22431 " guestfish --ro -a disk.img -i cat /etc/group\n"
22437 #: ../fish/guestfish.pod:114
22440 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
22446 #: ../fish/guestfish.pod:116
22447 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
22452 #: ../fish/guestfish.pod:118
22455 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
22461 #: ../fish/guestfish.pod:120
22462 msgid "As a script interpreter"
22467 #: ../fish/guestfish.pod:122
22468 msgid "Create a 100MB disk containing an ext2-formatted partition:"
22473 #: ../fish/guestfish.pod:124
22476 " #!/usr/bin/guestfish -f\n"
22477 " sparse test1.img 100M\n"
22479 " part-disk /dev/sda mbr\n"
22480 " mkfs ext2 /dev/sda1\n"
22486 #: ../fish/guestfish.pod:130
22487 msgid "Start with a prepared disk"
22492 #: ../fish/guestfish.pod:132
22494 "An alternate way to create a 100MB disk called C<test1.img> containing a "
22495 "single ext2-formatted partition:"
22500 #: ../fish/guestfish.pod:135
22503 " guestfish -N fs\n"
22509 #: ../fish/guestfish.pod:137
22510 msgid "To list what is available do:"
22515 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
22518 " guestfish -N help | less\n"
22524 #: ../fish/guestfish.pod:141
22525 msgid "Remote control"
22530 #: ../fish/guestfish.pod:143
22533 " eval \"`guestfish --listen`\"\n"
22534 " guestfish --remote add-ro disk.img\n"
22535 " guestfish --remote run\n"
22536 " guestfish --remote lvs\n"
22542 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
22543 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
22544 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
22545 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
22551 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
22552 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
22553 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
22554 #: ../tools/virt-list-partitions.pl:62
22560 #: ../fish/guestfish.pod:154
22561 msgid "Displays general help on options."
22566 #: ../fish/guestfish.pod:156
22572 #: ../fish/guestfish.pod:158
22573 msgid "B<--cmd-help>"
22578 #: ../fish/guestfish.pod:160
22579 msgid "Lists all available guestfish commands."
22584 #: ../fish/guestfish.pod:162
22590 #: ../fish/guestfish.pod:164
22591 msgid "B<--cmd-help cmd>"
22596 #: ../fish/guestfish.pod:166
22597 msgid "Displays detailed help on a single command C<cmd>."
22602 #: ../fish/guestfish.pod:168
22603 msgid "B<-a image>"
22608 #: ../fish/guestfish.pod:170
22609 msgid "B<--add image>"
22614 #: ../fish/guestfish.pod:172
22615 msgid "Add a block device or virtual machine image to the shell."
22620 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
22622 "The format of the disk image is auto-detected. To override this and force a "
22623 "particular format use the I<--format=..> option."
22627 #: ../fish/guestfish.pod:177
22629 "Using this flag is mostly equivalent to using the C<add> command, with "
22630 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
22631 "the I<--format=...> flag was given."
22636 #: ../fish/guestfish.pod:181
22642 #: ../fish/guestfish.pod:183
22643 msgid "B<--connect URI>"
22648 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22650 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22651 "URI to use. The default is to use the default libvirt connection."
22656 #: ../fish/guestfish.pod:189
22662 #: ../fish/guestfish.pod:191
22664 "If using the I<--listen> option and a csh-like shell, use this option. See "
22665 "section L</REMOTE CONTROL AND CSH> below."
22670 #: ../fish/guestfish.pod:194
22671 msgid "B<-d libvirt-domain>"
22676 #: ../fish/guestfish.pod:196
22677 msgid "B<--domain libvirt-domain>"
22682 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22684 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22685 "used, then any libvirt domain can be used. However in write mode, only "
22686 "libvirt domains which are shut down can be named here."
22690 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
22691 msgid "Domain UUIDs can be used instead of names."
22696 #: ../fish/guestfish.pod:204
22698 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22699 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22700 "if the I<--format:...> flag was given."
22705 #: ../fish/guestfish.pod:208
22711 #: ../fish/guestfish.pod:210
22712 msgid "B<--no-dest-paths>"
22717 #: ../fish/guestfish.pod:212
22719 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22720 "to hit the tab key to complete paths on the guest filesystem, but this "
22721 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22722 "allow this feature to be disabled."
22727 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22728 msgid "B<--echo-keys>"
22733 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
22735 "When prompting for keys and passphrases, guestfish normally turns echoing "
22736 "off so you cannot see what you are typing. If you are not worried about "
22737 "Tempest attacks and there is no one else in the room you can specify this "
22738 "flag to see what you are typing."
22743 #: ../fish/guestfish.pod:224
22749 #: ../fish/guestfish.pod:226
22750 msgid "B<--file file>"
22755 #: ../fish/guestfish.pod:228
22756 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22761 #: ../fish/guestfish.pod:231
22764 " #!/usr/bin/guestfish -f\n"
22770 #: ../fish/guestfish.pod:233
22771 msgid "B<--format=raw|qcow2|..>"
22776 #: ../fish/guestfish.pod:235
22777 msgid "B<--format>"
22782 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
22784 "The default for the I<-a> option is to auto-detect the format of the disk "
22785 "image. Using this forces the disk format for I<-a> options which follow on "
22786 "the command line. Using I<--format> with no argument switches back to auto-"
22787 "detection for subsequent I<-a> options."
22792 #: ../fish/guestfish.pod:244
22795 " guestfish --format=raw -a disk.img\n"
22801 #: ../fish/guestfish.pod:246
22802 msgid "forces raw format (no auto-detection) for C<disk.img>."
22807 #: ../fish/guestfish.pod:248
22810 " guestfish --format=raw -a disk.img --format -a another.img\n"
22816 #: ../fish/guestfish.pod:250
22818 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22819 "detection for C<another.img>."
22824 #: ../fish/guestfish.pod:253
22826 "If you have untrusted raw-format guest disk images, you should use this "
22827 "option to specify the disk format. This avoids a possible security problem "
22828 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22833 #: ../fish/guestfish.pod:258
22839 #: ../fish/guestfish.pod:260
22840 msgid "B<--inspector>"
22845 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
22847 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22848 "system and mount filesystems as they would be mounted on the real virtual "
22854 #: ../fish/guestfish.pod:266
22855 msgid "Typical usage is either:"
22860 #: ../fish/guestfish.pod:268
22863 " guestfish -d myguest -i\n"
22869 #: ../fish/guestfish.pod:270
22870 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22875 #: ../fish/guestfish.pod:272
22878 " guestfish --ro -d myguest -i\n"
22884 #: ../fish/guestfish.pod:274
22885 msgid "(for active domains, readonly), or specify the block device directly:"
22890 #: ../fish/guestfish.pod:276
22893 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22899 #: ../fish/guestfish.pod:278
22901 "Note that the command line syntax changed slightly over older versions of "
22902 "guestfish. You can still use the old syntax:"
22907 #: ../fish/guestfish.pod:281
22910 " guestfish [--ro] -i disk.img\n"
22916 #: ../fish/guestfish.pod:283
22919 " guestfish [--ro] -i libvirt-domain\n"
22925 #: ../fish/guestfish.pod:285
22927 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22928 "then using other commands to mount the filesystems that were found."
22933 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22934 msgid "B<--keys-from-stdin>"
22939 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
22941 "Read key or passphrase parameters from stdin. The default is to try to read "
22942 "passphrases from the user by opening C</dev/tty>."
22947 #: ../fish/guestfish.pod:294
22948 msgid "B<--listen>"
22953 #: ../fish/guestfish.pod:296
22955 "Fork into the background and listen for remote commands. See section L</"
22956 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22960 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22965 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
22967 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22968 "ATTACHING TO RUNNING DAEMONS>)."
22972 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22973 msgid "B<-m dev[:mountpoint[:options]]>"
22977 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
22978 msgid "B<--mount dev[:mountpoint[:options]]>"
22983 #: ../fish/guestfish.pod:308
22984 msgid "Mount the named partition or logical volume on the given mountpoint."
22989 #: ../fish/guestfish.pod:310
22990 msgid "If the mountpoint is omitted, it defaults to C</>."
22995 #: ../fish/guestfish.pod:312
22996 msgid "You have to mount something on C</> before most commands will work."
23001 #: ../fish/guestfish.pod:314
23003 "If any I<-m> or I<--mount> options are given, the guest is automatically "
23009 #: ../fish/guestfish.pod:317
23011 "If you don't know what filesystems a disk image contains, you can either run "
23012 "guestfish without this option, then list the partitions, filesystems and LVs "
23013 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
23014 "commands), or you can use the L<virt-filesystems(1)> program."
23018 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
23020 "The third (and rarely used) part of the mount parameter is the list of mount "
23021 "options used to mount the underlying filesystem. If this is not given, then "
23022 "the mount options are either the empty string or C<ro> (the latter if the "
23023 "I<--ro> flag is used). By specifying the mount options, you override this "
23024 "default choice. Probably the only time you would use this is to enable ACLs "
23025 "and/or extended attributes if the filesystem can support them:"
23029 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
23032 " -m /dev/sda1:/:acl,user_xattr\n"
23037 #: ../fish/guestfish.pod:333
23038 msgid "Using this flag is equivalent to using the C<mount-options> command."
23043 #: ../fish/guestfish.pod:335
23049 #: ../fish/guestfish.pod:337
23050 msgid "B<--no-sync>"
23055 #: ../fish/guestfish.pod:339
23057 "Disable autosync. This is enabled by default. See the discussion of "
23058 "autosync in the L<guestfs(3)> manpage."
23063 #: ../fish/guestfish.pod:342
23069 #: ../fish/guestfish.pod:344
23070 msgid "B<--new type>"
23075 #: ../fish/guestfish.pod:346
23081 #: ../fish/guestfish.pod:348
23083 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
23084 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
23085 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
23091 #: ../fish/guestfish.pod:353
23092 msgid "B<--progress-bars>"
23097 #: ../fish/guestfish.pod:355
23098 msgid "Enable progress bars, even when guestfish is used non-interactively."
23103 #: ../fish/guestfish.pod:357
23105 "Progress bars are enabled by default when guestfish is used as an "
23106 "interactive shell."
23111 #: ../fish/guestfish.pod:360
23112 msgid "B<--no-progress-bars>"
23117 #: ../fish/guestfish.pod:362
23118 msgid "Disable progress bars."
23123 #: ../fish/guestfish.pod:364
23124 msgid "B<--remote[=pid]>"
23129 #: ../fish/guestfish.pod:366
23131 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
23132 "CONTROL GUESTFISH OVER A SOCKET> below."
23137 #: ../fish/guestfish.pod:369
23143 #: ../fish/guestfish.pod:371
23149 #: ../fish/guestfish.pod:373
23151 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
23152 "mounts are done read-only."
23157 #: ../fish/guestfish.pod:376
23159 "The option must always be used if the disk image or virtual machine might be "
23160 "running, and is generally recommended in cases where you don't need write "
23161 "access to the disk."
23166 #: ../fish/guestfish.pod:380
23168 "Note that prepared disk images created with I<-N> are not affected by this "
23169 "option. Also commands like C<add> are not affected - you have to specify "
23170 "the C<readonly:true> option explicitly if you need it."
23175 #: ../fish/guestfish.pod:384
23176 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
23181 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
23182 msgid "B<--selinux>"
23187 #: ../fish/guestfish.pod:388
23188 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
23193 #: ../fish/guestfish.pod:390
23199 #: ../fish/guestfish.pod:392
23200 msgid "B<--verbose>"
23205 #: ../fish/guestfish.pod:394
23207 "Enable very verbose messages. This is particularly useful if you find a bug."
23212 #: ../fish/guestfish.pod:397
23218 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
23219 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
23220 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
23221 msgid "B<--version>"
23226 #: ../fish/guestfish.pod:401
23227 msgid "Display the guestfish / libguestfs version number and exit."
23232 #: ../fish/guestfish.pod:403
23238 #: ../fish/guestfish.pod:405
23243 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
23245 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
23246 "mounts are done read-write."
23250 #: ../fish/guestfish.pod:410
23251 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
23256 #: ../fish/guestfish.pod:412
23262 #: ../fish/guestfish.pod:414
23263 msgid "Echo each command before executing it."
23268 #: ../fish/guestfish.pod:418
23269 msgid "COMMANDS ON COMMAND LINE"
23274 #: ../fish/guestfish.pod:420
23276 "Any additional (non-option) arguments are treated as commands to execute."
23281 #: ../fish/guestfish.pod:423
23283 "Commands to execute should be separated by a colon (C<:>), where the colon "
23284 "is a separate parameter. Thus:"
23289 #: ../fish/guestfish.pod:426
23292 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
23298 #: ../fish/guestfish.pod:428
23300 "If there are no additional arguments, then we enter a shell, either an "
23301 "interactive shell with a prompt (if the input is a terminal) or a non-"
23302 "interactive shell."
23307 #: ../fish/guestfish.pod:432
23309 "In either command line mode or non-interactive shell, the first command that "
23310 "gives an error causes the whole shell to exit. In interactive mode (with a "
23311 "prompt) if a command fails, you can continue to enter commands."
23316 #: ../fish/guestfish.pod:437
23317 msgid "USING launch (OR run)"
23322 #: ../fish/guestfish.pod:439
23324 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
23325 "then launch it, then mount any disks you need, and finally issue actions/"
23326 "commands. So the general order of the day is:"
23331 #: ../fish/guestfish.pod:447
23332 msgid "add or -a/--add"
23337 #: ../fish/guestfish.pod:451
23338 msgid "launch (aka run)"
23343 #: ../fish/guestfish.pod:455
23344 msgid "mount or -m/--mount"
23349 #: ../fish/guestfish.pod:459
23350 msgid "any other commands"
23355 #: ../fish/guestfish.pod:463
23357 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
23358 "guest before mounting or performing any other commands."
23363 #: ../fish/guestfish.pod:466
23365 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
23366 "I<--new> options were given then C<run> is done automatically, simply "
23367 "because guestfish can't perform the action you asked for without doing this."
23372 #: ../fish/guestfish.pod:471
23373 msgid "OPENING DISKS FOR READ AND WRITE"
23377 #: ../fish/guestfish.pod:473
23379 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
23380 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
23381 "I<-i> and I<-m> open disk images read-only or for writing."
23385 #: ../fish/guestfish.pod:478
23387 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
23388 "opening disk images supplied on the command line for write. To open a disk "
23389 "image read-only you have to do I<-a image --ro>."
23394 #: ../fish/guestfish.pod:482
23396 "This matters: If you accidentally open a live VM disk image writable then "
23397 "you will cause irreversible disk corruption."
23401 #: ../fish/guestfish.pod:485
23403 "By libguestfs 1.12 we intend to change the default the other way. Disk "
23404 "images will be opened read-only. You will have to either specify "
23405 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
23406 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
23407 "access for disk images specified by those other command line options."
23411 #: ../fish/guestfish.pod:492
23413 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
23414 "which does nothing (it is already the default). However it is highly "
23415 "recommended that you use this option to indicate that you need write access, "
23416 "and prepare your scripts for the day when this option will be required for "
23422 #: ../fish/guestfish.pod:498
23424 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
23425 "other libguestfs program apart from guestfish and guestmount."
23430 #: ../fish/guestfish.pod:501
23436 #: ../fish/guestfish.pod:503
23438 "You can quote ordinary parameters using either single or double quotes. For "
23444 #: ../fish/guestfish.pod:506
23447 " add \"file with a space.img\"\n"
23453 #: ../fish/guestfish.pod:508
23456 " rm '/file name'\n"
23462 #: ../fish/guestfish.pod:510
23471 #: ../fish/guestfish.pod:512
23473 "A few commands require a list of strings to be passed. For these, use a "
23474 "whitespace-separated list, enclosed in quotes. Strings containing "
23475 "whitespace to be passed through must be enclosed in single quotes. A "
23476 "literal single quote must be escaped with a backslash."
23481 #: ../fish/guestfish.pod:517
23484 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
23485 " command \"/bin/echo 'foo bar'\"\n"
23486 " command \"/bin/echo \\'foo\\'\"\n"
23492 #: ../fish/guestfish.pod:521
23493 msgid "OPTIONAL ARGUMENTS"
23498 #: ../fish/guestfish.pod:523
23500 "Some commands take optional arguments. These arguments appear in this "
23501 "documentation as C<[argname:..]>. You can use them as in these examples:"
23506 #: ../fish/guestfish.pod:527
23509 " add-drive-opts filename\n"
23515 #: ../fish/guestfish.pod:529
23518 " add-drive-opts filename readonly:true\n"
23524 #: ../fish/guestfish.pod:531
23527 " add-drive-opts filename format:qcow2 readonly:false\n"
23533 #: ../fish/guestfish.pod:533
23535 "Each optional argument can appear at most once. All optional arguments must "
23536 "appear after the required ones."
23541 #: ../fish/guestfish.pod:536
23547 #: ../fish/guestfish.pod:538
23549 "This section applies to all commands which can take integers as parameters."
23554 #: ../fish/guestfish.pod:541
23555 msgid "SIZE SUFFIX"
23560 #: ../fish/guestfish.pod:543
23562 "When the command takes a parameter measured in bytes, you can use one of the "
23563 "following suffixes to specify kilobytes, megabytes and larger sizes:"
23568 #: ../fish/guestfish.pod:549
23569 msgid "B<k> or B<K> or B<KiB>"
23574 #: ../fish/guestfish.pod:551
23575 msgid "The size in kilobytes (multiplied by 1024)."
23580 #: ../fish/guestfish.pod:553
23586 #: ../fish/guestfish.pod:555
23587 msgid "The size in SI 1000 byte units."
23592 #: ../fish/guestfish.pod:557
23593 msgid "B<M> or B<MiB>"
23598 #: ../fish/guestfish.pod:559
23599 msgid "The size in megabytes (multiplied by 1048576)."
23604 #: ../fish/guestfish.pod:561
23610 #: ../fish/guestfish.pod:563
23611 msgid "The size in SI 1000000 byte units."
23616 #: ../fish/guestfish.pod:565
23617 msgid "B<G> or B<GiB>"
23622 #: ../fish/guestfish.pod:567
23623 msgid "The size in gigabytes (multiplied by 2**30)."
23628 #: ../fish/guestfish.pod:569
23634 #: ../fish/guestfish.pod:571
23635 msgid "The size in SI 10**9 byte units."
23640 #: ../fish/guestfish.pod:573
23641 msgid "B<T> or B<TiB>"
23646 #: ../fish/guestfish.pod:575
23647 msgid "The size in terabytes (multiplied by 2**40)."
23652 #: ../fish/guestfish.pod:577
23658 #: ../fish/guestfish.pod:579
23659 msgid "The size in SI 10**12 byte units."
23664 #: ../fish/guestfish.pod:581
23665 msgid "B<P> or B<PiB>"
23670 #: ../fish/guestfish.pod:583
23671 msgid "The size in petabytes (multiplied by 2**50)."
23676 #: ../fish/guestfish.pod:585
23682 #: ../fish/guestfish.pod:587
23683 msgid "The size in SI 10**15 byte units."
23688 #: ../fish/guestfish.pod:589
23689 msgid "B<E> or B<EiB>"
23694 #: ../fish/guestfish.pod:591
23695 msgid "The size in exabytes (multiplied by 2**60)."
23700 #: ../fish/guestfish.pod:593
23706 #: ../fish/guestfish.pod:595
23707 msgid "The size in SI 10**18 byte units."
23712 #: ../fish/guestfish.pod:597
23713 msgid "B<Z> or B<ZiB>"
23718 #: ../fish/guestfish.pod:599
23719 msgid "The size in zettabytes (multiplied by 2**70)."
23724 #: ../fish/guestfish.pod:601
23730 #: ../fish/guestfish.pod:603
23731 msgid "The size in SI 10**21 byte units."
23736 #: ../fish/guestfish.pod:605
23737 msgid "B<Y> or B<YiB>"
23742 #: ../fish/guestfish.pod:607
23743 msgid "The size in yottabytes (multiplied by 2**80)."
23748 #: ../fish/guestfish.pod:609
23754 #: ../fish/guestfish.pod:611
23755 msgid "The size in SI 10**24 byte units."
23760 #: ../fish/guestfish.pod:617
23763 " truncate-size /file 1G\n"
23769 #: ../fish/guestfish.pod:619
23770 msgid "would truncate the file to 1 gigabyte."
23775 #: ../fish/guestfish.pod:621
23777 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23778 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23779 "suffix will probably not do what you expect."
23784 #: ../fish/guestfish.pod:625
23785 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23790 #: ../fish/guestfish.pod:627
23792 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23793 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23798 #: ../fish/guestfish.pod:630
23801 " 1234 decimal number 1234\n"
23802 " 02322 octal number, equivalent to decimal 1234\n"
23803 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23809 #: ../fish/guestfish.pod:634
23811 "When using the C<chmod> command, you almost always want to specify an octal "
23812 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23813 "L<chmod(1)> program):"
23818 #: ../fish/guestfish.pod:638
23821 " chmod 0777 /public # OK\n"
23822 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23828 #: ../fish/guestfish.pod:641
23830 "Commands that return numbers usually print them in decimal, but some "
23831 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23832 "octal, preceeded by C<0>)."
23837 #: ../fish/guestfish.pod:645
23838 msgid "WILDCARDS AND GLOBBING"
23843 #: ../fish/guestfish.pod:647
23845 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23846 "(globbing) by default. So for example the following will not do what you "
23852 #: ../fish/guestfish.pod:651
23861 #: ../fish/guestfish.pod:653
23863 "Assuming you don't have a directory called literally C</home/*> then the "
23864 "above command will return an error."
23869 #: ../fish/guestfish.pod:656
23870 msgid "To perform wildcard expansion, use the C<glob> command."
23875 #: ../fish/guestfish.pod:658
23878 " glob rm-rf /home/*\n"
23884 #: ../fish/guestfish.pod:660
23886 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23887 "many times), equivalent to:"
23892 #: ../fish/guestfish.pod:663
23895 " rm-rf /home/jim\n"
23896 " rm-rf /home/joe\n"
23897 " rm-rf /home/mary\n"
23903 #: ../fish/guestfish.pod:667
23904 msgid "C<glob> only works on simple guest paths and not on device names."
23909 #: ../fish/guestfish.pod:669
23911 "If you have several parameters, each containing a wildcard, then glob will "
23912 "perform a Cartesian product."
23917 #: ../fish/guestfish.pod:672
23923 #: ../fish/guestfish.pod:674
23925 "Any line which starts with a I<#> character is treated as a comment and "
23926 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23927 "a command. For example:"
23932 #: ../fish/guestfish.pod:678
23935 " # this is a comment\n"
23936 " # this is a comment\n"
23937 " foo # NOT a comment\n"
23943 #: ../fish/guestfish.pod:682
23944 msgid "Blank lines are also ignored."
23949 #: ../fish/guestfish.pod:684
23950 msgid "RUNNING COMMANDS LOCALLY"
23955 #: ../fish/guestfish.pod:686
23957 "Any line which starts with a I<!> character is treated as a command sent to "
23958 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23963 #: ../fish/guestfish.pod:690
23967 " tgz-out /remote local/remote-data.tar.gz\n"
23973 #: ../fish/guestfish.pod:693
23975 "will create a directory C<local> on the host, and then export the contents "
23976 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23977 "(See C<tgz-out>)."
23982 #: ../fish/guestfish.pod:697
23984 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23985 "effect, due to the way that subprocesses work in Unix."
23989 #: ../fish/guestfish.pod:700
23990 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23994 #: ../fish/guestfish.pod:702
23996 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23997 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23998 "and executed as guestfish commands."
24002 #: ../fish/guestfish.pod:706
24004 "Thus you can use shell script to construct arbitrary guestfish commands "
24005 "which are then parsed by guestfish."
24009 #: ../fish/guestfish.pod:709
24011 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
24012 "through C</foo.100>) using guestfish commands alone. However this is simple "
24013 "if we use a shell script to create the guestfish commands for us:"
24017 #: ../fish/guestfish.pod:714
24020 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
24025 #: ../fish/guestfish.pod:716
24026 msgid "or with names like C</foo.001>:"
24030 #: ../fish/guestfish.pod:718
24033 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
24038 #: ../fish/guestfish.pod:720
24040 "When using guestfish interactively it can be helpful to just run the shell "
24041 "script first (ie. remove the initial C<E<lt>> character so it is just an "
24042 "ordinary I<!> local command), see what guestfish commands it would run, and "
24043 "when you are happy with those prepend the C<E<lt>> character to run the "
24044 "guestfish commands for real."
24049 #: ../fish/guestfish.pod:726
24055 #: ../fish/guestfish.pod:728
24057 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
24058 "command (a guestfish command) to the second command (any host command). For "
24064 #: ../fish/guestfish.pod:732
24067 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
24073 #: ../fish/guestfish.pod:734
24075 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
24076 "program). The above command would list all accounts in the guest filesystem "
24077 "which have UID 0, ie. root accounts including backdoors. Other examples:"
24082 #: ../fish/guestfish.pod:739
24085 " hexdump /bin/ls | head\n"
24086 " list-devices | tail -1\n"
24087 " tgz-out / - | tar ztf -\n"
24093 #: ../fish/guestfish.pod:743
24095 "The space before the pipe symbol is required, any space after the pipe "
24096 "symbol is optional. Everything after the pipe symbol is just passed "
24097 "straight to the host shell, so it can contain redirections, globs and "
24098 "anything else that makes sense on the host side."
24103 #: ../fish/guestfish.pod:748
24105 "To use a literal argument which begins with a pipe symbol, you have to quote "
24111 #: ../fish/guestfish.pod:751
24120 #: ../fish/guestfish.pod:753
24121 msgid "HOME DIRECTORIES"
24126 #: ../fish/guestfish.pod:755
24128 "If a parameter starts with the character C<~> then the tilde may be expanded "
24129 "as a home directory path (either C<~> for the current user's home directory, "
24130 "or C<~user> for another user)."
24135 #: ../fish/guestfish.pod:759
24137 "Note that home directory expansion happens for users known I<on the host>, "
24138 "not in the guest filesystem."
24143 #: ../fish/guestfish.pod:762
24145 "To use a literal argument which begins with a tilde, you have to quote it, "
24151 #: ../fish/guestfish.pod:765
24160 #: ../fish/guestfish.pod:769
24162 "Libguestfs has some support for Linux guests encrypted according to the "
24163 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
24164 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
24165 "LUKS is supported."
24170 #: ../fish/guestfish.pod:774
24171 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
24176 #: ../fish/guestfish.pod:776
24179 " ><fs> vfs-type /dev/sda2\n"
24186 #: ../fish/guestfish.pod:779
24188 "Then open those devices using L</luks-open>. This creates a device-mapper "
24189 "device called C</dev/mapper/luksdev>."
24194 #: ../fish/guestfish.pod:782
24197 " ><fs> luks-open /dev/sda2 luksdev\n"
24198 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
24204 #: ../fish/guestfish.pod:785
24206 "Finally you have to tell LVM to scan for volume groups on the newly created "
24212 #: ../fish/guestfish.pod:788
24216 " vg-activate-all true\n"
24222 #: ../fish/guestfish.pod:791
24223 msgid "The logical volume(s) can now be mounted in the usual way."
24228 #: ../fish/guestfish.pod:793
24230 "Before closing a LUKS device you must unmount any logical volumes on it and "
24231 "deactivate the volume groups by calling C<vg-activate false VG> on each "
24232 "one. Then you can close the mapper device:"
24237 #: ../fish/guestfish.pod:797
24240 " vg-activate false /dev/VG\n"
24241 " luks-close /dev/mapper/luksdev\n"
24247 #: ../fish/guestfish.pod:800
24248 msgid "WINDOWS PATHS"
24252 #: ../fish/guestfish.pod:802
24254 "If a path is prefixed with C<win:> then you can use Windows-style drive "
24255 "letters and paths (with some limitations). The following commands are "
24261 #: ../fish/guestfish.pod:806
24264 " file /WINDOWS/system32/config/system.LOG\n"
24270 #: ../fish/guestfish.pod:808
24273 " file win:\\windows\\system32\\config\\system.log\n"
24278 #: ../fish/guestfish.pod:810
24281 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
24286 #: ../fish/guestfish.pod:812
24288 "The parameter is rewritten \"behind the scenes\" by looking up the position "
24289 "where the drive is mounted, prepending that to the path, changing all "
24290 "backslash characters to forward slash, then resolving the result using L</"
24291 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
24292 "the parameter might be rewritten like this:"
24296 #: ../fish/guestfish.pod:818
24299 " win:e:\\foo\\bar => /e/FOO/bar\n"
24304 #: ../fish/guestfish.pod:820
24305 msgid "This only works in argument positions that expect a path."
24310 #: ../fish/guestfish.pod:822
24311 msgid "UPLOADING AND DOWNLOADING FILES"
24316 #: ../fish/guestfish.pod:824
24318 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
24319 "others which upload from or download to a local file, you can use the "
24320 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
24325 #: ../fish/guestfish.pod:828
24334 #: ../fish/guestfish.pod:830
24336 "reads stdin and creates from that a file C</foo> in the disk image, and:"
24341 #: ../fish/guestfish.pod:833
24344 " tar-out /etc - | tar tf -\n"
24350 #: ../fish/guestfish.pod:835
24352 "writes the tarball to stdout and then pipes that into the external \"tar\" "
24353 "command (see L</PIPES>)."
24358 #: ../fish/guestfish.pod:838
24360 "When using C<-> to read from stdin, the input is read up to the end of "
24361 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
24362 "some arbitrary end marker:"
24367 #: ../fish/guestfish.pod:842
24370 " upload -<<END /foo\n"
24380 #: ../fish/guestfish.pod:848
24382 "Any string of characters can be used instead of C<END>. The end marker must "
24383 "appear on a line of its own, without any preceeding or following characters "
24384 "(not even spaces)."
24389 #: ../fish/guestfish.pod:852
24391 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
24392 "upload local files (so-called \"FileIn\" parameters in the generator)."
24397 #: ../fish/guestfish.pod:855
24398 msgid "EXIT ON ERROR BEHAVIOUR"
24403 #: ../fish/guestfish.pod:857
24405 "By default, guestfish will ignore any errors when in interactive mode (ie. "
24406 "taking commands from a human over a tty), and will exit on the first error "
24407 "in non-interactive mode (scripts, commands given on the command line)."
24412 #: ../fish/guestfish.pod:862
24414 "If you prefix a command with a I<-> character, then that command will not "
24415 "cause guestfish to exit, even if that (one) command returns an error."
24420 #: ../fish/guestfish.pod:866
24421 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
24426 #: ../fish/guestfish.pod:868
24428 "Guestfish can be remote-controlled over a socket. This is useful "
24429 "particularly in shell scripts where you want to make several different "
24430 "changes to a filesystem, but you don't want the overhead of starting up a "
24431 "guestfish process each time."
24436 #: ../fish/guestfish.pod:873
24437 msgid "Start a guestfish server process using:"
24442 #: ../fish/guestfish.pod:875
24445 " eval \"`guestfish --listen`\"\n"
24451 #: ../fish/guestfish.pod:877
24452 msgid "and then send it commands by doing:"
24457 #: ../fish/guestfish.pod:879
24460 " guestfish --remote cmd [...]\n"
24466 #: ../fish/guestfish.pod:881
24467 msgid "To cause the server to exit, send it the exit command:"
24472 #: ../fish/guestfish.pod:883
24475 " guestfish --remote exit\n"
24481 #: ../fish/guestfish.pod:885
24483 "Note that the server will normally exit if there is an error in a command. "
24484 "You can change this in the usual way. See section L</EXIT ON ERROR "
24490 #: ../fish/guestfish.pod:889
24491 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
24496 #: ../fish/guestfish.pod:891
24498 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
24499 "is how the I<--remote> option knows where to send the commands. You can "
24500 "have several guestfish listener processes running using:"
24505 #: ../fish/guestfish.pod:895
24508 " eval \"`guestfish --listen`\"\n"
24509 " pid1=$GUESTFISH_PID\n"
24510 " eval \"`guestfish --listen`\"\n"
24511 " pid2=$GUESTFISH_PID\n"
24513 " guestfish --remote=$pid1 cmd\n"
24514 " guestfish --remote=$pid2 cmd\n"
24520 #: ../fish/guestfish.pod:903
24521 msgid "REMOTE CONTROL AND CSH"
24526 #: ../fish/guestfish.pod:905
24528 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
24534 #: ../fish/guestfish.pod:908
24537 " eval \"`guestfish --listen --csh`\"\n"
24543 #: ../fish/guestfish.pod:910
24544 msgid "REMOTE CONTROL DETAILS"
24549 #: ../fish/guestfish.pod:912
24551 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
24552 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
24553 "and C<$PID> is the process ID of the server."
24558 #: ../fish/guestfish.pod:916
24559 msgid "Guestfish client and server versions must match exactly."
24564 #: ../fish/guestfish.pod:918
24565 msgid "PREPARED DISK IMAGES"
24570 #: ../fish/guestfish.pod:920
24572 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
24573 "preformatted disk images that guestfish can make for you to save typing. "
24574 "This is particularly useful for testing purposes. This option is used "
24575 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
24576 "can be mixed with I<-a>)."
24581 #: ../fish/guestfish.pod:926
24583 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
24584 "the second and so on. Existing files in the current directory are "
24590 #: ../fish/guestfish.pod:930
24592 "The type briefly describes how the disk should be sized, partitioned, how "
24593 "filesystem(s) should be created, and how content should be added. "
24594 "Optionally the type can be followed by extra parameters, separated by C<:> "
24595 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
24596 "allocated disk, containing a single partition, with the partition formatted "
24597 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
24603 #: ../fish/guestfish.pod:938
24604 msgid "To list the available types and any extra parameters they take, run:"
24609 #: ../fish/guestfish.pod:942
24611 "Note that the prepared filesystem is not mounted. You would usually have to "
24612 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
24617 #: ../fish/guestfish.pod:946
24619 "If any I<-N> or I<--new> options are given, the guest is automatically "
24625 #: ../fish/guestfish.pod:951
24626 msgid "Create a 100MB disk with an ext4-formatted partition:"
24631 #: ../fish/guestfish.pod:953
24634 " guestfish -N fs:ext4\n"
24640 #: ../fish/guestfish.pod:955
24641 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24646 #: ../fish/guestfish.pod:957
24649 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24655 #: ../fish/guestfish.pod:959
24656 msgid "Create a blank 200MB disk:"
24661 #: ../fish/guestfish.pod:961
24664 " guestfish -N disk:200M\n"
24670 #: ../fish/guestfish.pod:963
24671 msgid "PROGRESS BARS"
24676 #: ../fish/guestfish.pod:965
24678 "Some (not all) long-running commands send progress notification messages as "
24679 "they are running. Guestfish turns these messages into progress bars."
24684 #: ../fish/guestfish.pod:969
24686 "When a command that supports progress bars takes longer than two seconds to "
24687 "run, and if progress bars are enabled, then you will see one appearing below "
24693 #: ../fish/guestfish.pod:973
24696 " ><fs> copy-size /large-file /another-file 2048M\n"
24697 " / 10% [#####-----------------------------------------] 00:30\n"
24703 #: ../fish/guestfish.pod:976
24705 "The spinner on the left hand side moves round once for every progress "
24706 "notification received from the backend. This is a (reasonably) golden "
24707 "assurance that the command is \"doing something\" even if the progress bar "
24708 "is not moving, because the command is able to send the progress "
24709 "notifications. When the bar reaches 100% and the command finishes, the "
24710 "spinner disappears."
24715 #: ../fish/guestfish.pod:983
24717 "Progress bars are enabled by default when guestfish is used interactively. "
24718 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24719 "and you can disable them completely using I<--no-progress-bars>."
24724 #: ../fish/guestfish.pod:988
24725 msgid "GUESTFISH COMMANDS"
24730 #: ../fish/guestfish.pod:990
24732 "The commands in this section are guestfish convenience commands, in other "
24733 "words, they are not part of the L<guestfs(3)> API."
24738 #: ../fish/guestfish.pod:993
24744 #: ../fish/guestfish.pod:995
24754 #: ../fish/guestfish.pod:998
24755 msgid "Without any parameter, this provides general help."
24760 #: ../fish/guestfish.pod:1000
24761 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24766 #: ../fish/guestfish.pod:1002
24767 msgid "quit | exit"
24772 #: ../fish/guestfish.pod:1004
24773 msgid "This exits guestfish. You can also use C<^D> key."
24778 #: ../fish/guestfish.pod:1006
24779 msgid "@FISH_COMMANDS@"
24784 #: ../fish/guestfish.pod:1008
24790 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24796 #: ../fish/guestfish.pod:1014
24798 "guestfish returns 0 if the commands completed without error, or 1 if there "
24804 #: ../fish/guestfish.pod:1021
24810 #: ../fish/guestfish.pod:1023
24812 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24817 #: ../fish/guestfish.pod:1026
24818 msgid "GUESTFISH_DISPLAY_IMAGE"
24822 #: ../fish/guestfish.pod:1028
24824 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
24825 "If not set, it uses L<display(1)>."
24830 #: ../fish/guestfish.pod:1031
24831 msgid "GUESTFISH_PID"
24836 #: ../fish/guestfish.pod:1033
24838 "Used with the I<--remote> option to specify the remote guestfish process to "
24839 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24844 #: ../fish/guestfish.pod:1037
24850 #: ../fish/guestfish.pod:1039
24852 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24853 "not specified, the external L<hexedit(1)> program is used."
24858 #: ../fish/guestfish.pod:1043
24864 #: ../fish/guestfish.pod:1045
24866 "If compiled with GNU readline support, various files in the home directory "
24867 "can be used. See L</FILES>."
24872 #: ../fish/guestfish.pod:1054
24874 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24875 "effect as using the B<-v> option."
24880 #: ../fish/guestfish.pod:1066
24882 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24883 "the discussion of paths in L<guestfs(3)>."
24888 #: ../fish/guestfish.pod:1077
24889 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24894 #: ../fish/guestfish.pod:1079
24900 #: ../fish/guestfish.pod:1081
24902 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24908 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
24913 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
24914 msgid "$HOME/.libguestfs-tools.rc"
24918 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
24919 msgid "/etc/libguestfs-tools.conf"
24923 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
24925 "This configuration file controls the default read-only or read-write mode "
24926 "(I<--ro> or I<--rw>)."
24930 #: ../fish/guestfish.pod:1108
24931 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24936 #: ../fish/guestfish.pod:1110
24937 msgid "$HOME/.guestfish"
24942 #: ../fish/guestfish.pod:1112
24944 "If compiled with GNU readline support, then the command history is saved in "
24950 #: ../fish/guestfish.pod:1115
24951 msgid "$HOME/.inputrc"
24956 #: ../fish/guestfish.pod:1117
24957 msgid "/etc/inputrc"
24962 #: ../fish/guestfish.pod:1119
24964 "If compiled with GNU readline support, then these files can be used to "
24965 "configure readline. For further information, please see L<readline(3)/"
24966 "INITIALIZATION FILE>."
24971 #: ../fish/guestfish.pod:1123
24972 msgid "To write rules which only apply to guestfish, use:"
24977 #: ../fish/guestfish.pod:1125
24988 #: ../fish/guestfish.pod:1129
24990 "Variables that you can set in inputrc that change the behaviour of guestfish "
24991 "in useful ways include:"
24996 #: ../fish/guestfish.pod:1134
24997 msgid "completion-ignore-case (default: on)"
25002 #: ../fish/guestfish.pod:1136
25004 "By default, guestfish will ignore case when tab-completing paths on the "
25010 #: ../fish/guestfish.pod:1139
25013 " set completion-ignore-case off\n"
25019 #: ../fish/guestfish.pod:1141
25020 msgid "to make guestfish case sensitive."
25025 #: ../fish/guestfish.pod:1145
25031 #: ../fish/guestfish.pod:1147
25032 msgid "test2.img (etc)"
25036 #: ../fish/guestfish.pod:1149
25038 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
25039 "will be created in the file C<test1.img> in the current directory. The "
25040 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
25041 "the same name will be overwritten."
25045 #: ../fish/guestfish.pod:1158
25047 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
25048 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
25049 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
25050 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
25051 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
25052 ">, L<display(1)>, L<hexedit(1)>."
25057 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
25058 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
25059 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
25060 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
25062 "This program is free software; you can redistribute it and/or modify it "
25063 "under the terms of the GNU General Public License as published by the Free "
25064 "Software Foundation; either version 2 of the License, or (at your option) "
25065 "any later version."
25070 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
25071 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
25072 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
25073 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
25075 "This program is distributed in the hope that it will be useful, but WITHOUT "
25076 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
25077 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
25083 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
25084 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
25085 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
25086 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
25088 "You should have received a copy of the GNU General Public License along with "
25089 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
25090 "Ave, Cambridge, MA 02139, USA."
25095 #: ../fish/guestfish-actions.pod:1
25101 #: ../fish/guestfish-actions.pod:3
25104 " add-cdrom filename\n"
25110 #: ../fish/guestfish-actions.pod:15
25112 "This call checks for the existence of C<filename>. This stops you from "
25113 "specifying other types of drive which are supported by qemu such as C<nbd:> "
25114 "and C<http:> URLs. To specify those, use the general L</config> call "
25120 #: ../fish/guestfish-actions.pod:22
25122 "If you just want to add an ISO file (often you use this as an efficient way "
25123 "to transfer large files into the guest), then you should probably use L</add-"
25124 "drive-ro> instead."
25129 #: ../fish/guestfish-actions.pod:35
25135 #: ../fish/guestfish-actions.pod:37
25140 #: ../fish/guestfish-actions.pod:39
25143 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
25149 #: ../fish/guestfish-actions.pod:41
25151 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
25152 "It works by connecting to libvirt, requesting the domain and domain XML from "
25153 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
25158 #: ../fish/guestfish-actions.pod:76
25160 "The other optional parameters are passed directly through to L</add-drive-"
25166 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
25167 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1962
25168 #: ../fish/guestfish-actions.pod:3128 ../fish/guestfish-actions.pod:3301
25169 #: ../fish/guestfish-actions.pod:3436
25171 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
25176 #: ../fish/guestfish-actions.pod:81
25182 #: ../fish/guestfish-actions.pod:83
25185 " add-drive filename\n"
25191 #: ../fish/guestfish-actions.pod:85
25193 "This function is the equivalent of calling L</add-drive-opts> with no "
25194 "optional parameters, so the disk is added writable, with the format being "
25195 "detected automatically."
25200 #: ../fish/guestfish-actions.pod:89
25202 "Automatic detection of the format opens you up to a potential security hole "
25203 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
25204 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
25205 "you should think about replacing calls to this function with calls to L</add-"
25206 "drive-opts>, and specifying the format."
25211 #: ../fish/guestfish-actions.pod:96
25212 msgid "add-drive-opts"
25217 #: ../fish/guestfish-actions.pod:98
25223 #: ../fish/guestfish-actions.pod:100
25226 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
25232 #: ../fish/guestfish-actions.pod:127
25234 "This forces the image format. If you omit this (or use L</add-drive> or L</"
25235 "add-drive-ro>) then the format is automatically detected. Possible formats "
25236 "include C<raw> and C<qcow2>."
25241 #: ../fish/guestfish-actions.pod:138
25243 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
25244 "add-drive-with-if> call (q.v.)"
25249 #: ../fish/guestfish-actions.pod:145
25250 msgid "add-drive-ro"
25255 #: ../fish/guestfish-actions.pod:147
25261 #: ../fish/guestfish-actions.pod:149
25264 " add-drive-ro filename\n"
25270 #: ../fish/guestfish-actions.pod:151
25272 "This function is the equivalent of calling L</add-drive-opts> with the "
25273 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
25274 "is added read-only, with the format being detected automatically."
25279 #: ../fish/guestfish-actions.pod:156
25280 msgid "add-drive-ro-with-if"
25285 #: ../fish/guestfish-actions.pod:158
25288 " add-drive-ro-with-if filename iface\n"
25294 #: ../fish/guestfish-actions.pod:160
25296 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
25297 "interface emulation to use at run time."
25302 #: ../fish/guestfish-actions.pod:170
25303 msgid "add-drive-with-if"
25308 #: ../fish/guestfish-actions.pod:172
25311 " add-drive-with-if filename iface\n"
25317 #: ../fish/guestfish-actions.pod:174
25319 "This is the same as L</add-drive> but it allows you to specify the QEMU "
25320 "interface emulation to use at run time."
25325 #: ../fish/guestfish-actions.pod:184
25331 #: ../fish/guestfish-actions.pod:186
25334 " aug-clear augpath\n"
25340 #: ../fish/guestfish-actions.pod:191
25346 #: ../fish/guestfish-actions.pod:193
25355 #: ../fish/guestfish-actions.pod:195
25357 "Close the current Augeas handle and free up any resources used by it. After "
25358 "calling this, you have to call L</aug-init> again before you can use any "
25359 "other Augeas functions."
25364 #: ../fish/guestfish-actions.pod:200
25365 msgid "aug-defnode"
25370 #: ../fish/guestfish-actions.pod:202
25373 " aug-defnode name expr val\n"
25379 #: ../fish/guestfish-actions.pod:207
25381 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
25382 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
25383 "containing that single node."
25388 #: ../fish/guestfish-actions.pod:215
25394 #: ../fish/guestfish-actions.pod:217
25397 " aug-defvar name expr\n"
25403 #: ../fish/guestfish-actions.pod:226
25409 #: ../fish/guestfish-actions.pod:228
25412 " aug-get augpath\n"
25418 #: ../fish/guestfish-actions.pod:233
25424 #: ../fish/guestfish-actions.pod:235
25427 " aug-init root flags\n"
25433 #: ../fish/guestfish-actions.pod:241
25434 msgid "You must call this before using any other L</aug-*> commands."
25439 #: ../fish/guestfish-actions.pod:276
25440 msgid "Do not load the tree in L</aug-init>."
25445 #: ../fish/guestfish-actions.pod:280
25446 msgid "To close the handle, you can call L</aug-close>."
25451 #: ../fish/guestfish-actions.pod:284
25457 #: ../fish/guestfish-actions.pod:286
25460 " aug-insert augpath label true|false\n"
25466 #: ../fish/guestfish-actions.pod:296
25472 #: ../fish/guestfish-actions.pod:298
25481 #: ../fish/guestfish-actions.pod:305
25487 #: ../fish/guestfish-actions.pod:307
25490 " aug-ls augpath\n"
25496 #: ../fish/guestfish-actions.pod:309
25498 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
25499 "resulting nodes into alphabetical order."
25504 #: ../fish/guestfish-actions.pod:312
25510 #: ../fish/guestfish-actions.pod:314
25513 " aug-match augpath\n"
25519 #: ../fish/guestfish-actions.pod:320
25525 #: ../fish/guestfish-actions.pod:322
25528 " aug-mv src dest\n"
25534 #: ../fish/guestfish-actions.pod:327
25540 #: ../fish/guestfish-actions.pod:329
25543 " aug-rm augpath\n"
25549 #: ../fish/guestfish-actions.pod:335
25555 #: ../fish/guestfish-actions.pod:337
25564 #: ../fish/guestfish-actions.pod:341
25566 "The flags which were passed to L</aug-init> affect exactly how files are "
25572 #: ../fish/guestfish-actions.pod:344
25578 #: ../fish/guestfish-actions.pod:346
25581 " aug-set augpath val\n"
25587 #: ../fish/guestfish-actions.pod:350
25589 "In the Augeas API, it is possible to clear a node by setting the value to "
25590 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
25591 "this call. Instead you must use the L</aug-clear> call."
25596 #: ../fish/guestfish-actions.pod:355
25602 #: ../fish/guestfish-actions.pod:357
25605 " available 'groups ...'\n"
25611 #: ../fish/guestfish-actions.pod:363
25613 "The libguestfs groups, and the functions that those groups correspond to, "
25614 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
25615 "runtime by calling L</available-all-groups>."
25620 #: ../fish/guestfish-actions.pod:387
25621 msgid "You must call L</launch> before calling this function."
25626 #: ../fish/guestfish-actions.pod:409
25628 "This call was added in version C<1.0.80>. In previous versions of "
25629 "libguestfs all you could do would be to speculatively execute a command to "
25630 "find out if the daemon implemented it. See also L</version>."
25635 #: ../fish/guestfish-actions.pod:416
25636 msgid "available-all-groups"
25641 #: ../fish/guestfish-actions.pod:418
25644 " available-all-groups\n"
25650 #: ../fish/guestfish-actions.pod:420
25652 "This command returns a list of all optional groups that this daemon knows "
25653 "about. Note this returns both supported and unsupported groups. To find "
25654 "out which ones the daemon can actually support you have to call L</"
25655 "available> on each member of the returned list."
25660 #: ../fish/guestfish-actions.pod:426
25661 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25666 #: ../fish/guestfish-actions.pod:428
25672 #: ../fish/guestfish-actions.pod:430
25675 " base64-in (base64file|-) filename\n"
25681 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25682 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
25683 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
25684 #: ../fish/guestfish-actions.pod:4631 ../fish/guestfish-actions.pod:4643
25685 #: ../fish/guestfish-actions.pod:4654 ../fish/guestfish-actions.pod:4665
25686 #: ../fish/guestfish-actions.pod:4717 ../fish/guestfish-actions.pod:4726
25687 #: ../fish/guestfish-actions.pod:4780 ../fish/guestfish-actions.pod:4803
25688 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25693 #: ../fish/guestfish-actions.pod:437
25699 #: ../fish/guestfish-actions.pod:439
25702 " base64-out filename (base64file|-)\n"
25708 #: ../fish/guestfish-actions.pod:446
25709 msgid "blockdev-flushbufs"
25714 #: ../fish/guestfish-actions.pod:448
25717 " blockdev-flushbufs device\n"
25723 #: ../fish/guestfish-actions.pod:455
25724 msgid "blockdev-getbsz"
25729 #: ../fish/guestfish-actions.pod:457
25732 " blockdev-getbsz device\n"
25738 #: ../fish/guestfish-actions.pod:466
25739 msgid "blockdev-getro"
25744 #: ../fish/guestfish-actions.pod:468
25747 " blockdev-getro device\n"
25753 #: ../fish/guestfish-actions.pod:475
25754 msgid "blockdev-getsize64"
25759 #: ../fish/guestfish-actions.pod:477
25762 " blockdev-getsize64 device\n"
25768 #: ../fish/guestfish-actions.pod:481
25769 msgid "See also L</blockdev-getsz>."
25774 #: ../fish/guestfish-actions.pod:485
25775 msgid "blockdev-getss"
25780 #: ../fish/guestfish-actions.pod:487
25783 " blockdev-getss device\n"
25789 #: ../fish/guestfish-actions.pod:492
25791 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25796 #: ../fish/guestfish-actions.pod:497
25797 msgid "blockdev-getsz"
25802 #: ../fish/guestfish-actions.pod:499
25805 " blockdev-getsz device\n"
25811 #: ../fish/guestfish-actions.pod:504
25813 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25814 "blockdev-getsize64> for the more useful I<size in bytes>."
25819 #: ../fish/guestfish-actions.pod:510
25820 msgid "blockdev-rereadpt"
25825 #: ../fish/guestfish-actions.pod:512
25828 " blockdev-rereadpt device\n"
25834 #: ../fish/guestfish-actions.pod:518
25835 msgid "blockdev-setbsz"
25840 #: ../fish/guestfish-actions.pod:520
25843 " blockdev-setbsz device blocksize\n"
25849 #: ../fish/guestfish-actions.pod:529
25850 msgid "blockdev-setro"
25855 #: ../fish/guestfish-actions.pod:531
25858 " blockdev-setro device\n"
25864 #: ../fish/guestfish-actions.pod:537
25865 msgid "blockdev-setrw"
25870 #: ../fish/guestfish-actions.pod:539
25873 " blockdev-setrw device\n"
25878 #: ../fish/guestfish-actions.pod:545
25879 msgid "btrfs-filesystem-resize"
25883 #: ../fish/guestfish-actions.pod:547
25886 " btrfs-filesystem-resize mountpoint [size:..]\n"
25892 #: ../fish/guestfish-actions.pod:570
25893 msgid "case-sensitive-path"
25898 #: ../fish/guestfish-actions.pod:572
25901 " case-sensitive-path path\n"
25907 #: ../fish/guestfish-actions.pod:596
25909 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25910 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25911 "the directories were originally created under Windows)."
25916 #: ../fish/guestfish-actions.pod:604
25917 msgid "See also L</realpath>."
25922 #: ../fish/guestfish-actions.pod:606
25928 #: ../fish/guestfish-actions.pod:608
25937 #: ../fish/guestfish-actions.pod:612
25939 "Note that this function cannot correctly handle binary files (specifically, "
25940 "files containing C<\\0> character which is treated as end of string). For "
25941 "those you need to use the L</read-file> or L</download> functions which have "
25942 "a more complex interface."
25947 #: ../fish/guestfish-actions.pod:620
25953 #: ../fish/guestfish-actions.pod:622
25956 " checksum csumtype path\n"
25962 #: ../fish/guestfish-actions.pod:665
25963 msgid "To get the checksum for a device, use L</checksum-device>."
25968 #: ../fish/guestfish-actions.pod:667
25969 msgid "To get the checksums for many files, use L</checksums-out>."
25974 #: ../fish/guestfish-actions.pod:669
25975 msgid "checksum-device"
25980 #: ../fish/guestfish-actions.pod:671
25983 " checksum-device csumtype device\n"
25989 #: ../fish/guestfish-actions.pod:673
25991 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25992 "device named C<device>. For the types of checksums supported see the L</"
25993 "checksum> command."
25998 #: ../fish/guestfish-actions.pod:677
25999 msgid "checksums-out"
26004 #: ../fish/guestfish-actions.pod:679
26007 " checksums-out csumtype directory (sumsfile|-)\n"
26013 #: ../fish/guestfish-actions.pod:695
26019 #: ../fish/guestfish-actions.pod:697
26022 " chmod mode path\n"
26028 #: ../fish/guestfish-actions.pod:708
26034 #: ../fish/guestfish-actions.pod:710
26037 " chown owner group path\n"
26043 #: ../fish/guestfish-actions.pod:718
26049 #: ../fish/guestfish-actions.pod:720
26052 " command 'arguments ...'\n"
26058 #: ../fish/guestfish-actions.pod:727
26060 "The single parameter is an argv-style list of arguments. The first element "
26061 "is the name of the program to run. Subsequent elements are parameters. The "
26062 "list must be non-empty (ie. must contain a program name). Note that the "
26063 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
26068 #: ../fish/guestfish-actions.pod:755
26069 msgid "command-lines"
26074 #: ../fish/guestfish-actions.pod:757
26077 " command-lines 'arguments ...'\n"
26083 #: ../fish/guestfish-actions.pod:759
26085 "This is the same as L</command>, but splits the result into a list of lines."
26090 #: ../fish/guestfish-actions.pod:762
26091 msgid "See also: L</sh-lines>"
26096 #: ../fish/guestfish-actions.pod:767
26102 #: ../fish/guestfish-actions.pod:769
26105 " config qemuparam qemuvalue\n"
26111 #: ../fish/guestfish-actions.pod:780
26117 #: ../fish/guestfish-actions.pod:782
26120 " copy-size src dest size\n"
26126 #: ../fish/guestfish-actions.pod:790
26132 #: ../fish/guestfish-actions.pod:792
26141 #: ../fish/guestfish-actions.pod:797
26147 #: ../fish/guestfish-actions.pod:799
26156 #: ../fish/guestfish-actions.pod:804
26162 #: ../fish/guestfish-actions.pod:806
26171 #: ../fish/guestfish-actions.pod:813
26173 "If the destination is a device, it must be as large or larger than the "
26174 "source file or device, otherwise the copy will fail. This command cannot do "
26175 "partial copies (see L</copy-size>)."
26180 #: ../fish/guestfish-actions.pod:817
26186 #: ../fish/guestfish-actions.pod:819
26195 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
26197 "This command is mostly useful for interactive sessions. It is I<not> "
26198 "intended that you try to parse the output string. Use L</statvfs> from "
26204 #: ../fish/guestfish-actions.pod:827
26210 #: ../fish/guestfish-actions.pod:829
26219 #: ../fish/guestfish-actions.pod:838
26225 #: ../fish/guestfish-actions.pod:840
26234 #: ../fish/guestfish-actions.pod:846
26236 "Another way to get the same information is to enable verbose messages with "
26237 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
26238 "before running the program."
26243 #: ../fish/guestfish-actions.pod:851
26249 #: ../fish/guestfish-actions.pod:853
26252 " download remotefilename (filename|-)\n"
26258 #: ../fish/guestfish-actions.pod:860
26259 msgid "See also L</upload>, L</cat>."
26264 #: ../fish/guestfish-actions.pod:864
26265 msgid "download-offset"
26270 #: ../fish/guestfish-actions.pod:866
26273 " download-offset remotefilename (filename|-) offset size\n"
26279 #: ../fish/guestfish-actions.pod:874
26281 "Note that there is no limit on the amount of data that can be downloaded "
26282 "with this call, unlike with L</pread>, and this call always reads the full "
26283 "amount unless an error occurs."
26288 #: ../fish/guestfish-actions.pod:879
26289 msgid "See also L</download>, L</pread>."
26294 #: ../fish/guestfish-actions.pod:883
26295 msgid "drop-caches"
26300 #: ../fish/guestfish-actions.pod:885
26303 " drop-caches whattodrop\n"
26309 #: ../fish/guestfish-actions.pod:897
26315 #: ../fish/guestfish-actions.pod:899
26324 #: ../fish/guestfish-actions.pod:911
26330 #: ../fish/guestfish-actions.pod:913
26333 " e2fsck-f device\n"
26339 #: ../fish/guestfish-actions.pod:919
26341 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
26342 "should use L</fsck>."
26347 #: ../fish/guestfish-actions.pod:922
26348 msgid "echo-daemon"
26353 #: ../fish/guestfish-actions.pod:924
26356 " echo-daemon 'words ...'\n"
26362 #: ../fish/guestfish-actions.pod:931
26363 msgid "See also L</ping-daemon>."
26368 #: ../fish/guestfish-actions.pod:933
26374 #: ../fish/guestfish-actions.pod:935
26377 " egrep regex path\n"
26383 #: ../fish/guestfish-actions.pod:943
26389 #: ../fish/guestfish-actions.pod:945
26392 " egrepi regex path\n"
26398 #: ../fish/guestfish-actions.pod:953
26404 #: ../fish/guestfish-actions.pod:955
26407 " equal file1 file2\n"
26413 #: ../fish/guestfish-actions.pod:962
26419 #: ../fish/guestfish-actions.pod:964
26428 #: ../fish/guestfish-actions.pod:969
26429 msgid "See also L</is-file>, L</is-dir>, L</stat>."
26434 #: ../fish/guestfish-actions.pod:971
26440 #: ../fish/guestfish-actions.pod:973
26443 " fallocate path len\n"
26449 #: ../fish/guestfish-actions.pod:990
26450 msgid "fallocate64"
26455 #: ../fish/guestfish-actions.pod:992
26458 " fallocate64 path len\n"
26464 #: ../fish/guestfish-actions.pod:998
26466 "Note that this call allocates disk blocks for the file. To create a sparse "
26467 "file use L</truncate-size> instead."
26472 #: ../fish/guestfish-actions.pod:1001
26474 "The deprecated call L</fallocate> does the same, but owing to an oversight "
26475 "it only allowed 30 bit lengths to be specified, effectively limiting the "
26476 "maximum size of files created through that call to 1GB."
26481 #: ../fish/guestfish-actions.pod:1010
26487 #: ../fish/guestfish-actions.pod:1012
26490 " fgrep pattern path\n"
26496 #: ../fish/guestfish-actions.pod:1020
26502 #: ../fish/guestfish-actions.pod:1022
26505 " fgrepi pattern path\n"
26511 #: ../fish/guestfish-actions.pod:1030
26517 #: ../fish/guestfish-actions.pod:1032
26525 #: ../fish/guestfish-actions.pod:1048
26527 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
26528 "(etc), L</is-zero>."
26533 #: ../fish/guestfish-actions.pod:1051
26534 msgid "file-architecture"
26539 #: ../fish/guestfish-actions.pod:1053
26542 " file-architecture filename\n"
26548 #: ../fish/guestfish-actions.pod:1156
26554 #: ../fish/guestfish-actions.pod:1158
26563 #: ../fish/guestfish-actions.pod:1162
26565 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
26566 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
26571 #: ../fish/guestfish-actions.pod:1166
26577 #: ../fish/guestfish-actions.pod:1168
26580 " fill c len path\n"
26586 #: ../fish/guestfish-actions.pod:1174
26588 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26589 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
26590 "L</fill-pattern>."
26595 #: ../fish/guestfish-actions.pod:1179
26596 msgid "fill-pattern"
26601 #: ../fish/guestfish-actions.pod:1181
26604 " fill-pattern pattern len path\n"
26610 #: ../fish/guestfish-actions.pod:1183
26612 "This function is like L</fill> except that it creates a new file of length "
26613 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
26614 "is truncated if necessary to ensure the length of the file is exactly C<len> "
26620 #: ../fish/guestfish-actions.pod:1188
26626 #: ../fish/guestfish-actions.pod:1190
26629 " find directory\n"
26635 #: ../fish/guestfish-actions.pod:1204
26636 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
26641 #: ../fish/guestfish-actions.pod:1217
26642 msgid "See also L</find0>."
26647 #: ../fish/guestfish-actions.pod:1222
26653 #: ../fish/guestfish-actions.pod:1224
26656 " find0 directory (files|-)\n"
26662 #: ../fish/guestfish-actions.pod:1230
26664 "This command works the same way as L</find> with the following exceptions:"
26669 #: ../fish/guestfish-actions.pod:1257
26670 msgid "findfs-label"
26675 #: ../fish/guestfish-actions.pod:1259
26678 " findfs-label label\n"
26684 #: ../fish/guestfish-actions.pod:1265
26685 msgid "To find the label of a filesystem, use L</vfs-label>."
26690 #: ../fish/guestfish-actions.pod:1267
26691 msgid "findfs-uuid"
26696 #: ../fish/guestfish-actions.pod:1269
26699 " findfs-uuid uuid\n"
26705 #: ../fish/guestfish-actions.pod:1275
26706 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26711 #: ../fish/guestfish-actions.pod:1277
26717 #: ../fish/guestfish-actions.pod:1279
26720 " fsck fstype device\n"
26726 #: ../fish/guestfish-actions.pod:1309
26732 #: ../fish/guestfish-actions.pod:1311
26740 #: ../fish/guestfish-actions.pod:1318
26741 msgid "get-attach-method"
26745 #: ../fish/guestfish-actions.pod:1320
26748 " get-attach-method\n"
26753 #: ../fish/guestfish-actions.pod:1322
26754 msgid "Return the current attach method. See L</set-attach-method>."
26759 #: ../fish/guestfish-actions.pod:1324
26760 msgid "get-autosync"
26765 #: ../fish/guestfish-actions.pod:1326
26774 #: ../fish/guestfish-actions.pod:1330
26780 #: ../fish/guestfish-actions.pod:1332
26789 #: ../fish/guestfish-actions.pod:1336
26790 msgid "get-e2label"
26795 #: ../fish/guestfish-actions.pod:1338
26798 " get-e2label device\n"
26804 #: ../fish/guestfish-actions.pod:1350
26810 #: ../fish/guestfish-actions.pod:1352
26813 " get-e2uuid device\n"
26819 #: ../fish/guestfish-actions.pod:1364
26820 msgid "get-memsize"
26825 #: ../fish/guestfish-actions.pod:1366
26834 #: ../fish/guestfish-actions.pod:1371
26836 "If L</set-memsize> was not called on this handle, and if "
26837 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26838 "value for memsize."
26843 #: ../fish/guestfish-actions.pod:1378
26844 msgid "get-network"
26849 #: ../fish/guestfish-actions.pod:1380
26858 #: ../fish/guestfish-actions.pod:1384
26864 #: ../fish/guestfish-actions.pod:1386
26873 #: ../fish/guestfish-actions.pod:1393
26879 #: ../fish/guestfish-actions.pod:1395
26885 #: ../fish/guestfish-actions.pod:1397
26894 #: ../fish/guestfish-actions.pod:1404
26900 #: ../fish/guestfish-actions.pod:1406
26909 #: ../fish/guestfish-actions.pod:1413
26910 msgid "get-recovery-proc"
26915 #: ../fish/guestfish-actions.pod:1415
26918 " get-recovery-proc\n"
26924 #: ../fish/guestfish-actions.pod:1419
26925 msgid "get-selinux"
26930 #: ../fish/guestfish-actions.pod:1421
26939 #: ../fish/guestfish-actions.pod:1423
26941 "This returns the current setting of the selinux flag which is passed to the "
26942 "appliance at boot time. See L</set-selinux>."
26947 #: ../fish/guestfish-actions.pod:1429
26953 #: ../fish/guestfish-actions.pod:1431
26962 #: ../fish/guestfish-actions.pod:1438
26968 #: ../fish/guestfish-actions.pod:1440
26977 #: ../fish/guestfish-actions.pod:1444
26983 #: ../fish/guestfish-actions.pod:1446
26992 #: ../fish/guestfish-actions.pod:1448
26994 "Return the current umask. By default the umask is C<022> unless it has been "
26995 "set by calling L</umask>."
27000 #: ../fish/guestfish-actions.pod:1451
27001 msgid "get-verbose"
27006 #: ../fish/guestfish-actions.pod:1453
27015 #: ../fish/guestfish-actions.pod:1457
27021 #: ../fish/guestfish-actions.pod:1459
27030 #: ../fish/guestfish-actions.pod:1463
27031 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
27036 #: ../fish/guestfish-actions.pod:1466
27042 #: ../fish/guestfish-actions.pod:1468
27045 " getxattr path name\n"
27051 #: ../fish/guestfish-actions.pod:1470
27053 "Get a single extended attribute from file C<path> named C<name>. This call "
27054 "follows symlinks. If you want to lookup an extended attribute for the "
27055 "symlink itself, use L</lgetxattr>."
27060 #: ../fish/guestfish-actions.pod:1474 ../fish/guestfish-actions.pod:2501
27062 "Normally it is better to get all extended attributes from a file in one go "
27063 "by calling L</getxattrs>. However some Linux filesystem implementations are "
27064 "buggy and do not provide a way to list out attributes. For these "
27065 "filesystems (notably ntfs-3g) you have to know the names of the extended "
27066 "attributes you want in advance and call this function."
27071 #: ../fish/guestfish-actions.pod:1484
27072 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
27077 #: ../fish/guestfish-actions.pod:1486
27083 #: ../fish/guestfish-actions.pod:1488
27086 " getxattrs path\n"
27092 #: ../fish/guestfish-actions.pod:1496
27093 msgid "See also: L</lgetxattrs>, L<attr(5)>."
27098 #: ../fish/guestfish-actions.pod:1498
27099 msgid "glob-expand"
27104 #: ../fish/guestfish-actions.pod:1500
27107 " glob-expand pattern\n"
27113 #: ../fish/guestfish-actions.pod:1513
27119 #: ../fish/guestfish-actions.pod:1515
27122 " grep regex path\n"
27128 #: ../fish/guestfish-actions.pod:1523
27134 #: ../fish/guestfish-actions.pod:1525
27137 " grepi regex path\n"
27143 #: ../fish/guestfish-actions.pod:1533
27144 msgid "grub-install"
27149 #: ../fish/guestfish-actions.pod:1535
27152 " grub-install root device\n"
27158 #: ../fish/guestfish-actions.pod:1551
27164 #: ../fish/guestfish-actions.pod:1553
27173 #: ../fish/guestfish-actions.pod:1561
27179 #: ../fish/guestfish-actions.pod:1563
27182 " head-n nrlines path\n"
27188 #: ../fish/guestfish-actions.pod:1576
27194 #: ../fish/guestfish-actions.pod:1578
27203 #: ../fish/guestfish-actions.pod:1586
27209 #: ../fish/guestfish-actions.pod:1588
27212 " initrd-cat initrdpath filename\n"
27218 #: ../fish/guestfish-actions.pod:1600
27219 msgid "See also L</initrd-list>."
27224 #: ../fish/guestfish-actions.pod:1605
27225 msgid "initrd-list"
27230 #: ../fish/guestfish-actions.pod:1607
27233 " initrd-list path\n"
27239 #: ../fish/guestfish-actions.pod:1619
27240 msgid "inotify-add-watch"
27245 #: ../fish/guestfish-actions.pod:1621
27248 " inotify-add-watch path mask\n"
27254 #: ../fish/guestfish-actions.pod:1633
27255 msgid "inotify-close"
27260 #: ../fish/guestfish-actions.pod:1635
27269 #: ../fish/guestfish-actions.pod:1641
27270 msgid "inotify-files"
27275 #: ../fish/guestfish-actions.pod:1643
27284 #: ../fish/guestfish-actions.pod:1645
27286 "This function is a helpful wrapper around L</inotify-read> which just "
27287 "returns a list of pathnames of objects that were touched. The returned "
27288 "pathnames are sorted and deduplicated."
27293 #: ../fish/guestfish-actions.pod:1649
27294 msgid "inotify-init"
27299 #: ../fish/guestfish-actions.pod:1651
27302 " inotify-init maxevents\n"
27308 #: ../fish/guestfish-actions.pod:1657
27310 "C<maxevents> is the maximum number of events which will be queued up between "
27311 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
27312 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
27313 "default was 16384 events. Beyond this limit, the kernel throws away events, "
27314 "but records the fact that it threw them away by setting a flag "
27315 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
27320 #: ../fish/guestfish-actions.pod:1667
27322 "Before any events are generated, you have to add some watches to the "
27323 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
27324 "L</inotify-watch-all>."
27329 #: ../fish/guestfish-actions.pod:1673
27331 "Queued up events should be read periodically by calling L</inotify-read> (or "
27332 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
27333 "If you don't read the events out often enough then you risk the internal "
27334 "queue overflowing."
27339 #: ../fish/guestfish-actions.pod:1680
27341 "The handle should be closed after use by calling L</inotify-close>. This "
27342 "also removes any watches automatically."
27347 #: ../fish/guestfish-actions.pod:1689
27348 msgid "inotify-read"
27353 #: ../fish/guestfish-actions.pod:1691
27362 #: ../fish/guestfish-actions.pod:1704
27363 msgid "inotify-rm-watch"
27368 #: ../fish/guestfish-actions.pod:1706
27371 " inotify-rm-watch wd\n"
27377 #: ../fish/guestfish-actions.pod:1708
27378 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
27383 #: ../fish/guestfish-actions.pod:1711
27384 msgid "inspect-get-arch"
27389 #: ../fish/guestfish-actions.pod:1713
27392 " inspect-get-arch root\n"
27398 #: ../fish/guestfish-actions.pod:1715
27400 "This returns the architecture of the inspected operating system. The "
27401 "possible return values are listed under L</file-architecture>."
27406 #: ../fish/guestfish-actions.pod:1724
27407 msgid "inspect-get-distro"
27412 #: ../fish/guestfish-actions.pod:1726
27415 " inspect-get-distro root\n"
27420 #: ../fish/guestfish-actions.pod:1807
27421 msgid "inspect-get-drive-mappings"
27425 #: ../fish/guestfish-actions.pod:1809
27428 " inspect-get-drive-mappings root\n"
27433 #: ../fish/guestfish-actions.pod:1836
27435 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27436 "get-mountpoints>, L</inspect-get-filesystems>."
27441 #: ../fish/guestfish-actions.pod:1840
27442 msgid "inspect-get-filesystems"
27447 #: ../fish/guestfish-actions.pod:1842
27450 " inspect-get-filesystems root\n"
27456 #: ../fish/guestfish-actions.pod:1852
27458 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27459 "get-mountpoints>."
27463 #: ../fish/guestfish-actions.pod:1855
27464 msgid "inspect-get-format"
27468 #: ../fish/guestfish-actions.pod:1857
27471 " inspect-get-format root\n"
27477 #: ../fish/guestfish-actions.pod:1886
27478 msgid "inspect-get-hostname"
27483 #: ../fish/guestfish-actions.pod:1888
27486 " inspect-get-hostname root\n"
27491 #: ../fish/guestfish-actions.pod:1898
27492 msgid "inspect-get-icon"
27496 #: ../fish/guestfish-actions.pod:1900
27499 " inspect-get-icon root [favicon:..] [highquality:..]\n"
27505 #: ../fish/guestfish-actions.pod:1964
27506 msgid "inspect-get-major-version"
27511 #: ../fish/guestfish-actions.pod:1966
27514 " inspect-get-major-version root\n"
27520 #: ../fish/guestfish-actions.pod:1982
27521 msgid "inspect-get-minor-version"
27526 #: ../fish/guestfish-actions.pod:1984
27529 " inspect-get-minor-version root\n"
27535 #: ../fish/guestfish-actions.pod:1991
27537 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27538 "get-major-version>."
27543 #: ../fish/guestfish-actions.pod:1994
27544 msgid "inspect-get-mountpoints"
27549 #: ../fish/guestfish-actions.pod:1996
27552 " inspect-get-mountpoints root\n"
27557 #: ../fish/guestfish-actions.pod:2015
27559 "For operating systems like Windows which still use drive letters, this call "
27560 "will only return an entry for the first drive \"mounted on\" C</>. For "
27561 "information about the mapping of drive letters to partitions, see L</inspect-"
27562 "get-drive-mappings>."
27567 #: ../fish/guestfish-actions.pod:2021
27569 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27570 "get-filesystems>."
27575 #: ../fish/guestfish-actions.pod:2024
27576 msgid "inspect-get-package-format"
27581 #: ../fish/guestfish-actions.pod:2026
27584 " inspect-get-package-format root\n"
27590 #: ../fish/guestfish-actions.pod:2028
27592 "This function and L</inspect-get-package-management> return the package "
27593 "format and package management tool used by the inspected operating system. "
27594 "For example for Fedora these functions would return C<rpm> (package format) "
27595 "and C<yum> (package management)."
27600 #: ../fish/guestfish-actions.pod:2043
27601 msgid "inspect-get-package-management"
27606 #: ../fish/guestfish-actions.pod:2045
27609 " inspect-get-package-management root\n"
27615 #: ../fish/guestfish-actions.pod:2047
27617 "L</inspect-get-package-format> and this function return the package format "
27618 "and package management tool used by the inspected operating system. For "
27619 "example for Fedora these functions would return C<rpm> (package format) and "
27620 "C<yum> (package management)."
27625 #: ../fish/guestfish-actions.pod:2064
27626 msgid "inspect-get-product-name"
27631 #: ../fish/guestfish-actions.pod:2066
27634 " inspect-get-product-name root\n"
27639 #: ../fish/guestfish-actions.pod:2078
27640 msgid "inspect-get-product-variant"
27644 #: ../fish/guestfish-actions.pod:2080
27647 " inspect-get-product-variant root\n"
27652 #: ../fish/guestfish-actions.pod:2101
27654 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27655 "get-product-name>, L</inspect-get-major-version>."
27660 #: ../fish/guestfish-actions.pod:2105
27661 msgid "inspect-get-roots"
27666 #: ../fish/guestfish-actions.pod:2107
27669 " inspect-get-roots\n"
27675 #: ../fish/guestfish-actions.pod:2109
27677 "This function is a convenient way to get the list of root devices, as "
27678 "returned from a previous call to L</inspect-os>, but without redoing the "
27679 "whole inspection process."
27684 #: ../fish/guestfish-actions.pod:2113
27686 "This returns an empty list if either no root devices were found or the "
27687 "caller has not called L</inspect-os>."
27692 #: ../fish/guestfish-actions.pod:2118
27693 msgid "inspect-get-type"
27698 #: ../fish/guestfish-actions.pod:2120
27701 " inspect-get-type root\n"
27706 #: ../fish/guestfish-actions.pod:2150
27707 msgid "inspect-get-windows-current-control-set"
27711 #: ../fish/guestfish-actions.pod:2152
27714 " inspect-get-windows-current-control-set root\n"
27720 #: ../fish/guestfish-actions.pod:2163
27721 msgid "inspect-get-windows-systemroot"
27726 #: ../fish/guestfish-actions.pod:2165
27729 " inspect-get-windows-systemroot root\n"
27734 #: ../fish/guestfish-actions.pod:2176
27735 msgid "inspect-is-live"
27739 #: ../fish/guestfish-actions.pod:2178
27742 " inspect-is-live root\n"
27747 #: ../fish/guestfish-actions.pod:2180
27749 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27750 "then this returns true if a live image was detected on the disk."
27754 #: ../fish/guestfish-actions.pod:2186
27755 msgid "inspect-is-multipart"
27759 #: ../fish/guestfish-actions.pod:2188
27762 " inspect-is-multipart root\n"
27767 #: ../fish/guestfish-actions.pod:2190
27769 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27770 "then this returns true if the disk is part of a set."
27774 #: ../fish/guestfish-actions.pod:2196
27775 msgid "inspect-is-netinst"
27779 #: ../fish/guestfish-actions.pod:2198
27782 " inspect-is-netinst root\n"
27787 #: ../fish/guestfish-actions.pod:2200
27789 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27790 "then this returns true if the disk is a network installer, ie. not a self-"
27791 "contained install CD but one which is likely to require network access to "
27792 "complete the install."
27797 #: ../fish/guestfish-actions.pod:2208
27798 msgid "inspect-list-applications"
27803 #: ../fish/guestfish-actions.pod:2210
27806 " inspect-list-applications root\n"
27812 #: ../fish/guestfish-actions.pod:2214
27814 "I<Note:> This call works differently from other parts of the inspection "
27815 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27816 "then mount up the disks, before calling this. Listing applications is a "
27817 "significantly more difficult operation which requires access to the full "
27818 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27819 "are just returning data cached in the libguestfs handle, this call actually "
27820 "reads parts of the mounted filesystems during the call."
27825 #: ../fish/guestfish-actions.pod:2304
27831 #: ../fish/guestfish-actions.pod:2306
27840 #: ../fish/guestfish-actions.pod:2321
27842 "You can pass the root string(s) returned to other L</inspect-get-*> "
27843 "functions in order to query further information about each operating system, "
27844 "such as the name and version."
27849 #: ../fish/guestfish-actions.pod:2326
27851 "This function uses other libguestfs features such as L</mount-ro> and L</"
27852 "umount-all> in order to mount and unmount filesystems and look at the "
27853 "contents. This should be called with no disks currently mounted. The "
27854 "function may also use Augeas, so any existing Augeas handle will be closed."
27859 #: ../fish/guestfish-actions.pod:2338 ../fish/guestfish-actions.pod:2536
27860 #: ../fish/guestfish-actions.pod:2595
27861 msgid "See also L</list-filesystems>."
27866 #: ../fish/guestfish-actions.pod:2340
27867 msgid "is-blockdev"
27872 #: ../fish/guestfish-actions.pod:2342
27875 " is-blockdev path\n"
27881 #: ../fish/guestfish-actions.pod:2347 ../fish/guestfish-actions.pod:2365
27882 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2393
27883 #: ../fish/guestfish-actions.pod:2403 ../fish/guestfish-actions.pod:2437
27884 #: ../fish/guestfish-actions.pod:2446
27885 msgid "See also L</stat>."
27890 #: ../fish/guestfish-actions.pod:2349
27896 #: ../fish/guestfish-actions.pod:2351
27905 #: ../fish/guestfish-actions.pod:2358
27911 #: ../fish/guestfish-actions.pod:2360
27914 " is-chardev path\n"
27920 #: ../fish/guestfish-actions.pod:2367
27926 #: ../fish/guestfish-actions.pod:2369
27935 #: ../fish/guestfish-actions.pod:2376
27941 #: ../fish/guestfish-actions.pod:2378
27950 #: ../fish/guestfish-actions.pod:2386
27956 #: ../fish/guestfish-actions.pod:2388
27965 #: ../fish/guestfish-actions.pod:2395
27971 #: ../fish/guestfish-actions.pod:2397
27980 #: ../fish/guestfish-actions.pod:2405
27981 msgid "is-launching"
27986 #: ../fish/guestfish-actions.pod:2407
27995 #: ../fish/guestfish-actions.pod:2414
28001 #: ../fish/guestfish-actions.pod:2416
28010 #: ../fish/guestfish-actions.pod:2421
28016 #: ../fish/guestfish-actions.pod:2423
28025 #: ../fish/guestfish-actions.pod:2430
28031 #: ../fish/guestfish-actions.pod:2432
28034 " is-socket path\n"
28040 #: ../fish/guestfish-actions.pod:2439
28046 #: ../fish/guestfish-actions.pod:2441
28049 " is-symlink path\n"
28054 #: ../fish/guestfish-actions.pod:2448
28059 #: ../fish/guestfish-actions.pod:2450
28067 #: ../fish/guestfish-actions.pod:2455
28068 msgid "is-zero-device"
28072 #: ../fish/guestfish-actions.pod:2457
28075 " is-zero-device device\n"
28081 #: ../fish/guestfish-actions.pod:2463
28082 msgid "kill-subprocess"
28087 #: ../fish/guestfish-actions.pod:2465
28090 " kill-subprocess\n"
28096 #: ../fish/guestfish-actions.pod:2469
28102 #: ../fish/guestfish-actions.pod:2471
28108 #: ../fish/guestfish-actions.pod:2473
28117 #: ../fish/guestfish-actions.pod:2481
28123 #: ../fish/guestfish-actions.pod:2483
28126 " lchown owner group path\n"
28132 #: ../fish/guestfish-actions.pod:2485
28134 "Change the file owner to C<owner> and group to C<group>. This is like L</"
28135 "chown> but if C<path> is a symlink then the link itself is changed, not the "
28141 #: ../fish/guestfish-actions.pod:2493
28147 #: ../fish/guestfish-actions.pod:2495
28150 " lgetxattr path name\n"
28156 #: ../fish/guestfish-actions.pod:2511
28157 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
28162 #: ../fish/guestfish-actions.pod:2513
28168 #: ../fish/guestfish-actions.pod:2515
28171 " lgetxattrs path\n"
28177 #: ../fish/guestfish-actions.pod:2517
28179 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
28180 "it returns the extended attributes of the link itself."
28184 #: ../fish/guestfish-actions.pod:2521
28189 #: ../fish/guestfish-actions.pod:2523
28198 #: ../fish/guestfish-actions.pod:2528
28199 msgid "list-devices"
28204 #: ../fish/guestfish-actions.pod:2530
28212 #: ../fish/guestfish-actions.pod:2538
28213 msgid "list-dm-devices"
28217 #: ../fish/guestfish-actions.pod:2540
28220 " list-dm-devices\n"
28225 #: ../fish/guestfish-actions.pod:2544
28227 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
28228 "previous call to L</luks-open>."
28232 #: ../fish/guestfish-actions.pod:2547
28234 "Device mapper devices which correspond to logical volumes are I<not> "
28235 "returned in this list. Call L</lvs> if you want to list logical volumes."
28240 #: ../fish/guestfish-actions.pod:2551
28241 msgid "list-filesystems"
28246 #: ../fish/guestfish-actions.pod:2553
28249 " list-filesystems\n"
28255 #: ../fish/guestfish-actions.pod:2572
28257 "This command runs other libguestfs commands, which might include L</mount> "
28258 "and L</umount>, and therefore you should use this soon after launch and only "
28259 "when nothing is mounted."
28264 #: ../fish/guestfish-actions.pod:2576
28266 "Not all of the filesystems returned will be mountable. In particular, swap "
28267 "partitions are returned in the list. Also this command does not check that "
28268 "each filesystem found is valid and mountable, and some filesystems might be "
28269 "mountable but require special options. Filesystems may not all belong to a "
28270 "single logical operating system (use L</inspect-os> to look for OSes)."
28275 #: ../fish/guestfish-actions.pod:2584
28276 msgid "list-partitions"
28281 #: ../fish/guestfish-actions.pod:2586
28284 " list-partitions\n"
28290 #: ../fish/guestfish-actions.pod:2592
28292 "This does not return logical volumes. For that you will need to call L</"
28298 #: ../fish/guestfish-actions.pod:2597
28304 #: ../fish/guestfish-actions.pod:2599
28313 #: ../fish/guestfish-actions.pod:2607
28319 #: ../fish/guestfish-actions.pod:2609
28322 " ln target linkname\n"
28328 #: ../fish/guestfish-actions.pod:2613
28334 #: ../fish/guestfish-actions.pod:2615
28337 " ln-f target linkname\n"
28343 #: ../fish/guestfish-actions.pod:2620
28349 #: ../fish/guestfish-actions.pod:2622
28352 " ln-s target linkname\n"
28358 #: ../fish/guestfish-actions.pod:2626
28364 #: ../fish/guestfish-actions.pod:2628
28367 " ln-sf target linkname\n"
28373 #: ../fish/guestfish-actions.pod:2633
28374 msgid "lremovexattr"
28379 #: ../fish/guestfish-actions.pod:2635
28382 " lremovexattr xattr path\n"
28388 #: ../fish/guestfish-actions.pod:2637
28390 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
28391 "it removes an extended attribute of the link itself."
28396 #: ../fish/guestfish-actions.pod:2641
28402 #: ../fish/guestfish-actions.pod:2643
28411 #: ../fish/guestfish-actions.pod:2649
28413 "This command is mostly useful for interactive sessions. Programs should "
28414 "probably use L</readdir> instead."
28419 #: ../fish/guestfish-actions.pod:2652
28425 #: ../fish/guestfish-actions.pod:2654
28428 " lsetxattr xattr val vallen path\n"
28434 #: ../fish/guestfish-actions.pod:2656
28436 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
28437 "sets an extended attribute of the link itself."
28442 #: ../fish/guestfish-actions.pod:2660
28448 #: ../fish/guestfish-actions.pod:2662
28457 #: ../fish/guestfish-actions.pod:2666
28459 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
28460 "the link is stat-ed, not the file it refers to."
28465 #: ../fish/guestfish-actions.pod:2672
28471 #: ../fish/guestfish-actions.pod:2674
28474 " lstatlist path 'names ...'\n"
28480 #: ../fish/guestfish-actions.pod:2676
28482 "This call allows you to perform the L</lstat> operation on multiple files, "
28483 "where all files are in the directory C<path>. C<names> is the list of files "
28484 "from this directory."
28489 #: ../fish/guestfish-actions.pod:2685
28491 "This call is intended for programs that want to efficiently list a directory "
28492 "contents without making many round-trips. See also L</lxattrlist> for a "
28493 "similarly efficient call for getting extended attributes. Very long "
28494 "directory listings might cause the protocol message size to be exceeded, "
28495 "causing this call to fail. The caller must split up such requests into "
28496 "smaller groups of names."
28501 #: ../fish/guestfish-actions.pod:2693
28502 msgid "luks-add-key"
28507 #: ../fish/guestfish-actions.pod:2695
28510 " luks-add-key device keyslot\n"
28516 #: ../fish/guestfish-actions.pod:2702
28518 "Note that if C<keyslot> already contains a key, then this command will "
28519 "fail. You have to use L</luks-kill-slot> first to remove that key."
28524 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2728
28525 #: ../fish/guestfish-actions.pod:2741 ../fish/guestfish-actions.pod:2755
28526 #: ../fish/guestfish-actions.pod:2781 ../fish/guestfish-actions.pod:2791
28528 "This command has one or more key or passphrase parameters. Guestfish will "
28529 "prompt for these separately."
28534 #: ../fish/guestfish-actions.pod:2709
28540 #: ../fish/guestfish-actions.pod:2711
28543 " luks-close device\n"
28549 #: ../fish/guestfish-actions.pod:2713
28551 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
28552 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
28553 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
28559 #: ../fish/guestfish-actions.pod:2719
28560 msgid "luks-format"
28565 #: ../fish/guestfish-actions.pod:2721
28568 " luks-format device keyslot\n"
28574 #: ../fish/guestfish-actions.pod:2734
28575 msgid "luks-format-cipher"
28580 #: ../fish/guestfish-actions.pod:2736
28583 " luks-format-cipher device keyslot cipher\n"
28589 #: ../fish/guestfish-actions.pod:2738
28591 "This command is the same as L</luks-format> but it also allows you to set "
28592 "the C<cipher> used."
28597 #: ../fish/guestfish-actions.pod:2747
28598 msgid "luks-kill-slot"
28603 #: ../fish/guestfish-actions.pod:2749
28606 " luks-kill-slot device keyslot\n"
28612 #: ../fish/guestfish-actions.pod:2758
28618 #: ../fish/guestfish-actions.pod:2760
28621 " luks-open device mapname\n"
28627 #: ../fish/guestfish-actions.pod:2774
28629 "If this block device contains LVM volume groups, then calling L</vgscan> "
28630 "followed by L</vg-activate-all> will make them visible."
28634 #: ../fish/guestfish-actions.pod:2778
28635 msgid "Use L</list-dm-devices> to list all device mapper devices."
28640 #: ../fish/guestfish-actions.pod:2784
28641 msgid "luks-open-ro"
28646 #: ../fish/guestfish-actions.pod:2786
28649 " luks-open-ro device mapname\n"
28655 #: ../fish/guestfish-actions.pod:2788
28657 "This is the same as L</luks-open> except that a read-only mapping is created."
28662 #: ../fish/guestfish-actions.pod:2794
28668 #: ../fish/guestfish-actions.pod:2796
28671 " lvcreate logvol volgroup mbytes\n"
28677 #: ../fish/guestfish-actions.pod:2801
28678 msgid "lvm-canonical-lv-name"
28683 #: ../fish/guestfish-actions.pod:2803
28686 " lvm-canonical-lv-name lvname\n"
28692 #: ../fish/guestfish-actions.pod:2812
28693 msgid "See also L</is-lv>."
28698 #: ../fish/guestfish-actions.pod:2814
28699 msgid "lvm-clear-filter"
28704 #: ../fish/guestfish-actions.pod:2816
28707 " lvm-clear-filter\n"
28713 #: ../fish/guestfish-actions.pod:2818
28715 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
28721 #: ../fish/guestfish-actions.pod:2824
28722 msgid "lvm-remove-all"
28727 #: ../fish/guestfish-actions.pod:2826
28730 " lvm-remove-all\n"
28736 #: ../fish/guestfish-actions.pod:2834
28737 msgid "lvm-set-filter"
28742 #: ../fish/guestfish-actions.pod:2836
28745 " lvm-set-filter 'devices ...'\n"
28751 #: ../fish/guestfish-actions.pod:2861
28757 #: ../fish/guestfish-actions.pod:2863
28760 " lvremove device\n"
28766 #: ../fish/guestfish-actions.pod:2871
28772 #: ../fish/guestfish-actions.pod:2873
28775 " lvrename logvol newlogvol\n"
28781 #: ../fish/guestfish-actions.pod:2877
28787 #: ../fish/guestfish-actions.pod:2879
28790 " lvresize device mbytes\n"
28796 #: ../fish/guestfish-actions.pod:2885
28797 msgid "lvresize-free"
28802 #: ../fish/guestfish-actions.pod:2887
28805 " lvresize-free lv percent\n"
28811 #: ../fish/guestfish-actions.pod:2895
28817 #: ../fish/guestfish-actions.pod:2897
28826 #: ../fish/guestfish-actions.pod:2905
28827 msgid "See also L</lvs-full>, L</list-filesystems>."
28832 #: ../fish/guestfish-actions.pod:2907
28838 #: ../fish/guestfish-actions.pod:2909
28847 #: ../fish/guestfish-actions.pod:2914
28853 #: ../fish/guestfish-actions.pod:2916
28862 #: ../fish/guestfish-actions.pod:2920
28868 #: ../fish/guestfish-actions.pod:2922
28871 " lxattrlist path 'names ...'\n"
28877 #: ../fish/guestfish-actions.pod:2938
28879 "This call is intended for programs that want to efficiently list a directory "
28880 "contents without making many round-trips. See also L</lstatlist> for a "
28881 "similarly efficient call for getting standard stats. Very long directory "
28882 "listings might cause the protocol message size to be exceeded, causing this "
28883 "call to fail. The caller must split up such requests into smaller groups of "
28889 #: ../fish/guestfish-actions.pod:2946
28895 #: ../fish/guestfish-actions.pod:2948
28904 #: ../fish/guestfish-actions.pod:2952
28910 #: ../fish/guestfish-actions.pod:2954
28913 " mkdir-mode path mode\n"
28919 #: ../fish/guestfish-actions.pod:2963
28920 msgid "See also L</mkdir>, L</umask>"
28925 #: ../fish/guestfish-actions.pod:2965
28931 #: ../fish/guestfish-actions.pod:2967
28940 #: ../fish/guestfish-actions.pod:2972
28946 #: ../fish/guestfish-actions.pod:2974
28949 " mkdtemp template\n"
28955 #: ../fish/guestfish-actions.pod:2995
28961 #: ../fish/guestfish-actions.pod:2997
28964 " mke2fs-J fstype blocksize device journal\n"
28970 #: ../fish/guestfish-actions.pod:3005
28971 msgid "See also L</mke2journal>."
28976 #: ../fish/guestfish-actions.pod:3007
28982 #: ../fish/guestfish-actions.pod:3009
28985 " mke2fs-JL fstype blocksize device label\n"
28991 #: ../fish/guestfish-actions.pod:3014
28992 msgid "See also L</mke2journal-L>."
28997 #: ../fish/guestfish-actions.pod:3016
29003 #: ../fish/guestfish-actions.pod:3018
29006 " mke2fs-JU fstype blocksize device uuid\n"
29012 #: ../fish/guestfish-actions.pod:3023
29013 msgid "See also L</mke2journal-U>."
29018 #: ../fish/guestfish-actions.pod:3025
29019 msgid "mke2journal"
29024 #: ../fish/guestfish-actions.pod:3027
29027 " mke2journal blocksize device\n"
29033 #: ../fish/guestfish-actions.pod:3034
29034 msgid "mke2journal-L"
29039 #: ../fish/guestfish-actions.pod:3036
29042 " mke2journal-L blocksize label device\n"
29048 #: ../fish/guestfish-actions.pod:3040
29049 msgid "mke2journal-U"
29054 #: ../fish/guestfish-actions.pod:3042
29057 " mke2journal-U blocksize uuid device\n"
29063 #: ../fish/guestfish-actions.pod:3046
29069 #: ../fish/guestfish-actions.pod:3048
29072 " mkfifo mode path\n"
29078 #: ../fish/guestfish-actions.pod:3050
29080 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
29081 "is just a convenient wrapper around L</mknod>."
29086 #: ../fish/guestfish-actions.pod:3056
29092 #: ../fish/guestfish-actions.pod:3058
29095 " mkfs fstype device\n"
29101 #: ../fish/guestfish-actions.pod:3064
29107 #: ../fish/guestfish-actions.pod:3066
29110 " mkfs-b fstype blocksize device\n"
29116 #: ../fish/guestfish-actions.pod:3068
29118 "This call is similar to L</mkfs>, but it allows you to control the block "
29119 "size of the resulting filesystem. Supported block sizes depend on the "
29120 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
29125 #: ../fish/guestfish-actions.pod:3083
29130 #: ../fish/guestfish-actions.pod:3085
29133 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
29139 #: ../fish/guestfish-actions.pod:3130
29140 msgid "mkmountpoint"
29145 #: ../fish/guestfish-actions.pod:3132
29148 " mkmountpoint exemptpath\n"
29154 #: ../fish/guestfish-actions.pod:3134
29156 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
29157 "to create extra mountpoints before mounting the first filesystem."
29162 #: ../fish/guestfish-actions.pod:3158
29164 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
29165 "unexpected errors if you try to mix these calls. It is safest to manually "
29166 "unmount filesystems and remove mountpoints after use."
29171 #: ../fish/guestfish-actions.pod:3162
29173 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
29174 "for this to work for manual mountpoints, you must ensure that the innermost "
29175 "mountpoints have the longest pathnames, as in the example code above."
29179 #: ../fish/guestfish-actions.pod:3169
29181 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
29182 "L</umount-all> to be called when the handle is closed which can also trigger "
29188 #: ../fish/guestfish-actions.pod:3173
29194 #: ../fish/guestfish-actions.pod:3175
29197 " mknod mode devmajor devminor path\n"
29203 #: ../fish/guestfish-actions.pod:3185
29205 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
29206 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
29207 "regular file). These constants are available in the standard Linux header "
29208 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
29209 "wrappers around this command which bitwise OR in the appropriate constant "
29215 #: ../fish/guestfish-actions.pod:3195
29221 #: ../fish/guestfish-actions.pod:3197
29224 " mknod-b mode devmajor devminor path\n"
29230 #: ../fish/guestfish-actions.pod:3199
29232 "This call creates a block device node called C<path> with mode C<mode> and "
29233 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29234 "wrapper around L</mknod>."
29239 #: ../fish/guestfish-actions.pod:3205
29245 #: ../fish/guestfish-actions.pod:3207
29248 " mknod-c mode devmajor devminor path\n"
29254 #: ../fish/guestfish-actions.pod:3209
29256 "This call creates a char device node called C<path> with mode C<mode> and "
29257 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29258 "wrapper around L</mknod>."
29263 #: ../fish/guestfish-actions.pod:3215
29269 #: ../fish/guestfish-actions.pod:3217
29278 #: ../fish/guestfish-actions.pod:3221
29284 #: ../fish/guestfish-actions.pod:3223
29287 " mkswap-L label device\n"
29293 #: ../fish/guestfish-actions.pod:3231
29299 #: ../fish/guestfish-actions.pod:3233
29302 " mkswap-U uuid device\n"
29308 #: ../fish/guestfish-actions.pod:3237
29309 msgid "mkswap-file"
29314 #: ../fish/guestfish-actions.pod:3239
29317 " mkswap-file path\n"
29323 #: ../fish/guestfish-actions.pod:3243
29325 "This command just writes a swap file signature to an existing file. To "
29326 "create the file itself, use something like L</fallocate>."
29331 #: ../fish/guestfish-actions.pod:3246
29337 #: ../fish/guestfish-actions.pod:3248
29340 " modprobe modulename\n"
29346 #: ../fish/guestfish-actions.pod:3255
29352 #: ../fish/guestfish-actions.pod:3257
29355 " mount device mountpoint\n"
29361 #: ../fish/guestfish-actions.pod:3273
29363 "B<Important note:> When you use this call, the filesystem options C<sync> "
29364 "and C<noatime> are set implicitly. This was originally done because we "
29365 "thought it would improve reliability, but it turns out that I<-o sync> has a "
29366 "very large negative performance impact and negligible effect on "
29367 "reliability. Therefore we recommend that you avoid using L</mount> in any "
29368 "code that needs performance, and instead use L</mount-options> (use an empty "
29369 "string for the first parameter if you don't want any options)."
29373 #: ../fish/guestfish-actions.pod:3290
29378 #: ../fish/guestfish-actions.pod:3292
29381 " mount-9p mounttag mountpoint [options:..]\n"
29387 #: ../fish/guestfish-actions.pod:3303
29393 #: ../fish/guestfish-actions.pod:3305
29396 " mount-loop file mountpoint\n"
29402 #: ../fish/guestfish-actions.pod:3311
29403 msgid "mount-options"
29408 #: ../fish/guestfish-actions.pod:3313
29411 " mount-options options device mountpoint\n"
29417 #: ../fish/guestfish-actions.pod:3315
29419 "This is the same as the L</mount> command, but it allows you to set the "
29420 "mount options as for the L<mount(8)> I<-o> flag."
29425 #: ../fish/guestfish-actions.pod:3323
29431 #: ../fish/guestfish-actions.pod:3325
29434 " mount-ro device mountpoint\n"
29440 #: ../fish/guestfish-actions.pod:3327
29442 "This is the same as the L</mount> command, but it mounts the filesystem with "
29443 "the read-only (I<-o ro>) flag."
29448 #: ../fish/guestfish-actions.pod:3330
29454 #: ../fish/guestfish-actions.pod:3332
29457 " mount-vfs options vfstype device mountpoint\n"
29463 #: ../fish/guestfish-actions.pod:3334
29465 "This is the same as the L</mount> command, but it allows you to set both the "
29466 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
29471 #: ../fish/guestfish-actions.pod:3338
29472 msgid "mountpoints"
29477 #: ../fish/guestfish-actions.pod:3340
29486 #: ../fish/guestfish-actions.pod:3342
29488 "This call is similar to L</mounts>. That call returns a list of devices. "
29489 "This one returns a hash table (map) of device name to directory where the "
29490 "device is mounted."
29495 #: ../fish/guestfish-actions.pod:3346
29501 #: ../fish/guestfish-actions.pod:3348
29510 #: ../fish/guestfish-actions.pod:3355
29511 msgid "See also: L</mountpoints>"
29516 #: ../fish/guestfish-actions.pod:3357
29522 #: ../fish/guestfish-actions.pod:3359
29531 #: ../fish/guestfish-actions.pod:3364
29532 msgid "ntfs-3g-probe"
29537 #: ../fish/guestfish-actions.pod:3366
29540 " ntfs-3g-probe true|false device\n"
29546 #: ../fish/guestfish-actions.pod:3380
29552 #: ../fish/guestfish-actions.pod:3382
29555 " ntfsresize device\n"
29560 #: ../fish/guestfish-actions.pod:3404
29561 msgid "ntfsresize-opts"
29565 #: ../fish/guestfish-actions.pod:3406
29568 " ntfsresize-opts device [size:..] [force:..]\n"
29573 #: ../fish/guestfish-actions.pod:3425
29575 "After the resize operation, the filesystem is always marked as requiring a "
29576 "consistency check (for safety). You have to boot into Windows to perform "
29577 "this check and clear this condition. If you I<don't> set the C<force> "
29578 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
29579 "a single filesystem without booting into Windows between each resize."
29584 #: ../fish/guestfish-actions.pod:3438
29585 msgid "ntfsresize-size"
29590 #: ../fish/guestfish-actions.pod:3440
29593 " ntfsresize-size device size\n"
29599 #: ../fish/guestfish-actions.pod:3442
29601 "This command is the same as L</ntfsresize> except that it allows you to "
29602 "specify the new size (in bytes) explicitly."
29607 #: ../fish/guestfish-actions.pod:3452
29613 #: ../fish/guestfish-actions.pod:3454
29616 " part-add device prlogex startsect endsect\n"
29622 #: ../fish/guestfish-actions.pod:3456
29624 "This command adds a partition to C<device>. If there is no partition table "
29625 "on the device, call L</part-init> first."
29630 #: ../fish/guestfish-actions.pod:3468
29632 "Creating a partition which covers the whole disk is not so easy. Use L</"
29633 "part-disk> to do that."
29638 #: ../fish/guestfish-actions.pod:3471
29644 #: ../fish/guestfish-actions.pod:3473
29647 " part-del device partnum\n"
29653 #: ../fish/guestfish-actions.pod:3481
29659 #: ../fish/guestfish-actions.pod:3483
29662 " part-disk device parttype\n"
29668 #: ../fish/guestfish-actions.pod:3485
29670 "This command is simply a combination of L</part-init> followed by L</part-"
29671 "add> to create a single primary partition covering the whole disk."
29676 #: ../fish/guestfish-actions.pod:3489
29678 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29679 "possible values are described in L</part-init>."
29684 #: ../fish/guestfish-actions.pod:3495
29685 msgid "part-get-bootable"
29690 #: ../fish/guestfish-actions.pod:3497
29693 " part-get-bootable device partnum\n"
29699 #: ../fish/guestfish-actions.pod:3502
29700 msgid "See also L</part-set-bootable>."
29705 #: ../fish/guestfish-actions.pod:3504
29706 msgid "part-get-mbr-id"
29711 #: ../fish/guestfish-actions.pod:3506
29714 " part-get-mbr-id device partnum\n"
29720 #: ../fish/guestfish-actions.pod:3511 ../fish/guestfish-actions.pod:3649
29722 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29723 "undefined results for other partition table types (see L</part-get-"
29729 #: ../fish/guestfish-actions.pod:3515
29730 msgid "part-get-parttype"
29735 #: ../fish/guestfish-actions.pod:3517
29738 " part-get-parttype device\n"
29744 #: ../fish/guestfish-actions.pod:3522
29746 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29747 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29748 "possible, although unusual. See L</part-init> for a full list."
29753 #: ../fish/guestfish-actions.pod:3527
29759 #: ../fish/guestfish-actions.pod:3529
29762 " part-init device parttype\n"
29768 #: ../fish/guestfish-actions.pod:3535
29770 "Initially there are no partitions. Following this, you should call L</part-"
29771 "add> for each partition required."
29776 #: ../fish/guestfish-actions.pod:3598
29782 #: ../fish/guestfish-actions.pod:3600
29785 " part-list device\n"
29791 #: ../fish/guestfish-actions.pod:3615
29793 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29794 "the device's sector size, see L</blockdev-getss>."
29799 #: ../fish/guestfish-actions.pod:3628
29800 msgid "part-set-bootable"
29805 #: ../fish/guestfish-actions.pod:3630
29808 " part-set-bootable device partnum true|false\n"
29814 #: ../fish/guestfish-actions.pod:3639
29815 msgid "part-set-mbr-id"
29820 #: ../fish/guestfish-actions.pod:3641
29823 " part-set-mbr-id device partnum idbyte\n"
29829 #: ../fish/guestfish-actions.pod:3653
29830 msgid "part-set-name"
29835 #: ../fish/guestfish-actions.pod:3655
29838 " part-set-name device partnum name\n"
29844 #: ../fish/guestfish-actions.pod:3663
29845 msgid "part-to-dev"
29850 #: ../fish/guestfish-actions.pod:3665
29853 " part-to-dev partition\n"
29859 #: ../fish/guestfish-actions.pod:3671
29861 "The named partition must exist, for example as a string returned from L</"
29862 "list-partitions>."
29867 #: ../fish/guestfish-actions.pod:3674
29868 msgid "ping-daemon"
29873 #: ../fish/guestfish-actions.pod:3676
29882 #: ../fish/guestfish-actions.pod:3683
29888 #: ../fish/guestfish-actions.pod:3685
29891 " pread path count offset\n"
29897 #: ../fish/guestfish-actions.pod:3693
29898 msgid "See also L</pwrite>, L</pread-device>."
29903 #: ../fish/guestfish-actions.pod:3698
29904 msgid "pread-device"
29909 #: ../fish/guestfish-actions.pod:3700
29912 " pread-device device count offset\n"
29918 #: ../fish/guestfish-actions.pod:3708
29919 msgid "See also L</pread>."
29924 #: ../fish/guestfish-actions.pod:3713
29930 #: ../fish/guestfish-actions.pod:3715
29933 " pvcreate device\n"
29939 #: ../fish/guestfish-actions.pod:3721
29945 #: ../fish/guestfish-actions.pod:3723
29948 " pvremove device\n"
29954 #: ../fish/guestfish-actions.pod:3732
29960 #: ../fish/guestfish-actions.pod:3734
29963 " pvresize device\n"
29969 #: ../fish/guestfish-actions.pod:3739
29970 msgid "pvresize-size"
29975 #: ../fish/guestfish-actions.pod:3741
29978 " pvresize-size device size\n"
29984 #: ../fish/guestfish-actions.pod:3743
29986 "This command is the same as L</pvresize> except that it allows you to "
29987 "specify the new size (in bytes) explicitly."
29992 #: ../fish/guestfish-actions.pod:3746
29998 #: ../fish/guestfish-actions.pod:3748
30007 #: ../fish/guestfish-actions.pod:3756
30008 msgid "See also L</pvs-full>."
30013 #: ../fish/guestfish-actions.pod:3758
30019 #: ../fish/guestfish-actions.pod:3760
30028 #: ../fish/guestfish-actions.pod:3765
30034 #: ../fish/guestfish-actions.pod:3767
30043 #: ../fish/guestfish-actions.pod:3771
30049 #: ../fish/guestfish-actions.pod:3773
30052 " pwrite path content offset\n"
30058 #: ../fish/guestfish-actions.pod:3784
30059 msgid "See also L</pread>, L</pwrite-device>."
30064 #: ../fish/guestfish-actions.pod:3789
30065 msgid "pwrite-device"
30070 #: ../fish/guestfish-actions.pod:3791
30073 " pwrite-device device content offset\n"
30079 #: ../fish/guestfish-actions.pod:3801
30080 msgid "See also L</pwrite>."
30085 #: ../fish/guestfish-actions.pod:3806
30091 #: ../fish/guestfish-actions.pod:3808
30094 " read-file path\n"
30100 #: ../fish/guestfish-actions.pod:3813
30102 "Unlike L</cat>, this function can correctly handle files that contain "
30103 "embedded ASCII NUL characters. However unlike L</download>, this function "
30104 "is limited in the total size of file that can be handled."
30109 #: ../fish/guestfish-actions.pod:3821
30115 #: ../fish/guestfish-actions.pod:3823
30118 " read-lines path\n"
30124 #: ../fish/guestfish-actions.pod:3830
30126 "Note that this function cannot correctly handle binary files (specifically, "
30127 "files containing C<\\0> character which is treated as end of line). For "
30128 "those you need to use the L</read-file> function which has a more complex "
30134 #: ../fish/guestfish-actions.pod:3835
30140 #: ../fish/guestfish-actions.pod:3837
30149 #: ../fish/guestfish-actions.pod:3889
30151 "This function is primarily intended for use by programs. To get a simple "
30152 "list of names, use L</ls>. To get a printable directory for human "
30153 "consumption, use L</ll>."
30158 #: ../fish/guestfish-actions.pod:3893
30164 #: ../fish/guestfish-actions.pod:3895
30173 #: ../fish/guestfish-actions.pod:3899
30174 msgid "readlinklist"
30179 #: ../fish/guestfish-actions.pod:3901
30182 " readlinklist path 'names ...'\n"
30188 #: ../fish/guestfish-actions.pod:3925
30194 #: ../fish/guestfish-actions.pod:3927
30203 #: ../fish/guestfish-actions.pod:3932
30204 msgid "removexattr"
30209 #: ../fish/guestfish-actions.pod:3934
30212 " removexattr xattr path\n"
30218 #: ../fish/guestfish-actions.pod:3939
30219 msgid "See also: L</lremovexattr>, L<attr(5)>."
30224 #: ../fish/guestfish-actions.pod:3941
30230 #: ../fish/guestfish-actions.pod:3943
30233 " resize2fs device\n"
30239 #: ../fish/guestfish-actions.pod:3948
30241 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
30242 "before calling this command. For unknown reasons C<resize2fs> sometimes "
30243 "gives an error about this and sometimes not. In any case, it is always safe "
30244 "to call L</e2fsck-f> before calling this function."
30248 #: ../fish/guestfish-actions.pod:3954
30249 msgid "resize2fs-M"
30253 #: ../fish/guestfish-actions.pod:3956
30256 " resize2fs-M device\n"
30261 #: ../fish/guestfish-actions.pod:3958
30263 "This command is the same as L</resize2fs>, but the filesystem is resized to "
30264 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
30269 #: ../fish/guestfish-actions.pod:3962
30271 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
30272 "and read the C<Block size> and C<Block count> values. These two numbers, "
30273 "multiplied together, give the resulting size of the minimal filesystem in "
30279 #: ../fish/guestfish-actions.pod:3967
30280 msgid "resize2fs-size"
30285 #: ../fish/guestfish-actions.pod:3969
30288 " resize2fs-size device size\n"
30294 #: ../fish/guestfish-actions.pod:3971
30296 "This command is the same as L</resize2fs> except that it allows you to "
30297 "specify the new size (in bytes) explicitly."
30302 #: ../fish/guestfish-actions.pod:3974
30308 #: ../fish/guestfish-actions.pod:3976
30317 #: ../fish/guestfish-actions.pod:3980
30323 #: ../fish/guestfish-actions.pod:3982
30332 #: ../fish/guestfish-actions.pod:3988
30338 #: ../fish/guestfish-actions.pod:3990
30347 #: ../fish/guestfish-actions.pod:3994
30348 msgid "rmmountpoint"
30353 #: ../fish/guestfish-actions.pod:3996
30356 " rmmountpoint exemptpath\n"
30362 #: ../fish/guestfish-actions.pod:3998
30364 "This calls removes a mountpoint that was previously created with L</"
30365 "mkmountpoint>. See L</mkmountpoint> for full details."
30370 #: ../fish/guestfish-actions.pod:4002
30371 msgid "scrub-device"
30376 #: ../fish/guestfish-actions.pod:4004
30379 " scrub-device device\n"
30385 #: ../fish/guestfish-actions.pod:4015
30391 #: ../fish/guestfish-actions.pod:4017
30394 " scrub-file file\n"
30400 #: ../fish/guestfish-actions.pod:4027
30401 msgid "scrub-freespace"
30406 #: ../fish/guestfish-actions.pod:4029
30409 " scrub-freespace dir\n"
30415 #: ../fish/guestfish-actions.pod:4031
30417 "This command creates the directory C<dir> and then fills it with files until "
30418 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
30419 "deletes them. The intention is to scrub any free space on the partition "
30420 "containing C<dir>."
30425 #: ../fish/guestfish-actions.pod:4040
30431 #: ../fish/guestfish-actions.pod:4042
30437 #: ../fish/guestfish-actions.pod:4044
30440 " set-append append\n"
30445 #: ../fish/guestfish-actions.pod:4055
30446 msgid "set-attach-method"
30450 #: ../fish/guestfish-actions.pod:4057
30451 msgid "attach-method"
30455 #: ../fish/guestfish-actions.pod:4059
30458 " set-attach-method attachmethod\n"
30464 #: ../fish/guestfish-actions.pod:4081
30465 msgid "set-autosync"
30470 #: ../fish/guestfish-actions.pod:4083
30476 #: ../fish/guestfish-actions.pod:4085
30479 " set-autosync true|false\n"
30485 #: ../fish/guestfish-actions.pod:4095
30491 #: ../fish/guestfish-actions.pod:4097
30497 #: ../fish/guestfish-actions.pod:4099
30500 " set-direct true|false\n"
30506 #: ../fish/guestfish-actions.pod:4105
30508 "One consequence of this is that log messages aren't caught by the library "
30509 "and handled by L</set-log-message-callback>, but go straight to stdout."
30514 #: ../fish/guestfish-actions.pod:4114
30515 msgid "set-e2label"
30520 #: ../fish/guestfish-actions.pod:4116
30523 " set-e2label device label\n"
30529 #: ../fish/guestfish-actions.pod:4122
30531 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
30532 "label on a filesystem."
30537 #: ../fish/guestfish-actions.pod:4125
30543 #: ../fish/guestfish-actions.pod:4127
30546 " set-e2uuid device uuid\n"
30552 #: ../fish/guestfish-actions.pod:4134
30554 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
30555 "UUID of a filesystem."
30560 #: ../fish/guestfish-actions.pod:4137
30561 msgid "set-memsize"
30566 #: ../fish/guestfish-actions.pod:4139
30572 #: ../fish/guestfish-actions.pod:4141
30575 " set-memsize memsize\n"
30581 #: ../fish/guestfish-actions.pod:4143
30583 "This sets the memory size in megabytes allocated to the qemu subprocess. "
30584 "This only has any effect if called before L</launch>."
30589 #: ../fish/guestfish-actions.pod:4154
30590 msgid "set-network"
30595 #: ../fish/guestfish-actions.pod:4156
30601 #: ../fish/guestfish-actions.pod:4158
30604 " set-network true|false\n"
30610 #: ../fish/guestfish-actions.pod:4166
30612 "You must call this before calling L</launch>, otherwise it has no effect."
30617 #: ../fish/guestfish-actions.pod:4169
30623 #: ../fish/guestfish-actions.pod:4171
30629 #: ../fish/guestfish-actions.pod:4173
30632 " set-path searchpath\n"
30638 #: ../fish/guestfish-actions.pod:4182
30644 #: ../fish/guestfish-actions.pod:4184
30650 #: ../fish/guestfish-actions.pod:4186
30659 #: ../fish/guestfish-actions.pod:4206
30660 msgid "set-recovery-proc"
30665 #: ../fish/guestfish-actions.pod:4208
30666 msgid "recovery-proc"
30671 #: ../fish/guestfish-actions.pod:4210
30674 " set-recovery-proc true|false\n"
30680 #: ../fish/guestfish-actions.pod:4212
30682 "If this is called with the parameter C<false> then L</launch> does not "
30683 "create a recovery process. The purpose of the recovery process is to stop "
30684 "runaway qemu processes in the case where the main program aborts abruptly."
30689 #: ../fish/guestfish-actions.pod:4217
30691 "This only has any effect if called before L</launch>, and the default is "
30697 #: ../fish/guestfish-actions.pod:4226
30698 msgid "set-selinux"
30703 #: ../fish/guestfish-actions.pod:4228
30709 #: ../fish/guestfish-actions.pod:4230
30712 " set-selinux true|false\n"
30718 #: ../fish/guestfish-actions.pod:4241
30724 #: ../fish/guestfish-actions.pod:4243
30730 #: ../fish/guestfish-actions.pod:4245
30733 " set-trace true|false\n"
30738 #: ../fish/guestfish-actions.pod:4257
30740 "Trace messages are normally sent to C<stderr>, unless you register a "
30741 "callback to send them somewhere else (see L</set-event-callback>)."
30746 #: ../fish/guestfish-actions.pod:4261
30747 msgid "set-verbose"
30752 #: ../fish/guestfish-actions.pod:4263
30758 #: ../fish/guestfish-actions.pod:4265
30761 " set-verbose true|false\n"
30766 #: ../fish/guestfish-actions.pod:4272
30768 "Verbose messages are normally sent to C<stderr>, unless you register a "
30769 "callback to send them somewhere else (see L</set-event-callback>)."
30774 #: ../fish/guestfish-actions.pod:4276
30780 #: ../fish/guestfish-actions.pod:4278
30783 " setcon context\n"
30789 #: ../fish/guestfish-actions.pod:4285
30795 #: ../fish/guestfish-actions.pod:4287
30798 " setxattr xattr val vallen path\n"
30804 #: ../fish/guestfish-actions.pod:4293
30805 msgid "See also: L</lsetxattr>, L<attr(5)>."
30810 #: ../fish/guestfish-actions.pod:4295
30816 #: ../fish/guestfish-actions.pod:4297
30819 " sfdisk device cyls heads sectors 'lines ...'\n"
30825 #: ../fish/guestfish-actions.pod:4319
30826 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30831 #: ../fish/guestfish-actions.pod:4332
30837 #: ../fish/guestfish-actions.pod:4334
30840 " sfdiskM device 'lines ...'\n"
30846 #: ../fish/guestfish-actions.pod:4336
30848 "This is a simplified interface to the L</sfdisk> command, where partition "
30849 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30850 "you don't need to specify the cyls, heads and sectors parameters which were "
30851 "rarely if ever used anyway."
30856 #: ../fish/guestfish-actions.pod:4342
30857 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30862 #: ../fish/guestfish-actions.pod:4355
30868 #: ../fish/guestfish-actions.pod:4357
30871 " sfdisk-N device partnum cyls heads sectors line\n"
30877 #: ../fish/guestfish-actions.pod:4362
30879 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30880 "cyls/heads/sectors parameters."
30885 #: ../fish/guestfish-actions.pod:4365
30886 msgid "See also: L</part-add>"
30891 #: ../fish/guestfish-actions.pod:4377
30892 msgid "sfdisk-disk-geometry"
30897 #: ../fish/guestfish-actions.pod:4379
30900 " sfdisk-disk-geometry device\n"
30906 #: ../fish/guestfish-actions.pod:4381
30908 "This displays the disk geometry of C<device> read from the partition table. "
30909 "Especially in the case where the underlying block device has been resized, "
30910 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30911 "kernel-geometry>)."
30916 #: ../fish/guestfish-actions.pod:4389
30917 msgid "sfdisk-kernel-geometry"
30922 #: ../fish/guestfish-actions.pod:4391
30925 " sfdisk-kernel-geometry device\n"
30931 #: ../fish/guestfish-actions.pod:4398
30937 #: ../fish/guestfish-actions.pod:4400
30940 " sfdisk-l device\n"
30946 #: ../fish/guestfish-actions.pod:4406
30947 msgid "See also: L</part-list>"
30952 #: ../fish/guestfish-actions.pod:4415
30958 #: ../fish/guestfish-actions.pod:4417
30967 #: ../fish/guestfish-actions.pod:4422
30968 msgid "This is like L</command>, but passes the command to:"
30973 #: ../fish/guestfish-actions.pod:4430
30974 msgid "All the provisos about L</command> apply to this call."
30979 #: ../fish/guestfish-actions.pod:4432
30985 #: ../fish/guestfish-actions.pod:4434
30988 " sh-lines command\n"
30994 #: ../fish/guestfish-actions.pod:4436
30995 msgid "This is the same as L</sh>, but splits the result into a list of lines."
31000 #: ../fish/guestfish-actions.pod:4439
31001 msgid "See also: L</command-lines>"
31006 #: ../fish/guestfish-actions.pod:4441
31012 #: ../fish/guestfish-actions.pod:4443
31021 #: ../fish/guestfish-actions.pod:4447
31027 #: ../fish/guestfish-actions.pod:4449
31036 #: ../fish/guestfish-actions.pod:4455
31042 #: ../fish/guestfish-actions.pod:4457
31051 #: ../fish/guestfish-actions.pod:4465
31057 #: ../fish/guestfish-actions.pod:4467
31066 #: ../fish/guestfish-actions.pod:4475
31072 #: ../fish/guestfish-actions.pod:4477
31075 " strings-e encoding path\n"
31081 #: ../fish/guestfish-actions.pod:4479
31083 "This is like the L</strings> command, but allows you to specify the encoding "
31084 "of strings that are looked for in the source file C<path>."
31089 #: ../fish/guestfish-actions.pod:4489
31091 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
31092 "ISO-8859-X (this is what L</strings> uses)."
31097 #: ../fish/guestfish-actions.pod:4521
31098 msgid "swapoff-device"
31103 #: ../fish/guestfish-actions.pod:4523
31106 " swapoff-device device\n"
31112 #: ../fish/guestfish-actions.pod:4525
31114 "This command disables the libguestfs appliance swap device or partition "
31115 "named C<device>. See L</swapon-device>."
31120 #: ../fish/guestfish-actions.pod:4529
31121 msgid "swapoff-file"
31126 #: ../fish/guestfish-actions.pod:4531
31129 " swapoff-file file\n"
31135 #: ../fish/guestfish-actions.pod:4535
31136 msgid "swapoff-label"
31141 #: ../fish/guestfish-actions.pod:4537
31144 " swapoff-label label\n"
31150 #: ../fish/guestfish-actions.pod:4542
31151 msgid "swapoff-uuid"
31156 #: ../fish/guestfish-actions.pod:4544
31159 " swapoff-uuid uuid\n"
31165 #: ../fish/guestfish-actions.pod:4549
31166 msgid "swapon-device"
31171 #: ../fish/guestfish-actions.pod:4551
31174 " swapon-device device\n"
31180 #: ../fish/guestfish-actions.pod:4553
31182 "This command enables the libguestfs appliance to use the swap device or "
31183 "partition named C<device>. The increased memory is made available for all "
31184 "commands, for example those run using L</command> or L</sh>."
31189 #: ../fish/guestfish-actions.pod:4565
31190 msgid "swapon-file"
31195 #: ../fish/guestfish-actions.pod:4567
31198 " swapon-file file\n"
31204 #: ../fish/guestfish-actions.pod:4569
31206 "This command enables swap to a file. See L</swapon-device> for other notes."
31211 #: ../fish/guestfish-actions.pod:4572
31212 msgid "swapon-label"
31217 #: ../fish/guestfish-actions.pod:4574
31220 " swapon-label label\n"
31226 #: ../fish/guestfish-actions.pod:4576
31228 "This command enables swap to a labeled swap partition. See L</swapon-"
31229 "device> for other notes."
31234 #: ../fish/guestfish-actions.pod:4579
31235 msgid "swapon-uuid"
31240 #: ../fish/guestfish-actions.pod:4581
31243 " swapon-uuid uuid\n"
31249 #: ../fish/guestfish-actions.pod:4583
31251 "This command enables swap to a swap partition with the given UUID. See L</"
31252 "swapon-device> for other notes."
31257 #: ../fish/guestfish-actions.pod:4586
31263 #: ../fish/guestfish-actions.pod:4588
31272 #: ../fish/guestfish-actions.pod:4596
31278 #: ../fish/guestfish-actions.pod:4598
31287 #: ../fish/guestfish-actions.pod:4606
31293 #: ../fish/guestfish-actions.pod:4608
31296 " tail-n nrlines path\n"
31302 #: ../fish/guestfish-actions.pod:4621
31308 #: ../fish/guestfish-actions.pod:4623
31311 " tar-in (tarfile|-) directory\n"
31317 #: ../fish/guestfish-actions.pod:4628
31318 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
31323 #: ../fish/guestfish-actions.pod:4633
31329 #: ../fish/guestfish-actions.pod:4635
31332 " tar-out directory (tarfile|-)\n"
31338 #: ../fish/guestfish-actions.pod:4640
31339 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
31344 #: ../fish/guestfish-actions.pod:4645
31350 #: ../fish/guestfish-actions.pod:4647
31353 " tgz-in (tarball|-) directory\n"
31359 #: ../fish/guestfish-actions.pod:4652
31360 msgid "To upload an uncompressed tarball, use L</tar-in>."
31365 #: ../fish/guestfish-actions.pod:4656
31371 #: ../fish/guestfish-actions.pod:4658
31374 " tgz-out directory (tarball|-)\n"
31380 #: ../fish/guestfish-actions.pod:4663
31381 msgid "To download an uncompressed tarball, use L</tar-out>."
31386 #: ../fish/guestfish-actions.pod:4667
31392 #: ../fish/guestfish-actions.pod:4669
31401 #: ../fish/guestfish-actions.pod:4678
31407 #: ../fish/guestfish-actions.pod:4680
31416 #: ../fish/guestfish-actions.pod:4685
31417 msgid "truncate-size"
31422 #: ../fish/guestfish-actions.pod:4687
31425 " truncate-size path size\n"
31431 #: ../fish/guestfish-actions.pod:4692
31433 "If the current file size is less than C<size> then the file is extended to "
31434 "the required size with zero bytes. This creates a sparse file (ie. disk "
31435 "blocks are not allocated for the file until you write to it). To create a "
31436 "non-sparse file of zeroes, use L</fallocate64> instead."
31441 #: ../fish/guestfish-actions.pod:4698
31447 #: ../fish/guestfish-actions.pod:4700
31450 " tune2fs-l device\n"
31456 #: ../fish/guestfish-actions.pod:4710
31462 #: ../fish/guestfish-actions.pod:4712
31465 " txz-in (tarball|-) directory\n"
31471 #: ../fish/guestfish-actions.pod:4719
31477 #: ../fish/guestfish-actions.pod:4721
31480 " txz-out directory (tarball|-)\n"
31486 #: ../fish/guestfish-actions.pod:4728
31492 #: ../fish/guestfish-actions.pod:4730
31501 #: ../fish/guestfish-actions.pod:4744
31502 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
31507 #: ../fish/guestfish-actions.pod:4749
31513 #: ../fish/guestfish-actions.pod:4751
31519 #: ../fish/guestfish-actions.pod:4753
31522 " umount pathordevice\n"
31528 #: ../fish/guestfish-actions.pod:4759
31534 #: ../fish/guestfish-actions.pod:4761
31535 msgid "unmount-all"
31540 #: ../fish/guestfish-actions.pod:4763
31549 #: ../fish/guestfish-actions.pod:4769
31555 #: ../fish/guestfish-actions.pod:4771
31558 " upload (filename|-) remotefilename\n"
31564 #: ../fish/guestfish-actions.pod:4778
31565 msgid "See also L</download>."
31570 #: ../fish/guestfish-actions.pod:4782
31571 msgid "upload-offset"
31576 #: ../fish/guestfish-actions.pod:4784
31579 " upload-offset (filename|-) remotefilename offset\n"
31585 #: ../fish/guestfish-actions.pod:4796
31587 "Note that there is no limit on the amount of data that can be uploaded with "
31588 "this call, unlike with L</pwrite>, and this call always writes the full "
31589 "amount unless an error occurs."
31594 #: ../fish/guestfish-actions.pod:4801
31595 msgid "See also L</upload>, L</pwrite>."
31600 #: ../fish/guestfish-actions.pod:4805
31606 #: ../fish/guestfish-actions.pod:4807
31609 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
31615 #: ../fish/guestfish-actions.pod:4826
31621 #: ../fish/guestfish-actions.pod:4828
31630 #: ../fish/guestfish-actions.pod:4855
31632 "I<Note:> Don't use this call to test for availability of features. In "
31633 "enterprise distributions we backport features from later versions into "
31634 "earlier versions, making this an unreliable way to test for features. Use "
31635 "L</available> instead."
31640 #: ../fish/guestfish-actions.pod:4861
31646 #: ../fish/guestfish-actions.pod:4863
31649 " vfs-label device\n"
31655 #: ../fish/guestfish-actions.pod:4870
31656 msgid "To find a filesystem from the label, use L</findfs-label>."
31661 #: ../fish/guestfish-actions.pod:4872
31667 #: ../fish/guestfish-actions.pod:4874
31670 " vfs-type device\n"
31676 #: ../fish/guestfish-actions.pod:4884
31682 #: ../fish/guestfish-actions.pod:4886
31685 " vfs-uuid device\n"
31691 #: ../fish/guestfish-actions.pod:4893
31692 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
31697 #: ../fish/guestfish-actions.pod:4895
31698 msgid "vg-activate"
31703 #: ../fish/guestfish-actions.pod:4897
31706 " vg-activate true|false 'volgroups ...'\n"
31712 #: ../fish/guestfish-actions.pod:4907
31713 msgid "vg-activate-all"
31718 #: ../fish/guestfish-actions.pod:4909
31721 " vg-activate-all true|false\n"
31727 #: ../fish/guestfish-actions.pod:4916
31733 #: ../fish/guestfish-actions.pod:4918
31736 " vgcreate volgroup 'physvols ...'\n"
31742 #: ../fish/guestfish-actions.pod:4923
31748 #: ../fish/guestfish-actions.pod:4925
31751 " vglvuuids vgname\n"
31757 #: ../fish/guestfish-actions.pod:4930
31759 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
31760 "logical volumes and volume groups."
31765 #: ../fish/guestfish-actions.pod:4933
31766 msgid "See also L</vgpvuuids>."
31771 #: ../fish/guestfish-actions.pod:4935
31777 #: ../fish/guestfish-actions.pod:4937
31780 " vgpvuuids vgname\n"
31786 #: ../fish/guestfish-actions.pod:4942
31788 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31789 "physical volumes and volume groups."
31794 #: ../fish/guestfish-actions.pod:4945
31795 msgid "See also L</vglvuuids>."
31800 #: ../fish/guestfish-actions.pod:4947
31806 #: ../fish/guestfish-actions.pod:4949
31809 " vgremove vgname\n"
31815 #: ../fish/guestfish-actions.pod:4956
31821 #: ../fish/guestfish-actions.pod:4958
31824 " vgrename volgroup newvolgroup\n"
31830 #: ../fish/guestfish-actions.pod:4962
31836 #: ../fish/guestfish-actions.pod:4964
31845 #: ../fish/guestfish-actions.pod:4972
31846 msgid "See also L</vgs-full>."
31851 #: ../fish/guestfish-actions.pod:4974
31857 #: ../fish/guestfish-actions.pod:4976
31866 #: ../fish/guestfish-actions.pod:4981
31872 #: ../fish/guestfish-actions.pod:4983
31881 #: ../fish/guestfish-actions.pod:4988
31887 #: ../fish/guestfish-actions.pod:4990
31896 #: ../fish/guestfish-actions.pod:4994
31902 #: ../fish/guestfish-actions.pod:4996
31911 #: ../fish/guestfish-actions.pod:5001
31917 #: ../fish/guestfish-actions.pod:5003
31926 #: ../fish/guestfish-actions.pod:5008
31932 #: ../fish/guestfish-actions.pod:5010
31941 #: ../fish/guestfish-actions.pod:5015
31947 #: ../fish/guestfish-actions.pod:5017
31950 " write path content\n"
31956 #: ../fish/guestfish-actions.pod:5025
31962 #: ../fish/guestfish-actions.pod:5027
31965 " write-file path content size\n"
31971 #: ../fish/guestfish-actions.pod:5050
31977 #: ../fish/guestfish-actions.pod:5052
31980 " zegrep regex path\n"
31986 #: ../fish/guestfish-actions.pod:5060
31992 #: ../fish/guestfish-actions.pod:5062
31995 " zegrepi regex path\n"
32001 #: ../fish/guestfish-actions.pod:5070
32007 #: ../fish/guestfish-actions.pod:5072
32015 #: ../fish/guestfish-actions.pod:5080
32016 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
32021 #: ../fish/guestfish-actions.pod:5083
32022 msgid "zero-device"
32027 #: ../fish/guestfish-actions.pod:5085
32030 " zero-device device\n"
32036 #: ../fish/guestfish-actions.pod:5087
32038 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
32039 "which just zeroes the first few blocks of a device."
32044 #: ../fish/guestfish-actions.pod:5094
32050 #: ../fish/guestfish-actions.pod:5096
32053 " zerofree device\n"
32059 #: ../fish/guestfish-actions.pod:5109
32065 #: ../fish/guestfish-actions.pod:5111
32068 " zfgrep pattern path\n"
32074 #: ../fish/guestfish-actions.pod:5119
32080 #: ../fish/guestfish-actions.pod:5121
32083 " zfgrepi pattern path\n"
32089 #: ../fish/guestfish-actions.pod:5129
32095 #: ../fish/guestfish-actions.pod:5131
32098 " zfile meth path\n"
32104 #: ../fish/guestfish-actions.pod:5138
32106 "Since 1.0.63, use L</file> instead which can now process compressed files."
32111 #: ../fish/guestfish-actions.pod:5148
32117 #: ../fish/guestfish-actions.pod:5150
32120 " zgrep regex path\n"
32126 #: ../fish/guestfish-actions.pod:5158
32132 #: ../fish/guestfish-actions.pod:5160
32135 " zgrepi regex path\n"
32141 #: ../fish/guestfish-commands.pod:1
32147 #: ../fish/guestfish-commands.pod:3
32153 #: ../fish/guestfish-commands.pod:5
32156 " alloc filename size\n"
32162 #: ../fish/guestfish-commands.pod:7
32164 "This creates an empty (zeroed) file of the given size, and then adds so it "
32165 "can be further examined."
32170 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
32171 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
32176 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
32177 msgid "Size can be specified using standard suffixes, eg. C<1M>."
32182 #: ../fish/guestfish-commands.pod:14
32184 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
32185 "image, see L</PREPARED DISK IMAGES>."
32190 #: ../fish/guestfish-commands.pod:17
32196 #: ../fish/guestfish-commands.pod:19
32199 " copy-in local [local ...] /remotedir\n"
32205 #: ../fish/guestfish-commands.pod:21
32207 "C<copy-in> copies local files or directories recursively into the disk "
32208 "image, placing them in the directory called C</remotedir> (which must "
32209 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
32210 "other commands as necessary."
32215 #: ../fish/guestfish-commands.pod:26
32217 "Multiple local files and directories can be specified, but the last "
32218 "parameter must always be a remote directory. Wildcards cannot be used."
32223 #: ../fish/guestfish-commands.pod:30
32229 #: ../fish/guestfish-commands.pod:32
32232 " copy-out remote [remote ...] localdir\n"
32238 #: ../fish/guestfish-commands.pod:34
32240 "C<copy-out> copies remote files or directories recursively out of the disk "
32241 "image, placing them on the host disk in a local directory called C<localdir> "
32242 "(which must exist). This guestfish meta-command turns into a sequence of L</"
32243 "download>, L</tar-out> and other commands as necessary."
32248 #: ../fish/guestfish-commands.pod:40
32250 "Multiple remote files and directories can be specified, but the last "
32251 "parameter must always be a local directory. To download to the current "
32252 "directory, use C<.> as in:"
32257 #: ../fish/guestfish-commands.pod:44
32260 " copy-out /home .\n"
32266 #: ../fish/guestfish-commands.pod:46
32268 "Wildcards cannot be used in the ordinary command, but you can use them with "
32269 "the help of L</glob> like this:"
32274 #: ../fish/guestfish-commands.pod:49
32277 " glob copy-out /home/* .\n"
32282 #: ../fish/guestfish-commands.pod:51
32287 #: ../fish/guestfish-commands.pod:53
32290 " display filename\n"
32295 #: ../fish/guestfish-commands.pod:55
32297 "Use C<display> (a graphical display program) to display an image file. It "
32298 "downloads the file, and runs C<display> on it."
32302 #: ../fish/guestfish-commands.pod:58
32304 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
32305 "environment variable. For example to use the GNOME display program:"
32309 #: ../fish/guestfish-commands.pod:61
32312 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
32317 #: ../fish/guestfish-commands.pod:63
32318 msgid "See also L<display(1)>."
32323 #: ../fish/guestfish-commands.pod:65
32329 #: ../fish/guestfish-commands.pod:67
32332 " echo [params ...]\n"
32338 #: ../fish/guestfish-commands.pod:69
32339 msgid "This echos the parameters to the terminal."
32344 #: ../fish/guestfish-commands.pod:71
32350 #: ../fish/guestfish-commands.pod:73
32356 #: ../fish/guestfish-commands.pod:75
32362 #: ../fish/guestfish-commands.pod:77
32371 #: ../fish/guestfish-commands.pod:79
32373 "This is used to edit a file. It downloads the file, edits it locally using "
32374 "your editor, then uploads the result."
32379 #: ../fish/guestfish-commands.pod:82
32381 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
32382 "or C<emacs> you will get those corresponding editors."
32387 #: ../fish/guestfish-commands.pod:86
32393 #: ../fish/guestfish-commands.pod:88
32396 " glob command args...\n"
32402 #: ../fish/guestfish-commands.pod:90
32404 "Expand wildcards in any paths in the args list, and run C<command> "
32405 "repeatedly on each matching path."
32410 #: ../fish/guestfish-commands.pod:93
32411 msgid "See L</WILDCARDS AND GLOBBING>."
32416 #: ../fish/guestfish-commands.pod:95
32422 #: ../fish/guestfish-commands.pod:97
32425 " hexedit <filename|device>\n"
32426 " hexedit <filename|device> <max>\n"
32427 " hexedit <filename|device> <start> <max>\n"
32433 #: ../fish/guestfish-commands.pod:101
32435 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
32441 #: ../fish/guestfish-commands.pod:104
32443 "This command works by downloading potentially the whole file or device, "
32444 "editing it locally, then uploading it. If the file or device is large, you "
32445 "have to specify which part you wish to edit by using C<max> and/or C<start> "
32446 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
32447 "usual modifiers allowed such as C<1M> (1 megabyte)."
32452 #: ../fish/guestfish-commands.pod:111
32453 msgid "For example to edit the first few sectors of a disk you might do:"
32458 #: ../fish/guestfish-commands.pod:114
32461 " hexedit /dev/sda 1M\n"
32467 #: ../fish/guestfish-commands.pod:116
32469 "which would allow you to edit anywhere within the first megabyte of the disk."
32474 #: ../fish/guestfish-commands.pod:119
32475 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
32480 #: ../fish/guestfish-commands.pod:121
32483 " hexedit /dev/sda1 0x400 0x400\n"
32489 #: ../fish/guestfish-commands.pod:123
32490 msgid "(assuming the superblock is in the standard location)."
32495 #: ../fish/guestfish-commands.pod:125
32497 "This command requires the external L<hexedit(1)> program. You can specify "
32498 "another program to use by setting the C<HEXEDITOR> environment variable."
32503 #: ../fish/guestfish-commands.pod:129
32504 msgid "See also L</hexdump>."
32509 #: ../fish/guestfish-commands.pod:131
32515 #: ../fish/guestfish-commands.pod:133
32524 #: ../fish/guestfish-commands.pod:135
32526 "Change the local directory, ie. the current directory of guestfish itself."
32531 #: ../fish/guestfish-commands.pod:138
32532 msgid "Note that C<!cd> won't do what you might expect."
32537 #: ../fish/guestfish-commands.pod:140
32543 #: ../fish/guestfish-commands.pod:142
32549 #: ../fish/guestfish-commands.pod:144
32558 #: ../fish/guestfish-commands.pod:146
32559 msgid "Opens the manual page for guestfish."
32564 #: ../fish/guestfish-commands.pod:148
32570 #: ../fish/guestfish-commands.pod:150
32576 #: ../fish/guestfish-commands.pod:152
32585 #: ../fish/guestfish-commands.pod:154
32594 #: ../fish/guestfish-commands.pod:156
32595 msgid "This is used to view a file."
32600 #: ../fish/guestfish-commands.pod:158
32602 "The default viewer is C<$PAGER>. However if you use the alternate command "
32603 "C<less> you will get the C<less> command specifically."
32608 #: ../fish/guestfish-commands.pod:161
32614 #: ../fish/guestfish-commands.pod:163
32623 #: ../fish/guestfish-commands.pod:165
32625 "Close and reopen the libguestfs handle. It is not necessary to use this "
32626 "normally, because the handle is closed properly when guestfish exits. "
32627 "However this is occasionally useful for testing."
32632 #: ../fish/guestfish-commands.pod:169
32638 #: ../fish/guestfish-commands.pod:171
32641 " sparse filename size\n"
32647 #: ../fish/guestfish-commands.pod:173
32649 "This creates an empty sparse file of the given size, and then adds so it can "
32650 "be further examined."
32655 #: ../fish/guestfish-commands.pod:176
32657 "In all respects it works the same as the L</alloc> command, except that the "
32658 "image file is allocated sparsely, which means that disk blocks are not "
32659 "assigned to the file until they are needed. Sparse disk files only use "
32660 "space when written to, but they are slower and there is a danger you could "
32661 "run out of real disk space during a write operation."
32666 #: ../fish/guestfish-commands.pod:186
32672 #: ../fish/guestfish-commands.pod:188
32681 #: ../fish/guestfish-commands.pod:190
32683 "This command returns a list of the optional groups known to the daemon, and "
32684 "indicates which ones are supported by this build of the libguestfs appliance."
32689 #: ../fish/guestfish-commands.pod:194
32690 msgid "See also L<guestfs(3)/AVAILABILITY>."
32695 #: ../fish/guestfish-commands.pod:196
32701 #: ../fish/guestfish-commands.pod:198
32704 " time command args...\n"
32710 #: ../fish/guestfish-commands.pod:200
32712 "Run the command as usual, but print the elapsed time afterwards. This can "
32713 "be useful for benchmarking operations."
32718 #: ../test-tool/libguestfs-test-tool.pod:5
32719 msgid "libguestfs-test-tool - End user tests for libguestfs"
32724 #: ../test-tool/libguestfs-test-tool.pod:9
32727 " libguestfs-test-tool [--options]\n"
32733 #: ../test-tool/libguestfs-test-tool.pod:13
32735 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
32736 "and developers, to allow them to check basic libguestfs functionality is "
32737 "working. This is needed because libguestfs occasionally breaks for reasons "
32738 "beyond our control: usually because of changes in the underlying qemu or "
32739 "kernel packages, or the host environment."
32744 #: ../test-tool/libguestfs-test-tool.pod:20
32745 msgid "If you suspect a problem in libguestfs, then just run:"
32750 #: ../test-tool/libguestfs-test-tool.pod:22
32753 " libguestfs-test-tool\n"
32759 #: ../test-tool/libguestfs-test-tool.pod:24
32760 msgid "It will print lots of diagnostic messages."
32765 #: ../test-tool/libguestfs-test-tool.pod:26
32766 msgid "If it runs to completion successfully, you will see this near the end:"
32771 #: ../test-tool/libguestfs-test-tool.pod:28
32774 " ===== TEST FINISHED OK =====\n"
32780 #: ../test-tool/libguestfs-test-tool.pod:30
32781 msgid "and the test tool will exit with code 0."
32786 #: ../test-tool/libguestfs-test-tool.pod:32
32788 "If it fails (and/or exits with non-zero error code), please paste the "
32789 "B<complete, unedited> output of the test tool into a bug report. More "
32790 "information about reporting bugs can be found on the L<http://libguestfs.org/"
32796 #: ../test-tool/libguestfs-test-tool.pod:41
32802 #: ../test-tool/libguestfs-test-tool.pod:43
32803 msgid "Display short usage information and exit."
32808 #: ../test-tool/libguestfs-test-tool.pod:45
32809 msgid "I<--qemu qemu_binary>"
32814 #: ../test-tool/libguestfs-test-tool.pod:47
32816 "If you have downloaded another qemu binary, point this option at the full "
32817 "path of the binary to try it."
32822 #: ../test-tool/libguestfs-test-tool.pod:50
32823 msgid "I<--qemudir qemu_source_dir>"
32828 #: ../test-tool/libguestfs-test-tool.pod:52
32830 "If you have compiled qemu from source, point this option at the source "
32831 "directory to try it."
32836 #: ../test-tool/libguestfs-test-tool.pod:55
32837 msgid "I<--timeout N>"
32842 #: ../test-tool/libguestfs-test-tool.pod:57
32844 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32845 "does not usually need to be adjusted unless your machine is very slow."
32850 #: ../test-tool/libguestfs-test-tool.pod:63
32851 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32856 #: ../test-tool/libguestfs-test-tool.pod:65
32858 "If you have compiled another version of qemu from source and would like to "
32859 "try that, then you can use the I<--qemudir> option to point to the qemu "
32860 "source directory."
32865 #: ../test-tool/libguestfs-test-tool.pod:69
32867 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32868 "option to point to the binary."
32873 #: ../test-tool/libguestfs-test-tool.pod:72
32875 "When using an alternate qemu with libguestfs, usually you would need to "
32876 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32877 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32878 "use either of the I<--qemudir> or I<--qemu> options."
32883 #: ../test-tool/libguestfs-test-tool.pod:79
32885 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32886 "I<1> if there was an error."
32891 #: ../test-tool/libguestfs-test-tool.pod:84
32893 "For the full list of environment variables which may affect libguestfs, "
32894 "please see the L<guestfs(3)> manual page."
32899 #: ../test-tool/libguestfs-test-tool.pod:89
32900 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32905 #: ../fuse/guestmount.pod:5
32907 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32912 #: ../fuse/guestmount.pod:9
32915 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32921 #: ../fuse/guestmount.pod:11
32924 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32930 #: ../fuse/guestmount.pod:13
32933 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32939 #: ../fuse/guestmount.pod:17
32941 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32942 "machines. If you do this, you risk disk corruption in the VM."
32947 #: ../fuse/guestmount.pod:22
32949 "The guestmount program can be used to mount virtual machine filesystems and "
32950 "other disk images on the host. It uses libguestfs for access to the guest "
32951 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32952 "a mountable device."
32957 #: ../fuse/guestmount.pod:27
32959 "Along with other options, you have to give at least one device (I<-a> "
32960 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32961 "option) or use the I<-i> inspection option. How this works is better "
32962 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32968 #: ../fuse/guestmount.pod:33
32970 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32971 "by you, and the filesystem will not be visible to any other users unless you "
32972 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32973 "the filesystem, use the C<fusermount -u> command."
32978 #: ../fuse/guestmount.pod:41
32980 "For a typical Windows guest which has its main filesystem on the first "
32986 #: ../fuse/guestmount.pod:44
32989 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32995 #: ../fuse/guestmount.pod:46
32997 "For a typical Linux guest which has a /boot filesystem on the first "
32998 "partition, and the root filesystem on a logical volume:"
33003 #: ../fuse/guestmount.pod:49
33006 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
33012 #: ../fuse/guestmount.pod:51
33013 msgid "To get libguestfs to detect guest mountpoints for you:"
33018 #: ../fuse/guestmount.pod:53
33021 " guestmount -a guest.img -i --ro /mnt\n"
33027 #: ../fuse/guestmount.pod:55
33028 msgid "For a libvirt guest called \"Guest\" you could do:"
33033 #: ../fuse/guestmount.pod:57
33036 " guestmount -d Guest -i --ro /mnt\n"
33042 #: ../fuse/guestmount.pod:59
33044 "If you don't know what filesystems are contained in a guest or disk image, "
33045 "use L<virt-filesystems(1)> first:"
33050 #: ../fuse/guestmount.pod:62
33053 " virt-filesystems MyGuest\n"
33059 #: ../fuse/guestmount.pod:64
33061 "If you want to trace the libguestfs calls but without excessive debugging "
33062 "information, we recommend:"
33067 #: ../fuse/guestmount.pod:67
33070 " guestmount [...] --trace /mnt\n"
33076 #: ../fuse/guestmount.pod:69
33077 msgid "If you want to debug the program, we recommend:"
33082 #: ../fuse/guestmount.pod:71
33085 " guestmount [...] --trace --verbose /mnt\n"
33090 #: ../fuse/guestmount.pod:73
33095 #: ../fuse/guestmount.pod:75
33096 msgid "Other users cannot see the filesystem by default"
33100 #: ../fuse/guestmount.pod:77
33102 "If you mount a filesystem as one user (eg. root), then other users will not "
33103 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
33104 "option when mounting:"
33108 #: ../fuse/guestmount.pod:81
33111 " sudo guestmount [...] -o allow_other /mnt\n"
33117 #: ../fuse/guestmount.pod:87
33118 msgid "B<-a image> | B<--add image>"
33123 #: ../fuse/guestmount.pod:89
33124 msgid "Add a block device or virtual machine image."
33129 #: ../fuse/guestmount.pod:94
33130 msgid "B<-c URI> | B<--connect URI>"
33135 #: ../fuse/guestmount.pod:100
33136 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
33141 #: ../fuse/guestmount.pod:108
33142 msgid "B<--dir-cache-timeout N>"
33147 #: ../fuse/guestmount.pod:110
33149 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
33150 "seconds. The readdir cache [actually, there are several semi-independent "
33151 "caches] is populated after a readdir(2) call with the stat and extended "
33152 "attributes of the files in the directory, in anticipation that they will be "
33153 "requested soon after."
33158 #: ../fuse/guestmount.pod:116
33160 "There is also a different attribute cache implemented by FUSE (see the FUSE "
33161 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
33162 "requests, only cache existing ones."
33167 #: ../fuse/guestmount.pod:127
33168 msgid "B<--format=raw|qcow2|..> | B<--format>"
33173 #: ../fuse/guestmount.pod:134
33175 "If you have untrusted raw-format guest disk images, you should use this "
33176 "option to specify the disk format. This avoids a possible security problem "
33177 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
33178 "guestfs_add_drive_opts>."
33183 #: ../fuse/guestmount.pod:139
33184 msgid "B<--fuse-help>"
33189 #: ../fuse/guestmount.pod:141
33190 msgid "Display help on special FUSE options (see I<-o> below)."
33195 #: ../fuse/guestmount.pod:145
33196 msgid "Display brief help and exit."
33201 #: ../fuse/guestmount.pod:147
33202 msgid "B<-i> | B<--inspector>"
33207 #: ../fuse/guestmount.pod:167
33209 "Mount the named partition or logical volume on the given mountpoint B<in the "
33210 "guest> (this has nothing to do with mountpoints in the host)."
33215 #: ../fuse/guestmount.pod:170
33217 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
33218 "something on C</>."
33223 #: ../fuse/guestmount.pod:183
33224 msgid "B<-n> | B<--no-sync>"
33229 #: ../fuse/guestmount.pod:185
33231 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
33232 "unmounted. If you specify this option, then we don't attempt to sync the "
33233 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
33238 #: ../fuse/guestmount.pod:190
33239 msgid "B<-o option> | B<--option option>"
33244 #: ../fuse/guestmount.pod:192
33245 msgid "Pass extra options to FUSE."
33250 #: ../fuse/guestmount.pod:194
33252 "To get a list of all the extra options supported by FUSE, use the command "
33253 "below. Note that only the FUSE I<-o> options can be passed, and only some "
33254 "of them are a good idea."
33259 #: ../fuse/guestmount.pod:198
33262 " guestmount --fuse-help\n"
33268 #: ../fuse/guestmount.pod:200
33269 msgid "Some potentially useful FUSE options:"
33274 #: ../fuse/guestmount.pod:204
33275 msgid "B<-o allow_other>"
33280 #: ../fuse/guestmount.pod:206
33281 msgid "Allow other users to see the filesystem."
33286 #: ../fuse/guestmount.pod:208
33287 msgid "B<-o attr_timeout=N>"
33292 #: ../fuse/guestmount.pod:210
33293 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
33298 #: ../fuse/guestmount.pod:212
33299 msgid "B<-o kernel_cache>"
33304 #: ../fuse/guestmount.pod:214
33306 "Allow the kernel to cache files (reduces the number of reads that have to go "
33307 "through the L<guestfs(3)> API). This is generally a good idea if you can "
33308 "afford the extra memory usage."
33313 #: ../fuse/guestmount.pod:218
33314 msgid "B<-o uid=N> B<-o gid=N>"
33319 #: ../fuse/guestmount.pod:220
33321 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
33322 "the chosen values."
33327 #: ../fuse/guestmount.pod:225
33328 msgid "B<-r> | B<--ro>"
33333 #: ../fuse/guestmount.pod:227
33335 "Add devices and mount everything read-only. Also disallow writes and make "
33336 "the disk appear read-only to FUSE."
33341 #: ../fuse/guestmount.pod:230
33343 "This is highly recommended if you are not going to edit the guest disk. If "
33344 "the guest is running and this option is I<not> supplied, then there is a "
33345 "strong risk of disk corruption in the guest. We try to prevent this from "
33346 "happening, but it is not always possible."
33351 #: ../fuse/guestmount.pod:235
33352 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
33357 #: ../fuse/guestmount.pod:239
33358 msgid "Enable SELinux support for the guest."
33363 #: ../fuse/guestmount.pod:241
33364 msgid "B<-v> | B<--verbose>"
33369 #: ../fuse/guestmount.pod:243
33370 msgid "Enable verbose messages from underlying libguestfs."
33375 #: ../fuse/guestmount.pod:245
33376 msgid "B<-V> | B<--version>"
33381 #: ../fuse/guestmount.pod:247
33382 msgid "Display the program version and exit."
33387 #: ../fuse/guestmount.pod:249
33388 msgid "B<-w> | B<--rw>"
33392 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
33393 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
33398 #: ../fuse/guestmount.pod:256
33399 msgid "B<-x> | B<--trace>"
33404 #: ../fuse/guestmount.pod:258
33405 msgid "Trace libguestfs calls and entry into each FUSE function."
33410 #: ../fuse/guestmount.pod:260
33411 msgid "This also stops the daemon from forking into the background."
33416 #: ../fuse/guestmount.pod:281
33418 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
33419 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
33425 #: ../fuse/guestmount.pod:296
33426 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
33431 #: ../tools/virt-win-reg.pl:37
33433 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33438 #: ../tools/virt-win-reg.pl:41
33441 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33447 #: ../tools/virt-win-reg.pl:43
33450 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33456 #: ../tools/virt-win-reg.pl:45
33459 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33465 #: ../tools/virt-win-reg.pl:47
33468 " virt-win-reg --merge domname [input.reg ...]\n"
33474 #: ../tools/virt-win-reg.pl:49
33477 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33482 #: ../tools/virt-win-reg.pl:53
33484 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33485 "virtual machines. If you do this, you I<will> get irreversible disk "
33486 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33487 "but doesn't catch all cases."
33491 #: ../tools/virt-win-reg.pl:58
33493 "Modifying the Windows Registry is an inherently risky operation. The format "
33494 "is deliberately obscure and undocumented, and Registry changes can leave the "
33495 "system unbootable. Therefore when using the I<--merge> option, make sure "
33496 "you have a reliable backup first."
33501 #: ../tools/virt-win-reg.pl:65
33503 "This program can export and merge Windows Registry entries from a Windows "
33509 #: ../tools/virt-win-reg.pl:68
33511 "The first parameter is the libvirt guest name or the raw disk image of a "
33516 #: ../tools/virt-win-reg.pl:71
33518 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33519 "exported (recursively). For example:"
33524 #: ../tools/virt-win-reg.pl:74
33527 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33533 #: ../tools/virt-win-reg.pl:76
33535 "You can also display single values from within registry keys, for example:"
33540 #: ../tools/virt-win-reg.pl:79
33543 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33544 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33545 " Windows 7 Enterprise\n"
33550 #: ../tools/virt-win-reg.pl:83
33552 "With I<--merge>, you can merge a textual regedit file into the Windows "
33558 #: ../tools/virt-win-reg.pl:86
33561 " $ virt-win-reg --merge Windows7 changes.reg\n"
33567 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33573 #: ../tools/virt-win-reg.pl:90
33575 "This program is only meant for simple access to the registry. If you want "
33576 "to do complicated things with the registry, we suggest you download the "
33577 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33578 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33579 "L<hivexregedit(1)>."
33584 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
33585 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
33586 #: ../tools/virt-list-partitions.pl:64
33587 msgid "Display brief help."
33592 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
33593 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
33594 #: ../tools/virt-list-partitions.pl:72
33595 msgid "Display version number and exit."
33600 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33606 #: ../tools/virt-win-reg.pl:122
33607 msgid "Enable debugging messages."
33612 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
33613 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
33614 msgid "B<--connect URI> | B<-c URI>"
33619 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
33620 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
33622 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
33623 "to the default libvirt hypervisor."
33628 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
33629 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
33631 "If you specify guest block devices directly, then libvirt is not used at all."
33636 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
33637 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
33638 msgid "B<--format> raw"
33643 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
33644 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
33646 "Specify the format of disk images given on the command line. If this is "
33647 "omitted then the format is autodetected from the content of the disk image."
33652 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
33653 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
33655 "If disk images are requested from libvirt, then this program asks libvirt "
33656 "for this information. In this case, the value of the format parameter is "
33662 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
33663 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
33665 "If working with untrusted raw-format guest disk images, you should ensure "
33666 "the format is always specified."
33671 #: ../tools/virt-win-reg.pl:157
33677 #: ../tools/virt-win-reg.pl:159
33679 "In merge mode, this merges a textual regedit file into the Windows Registry "
33680 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33681 "displays or exports Registry entries instead."
33685 #: ../tools/virt-win-reg.pl:163
33687 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33688 "result in disk corruption. However exporting (without this flag) is always "
33694 #: ../tools/virt-win-reg.pl:171
33695 msgid "B<--encoding> UTF-16LE|ASCII"
33700 #: ../tools/virt-win-reg.pl:173
33702 "When merging (only), you may need to specify the encoding for strings to be "
33703 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33704 "(3)/ENCODING STRINGS>."
33709 #: ../tools/virt-win-reg.pl:177
33711 "The default is to use UTF-16LE, which should work with recent versions of "
33716 #: ../tools/virt-win-reg.pl:184
33717 msgid "B<--unsafe-printable-strings>"
33721 #: ../tools/virt-win-reg.pl:186
33723 "When exporting (only), assume strings are UTF-16LE and print them as strings "
33724 "instead of hex sequences. Remove the final zero codepoint from strings if "
33729 #: ../tools/virt-win-reg.pl:190
33731 "This is unsafe and does not preserve the fidelity of strings in the original "
33732 "Registry for various reasons:"
33736 #: ../tools/virt-win-reg.pl:197
33738 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
33739 "other encodings will be corrupted by this transformation."
33743 #: ../tools/virt-win-reg.pl:202
33745 "Assumes that everything which has type 1 or 2 is really a string and that "
33746 "everything else is not a string, but the type field in real Registries is "
33751 #: ../tools/virt-win-reg.pl:208
33753 "Loses information about whether a zero codepoint followed the string in the "
33758 #: ../tools/virt-win-reg.pl:213
33760 "This all happens because the Registry itself contains no information about "
33761 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
33765 #: ../tools/virt-win-reg.pl:217
33767 "You should only use this option for quick hacking and debugging of the "
33768 "Registry contents, and I<never> use it if the output is going to be passed "
33769 "into another program or stored in another Registry."
33774 #: ../tools/virt-win-reg.pl:554
33775 msgid "SUPPORTED SYSTEMS"
33780 #: ../tools/virt-win-reg.pl:556
33782 "The program currently supports Windows NT-derived guests starting with "
33783 "Windows XP through to at least Windows 7."
33787 #: ../tools/virt-win-reg.pl:559
33788 msgid "The following Registry keys are supported:"
33792 #: ../tools/virt-win-reg.pl:563
33793 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
33797 #: ../tools/virt-win-reg.pl:565
33798 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
33802 #: ../tools/virt-win-reg.pl:567
33803 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
33807 #: ../tools/virt-win-reg.pl:569
33808 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
33812 #: ../tools/virt-win-reg.pl:571
33813 msgid "C<HKEY_USERS\\.DEFAULT>"
33817 #: ../tools/virt-win-reg.pl:573
33818 msgid "C<HKEY_USERS\\I<SID>>"
33822 #: ../tools/virt-win-reg.pl:575
33823 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
33827 #: ../tools/virt-win-reg.pl:577
33828 msgid "C<HKEY_USERS\\I<username>>"
33832 #: ../tools/virt-win-reg.pl:579
33834 "where I<username> is a local user name (this is a libguestfs extension)."
33839 #: ../tools/virt-win-reg.pl:583
33841 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33846 #: ../tools/virt-win-reg.pl:586
33848 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
33849 "supported (there is no \"current user\")."
33854 #: ../tools/virt-win-reg.pl:589
33860 #: ../tools/virt-win-reg.pl:591
33862 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33863 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33864 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33865 "Windows-style line endings, you may need to reencode the whole file before "
33866 "or after processing."
33870 #: ../tools/virt-win-reg.pl:597
33872 "To reencode a file from Windows format to Linux (before processing it with "
33873 "the I<--merge> option), you would do something like this:"
33878 #: ../tools/virt-win-reg.pl:600
33881 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33887 #: ../tools/virt-win-reg.pl:602
33889 "To go in the opposite direction, after exporting and before sending the file "
33890 "to a Windows user, do something like this:"
33895 #: ../tools/virt-win-reg.pl:605
33898 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33904 #: ../tools/virt-win-reg.pl:607
33905 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33910 #: ../tools/virt-win-reg.pl:609
33912 "If you are unsure about the current encoding, use the L<file(1)> command. "
33913 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33914 "style (CRLF) line endings, like this:"
33919 #: ../tools/virt-win-reg.pl:613
33922 " $ file software.reg\n"
33923 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33924 " with CRLF line terminators\n"
33929 #: ../tools/virt-win-reg.pl:617
33930 msgid "This file would need conversion before you could I<--merge> it."
33935 #: ../tools/virt-win-reg.pl:619
33936 msgid "CurrentControlSet etc."
33941 #: ../tools/virt-win-reg.pl:621
33943 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33944 "Registry at the level of the hive file, and therefore you cannot modify "
33950 #: ../tools/virt-win-reg.pl:625
33952 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33953 "circumstances it might refer to another control set. The way to find out is "
33954 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33959 #: ../tools/virt-win-reg.pl:629
33962 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33963 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33964 " \"Current\"=dword:00000001\n"
33965 " \"Default\"=dword:00000001\n"
33966 " \"Failed\"=dword:00000000\n"
33967 " \"LastKnownGood\"=dword:00000002\n"
33973 #: ../tools/virt-win-reg.pl:636
33974 msgid "\"Current\" is the one which Windows will choose when it boots."
33979 #: ../tools/virt-win-reg.pl:638
33981 "Similarly, other C<Current...> keys in the path may need to be replaced."
33986 #: ../tools/virt-win-reg.pl:641
33987 msgid "WINDOWS TIPS"
33992 #: ../tools/virt-win-reg.pl:643
33994 "Note that some of these tips modify the guest disk image. The guest I<must> "
33995 "be shut off, else you will get disk corruption."
34000 #: ../tools/virt-win-reg.pl:646
34001 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
34006 #: ../tools/virt-win-reg.pl:648
34008 "Prepare a DOS batch script, VBScript or executable. Upload this using "
34009 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
34010 "is uploaded into C<C:\\>:"
34015 #: ../tools/virt-win-reg.pl:652
34018 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
34024 #: ../tools/virt-win-reg.pl:654
34025 msgid "Prepare a regedit file containing the registry change:"
34030 #: ../tools/virt-win-reg.pl:656
34033 " cat > test.reg <<'EOF'\n"
34034 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
34035 " \"Test\"=\"c:\\\\test.bat\"\n"
34042 #: ../tools/virt-win-reg.pl:661
34044 "In this example we use the key C<RunOnce> which means that the script will "
34045 "run precisely once when the first user logs in. If you want it to run every "
34046 "time a user logs in, replace C<RunOnce> with C<Run>."
34051 #: ../tools/virt-win-reg.pl:665
34052 msgid "Now update the registry:"
34057 #: ../tools/virt-win-reg.pl:667
34060 " virt-win-reg --merge WindowsGuest test.reg\n"
34066 #: ../tools/virt-win-reg.pl:669
34067 msgid "INSTALLING A SERVICE"
34072 #: ../tools/virt-win-reg.pl:671
34074 "This section assumes you are familiar with Windows services, and you either "
34075 "have a program which handles the Windows Service Control Protocol directly "
34076 "or you want to run any program using a service wrapper like SrvAny or the "
34082 #: ../tools/virt-win-reg.pl:676
34084 "First upload the program and optionally the service wrapper. In this case "
34085 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
34090 #: ../tools/virt-win-reg.pl:680
34093 " guestfish -i -d WindowsGuest <<EOF\n"
34094 " upload rhsrvany.exe /rhsrvany.exe\n"
34095 " upload test.exe /test.exe\n"
34102 #: ../tools/virt-win-reg.pl:685
34104 "Prepare a regedit file containing the registry changes. In this example, "
34105 "the first registry change is needed for the service itself or the service "
34106 "wrapper (if used). The second registry change is only needed because I am "
34107 "using the RHSrvAny service wrapper."
34112 #: ../tools/virt-win-reg.pl:690
34115 " cat > service.reg <<'EOF'\n"
34116 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
34117 " \"Type\"=dword:00000010\n"
34118 " \"Start\"=dword:00000002\n"
34119 " \"ErrorControl\"=dword:00000001\n"
34120 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
34121 " \"DisplayName\"=\"RHSrvAny\"\n"
34122 " \"ObjectName\"=\"NetworkService\"\n"
34128 #: ../tools/virt-win-reg.pl:699
34131 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
34132 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
34133 " \"PWD\"=\"c:\\\\Temp\"\n"
34140 #: ../tools/virt-win-reg.pl:710
34142 "For use of C<ControlSet001> see the section above in this manual page. You "
34143 "may need to adjust this according to the control set that is in use by the "
34149 #: ../tools/virt-win-reg.pl:716
34151 "C<\"ObjectName\"> controls the privileges that the service will have. An "
34152 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
34153 "privileged account."
34158 #: ../tools/virt-win-reg.pl:722
34160 "For the meaning of the magic numbers, see this Microsoft KB article: "
34161 "L<http://support.microsoft.com/kb/103000>."
34166 #: ../tools/virt-win-reg.pl:727
34167 msgid "Update the registry:"
34172 #: ../tools/virt-win-reg.pl:729
34175 " virt-win-reg --merge WindowsGuest service.reg\n"
34181 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
34182 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
34183 #: ../tools/virt-list-partitions.pl:250
34184 msgid "SHELL QUOTING"
34189 #: ../tools/virt-win-reg.pl:733
34191 "Be careful when passing parameters containing C<\\> (backslash) in the "
34192 "shell. Usually you will have to use 'single quotes' or double backslashes "
34193 "(but not both) to protect them from the shell."
34198 #: ../tools/virt-win-reg.pl:737
34199 msgid "Paths and value names are case-insensitive."
34204 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
34205 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
34206 #: ../tools/virt-list-partitions.pl:252
34208 "Libvirt guest names can contain arbitrary characters, some of which have "
34209 "meaning to the shell such as C<#> and space. You may need to quote or "
34210 "escape these characters on the command line. See the shell manual page L<sh"
34211 "(1)> for details."
34216 #: ../tools/virt-win-reg.pl:746
34218 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
34219 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
34220 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34225 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
34227 "When reporting bugs, please enable debugging and capture the I<complete> "
34233 #: ../tools/virt-win-reg.pl:764
34236 " export LIBGUESTFS_DEBUG=1\n"
34237 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
34243 #: ../tools/virt-win-reg.pl:767
34245 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
34251 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
34252 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
34253 #: ../tools/virt-list-partitions.pl:269
34259 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
34260 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
34261 #: ../tools/virt-list-partitions.pl:271
34262 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
34267 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
34268 msgid "Copyright (C) 2010 Red Hat Inc."
34273 #: ../tools/virt-list-filesystems.pl:32
34275 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34280 #: ../tools/virt-list-filesystems.pl:36
34283 " virt-list-filesystems [--options] domname\n"
34289 #: ../tools/virt-list-filesystems.pl:38
34292 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34298 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34300 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34306 #: ../tools/virt-list-filesystems.pl:45
34308 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34309 "are contained in a virtual machine or disk image."
34314 #: ../tools/virt-list-filesystems.pl:49
34316 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34317 "functionality. For more complex cases you should look at the L<guestfish(1)"
34323 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34324 msgid "B<-l> | B<--long>"
34329 #: ../tools/virt-list-filesystems.pl:108
34331 "With this option, C<virt-list-filesystems> displays the type of each "
34332 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34337 #: ../tools/virt-list-filesystems.pl:115
34338 msgid "B<-a> | B<--all>"
34343 #: ../tools/virt-list-filesystems.pl:117
34345 "Normally we only show mountable filesystems. If this option is given then "
34346 "swap devices are shown too."
34351 #: ../tools/virt-list-filesystems.pl:191
34353 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34354 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34355 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34360 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34361 msgid "Copyright (C) 2009 Red Hat Inc."
34366 #: ../tools/virt-tar.pl:33
34367 msgid "virt-tar - Extract or upload files to a virtual machine"
34372 #: ../tools/virt-tar.pl:37
34375 " virt-tar [--options] -x domname directory tarball\n"
34381 #: ../tools/virt-tar.pl:39
34384 " virt-tar [--options] -u domname tarball directory\n"
34390 #: ../tools/virt-tar.pl:41
34393 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34399 #: ../tools/virt-tar.pl:43
34402 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34407 #: ../tools/virt-tar.pl:47
34409 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34410 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34415 #: ../tools/virt-tar.pl:52
34416 msgid "Download C</home> from the VM into a local tarball:"
34421 #: ../tools/virt-tar.pl:54
34424 " virt-tar -x domname /home home.tar\n"
34430 #: ../tools/virt-tar.pl:56
34433 " virt-tar -zx domname /home home.tar.gz\n"
34439 #: ../tools/virt-tar.pl:58
34440 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34445 #: ../tools/virt-tar.pl:60
34448 " virt-tar -u domname uploadstuff.tar /tmp\n"
34454 #: ../tools/virt-tar.pl:62
34457 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34462 #: ../tools/virt-tar.pl:66
34464 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34465 "virtual machines. If you do this, you risk disk corruption in the VM. "
34466 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34470 #: ../tools/virt-tar.pl:71
34472 "You can use I<-x> (extract) on live virtual machines, but you might get "
34473 "inconsistent results or errors if there is filesystem activity inside the "
34474 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34475 "work, but the only way to guarantee consistent results is if the virtual "
34476 "machine is shut down."
34481 #: ../tools/virt-tar.pl:79
34483 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34484 "parts of a guest filesystem. There are many possibilities: making backups, "
34485 "uploading data files, snooping on guest activity, fixing or customizing "
34491 #: ../tools/virt-tar.pl:84
34493 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34494 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34495 "should look at the L<guestfish(1)> tool."
34499 #: ../tools/virt-tar.pl:88
34501 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34502 "its contents (recursively) from the virtual machine into a local tarball. "
34503 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34504 "virtual machine. You cannot use these two options together."
34508 #: ../tools/virt-tar.pl:94
34510 "In addition, you may need to use the I<-z> (gZip) option to enable "
34511 "compression. When uploading, you have to specify I<-z> if the upload file "
34512 "is compressed because virt-tar won't detect this on its own."
34517 #: ../tools/virt-tar.pl:98
34519 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34520 "example it cannot do PKZip files or bzip2 compression. If you want that "
34521 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34522 "the L<libguestfs(3)> API)."
34527 #: ../tools/virt-tar.pl:156
34528 msgid "B<-x> | B<--extract> | B<--download>"
34533 #: ../tools/virt-tar.pl:158
34534 msgid "B<-u> | B<--upload>"
34538 #: ../tools/virt-tar.pl:160
34540 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34545 #: ../tools/virt-tar.pl:163
34547 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34548 "Please read the L</WARNING> section above before using this option."
34553 #: ../tools/virt-tar.pl:167
34554 msgid "You must specify exactly one of these options."
34559 #: ../tools/virt-tar.pl:173
34560 msgid "B<-z> | B<--gzip>"
34565 #: ../tools/virt-tar.pl:175
34566 msgid "Specify that the input or output tarball is gzip-compressed."
34570 #: ../tools/virt-tar.pl:288
34572 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34573 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34574 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34580 #: ../tools/virt-make-fs.pl:37
34581 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34586 #: ../tools/virt-make-fs.pl:41
34589 " virt-make-fs [--options] input.tar output.img\n"
34595 #: ../tools/virt-make-fs.pl:43
34598 " virt-make-fs [--options] input.tar.gz output.img\n"
34604 #: ../tools/virt-make-fs.pl:45
34607 " virt-make-fs [--options] directory output.img\n"
34613 #: ../tools/virt-make-fs.pl:49
34615 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34616 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34617 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34618 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34619 "you want to attach these filesystems to existing virtual machines (eg. to "
34620 "import large amounts of read-only data to a VM)."
34625 #: ../tools/virt-make-fs.pl:57
34626 msgid "Basic usage is:"
34631 #: ../tools/virt-make-fs.pl:59
34634 " virt-make-fs input output\n"
34640 #: ../tools/virt-make-fs.pl:61
34642 "where C<input> is either a directory containing files that you want to add, "
34643 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34644 "C<output> is a disk image. The input type is detected automatically. The "
34645 "output disk image defaults to a raw ext2 image unless you specify extra "
34646 "flags (see L</OPTIONS> below)."
34651 #: ../tools/virt-make-fs.pl:67
34652 msgid "EXTRA SPACE"
34656 #: ../tools/virt-make-fs.pl:69
34658 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34659 "the files that it contains, but might have extra space. Depending on how "
34660 "you are going to use the output, you might think this extra space is wasted "
34661 "and want to minimize it, or you might want to leave space so that more files "
34662 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34663 "but you can use the I<--size> flag to leave space in the filesystem if you "
34668 #: ../tools/virt-make-fs.pl:77
34670 "An alternative way to leave extra space but not make the output image any "
34671 "bigger is to use an alternative disk image format (instead of the default "
34672 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34673 "image format (check your hypervisor supports this before using it). This "
34674 "allows you to choose a large I<--size> but the extra space won't actually be "
34675 "allocated in the image until you try to store something in it."
34679 #: ../tools/virt-make-fs.pl:85
34681 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34682 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34683 "to build another image from scratch."
34688 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34689 #: ../tools/virt-make-fs.pl:142
34695 #: ../tools/virt-make-fs.pl:91
34698 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34704 #: ../tools/virt-make-fs.pl:93
34705 msgid "FILESYSTEM TYPE"
34710 #: ../tools/virt-make-fs.pl:95
34712 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34713 "libguestfs supports can be used (but I<not> read-only formats like "
34714 "ISO9660). Here are some of the more common choices:"
34719 #: ../tools/virt-make-fs.pl:101
34725 #: ../tools/virt-make-fs.pl:103
34727 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34728 "you are not going to use the filesystem in a way that requires the journal, "
34729 "then this is just wasted overhead."
34734 #: ../tools/virt-make-fs.pl:107
34735 msgid "I<ntfs> or I<vfat>"
34740 #: ../tools/virt-make-fs.pl:109
34741 msgid "Useful if exporting data to a Windows guest."
34746 #: ../tools/virt-make-fs.pl:111
34748 "I<Note for vfat>: The tar archive or local directory must only contain files "
34749 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34750 "program running within libguestfs is unable to change the ownership of non-"
34751 "root files, since vfat itself does not support this."
34756 #: ../tools/virt-make-fs.pl:116
34762 #: ../tools/virt-make-fs.pl:118
34764 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34765 "total filesystem size."
34770 #: ../tools/virt-make-fs.pl:125
34773 " virt-make-fs --type=minix input minixfs.img\n"
34779 #: ../tools/virt-make-fs.pl:127
34780 msgid "TO PARTITION OR NOT TO PARTITION"
34785 #: ../tools/virt-make-fs.pl:129
34786 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34791 #: ../tools/virt-make-fs.pl:131
34793 "Adding a partition can make the disk image more compatible with certain "
34794 "virtualized operating systems which don't expect to see a filesystem "
34795 "directly located on a block device (Linux doesn't care and will happily "
34796 "handle both types)."
34801 #: ../tools/virt-make-fs.pl:136
34803 "On the other hand, if you have a partition table then the output image is no "
34804 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34805 "directly on a partitioned disk image. (However libguestfs tools such as "
34806 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34811 #: ../tools/virt-make-fs.pl:144
34812 msgid "Add an MBR partition:"
34817 #: ../tools/virt-make-fs.pl:146
34820 " virt-make-fs --partition -- input disk.img\n"
34826 #: ../tools/virt-make-fs.pl:148
34828 "If the output disk image could be terabyte-sized or larger, it's better to "
34829 "use an EFI/GPT-compatible partition table:"
34834 #: ../tools/virt-make-fs.pl:151
34837 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34843 #: ../tools/virt-make-fs.pl:179
34844 msgid "Enable debugging information."
34849 #: ../tools/virt-make-fs.pl:185
34850 msgid "B<--size=E<lt>NE<gt>>"
34855 #: ../tools/virt-make-fs.pl:187
34856 msgid "B<--size=+E<lt>NE<gt>>"
34861 #: ../tools/virt-make-fs.pl:189
34862 msgid "B<-s E<lt>NE<gt>>"
34867 #: ../tools/virt-make-fs.pl:191
34868 msgid "B<-s +E<lt>NE<gt>>"
34872 #: ../tools/virt-make-fs.pl:193
34874 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34879 #: ../tools/virt-make-fs.pl:196
34881 "If this option is I<not> given, then the output image will be just large "
34882 "enough to contain all the files, with not much wasted space."
34887 #: ../tools/virt-make-fs.pl:199
34889 "To choose a fixed size output disk, specify an absolute number followed by b/"
34890 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34891 "Petabytes or Exabytes. This must be large enough to contain all the input "
34892 "files, else you will get an error."
34896 #: ../tools/virt-make-fs.pl:204
34898 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34899 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34900 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34901 "the input files, and (approximately) an extra 200 MB free space."
34906 #: ../tools/virt-make-fs.pl:210
34908 "Note that virt-make-fs estimates free space, and therefore will not produce "
34909 "filesystems containing precisely the free space requested. (It is much more "
34910 "expensive and time-consuming to produce a filesystem which has precisely the "
34911 "desired free space)."
34916 #: ../tools/virt-make-fs.pl:219
34917 msgid "B<--format=E<lt>fmtE<gt>>"
34922 #: ../tools/virt-make-fs.pl:221
34923 msgid "B<-F E<lt>fmtE<gt>>"
34928 #: ../tools/virt-make-fs.pl:223
34929 msgid "Choose the output disk image format."
34934 #: ../tools/virt-make-fs.pl:225
34935 msgid "The default is C<raw> (raw disk image)."
34940 #: ../tools/virt-make-fs.pl:227
34942 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34943 "that would really make sense here is C<qcow2>."
34948 #: ../tools/virt-make-fs.pl:234
34949 msgid "B<--type=E<lt>fsE<gt>>"
34954 #: ../tools/virt-make-fs.pl:236
34955 msgid "B<-t E<lt>fsE<gt>>"
34960 #: ../tools/virt-make-fs.pl:238
34961 msgid "Choose the output filesystem type."
34966 #: ../tools/virt-make-fs.pl:240
34967 msgid "The default is C<ext2>."
34972 #: ../tools/virt-make-fs.pl:242
34974 "Any filesystem which is supported read-write by libguestfs can be used here."
34979 #: ../tools/virt-make-fs.pl:249
34980 msgid "B<--partition>"
34985 #: ../tools/virt-make-fs.pl:251
34986 msgid "B<--partition=E<lt>parttypeE<gt>>"
34991 #: ../tools/virt-make-fs.pl:253
34993 "If specified, this flag adds an MBR partition table to the output disk image."
34997 #: ../tools/virt-make-fs.pl:256
34999 "You can change the partition table type, eg. I<--partition=gpt> for large "
35004 #: ../tools/virt-make-fs.pl:259
35006 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
35007 "might consider the next parameter to be the partition type. For example:"
35012 #: ../tools/virt-make-fs.pl:263
35015 " virt-make-fs --partition input.tar ...\n"
35020 #: ../tools/virt-make-fs.pl:265
35022 "would cause virt-make-fs to think you wanted to use a partition type of "
35023 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
35024 "dash) between options and the input file argument:"
35029 #: ../tools/virt-make-fs.pl:269
35032 " virt-make-fs --partition -- input.tar ...\n"
35037 #: ../tools/virt-make-fs.pl:541
35039 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35040 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35041 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35046 #: ../tools/virt-make-fs.pl:558
35049 " export LIBGUESTFS_DEBUG=1\n"
35050 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35056 #: ../tools/virt-make-fs.pl:561
35058 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35064 #: ../tools/virt-list-partitions.pl:32
35066 "virt-list-partitions - List partitions in a virtual machine or disk image"
35071 #: ../tools/virt-list-partitions.pl:36
35074 " virt-list-partitions [--options] domname\n"
35080 #: ../tools/virt-list-partitions.pl:38
35083 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35089 #: ../tools/virt-list-partitions.pl:45
35091 "C<virt-list-partitions> is a command line tool to list the partitions that "
35092 "are contained in a virtual machine or disk image. It is mainly useful as a "
35093 "first step to using L<virt-resize(1)>."
35098 #: ../tools/virt-list-partitions.pl:50
35100 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35101 "functionality. For more complex cases you should look at the L<guestfish(1)"
35107 #: ../tools/virt-list-partitions.pl:107
35108 msgid "B<-h> | B<--human-readable>"
35113 #: ../tools/virt-list-partitions.pl:109
35114 msgid "Show sizes in human-readable form (eg. \"1G\")."
35119 #: ../tools/virt-list-partitions.pl:117
35121 "With this option, C<virt-list-partitions> displays the type and size of each "
35122 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35127 #: ../tools/virt-list-partitions.pl:124
35128 msgid "B<-t> | B<--total>"
35133 #: ../tools/virt-list-partitions.pl:126
35135 "Display the total size of each block device (as a separate row or rows)."
35140 #: ../tools/virt-list-partitions.pl:259
35142 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35143 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35144 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35149 #: ../tools/virt-list-partitions.pl:275
35150 msgid "Copyright (C) 2009-2010 Red Hat Inc."