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-06-28 19:35+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:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975
927 #: ../src/guestfs.pod:2979 ../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:1603
931 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
932 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623
933 #: ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631
934 #: ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645
935 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787
936 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796
937 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862
938 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871
939 #: ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2789
940 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2804
941 #: ../src/guestfs-actions.pod:2811 ../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:1074
947 #: ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082
948 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094
949 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102
950 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
951 #: ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210
952 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
953 #: ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266
954 #: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275
955 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908
956 #: ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923
957 #: ../fish/guestfish-actions.pod:1930 ../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:1858 ../src/guestfs-actions.pod:2779
3666 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262
3667 #: ../fish/guestfish-actions.pod:1898 ../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:5951
5577 #: ../fish/guestfish-actions.pod:3958
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
5615 msgid "Outside contributions, experimental parts."
5619 #: ../src/guestfs.pod:2665
5624 #: ../src/guestfs.pod:2667
5626 "The daemon that runs inside the libguestfs appliance and carries out actions."
5630 #: ../src/guestfs.pod:2670
5635 #: ../src/guestfs.pod:2672
5636 msgid "L<virt-df(1)> command and documentation."
5640 #: ../src/guestfs.pod:2674
5645 #: ../src/guestfs.pod:2676
5646 msgid "L<virt-edit(1)> command and documentation."
5650 #: ../src/guestfs.pod:2678
5655 #: ../src/guestfs.pod:2680
5656 msgid "C API example code."
5660 #: ../src/guestfs.pod:2682
5665 #: ../src/guestfs.pod:2684
5667 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5668 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5669 "L<virt-tar-out(1)>."
5673 #: ../src/guestfs.pod:2688
5678 #: ../src/guestfs.pod:2690
5680 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5684 #: ../src/guestfs.pod:2692
5685 msgid "C<generator>"
5689 #: ../src/guestfs.pod:2694
5691 "The crucially important generator, used to automatically generate large "
5692 "amounts of boilerplate C code for things like RPC and bindings."
5696 #: ../src/guestfs.pod:2697
5701 #: ../src/guestfs.pod:2699
5702 msgid "Files used by the test suite."
5706 #: ../src/guestfs.pod:2701
5707 msgid "Some \"phony\" guest images which we test against."
5711 #: ../src/guestfs.pod:2703
5712 msgid "C<inspector>"
5716 #: ../src/guestfs.pod:2705
5717 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5721 #: ../src/guestfs.pod:2707
5726 #: ../src/guestfs.pod:2709
5727 msgid "Logo used on the website. The fish is called Arthur by the way."
5731 #: ../src/guestfs.pod:2711
5736 #: ../src/guestfs.pod:2713
5737 msgid "M4 macros used by autoconf."
5741 #: ../src/guestfs.pod:2715
5746 #: ../src/guestfs.pod:2717
5747 msgid "Translations of simple gettext strings."
5751 #: ../src/guestfs.pod:2719
5756 #: ../src/guestfs.pod:2721
5758 "The build infrastructure and PO files for translations of manpages and POD "
5759 "files. Eventually this will be combined with the C<po> directory, but that "
5760 "is rather complicated."
5764 #: ../src/guestfs.pod:2725
5765 msgid "C<regressions>"
5769 #: ../src/guestfs.pod:2727
5770 msgid "Regression tests."
5774 #: ../src/guestfs.pod:2729
5779 #: ../src/guestfs.pod:2731
5780 msgid "L<virt-rescue(1)> command and documentation."
5784 #: ../src/guestfs.pod:2733
5789 #: ../src/guestfs.pod:2735
5790 msgid "Source code to the C library."
5794 #: ../src/guestfs.pod:2737
5799 #: ../src/guestfs.pod:2739
5800 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5804 #: ../src/guestfs.pod:2741
5805 msgid "C<test-tool>"
5809 #: ../src/guestfs.pod:2743
5811 "Test tool for end users to test if their qemu/kernel combination will work "
5816 #: ../src/guestfs.pod:2746
5821 #: ../src/guestfs.pod:2748
5826 #: ../src/guestfs.pod:2750
5831 #: ../src/guestfs.pod:2752
5836 #: ../src/guestfs.pod:2754
5841 #: ../src/guestfs.pod:2756
5846 #: ../src/guestfs.pod:2758
5851 #: ../src/guestfs.pod:2760
5856 #: ../src/guestfs.pod:2762
5857 msgid "Language bindings."
5861 #: ../src/guestfs.pod:2766
5867 #: ../src/guestfs.pod:2768
5868 msgid "PROTOCOL LIMITS"
5873 #: ../src/guestfs.pod:2770
5875 "Internally libguestfs uses a message-based protocol to pass API calls and "
5876 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5877 "plenty more detail about this). The maximum message size used by the "
5878 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5879 "aware of this limit. The API calls which may be affected are individually "
5880 "documented, with a link back to this section of the documentation."
5885 #: ../src/guestfs.pod:2778
5887 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5888 "a simple string. Because this string is at some point internally encoded as "
5889 "a message, the maximum size that it can return is slightly under 4 MB. If "
5890 "the requested file is larger than this then you will get an error."
5895 #: ../src/guestfs.pod:2784
5897 "In order to transfer large files into and out of the guest filesystem, you "
5898 "need to use particular calls that support this. The sections L</UPLOADING> "
5899 "and L</DOWNLOADING> document how to do this."
5904 #: ../src/guestfs.pod:2788
5906 "You might also consider mounting the disk image using our FUSE filesystem "
5907 "support (L<guestmount(1)>)."
5911 #: ../src/guestfs.pod:2791
5912 msgid "MAXIMUM NUMBER OF DISKS"
5916 #: ../src/guestfs.pod:2793
5917 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5921 #: ../src/guestfs.pod:2796
5923 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5924 "slots. However febootstrap only understands disks with names C</dev/vda> "
5925 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5930 #: ../src/guestfs.pod:2801
5932 "We are working to substantially raise this limit in future versions but it "
5933 "requires complex changes to qemu."
5937 #: ../src/guestfs.pod:2804
5939 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5940 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5941 "requires changes to qemu."
5945 #: ../src/guestfs.pod:2808
5946 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5950 #: ../src/guestfs.pod:2810
5951 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5955 #: ../src/guestfs.pod:2812
5957 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5958 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5962 #: ../src/guestfs.pod:2815
5964 "If you attach a disk with more than 15 partitions, the extra partitions are "
5965 "ignored by libguestfs."
5969 #: ../src/guestfs.pod:2818
5970 msgid "MAXIMUM SIZE OF A DISK"
5974 #: ../src/guestfs.pod:2820
5975 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5979 #: ../src/guestfs.pod:2822
5981 "We have tested block devices up to 1 exabyte (2**60 or "
5982 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5987 #: ../src/guestfs.pod:2826
5989 "Although libguestfs probably does not impose any limit, the underlying host "
5990 "storage will. If you store disk images on a host ext4 filesystem, then the "
5991 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5992 "TB). If you store disk images as host logical volumes then you are limited "
5993 "by the maximum size of an LV."
5997 #: ../src/guestfs.pod:2832
5999 "For the hugest disk image files, we recommend using XFS on the host for "
6004 #: ../src/guestfs.pod:2835
6005 msgid "MAXIMUM SIZE OF A PARTITION"
6009 #: ../src/guestfs.pod:2837
6011 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6012 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6013 "address a partition located beyond 2 TB on the disk."
6017 #: ../src/guestfs.pod:2841
6019 "It is recommended that you use GPT partitions on disks which are larger than "
6020 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6021 "which are theoretically larger than the largest disk we could support."
6025 #: ../src/guestfs.pod:2846
6026 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6030 #: ../src/guestfs.pod:2848
6032 "This depends on the filesystem type. libguestfs itself does not impose any "
6033 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6034 "what these limits are."
6038 #: ../src/guestfs.pod:2852
6039 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6043 #: ../src/guestfs.pod:2854
6045 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6046 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6047 "uploads and downloads."
6051 #: ../src/guestfs.pod:2858
6052 msgid "INSPECTION LIMITS"
6056 #: ../src/guestfs.pod:2860
6058 "The inspection code has several arbitrary limits on things like the size of "
6059 "Windows Registry hive it will read, and the length of product name. These "
6060 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6061 "memory and disk space on the host, and should not be reached in practice. "
6062 "See the source code for more information."
6067 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017
6068 #: ../test-tool/libguestfs-test-tool.pod:82
6069 msgid "ENVIRONMENT VARIABLES"
6074 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1048
6075 msgid "LIBGUESTFS_APPEND"
6080 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1050
6081 msgid "Pass additional options to the guest kernel."
6086 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1052
6087 msgid "LIBGUESTFS_DEBUG"
6092 #: ../src/guestfs.pod:2876
6094 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6095 "effect as calling C<guestfs_set_verbose (g, 1)>."
6100 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1057
6101 msgid "LIBGUESTFS_MEMSIZE"
6106 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1059
6108 "Set the memory allocated to the qemu process, in megabytes. For example:"
6113 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1062
6116 " LIBGUESTFS_MEMSIZE=700\n"
6122 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1064
6123 msgid "LIBGUESTFS_PATH"
6127 #: ../src/guestfs.pod:2888
6129 "Set the path that libguestfs uses to search for a supermin appliance. See "
6130 "the discussion of paths in section L</PATH> above."
6135 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1069
6136 msgid "LIBGUESTFS_QEMU"
6141 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1071
6143 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6144 "which was found at compile time by the configure script is used."
6149 #: ../src/guestfs.pod:2897
6150 msgid "See also L</QEMU WRAPPERS> above."
6155 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1075
6156 msgid "LIBGUESTFS_TRACE"
6161 #: ../src/guestfs.pod:2901
6163 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6164 "effect as calling C<guestfs_set_trace (g, 1)>."
6169 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1084
6174 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1086
6176 "Location of temporary directory, defaults to C</tmp> except for the cached "
6177 "supermin appliance which defaults to C</var/tmp>."
6181 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1089
6183 "If libguestfs was compiled to use the supermin appliance then the real "
6184 "appliance is cached in this directory, shared between all handles belonging "
6185 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6186 "use in case C</var/tmp> is not large enough."
6191 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1156
6192 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
6193 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
6194 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6195 #: ../tools/virt-list-partitions.pl:257
6200 #: ../src/guestfs.pod:2919
6202 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6203 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6204 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6205 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6206 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6207 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6208 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6213 #: ../src/guestfs.pod:2946
6215 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6216 "(8)>, L<disktype(1)>."
6221 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:759
6222 #: ../tools/virt-make-fs.pl:553
6228 #: ../src/guestfs.pod:2955
6229 msgid "To get a list of bugs against libguestfs use this link:"
6234 #: ../src/guestfs.pod:2957
6236 "L<https://bugzilla.redhat.com/buglist.cgi?"
6237 "component=libguestfs&product=Virtualization+Tools>"
6242 #: ../src/guestfs.pod:2959
6243 msgid "To report a new bug against libguestfs use this link:"
6248 #: ../src/guestfs.pod:2961
6250 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6251 "component=libguestfs&product=Virtualization+Tools>"
6256 #: ../src/guestfs.pod:2963
6257 msgid "When reporting a bug, please check:"
6262 #: ../src/guestfs.pod:2969
6263 msgid "That the bug hasn't been reported already."
6268 #: ../src/guestfs.pod:2973
6269 msgid "That you are testing a recent version."
6274 #: ../src/guestfs.pod:2977
6275 msgid "Describe the bug accurately, and give a way to reproduce it."
6280 #: ../src/guestfs.pod:2981
6282 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6288 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1180
6289 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
6295 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1182
6296 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
6297 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6302 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1184
6303 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
6304 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
6305 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6306 #: ../tools/virt-list-partitions.pl:273
6311 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1186
6312 #: ../test-tool/libguestfs-test-tool.pod:99
6313 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6318 #: ../src/guestfs.pod:2995
6320 "This library is free software; you can redistribute it and/or modify it "
6321 "under the terms of the GNU Lesser General Public License as published by the "
6322 "Free Software Foundation; either version 2 of the License, or (at your "
6323 "option) any later version."
6328 #: ../src/guestfs.pod:3000
6330 "This library is distributed in the hope that it will be useful, but WITHOUT "
6331 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6332 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6338 #: ../src/guestfs.pod:3005
6340 "You should have received a copy of the GNU Lesser General Public License "
6341 "along with this library; if not, write to the Free Software Foundation, "
6342 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6347 #: ../src/guestfs-actions.pod:1
6348 msgid "guestfs_add_cdrom"
6353 #: ../src/guestfs-actions.pod:3
6357 " guestfs_add_cdrom (guestfs_h *g,\n"
6358 " const char *filename);\n"
6364 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6365 msgid "This function adds a virtual CD-ROM disk image to the guest."
6369 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6370 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6375 #: ../src/guestfs-actions.pod:17
6377 "This call checks for the existence of C<filename>. This stops you from "
6378 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6379 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6385 #: ../src/guestfs-actions.pod:24
6387 "If you just want to add an ISO file (often you use this as an efficient way "
6388 "to transfer large files into the guest), then you should probably use "
6389 "C<guestfs_add_drive_ro> instead."
6394 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6395 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6396 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6397 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6398 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6399 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6400 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6401 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6402 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6403 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6404 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6405 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
6406 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
6407 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
6408 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
6409 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
6410 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
6411 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
6412 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720
6413 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2269
6414 #: ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2474
6415 #: ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3529
6416 #: ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3569
6417 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3750
6418 #: ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3777
6419 #: ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3828
6420 #: ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3920
6421 #: ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3960
6422 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4015
6423 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4053
6424 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4100
6425 #: ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4152
6426 #: ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4180
6427 #: ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4290
6428 #: ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4323
6429 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4392
6430 #: ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4426
6431 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4454
6432 #: ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486
6433 #: ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4564
6434 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4668
6435 #: ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4706
6436 #: ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735
6437 #: ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:4763
6438 #: ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4813
6439 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
6440 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4917
6441 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4983
6442 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034
6443 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5079
6444 #: ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5231
6445 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5310
6446 #: ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5360
6447 #: ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5443
6448 #: ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:5470
6449 #: ../src/guestfs-actions.pod:5759 ../src/guestfs-actions.pod:5778
6450 #: ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5809
6451 #: ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5835
6452 #: ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5861
6453 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5898
6454 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5936
6455 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5982
6456 #: ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6023
6457 #: ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6063
6458 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6099
6459 #: ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6151
6460 #: ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6194
6461 #: ../src/guestfs-actions.pod:6213 ../src/guestfs-actions.pod:6228
6462 #: ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6284
6463 #: ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6347
6464 #: ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6590
6465 #: ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6615
6466 #: ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:6650
6467 #: ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6676
6468 #: ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6704
6469 #: ../src/guestfs-actions.pod:6763 ../src/guestfs-actions.pod:6780
6470 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6812
6471 #: ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842
6472 #: ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6898
6473 #: ../src/guestfs-actions.pod:6912 ../src/guestfs-actions.pod:6953
6474 #: ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6984
6475 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7054
6476 #: ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7191
6477 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7260
6478 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7318
6479 #: ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7412
6480 #: ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7505
6481 #: ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7553
6482 msgid "This function returns 0 on success or -1 on error."
6487 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6488 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6489 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6491 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6497 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6498 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6499 #: ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:1968
6500 #: ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4818
6501 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6322
6502 #: ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6414
6503 #: ../src/guestfs-actions.pod:7356 ../src/guestfs-actions.pod:7446
6504 #: ../src/guestfs-actions.pod:7616 ../fish/guestfish-actions.pod:31
6505 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6506 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6507 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038
6508 #: ../fish/guestfish-actions.pod:3235 ../fish/guestfish-actions.pod:4220
6509 #: ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4265
6510 #: ../fish/guestfish-actions.pod:4303 ../fish/guestfish-actions.pod:4944
6511 #: ../fish/guestfish-actions.pod:5042
6513 "Deprecated functions will not be removed from the API, but the fact that "
6514 "they are deprecated indicates that there are problems with correct use of "
6520 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6521 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1919
6522 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2120
6523 #: ../src/guestfs-actions.pod:3531 ../src/guestfs-actions.pod:3551
6524 #: ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5984
6525 #: ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6215
6526 #: ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6831
6527 #: ../src/guestfs-actions.pod:7360
6528 msgid "(Added in 0.3)"
6533 #: ../src/guestfs-actions.pod:41
6534 msgid "guestfs_add_domain"
6539 #: ../src/guestfs-actions.pod:43
6543 " guestfs_add_domain (guestfs_h *g,\n"
6544 " const char *dom,\n"
6551 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6552 #: ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:4525
6553 #: ../src/guestfs-actions.pod:4832
6555 "You may supply a list of optional arguments to this call. Use zero or more "
6556 "of the following pairs of parameters, and terminate the list with C<-1> on "
6557 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6561 #: ../src/guestfs-actions.pod:53
6564 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6565 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6566 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6567 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6568 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6574 #: ../src/guestfs-actions.pod:59
6576 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6577 "It works by connecting to libvirt, requesting the domain and domain XML from "
6578 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6584 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6586 "The number of disks added is returned. This operation is atomic: if an "
6587 "error is returned, then no disks are added."
6592 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6594 "This function does some minimal checks to make sure the libvirt domain is "
6595 "not running (unless C<readonly> is true). In a future version we will try "
6596 "to acquire the libvirt lock on each disk."
6601 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6603 "Disks must be accessible locally. This often means that adding disks from a "
6604 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6605 "unless those disks are accessible via the same device path locally too."
6609 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6611 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6612 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6613 "libvirt URI (or one set through an environment variable, see the libvirt "
6614 "documentation for full details)."
6618 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6620 "The optional C<live> flag controls whether this call will try to connect to "
6621 "a running virtual machine C<guestfsd> process if it sees a suitable "
6622 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6623 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6624 "DAEMONS> for more information."
6628 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6630 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6631 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6632 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6638 #: ../src/guestfs-actions.pod:94
6640 "The other optional parameters are passed directly through to "
6641 "C<guestfs_add_drive_opts>."
6646 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6647 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6648 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6649 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6650 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6651 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2029
6652 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:2107
6653 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2866
6654 #: ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:5006
6655 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5540
6656 #: ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:6939
6657 #: ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384
6658 #: ../src/guestfs-actions.pod:7397
6659 msgid "On error this function returns -1."
6664 #: ../src/guestfs-actions.pod:99
6665 msgid "(Added in 1.7.4)"
6670 #: ../src/guestfs-actions.pod:101
6671 msgid "guestfs_add_domain_va"
6676 #: ../src/guestfs-actions.pod:103
6680 " guestfs_add_domain_va (guestfs_h *g,\n"
6681 " const char *dom,\n"
6688 #: ../src/guestfs-actions.pod:108
6689 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6694 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6695 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6696 #: ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2844
6697 #: ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4590
6698 #: ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4870
6699 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6704 #: ../src/guestfs-actions.pod:112
6705 msgid "guestfs_add_domain_argv"
6710 #: ../src/guestfs-actions.pod:114
6714 " guestfs_add_domain_argv (guestfs_h *g,\n"
6715 " const char *dom,\n"
6716 " const struct guestfs_add_domain_argv *optargs);\n"
6722 #: ../src/guestfs-actions.pod:119
6723 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6728 #: ../src/guestfs-actions.pod:123
6729 msgid "guestfs_add_drive"
6734 #: ../src/guestfs-actions.pod:125
6738 " guestfs_add_drive (guestfs_h *g,\n"
6739 " const char *filename);\n"
6745 #: ../src/guestfs-actions.pod:129
6747 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6748 "optional parameters, so the disk is added writable, with the format being "
6749 "detected automatically."
6754 #: ../src/guestfs-actions.pod:133
6756 "Automatic detection of the format opens you up to a potential security hole "
6757 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6758 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6759 "you should think about replacing calls to this function with calls to "
6760 "C<guestfs_add_drive_opts>, and specifying the format."
6765 #: ../src/guestfs-actions.pod:144
6766 msgid "guestfs_add_drive_opts"
6771 #: ../src/guestfs-actions.pod:146
6775 " guestfs_add_drive_opts (guestfs_h *g,\n"
6776 " const char *filename,\n"
6783 #: ../src/guestfs-actions.pod:156
6786 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6787 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6788 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6794 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6796 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6797 "The first time you call this function, the disk appears as C</dev/sda>, the "
6798 "second time as C</dev/sdb>, and so on."
6803 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6805 "You don't necessarily need to be root when using libguestfs. However you "
6806 "obviously do need sufficient permissions to access the filename for whatever "
6807 "operations you want to perform (ie. read access if you just want to read the "
6808 "image or write access if you want to modify the image)."
6813 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6814 msgid "This call checks that C<filename> exists."
6819 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4536
6820 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6821 msgid "The optional arguments are:"
6826 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6832 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6834 "If true then the image is treated as read-only. Writes are still allowed, "
6835 "but they are stored in a temporary snapshot overlay which is discarded at "
6836 "the end. The disk that you add is not modified."
6841 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6847 #: ../src/guestfs-actions.pod:185
6849 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6850 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6851 "Possible formats include C<raw> and C<qcow2>."
6856 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6858 "Automatic detection of the format opens you up to a potential security hole "
6859 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6860 "RHBZ#642934. Specifying the format closes this security hole."
6865 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6871 #: ../src/guestfs-actions.pod:196
6873 "This rarely-used option lets you emulate the behaviour of the deprecated "
6874 "C<guestfs_add_drive_with_if> call (q.v.)"
6879 #: ../src/guestfs-actions.pod:203
6880 msgid "(Added in 1.5.23)"
6885 #: ../src/guestfs-actions.pod:205
6886 msgid "guestfs_add_drive_opts_va"
6891 #: ../src/guestfs-actions.pod:207
6895 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6896 " const char *filename,\n"
6903 #: ../src/guestfs-actions.pod:212
6904 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6909 #: ../src/guestfs-actions.pod:216
6910 msgid "guestfs_add_drive_opts_argv"
6915 #: ../src/guestfs-actions.pod:218
6919 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6920 " const char *filename,\n"
6921 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6927 #: ../src/guestfs-actions.pod:223
6928 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6933 #: ../src/guestfs-actions.pod:227
6934 msgid "guestfs_add_drive_ro"
6939 #: ../src/guestfs-actions.pod:229
6943 " guestfs_add_drive_ro (guestfs_h *g,\n"
6944 " const char *filename);\n"
6950 #: ../src/guestfs-actions.pod:233
6952 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6953 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6954 "disk is added read-only, with the format being detected automatically."
6959 #: ../src/guestfs-actions.pod:240
6960 msgid "(Added in 1.0.38)"
6965 #: ../src/guestfs-actions.pod:242
6966 msgid "guestfs_add_drive_ro_with_if"
6971 #: ../src/guestfs-actions.pod:244
6975 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6976 " const char *filename,\n"
6977 " const char *iface);\n"
6983 #: ../src/guestfs-actions.pod:249
6985 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6986 "QEMU interface emulation to use at run time."
6991 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6992 #: ../src/guestfs-actions.pod:2359
6993 msgid "(Added in 1.0.84)"
6998 #: ../src/guestfs-actions.pod:263
6999 msgid "guestfs_add_drive_with_if"
7004 #: ../src/guestfs-actions.pod:265
7008 " guestfs_add_drive_with_if (guestfs_h *g,\n"
7009 " const char *filename,\n"
7010 " const char *iface);\n"
7016 #: ../src/guestfs-actions.pod:270
7018 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7019 "QEMU interface emulation to use at run time."
7024 #: ../src/guestfs-actions.pod:284
7025 msgid "guestfs_aug_clear"
7030 #: ../src/guestfs-actions.pod:286
7034 " guestfs_aug_clear (guestfs_h *g,\n"
7035 " const char *augpath);\n"
7041 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7043 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7044 "L<augtool(1)> C<clear> command."
7049 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2109
7050 msgid "(Added in 1.3.4)"
7055 #: ../src/guestfs-actions.pod:297
7056 msgid "guestfs_aug_close"
7061 #: ../src/guestfs-actions.pod:299
7065 " guestfs_aug_close (guestfs_h *g);\n"
7071 #: ../src/guestfs-actions.pod:302
7073 "Close the current Augeas handle and free up any resources used by it. After "
7074 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7075 "any other Augeas functions."
7080 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7081 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7082 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7083 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7084 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7085 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7086 #: ../src/guestfs-actions.pod:5617
7087 msgid "(Added in 0.7)"
7092 #: ../src/guestfs-actions.pod:311
7093 msgid "guestfs_aug_defnode"
7098 #: ../src/guestfs-actions.pod:313
7101 " struct guestfs_int_bool *\n"
7102 " guestfs_aug_defnode (guestfs_h *g,\n"
7103 " const char *name,\n"
7104 " const char *expr,\n"
7105 " const char *val);\n"
7111 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7113 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7118 #: ../src/guestfs-actions.pod:322
7120 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7121 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7122 "containing that single node."
7127 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7129 "On success this returns a pair containing the number of nodes in the "
7130 "nodeset, and a boolean flag if a node was created."
7135 #: ../src/guestfs-actions.pod:330
7137 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7138 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7143 #: ../src/guestfs-actions.pod:336
7144 msgid "guestfs_aug_defvar"
7149 #: ../src/guestfs-actions.pod:338
7153 " guestfs_aug_defvar (guestfs_h *g,\n"
7154 " const char *name,\n"
7155 " const char *expr);\n"
7161 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7163 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7164 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7169 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7171 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7172 "evaluates to something which is not a nodeset."
7177 #: ../src/guestfs-actions.pod:354
7178 msgid "guestfs_aug_get"
7183 #: ../src/guestfs-actions.pod:356
7187 " guestfs_aug_get (guestfs_h *g,\n"
7188 " const char *augpath);\n"
7194 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7196 "Look up the value associated with C<path>. If C<path> matches exactly one "
7197 "node, the C<value> is returned."
7202 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
7203 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
7204 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
7205 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
7206 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
7207 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
7208 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
7209 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1941
7210 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2132
7211 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2528
7212 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2720
7213 #: ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2949
7214 #: ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2998
7215 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3089
7216 #: ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3127
7217 #: ../src/guestfs-actions.pod:3722 ../src/guestfs-actions.pod:4072
7218 #: ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4352
7219 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5345
7220 #: ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5693
7221 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6375
7222 #: ../src/guestfs-actions.pod:6391 ../src/guestfs-actions.pod:6408
7223 #: ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7113
7224 #: ../src/guestfs-actions.pod:7132 ../src/guestfs-actions.pod:7150
7225 #: ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7610
7227 "This function returns a string, or NULL on error. I<The caller must free "
7228 "the returned string after use>."
7233 #: ../src/guestfs-actions.pod:368
7234 msgid "guestfs_aug_init"
7239 #: ../src/guestfs-actions.pod:370
7243 " guestfs_aug_init (guestfs_h *g,\n"
7244 " const char *root,\n"
7251 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7253 "Create a new Augeas handle for editing configuration files. If there was "
7254 "any previous Augeas handle associated with this guestfs session, then it is "
7260 #: ../src/guestfs-actions.pod:379
7261 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7266 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7268 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7273 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7275 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7276 "logical I<or> of the following integers:"
7281 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7282 msgid "C<AUG_SAVE_BACKUP> = 1"
7287 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7288 msgid "Keep the original file with a C<.augsave> extension."
7293 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7294 msgid "C<AUG_SAVE_NEWFILE> = 2"
7299 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7301 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7302 "original. Overrides C<AUG_SAVE_BACKUP>."
7307 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7308 msgid "C<AUG_TYPE_CHECK> = 4"
7313 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7314 msgid "Typecheck lenses (can be expensive)."
7319 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7320 msgid "C<AUG_NO_STDINC> = 8"
7325 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7326 msgid "Do not use standard load path for modules."
7331 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7332 msgid "C<AUG_SAVE_NOOP> = 16"
7337 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7338 msgid "Make save a no-op, just record what would have been changed."
7343 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7344 msgid "C<AUG_NO_LOAD> = 32"
7349 #: ../src/guestfs-actions.pod:414
7350 msgid "Do not load the tree in C<guestfs_aug_init>."
7355 #: ../src/guestfs-actions.pod:418
7356 msgid "To close the handle, you can call C<guestfs_aug_close>."
7361 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7362 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7367 #: ../src/guestfs-actions.pod:426
7368 msgid "guestfs_aug_insert"
7373 #: ../src/guestfs-actions.pod:428
7377 " guestfs_aug_insert (guestfs_h *g,\n"
7378 " const char *augpath,\n"
7379 " const char *label,\n"
7386 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7388 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7389 "or after C<path> (depending on the boolean flag C<before>)."
7394 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7396 "C<path> must match exactly one existing node in the tree, and C<label> must "
7397 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7402 #: ../src/guestfs-actions.pod:446
7403 msgid "guestfs_aug_load"
7408 #: ../src/guestfs-actions.pod:448
7412 " guestfs_aug_load (guestfs_h *g);\n"
7418 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7419 msgid "Load files into the tree."
7424 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7425 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7430 #: ../src/guestfs-actions.pod:460
7431 msgid "guestfs_aug_ls"
7436 #: ../src/guestfs-actions.pod:462
7440 " guestfs_aug_ls (guestfs_h *g,\n"
7441 " const char *augpath);\n"
7447 #: ../src/guestfs-actions.pod:466
7449 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7450 "sorting the resulting nodes into alphabetical order."
7455 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7456 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
7457 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
7458 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
7459 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2204
7460 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2239
7461 #: ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2306
7462 #: ../src/guestfs-actions.pod:2377 ../src/guestfs-actions.pod:2426
7463 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:3049
7464 #: ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3627
7465 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3704
7466 #: ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:4214
7467 #: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:5487
7468 #: ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5727
7469 #: ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6516
7470 #: ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6717
7471 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:7223
7472 #: ../src/guestfs-actions.pod:7243 ../src/guestfs-actions.pod:7290
7473 #: ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7481
7474 #: ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7586
7475 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7651
7477 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7478 ">), or NULL if there was an error. I<The caller must free the strings and "
7479 "the array after use>."
7484 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
7485 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
7486 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3426
7487 #: ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4105
7488 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4325
7489 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4971
7490 #: ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5823
7491 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5849
7492 #: ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6955
7493 #: ../src/guestfs-actions.pod:6968 ../src/guestfs-actions.pod:7207
7494 #: ../src/guestfs-actions.pod:7450
7495 msgid "(Added in 0.8)"
7500 #: ../src/guestfs-actions.pod:475
7501 msgid "guestfs_aug_match"
7506 #: ../src/guestfs-actions.pod:477
7510 " guestfs_aug_match (guestfs_h *g,\n"
7511 " const char *augpath);\n"
7517 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7519 "Returns a list of paths which match the path expression C<path>. The "
7520 "returned paths are sufficiently qualified so that they match exactly one "
7521 "node in the current tree."
7526 #: ../src/guestfs-actions.pod:491
7527 msgid "guestfs_aug_mv"
7532 #: ../src/guestfs-actions.pod:493
7536 " guestfs_aug_mv (guestfs_h *g,\n"
7537 " const char *src,\n"
7538 " const char *dest);\n"
7544 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7546 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7547 "C<dest> is overwritten if it exists."
7552 #: ../src/guestfs-actions.pod:505
7553 msgid "guestfs_aug_rm"
7558 #: ../src/guestfs-actions.pod:507
7562 " guestfs_aug_rm (guestfs_h *g,\n"
7563 " const char *augpath);\n"
7569 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7570 msgid "Remove C<path> and all of its children."
7575 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7576 msgid "On success this returns the number of entries which were removed."
7581 #: ../src/guestfs-actions.pod:519
7582 msgid "guestfs_aug_save"
7587 #: ../src/guestfs-actions.pod:521
7591 " guestfs_aug_save (guestfs_h *g);\n"
7597 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7598 msgid "This writes all pending changes to disk."
7603 #: ../src/guestfs-actions.pod:526
7605 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7611 #: ../src/guestfs-actions.pod:533
7612 msgid "guestfs_aug_set"
7617 #: ../src/guestfs-actions.pod:535
7621 " guestfs_aug_set (guestfs_h *g,\n"
7622 " const char *augpath,\n"
7623 " const char *val);\n"
7629 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7630 msgid "Set the value associated with C<path> to C<val>."
7635 #: ../src/guestfs-actions.pod:542
7637 "In the Augeas API, it is possible to clear a node by setting the value to "
7638 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7639 "this call. Instead you must use the C<guestfs_aug_clear> call."
7644 #: ../src/guestfs-actions.pod:551
7645 msgid "guestfs_available"
7650 #: ../src/guestfs-actions.pod:553
7654 " guestfs_available (guestfs_h *g,\n"
7655 " char *const *groups);\n"
7661 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7663 "This command is used to check the availability of some groups of "
7664 "functionality in the appliance, which not all builds of the libguestfs "
7665 "appliance will be able to provide."
7670 #: ../src/guestfs-actions.pod:561
7672 "The libguestfs groups, and the functions that those groups correspond to, "
7673 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7674 "runtime by calling C<guestfs_available_all_groups>."
7679 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7681 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7682 "\"]> would check for the availability of the Linux inotify functions and "
7683 "Augeas (configuration file editing) functions."
7688 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7689 msgid "The command returns no error if I<all> requested groups are available."
7694 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7696 "It fails with an error if one or more of the requested groups is unavailable "
7702 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7704 "If an unknown group name is included in the list of groups then an error is "
7710 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7716 #: ../src/guestfs-actions.pod:585
7717 msgid "You must call C<guestfs_launch> before calling this function."
7722 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7724 "The reason is because we don't know what groups are supported by the "
7725 "appliance/daemon until it is running and can be queried."
7730 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7732 "If a group of functions is available, this does not necessarily mean that "
7733 "they will work. You still have to check for errors when calling individual "
7734 "API functions even if they are available."
7739 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7741 "It is usually the job of distro packagers to build complete functionality "
7742 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7743 "with all requirements satisfied, will support everything."
7748 #: ../src/guestfs-actions.pod:607
7750 "This call was added in version C<1.0.80>. In previous versions of "
7751 "libguestfs all you could do would be to speculatively execute a command to "
7752 "find out if the daemon implemented it. See also C<guestfs_version>."
7757 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7758 msgid "(Added in 1.0.80)"
7763 #: ../src/guestfs-actions.pod:618
7764 msgid "guestfs_available_all_groups"
7769 #: ../src/guestfs-actions.pod:620
7773 " guestfs_available_all_groups (guestfs_h *g);\n"
7779 #: ../src/guestfs-actions.pod:623
7781 "This command returns a list of all optional groups that this daemon knows "
7782 "about. Note this returns both supported and unsupported groups. To find "
7783 "out which ones the daemon can actually support you have to call "
7784 "C<guestfs_available> on each member of the returned list."
7789 #: ../src/guestfs-actions.pod:629
7790 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7795 #: ../src/guestfs-actions.pod:635
7796 msgid "(Added in 1.3.15)"
7801 #: ../src/guestfs-actions.pod:637
7802 msgid "guestfs_base64_in"
7807 #: ../src/guestfs-actions.pod:639
7811 " guestfs_base64_in (guestfs_h *g,\n"
7812 " const char *base64file,\n"
7813 " const char *filename);\n"
7819 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7821 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7826 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7827 msgid "(Added in 1.3.5)"
7832 #: ../src/guestfs-actions.pod:651
7833 msgid "guestfs_base64_out"
7838 #: ../src/guestfs-actions.pod:653
7842 " guestfs_base64_out (guestfs_h *g,\n"
7843 " const char *filename,\n"
7844 " const char *base64file);\n"
7850 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7852 "This command downloads the contents of C<filename>, writing it out to local "
7853 "file C<base64file> encoded as base64."
7858 #: ../src/guestfs-actions.pod:665
7859 msgid "guestfs_blockdev_flushbufs"
7864 #: ../src/guestfs-actions.pod:667
7868 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7869 " const char *device);\n"
7875 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7877 "This tells the kernel to flush internal buffers associated with C<device>."
7882 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7883 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7884 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7885 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7886 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7887 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7888 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7889 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7890 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7891 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7892 msgid "This uses the L<blockdev(8)> command."
7897 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7898 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7899 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7900 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7901 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7902 msgid "(Added in 0.9.3)"
7907 #: ../src/guestfs-actions.pod:680
7908 msgid "guestfs_blockdev_getbsz"
7913 #: ../src/guestfs-actions.pod:682
7917 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7918 " const char *device);\n"
7924 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7925 msgid "This returns the block size of a device."
7930 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7931 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7933 "(Note this is different from both I<size in blocks> and I<filesystem block "
7939 #: ../src/guestfs-actions.pod:697
7940 msgid "guestfs_blockdev_getro"
7945 #: ../src/guestfs-actions.pod:699
7949 " guestfs_blockdev_getro (guestfs_h *g,\n"
7950 " const char *device);\n"
7956 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7958 "Returns a boolean indicating if the block device is read-only (true if read-"
7959 "only, false if not)."
7964 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7965 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1917
7966 #: ../src/guestfs-actions.pod:1928 ../src/guestfs-actions.pod:2000
7967 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2070
7968 #: ../src/guestfs-actions.pod:2095 ../src/guestfs-actions.pod:2118
7969 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158
7970 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3334
7971 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3363
7972 #: ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3393
7973 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3424
7974 #: ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3451
7975 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3480
7976 #: ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3508
7977 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:5116
7978 msgid "This function returns a C truth value on success or -1 on error."
7983 #: ../src/guestfs-actions.pod:712
7984 msgid "guestfs_blockdev_getsize64"
7989 #: ../src/guestfs-actions.pod:714
7993 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7994 " const char *device);\n"
8000 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
8001 msgid "This returns the size of the device in bytes."
8006 #: ../src/guestfs-actions.pod:720
8007 msgid "See also C<guestfs_blockdev_getsz>."
8012 #: ../src/guestfs-actions.pod:728
8013 msgid "guestfs_blockdev_getss"
8018 #: ../src/guestfs-actions.pod:730
8022 " guestfs_blockdev_getss (guestfs_h *g,\n"
8023 " const char *device);\n"
8029 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8031 "This returns the size of sectors on a block device. Usually 512, but can be "
8032 "larger for modern devices."
8037 #: ../src/guestfs-actions.pod:737
8039 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8045 #: ../src/guestfs-actions.pod:746
8046 msgid "guestfs_blockdev_getsz"
8051 #: ../src/guestfs-actions.pod:748
8055 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8056 " const char *device);\n"
8062 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8064 "This returns the size of the device in units of 512-byte sectors (even if "
8065 "the sectorsize isn't 512 bytes ... weird)."
8070 #: ../src/guestfs-actions.pod:755
8072 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8073 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8078 #: ../src/guestfs-actions.pod:765
8079 msgid "guestfs_blockdev_rereadpt"
8084 #: ../src/guestfs-actions.pod:767
8088 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8089 " const char *device);\n"
8095 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8096 msgid "Reread the partition table on C<device>."
8101 #: ../src/guestfs-actions.pod:779
8102 msgid "guestfs_blockdev_setbsz"
8107 #: ../src/guestfs-actions.pod:781
8111 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8112 " const char *device,\n"
8113 " int blocksize);\n"
8119 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8120 msgid "This sets the block size of a device."
8125 #: ../src/guestfs-actions.pod:797
8126 msgid "guestfs_blockdev_setro"
8131 #: ../src/guestfs-actions.pod:799
8135 " guestfs_blockdev_setro (guestfs_h *g,\n"
8136 " const char *device);\n"
8142 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8143 msgid "Sets the block device named C<device> to read-only."
8148 #: ../src/guestfs-actions.pod:811
8149 msgid "guestfs_blockdev_setrw"
8154 #: ../src/guestfs-actions.pod:813
8158 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8159 " const char *device);\n"
8165 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8166 msgid "Sets the block device named C<device> to read-write."
8171 #: ../src/guestfs-actions.pod:825
8172 msgid "guestfs_case_sensitive_path"
8177 #: ../src/guestfs-actions.pod:827
8181 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8182 " const char *path);\n"
8188 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
8190 "This can be used to resolve case insensitive paths on a filesystem which is "
8191 "case sensitive. The use case is to resolve paths which you have read from "
8192 "Windows configuration files or the Windows Registry, to the true path."
8197 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
8199 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8200 "(and probably others), which is that although the underlying filesystem is "
8201 "case-insensitive, the driver exports the filesystem to Linux as case-"
8207 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
8209 "One consequence of this is that special directories such as C<c:\\windows> "
8210 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8211 "precise details of how they were created. In Windows itself this would not "
8217 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
8219 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8225 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
8227 "This function resolves the true case of each element in the path and returns "
8228 "the case-sensitive path."
8233 #: ../src/guestfs-actions.pod:853
8235 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8236 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8237 "how the directories were originally created under Windows)."
8242 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
8243 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8248 #: ../src/guestfs-actions.pod:861
8249 msgid "See also C<guestfs_realpath>."
8254 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7135
8255 msgid "(Added in 1.0.75)"
8260 #: ../src/guestfs-actions.pod:868
8266 #: ../src/guestfs-actions.pod:870
8270 " guestfs_cat (guestfs_h *g,\n"
8271 " const char *path);\n"
8277 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5603
8278 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3717
8279 msgid "Return the contents of the file named C<path>."
8284 #: ../src/guestfs-actions.pod:876
8286 "Note that this function cannot correctly handle binary files (specifically, "
8287 "files containing C<\\0> character which is treated as end of string). For "
8288 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8289 "functions which have a more complex interface."
8294 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
8295 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
8296 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
8297 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
8298 #: ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243
8299 #: ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310
8300 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2356
8301 #: ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5411
8302 #: ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5568
8303 #: ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:6520
8304 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6721
8305 #: ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:7414
8306 #: ../src/guestfs-actions.pod:7440 ../src/guestfs-actions.pod:7466
8307 #: ../src/guestfs-actions.pod:7485 ../src/guestfs-actions.pod:7571
8308 #: ../src/guestfs-actions.pod:7590 ../src/guestfs-actions.pod:7636
8309 #: ../src/guestfs-actions.pod:7655 ../fish/guestfish-actions.pod:592
8310 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8311 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8312 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8313 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
8314 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
8315 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
8316 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3587
8317 #: ../fish/guestfish-actions.pod:3602 ../fish/guestfish-actions.pod:3678
8318 #: ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:3710
8319 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4410
8320 #: ../fish/guestfish-actions.pod:4495 ../fish/guestfish-actions.pod:4510
8321 #: ../fish/guestfish-actions.pod:4920 ../fish/guestfish-actions.pod:4938
8322 #: ../fish/guestfish-actions.pod:4955 ../fish/guestfish-actions.pod:4965
8323 #: ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024
8324 #: ../fish/guestfish-actions.pod:5053 ../fish/guestfish-actions.pod:5063
8326 "Because of the message protocol, there is a transfer limit of somewhere "
8327 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8332 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3646
8333 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3725
8334 #: ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:4218
8335 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5491
8336 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:7294
8337 #: ../src/guestfs-actions.pod:7308
8338 msgid "(Added in 0.4)"
8343 #: ../src/guestfs-actions.pod:889
8344 msgid "guestfs_checksum"
8349 #: ../src/guestfs-actions.pod:891
8353 " guestfs_checksum (guestfs_h *g,\n"
8354 " const char *csumtype,\n"
8355 " const char *path);\n"
8361 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
8363 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8368 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
8370 "The type of checksum to compute is given by the C<csumtype> parameter which "
8371 "must have one of the following values:"
8376 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
8382 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
8384 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8390 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
8396 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
8397 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8402 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
8408 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
8409 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8414 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
8420 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
8421 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8426 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
8432 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
8433 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8438 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
8444 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
8445 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8450 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
8456 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
8457 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8462 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
8463 msgid "The checksum is returned as a printable string."
8468 #: ../src/guestfs-actions.pod:937
8469 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8474 #: ../src/guestfs-actions.pod:939
8475 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8480 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
8481 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:3350
8482 #: ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3440
8483 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:6991
8484 msgid "(Added in 1.0.2)"
8489 #: ../src/guestfs-actions.pod:946
8490 msgid "guestfs_checksum_device"
8495 #: ../src/guestfs-actions.pod:948
8499 " guestfs_checksum_device (guestfs_h *g,\n"
8500 " const char *csumtype,\n"
8501 " const char *device);\n"
8507 #: ../src/guestfs-actions.pod:953
8509 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8510 "device named C<device>. For the types of checksums supported see the "
8511 "C<guestfs_checksum> command."
8516 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5022
8517 #: ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5118
8518 #: ../src/guestfs-actions.pod:5136 ../src/guestfs-actions.pod:5312
8519 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6914
8520 #: ../src/guestfs-actions.pod:7320
8521 msgid "(Added in 1.3.2)"
8526 #: ../src/guestfs-actions.pod:962
8527 msgid "guestfs_checksums_out"
8532 #: ../src/guestfs-actions.pod:964
8536 " guestfs_checksums_out (guestfs_h *g,\n"
8537 " const char *csumtype,\n"
8538 " const char *directory,\n"
8539 " const char *sumsfile);\n"
8545 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
8547 "This command computes the checksums of all regular files in C<directory> and "
8548 "then emits a list of those checksums to the local output file C<sumsfile>."
8553 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
8555 "This can be used for verifying the integrity of a virtual machine. However "
8556 "to be properly secure you should pay attention to the output of the checksum "
8557 "command (it uses the ones from GNU coreutils). In particular when the "
8558 "filename is not printable, coreutils uses a special backslash syntax. For "
8559 "more information, see the GNU coreutils info file."
8564 #: ../src/guestfs-actions.pod:984
8565 msgid "(Added in 1.3.7)"
8570 #: ../src/guestfs-actions.pod:986
8571 msgid "guestfs_chmod"
8576 #: ../src/guestfs-actions.pod:988
8580 " guestfs_chmod (guestfs_h *g,\n"
8582 " const char *path);\n"
8588 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
8590 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8596 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
8598 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8599 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8605 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4469
8606 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4685
8607 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:681
8608 #: ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3142
8609 #: ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3162
8610 msgid "The mode actually set is affected by the umask."
8615 #: ../src/guestfs-actions.pod:1006
8616 msgid "guestfs_chown"
8621 #: ../src/guestfs-actions.pod:1008
8625 " guestfs_chown (guestfs_h *g,\n"
8628 " const char *path);\n"
8634 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
8635 msgid "Change the file owner to C<owner> and group to C<group>."
8640 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3565
8641 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
8643 "Only numeric uid and gid are supported. If you want to use names, you will "
8644 "need to locate and parse the password file yourself (Augeas support makes "
8645 "this relatively easy)."
8650 #: ../src/guestfs-actions.pod:1024
8651 msgid "guestfs_command"
8656 #: ../src/guestfs-actions.pod:1026
8660 " guestfs_command (guestfs_h *g,\n"
8661 " char *const *arguments);\n"
8667 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
8669 "This call runs a command from the guest filesystem. The filesystem must be "
8670 "mounted, and must contain a compatible operating system (ie. something "
8671 "Linux, with the same or compatible processor architecture)."
8676 #: ../src/guestfs-actions.pod:1035
8678 "The single parameter is an argv-style list of arguments. The first element "
8679 "is the name of the program to run. Subsequent elements are parameters. The "
8680 "list must be non-empty (ie. must contain a program name). Note that the "
8681 "command runs directly, and is I<not> invoked via the shell (see "
8687 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
8688 msgid "The return value is anything printed to I<stdout> by the command."
8693 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
8695 "If the command returns a non-zero exit status, then this function returns an "
8696 "error message. The error message string is the content of I<stderr> from "
8702 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
8704 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8705 "bin>. If you require a program from another location, you should provide "
8706 "the full path in the first parameter."
8711 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8713 "Shared libraries and data files required by the program must be available on "
8714 "filesystems which are mounted in the correct places. It is the caller's "
8715 "responsibility to ensure all filesystems that are needed are mounted at the "
8721 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8722 #: ../src/guestfs-actions.pod:1551
8723 msgid "(Added in 0.9.1)"
8728 #: ../src/guestfs-actions.pod:1068
8729 msgid "guestfs_command_lines"
8734 #: ../src/guestfs-actions.pod:1070
8738 " guestfs_command_lines (guestfs_h *g,\n"
8739 " char *const *arguments);\n"
8745 #: ../src/guestfs-actions.pod:1074
8747 "This is the same as C<guestfs_command>, but splits the result into a list of "
8753 #: ../src/guestfs-actions.pod:1077
8754 msgid "See also: C<guestfs_sh_lines>"
8759 #: ../src/guestfs-actions.pod:1088
8760 msgid "guestfs_config"
8765 #: ../src/guestfs-actions.pod:1090
8769 " guestfs_config (guestfs_h *g,\n"
8770 " const char *qemuparam,\n"
8771 " const char *qemuvalue);\n"
8776 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8778 "This can be used to add arbitrary qemu command line parameters of the form "
8779 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8780 "setting some parameters which would interfere with parameters that we use."
8785 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8786 msgid "The first character of C<param> string must be a C<-> (dash)."
8791 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8792 msgid "C<value> can be NULL."
8797 #: ../src/guestfs-actions.pod:1108
8798 msgid "guestfs_copy_size"
8803 #: ../src/guestfs-actions.pod:1110
8807 " guestfs_copy_size (guestfs_h *g,\n"
8808 " const char *src,\n"
8809 " const char *dest,\n"
8816 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8818 "This command copies exactly C<size> bytes from one source device or file "
8819 "C<src> to another destination device or file C<dest>."
8824 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8826 "Note this will fail if the source is too short or if the destination is not "
8831 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8832 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8833 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8834 #: ../src/guestfs-actions.pod:3546 ../src/guestfs-actions.pod:6986
8835 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7507
8836 #: ../src/guestfs-actions.pod:7526
8838 "This long-running command can generate progress notification messages so "
8839 "that the caller can display a progress bar or indicator. To receive these "
8840 "messages, the caller must register a progress event callback. See L<guestfs"
8841 "(3)/GUESTFS_EVENT_PROGRESS>."
8846 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4245
8847 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:7227
8848 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7333
8849 msgid "(Added in 1.0.87)"
8854 #: ../src/guestfs-actions.pod:1131
8860 #: ../src/guestfs-actions.pod:1133
8864 " guestfs_cp (guestfs_h *g,\n"
8865 " const char *src,\n"
8866 " const char *dest);\n"
8872 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8874 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8875 "destination filename or destination directory."
8880 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8881 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8882 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4985
8883 #: ../src/guestfs-actions.pod:5362
8884 msgid "(Added in 1.0.18)"
8889 #: ../src/guestfs-actions.pod:1145
8890 msgid "guestfs_cp_a"
8895 #: ../src/guestfs-actions.pod:1147
8899 " guestfs_cp_a (guestfs_h *g,\n"
8900 " const char *src,\n"
8901 " const char *dest);\n"
8907 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8909 "This copies a file or directory from C<src> to C<dest> recursively using the "
8915 #: ../src/guestfs-actions.pod:1159
8921 #: ../src/guestfs-actions.pod:1161
8925 " guestfs_dd (guestfs_h *g,\n"
8926 " const char *src,\n"
8927 " const char *dest);\n"
8933 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8935 "This command copies from one source device or file C<src> to another "
8936 "destination device or file C<dest>. Normally you would use this to copy to "
8937 "or from a device or partition, for example to duplicate a filesystem."
8942 #: ../src/guestfs-actions.pod:1171
8944 "If the destination is a device, it must be as large or larger than the "
8945 "source file or device, otherwise the copy will fail. This command cannot do "
8946 "partial copies (see C<guestfs_copy_size>)."
8951 #: ../src/guestfs-actions.pod:1179
8957 #: ../src/guestfs-actions.pod:1181
8961 " guestfs_df (guestfs_h *g);\n"
8967 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8968 msgid "This command runs the C<df> command to report disk space used."
8973 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8975 "This command is mostly useful for interactive sessions. It is I<not> "
8976 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8982 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8983 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2289
8984 #: ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2381
8985 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4885
8986 #: ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6748
8987 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386
8988 #: ../src/guestfs-actions.pod:7399
8989 msgid "(Added in 1.0.54)"
8994 #: ../src/guestfs-actions.pod:1195
8995 msgid "guestfs_df_h"
9000 #: ../src/guestfs-actions.pod:1197
9004 " guestfs_df_h (guestfs_h *g);\n"
9010 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
9012 "This command runs the C<df -h> command to report disk space used in human-"
9018 #: ../src/guestfs-actions.pod:1212
9019 msgid "guestfs_dmesg"
9024 #: ../src/guestfs-actions.pod:1214
9028 " guestfs_dmesg (guestfs_h *g);\n"
9034 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
9036 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9037 "This is sometimes useful for extended debugging of problems."
9042 #: ../src/guestfs-actions.pod:1221
9044 "Another way to get the same information is to enable verbose messages with "
9045 "C<guestfs_set_verbose> or by setting the environment variable "
9046 "C<LIBGUESTFS_DEBUG=1> before running the program."
9051 #: ../src/guestfs-actions.pod:1231
9052 msgid "guestfs_download"
9057 #: ../src/guestfs-actions.pod:1233
9061 " guestfs_download (guestfs_h *g,\n"
9062 " const char *remotefilename,\n"
9063 " const char *filename);\n"
9069 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
9070 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9072 "Download file C<remotefilename> and save it as C<filename> on the local "
9078 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6980
9079 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4668
9080 msgid "C<filename> can also be a named pipe."
9085 #: ../src/guestfs-actions.pod:1243
9086 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9091 #: ../src/guestfs-actions.pod:1254
9092 msgid "guestfs_download_offset"
9097 #: ../src/guestfs-actions.pod:1256
9101 " guestfs_download_offset (guestfs_h *g,\n"
9102 " const char *remotefilename,\n"
9103 " const char *filename,\n"
9104 " int64_t offset,\n"
9111 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
9113 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9114 "region must be within the file or device)."
9119 #: ../src/guestfs-actions.pod:1269
9121 "Note that there is no limit on the amount of data that can be downloaded "
9122 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9123 "full amount unless an error occurs."
9128 #: ../src/guestfs-actions.pod:1274
9129 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9134 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7025
9135 msgid "(Added in 1.5.17)"
9140 #: ../src/guestfs-actions.pod:1285
9141 msgid "guestfs_drop_caches"
9146 #: ../src/guestfs-actions.pod:1287
9150 " guestfs_drop_caches (guestfs_h *g,\n"
9151 " int whattodrop);\n"
9157 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
9159 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9160 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9161 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9166 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
9167 msgid "Setting C<whattodrop> to 3 should drop everything."
9172 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
9174 "This automatically calls L<sync(2)> before the operation, so that the "
9175 "maximum guest memory is freed."
9180 #: ../src/guestfs-actions.pod:1305
9186 #: ../src/guestfs-actions.pod:1307
9190 " guestfs_du (guestfs_h *g,\n"
9191 " const char *path);\n"
9197 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
9199 "This command runs the C<du -s> command to estimate file space usage for "
9205 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
9207 "C<path> can be a file or a directory. If C<path> is a directory then the "
9208 "estimate includes the contents of the directory and all subdirectories "
9214 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
9216 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9221 #: ../src/guestfs-actions.pod:1330
9222 msgid "guestfs_e2fsck_f"
9227 #: ../src/guestfs-actions.pod:1332
9231 " guestfs_e2fsck_f (guestfs_h *g,\n"
9232 " const char *device);\n"
9237 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
9239 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9240 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9246 #: ../src/guestfs-actions.pod:1340
9248 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9249 "Normally you should use C<guestfs_fsck>."
9254 #: ../src/guestfs-actions.pod:1345
9255 msgid "(Added in 1.0.29)"
9260 #: ../src/guestfs-actions.pod:1347
9261 msgid "guestfs_echo_daemon"
9266 #: ../src/guestfs-actions.pod:1349
9270 " guestfs_echo_daemon (guestfs_h *g,\n"
9271 " char *const *words);\n"
9277 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
9279 "This command concatenates the list of C<words> passed with single spaces "
9280 "between them and returns the resulting string."
9285 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
9286 msgid "You can use this command to test the connection through to the daemon."
9291 #: ../src/guestfs-actions.pod:1358
9292 msgid "See also C<guestfs_ping_daemon>."
9297 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2097
9298 #: ../src/guestfs-actions.pod:6196
9299 msgid "(Added in 1.0.69)"
9304 #: ../src/guestfs-actions.pod:1365
9305 msgid "guestfs_egrep"
9310 #: ../src/guestfs-actions.pod:1367
9314 " guestfs_egrep (guestfs_h *g,\n"
9315 " const char *regex,\n"
9316 " const char *path);\n"
9322 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
9324 "This calls the external C<egrep> program and returns the matching lines."
9329 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
9330 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
9331 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2227
9332 #: ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:2402
9333 #: ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2430
9334 #: ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2498
9335 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3738
9336 #: ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3765
9337 #: ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4765
9338 #: ../src/guestfs-actions.pod:5696 ../src/guestfs-actions.pod:5745
9339 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6604
9340 #: ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6630
9341 #: ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6665
9342 #: ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6691
9343 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7488
9344 #: ../src/guestfs-actions.pod:7574 ../src/guestfs-actions.pod:7593
9345 #: ../src/guestfs-actions.pod:7639 ../src/guestfs-actions.pod:7658
9346 msgid "(Added in 1.0.66)"
9351 #: ../src/guestfs-actions.pod:1384
9352 msgid "guestfs_egrepi"
9357 #: ../src/guestfs-actions.pod:1386
9361 " guestfs_egrepi (guestfs_h *g,\n"
9362 " const char *regex,\n"
9363 " const char *path);\n"
9369 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
9371 "This calls the external C<egrep -i> program and returns the matching lines."
9376 #: ../src/guestfs-actions.pod:1403
9377 msgid "guestfs_equal"
9382 #: ../src/guestfs-actions.pod:1405
9386 " guestfs_equal (guestfs_h *g,\n"
9387 " const char *file1,\n"
9388 " const char *file2);\n"
9394 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
9396 "This compares the two files C<file1> and C<file2> and returns true if their "
9397 "content is exactly equal, or false otherwise."
9402 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
9403 msgid "The external L<cmp(1)> program is used for the comparison."
9408 #: ../src/guestfs-actions.pod:1419
9409 msgid "guestfs_exists"
9414 #: ../src/guestfs-actions.pod:1421
9418 " guestfs_exists (guestfs_h *g,\n"
9419 " const char *path);\n"
9425 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
9427 "This returns C<true> if and only if there is a file, directory (or anything) "
9428 "with the given C<path> name."
9433 #: ../src/guestfs-actions.pod:1428
9434 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9439 #: ../src/guestfs-actions.pod:1434
9440 msgid "guestfs_fallocate"
9445 #: ../src/guestfs-actions.pod:1436
9449 " guestfs_fallocate (guestfs_h *g,\n"
9450 " const char *path,\n"
9457 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
9458 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9460 "This command preallocates a file (containing zero bytes) named C<path> of "
9461 "size C<len> bytes. If the file exists already, it is overwritten."
9466 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
9468 "Do not confuse this with the guestfish-specific C<alloc> command which "
9469 "allocates a file in the host and attaches it as a device."
9474 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
9476 "This function is deprecated. In new code, use the C<fallocate64> call "
9482 #: ../src/guestfs-actions.pod:1460
9483 msgid "guestfs_fallocate64"
9488 #: ../src/guestfs-actions.pod:1462
9492 " guestfs_fallocate64 (guestfs_h *g,\n"
9493 " const char *path,\n"
9500 #: ../src/guestfs-actions.pod:1471
9502 "Note that this call allocates disk blocks for the file. To create a sparse "
9503 "file use C<guestfs_truncate_size> instead."
9508 #: ../src/guestfs-actions.pod:1474
9510 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9511 "oversight it only allowed 30 bit lengths to be specified, effectively "
9512 "limiting the maximum size of files created through that call to 1GB."
9517 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
9519 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9520 "commands which create a file in the host and attach it as a device."
9525 #: ../src/guestfs-actions.pod:1485
9526 msgid "(Added in 1.3.17)"
9531 #: ../src/guestfs-actions.pod:1487
9532 msgid "guestfs_fgrep"
9537 #: ../src/guestfs-actions.pod:1489
9541 " guestfs_fgrep (guestfs_h *g,\n"
9542 " const char *pattern,\n"
9543 " const char *path);\n"
9549 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
9551 "This calls the external C<fgrep> program and returns the matching lines."
9556 #: ../src/guestfs-actions.pod:1506
9557 msgid "guestfs_fgrepi"
9562 #: ../src/guestfs-actions.pod:1508
9566 " guestfs_fgrepi (guestfs_h *g,\n"
9567 " const char *pattern,\n"
9568 " const char *path);\n"
9574 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
9576 "This calls the external C<fgrep -i> program and returns the matching lines."
9581 #: ../src/guestfs-actions.pod:1525
9582 msgid "guestfs_file"
9587 #: ../src/guestfs-actions.pod:1527
9591 " guestfs_file (guestfs_h *g,\n"
9592 " const char *path);\n"
9598 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
9600 "This call uses the standard L<file(1)> command to determine the type or "
9601 "contents of the file."
9606 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
9608 "This call will also transparently look inside various types of compressed "
9613 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
9615 "The exact command which runs is C<file -zb path>. Note in particular that "
9616 "the filename is not prepended to the output (the I<-b> option)."
9620 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
9622 "The output depends on the output of the underlying L<file(1)> command and it "
9623 "can change in future in ways beyond our control. In other words, the output "
9624 "is not guaranteed by the ABI."
9628 #: ../src/guestfs-actions.pod:1545
9630 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9631 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
9636 #: ../src/guestfs-actions.pod:1553
9637 msgid "guestfs_file_architecture"
9642 #: ../src/guestfs-actions.pod:1555
9646 " guestfs_file_architecture (guestfs_h *g,\n"
9647 " const char *filename);\n"
9653 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
9655 "This detects the architecture of the binary C<filename>, and returns it if "
9661 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
9662 msgid "Currently defined architectures are:"
9667 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
9673 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
9675 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9676 "irrespective of the precise processor requirements of the binary."
9681 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
9687 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
9688 msgid "64 bit x86-64."
9693 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
9699 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
9700 msgid "32 bit SPARC."
9705 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
9711 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
9712 msgid "64 bit SPARC V9 and above."
9717 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
9723 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
9724 msgid "Intel Itanium."
9729 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
9735 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
9736 msgid "32 bit Power PC."
9741 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
9747 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
9748 msgid "64 bit Power PC."
9753 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
9754 msgid "Libguestfs may return other architecture strings in future."
9759 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
9760 msgid "The function works on at least the following types of files:"
9765 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
9766 msgid "many types of Un*x and Linux binary"
9771 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
9772 msgid "many types of Un*x and Linux shared library"
9777 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
9778 msgid "Windows Win32 and Win64 binaries"
9783 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
9784 msgid "Windows Win32 and Win64 DLLs"
9789 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
9790 msgid "Win32 binaries and DLLs return C<i386>."
9795 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
9796 msgid "Win64 binaries and DLLs return C<x86_64>."
9801 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
9802 msgid "Linux kernel modules"
9807 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
9808 msgid "Linux new-style initrd images"
9813 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
9814 msgid "some non-x86 Linux vmlinuz kernels"
9819 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
9820 msgid "What it can't do currently:"
9825 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
9826 msgid "static libraries (libfoo.a)"
9831 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
9832 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9837 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
9838 msgid "x86 Linux vmlinuz kernels"
9843 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
9845 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9846 "compressed code, and are horribly hard to unpack. If you want to find the "
9847 "architecture of a kernel, use the architecture of the associated initrd or "
9848 "kernel module(s) instead."
9853 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
9854 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2531
9855 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2685
9856 #: ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:2886
9857 #: ../src/guestfs-actions.pod:2926 ../src/guestfs-actions.pod:3001
9858 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3321
9859 #: ../src/guestfs-actions.pod:3453
9860 msgid "(Added in 1.5.3)"
9865 #: ../src/guestfs-actions.pod:1665
9866 msgid "guestfs_filesize"
9871 #: ../src/guestfs-actions.pod:1667
9875 " guestfs_filesize (guestfs_h *g,\n"
9876 " const char *file);\n"
9882 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9883 msgid "This command returns the size of C<file> in bytes."
9888 #: ../src/guestfs-actions.pod:1673
9890 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9891 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9892 "devices, use C<guestfs_blockdev_getsize64>."
9897 #: ../src/guestfs-actions.pod:1679
9898 msgid "(Added in 1.0.82)"
9903 #: ../src/guestfs-actions.pod:1681
9904 msgid "guestfs_fill"
9909 #: ../src/guestfs-actions.pod:1683
9913 " guestfs_fill (guestfs_h *g,\n"
9916 " const char *path);\n"
9922 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9924 "This command creates a new file called C<path>. The initial content of the "
9925 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9931 #: ../src/guestfs-actions.pod:1693
9933 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9934 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9935 "bytes use C<guestfs_fill_pattern>."
9940 #: ../src/guestfs-actions.pod:1705
9941 msgid "(Added in 1.0.79)"
9946 #: ../src/guestfs-actions.pod:1707
9947 msgid "guestfs_fill_pattern"
9952 #: ../src/guestfs-actions.pod:1709
9956 " guestfs_fill_pattern (guestfs_h *g,\n"
9957 " const char *pattern,\n"
9959 " const char *path);\n"
9965 #: ../src/guestfs-actions.pod:1715
9967 "This function is like C<guestfs_fill> except that it creates a new file of "
9968 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9969 "pattern is truncated if necessary to ensure the length of the file is "
9970 "exactly C<len> bytes."
9975 #: ../src/guestfs-actions.pod:1727
9976 msgid "(Added in 1.3.12)"
9981 #: ../src/guestfs-actions.pod:1729
9982 msgid "guestfs_find"
9987 #: ../src/guestfs-actions.pod:1731
9991 " guestfs_find (guestfs_h *g,\n"
9992 " const char *directory);\n"
9998 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
10000 "This command lists out all files and directories, recursively, starting at "
10001 "C<directory>. It is essentially equivalent to running the shell command "
10002 "C<find directory -print> but some post-processing happens on the output, "
10008 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
10010 "This returns a list of strings I<without any prefix>. Thus if the directory "
10016 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
10027 #: ../src/guestfs-actions.pod:1747
10029 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10034 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
10046 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
10047 msgid "If C<directory> is not a directory, then this command returns an error."
10052 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
10053 msgid "The returned list is sorted."
10058 #: ../src/guestfs-actions.pod:1760
10059 msgid "See also C<guestfs_find0>."
10064 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4182
10065 #: ../src/guestfs-actions.pod:5780
10066 msgid "(Added in 1.0.27)"
10071 #: ../src/guestfs-actions.pod:1771
10072 msgid "guestfs_find0"
10077 #: ../src/guestfs-actions.pod:1773
10081 " guestfs_find0 (guestfs_h *g,\n"
10082 " const char *directory,\n"
10083 " const char *files);\n"
10089 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
10091 "This command lists out all files and directories, recursively, starting at "
10092 "C<directory>, placing the resulting list in the external file called "
10098 #: ../src/guestfs-actions.pod:1782
10100 "This command works the same way as C<guestfs_find> with the following "
10106 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
10107 msgid "The resulting list is written to an external file."
10112 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
10114 "Items (filenames) in the result are separated by C<\\0> characters. See "
10115 "L<find(1)> option I<-print0>."
10120 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
10121 msgid "This command is not limited in the number of names that it can return."
10126 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
10127 msgid "The result list is not sorted."
10132 #: ../src/guestfs-actions.pod:1809
10133 msgid "(Added in 1.0.74)"
10138 #: ../src/guestfs-actions.pod:1811
10139 msgid "guestfs_findfs_label"
10144 #: ../src/guestfs-actions.pod:1813
10148 " guestfs_findfs_label (guestfs_h *g,\n"
10149 " const char *label);\n"
10155 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
10157 "This command searches the filesystems and returns the one which has the "
10158 "given label. An error is returned if no such filesystem can be found."
10163 #: ../src/guestfs-actions.pod:1821
10164 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10169 #: ../src/guestfs-actions.pod:1828
10170 msgid "guestfs_findfs_uuid"
10175 #: ../src/guestfs-actions.pod:1830
10179 " guestfs_findfs_uuid (guestfs_h *g,\n"
10180 " const char *uuid);\n"
10186 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
10188 "This command searches the filesystems and returns the one which has the "
10189 "given UUID. An error is returned if no such filesystem can be found."
10194 #: ../src/guestfs-actions.pod:1838
10195 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10200 #: ../src/guestfs-actions.pod:1845
10201 msgid "guestfs_fsck"
10206 #: ../src/guestfs-actions.pod:1847
10210 " guestfs_fsck (guestfs_h *g,\n"
10211 " const char *fstype,\n"
10212 " const char *device);\n"
10218 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
10220 "This runs the filesystem checker (fsck) on C<device> which should have "
10221 "filesystem type C<fstype>."
10226 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
10228 "The returned integer is the status. See L<fsck(8)> for the list of status "
10229 "codes from C<fsck>."
10234 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
10235 msgid "Multiple status codes can be summed together."
10240 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
10242 "A non-zero return code can mean \"success\", for example if errors have been "
10243 "corrected on the filesystem."
10248 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
10249 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10254 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
10256 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10261 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7512
10262 msgid "(Added in 1.0.16)"
10267 #: ../src/guestfs-actions.pod:1884
10268 msgid "guestfs_get_append"
10273 #: ../src/guestfs-actions.pod:1886
10277 " guestfs_get_append (guestfs_h *g);\n"
10283 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
10285 "Return the additional kernel options which are added to the guest kernel "
10291 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
10292 msgid "If C<NULL> then no options are added."
10297 #: ../src/guestfs-actions.pod:1894
10299 "This function returns a string which may be NULL. There is no way to return "
10300 "an error from this function. The string is owned by the guest handle and "
10301 "must I<not> be freed."
10306 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5458
10307 #: ../src/guestfs-actions.pod:5938 ../src/guestfs-actions.pod:6359
10308 #: ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6394
10309 #: ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:7175
10310 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7555
10311 msgid "(Added in 1.0.26)"
10315 #: ../src/guestfs-actions.pod:1900
10316 msgid "guestfs_get_attach_method"
10320 #: ../src/guestfs-actions.pod:1902
10324 " guestfs_get_attach_method (guestfs_h *g);\n"
10329 #: ../src/guestfs-actions.pod:1905
10330 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10335 #: ../src/guestfs-actions.pod:1910
10336 msgid "guestfs_get_autosync"
10341 #: ../src/guestfs-actions.pod:1912
10345 " guestfs_get_autosync (guestfs_h *g);\n"
10351 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1303
10352 msgid "Get the autosync flag."
10357 #: ../src/guestfs-actions.pod:1921
10358 msgid "guestfs_get_direct"
10363 #: ../src/guestfs-actions.pod:1923
10367 " guestfs_get_direct (guestfs_h *g);\n"
10373 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1309
10374 msgid "Return the direct appliance mode flag."
10379 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:6007
10380 msgid "(Added in 1.0.72)"
10385 #: ../src/guestfs-actions.pod:1932
10386 msgid "guestfs_get_e2label"
10391 #: ../src/guestfs-actions.pod:1934
10395 " guestfs_get_e2label (guestfs_h *g,\n"
10396 " const char *device);\n"
10402 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1315
10404 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10409 #: ../src/guestfs-actions.pod:1944 ../fish/guestfish-actions.pod:1318
10411 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10416 #: ../src/guestfs-actions.pod:1951 ../src/guestfs-actions.pod:1972
10417 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6044
10418 msgid "(Added in 1.0.15)"
10423 #: ../src/guestfs-actions.pod:1953
10424 msgid "guestfs_get_e2uuid"
10429 #: ../src/guestfs-actions.pod:1955
10433 " guestfs_get_e2uuid (guestfs_h *g,\n"
10434 " const char *device);\n"
10440 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1329
10442 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10447 #: ../src/guestfs-actions.pod:1965 ../fish/guestfish-actions.pod:1332
10449 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10454 #: ../src/guestfs-actions.pod:1974
10455 msgid "guestfs_get_memsize"
10460 #: ../src/guestfs-actions.pod:1976
10464 " guestfs_get_memsize (guestfs_h *g);\n"
10470 #: ../src/guestfs-actions.pod:1979 ../fish/guestfish-actions.pod:1343
10472 "This gets the memory size in megabytes allocated to the qemu subprocess."
10477 #: ../src/guestfs-actions.pod:1982
10479 "If C<guestfs_set_memsize> was not called on this handle, and if "
10480 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10481 "value for memsize."
10486 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2067
10487 #: ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6167
10488 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
10489 #: ../fish/guestfish-actions.pod:4043 ../fish/guestfish-actions.pod:4130
10491 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10496 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:4473
10497 #: ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:4689
10498 #: ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4720
10499 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4750
10500 #: ../src/guestfs-actions.pod:5683 ../src/guestfs-actions.pod:6065
10501 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6941
10502 msgid "(Added in 1.0.55)"
10507 #: ../src/guestfs-actions.pod:1993
10508 msgid "guestfs_get_network"
10513 #: ../src/guestfs-actions.pod:1995
10517 " guestfs_get_network (guestfs_h *g);\n"
10523 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1357
10524 msgid "This returns the enable network flag."
10529 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:6084
10530 msgid "(Added in 1.5.4)"
10535 #: ../src/guestfs-actions.pod:2004
10536 msgid "guestfs_get_path"
10541 #: ../src/guestfs-actions.pod:2006
10545 " guestfs_get_path (guestfs_h *g);\n"
10551 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1363
10552 msgid "Return the current search path."
10557 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1365
10559 "This is always non-NULL. If it wasn't set already, then this will return "
10560 "the default path."
10565 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2043
10567 "This function returns a string, or NULL on error. The string is owned by "
10568 "the guest handle and must I<not> be freed."
10573 #: ../src/guestfs-actions.pod:2019
10574 msgid "guestfs_get_pid"
10579 #: ../src/guestfs-actions.pod:2021
10583 " guestfs_get_pid (guestfs_h *g);\n"
10589 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
10591 "Return the process ID of the qemu subprocess. If there is no qemu "
10592 "subprocess, then this will return an error."
10597 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
10598 msgid "This is an internal call used for debugging and testing."
10603 #: ../src/guestfs-actions.pod:2031
10604 msgid "(Added in 1.0.56)"
10609 #: ../src/guestfs-actions.pod:2033
10610 msgid "guestfs_get_qemu"
10615 #: ../src/guestfs-actions.pod:2035
10619 " guestfs_get_qemu (guestfs_h *g);\n"
10625 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1383
10626 msgid "Return the current qemu binary."
10631 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1385
10633 "This is always non-NULL. If it wasn't set already, then this will return "
10634 "the default qemu binary name."
10639 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:6129
10640 msgid "(Added in 1.0.6)"
10645 #: ../src/guestfs-actions.pod:2048
10646 msgid "guestfs_get_recovery_proc"
10651 #: ../src/guestfs-actions.pod:2050
10655 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10661 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1392
10662 msgid "Return the recovery process enabled flag."
10667 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3571
10668 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4280
10669 #: ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:5388
10670 #: ../src/guestfs-actions.pod:5731 ../src/guestfs-actions.pod:6153
10671 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6864
10672 #: ../src/guestfs-actions.pod:7056
10673 msgid "(Added in 1.0.77)"
10678 #: ../src/guestfs-actions.pod:2059
10679 msgid "guestfs_get_selinux"
10684 #: ../src/guestfs-actions.pod:2061
10688 " guestfs_get_selinux (guestfs_h *g);\n"
10694 #: ../src/guestfs-actions.pod:2064
10696 "This returns the current setting of the selinux flag which is passed to the "
10697 "appliance at boot time. See C<guestfs_set_selinux>."
10702 #: ../src/guestfs-actions.pod:2072 ../src/guestfs-actions.pod:2135
10703 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6230
10704 msgid "(Added in 1.0.67)"
10709 #: ../src/guestfs-actions.pod:2074
10710 msgid "guestfs_get_state"
10715 #: ../src/guestfs-actions.pod:2076
10719 " guestfs_get_state (guestfs_h *g);\n"
10725 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1408
10727 "This returns the current state as an opaque integer. This is only useful "
10728 "for printing debug and internal error messages."
10733 #: ../src/guestfs-actions.pod:2082 ../src/guestfs-actions.pod:3346
10734 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3436
10735 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:1411
10736 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
10737 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
10738 msgid "For more information on states, see L<guestfs(3)>."
10743 #: ../src/guestfs-actions.pod:2088
10744 msgid "guestfs_get_trace"
10749 #: ../src/guestfs-actions.pod:2090
10753 " guestfs_get_trace (guestfs_h *g);\n"
10759 #: ../src/guestfs-actions.pod:2093 ../fish/guestfish-actions.pod:1417
10760 msgid "Return the command trace flag."
10765 #: ../src/guestfs-actions.pod:2099
10766 msgid "guestfs_get_umask"
10771 #: ../src/guestfs-actions.pod:2101
10775 " guestfs_get_umask (guestfs_h *g);\n"
10781 #: ../src/guestfs-actions.pod:2104
10783 "Return the current umask. By default the umask is C<022> unless it has been "
10784 "set by calling C<guestfs_umask>."
10789 #: ../src/guestfs-actions.pod:2111
10790 msgid "guestfs_get_verbose"
10795 #: ../src/guestfs-actions.pod:2113
10799 " guestfs_get_verbose (guestfs_h *g);\n"
10805 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1430
10806 msgid "This returns the verbose messages flag."
10811 #: ../src/guestfs-actions.pod:2122
10812 msgid "guestfs_getcon"
10817 #: ../src/guestfs-actions.pod:2124
10821 " guestfs_getcon (guestfs_h *g);\n"
10827 #: ../src/guestfs-actions.pod:2127 ../fish/guestfish-actions.pod:1436
10828 msgid "This gets the SELinux security context of the daemon."
10833 #: ../src/guestfs-actions.pod:2129
10835 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10840 #: ../src/guestfs-actions.pod:2137
10841 msgid "guestfs_getxattr"
10846 #: ../src/guestfs-actions.pod:2139
10850 " guestfs_getxattr (guestfs_h *g,\n"
10851 " const char *path,\n"
10852 " const char *name,\n"
10853 " size_t *size_r);\n"
10859 #: ../src/guestfs-actions.pod:2145
10861 "Get a single extended attribute from file C<path> named C<name>. This call "
10862 "follows symlinks. If you want to lookup an extended attribute for the "
10863 "symlink itself, use C<guestfs_lgetxattr>."
10868 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:3585
10870 "Normally it is better to get all extended attributes from a file in one go "
10871 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10872 "implementations are buggy and do not provide a way to list out attributes. "
10873 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10874 "extended attributes you want in advance and call this function."
10879 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3592
10880 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
10882 "Extended attribute values are blobs of binary data. If there is no extended "
10883 "attribute named C<name>, this returns an error."
10888 #: ../src/guestfs-actions.pod:2159
10889 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10894 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2352
10895 #: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3597
10896 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5407
10897 #: ../src/guestfs-actions.pod:5588
10899 "This function returns a buffer, or NULL on error. The size of the returned "
10900 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10905 #: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3601
10906 msgid "(Added in 1.7.24)"
10911 #: ../src/guestfs-actions.pod:2167
10912 msgid "guestfs_getxattrs"
10917 #: ../src/guestfs-actions.pod:2169
10920 " struct guestfs_xattr_list *\n"
10921 " guestfs_getxattrs (guestfs_h *g,\n"
10922 " const char *path);\n"
10928 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1465
10930 "This call lists the extended attributes of the file or directory C<path>."
10935 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
10937 "At the system call level, this is a combination of the L<listxattr(2)> and "
10938 "L<getxattr(2)> calls."
10943 #: ../src/guestfs-actions.pod:2179
10944 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10949 #: ../src/guestfs-actions.pod:2181 ../src/guestfs-actions.pod:3613
10950 #: ../src/guestfs-actions.pod:4276
10952 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10953 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10958 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:3617
10959 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3830
10960 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:6249
10961 #: ../src/guestfs-actions.pod:7620
10962 msgid "(Added in 1.0.59)"
10967 #: ../src/guestfs-actions.pod:2187
10968 msgid "guestfs_glob_expand"
10973 #: ../src/guestfs-actions.pod:2189
10977 " guestfs_glob_expand (guestfs_h *g,\n"
10978 " const char *pattern);\n"
10984 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1477
10986 "This command searches for all the pathnames matching C<pattern> according to "
10987 "the wildcard expansion rules used by the shell."
10992 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1481
10994 "If no paths match, then this returns an empty list (note: not an error)."
10999 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
11001 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
11002 "GLOB_BRACE>. See that manual page for more details."
11007 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:6442
11008 #: ../src/guestfs-actions.pod:6459
11009 msgid "(Added in 1.0.50)"
11014 #: ../src/guestfs-actions.pod:2210
11015 msgid "guestfs_grep"
11020 #: ../src/guestfs-actions.pod:2212
11024 " guestfs_grep (guestfs_h *g,\n"
11025 " const char *regex,\n"
11026 " const char *path);\n"
11032 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1492
11033 msgid "This calls the external C<grep> program and returns the matching lines."
11038 #: ../src/guestfs-actions.pod:2229
11039 msgid "guestfs_grepi"
11044 #: ../src/guestfs-actions.pod:2231
11048 " guestfs_grepi (guestfs_h *g,\n"
11049 " const char *regex,\n"
11050 " const char *path);\n"
11056 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1502
11058 "This calls the external C<grep -i> program and returns the matching lines."
11063 #: ../src/guestfs-actions.pod:2248
11064 msgid "guestfs_grub_install"
11069 #: ../src/guestfs-actions.pod:2250
11073 " guestfs_grub_install (guestfs_h *g,\n"
11074 " const char *root,\n"
11075 " const char *device);\n"
11081 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1512
11083 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11084 "the root directory being C<root>."
11089 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
11091 "Note: If grub-install reports the error \"No suitable drive was found in the "
11092 "generated device map.\" it may be that you need to create a C</boot/grub/"
11093 "device.map> file first that contains the mapping between grub device names "
11094 "and Linux device names. It is usually sufficient to create a file "
11100 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
11103 " (hd0) /dev/vda\n"
11109 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1524
11110 msgid "replacing C</dev/vda> with the name of the installation device."
11115 #: ../src/guestfs-actions.pod:2271
11116 msgid "(Added in 1.0.17)"
11121 #: ../src/guestfs-actions.pod:2273
11122 msgid "guestfs_head"
11127 #: ../src/guestfs-actions.pod:2275
11131 " guestfs_head (guestfs_h *g,\n"
11132 " const char *path);\n"
11138 #: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1530
11140 "This command returns up to the first 10 lines of a file as a list of strings."
11145 #: ../src/guestfs-actions.pod:2291
11146 msgid "guestfs_head_n"
11151 #: ../src/guestfs-actions.pod:2293
11155 " guestfs_head_n (guestfs_h *g,\n"
11157 " const char *path);\n"
11163 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1540
11165 "If the parameter C<nrlines> is a positive number, this returns the first "
11166 "C<nrlines> lines of the file C<path>."
11171 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
11173 "If the parameter C<nrlines> is a negative number, this returns lines from "
11174 "the file C<path>, excluding the last C<nrlines> lines."
11179 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6739
11180 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4508
11181 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11186 #: ../src/guestfs-actions.pod:2315
11187 msgid "guestfs_hexdump"
11192 #: ../src/guestfs-actions.pod:2317
11196 " guestfs_hexdump (guestfs_h *g,\n"
11197 " const char *path);\n"
11203 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1555
11205 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11206 "readable, canonical hex dump of the file."
11211 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:6523
11212 #: ../src/guestfs-actions.pod:6578
11213 msgid "(Added in 1.0.22)"
11218 #: ../src/guestfs-actions.pod:2332
11219 msgid "guestfs_initrd_cat"
11224 #: ../src/guestfs-actions.pod:2334
11228 " guestfs_initrd_cat (guestfs_h *g,\n"
11229 " const char *initrdpath,\n"
11230 " const char *filename,\n"
11231 " size_t *size_r);\n"
11237 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1565
11239 "This command unpacks the file C<filename> from the initrd file called "
11240 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11246 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1569
11248 "For example, in guestfish you could use the following command to examine the "
11249 "boot script (usually called C</init>) contained in a Linux initrd or "
11255 #: ../src/guestfs-actions.pod:2348 ../fish/guestfish-actions.pod:1573
11258 " initrd-cat /boot/initrd-<version>.img init\n"
11264 #: ../src/guestfs-actions.pod:2350
11265 msgid "See also C<guestfs_initrd_list>."
11270 #: ../src/guestfs-actions.pod:2361
11271 msgid "guestfs_initrd_list"
11276 #: ../src/guestfs-actions.pod:2363
11280 " guestfs_initrd_list (guestfs_h *g,\n"
11281 " const char *path);\n"
11287 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1584
11288 msgid "This command lists out files contained in an initrd."
11293 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1586
11295 "The files are listed without any initial C</> character. The files are "
11296 "listed in the order they appear (not necessarily alphabetical). Directory "
11297 "names are listed as separate items."
11302 #: ../src/guestfs-actions.pod:2373 ../fish/guestfish-actions.pod:1590
11304 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11305 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11311 #: ../src/guestfs-actions.pod:2383
11312 msgid "guestfs_inotify_add_watch"
11317 #: ../src/guestfs-actions.pod:2385
11321 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11322 " const char *path,\n"
11329 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1598
11330 msgid "Watch C<path> for the events listed in C<mask>."
11335 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1600
11337 "Note that if C<path> is a directory then events within that directory are "
11338 "watched, but this does I<not> happen recursively (in subdirectories)."
11343 #: ../src/guestfs-actions.pod:2396 ../fish/guestfish-actions.pod:1604
11345 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11346 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11351 #: ../src/guestfs-actions.pod:2404
11352 msgid "guestfs_inotify_close"
11357 #: ../src/guestfs-actions.pod:2406
11361 " guestfs_inotify_close (guestfs_h *g);\n"
11367 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1612
11369 "This closes the inotify handle which was previously opened by inotify_init. "
11370 "It removes all watches, throws away any pending events, and deallocates all "
11376 #: ../src/guestfs-actions.pod:2417
11377 msgid "guestfs_inotify_files"
11382 #: ../src/guestfs-actions.pod:2419
11386 " guestfs_inotify_files (guestfs_h *g);\n"
11392 #: ../src/guestfs-actions.pod:2422
11394 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11395 "returns a list of pathnames of objects that were touched. The returned "
11396 "pathnames are sorted and deduplicated."
11401 #: ../src/guestfs-actions.pod:2432
11402 msgid "guestfs_inotify_init"
11407 #: ../src/guestfs-actions.pod:2434
11411 " guestfs_inotify_init (guestfs_h *g,\n"
11412 " int maxevents);\n"
11418 #: ../src/guestfs-actions.pod:2438 ../fish/guestfish-actions.pod:1628
11420 "This command creates a new inotify handle. The inotify subsystem can be "
11421 "used to notify events which happen to objects in the guest filesystem."
11426 #: ../src/guestfs-actions.pod:2442
11428 "C<maxevents> is the maximum number of events which will be queued up between "
11429 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11430 "passed as C<0>, then the kernel (or previously set) default is used. For "
11431 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11432 "throws away events, but records the fact that it threw them away by setting "
11433 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11434 "C<guestfs_inotify_read>)."
11439 #: ../src/guestfs-actions.pod:2452
11441 "Before any events are generated, you have to add some watches to the "
11442 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11443 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11448 #: ../src/guestfs-actions.pod:2458
11450 "Queued up events should be read periodically by calling "
11451 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11452 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11453 "often enough then you risk the internal queue overflowing."
11458 #: ../src/guestfs-actions.pod:2465
11460 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11461 "This also removes any watches automatically."
11466 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1659
11468 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11469 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11470 "that there is one global inotify handle per libguestfs instance."
11475 #: ../src/guestfs-actions.pod:2478
11476 msgid "guestfs_inotify_read"
11481 #: ../src/guestfs-actions.pod:2480
11484 " struct guestfs_inotify_event_list *\n"
11485 " guestfs_inotify_read (guestfs_h *g);\n"
11491 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1668
11493 "Return the complete queue of events that have happened since the previous "
11499 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
11500 msgid "If no events have happened, this returns an empty list."
11505 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1673
11507 "I<Note>: In order to make sure that all events have been read, you must call "
11508 "this function repeatedly until it returns an empty list. The reason is that "
11509 "the call will read events up to the maximum appliance-to-host message size "
11510 "and leave remaining events in the queue."
11515 #: ../src/guestfs-actions.pod:2494
11517 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11518 "there was an error. I<The caller must call "
11519 "C<guestfs_free_inotify_event_list> after use>."
11524 #: ../src/guestfs-actions.pod:2500
11525 msgid "guestfs_inotify_rm_watch"
11530 #: ../src/guestfs-actions.pod:2502
11534 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11541 #: ../src/guestfs-actions.pod:2506
11543 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11548 #: ../src/guestfs-actions.pod:2513
11549 msgid "guestfs_inspect_get_arch"
11554 #: ../src/guestfs-actions.pod:2515
11558 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11559 " const char *root);\n"
11565 #: ../src/guestfs-actions.pod:2519
11567 "This returns the architecture of the inspected operating system. The "
11568 "possible return values are listed under C<guestfs_file_architecture>."
11573 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1694
11575 "If the architecture could not be determined, then the string C<unknown> is "
11581 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2616
11582 #: ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:2735
11583 #: ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2947
11584 #: ../src/guestfs-actions.pod:2975 ../src/guestfs-actions.pod:2996
11585 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3087
11586 #: ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3125
11587 #: ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3156
11588 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3272
11589 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:1697
11590 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
11591 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
11592 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
11593 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
11594 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
11595 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
11596 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
11597 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
11598 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11603 #: ../src/guestfs-actions.pod:2533
11604 msgid "guestfs_inspect_get_distro"
11609 #: ../src/guestfs-actions.pod:2535
11613 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11614 " const char *root);\n"
11620 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1703
11622 "This returns the distro (distribution) of the inspected operating system."
11627 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1706
11628 msgid "Currently defined distros are:"
11633 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1710
11634 msgid "\"archlinux\""
11639 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
11640 msgid "Arch Linux."
11644 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1714
11649 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1716
11655 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1718
11661 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1720
11667 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1722
11673 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1724
11679 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1726
11685 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1728
11691 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1730
11692 msgid "\"linuxmint\""
11697 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1732
11698 msgid "Linux Mint."
11703 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1734
11704 msgid "\"mandriva\""
11709 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1736
11715 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1738
11721 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1740
11727 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1742
11733 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1744
11739 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1746
11740 msgid "\"redhat-based\""
11745 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1748
11746 msgid "Some Red Hat-derived distro."
11751 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1750
11756 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1752
11757 msgid "Red Hat Enterprise Linux."
11761 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1754
11762 msgid "\"scientificlinux\""
11766 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1756
11767 msgid "Scientific Linux."
11771 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1758
11772 msgid "\"slackware\""
11776 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1760
11782 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1762
11788 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1764
11794 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2709
11795 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:1766
11796 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
11797 msgid "\"unknown\""
11802 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1768
11803 msgid "The distro could not be determined."
11808 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3070
11809 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
11810 msgid "\"windows\""
11815 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1772
11817 "Windows does not have distributions. This string is returned if the OS type "
11823 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2715
11824 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:1777
11825 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
11827 "Future versions of libguestfs may return other strings here. The caller "
11828 "should be prepared to handle any string."
11832 #: ../src/guestfs-actions.pod:2623
11833 msgid "guestfs_inspect_get_drive_mappings"
11837 #: ../src/guestfs-actions.pod:2625
11841 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11842 " const char *root);\n"
11847 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1786
11849 "This call is useful for Windows which uses a primitive system of assigning "
11850 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11851 "Windows Registry to find out how disks/partitions are mapped to drive "
11852 "letters, and returns a hash table as in the example below:"
11856 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1792
11859 " C => /dev/vda2\n"
11860 " E => /dev/vdb1\n"
11861 " F => /dev/vdc1\n"
11866 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1796
11868 "Note that keys are drive letters. For Windows, the key is case insensitive "
11869 "and just contains the drive letter, without the customary colon separator "
11874 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1800
11876 "In future we may support other operating systems that also used drive "
11877 "letters, but the keys for those might not be case insensitive and might be "
11878 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11883 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1805
11885 "For Windows guests, currently only hard drive mappings are returned. "
11886 "Removable disks (eg. DVD-ROMs) are ignored."
11890 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
11892 "For guests that do not use drive mappings, or if the drive mappings could "
11893 "not be determined, this returns an empty hash table."
11897 #: ../src/guestfs-actions.pod:2654
11899 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11900 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11905 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2920
11906 #: ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:4947
11907 #: ../src/guestfs-actions.pod:6880
11909 "This function returns a NULL-terminated array of strings, or NULL if there "
11910 "was an error. The array of strings will always have length C<2n+1>, where "
11911 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11912 "caller must free the strings and the array after use>."
11917 #: ../src/guestfs-actions.pod:2664
11918 msgid "guestfs_inspect_get_filesystems"
11923 #: ../src/guestfs-actions.pod:2666
11927 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11928 " const char *root);\n"
11934 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1819
11936 "This returns a list of all the filesystems that we think are associated with "
11937 "this operating system. This includes the root filesystem, other ordinary "
11938 "filesystems, and non-mounted devices like swap partitions."
11943 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1824
11945 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11946 "to be shared between operating systems."
11951 #: ../src/guestfs-actions.pod:2678
11953 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11954 "C<guestfs_inspect_get_mountpoints>."
11958 #: ../src/guestfs-actions.pod:2687
11959 msgid "guestfs_inspect_get_format"
11963 #: ../src/guestfs-actions.pod:2689
11967 " guestfs_inspect_get_format (guestfs_h *g,\n"
11968 " const char *root);\n"
11973 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
11975 "This returns the format of the inspected operating system. You can use it "
11976 "to detect install images, live CDs and similar."
11980 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
11981 msgid "Currently defined formats are:"
11985 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1841
11986 msgid "\"installed\""
11990 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
11991 msgid "This is an installed operating system."
11995 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1845
11996 msgid "\"installer\""
12000 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1847
12002 "The disk image being inspected is not an installed operating system, but a "
12003 "I<bootable> install disk, live CD, or similar."
12007 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
12008 msgid "The format of this disk image is not known."
12013 #: ../src/guestfs-actions.pod:2723
12014 msgid "guestfs_inspect_get_hostname"
12019 #: ../src/guestfs-actions.pod:2725
12023 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12024 " const char *root);\n"
12030 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1865
12032 "This function returns the hostname of the operating system as found by "
12033 "inspection of the guest's configuration files."
12038 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1868
12040 "If the hostname could not be determined, then the string C<unknown> is "
12046 #: ../src/guestfs-actions.pod:2740
12047 msgid "(Added in 1.7.9)"
12051 #: ../src/guestfs-actions.pod:2742
12052 msgid "guestfs_inspect_get_icon"
12056 #: ../src/guestfs-actions.pod:2744
12060 " guestfs_inspect_get_icon (guestfs_h *g,\n"
12061 " const char *root,\n"
12062 " size_t *size_r,\n"
12068 #: ../src/guestfs-actions.pod:2755
12071 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
12072 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
12077 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1877
12079 "This function returns an icon corresponding to the inspected operating "
12080 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
12081 "to PNG if necessary)."
12085 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1881
12087 "If it was not possible to get an icon this function returns a zero-length "
12088 "(non-NULL) buffer. I<Callers must check for this case>."
12092 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1884
12094 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
12095 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
12096 "this file will be returned. You can disable favicons by passing the "
12097 "optional C<favicon> boolean as false (default is true)."
12101 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1890
12103 "If finding the favicon fails, then we look in other places in the guest for "
12108 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1893
12110 "If the optional C<highquality> boolean is true then only high quality icons "
12111 "are returned, which means only icons of high resolution with an alpha "
12112 "channel. The default (false) is to return any icon we can, even if it is of "
12113 "substandard quality."
12117 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1904
12119 "Unlike most other inspection API calls, the guest's disks must be mounted up "
12120 "before you call this, since it needs to read information from the guest "
12121 "filesystem during the call."
12125 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1910
12127 "B<Security:> The icon data comes from the untrusted guest, and should be "
12128 "treated with caution. PNG files have been known to contain exploits. "
12129 "Ensure that libpng (or other relevant libraries) are fully up to date before "
12130 "trying to process or display the icon."
12134 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1918
12136 "The PNG image returned can be any size. It might not be square. Libguestfs "
12137 "tries to return the largest, highest quality icon available. The "
12138 "application must scale the icon to the required size."
12142 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1925
12144 "Extracting icons from Windows guests requires the external C<wrestool> "
12145 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
12146 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
12147 "installed separately."
12151 #: ../src/guestfs-actions.pod:2813 ../fish/guestfish-actions.pod:1932
12153 "Operating system icons are usually trademarks. Seek legal advice before "
12154 "using trademarks in applications."
12158 #: ../src/guestfs-actions.pod:2822
12159 msgid "guestfs_inspect_get_icon_va"
12163 #: ../src/guestfs-actions.pod:2824
12167 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
12168 " const char *root,\n"
12169 " size_t *size_r,\n"
12170 " va_list args);\n"
12175 #: ../src/guestfs-actions.pod:2830
12176 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
12180 #: ../src/guestfs-actions.pod:2834
12181 msgid "guestfs_inspect_get_icon_argv"
12185 #: ../src/guestfs-actions.pod:2836
12189 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
12190 " const char *root,\n"
12191 " size_t *size_r,\n"
12192 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
12197 #: ../src/guestfs-actions.pod:2842
12198 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
12203 #: ../src/guestfs-actions.pod:2846
12204 msgid "guestfs_inspect_get_major_version"
12209 #: ../src/guestfs-actions.pod:2848
12213 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12214 " const char *root);\n"
12220 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1943
12222 "This returns the major version number of the inspected operating system."
12227 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1946
12229 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12230 "popular public names used by the operating system. Notably the operating "
12231 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12232 "1). You can find out the real versions corresponding to releases of Windows "
12233 "by consulting Wikipedia or MSDN."
12238 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2879
12239 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
12240 msgid "If the version could not be determined, then C<0> is returned."
12245 #: ../src/guestfs-actions.pod:2870
12246 msgid "guestfs_inspect_get_minor_version"
12251 #: ../src/guestfs-actions.pod:2872
12255 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12256 " const char *root);\n"
12262 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1961
12264 "This returns the minor version number of the inspected operating system."
12269 #: ../src/guestfs-actions.pod:2881
12271 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12272 "C<guestfs_inspect_get_major_version>."
12277 #: ../src/guestfs-actions.pod:2888
12278 msgid "guestfs_inspect_get_mountpoints"
12283 #: ../src/guestfs-actions.pod:2890
12287 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12288 " const char *root);\n"
12293 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1973
12295 "This returns a hash of where we think the filesystems associated with this "
12296 "operating system should be mounted. Callers should note that this is at "
12297 "best an educated guess made by reading configuration files such as C</etc/"
12298 "fstab>. I<In particular note> that this may return filesystems which are "
12299 "non-existent or not mountable and callers should be prepared to handle or "
12300 "ignore failures if they try to mount them."
12305 #: ../src/guestfs-actions.pod:2903 ../fish/guestfish-actions.pod:1982
12307 "Each element in the returned hashtable has a key which is the path of the "
12308 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12309 "mounted there (eg. C</dev/sda1>)."
12314 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:1987
12316 "Non-mounted devices such as swap devices are I<not> returned in this list."
12320 #: ../src/guestfs-actions.pod:2911
12322 "For operating systems like Windows which still use drive letters, this call "
12323 "will only return an entry for the first drive \"mounted on\" C</>. For "
12324 "information about the mapping of drive letters to partitions, see "
12325 "C<guestfs_inspect_get_drive_mappings>."
12330 #: ../src/guestfs-actions.pod:2917
12332 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12333 "C<guestfs_inspect_get_filesystems>."
12338 #: ../src/guestfs-actions.pod:2928
12339 msgid "guestfs_inspect_get_package_format"
12344 #: ../src/guestfs-actions.pod:2930
12348 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12349 " const char *root);\n"
12355 #: ../src/guestfs-actions.pod:2934
12357 "This function and C<guestfs_inspect_get_package_management> return the "
12358 "package format and package management tool used by the inspected operating "
12359 "system. For example for Fedora these functions would return C<rpm> (package "
12360 "format) and C<yum> (package management)."
12365 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2009
12367 "This returns the string C<unknown> if we could not determine the package "
12368 "format I<or> if the operating system does not have a real packaging system "
12374 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2013
12376 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12377 "Future versions of libguestfs may return other strings."
12382 #: ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2980
12383 msgid "(Added in 1.7.5)"
12388 #: ../src/guestfs-actions.pod:2954
12389 msgid "guestfs_inspect_get_package_management"
12394 #: ../src/guestfs-actions.pod:2956
12398 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12399 " const char *root);\n"
12405 #: ../src/guestfs-actions.pod:2960
12407 "C<guestfs_inspect_get_package_format> and this function return the package "
12408 "format and package management tool used by the inspected operating system. "
12409 "For example for Fedora these functions would return C<rpm> (package format) "
12410 "and C<yum> (package management)."
12415 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2028
12417 "This returns the string C<unknown> if we could not determine the package "
12418 "management tool I<or> if the operating system does not have a real packaging "
12419 "system (eg. Windows)."
12424 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2032
12426 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12427 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12428 "libguestfs may return other strings."
12433 #: ../src/guestfs-actions.pod:2982
12434 msgid "guestfs_inspect_get_product_name"
12439 #: ../src/guestfs-actions.pod:2984
12443 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12444 " const char *root);\n"
12450 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2043
12452 "This returns the product name of the inspected operating system. The "
12453 "product name is generally some freeform string which can be displayed to the "
12454 "user, but should not be parsed by programs."
12459 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2048
12461 "If the product name could not be determined, then the string C<unknown> is "
12466 #: ../src/guestfs-actions.pod:3003
12467 msgid "guestfs_inspect_get_product_variant"
12471 #: ../src/guestfs-actions.pod:3005
12475 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12476 " const char *root);\n"
12481 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2057
12482 msgid "This returns the product variant of the inspected operating system."
12486 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2060
12488 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12489 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12490 "is usually a string such as C<Client> or C<Server> (other values are "
12491 "possible). This can be used to distinguish consumer and enterprise versions "
12492 "of Windows that have the same version number (for example, Windows 7 and "
12493 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12494 "the latter is C<Server>)."
12498 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2069
12500 "For enterprise Linux guests, in future we intend this to return the product "
12501 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12502 "implemented at present."
12506 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2073
12508 "If the product variant could not be determined, then the string C<unknown> "
12513 #: ../src/guestfs-actions.pod:3028
12515 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12516 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12521 #: ../src/guestfs-actions.pod:3035
12522 msgid "guestfs_inspect_get_roots"
12527 #: ../src/guestfs-actions.pod:3037
12531 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12537 #: ../src/guestfs-actions.pod:3040
12539 "This function is a convenient way to get the list of root devices, as "
12540 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12541 "the whole inspection process."
12546 #: ../src/guestfs-actions.pod:3044
12548 "This returns an empty list if either no root devices were found or the "
12549 "caller has not called C<guestfs_inspect_os>."
12554 #: ../src/guestfs-actions.pod:3053
12555 msgid "(Added in 1.7.3)"
12560 #: ../src/guestfs-actions.pod:3055
12561 msgid "guestfs_inspect_get_type"
12566 #: ../src/guestfs-actions.pod:3057
12570 " guestfs_inspect_get_type (guestfs_h *g,\n"
12571 " const char *root);\n"
12577 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2097
12579 "This returns the type of the inspected operating system. Currently defined "
12585 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2102
12591 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2104
12592 msgid "Any Linux-based operating system."
12597 #: ../src/guestfs-actions.pod:3072 ../fish/guestfish-actions.pod:2108
12598 msgid "Any Microsoft Windows operating system."
12603 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2110
12604 msgid "\"freebsd\""
12609 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2112
12615 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2116
12616 msgid "The operating system type could not be determined."
12620 #: ../src/guestfs-actions.pod:3094
12621 msgid "guestfs_inspect_get_windows_current_control_set"
12625 #: ../src/guestfs-actions.pod:3096
12629 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12630 " const char *root);\n"
12635 #: ../src/guestfs-actions.pod:3100 ../fish/guestfish-actions.pod:2129
12637 "This returns the Windows CurrentControlSet of the inspected guest. The "
12638 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12642 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2132
12644 "This call assumes that the guest is Windows and that the Registry could be "
12645 "examined by inspection. If this is not the case then an error is returned."
12650 #: ../src/guestfs-actions.pod:3112
12651 msgid "guestfs_inspect_get_windows_systemroot"
12656 #: ../src/guestfs-actions.pod:3114
12660 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12661 " const char *root);\n"
12667 #: ../src/guestfs-actions.pod:3118 ../fish/guestfish-actions.pod:2142
12669 "This returns the Windows systemroot of the inspected guest. The systemroot "
12670 "is a directory path such as C</WINDOWS>."
12675 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2145
12677 "This call assumes that the guest is Windows and that the systemroot could be "
12678 "determined by inspection. If this is not the case then an error is returned."
12683 #: ../src/guestfs-actions.pod:3130
12684 msgid "(Added in 1.5.25)"
12688 #: ../src/guestfs-actions.pod:3132
12689 msgid "guestfs_inspect_is_live"
12693 #: ../src/guestfs-actions.pod:3134
12697 " guestfs_inspect_is_live (guestfs_h *g,\n"
12698 " const char *root);\n"
12703 #: ../src/guestfs-actions.pod:3138
12705 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12706 "disk), then this returns true if a live image was detected on the disk."
12710 #: ../src/guestfs-actions.pod:3146
12711 msgid "guestfs_inspect_is_multipart"
12715 #: ../src/guestfs-actions.pod:3148
12719 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12720 " const char *root);\n"
12725 #: ../src/guestfs-actions.pod:3152
12727 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12728 "disk), then this returns true if the disk is part of a set."
12732 #: ../src/guestfs-actions.pod:3160
12733 msgid "guestfs_inspect_is_netinst"
12737 #: ../src/guestfs-actions.pod:3162
12741 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12742 " const char *root);\n"
12747 #: ../src/guestfs-actions.pod:3166
12749 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12750 "disk), then this returns true if the disk is a network installer, ie. not a "
12751 "self-contained install CD but one which is likely to require network access "
12752 "to complete the install."
12757 #: ../src/guestfs-actions.pod:3176
12758 msgid "guestfs_inspect_list_applications"
12763 #: ../src/guestfs-actions.pod:3178
12766 " struct guestfs_application_list *\n"
12767 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12768 " const char *root);\n"
12774 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2187
12775 msgid "Return the list of applications installed in the operating system."
12780 #: ../src/guestfs-actions.pod:3184
12782 "I<Note:> This call works differently from other parts of the inspection "
12783 "API. You have to call C<guestfs_inspect_os>, then "
12784 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12785 "this. Listing applications is a significantly more difficult operation "
12786 "which requires access to the full filesystem. Also note that unlike the "
12787 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12788 "the libguestfs handle, this call actually reads parts of the mounted "
12789 "filesystems during the call."
12794 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2199
12796 "This returns an empty list if the inspection code was not able to determine "
12797 "the list of applications."
12802 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2202
12803 msgid "The application structure contains the following fields:"
12808 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2206
12809 msgid "C<app_name>"
12814 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2208
12816 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12817 "guests, this is the package name."
12822 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2211
12823 msgid "C<app_display_name>"
12828 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2213
12830 "The display name of the application, sometimes localized to the install "
12831 "language of the guest operating system."
12836 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2216
12838 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12839 "to display something can use C<app_name> instead."
12844 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2219
12845 msgid "C<app_epoch>"
12850 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2221
12852 "For package managers which use epochs, this contains the epoch of the "
12853 "package (an integer). If unavailable, this is returned as C<0>."
12858 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2224
12859 msgid "C<app_version>"
12864 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2226
12866 "The version string of the application or package. If unavailable this is "
12867 "returned as an empty string C<\"\">."
12872 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2229
12873 msgid "C<app_release>"
12878 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2231
12880 "The release string of the application or package, for package managers that "
12881 "use this. If unavailable this is returned as an empty string C<\"\">."
12886 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2235
12887 msgid "C<app_install_path>"
12892 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2237
12894 "The installation path of the application (on operating systems such as "
12895 "Windows which use installation paths). This path is in the format used by "
12896 "the guest operating system, it is not a libguestfs path."
12901 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2242
12902 msgid "If unavailable this is returned as an empty string C<\"\">."
12907 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2244
12908 msgid "C<app_trans_path>"
12913 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2246
12915 "The install path translated into a libguestfs path. If unavailable this is "
12916 "returned as an empty string C<\"\">."
12921 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
12922 msgid "C<app_publisher>"
12927 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2251
12929 "The name of the publisher of the application, for package managers that use "
12930 "this. If unavailable this is returned as an empty string C<\"\">."
12935 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2255
12941 #: ../src/guestfs-actions.pod:3252 ../fish/guestfish-actions.pod:2257
12943 "The URL (eg. upstream URL) of the application. If unavailable this is "
12944 "returned as an empty string C<\"\">."
12949 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2260
12950 msgid "C<app_source_package>"
12955 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2262
12957 "For packaging systems which support this, the name of the source package. "
12958 "If unavailable this is returned as an empty string C<\"\">."
12963 #: ../src/guestfs-actions.pod:3260 ../fish/guestfish-actions.pod:2265
12964 msgid "C<app_summary>"
12969 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2267
12971 "A short (usually one line) description of the application or package. If "
12972 "unavailable this is returned as an empty string C<\"\">."
12977 #: ../src/guestfs-actions.pod:3265 ../fish/guestfish-actions.pod:2270
12978 msgid "C<app_description>"
12983 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2272
12985 "A longer description of the application or package. If unavailable this is "
12986 "returned as an empty string C<\"\">."
12991 #: ../src/guestfs-actions.pod:3274
12993 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12994 "there was an error. I<The caller must call C<guestfs_free_application_list> "
13000 #: ../src/guestfs-actions.pod:3278
13001 msgid "(Added in 1.7.8)"
13006 #: ../src/guestfs-actions.pod:3280
13007 msgid "guestfs_inspect_os"
13012 #: ../src/guestfs-actions.pod:3282
13016 " guestfs_inspect_os (guestfs_h *g);\n"
13022 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2283
13024 "This function uses other libguestfs functions and certain heuristics to "
13025 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
13026 "for operating systems."
13031 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2287
13032 msgid "The list returned is empty if no operating systems were found."
13037 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2289
13039 "If one operating system was found, then this returns a list with a single "
13040 "element, which is the name of the root filesystem of this operating system. "
13041 "It is also possible for this function to return a list containing more than "
13042 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
13043 "element being the root filesystem of one of the operating systems."
13048 #: ../src/guestfs-actions.pod:3298
13050 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
13051 "functions in order to query further information about each operating system, "
13052 "such as the name and version."
13057 #: ../src/guestfs-actions.pod:3303
13059 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
13060 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
13061 "the contents. This should be called with no disks currently mounted. The "
13062 "function may also use Augeas, so any existing Augeas handle will be closed."
13067 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2307
13069 "This function cannot decrypt encrypted disks. The caller must do that first "
13070 "(supplying the necessary keys) if the disk is encrypted."
13075 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3640
13076 #: ../src/guestfs-actions.pod:3702
13077 msgid "See also C<guestfs_list_filesystems>."
13082 #: ../src/guestfs-actions.pod:3323
13083 msgid "guestfs_is_blockdev"
13088 #: ../src/guestfs-actions.pod:3325
13092 " guestfs_is_blockdev (guestfs_h *g,\n"
13093 " const char *path);\n"
13099 #: ../src/guestfs-actions.pod:3329 ../fish/guestfish-actions.pod:2319
13101 "This returns C<true> if and only if there is a block device with the given "
13107 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3361
13108 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3406
13109 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3478
13110 #: ../src/guestfs-actions.pod:3493
13111 msgid "See also C<guestfs_stat>."
13116 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3365
13117 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3482
13118 #: ../src/guestfs-actions.pod:3497
13119 msgid "(Added in 1.5.10)"
13124 #: ../src/guestfs-actions.pod:3338
13125 msgid "guestfs_is_busy"
13130 #: ../src/guestfs-actions.pod:3340
13134 " guestfs_is_busy (guestfs_h *g);\n"
13140 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2328
13142 "This returns true iff this handle is busy processing a command (in the "
13148 #: ../src/guestfs-actions.pod:3352
13149 msgid "guestfs_is_chardev"
13154 #: ../src/guestfs-actions.pod:3354
13158 " guestfs_is_chardev (guestfs_h *g,\n"
13159 " const char *path);\n"
13165 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2337
13167 "This returns C<true> if and only if there is a character device with the "
13168 "given C<path> name."
13173 #: ../src/guestfs-actions.pod:3367
13174 msgid "guestfs_is_config"
13179 #: ../src/guestfs-actions.pod:3369
13183 " guestfs_is_config (guestfs_h *g);\n"
13189 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2346
13191 "This returns true iff this handle is being configured (in the C<CONFIG> "
13197 #: ../src/guestfs-actions.pod:3381
13198 msgid "guestfs_is_dir"
13203 #: ../src/guestfs-actions.pod:3383
13207 " guestfs_is_dir (guestfs_h *g,\n"
13208 " const char *path);\n"
13214 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2355
13216 "This returns C<true> if and only if there is a directory with the given "
13217 "C<path> name. Note that it returns false for other objects like files."
13222 #: ../src/guestfs-actions.pod:3397
13223 msgid "guestfs_is_fifo"
13228 #: ../src/guestfs-actions.pod:3399
13232 " guestfs_is_fifo (guestfs_h *g,\n"
13233 " const char *path);\n"
13239 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2365
13241 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13242 "given C<path> name."
13247 #: ../src/guestfs-actions.pod:3412
13248 msgid "guestfs_is_file"
13253 #: ../src/guestfs-actions.pod:3414
13257 " guestfs_is_file (guestfs_h *g,\n"
13258 " const char *path);\n"
13264 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2374
13266 "This returns C<true> if and only if there is a regular file with the given "
13267 "C<path> name. Note that it returns false for other objects like directories."
13272 #: ../src/guestfs-actions.pod:3428
13273 msgid "guestfs_is_launching"
13278 #: ../src/guestfs-actions.pod:3430
13282 " guestfs_is_launching (guestfs_h *g);\n"
13288 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2384
13290 "This returns true iff this handle is launching the subprocess (in the "
13291 "C<LAUNCHING> state)."
13296 #: ../src/guestfs-actions.pod:3442
13297 msgid "guestfs_is_lv"
13302 #: ../src/guestfs-actions.pod:3444
13306 " guestfs_is_lv (guestfs_h *g,\n"
13307 " const char *device);\n"
13313 #: ../src/guestfs-actions.pod:3448 ../fish/guestfish-actions.pod:2393
13315 "This command tests whether C<device> is a logical volume, and returns true "
13316 "iff this is the case."
13321 #: ../src/guestfs-actions.pod:3455
13322 msgid "guestfs_is_ready"
13327 #: ../src/guestfs-actions.pod:3457
13331 " guestfs_is_ready (guestfs_h *g);\n"
13337 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2400
13339 "This returns true iff this handle is ready to accept commands (in the "
13345 #: ../src/guestfs-actions.pod:3469
13346 msgid "guestfs_is_socket"
13351 #: ../src/guestfs-actions.pod:3471
13355 " guestfs_is_socket (guestfs_h *g,\n"
13356 " const char *path);\n"
13362 #: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2409
13364 "This returns C<true> if and only if there is a Unix domain socket with the "
13365 "given C<path> name."
13370 #: ../src/guestfs-actions.pod:3484
13371 msgid "guestfs_is_symlink"
13376 #: ../src/guestfs-actions.pod:3486
13380 " guestfs_is_symlink (guestfs_h *g,\n"
13381 " const char *path);\n"
13387 #: ../src/guestfs-actions.pod:3490 ../fish/guestfish-actions.pod:2418
13389 "This returns C<true> if and only if there is a symbolic link with the given "
13394 #: ../src/guestfs-actions.pod:3499
13395 msgid "guestfs_is_zero"
13399 #: ../src/guestfs-actions.pod:3501
13403 " guestfs_is_zero (guestfs_h *g,\n"
13404 " const char *path);\n"
13409 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2427
13411 "This returns true iff the file exists and the file is empty or it contains "
13416 #: ../src/guestfs-actions.pod:3510
13417 msgid "guestfs_is_zero_device"
13421 #: ../src/guestfs-actions.pod:3512
13425 " guestfs_is_zero_device (guestfs_h *g,\n"
13426 " const char *device);\n"
13431 #: ../src/guestfs-actions.pod:3516 ../fish/guestfish-actions.pod:2434
13432 msgid "This returns true iff the device exists and contains all zero bytes."
13436 #: ../src/guestfs-actions.pod:3518 ../fish/guestfish-actions.pod:2436
13437 msgid "Note that for large devices this can take a long time to run."
13442 #: ../src/guestfs-actions.pod:3522
13443 msgid "guestfs_kill_subprocess"
13448 #: ../src/guestfs-actions.pod:3524
13452 " guestfs_kill_subprocess (guestfs_h *g);\n"
13458 #: ../src/guestfs-actions.pod:3527 ../fish/guestfish-actions.pod:2442
13459 msgid "This kills the qemu subprocess. You should never need to call this."
13464 #: ../src/guestfs-actions.pod:3533
13465 msgid "guestfs_launch"
13470 #: ../src/guestfs-actions.pod:3535
13474 " guestfs_launch (guestfs_h *g);\n"
13480 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2450
13482 "Internally libguestfs is implemented by running a virtual machine using "
13488 #: ../src/guestfs-actions.pod:3541 ../fish/guestfish-actions.pod:2453
13490 "You should call this after configuring the handle (eg. adding drives) but "
13491 "before performing any actions."
13496 #: ../src/guestfs-actions.pod:3553
13497 msgid "guestfs_lchown"
13502 #: ../src/guestfs-actions.pod:3555
13506 " guestfs_lchown (guestfs_h *g,\n"
13509 " const char *path);\n"
13515 #: ../src/guestfs-actions.pod:3561
13517 "Change the file owner to C<owner> and group to C<group>. This is like "
13518 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13519 "changed, not the target."
13524 #: ../src/guestfs-actions.pod:3573
13525 msgid "guestfs_lgetxattr"
13530 #: ../src/guestfs-actions.pod:3575
13534 " guestfs_lgetxattr (guestfs_h *g,\n"
13535 " const char *path,\n"
13536 " const char *name,\n"
13537 " size_t *size_r);\n"
13543 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2472
13545 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13546 "is a symlink, then this call returns an extended attribute from the symlink."
13551 #: ../src/guestfs-actions.pod:3595
13552 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13557 #: ../src/guestfs-actions.pod:3603
13558 msgid "guestfs_lgetxattrs"
13563 #: ../src/guestfs-actions.pod:3605
13566 " struct guestfs_xattr_list *\n"
13567 " guestfs_lgetxattrs (guestfs_h *g,\n"
13568 " const char *path);\n"
13574 #: ../src/guestfs-actions.pod:3609
13576 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13577 "then it returns the extended attributes of the link itself."
13581 #: ../src/guestfs-actions.pod:3619
13582 msgid "guestfs_list_9p"
13586 #: ../src/guestfs-actions.pod:3621
13590 " guestfs_list_9p (guestfs_h *g);\n"
13595 #: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:2500
13597 "List all 9p filesystems attached to the guest. A list of mount tags is "
13603 #: ../src/guestfs-actions.pod:3631
13604 msgid "guestfs_list_devices"
13609 #: ../src/guestfs-actions.pod:3633
13613 " guestfs_list_devices (guestfs_h *g);\n"
13619 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2507
13620 msgid "List all the block devices."
13625 #: ../src/guestfs-actions.pod:3638 ../fish/guestfish-actions.pod:2509
13626 msgid "The full block device names are returned, eg. C</dev/sda>."
13631 #: ../src/guestfs-actions.pod:3648
13632 msgid "guestfs_list_filesystems"
13637 #: ../src/guestfs-actions.pod:3650
13641 " guestfs_list_filesystems (guestfs_h *g);\n"
13647 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2517
13649 "This inspection command looks for filesystems on partitions, block devices "
13650 "and logical volumes, returning a list of devices containing filesystems and "
13656 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2521
13658 "The return value is a hash, where the keys are the devices containing "
13659 "filesystems, and the values are the filesystem types. For example:"
13664 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2525
13667 " \"/dev/sda1\" => \"ntfs\"\n"
13668 " \"/dev/sda2\" => \"ext2\"\n"
13669 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13670 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13676 #: ../src/guestfs-actions.pod:3666 ../fish/guestfish-actions.pod:2530
13678 "The value can have the special value \"unknown\", meaning the content of the "
13679 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13684 #: ../src/guestfs-actions.pod:3670
13686 "This command runs other libguestfs commands, which might include "
13687 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13688 "soon after launch and only when nothing is mounted."
13693 #: ../src/guestfs-actions.pod:3674
13695 "Not all of the filesystems returned will be mountable. In particular, swap "
13696 "partitions are returned in the list. Also this command does not check that "
13697 "each filesystem found is valid and mountable, and some filesystems might be "
13698 "mountable but require special options. Filesystems may not all belong to a "
13699 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13704 #: ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:5348
13705 msgid "(Added in 1.5.15)"
13710 #: ../src/guestfs-actions.pod:3690
13711 msgid "guestfs_list_partitions"
13716 #: ../src/guestfs-actions.pod:3692
13720 " guestfs_list_partitions (guestfs_h *g);\n"
13726 #: ../src/guestfs-actions.pod:3695 ../fish/guestfish-actions.pod:2550
13727 msgid "List all the partitions detected on all block devices."
13732 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2552
13733 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13738 #: ../src/guestfs-actions.pod:3699
13740 "This does not return logical volumes. For that you will need to call "
13746 #: ../src/guestfs-actions.pod:3710
13752 #: ../src/guestfs-actions.pod:3712
13756 " guestfs_ll (guestfs_h *g,\n"
13757 " const char *directory);\n"
13763 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2563
13765 "List the files in C<directory> (relative to the root directory, there is no "
13766 "cwd) in the format of 'ls -la'."
13771 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2566
13773 "This command is mostly useful for interactive sessions. It is I<not> "
13774 "intended that you try to parse the output string."
13779 #: ../src/guestfs-actions.pod:3727
13785 #: ../src/guestfs-actions.pod:3729
13789 " guestfs_ln (guestfs_h *g,\n"
13790 " const char *target,\n"
13791 " const char *linkname);\n"
13797 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2573
13798 msgid "This command creates a hard link using the C<ln> command."
13803 #: ../src/guestfs-actions.pod:3740
13804 msgid "guestfs_ln_f"
13809 #: ../src/guestfs-actions.pod:3742
13813 " guestfs_ln_f (guestfs_h *g,\n"
13814 " const char *target,\n"
13815 " const char *linkname);\n"
13820 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2579
13822 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13823 "option removes the link (C<linkname>) if it exists already."
13828 #: ../src/guestfs-actions.pod:3754
13829 msgid "guestfs_ln_s"
13834 #: ../src/guestfs-actions.pod:3756
13838 " guestfs_ln_s (guestfs_h *g,\n"
13839 " const char *target,\n"
13840 " const char *linkname);\n"
13846 #: ../src/guestfs-actions.pod:3761 ../fish/guestfish-actions.pod:2586
13847 msgid "This command creates a symbolic link using the C<ln -s> command."
13852 #: ../src/guestfs-actions.pod:3767
13853 msgid "guestfs_ln_sf"
13858 #: ../src/guestfs-actions.pod:3769
13862 " guestfs_ln_sf (guestfs_h *g,\n"
13863 " const char *target,\n"
13864 " const char *linkname);\n"
13869 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2592
13871 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13872 "option removes the link (C<linkname>) if it exists already."
13877 #: ../src/guestfs-actions.pod:3781
13878 msgid "guestfs_lremovexattr"
13883 #: ../src/guestfs-actions.pod:3783
13887 " guestfs_lremovexattr (guestfs_h *g,\n"
13888 " const char *xattr,\n"
13889 " const char *path);\n"
13895 #: ../src/guestfs-actions.pod:3788
13897 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13898 "link, then it removes an extended attribute of the link itself."
13903 #: ../src/guestfs-actions.pod:3796
13909 #: ../src/guestfs-actions.pod:3798
13913 " guestfs_ls (guestfs_h *g,\n"
13914 " const char *directory);\n"
13920 #: ../src/guestfs-actions.pod:3802 ../fish/guestfish-actions.pod:2607
13922 "List the files in C<directory> (relative to the root directory, there is no "
13923 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13928 #: ../src/guestfs-actions.pod:3806
13930 "This command is mostly useful for interactive sessions. Programs should "
13931 "probably use C<guestfs_readdir> instead."
13936 #: ../src/guestfs-actions.pod:3815
13937 msgid "guestfs_lsetxattr"
13942 #: ../src/guestfs-actions.pod:3817
13946 " guestfs_lsetxattr (guestfs_h *g,\n"
13947 " const char *xattr,\n"
13948 " const char *val,\n"
13950 " const char *path);\n"
13956 #: ../src/guestfs-actions.pod:3824
13958 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13959 "then it sets an extended attribute of the link itself."
13964 #: ../src/guestfs-actions.pod:3832
13965 msgid "guestfs_lstat"
13970 #: ../src/guestfs-actions.pod:3834
13973 " struct guestfs_stat *\n"
13974 " guestfs_lstat (guestfs_h *g,\n"
13975 " const char *path);\n"
13981 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:6479
13982 #: ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4343
13983 msgid "Returns file information for the given C<path>."
13988 #: ../src/guestfs-actions.pod:3840
13990 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13991 "link, then the link is stat-ed, not the file it refers to."
13996 #: ../src/guestfs-actions.pod:3844 ../fish/guestfish-actions.pod:2632
13997 msgid "This is the same as the C<lstat(2)> system call."
14002 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:6483
14004 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
14005 "error. I<The caller must call C<guestfs_free_stat> after use>."
14010 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:6487
14011 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6886
14012 msgid "(Added in 0.9.2)"
14017 #: ../src/guestfs-actions.pod:3852
14018 msgid "guestfs_lstatlist"
14023 #: ../src/guestfs-actions.pod:3854
14026 " struct guestfs_stat_list *\n"
14027 " guestfs_lstatlist (guestfs_h *g,\n"
14028 " const char *path,\n"
14029 " char *const *names);\n"
14035 #: ../src/guestfs-actions.pod:3859
14037 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
14038 "files, where all files are in the directory C<path>. C<names> is the list "
14039 "of files from this directory."
14044 #: ../src/guestfs-actions.pod:3863 ../fish/guestfish-actions.pod:2642
14046 "On return you get a list of stat structs, with a one-to-one correspondence "
14047 "to the C<names> list. If any name did not exist or could not be lstat'd, "
14048 "then the C<ino> field of that structure is set to C<-1>."
14053 #: ../src/guestfs-actions.pod:3868
14055 "This call is intended for programs that want to efficiently list a directory "
14056 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
14057 "for a similarly efficient call for getting extended attributes. Very long "
14058 "directory listings might cause the protocol message size to be exceeded, "
14059 "causing this call to fail. The caller must split up such requests into "
14060 "smaller groups of names."
14065 #: ../src/guestfs-actions.pod:3876
14067 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
14068 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
14073 #: ../src/guestfs-actions.pod:3882
14074 msgid "guestfs_luks_add_key"
14079 #: ../src/guestfs-actions.pod:3884
14083 " guestfs_luks_add_key (guestfs_h *g,\n"
14084 " const char *device,\n"
14085 " const char *key,\n"
14086 " const char *newkey,\n"
14093 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:2659
14095 "This command adds a new key on LUKS device C<device>. C<key> is any "
14096 "existing key, and is used to access the device. C<newkey> is the new key to "
14097 "add. C<keyslot> is the key slot that will be replaced."
14102 #: ../src/guestfs-actions.pod:3896
14104 "Note that if C<keyslot> already contains a key, then this command will "
14105 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
14110 #: ../src/guestfs-actions.pod:3902 ../src/guestfs-actions.pod:3942
14111 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:3985
14112 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4036
14114 "This function takes a key or passphrase parameter which could contain "
14115 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
14121 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3946
14122 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:3989
14123 msgid "(Added in 1.5.2)"
14128 #: ../src/guestfs-actions.pod:3908
14129 msgid "guestfs_luks_close"
14134 #: ../src/guestfs-actions.pod:3910
14138 " guestfs_luks_close (guestfs_h *g,\n"
14139 " const char *device);\n"
14145 #: ../src/guestfs-actions.pod:3914
14147 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
14148 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
14149 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
14150 "underlying block device."
14155 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4021
14156 #: ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4090
14157 #: ../src/guestfs-actions.pod:4138
14158 msgid "(Added in 1.5.1)"
14163 #: ../src/guestfs-actions.pod:3924
14164 msgid "guestfs_luks_format"
14169 #: ../src/guestfs-actions.pod:3926
14173 " guestfs_luks_format (guestfs_h *g,\n"
14174 " const char *device,\n"
14175 " const char *key,\n"
14182 #: ../src/guestfs-actions.pod:3932 ../fish/guestfish-actions.pod:2685
14184 "This command erases existing data on C<device> and formats the device as a "
14185 "LUKS encrypted device. C<key> is the initial key, which is added to key "
14186 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
14191 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3962
14192 #: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5099
14193 #: ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:6286
14194 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6349
14195 #: ../src/guestfs-actions.pod:7531 ../fish/guestfish-actions.pod:2693
14196 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2790
14197 #: ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3904
14198 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4237
14199 #: ../fish/guestfish-actions.pod:4259 ../fish/guestfish-actions.pod:4989
14201 "B<This command is dangerous. Without careful use you can easily destroy all "
14207 #: ../src/guestfs-actions.pod:3948
14208 msgid "guestfs_luks_format_cipher"
14213 #: ../src/guestfs-actions.pod:3950
14217 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14218 " const char *device,\n"
14219 " const char *key,\n"
14221 " const char *cipher);\n"
14227 #: ../src/guestfs-actions.pod:3957
14229 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14230 "set the C<cipher> used."
14235 #: ../src/guestfs-actions.pod:3971
14236 msgid "guestfs_luks_kill_slot"
14241 #: ../src/guestfs-actions.pod:3973
14245 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14246 " const char *device,\n"
14247 " const char *key,\n"
14254 #: ../src/guestfs-actions.pod:3979 ../fish/guestfish-actions.pod:2713
14256 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14257 "device C<device>. C<key> must be one of the I<other> keys."
14262 #: ../src/guestfs-actions.pod:3991
14263 msgid "guestfs_luks_open"
14268 #: ../src/guestfs-actions.pod:3993
14272 " guestfs_luks_open (guestfs_h *g,\n"
14273 " const char *device,\n"
14274 " const char *key,\n"
14275 " const char *mapname);\n"
14281 #: ../src/guestfs-actions.pod:3999 ../fish/guestfish-actions.pod:2724
14283 "This command opens a block device which has been encrypted according to the "
14284 "Linux Unified Key Setup (LUKS) standard."
14289 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2727
14290 msgid "C<device> is the encrypted block device or partition."
14295 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2729
14297 "The caller must supply one of the keys associated with the LUKS block "
14298 "device, in the C<key> parameter."
14303 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2732
14305 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14306 "writes to this block device are decrypted from and encrypted to the "
14307 "underlying C<device> respectively."
14312 #: ../src/guestfs-actions.pod:4011
14314 "If this block device contains LVM volume groups, then calling "
14315 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14321 #: ../src/guestfs-actions.pod:4023
14322 msgid "guestfs_luks_open_ro"
14327 #: ../src/guestfs-actions.pod:4025
14331 " guestfs_luks_open_ro (guestfs_h *g,\n"
14332 " const char *device,\n"
14333 " const char *key,\n"
14334 " const char *mapname);\n"
14340 #: ../src/guestfs-actions.pod:4031
14342 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14348 #: ../src/guestfs-actions.pod:4042
14349 msgid "guestfs_lvcreate"
14354 #: ../src/guestfs-actions.pod:4044
14358 " guestfs_lvcreate (guestfs_h *g,\n"
14359 " const char *logvol,\n"
14360 " const char *volgroup,\n"
14367 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2757
14369 "This creates an LVM logical volume called C<logvol> on the volume group "
14370 "C<volgroup>, with C<size> megabytes."
14375 #: ../src/guestfs-actions.pod:4057
14376 msgid "guestfs_lvm_canonical_lv_name"
14381 #: ../src/guestfs-actions.pod:4059
14385 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14386 " const char *lvname);\n"
14392 #: ../src/guestfs-actions.pod:4063 ../fish/guestfish-actions.pod:2764
14394 "This converts alternative naming schemes for LVs that you might find to the "
14395 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14401 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2768
14403 "This command returns an error if the C<lvname> parameter does not refer to a "
14409 #: ../src/guestfs-actions.pod:4070
14410 msgid "See also C<guestfs_is_lv>."
14415 #: ../src/guestfs-actions.pod:4075
14416 msgid "(Added in 1.5.24)"
14421 #: ../src/guestfs-actions.pod:4077
14422 msgid "guestfs_lvm_clear_filter"
14427 #: ../src/guestfs-actions.pod:4079
14431 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14437 #: ../src/guestfs-actions.pod:4082
14439 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14440 "see every block device."
14445 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4127
14446 #: ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
14448 "This command also clears the LVM cache and performs a volume group scan."
14453 #: ../src/guestfs-actions.pod:4092
14454 msgid "guestfs_lvm_remove_all"
14459 #: ../src/guestfs-actions.pod:4094
14463 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14469 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2787
14471 "This command removes all LVM logical volumes, volume groups and physical "
14477 #: ../src/guestfs-actions.pod:4107
14478 msgid "guestfs_lvm_set_filter"
14483 #: ../src/guestfs-actions.pod:4109
14487 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14488 " char *const *devices);\n"
14494 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2797
14496 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14497 "block devices in the list C<devices>, and will ignore all other attached "
14503 #: ../src/guestfs-actions.pod:4117 ../fish/guestfish-actions.pod:2801
14505 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14506 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14507 "there are two types of duplication possible: either cloned PVs/VGs which "
14508 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14509 "same name. In normal operation you cannot create this situation, but you "
14510 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14511 "inside the LVM metadata."
14516 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2814
14517 msgid "You can filter whole block devices or individual partitions."
14522 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2816
14524 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14525 "filesystem), even if you are not filtering out that VG."
14530 #: ../src/guestfs-actions.pod:4140
14531 msgid "guestfs_lvremove"
14536 #: ../src/guestfs-actions.pod:4142
14540 " guestfs_lvremove (guestfs_h *g,\n"
14541 " const char *device);\n"
14547 #: ../src/guestfs-actions.pod:4146 ../fish/guestfish-actions.pod:2824
14549 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14550 "LV, such as C</dev/VG/LV>."
14555 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2827
14557 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14563 #: ../src/guestfs-actions.pod:4154 ../src/guestfs-actions.pod:5445
14564 #: ../src/guestfs-actions.pod:7262
14565 msgid "(Added in 1.0.13)"
14570 #: ../src/guestfs-actions.pod:4156
14571 msgid "guestfs_lvrename"
14576 #: ../src/guestfs-actions.pod:4158
14580 " guestfs_lvrename (guestfs_h *g,\n"
14581 " const char *logvol,\n"
14582 " const char *newlogvol);\n"
14588 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2834
14589 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14594 #: ../src/guestfs-actions.pod:4167 ../src/guestfs-actions.pod:7275
14595 msgid "(Added in 1.0.83)"
14600 #: ../src/guestfs-actions.pod:4169
14601 msgid "guestfs_lvresize"
14606 #: ../src/guestfs-actions.pod:4171
14610 " guestfs_lvresize (guestfs_h *g,\n"
14611 " const char *device,\n"
14618 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2840
14620 "This resizes (expands or shrinks) an existing LVM logical volume to "
14621 "C<mbytes>. When reducing, data in the reduced part is lost."
14626 #: ../src/guestfs-actions.pod:4184
14627 msgid "guestfs_lvresize_free"
14632 #: ../src/guestfs-actions.pod:4186
14636 " guestfs_lvresize_free (guestfs_h *g,\n"
14637 " const char *lv,\n"
14644 #: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2848
14646 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14647 "remaining free space in the volume group. Commonly you would call this with "
14648 "pc = 100 which expands the logical volume as much as possible, using all "
14649 "remaining free space in the volume group."
14654 #: ../src/guestfs-actions.pod:4199
14655 msgid "(Added in 1.3.3)"
14660 #: ../src/guestfs-actions.pod:4201
14661 msgid "guestfs_lvs"
14666 #: ../src/guestfs-actions.pod:4203
14670 " guestfs_lvs (guestfs_h *g);\n"
14676 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2858
14678 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14684 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2861
14686 "This returns a list of the logical volume device names (eg. C</dev/"
14687 "VolGroup00/LogVol00>)."
14692 #: ../src/guestfs-actions.pod:4212
14693 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14698 #: ../src/guestfs-actions.pod:4220
14699 msgid "guestfs_lvs_full"
14704 #: ../src/guestfs-actions.pod:4222
14707 " struct guestfs_lvm_lv_list *\n"
14708 " guestfs_lvs_full (guestfs_h *g);\n"
14714 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2870
14716 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14717 "(8)> command. The \"full\" version includes all fields."
14722 #: ../src/guestfs-actions.pod:4228
14724 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14725 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14730 #: ../src/guestfs-actions.pod:4234
14731 msgid "guestfs_lvuuid"
14736 #: ../src/guestfs-actions.pod:4236
14740 " guestfs_lvuuid (guestfs_h *g,\n"
14741 " const char *device);\n"
14747 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2877
14748 msgid "This command returns the UUID of the LVM LV C<device>."
14753 #: ../src/guestfs-actions.pod:4247
14754 msgid "guestfs_lxattrlist"
14759 #: ../src/guestfs-actions.pod:4249
14762 " struct guestfs_xattr_list *\n"
14763 " guestfs_lxattrlist (guestfs_h *g,\n"
14764 " const char *path,\n"
14765 " char *const *names);\n"
14771 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2883
14773 "This call allows you to get the extended attributes of multiple files, where "
14774 "all files are in the directory C<path>. C<names> is the list of files from "
14780 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2887
14782 "On return you get a flat list of xattr structs which must be interpreted "
14783 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14784 "C<attrval> in this struct is zero-length to indicate there was an error "
14785 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14786 "number (the number of following attributes for this file, which could be C<"
14787 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14788 "for the first named file. This repeats for the second and subsequent files."
14793 #: ../src/guestfs-actions.pod:4268
14795 "This call is intended for programs that want to efficiently list a directory "
14796 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14797 "a similarly efficient call for getting standard stats. Very long directory "
14798 "listings might cause the protocol message size to be exceeded, causing this "
14799 "call to fail. The caller must split up such requests into smaller groups of "
14805 #: ../src/guestfs-actions.pod:4282
14806 msgid "guestfs_mkdir"
14811 #: ../src/guestfs-actions.pod:4284
14815 " guestfs_mkdir (guestfs_h *g,\n"
14816 " const char *path);\n"
14822 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2909
14823 msgid "Create a directory named C<path>."
14828 #: ../src/guestfs-actions.pod:4294
14829 msgid "guestfs_mkdir_mode"
14834 #: ../src/guestfs-actions.pod:4296
14838 " guestfs_mkdir_mode (guestfs_h *g,\n"
14839 " const char *path,\n"
14846 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2915
14848 "This command creates a directory, setting the initial permissions of the "
14849 "directory to C<mode>."
14854 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:2918
14856 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14857 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14863 #: ../src/guestfs-actions.pod:4308
14864 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14869 #: ../src/guestfs-actions.pod:4314
14870 msgid "guestfs_mkdir_p"
14875 #: ../src/guestfs-actions.pod:4316
14879 " guestfs_mkdir_p (guestfs_h *g,\n"
14880 " const char *path);\n"
14886 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2928
14888 "Create a directory named C<path>, creating any parent directories as "
14889 "necessary. This is like the C<mkdir -p> shell command."
14894 #: ../src/guestfs-actions.pod:4327
14895 msgid "guestfs_mkdtemp"
14900 #: ../src/guestfs-actions.pod:4329
14904 " guestfs_mkdtemp (guestfs_h *g,\n"
14905 " const char *template);\n"
14911 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2935
14913 "This command creates a temporary directory. The C<template> parameter "
14914 "should be a full pathname for the temporary directory name with the final "
14915 "six characters being \"XXXXXX\"."
14920 #: ../src/guestfs-actions.pod:4338 ../fish/guestfish-actions.pod:2940
14922 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14923 "being suitable for Windows filesystems."
14928 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2943
14929 msgid "The name of the temporary directory that was created is returned."
14934 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2946
14935 msgid "The temporary directory is created with mode 0700 and is owned by root."
14940 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2949
14942 "The caller is responsible for deleting the temporary directory and its "
14943 "contents after use."
14948 #: ../src/guestfs-actions.pod:4350 ../fish/guestfish-actions.pod:2952
14949 msgid "See also: L<mkdtemp(3)>"
14954 #: ../src/guestfs-actions.pod:4357
14955 msgid "guestfs_mke2fs_J"
14960 #: ../src/guestfs-actions.pod:4359
14964 " guestfs_mke2fs_J (guestfs_h *g,\n"
14965 " const char *fstype,\n"
14966 " int blocksize,\n"
14967 " const char *device,\n"
14968 " const char *journal);\n"
14974 #: ../src/guestfs-actions.pod:4366 ../fish/guestfish-actions.pod:2958
14976 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14977 "C<journal>. It is equivalent to the command:"
14982 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2962
14985 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14991 #: ../src/guestfs-actions.pod:4372
14992 msgid "See also C<guestfs_mke2journal>."
14997 #: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4394
14998 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4428
14999 #: ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:4456
15000 #: ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4780
15001 msgid "(Added in 1.0.68)"
15006 #: ../src/guestfs-actions.pod:4378
15007 msgid "guestfs_mke2fs_JL"
15012 #: ../src/guestfs-actions.pod:4380
15016 " guestfs_mke2fs_JL (guestfs_h *g,\n"
15017 " const char *fstype,\n"
15018 " int blocksize,\n"
15019 " const char *device,\n"
15020 " const char *label);\n"
15026 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2970
15028 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15029 "the journal labeled C<label>."
15034 #: ../src/guestfs-actions.pod:4390
15035 msgid "See also C<guestfs_mke2journal_L>."
15040 #: ../src/guestfs-actions.pod:4396
15041 msgid "guestfs_mke2fs_JU"
15046 #: ../src/guestfs-actions.pod:4398
15050 " guestfs_mke2fs_JU (guestfs_h *g,\n"
15051 " const char *fstype,\n"
15052 " int blocksize,\n"
15053 " const char *device,\n"
15054 " const char *uuid);\n"
15060 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2979
15062 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15063 "the journal with UUID C<uuid>."
15068 #: ../src/guestfs-actions.pod:4408
15069 msgid "See also C<guestfs_mke2journal_U>."
15074 #: ../src/guestfs-actions.pod:4414
15075 msgid "guestfs_mke2journal"
15080 #: ../src/guestfs-actions.pod:4416
15084 " guestfs_mke2journal (guestfs_h *g,\n"
15085 " int blocksize,\n"
15086 " const char *device);\n"
15092 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2988
15094 "This creates an ext2 external journal on C<device>. It is equivalent to the "
15100 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2991
15103 " mke2fs -O journal_dev -b blocksize device\n"
15109 #: ../src/guestfs-actions.pod:4430
15110 msgid "guestfs_mke2journal_L"
15115 #: ../src/guestfs-actions.pod:4432
15119 " guestfs_mke2journal_L (guestfs_h *g,\n"
15120 " int blocksize,\n"
15121 " const char *label,\n"
15122 " const char *device);\n"
15128 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2997
15129 msgid "This creates an ext2 external journal on C<device> with label C<label>."
15134 #: ../src/guestfs-actions.pod:4444
15135 msgid "guestfs_mke2journal_U"
15140 #: ../src/guestfs-actions.pod:4446
15144 " guestfs_mke2journal_U (guestfs_h *g,\n"
15145 " int blocksize,\n"
15146 " const char *uuid,\n"
15147 " const char *device);\n"
15153 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3003
15154 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
15159 #: ../src/guestfs-actions.pod:4458
15160 msgid "guestfs_mkfifo"
15165 #: ../src/guestfs-actions.pod:4460
15169 " guestfs_mkfifo (guestfs_h *g,\n"
15171 " const char *path);\n"
15177 #: ../src/guestfs-actions.pod:4465
15179 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
15180 "is just a convenient wrapper around C<guestfs_mknod>."
15185 #: ../src/guestfs-actions.pod:4475
15186 msgid "guestfs_mkfs"
15191 #: ../src/guestfs-actions.pod:4477
15195 " guestfs_mkfs (guestfs_h *g,\n"
15196 " const char *fstype,\n"
15197 " const char *device);\n"
15203 #: ../src/guestfs-actions.pod:4482 ../fish/guestfish-actions.pod:3019
15205 "This creates a filesystem on C<device> (usually a partition or LVM logical "
15206 "volume). The filesystem type is C<fstype>, for example C<ext3>."
15211 #: ../src/guestfs-actions.pod:4490
15212 msgid "guestfs_mkfs_b"
15217 #: ../src/guestfs-actions.pod:4492
15221 " guestfs_mkfs_b (guestfs_h *g,\n"
15222 " const char *fstype,\n"
15223 " int blocksize,\n"
15224 " const char *device);\n"
15230 #: ../src/guestfs-actions.pod:4498
15232 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15233 "block size of the resulting filesystem. Supported block sizes depend on the "
15234 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15239 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4546
15240 #: ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
15242 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15248 #: ../src/guestfs-actions.pod:4508 ../fish/guestfish-actions.pod:3035
15250 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15255 #: ../src/guestfs-actions.pod:4517
15256 msgid "guestfs_mkfs_opts"
15261 #: ../src/guestfs-actions.pod:4519
15265 " guestfs_mkfs_opts (guestfs_h *g,\n"
15266 " const char *fstype,\n"
15267 " const char *device,\n"
15273 #: ../src/guestfs-actions.pod:4530
15276 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15277 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15283 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3046
15285 "This function creates a filesystem on C<device>. The filesystem type is "
15286 "C<fstype>, for example C<ext3>."
15291 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3053
15292 msgid "C<blocksize>"
15297 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3055
15299 "The filesystem block size. Supported block sizes depend on the filesystem "
15300 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15305 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3062
15306 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15310 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3064
15311 msgid "C<features>"
15315 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3066
15316 msgid "This passes the I<-O> parameter to the external mkfs program."
15320 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3068
15322 "For certain filesystem types, this allows extra filesystem features to be "
15323 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15327 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3072
15329 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15334 #: ../src/guestfs-actions.pod:4566
15335 msgid "(Added in 1.7.19)"
15340 #: ../src/guestfs-actions.pod:4568
15341 msgid "guestfs_mkfs_opts_va"
15346 #: ../src/guestfs-actions.pod:4570
15350 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15351 " const char *fstype,\n"
15352 " const char *device,\n"
15353 " va_list args);\n"
15359 #: ../src/guestfs-actions.pod:4576
15360 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15365 #: ../src/guestfs-actions.pod:4580
15366 msgid "guestfs_mkfs_opts_argv"
15371 #: ../src/guestfs-actions.pod:4582
15375 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15376 " const char *fstype,\n"
15377 " const char *device,\n"
15378 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15384 #: ../src/guestfs-actions.pod:4588
15385 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15390 #: ../src/guestfs-actions.pod:4592
15391 msgid "guestfs_mkmountpoint"
15396 #: ../src/guestfs-actions.pod:4594
15400 " guestfs_mkmountpoint (guestfs_h *g,\n"
15401 " const char *exemptpath);\n"
15407 #: ../src/guestfs-actions.pod:4598
15409 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15410 "that can be used to create extra mountpoints before mounting the first "
15416 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3087
15418 "These calls are I<only> necessary in some very limited circumstances, mainly "
15419 "the case where you want to mount a mix of unrelated and/or read-only "
15420 "filesystems together."
15425 #: ../src/guestfs-actions.pod:4606 ../fish/guestfish-actions.pod:3091
15427 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15428 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15429 "inside that. You can unpack this as follows in guestfish:"
15434 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3096
15437 " add-ro Fedora-11-i686-Live.iso\n"
15439 " mkmountpoint /cd\n"
15440 " mkmountpoint /sqsh\n"
15441 " mkmountpoint /ext3fs\n"
15442 " mount /dev/sda /cd\n"
15443 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15444 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15450 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3105
15451 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15456 #: ../src/guestfs-actions.pod:4622
15458 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15459 "may get unexpected errors if you try to mix these calls. It is safest to "
15460 "manually unmount filesystems and remove mountpoints after use."
15465 #: ../src/guestfs-actions.pod:4626
15467 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15468 "first, so for this to work for manual mountpoints, you must ensure that the "
15469 "innermost mountpoints have the longest pathnames, as in the example code "
15475 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3116
15477 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15481 #: ../src/guestfs-actions.pod:4633
15483 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15484 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15485 "can also trigger these issues."
15490 #: ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4953
15491 #: ../src/guestfs-actions.pod:5863
15492 msgid "(Added in 1.0.62)"
15497 #: ../src/guestfs-actions.pod:4641
15498 msgid "guestfs_mknod"
15503 #: ../src/guestfs-actions.pod:4643
15507 " guestfs_mknod (guestfs_h *g,\n"
15511 " const char *path);\n"
15517 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3126
15519 "This call creates block or character special devices, or named pipes (FIFOs)."
15524 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3129
15526 "The C<mode> parameter should be the mode, using the standard constants. "
15527 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15528 "used when creating block and character special devices."
15533 #: ../src/guestfs-actions.pod:4658
15535 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15536 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15537 "regular file). These constants are available in the standard Linux header "
15538 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15539 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15540 "the appropriate constant for you."
15545 #: ../src/guestfs-actions.pod:4672
15546 msgid "guestfs_mknod_b"
15551 #: ../src/guestfs-actions.pod:4674
15555 " guestfs_mknod_b (guestfs_h *g,\n"
15559 " const char *path);\n"
15565 #: ../src/guestfs-actions.pod:4681
15567 "This call creates a block device node called C<path> with mode C<mode> and "
15568 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15569 "wrapper around C<guestfs_mknod>."
15574 #: ../src/guestfs-actions.pod:4691
15575 msgid "guestfs_mknod_c"
15580 #: ../src/guestfs-actions.pod:4693
15584 " guestfs_mknod_c (guestfs_h *g,\n"
15588 " const char *path);\n"
15594 #: ../src/guestfs-actions.pod:4700
15596 "This call creates a char device node called C<path> with mode C<mode> and "
15597 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15598 "wrapper around C<guestfs_mknod>."
15603 #: ../src/guestfs-actions.pod:4710
15604 msgid "guestfs_mkswap"
15609 #: ../src/guestfs-actions.pod:4712
15613 " guestfs_mkswap (guestfs_h *g,\n"
15614 " const char *device);\n"
15620 #: ../src/guestfs-actions.pod:4716 ../fish/guestfish-actions.pod:3168
15621 msgid "Create a swap partition on C<device>."
15626 #: ../src/guestfs-actions.pod:4722
15627 msgid "guestfs_mkswap_L"
15632 #: ../src/guestfs-actions.pod:4724
15636 " guestfs_mkswap_L (guestfs_h *g,\n"
15637 " const char *label,\n"
15638 " const char *device);\n"
15644 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3174
15645 msgid "Create a swap partition on C<device> with label C<label>."
15650 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3176
15652 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15653 "sda>), just to a partition. This appears to be a limitation of the kernel "
15659 #: ../src/guestfs-actions.pod:4739
15660 msgid "guestfs_mkswap_U"
15665 #: ../src/guestfs-actions.pod:4741
15669 " guestfs_mkswap_U (guestfs_h *g,\n"
15670 " const char *uuid,\n"
15671 " const char *device);\n"
15677 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3184
15678 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15683 #: ../src/guestfs-actions.pod:4752
15684 msgid "guestfs_mkswap_file"
15689 #: ../src/guestfs-actions.pod:4754
15693 " guestfs_mkswap_file (guestfs_h *g,\n"
15694 " const char *path);\n"
15700 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3190
15701 msgid "Create a swap file."
15706 #: ../src/guestfs-actions.pod:4760
15708 "This command just writes a swap file signature to an existing file. To "
15709 "create the file itself, use something like C<guestfs_fallocate>."
15714 #: ../src/guestfs-actions.pod:4767
15715 msgid "guestfs_modprobe"
15720 #: ../src/guestfs-actions.pod:4769
15724 " guestfs_modprobe (guestfs_h *g,\n"
15725 " const char *modulename);\n"
15731 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3199
15732 msgid "This loads a kernel module in the appliance."
15737 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3201
15739 "The kernel module must have been whitelisted when libguestfs was built (see "
15740 "C<appliance/kmod.whitelist.in> in the source)."
15745 #: ../src/guestfs-actions.pod:4782
15746 msgid "guestfs_mount"
15751 #: ../src/guestfs-actions.pod:4784
15755 " guestfs_mount (guestfs_h *g,\n"
15756 " const char *device,\n"
15757 " const char *mountpoint);\n"
15763 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3208
15765 "Mount a guest disk at a position in the filesystem. Block devices are named "
15766 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15767 "those block devices contain partitions, they will have the usual names (eg. "
15768 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15773 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3214
15775 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15776 "mounted on C</> before others can be mounted. Other filesystems can only be "
15777 "mounted on directories which already exist."
15782 #: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3219
15784 "The mounted filesystem is writable, if we have sufficient permissions on the "
15785 "underlying device."
15790 #: ../src/guestfs-actions.pod:4803
15792 "B<Important note:> When you use this call, the filesystem options C<sync> "
15793 "and C<noatime> are set implicitly. This was originally done because we "
15794 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15795 "very large negative performance impact and negligible effect on "
15796 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15797 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15798 "(use an empty string for the first parameter if you don't want any options)."
15802 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3232
15804 "This function is deprecated. In new code, use the C<mount_options> call "
15809 #: ../src/guestfs-actions.pod:4824
15810 msgid "guestfs_mount_9p"
15814 #: ../src/guestfs-actions.pod:4826
15818 " guestfs_mount_9p (guestfs_h *g,\n"
15819 " const char *mounttag,\n"
15820 " const char *mountpoint,\n"
15826 #: ../src/guestfs-actions.pod:4837
15829 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
15834 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3243
15836 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
15841 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3246
15843 "If required, C<trans=virtio> will be automatically added to the options. "
15844 "Any other options required can be passed in the optional C<options> "
15849 #: ../src/guestfs-actions.pod:4848
15850 msgid "guestfs_mount_9p_va"
15854 #: ../src/guestfs-actions.pod:4850
15858 " guestfs_mount_9p_va (guestfs_h *g,\n"
15859 " const char *mounttag,\n"
15860 " const char *mountpoint,\n"
15861 " va_list args);\n"
15866 #: ../src/guestfs-actions.pod:4856
15867 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
15871 #: ../src/guestfs-actions.pod:4860
15872 msgid "guestfs_mount_9p_argv"
15876 #: ../src/guestfs-actions.pod:4862
15880 " guestfs_mount_9p_argv (guestfs_h *g,\n"
15881 " const char *mounttag,\n"
15882 " const char *mountpoint,\n"
15883 " const struct guestfs_mount_9p_argv *optargs);\n"
15888 #: ../src/guestfs-actions.pod:4868
15889 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
15894 #: ../src/guestfs-actions.pod:4872
15895 msgid "guestfs_mount_loop"
15900 #: ../src/guestfs-actions.pod:4874
15904 " guestfs_mount_loop (guestfs_h *g,\n"
15905 " const char *file,\n"
15906 " const char *mountpoint);\n"
15912 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3256
15914 "This command lets you mount C<file> (a filesystem image in a file) on a "
15915 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15921 #: ../src/guestfs-actions.pod:4887
15922 msgid "guestfs_mount_options"
15927 #: ../src/guestfs-actions.pod:4889
15931 " guestfs_mount_options (guestfs_h *g,\n"
15932 " const char *options,\n"
15933 " const char *device,\n"
15934 " const char *mountpoint);\n"
15940 #: ../src/guestfs-actions.pod:4895
15942 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15943 "the mount options as for the L<mount(8)> I<-o> flag."
15948 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3268
15950 "If the C<options> parameter is an empty string, then no options are passed "
15951 "(all options default to whatever the filesystem uses)."
15956 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4919
15957 #: ../src/guestfs-actions.pod:4936
15958 msgid "(Added in 1.0.10)"
15963 #: ../src/guestfs-actions.pod:4907
15964 msgid "guestfs_mount_ro"
15969 #: ../src/guestfs-actions.pod:4909
15973 " guestfs_mount_ro (guestfs_h *g,\n"
15974 " const char *device,\n"
15975 " const char *mountpoint);\n"
15981 #: ../src/guestfs-actions.pod:4914
15983 "This is the same as the C<guestfs_mount> command, but it mounts the "
15984 "filesystem with the read-only (I<-o ro>) flag."
15989 #: ../src/guestfs-actions.pod:4921
15990 msgid "guestfs_mount_vfs"
15995 #: ../src/guestfs-actions.pod:4923
15999 " guestfs_mount_vfs (guestfs_h *g,\n"
16000 " const char *options,\n"
16001 " const char *vfstype,\n"
16002 " const char *device,\n"
16003 " const char *mountpoint);\n"
16009 #: ../src/guestfs-actions.pod:4930
16011 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16012 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
16018 #: ../src/guestfs-actions.pod:4938
16019 msgid "guestfs_mountpoints"
16024 #: ../src/guestfs-actions.pod:4940
16028 " guestfs_mountpoints (guestfs_h *g);\n"
16034 #: ../src/guestfs-actions.pod:4943
16036 "This call is similar to C<guestfs_mounts>. That call returns a list of "
16037 "devices. This one returns a hash table (map) of device name to directory "
16038 "where the device is mounted."
16043 #: ../src/guestfs-actions.pod:4955
16044 msgid "guestfs_mounts"
16049 #: ../src/guestfs-actions.pod:4957
16053 " guestfs_mounts (guestfs_h *g);\n"
16059 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3299
16061 "This returns the list of currently mounted filesystems. It returns the list "
16062 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
16067 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3302
16068 msgid "Some internal mounts are not shown."
16073 #: ../src/guestfs-actions.pod:4965
16074 msgid "See also: C<guestfs_mountpoints>"
16079 #: ../src/guestfs-actions.pod:4973
16085 #: ../src/guestfs-actions.pod:4975
16089 " guestfs_mv (guestfs_h *g,\n"
16090 " const char *src,\n"
16091 " const char *dest);\n"
16097 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3310
16099 "This moves a file from C<src> to C<dest> where C<dest> is either a "
16100 "destination filename or destination directory."
16105 #: ../src/guestfs-actions.pod:4987
16106 msgid "guestfs_ntfs_3g_probe"
16111 #: ../src/guestfs-actions.pod:4989
16115 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
16117 " const char *device);\n"
16123 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3317
16125 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
16126 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
16127 "write, and some cannot be mounted at all)."
16132 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3321
16134 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
16135 "can be mounted read-write. Set it to false if you want to test if the "
16136 "volume can be mounted read-only."
16141 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3325
16143 "The return value is an integer which C<0> if the operation would succeed, or "
16144 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
16149 #: ../src/guestfs-actions.pod:5008
16150 msgid "(Added in 1.0.43)"
16155 #: ../src/guestfs-actions.pod:5010
16156 msgid "guestfs_ntfsresize"
16161 #: ../src/guestfs-actions.pod:5012
16165 " guestfs_ntfsresize (guestfs_h *g,\n"
16166 " const char *device);\n"
16172 #: ../src/guestfs-actions.pod:5016 ../fish/guestfish-actions.pod:3333
16174 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
16175 "size of the underlying device. See also L<ntfsresize(8)>."
16180 #: ../src/guestfs-actions.pod:5024
16181 msgid "guestfs_ntfsresize_size"
16186 #: ../src/guestfs-actions.pod:5026
16190 " guestfs_ntfsresize_size (guestfs_h *g,\n"
16191 " const char *device,\n"
16192 " int64_t size);\n"
16198 #: ../src/guestfs-actions.pod:5031
16200 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
16201 "to specify the new size (in bytes) explicitly."
16206 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5472
16207 #: ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5811
16208 #: ../src/guestfs-actions.pod:7417
16209 msgid "(Added in 1.3.14)"
16214 #: ../src/guestfs-actions.pod:5038
16215 msgid "guestfs_part_add"
16220 #: ../src/guestfs-actions.pod:5040
16224 " guestfs_part_add (guestfs_h *g,\n"
16225 " const char *device,\n"
16226 " const char *prlogex,\n"
16227 " int64_t startsect,\n"
16228 " int64_t endsect);\n"
16234 #: ../src/guestfs-actions.pod:5047
16236 "This command adds a partition to C<device>. If there is no partition table "
16237 "on the device, call C<guestfs_part_init> first."
16242 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3351
16244 "The C<prlogex> parameter is the type of partition. Normally you should pass "
16245 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
16246 "C<logical>) and C<e> (or C<extended>) partition types."
16251 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3356
16253 "C<startsect> and C<endsect> are the start and end of the partition in "
16254 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
16255 "from the end of the disk (C<-1> is the last sector)."
16260 #: ../src/guestfs-actions.pod:5059
16262 "Creating a partition which covers the whole disk is not so easy. Use "
16263 "C<guestfs_part_disk> to do that."
16268 #: ../src/guestfs-actions.pod:5064 ../src/guestfs-actions.pod:5102
16269 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5233
16270 #: ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5290
16271 #: ../src/guestfs-actions.pod:5330
16272 msgid "(Added in 1.0.78)"
16277 #: ../src/guestfs-actions.pod:5066
16278 msgid "guestfs_part_del"
16283 #: ../src/guestfs-actions.pod:5068
16287 " guestfs_part_del (guestfs_h *g,\n"
16288 " const char *device,\n"
16295 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3367
16296 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16301 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3369
16303 "Note that in the case of MBR partitioning, deleting an extended partition "
16304 "also deletes any logical partitions it contains."
16309 #: ../src/guestfs-actions.pod:5083
16310 msgid "guestfs_part_disk"
16315 #: ../src/guestfs-actions.pod:5085
16319 " guestfs_part_disk (guestfs_h *g,\n"
16320 " const char *device,\n"
16321 " const char *parttype);\n"
16327 #: ../src/guestfs-actions.pod:5090
16329 "This command is simply a combination of C<guestfs_part_init> followed by "
16330 "C<guestfs_part_add> to create a single primary partition covering the whole "
16336 #: ../src/guestfs-actions.pod:5094
16338 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16339 "possible values are described in C<guestfs_part_init>."
16344 #: ../src/guestfs-actions.pod:5104
16345 msgid "guestfs_part_get_bootable"
16350 #: ../src/guestfs-actions.pod:5106
16354 " guestfs_part_get_bootable (guestfs_h *g,\n"
16355 " const char *device,\n"
16362 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3391
16364 "This command returns true if the partition C<partnum> on C<device> has the "
16365 "bootable flag set."
16370 #: ../src/guestfs-actions.pod:5114
16371 msgid "See also C<guestfs_part_set_bootable>."
16376 #: ../src/guestfs-actions.pod:5120
16377 msgid "guestfs_part_get_mbr_id"
16382 #: ../src/guestfs-actions.pod:5122
16386 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16387 " const char *device,\n"
16394 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3400
16396 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16397 "partition C<partnum>."
16402 #: ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5306
16404 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16405 "undefined results for other partition table types (see "
16406 "C<guestfs_part_get_parttype>)."
16411 #: ../src/guestfs-actions.pod:5138
16412 msgid "guestfs_part_get_parttype"
16417 #: ../src/guestfs-actions.pod:5140
16421 " guestfs_part_get_parttype (guestfs_h *g,\n"
16422 " const char *device);\n"
16428 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3411
16430 "This command examines the partition table on C<device> and returns the "
16431 "partition table type (format) being used."
16436 #: ../src/guestfs-actions.pod:5147
16438 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16439 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16440 "possible, although unusual. See C<guestfs_part_init> for a full list."
16445 #: ../src/guestfs-actions.pod:5157
16446 msgid "guestfs_part_init"
16451 #: ../src/guestfs-actions.pod:5159
16455 " guestfs_part_init (guestfs_h *g,\n"
16456 " const char *device,\n"
16457 " const char *parttype);\n"
16463 #: ../src/guestfs-actions.pod:5164 ../fish/guestfish-actions.pod:3423
16465 "This creates an empty partition table on C<device> of one of the partition "
16466 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16467 "(for large disks)."
16472 #: ../src/guestfs-actions.pod:5168
16474 "Initially there are no partitions. Following this, you should call "
16475 "C<guestfs_part_add> for each partition required."
16480 #: ../src/guestfs-actions.pod:5171 ../fish/guestfish-actions.pod:3430
16481 msgid "Possible values for C<parttype> are:"
16486 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3434
16487 msgid "B<efi> | B<gpt>"
16492 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3436
16493 msgid "Intel EFI / GPT partition table."
16498 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3438
16500 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16501 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16502 "the C<mbr> format."
16507 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3442
16508 msgid "B<mbr> | B<msdos>"
16513 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3444
16515 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16516 "Windows. This partition type will B<only> work for device sizes up to 2 "
16517 "TB. For large disks we recommend using C<gpt>."
16522 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3451
16524 "Other partition table types that may work but are not supported include:"
16529 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3456
16535 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3458
16536 msgid "AIX disk labels."
16541 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3460
16542 msgid "B<amiga> | B<rdb>"
16547 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3462
16548 msgid "Amiga \"Rigid Disk Block\" format."
16553 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3464
16559 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3466
16560 msgid "BSD disk labels."
16565 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3468
16571 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3470
16572 msgid "DASD, used on IBM mainframes."
16577 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3472
16583 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3474
16584 msgid "MIPS/SGI volumes."
16589 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3476
16595 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3478
16596 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16601 #: ../src/guestfs-actions.pod:5221 ../fish/guestfish-actions.pod:3480
16607 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3482
16608 msgid "NEC PC-98 format, common in Japan apparently."
16613 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3484
16619 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3486
16620 msgid "Sun disk labels."
16625 #: ../src/guestfs-actions.pod:5235
16626 msgid "guestfs_part_list"
16631 #: ../src/guestfs-actions.pod:5237
16634 " struct guestfs_partition_list *\n"
16635 " guestfs_part_list (guestfs_h *g,\n"
16636 " const char *device);\n"
16642 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3494
16644 "This command parses the partition table on C<device> and returns the list of "
16645 "partitions found."
16650 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3497
16651 msgid "The fields in the returned structure are:"
16656 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3501
16657 msgid "B<part_num>"
16662 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3503
16663 msgid "Partition number, counting from 1."
16668 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3505
16669 msgid "B<part_start>"
16674 #: ../src/guestfs-actions.pod:5254
16676 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16677 "the device's sector size, see C<guestfs_blockdev_getss>."
16682 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3510
16683 msgid "B<part_end>"
16688 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3512
16689 msgid "End of the partition in bytes."
16694 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3514
16695 msgid "B<part_size>"
16700 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3516
16701 msgid "Size of the partition in bytes."
16706 #: ../src/guestfs-actions.pod:5267
16708 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16709 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16715 #: ../src/guestfs-actions.pod:5273
16716 msgid "guestfs_part_set_bootable"
16721 #: ../src/guestfs-actions.pod:5275
16725 " guestfs_part_set_bootable (guestfs_h *g,\n"
16726 " const char *device,\n"
16728 " int bootable);\n"
16734 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3524
16736 "This sets the bootable flag on partition numbered C<partnum> on device "
16737 "C<device>. Note that partitions are numbered from 1."
16742 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3527
16744 "The bootable flag is used by some operating systems (notably Windows) to "
16745 "determine which partition to boot from. It is by no means universally "
16751 #: ../src/guestfs-actions.pod:5292
16752 msgid "guestfs_part_set_mbr_id"
16757 #: ../src/guestfs-actions.pod:5294
16761 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16762 " const char *device,\n"
16770 #: ../src/guestfs-actions.pod:5300 ../fish/guestfish-actions.pod:3535
16772 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16773 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16774 "documentation are in fact hexadecimal numbers, but usually documented "
16775 "without any leading \"0x\" which might be confusing."
16780 #: ../src/guestfs-actions.pod:5314
16781 msgid "guestfs_part_set_name"
16786 #: ../src/guestfs-actions.pod:5316
16790 " guestfs_part_set_name (guestfs_h *g,\n"
16791 " const char *device,\n"
16793 " const char *name);\n"
16799 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3549
16801 "This sets the partition name on partition numbered C<partnum> on device "
16802 "C<device>. Note that partitions are numbered from 1."
16807 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3552
16809 "The partition name can only be set on certain types of partition table. "
16810 "This works on C<gpt> but not on C<mbr> partitions."
16815 #: ../src/guestfs-actions.pod:5332
16816 msgid "guestfs_part_to_dev"
16821 #: ../src/guestfs-actions.pod:5334
16825 " guestfs_part_to_dev (guestfs_h *g,\n"
16826 " const char *partition);\n"
16832 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3559
16834 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16835 "partition number, returning the device name (eg. \"/dev/sdb\")."
16840 #: ../src/guestfs-actions.pod:5342
16842 "The named partition must exist, for example as a string returned from "
16843 "C<guestfs_list_partitions>."
16848 #: ../src/guestfs-actions.pod:5350
16849 msgid "guestfs_ping_daemon"
16854 #: ../src/guestfs-actions.pod:5352
16858 " guestfs_ping_daemon (guestfs_h *g);\n"
16864 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3570
16866 "This is a test probe into the guestfs daemon running inside the qemu "
16867 "subprocess. Calling this function checks that the daemon responds to the "
16868 "ping message, without affecting the daemon or attached block device(s) in "
16874 #: ../src/guestfs-actions.pod:5364
16875 msgid "guestfs_pread"
16880 #: ../src/guestfs-actions.pod:5366
16884 " guestfs_pread (guestfs_h *g,\n"
16885 " const char *path,\n"
16887 " int64_t offset,\n"
16888 " size_t *size_r);\n"
16894 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3579
16896 "This command lets you read part of a file. It reads C<count> bytes of the "
16897 "file, starting at C<offset>, from file C<path>."
16902 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5402
16903 #: ../fish/guestfish-actions.pod:3582 ../fish/guestfish-actions.pod:3597
16905 "This may read fewer bytes than requested. For further details see the "
16906 "L<pread(2)> system call."
16911 #: ../src/guestfs-actions.pod:5379
16912 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16917 #: ../src/guestfs-actions.pod:5390
16918 msgid "guestfs_pread_device"
16923 #: ../src/guestfs-actions.pod:5392
16927 " guestfs_pread_device (guestfs_h *g,\n"
16928 " const char *device,\n"
16930 " int64_t offset,\n"
16931 " size_t *size_r);\n"
16937 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3594
16939 "This command lets you read part of a file. It reads C<count> bytes of "
16940 "C<device>, starting at C<offset>."
16945 #: ../src/guestfs-actions.pod:5405
16946 msgid "See also C<guestfs_pread>."
16951 #: ../src/guestfs-actions.pod:5414
16952 msgid "(Added in 1.5.21)"
16957 #: ../src/guestfs-actions.pod:5416
16958 msgid "guestfs_pvcreate"
16963 #: ../src/guestfs-actions.pod:5418
16967 " guestfs_pvcreate (guestfs_h *g,\n"
16968 " const char *device);\n"
16974 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3609
16976 "This creates an LVM physical volume on the named C<device>, where C<device> "
16977 "should usually be a partition name such as C</dev/sda1>."
16982 #: ../src/guestfs-actions.pod:5430
16983 msgid "guestfs_pvremove"
16988 #: ../src/guestfs-actions.pod:5432
16992 " guestfs_pvremove (guestfs_h *g,\n"
16993 " const char *device);\n"
16999 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3617
17001 "This wipes a physical volume C<device> so that LVM will no longer recognise "
17007 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3620
17009 "The implementation uses the C<pvremove> command which refuses to wipe "
17010 "physical volumes that contain any volume groups, so you have to remove those "
17016 #: ../src/guestfs-actions.pod:5447
17017 msgid "guestfs_pvresize"
17022 #: ../src/guestfs-actions.pod:5449
17026 " guestfs_pvresize (guestfs_h *g,\n"
17027 " const char *device);\n"
17033 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3628
17035 "This resizes (expands or shrinks) an existing LVM physical volume to match "
17036 "the new size of the underlying device."
17041 #: ../src/guestfs-actions.pod:5460
17042 msgid "guestfs_pvresize_size"
17047 #: ../src/guestfs-actions.pod:5462
17051 " guestfs_pvresize_size (guestfs_h *g,\n"
17052 " const char *device,\n"
17053 " int64_t size);\n"
17059 #: ../src/guestfs-actions.pod:5467
17061 "This command is the same as C<guestfs_pvresize> except that it allows you to "
17062 "specify the new size (in bytes) explicitly."
17067 #: ../src/guestfs-actions.pod:5474
17068 msgid "guestfs_pvs"
17073 #: ../src/guestfs-actions.pod:5476
17077 " guestfs_pvs (guestfs_h *g);\n"
17083 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3642
17085 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17091 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3645
17093 "This returns a list of just the device names that contain PVs (eg. C</dev/"
17099 #: ../src/guestfs-actions.pod:5485
17100 msgid "See also C<guestfs_pvs_full>."
17105 #: ../src/guestfs-actions.pod:5493
17106 msgid "guestfs_pvs_full"
17111 #: ../src/guestfs-actions.pod:5495
17114 " struct guestfs_lvm_pv_list *\n"
17115 " guestfs_pvs_full (guestfs_h *g);\n"
17121 #: ../src/guestfs-actions.pod:5498 ../fish/guestfish-actions.pod:3654
17123 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17124 "(8)> command. The \"full\" version includes all fields."
17129 #: ../src/guestfs-actions.pod:5501
17131 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
17132 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
17137 #: ../src/guestfs-actions.pod:5507
17138 msgid "guestfs_pvuuid"
17143 #: ../src/guestfs-actions.pod:5509
17147 " guestfs_pvuuid (guestfs_h *g,\n"
17148 " const char *device);\n"
17154 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3661
17155 msgid "This command returns the UUID of the LVM PV C<device>."
17160 #: ../src/guestfs-actions.pod:5520
17161 msgid "guestfs_pwrite"
17166 #: ../src/guestfs-actions.pod:5522
17170 " guestfs_pwrite (guestfs_h *g,\n"
17171 " const char *path,\n"
17172 " const char *content,\n"
17173 " size_t content_size,\n"
17174 " int64_t offset);\n"
17180 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3667
17182 "This command writes to part of a file. It writes the data buffer C<content> "
17183 "to the file C<path> starting at offset C<offset>."
17188 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3670
17190 "This command implements the L<pwrite(2)> system call, and like that system "
17191 "call it may not write the full data requested. The return value is the "
17192 "number of bytes that were actually written to the file. This could even be "
17193 "0, although short writes are unlikely for regular files in ordinary "
17199 #: ../src/guestfs-actions.pod:5538
17200 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
17205 #: ../src/guestfs-actions.pod:5547
17206 msgid "guestfs_pwrite_device"
17211 #: ../src/guestfs-actions.pod:5549
17215 " guestfs_pwrite_device (guestfs_h *g,\n"
17216 " const char *device,\n"
17217 " const char *content,\n"
17218 " size_t content_size,\n"
17219 " int64_t offset);\n"
17225 #: ../src/guestfs-actions.pod:5556 ../fish/guestfish-actions.pod:3685
17227 "This command writes to part of a device. It writes the data buffer "
17228 "C<content> to C<device> starting at offset C<offset>."
17233 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3688
17235 "This command implements the L<pwrite(2)> system call, and like that system "
17236 "call it may not write the full data requested (although short writes to disk "
17237 "devices and partitions are probably impossible with standard Linux kernels)."
17242 #: ../src/guestfs-actions.pod:5564
17243 msgid "See also C<guestfs_pwrite>."
17248 #: ../src/guestfs-actions.pod:5571
17249 msgid "(Added in 1.5.20)"
17254 #: ../src/guestfs-actions.pod:5573
17255 msgid "guestfs_read_file"
17260 #: ../src/guestfs-actions.pod:5575
17264 " guestfs_read_file (guestfs_h *g,\n"
17265 " const char *path,\n"
17266 " size_t *size_r);\n"
17272 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3702
17273 msgid "This calls returns the contents of the file C<path> as a buffer."
17278 #: ../src/guestfs-actions.pod:5583
17280 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
17281 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
17282 "function is limited in the total size of file that can be handled."
17287 #: ../src/guestfs-actions.pod:5595
17288 msgid "(Added in 1.0.63)"
17293 #: ../src/guestfs-actions.pod:5597
17294 msgid "guestfs_read_lines"
17299 #: ../src/guestfs-actions.pod:5599
17303 " guestfs_read_lines (guestfs_h *g,\n"
17304 " const char *path);\n"
17310 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3719
17312 "The file contents are returned as a list of lines. Trailing C<LF> and "
17313 "C<CRLF> character sequences are I<not> returned."
17318 #: ../src/guestfs-actions.pod:5608
17320 "Note that this function cannot correctly handle binary files (specifically, "
17321 "files containing C<\\0> character which is treated as end of line). For "
17322 "those you need to use the C<guestfs_read_file> function which has a more "
17323 "complex interface."
17328 #: ../src/guestfs-actions.pod:5619
17329 msgid "guestfs_readdir"
17334 #: ../src/guestfs-actions.pod:5621
17337 " struct guestfs_dirent_list *\n"
17338 " guestfs_readdir (guestfs_h *g,\n"
17339 " const char *dir);\n"
17345 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3731
17346 msgid "This returns the list of directory entries in directory C<dir>."
17351 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3733
17353 "All entries in the directory are returned, including C<.> and C<..>. The "
17354 "entries are I<not> sorted, but returned in the same order as the underlying "
17360 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3737
17362 "Also this call returns basic file type information about each file. The "
17363 "C<ftyp> field will contain one of the following characters:"
17368 #: ../src/guestfs-actions.pod:5636 ../fish/guestfish-actions.pod:3742
17374 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3744
17375 msgid "Block special"
17380 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3746
17386 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3748
17387 msgid "Char special"
17392 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3750
17398 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3752
17404 #: ../src/guestfs-actions.pod:5648 ../fish/guestfish-actions.pod:3754
17410 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3756
17411 msgid "FIFO (named pipe)"
17416 #: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3758
17422 #: ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:3760
17423 msgid "Symbolic link"
17428 #: ../src/guestfs-actions.pod:5656 ../fish/guestfish-actions.pod:3762
17434 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3764
17435 msgid "Regular file"
17440 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3766
17446 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3768
17452 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3770
17458 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3772
17459 msgid "Unknown file type"
17464 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3774
17470 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:3776
17472 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17477 #: ../src/guestfs-actions.pod:5675
17479 "This function is primarily intended for use by programs. To get a simple "
17480 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17481 "consumption, use C<guestfs_ll>."
17486 #: ../src/guestfs-actions.pod:5679
17488 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17489 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17494 #: ../src/guestfs-actions.pod:5685
17495 msgid "guestfs_readlink"
17500 #: ../src/guestfs-actions.pod:5687
17504 " guestfs_readlink (guestfs_h *g,\n"
17505 " const char *path);\n"
17511 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3789
17512 msgid "This command reads the target of a symbolic link."
17517 #: ../src/guestfs-actions.pod:5698
17518 msgid "guestfs_readlinklist"
17523 #: ../src/guestfs-actions.pod:5700
17527 " guestfs_readlinklist (guestfs_h *g,\n"
17528 " const char *path,\n"
17529 " char *const *names);\n"
17535 #: ../src/guestfs-actions.pod:5705 ../fish/guestfish-actions.pod:3795
17537 "This call allows you to do a C<readlink> operation on multiple files, where "
17538 "all files are in the directory C<path>. C<names> is the list of files from "
17544 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3799
17546 "On return you get a list of strings, with a one-to-one correspondence to the "
17547 "C<names> list. Each string is the value of the symbolic link."
17552 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3803
17554 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17555 "result string is the empty string C<\"\">. However the whole operation is "
17556 "completed even if there were C<readlink(2)> errors, and so you can call this "
17557 "function with names where you don't know if they are symbolic links already "
17558 "(albeit slightly less efficient)."
17563 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3810
17565 "This call is intended for programs that want to efficiently list a directory "
17566 "contents without making many round-trips. Very long directory listings "
17567 "might cause the protocol message size to be exceeded, causing this call to "
17568 "fail. The caller must split up such requests into smaller groups of names."
17573 #: ../src/guestfs-actions.pod:5733
17574 msgid "guestfs_realpath"
17579 #: ../src/guestfs-actions.pod:5735
17583 " guestfs_realpath (guestfs_h *g,\n"
17584 " const char *path);\n"
17590 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3821
17592 "Return the canonicalized absolute pathname of C<path>. The returned path "
17593 "has no C<.>, C<..> or symbolic link path elements."
17598 #: ../src/guestfs-actions.pod:5747
17599 msgid "guestfs_removexattr"
17604 #: ../src/guestfs-actions.pod:5749
17608 " guestfs_removexattr (guestfs_h *g,\n"
17609 " const char *xattr,\n"
17610 " const char *path);\n"
17616 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3828
17618 "This call removes the extended attribute named C<xattr> of the file C<path>."
17623 #: ../src/guestfs-actions.pod:5757
17624 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17629 #: ../src/guestfs-actions.pod:5763
17630 msgid "guestfs_resize2fs"
17635 #: ../src/guestfs-actions.pod:5765
17639 " guestfs_resize2fs (guestfs_h *g,\n"
17640 " const char *device);\n"
17646 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3837
17648 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17649 "underlying device."
17654 #: ../src/guestfs-actions.pod:5772
17656 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17657 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17658 "sometimes gives an error about this and sometimes not. In any case, it is "
17659 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17663 #: ../src/guestfs-actions.pod:5782
17664 msgid "guestfs_resize2fs_M"
17668 #: ../src/guestfs-actions.pod:5784
17672 " guestfs_resize2fs_M (guestfs_h *g,\n"
17673 " const char *device);\n"
17678 #: ../src/guestfs-actions.pod:5788
17680 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17681 "resized to its minimum size. This works like the I<-M> option to the "
17682 "C<resize2fs> command."
17686 #: ../src/guestfs-actions.pod:5792
17688 "To get the resulting size of the filesystem you should call "
17689 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17690 "These two numbers, multiplied together, give the resulting size of the "
17691 "minimal filesystem in bytes."
17696 #: ../src/guestfs-actions.pod:5799
17697 msgid "guestfs_resize2fs_size"
17702 #: ../src/guestfs-actions.pod:5801
17706 " guestfs_resize2fs_size (guestfs_h *g,\n"
17707 " const char *device,\n"
17708 " int64_t size);\n"
17714 #: ../src/guestfs-actions.pod:5806
17716 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17717 "to specify the new size (in bytes) explicitly."
17722 #: ../src/guestfs-actions.pod:5813
17728 #: ../src/guestfs-actions.pod:5815
17732 " guestfs_rm (guestfs_h *g,\n"
17733 " const char *path);\n"
17739 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3870
17740 msgid "Remove the single file C<path>."
17745 #: ../src/guestfs-actions.pod:5825
17746 msgid "guestfs_rm_rf"
17751 #: ../src/guestfs-actions.pod:5827
17755 " guestfs_rm_rf (guestfs_h *g,\n"
17756 " const char *path);\n"
17762 #: ../src/guestfs-actions.pod:5831 ../fish/guestfish-actions.pod:3876
17764 "Remove the file or directory C<path>, recursively removing the contents if "
17765 "its a directory. This is like the C<rm -rf> shell command."
17770 #: ../src/guestfs-actions.pod:5839
17771 msgid "guestfs_rmdir"
17776 #: ../src/guestfs-actions.pod:5841
17780 " guestfs_rmdir (guestfs_h *g,\n"
17781 " const char *path);\n"
17787 #: ../src/guestfs-actions.pod:5845 ../fish/guestfish-actions.pod:3884
17788 msgid "Remove the single directory C<path>."
17793 #: ../src/guestfs-actions.pod:5851
17794 msgid "guestfs_rmmountpoint"
17799 #: ../src/guestfs-actions.pod:5853
17803 " guestfs_rmmountpoint (guestfs_h *g,\n"
17804 " const char *exemptpath);\n"
17810 #: ../src/guestfs-actions.pod:5857
17812 "This calls removes a mountpoint that was previously created with "
17813 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17818 #: ../src/guestfs-actions.pod:5865
17819 msgid "guestfs_scrub_device"
17824 #: ../src/guestfs-actions.pod:5867
17828 " guestfs_scrub_device (guestfs_h *g,\n"
17829 " const char *device);\n"
17835 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3898
17837 "This command writes patterns over C<device> to make data retrieval more "
17843 #: ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:5895
17844 #: ../src/guestfs-actions.pod:5914 ../fish/guestfish-actions.pod:3901
17845 #: ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3929
17847 "It is an interface to the L<scrub(1)> program. See that manual page for "
17853 #: ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:5900
17854 #: ../src/guestfs-actions.pod:5919
17855 msgid "(Added in 1.0.52)"
17860 #: ../src/guestfs-actions.pod:5884
17861 msgid "guestfs_scrub_file"
17866 #: ../src/guestfs-actions.pod:5886
17870 " guestfs_scrub_file (guestfs_h *g,\n"
17871 " const char *file);\n"
17877 #: ../src/guestfs-actions.pod:5890 ../fish/guestfish-actions.pod:3911
17879 "This command writes patterns over a file to make data retrieval more "
17885 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3914
17886 msgid "The file is I<removed> after scrubbing."
17891 #: ../src/guestfs-actions.pod:5902
17892 msgid "guestfs_scrub_freespace"
17897 #: ../src/guestfs-actions.pod:5904
17901 " guestfs_scrub_freespace (guestfs_h *g,\n"
17902 " const char *dir);\n"
17908 #: ../src/guestfs-actions.pod:5908
17910 "This command creates the directory C<dir> and then fills it with files until "
17911 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17912 "and deletes them. The intention is to scrub any free space on the partition "
17913 "containing C<dir>."
17918 #: ../src/guestfs-actions.pod:5921
17919 msgid "guestfs_set_append"
17924 #: ../src/guestfs-actions.pod:5923
17928 " guestfs_set_append (guestfs_h *g,\n"
17929 " const char *append);\n"
17935 #: ../src/guestfs-actions.pod:5927 ../fish/guestfish-actions.pod:3938
17937 "This function is used to add additional options to the guest kernel command "
17943 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3941
17945 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17946 "environment variable."
17951 #: ../src/guestfs-actions.pod:5933 ../fish/guestfish-actions.pod:3944
17953 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17954 "(libguestfs always adds a few of its own)."
17958 #: ../src/guestfs-actions.pod:5940
17959 msgid "guestfs_set_attach_method"
17963 #: ../src/guestfs-actions.pod:5942
17967 " guestfs_set_attach_method (guestfs_h *g,\n"
17968 " const char *attachmethod);\n"
17973 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3953
17975 "Set the method that libguestfs uses to connect to the back end guestfsd "
17976 "daemon. Possible methods are:"
17980 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3960
17982 "Launch an appliance and connect to it. This is the ordinary method and the "
17987 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3963
17988 msgid "C<unix:I<path>>"
17992 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3965
17993 msgid "Connect to the Unix domain socket I<path>."
17997 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3967
17999 "This method lets you connect to an existing daemon or (using virtio-serial) "
18000 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
18001 "RUNNING DAEMONS>."
18006 #: ../src/guestfs-actions.pod:5968
18007 msgid "guestfs_set_autosync"
18012 #: ../src/guestfs-actions.pod:5970
18016 " guestfs_set_autosync (guestfs_h *g,\n"
18017 " int autosync);\n"
18022 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3979
18024 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
18025 "effort attempt to make filesystems consistent and synchronized when the "
18026 "handle is closed (also if the program exits without closing handles)."
18031 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3984
18033 "This is enabled by default (since libguestfs 1.5.24, previously it was "
18034 "disabled by default)."
18039 #: ../src/guestfs-actions.pod:5986
18040 msgid "guestfs_set_direct"
18045 #: ../src/guestfs-actions.pod:5988
18049 " guestfs_set_direct (guestfs_h *g,\n"
18056 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:3993
18058 "If the direct appliance mode flag is enabled, then stdin and stdout are "
18059 "passed directly through to the appliance once it is launched."
18064 #: ../src/guestfs-actions.pod:5996
18066 "One consequence of this is that log messages aren't caught by the library "
18067 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
18073 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4001
18074 msgid "You probably don't want to use this unless you know what you are doing."
18079 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4004
18080 msgid "The default is disabled."
18085 #: ../src/guestfs-actions.pod:6009
18086 msgid "guestfs_set_e2label"
18091 #: ../src/guestfs-actions.pod:6011
18095 " guestfs_set_e2label (guestfs_h *g,\n"
18096 " const char *device,\n"
18097 " const char *label);\n"
18103 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4010
18105 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
18106 "C<label>. Filesystem labels are limited to 16 characters."
18111 #: ../src/guestfs-actions.pod:6020
18113 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
18114 "the existing label on a filesystem."
18119 #: ../src/guestfs-actions.pod:6027
18120 msgid "guestfs_set_e2uuid"
18125 #: ../src/guestfs-actions.pod:6029
18129 " guestfs_set_e2uuid (guestfs_h *g,\n"
18130 " const char *device,\n"
18131 " const char *uuid);\n"
18137 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4021
18139 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
18140 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
18141 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
18146 #: ../src/guestfs-actions.pod:6039
18148 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
18149 "the existing UUID of a filesystem."
18154 #: ../src/guestfs-actions.pod:6046
18155 msgid "guestfs_set_memsize"
18160 #: ../src/guestfs-actions.pod:6048
18164 " guestfs_set_memsize (guestfs_h *g,\n"
18171 #: ../src/guestfs-actions.pod:6052
18173 "This sets the memory size in megabytes allocated to the qemu subprocess. "
18174 "This only has any effect if called before C<guestfs_launch>."
18179 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4039
18181 "You can also change this by setting the environment variable "
18182 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
18187 #: ../src/guestfs-actions.pod:6067
18188 msgid "guestfs_set_network"
18193 #: ../src/guestfs-actions.pod:6069
18197 " guestfs_set_network (guestfs_h *g,\n"
18204 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4052
18206 "If C<network> is true, then the network is enabled in the libguestfs "
18207 "appliance. The default is false."
18212 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4055
18214 "This affects whether commands are able to access the network (see L<guestfs"
18215 "(3)/RUNNING COMMANDS>)."
18220 #: ../src/guestfs-actions.pod:6079
18222 "You must call this before calling C<guestfs_launch>, otherwise it has no "
18228 #: ../src/guestfs-actions.pod:6086
18229 msgid "guestfs_set_path"
18234 #: ../src/guestfs-actions.pod:6088
18238 " guestfs_set_path (guestfs_h *g,\n"
18239 " const char *searchpath);\n"
18245 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4067
18246 msgid "Set the path that libguestfs searches for kernel and initrd.img."
18251 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4069
18253 "The default is C<$libdir/guestfs> unless overridden by setting "
18254 "C<LIBGUESTFS_PATH> environment variable."
18259 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4072
18260 msgid "Setting C<path> to C<NULL> restores the default path."
18265 #: ../src/guestfs-actions.pod:6103
18266 msgid "guestfs_set_qemu"
18271 #: ../src/guestfs-actions.pod:6105
18275 " guestfs_set_qemu (guestfs_h *g,\n"
18276 " const char *qemu);\n"
18282 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4080
18283 msgid "Set the qemu binary that we will use."
18288 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4082
18290 "The default is chosen when the library was compiled by the configure script."
18295 #: ../src/guestfs-actions.pod:6114 ../fish/guestfish-actions.pod:4085
18297 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18303 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4088
18304 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18309 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4090
18311 "Note that you should call this function as early as possible after creating "
18312 "the handle. This is because some pre-launch operations depend on testing "
18313 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18314 "don't retest features, and so you might see inconsistent results. Using the "
18315 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18316 "the qemu binary at the same time as the handle is created."
18321 #: ../src/guestfs-actions.pod:6131
18322 msgid "guestfs_set_recovery_proc"
18327 #: ../src/guestfs-actions.pod:6133
18331 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18332 " int recoveryproc);\n"
18338 #: ../src/guestfs-actions.pod:6137
18340 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18341 "not create a recovery process. The purpose of the recovery process is to "
18342 "stop runaway qemu processes in the case where the main program aborts "
18348 #: ../src/guestfs-actions.pod:6142
18350 "This only has any effect if called before C<guestfs_launch>, and the default "
18356 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4112
18358 "About the only time when you would want to disable this is if the main "
18359 "process will fork itself into the background (\"daemonize\" itself). In "
18360 "this case the recovery process thinks that the main program has disappeared "
18361 "and so kills qemu, which is not very helpful."
18366 #: ../src/guestfs-actions.pod:6155
18367 msgid "guestfs_set_selinux"
18372 #: ../src/guestfs-actions.pod:6157
18376 " guestfs_set_selinux (guestfs_h *g,\n"
18383 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4124
18385 "This sets the selinux flag that is passed to the appliance at boot time. "
18386 "The default is C<selinux=0> (disabled)."
18391 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4127
18393 "Note that if SELinux is enabled, it is always in Permissive mode "
18394 "(C<enforcing=0>)."
18399 #: ../src/guestfs-actions.pod:6174
18400 msgid "guestfs_set_trace"
18405 #: ../src/guestfs-actions.pod:6176
18409 " guestfs_set_trace (guestfs_h *g,\n"
18415 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4139
18417 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18418 "return values are traced."
18423 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4142
18425 "If you want to trace C API calls into libguestfs (and other libraries) then "
18426 "possibly a better way is to use the external ltrace(1) command."
18431 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4146
18433 "Command traces are disabled unless the environment variable "
18434 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18438 #: ../src/guestfs-actions.pod:6190
18440 "Trace messages are normally sent to C<stderr>, unless you register a "
18441 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18446 #: ../src/guestfs-actions.pod:6198
18447 msgid "guestfs_set_verbose"
18452 #: ../src/guestfs-actions.pod:6200
18456 " guestfs_set_verbose (guestfs_h *g,\n"
18462 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4159
18463 msgid "If C<verbose> is true, this turns on verbose messages."
18468 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4161
18470 "Verbose messages are disabled unless the environment variable "
18471 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18475 #: ../src/guestfs-actions.pod:6209
18477 "Verbose messages are normally sent to C<stderr>, unless you register a "
18478 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18483 #: ../src/guestfs-actions.pod:6217
18484 msgid "guestfs_setcon"
18489 #: ../src/guestfs-actions.pod:6219
18493 " guestfs_setcon (guestfs_h *g,\n"
18494 " const char *context);\n"
18500 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4172
18502 "This sets the SELinux security context of the daemon to the string "
18508 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4175
18509 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18514 #: ../src/guestfs-actions.pod:6232
18515 msgid "guestfs_setxattr"
18520 #: ../src/guestfs-actions.pod:6234
18524 " guestfs_setxattr (guestfs_h *g,\n"
18525 " const char *xattr,\n"
18526 " const char *val,\n"
18528 " const char *path);\n"
18534 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4181
18536 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18537 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18542 #: ../src/guestfs-actions.pod:6245
18543 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18548 #: ../src/guestfs-actions.pod:6251
18549 msgid "guestfs_sfdisk"
18554 #: ../src/guestfs-actions.pod:6253
18558 " guestfs_sfdisk (guestfs_h *g,\n"
18559 " const char *device,\n"
18563 " char *const *lines);\n"
18569 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4191
18571 "This is a direct interface to the L<sfdisk(8)> program for creating "
18572 "partitions on block devices."
18577 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4194
18578 msgid "C<device> should be a block device, for example C</dev/sda>."
18583 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4196
18585 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18586 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18587 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18588 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18589 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18590 "the kernel) cannot work out the right geometry and you will need to tell it."
18595 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4204
18597 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18598 "refer to the L<sfdisk(8)> manpage."
18603 #: ../src/guestfs-actions.pod:6277 ../fish/guestfish-actions.pod:4207
18605 "To create a single partition occupying the whole disk, you would pass "
18606 "C<lines> as a single element list, when the single element being the string "
18612 #: ../src/guestfs-actions.pod:6281
18614 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18618 #: ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6319
18619 #: ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4217
18620 #: ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4262
18622 "This function is deprecated. In new code, use the C<part_add> call instead."
18627 #: ../src/guestfs-actions.pod:6298
18628 msgid "guestfs_sfdiskM"
18633 #: ../src/guestfs-actions.pod:6300
18637 " guestfs_sfdiskM (guestfs_h *g,\n"
18638 " const char *device,\n"
18639 " char *const *lines);\n"
18645 #: ../src/guestfs-actions.pod:6305
18647 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18648 "partition sizes are specified in megabytes only (rounded to the nearest "
18649 "cylinder) and you don't need to specify the cyls, heads and sectors "
18650 "parameters which were rarely if ever used anyway."
18655 #: ../src/guestfs-actions.pod:6311
18657 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18658 "C<guestfs_part_disk>"
18663 #: ../src/guestfs-actions.pod:6328
18664 msgid "guestfs_sfdisk_N"
18669 #: ../src/guestfs-actions.pod:6330
18673 " guestfs_sfdisk_N (guestfs_h *g,\n"
18674 " const char *device,\n"
18679 " const char *line);\n"
18685 #: ../src/guestfs-actions.pod:6339 ../fish/guestfish-actions.pod:4251
18687 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18688 "(note: C<n> counts from 1)."
18693 #: ../src/guestfs-actions.pod:6342
18695 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18696 "for the cyls/heads/sectors parameters."
18701 #: ../src/guestfs-actions.pod:6345
18702 msgid "See also: C<guestfs_part_add>"
18707 #: ../src/guestfs-actions.pod:6361
18708 msgid "guestfs_sfdisk_disk_geometry"
18713 #: ../src/guestfs-actions.pod:6363
18717 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18718 " const char *device);\n"
18724 #: ../src/guestfs-actions.pod:6367
18726 "This displays the disk geometry of C<device> read from the partition table. "
18727 "Especially in the case where the underlying block device has been resized, "
18728 "this can be different from the kernel's idea of the geometry (see "
18729 "C<guestfs_sfdisk_kernel_geometry>)."
18734 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6388
18735 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4287
18736 msgid "The result is in human-readable format, and not designed to be parsed."
18741 #: ../src/guestfs-actions.pod:6380
18742 msgid "guestfs_sfdisk_kernel_geometry"
18747 #: ../src/guestfs-actions.pod:6382
18751 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18752 " const char *device);\n"
18758 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4285
18759 msgid "This displays the kernel's idea of the geometry of C<device>."
18764 #: ../src/guestfs-actions.pod:6396
18765 msgid "guestfs_sfdisk_l"
18770 #: ../src/guestfs-actions.pod:6398
18774 " guestfs_sfdisk_l (guestfs_h *g,\n"
18775 " const char *device);\n"
18781 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4294
18783 "This displays the partition table on C<device>, in the human-readable output "
18784 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18789 #: ../src/guestfs-actions.pod:6406
18790 msgid "See also: C<guestfs_part_list>"
18794 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4300
18796 "This function is deprecated. In new code, use the C<part_list> call instead."
18801 #: ../src/guestfs-actions.pod:6420
18807 #: ../src/guestfs-actions.pod:6422
18811 " guestfs_sh (guestfs_h *g,\n"
18812 " const char *command);\n"
18818 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4311
18820 "This call runs a command from the guest filesystem via the guest's C</bin/"
18826 #: ../src/guestfs-actions.pod:6429
18827 msgid "This is like C<guestfs_command>, but passes the command to:"
18832 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4316
18835 " /bin/sh -c \"command\"\n"
18841 #: ../src/guestfs-actions.pod:6433 ../fish/guestfish-actions.pod:4318
18843 "Depending on the guest's shell, this usually results in wildcards being "
18844 "expanded, shell expressions being interpolated and so on."
18849 #: ../src/guestfs-actions.pod:6437
18850 msgid "All the provisos about C<guestfs_command> apply to this call."
18855 #: ../src/guestfs-actions.pod:6444
18856 msgid "guestfs_sh_lines"
18861 #: ../src/guestfs-actions.pod:6446
18865 " guestfs_sh_lines (guestfs_h *g,\n"
18866 " const char *command);\n"
18872 #: ../src/guestfs-actions.pod:6450
18874 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18880 #: ../src/guestfs-actions.pod:6453
18881 msgid "See also: C<guestfs_command_lines>"
18886 #: ../src/guestfs-actions.pod:6461
18887 msgid "guestfs_sleep"
18892 #: ../src/guestfs-actions.pod:6463
18896 " guestfs_sleep (guestfs_h *g,\n"
18903 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4337
18904 msgid "Sleep for C<secs> seconds."
18909 #: ../src/guestfs-actions.pod:6471
18910 msgid "(Added in 1.0.41)"
18915 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-structs.pod:109
18916 msgid "guestfs_stat"
18921 #: ../src/guestfs-actions.pod:6475
18924 " struct guestfs_stat *\n"
18925 " guestfs_stat (guestfs_h *g,\n"
18926 " const char *path);\n"
18932 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4345
18933 msgid "This is the same as the C<stat(2)> system call."
18938 #: ../src/guestfs-actions.pod:6489 ../src/guestfs-structs.pod:135
18939 msgid "guestfs_statvfs"
18944 #: ../src/guestfs-actions.pod:6491
18947 " struct guestfs_statvfs *\n"
18948 " guestfs_statvfs (guestfs_h *g,\n"
18949 " const char *path);\n"
18955 #: ../src/guestfs-actions.pod:6495 ../fish/guestfish-actions.pod:4351
18957 "Returns file system statistics for any mounted file system. C<path> should "
18958 "be a file or directory in the mounted file system (typically it is the mount "
18959 "point itself, but it doesn't need to be)."
18964 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4355
18965 msgid "This is the same as the C<statvfs(2)> system call."
18970 #: ../src/guestfs-actions.pod:6501
18972 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18973 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18978 #: ../src/guestfs-actions.pod:6507
18979 msgid "guestfs_strings"
18984 #: ../src/guestfs-actions.pod:6509
18988 " guestfs_strings (guestfs_h *g,\n"
18989 " const char *path);\n"
18995 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4361
18997 "This runs the L<strings(1)> command on a file and returns the list of "
18998 "printable strings found."
19003 #: ../src/guestfs-actions.pod:6525
19004 msgid "guestfs_strings_e"
19009 #: ../src/guestfs-actions.pod:6527
19013 " guestfs_strings_e (guestfs_h *g,\n"
19014 " const char *encoding,\n"
19015 " const char *path);\n"
19021 #: ../src/guestfs-actions.pod:6532
19023 "This is like the C<guestfs_strings> command, but allows you to specify the "
19024 "encoding of strings that are looked for in the source file C<path>."
19029 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4375
19030 msgid "Allowed encodings are:"
19035 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4379
19041 #: ../src/guestfs-actions.pod:6542
19043 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
19044 "ISO-8859-X (this is what C<guestfs_strings> uses)."
19049 #: ../src/guestfs-actions.pod:6545 ../fish/guestfish-actions.pod:4384
19055 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4386
19056 msgid "Single 8-bit-byte characters."
19061 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4388
19067 #: ../src/guestfs-actions.pod:6551 ../fish/guestfish-actions.pod:4390
19068 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
19073 #: ../src/guestfs-actions.pod:6554 ../fish/guestfish-actions.pod:4393
19074 msgid "l (lower case letter L)"
19079 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4395
19081 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
19082 "examining binaries in Windows guests."
19087 #: ../src/guestfs-actions.pod:6559 ../fish/guestfish-actions.pod:4398
19093 #: ../src/guestfs-actions.pod:6561 ../fish/guestfish-actions.pod:4400
19094 msgid "32-bit big endian such as UCS-4BE."
19099 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4402
19105 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4404
19106 msgid "32-bit little endian such as UCS-4LE."
19111 #: ../src/guestfs-actions.pod:6569 ../fish/guestfish-actions.pod:4408
19112 msgid "The returned strings are transcoded to UTF-8."
19117 #: ../src/guestfs-actions.pod:6580
19118 msgid "guestfs_swapoff_device"
19123 #: ../src/guestfs-actions.pod:6582
19127 " guestfs_swapoff_device (guestfs_h *g,\n"
19128 " const char *device);\n"
19134 #: ../src/guestfs-actions.pod:6586
19136 "This command disables the libguestfs appliance swap device or partition "
19137 "named C<device>. See C<guestfs_swapon_device>."
19142 #: ../src/guestfs-actions.pod:6594
19143 msgid "guestfs_swapoff_file"
19148 #: ../src/guestfs-actions.pod:6596
19152 " guestfs_swapoff_file (guestfs_h *g,\n"
19153 " const char *file);\n"
19159 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4425
19160 msgid "This command disables the libguestfs appliance swap on file."
19165 #: ../src/guestfs-actions.pod:6606
19166 msgid "guestfs_swapoff_label"
19171 #: ../src/guestfs-actions.pod:6608
19175 " guestfs_swapoff_label (guestfs_h *g,\n"
19176 " const char *label);\n"
19182 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4431
19184 "This command disables the libguestfs appliance swap on labeled swap "
19190 #: ../src/guestfs-actions.pod:6619
19191 msgid "guestfs_swapoff_uuid"
19196 #: ../src/guestfs-actions.pod:6621
19200 " guestfs_swapoff_uuid (guestfs_h *g,\n"
19201 " const char *uuid);\n"
19207 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4438
19209 "This command disables the libguestfs appliance swap partition with the given "
19215 #: ../src/guestfs-actions.pod:6632
19216 msgid "guestfs_swapon_device"
19221 #: ../src/guestfs-actions.pod:6634
19225 " guestfs_swapon_device (guestfs_h *g,\n"
19226 " const char *device);\n"
19232 #: ../src/guestfs-actions.pod:6638
19234 "This command enables the libguestfs appliance to use the swap device or "
19235 "partition named C<device>. The increased memory is made available for all "
19236 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
19241 #: ../src/guestfs-actions.pod:6643 ../fish/guestfish-actions.pod:4450
19243 "Note that you should not swap to existing guest swap partitions unless you "
19244 "know what you are doing. They may contain hibernation information, or other "
19245 "information that the guest doesn't want you to trash. You also risk leaking "
19246 "information about the host to the guest this way. Instead, attach a new "
19247 "host device to the guest and swap on that."
19252 #: ../src/guestfs-actions.pod:6654
19253 msgid "guestfs_swapon_file"
19258 #: ../src/guestfs-actions.pod:6656
19262 " guestfs_swapon_file (guestfs_h *g,\n"
19263 " const char *file);\n"
19269 #: ../src/guestfs-actions.pod:6660
19271 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
19277 #: ../src/guestfs-actions.pod:6667
19278 msgid "guestfs_swapon_label"
19283 #: ../src/guestfs-actions.pod:6669
19287 " guestfs_swapon_label (guestfs_h *g,\n"
19288 " const char *label);\n"
19294 #: ../src/guestfs-actions.pod:6673
19296 "This command enables swap to a labeled swap partition. See "
19297 "C<guestfs_swapon_device> for other notes."
19302 #: ../src/guestfs-actions.pod:6680
19303 msgid "guestfs_swapon_uuid"
19308 #: ../src/guestfs-actions.pod:6682
19312 " guestfs_swapon_uuid (guestfs_h *g,\n"
19313 " const char *uuid);\n"
19319 #: ../src/guestfs-actions.pod:6686
19321 "This command enables swap to a swap partition with the given UUID. See "
19322 "C<guestfs_swapon_device> for other notes."
19327 #: ../src/guestfs-actions.pod:6693
19328 msgid "guestfs_sync"
19333 #: ../src/guestfs-actions.pod:6695
19337 " guestfs_sync (guestfs_h *g);\n"
19343 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4482
19345 "This syncs the disk, so that any writes are flushed through to the "
19346 "underlying disk image."
19351 #: ../src/guestfs-actions.pod:6701 ../fish/guestfish-actions.pod:4485
19353 "You should always call this if you have modified a disk image, before "
19354 "closing the handle."
19359 #: ../src/guestfs-actions.pod:6708
19360 msgid "guestfs_tail"
19365 #: ../src/guestfs-actions.pod:6710
19369 " guestfs_tail (guestfs_h *g,\n"
19370 " const char *path);\n"
19376 #: ../src/guestfs-actions.pod:6714 ../fish/guestfish-actions.pod:4492
19378 "This command returns up to the last 10 lines of a file as a list of strings."
19383 #: ../src/guestfs-actions.pod:6726
19384 msgid "guestfs_tail_n"
19389 #: ../src/guestfs-actions.pod:6728
19393 " guestfs_tail_n (guestfs_h *g,\n"
19395 " const char *path);\n"
19401 #: ../src/guestfs-actions.pod:6733 ../fish/guestfish-actions.pod:4502
19403 "If the parameter C<nrlines> is a positive number, this returns the last "
19404 "C<nrlines> lines of the file C<path>."
19409 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4505
19411 "If the parameter C<nrlines> is a negative number, this returns lines from "
19412 "the file C<path>, starting with the C<-nrlines>th line."
19417 #: ../src/guestfs-actions.pod:6750
19418 msgid "guestfs_tar_in"
19423 #: ../src/guestfs-actions.pod:6752
19427 " guestfs_tar_in (guestfs_h *g,\n"
19428 " const char *tarfile,\n"
19429 " const char *directory);\n"
19435 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4517
19437 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19438 "tar file) into C<directory>."
19443 #: ../src/guestfs-actions.pod:6760
19445 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19450 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6782
19451 #: ../src/guestfs-actions.pod:6798 ../src/guestfs-actions.pod:6814
19452 msgid "(Added in 1.0.3)"
19457 #: ../src/guestfs-actions.pod:6767
19458 msgid "guestfs_tar_out"
19463 #: ../src/guestfs-actions.pod:6769
19467 " guestfs_tar_out (guestfs_h *g,\n"
19468 " const char *directory,\n"
19469 " const char *tarfile);\n"
19475 #: ../src/guestfs-actions.pod:6774 ../fish/guestfish-actions.pod:4529
19477 "This command packs the contents of C<directory> and downloads it to local "
19483 #: ../src/guestfs-actions.pod:6777
19485 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19486 "C<guestfs_txz_out>."
19491 #: ../src/guestfs-actions.pod:6784
19492 msgid "guestfs_tgz_in"
19497 #: ../src/guestfs-actions.pod:6786
19501 " guestfs_tgz_in (guestfs_h *g,\n"
19502 " const char *tarball,\n"
19503 " const char *directory);\n"
19509 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4541
19511 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19512 "tar file) into C<directory>."
19517 #: ../src/guestfs-actions.pod:6794
19518 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19523 #: ../src/guestfs-actions.pod:6800
19524 msgid "guestfs_tgz_out"
19529 #: ../src/guestfs-actions.pod:6802
19533 " guestfs_tgz_out (guestfs_h *g,\n"
19534 " const char *directory,\n"
19535 " const char *tarball);\n"
19541 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4552
19543 "This command packs the contents of C<directory> and downloads it to local "
19549 #: ../src/guestfs-actions.pod:6810
19550 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19555 #: ../src/guestfs-actions.pod:6816
19556 msgid "guestfs_touch"
19561 #: ../src/guestfs-actions.pod:6818
19565 " guestfs_touch (guestfs_h *g,\n"
19566 " const char *path);\n"
19572 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4563
19574 "Touch acts like the L<touch(1)> command. It can be used to update the "
19575 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19581 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4567
19583 "This command only works on regular files, and will fail on other file types "
19584 "such as directories, symbolic links, block special etc."
19589 #: ../src/guestfs-actions.pod:6833
19590 msgid "guestfs_truncate"
19595 #: ../src/guestfs-actions.pod:6835
19599 " guestfs_truncate (guestfs_h *g,\n"
19600 " const char *path);\n"
19606 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4574
19608 "This command truncates C<path> to a zero-length file. The file must exist "
19614 #: ../src/guestfs-actions.pod:6846
19615 msgid "guestfs_truncate_size"
19620 #: ../src/guestfs-actions.pod:6848
19624 " guestfs_truncate_size (guestfs_h *g,\n"
19625 " const char *path,\n"
19626 " int64_t size);\n"
19632 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4581
19634 "This command truncates C<path> to size C<size> bytes. The file must exist "
19640 #: ../src/guestfs-actions.pod:6856
19642 "If the current file size is less than C<size> then the file is extended to "
19643 "the required size with zero bytes. This creates a sparse file (ie. disk "
19644 "blocks are not allocated for the file until you write to it). To create a "
19645 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19650 #: ../src/guestfs-actions.pod:6866
19651 msgid "guestfs_tune2fs_l"
19656 #: ../src/guestfs-actions.pod:6868
19660 " guestfs_tune2fs_l (guestfs_h *g,\n"
19661 " const char *device);\n"
19667 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4594
19669 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19675 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4597
19677 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19678 "for more details. The list of fields returned isn't clearly defined, and "
19679 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19680 "and the filesystem itself."
19685 #: ../src/guestfs-actions.pod:6888
19686 msgid "guestfs_txz_in"
19691 #: ../src/guestfs-actions.pod:6890
19695 " guestfs_txz_in (guestfs_h *g,\n"
19696 " const char *tarball,\n"
19697 " const char *directory);\n"
19703 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4606
19705 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19706 "tar file) into C<directory>."
19711 #: ../src/guestfs-actions.pod:6902
19712 msgid "guestfs_txz_out"
19717 #: ../src/guestfs-actions.pod:6904
19721 " guestfs_txz_out (guestfs_h *g,\n"
19722 " const char *directory,\n"
19723 " const char *tarball);\n"
19729 #: ../src/guestfs-actions.pod:6909 ../fish/guestfish-actions.pod:4615
19731 "This command packs the contents of C<directory> and downloads it to local "
19732 "file C<tarball> (as an xz compressed tar archive)."
19737 #: ../src/guestfs-actions.pod:6916
19738 msgid "guestfs_umask"
19743 #: ../src/guestfs-actions.pod:6918
19747 " guestfs_umask (guestfs_h *g,\n"
19754 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4624
19756 "This function sets the mask used for creating new files and device nodes to "
19762 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4627
19764 "Typical umask values would be C<022> which creates new files with "
19765 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19766 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19771 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4632
19773 "The default umask is C<022>. This is important because it means that "
19774 "directories and device nodes will be created with C<0644> or C<0755> mode "
19775 "even if you specify C<0777>."
19780 #: ../src/guestfs-actions.pod:6934
19782 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19783 "C<guestfs_mkdir>."
19788 #: ../src/guestfs-actions.pod:6937 ../fish/guestfish-actions.pod:4639
19789 msgid "This call returns the previous umask."
19794 #: ../src/guestfs-actions.pod:6943
19795 msgid "guestfs_umount"
19800 #: ../src/guestfs-actions.pod:6945
19804 " guestfs_umount (guestfs_h *g,\n"
19805 " const char *pathordevice);\n"
19811 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4647
19813 "This unmounts the given filesystem. The filesystem may be specified either "
19814 "by its mountpoint (path) or the device which contains the filesystem."
19819 #: ../src/guestfs-actions.pod:6957
19820 msgid "guestfs_umount_all"
19825 #: ../src/guestfs-actions.pod:6959
19829 " guestfs_umount_all (guestfs_h *g);\n"
19835 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4657
19836 msgid "This unmounts all mounted filesystems."
19841 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4659
19842 msgid "Some internal mounts are not unmounted by this call."
19847 #: ../src/guestfs-actions.pod:6970
19848 msgid "guestfs_upload"
19853 #: ../src/guestfs-actions.pod:6972
19857 " guestfs_upload (guestfs_h *g,\n"
19858 " const char *filename,\n"
19859 " const char *remotefilename);\n"
19865 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7001
19866 #: ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4678
19867 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19872 #: ../src/guestfs-actions.pod:6982
19873 msgid "See also C<guestfs_download>."
19878 #: ../src/guestfs-actions.pod:6993
19879 msgid "guestfs_upload_offset"
19884 #: ../src/guestfs-actions.pod:6995
19888 " guestfs_upload_offset (guestfs_h *g,\n"
19889 " const char *filename,\n"
19890 " const char *remotefilename,\n"
19891 " int64_t offset);\n"
19897 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4681
19899 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19900 "The intention is to overwrite parts of existing files or devices, although "
19901 "if a non-existant file is specified then it is created with a \"hole\" "
19902 "before C<offset>. The size of the data written is implicit in the size of "
19903 "the source C<filename>."
19908 #: ../src/guestfs-actions.pod:7011
19910 "Note that there is no limit on the amount of data that can be uploaded with "
19911 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19912 "full amount unless an error occurs."
19917 #: ../src/guestfs-actions.pod:7016
19918 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19923 #: ../src/guestfs-actions.pod:7027
19924 msgid "guestfs_utimens"
19929 #: ../src/guestfs-actions.pod:7029
19933 " guestfs_utimens (guestfs_h *g,\n"
19934 " const char *path,\n"
19935 " int64_t atsecs,\n"
19936 " int64_t atnsecs,\n"
19937 " int64_t mtsecs,\n"
19938 " int64_t mtnsecs);\n"
19944 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4701
19945 msgid "This command sets the timestamps of a file with nanosecond precision."
19950 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4704
19952 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19958 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4707
19960 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19961 "nanoseconds from the epoch."
19966 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4710
19968 "If the C<*nsecs> field contains the special value C<-1> then the "
19969 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19970 "ignored in this case)."
19975 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4714
19977 "If the C<*nsecs> field contains the special value C<-2> then the "
19978 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19984 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-structs.pod:175
19985 msgid "guestfs_version"
19990 #: ../src/guestfs-actions.pod:7060
19993 " struct guestfs_version *\n"
19994 " guestfs_version (guestfs_h *g);\n"
20000 #: ../src/guestfs-actions.pod:7063 ../fish/guestfish-actions.pod:4722
20002 "Return the libguestfs version number that the program is linked against."
20007 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4725
20009 "Note that because of dynamic linking this is not necessarily the version of "
20010 "libguestfs that you compiled against. You can compile the program, and then "
20011 "at runtime dynamically link against a completely different C<libguestfs.so> "
20017 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4730
20019 "This call was added in version C<1.0.58>. In previous versions of "
20020 "libguestfs there was no way to get the version number. From C code you can "
20021 "use dynamic linker functions to find out if this symbol exists (if it "
20022 "doesn't, then it's an earlier version)."
20027 #: ../src/guestfs-actions.pod:7077 ../fish/guestfish-actions.pod:4736
20029 "The call returns a structure with four elements. The first three (C<major>, "
20030 "C<minor> and C<release>) are numbers and correspond to the usual version "
20031 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
20032 "but may be used for distro-specific information."
20037 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4742
20039 "To construct the original version string: C<$major.$minor.$release$extra>"
20044 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4745
20045 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
20050 #: ../src/guestfs-actions.pod:7088
20052 "I<Note:> Don't use this call to test for availability of features. In "
20053 "enterprise distributions we backport features from later versions into "
20054 "earlier versions, making this an unreliable way to test for features. Use "
20055 "C<guestfs_available> instead."
20060 #: ../src/guestfs-actions.pod:7094
20062 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
20063 "error. I<The caller must call C<guestfs_free_version> after use>."
20068 #: ../src/guestfs-actions.pod:7098
20069 msgid "(Added in 1.0.58)"
20074 #: ../src/guestfs-actions.pod:7100
20075 msgid "guestfs_vfs_label"
20080 #: ../src/guestfs-actions.pod:7102
20084 " guestfs_vfs_label (guestfs_h *g,\n"
20085 " const char *device);\n"
20091 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4757
20092 msgid "This returns the filesystem label of the filesystem on C<device>."
20097 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4760
20098 msgid "If the filesystem is unlabeled, this returns the empty string."
20103 #: ../src/guestfs-actions.pod:7111
20104 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
20109 #: ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7153
20110 msgid "(Added in 1.3.18)"
20115 #: ../src/guestfs-actions.pod:7118
20116 msgid "guestfs_vfs_type"
20121 #: ../src/guestfs-actions.pod:7120
20125 " guestfs_vfs_type (guestfs_h *g,\n"
20126 " const char *device);\n"
20132 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4768
20134 "This command gets the filesystem type corresponding to the filesystem on "
20140 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4771
20142 "For most filesystems, the result is the name of the Linux VFS module which "
20143 "would be used to mount this filesystem if you mounted it without specifying "
20144 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
20149 #: ../src/guestfs-actions.pod:7137
20150 msgid "guestfs_vfs_uuid"
20155 #: ../src/guestfs-actions.pod:7139
20159 " guestfs_vfs_uuid (guestfs_h *g,\n"
20160 " const char *device);\n"
20166 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4780
20167 msgid "This returns the filesystem UUID of the filesystem on C<device>."
20172 #: ../src/guestfs-actions.pod:7146 ../fish/guestfish-actions.pod:4783
20173 msgid "If the filesystem does not have a UUID, this returns the empty string."
20178 #: ../src/guestfs-actions.pod:7148
20179 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
20184 #: ../src/guestfs-actions.pod:7155
20185 msgid "guestfs_vg_activate"
20190 #: ../src/guestfs-actions.pod:7157
20194 " guestfs_vg_activate (guestfs_h *g,\n"
20196 " char *const *volgroups);\n"
20202 #: ../src/guestfs-actions.pod:7162 ../fish/guestfish-actions.pod:4791
20204 "This command activates or (if C<activate> is false) deactivates all logical "
20205 "volumes in the listed volume groups C<volgroups>. If activated, then they "
20206 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
20207 "deactivated, then those devices disappear."
20212 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4797
20213 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
20218 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4799
20220 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
20221 "activated or deactivated."
20226 #: ../src/guestfs-actions.pod:7177
20227 msgid "guestfs_vg_activate_all"
20232 #: ../src/guestfs-actions.pod:7179
20236 " guestfs_vg_activate_all (guestfs_h *g,\n"
20237 " int activate);\n"
20243 #: ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:4806
20245 "This command activates or (if C<activate> is false) deactivates all logical "
20246 "volumes in all volume groups. If activated, then they are made known to the "
20247 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
20248 "those devices disappear."
20253 #: ../src/guestfs-actions.pod:7189 ../fish/guestfish-actions.pod:4812
20254 msgid "This command is the same as running C<vgchange -a y|n>"
20259 #: ../src/guestfs-actions.pod:7195
20260 msgid "guestfs_vgcreate"
20265 #: ../src/guestfs-actions.pod:7197
20269 " guestfs_vgcreate (guestfs_h *g,\n"
20270 " const char *volgroup,\n"
20271 " char *const *physvols);\n"
20277 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4818
20279 "This creates an LVM volume group called C<volgroup> from the non-empty list "
20280 "of physical volumes C<physvols>."
20285 #: ../src/guestfs-actions.pod:7209
20286 msgid "guestfs_vglvuuids"
20291 #: ../src/guestfs-actions.pod:7211
20295 " guestfs_vglvuuids (guestfs_h *g,\n"
20296 " const char *vgname);\n"
20302 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4825
20304 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20305 "volumes created in this volume group."
20310 #: ../src/guestfs-actions.pod:7218
20312 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20313 "associate logical volumes and volume groups."
20318 #: ../src/guestfs-actions.pod:7221
20319 msgid "See also C<guestfs_vgpvuuids>."
20324 #: ../src/guestfs-actions.pod:7229
20325 msgid "guestfs_vgpvuuids"
20330 #: ../src/guestfs-actions.pod:7231
20334 " guestfs_vgpvuuids (guestfs_h *g,\n"
20335 " const char *vgname);\n"
20341 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4837
20343 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20344 "volumes that this volume group resides on."
20349 #: ../src/guestfs-actions.pod:7238
20351 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20352 "associate physical volumes and volume groups."
20357 #: ../src/guestfs-actions.pod:7241
20358 msgid "See also C<guestfs_vglvuuids>."
20363 #: ../src/guestfs-actions.pod:7249
20364 msgid "guestfs_vgremove"
20369 #: ../src/guestfs-actions.pod:7251
20373 " guestfs_vgremove (guestfs_h *g,\n"
20374 " const char *vgname);\n"
20380 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
20381 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20386 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4851
20388 "This also forcibly removes all logical volumes in the volume group (if any)."
20393 #: ../src/guestfs-actions.pod:7264
20394 msgid "guestfs_vgrename"
20399 #: ../src/guestfs-actions.pod:7266
20403 " guestfs_vgrename (guestfs_h *g,\n"
20404 " const char *volgroup,\n"
20405 " const char *newvolgroup);\n"
20411 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4858
20412 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20417 #: ../src/guestfs-actions.pod:7277
20418 msgid "guestfs_vgs"
20423 #: ../src/guestfs-actions.pod:7279
20427 " guestfs_vgs (guestfs_h *g);\n"
20433 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4864
20435 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20441 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4867
20443 "This returns a list of just the volume group names that were detected (eg. "
20449 #: ../src/guestfs-actions.pod:7288
20450 msgid "See also C<guestfs_vgs_full>."
20455 #: ../src/guestfs-actions.pod:7296
20456 msgid "guestfs_vgs_full"
20461 #: ../src/guestfs-actions.pod:7298
20464 " struct guestfs_lvm_vg_list *\n"
20465 " guestfs_vgs_full (guestfs_h *g);\n"
20471 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4876
20473 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20474 "> command. The \"full\" version includes all fields."
20479 #: ../src/guestfs-actions.pod:7304
20481 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20482 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20487 #: ../src/guestfs-actions.pod:7310
20488 msgid "guestfs_vgscan"
20493 #: ../src/guestfs-actions.pod:7312
20497 " guestfs_vgscan (guestfs_h *g);\n"
20503 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:4883
20505 "This rescans all block devices and rebuilds the list of LVM physical "
20506 "volumes, volume groups and logical volumes."
20511 #: ../src/guestfs-actions.pod:7322
20512 msgid "guestfs_vguuid"
20517 #: ../src/guestfs-actions.pod:7324
20521 " guestfs_vguuid (guestfs_h *g,\n"
20522 " const char *vgname);\n"
20528 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4890
20529 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20534 #: ../src/guestfs-actions.pod:7335
20535 msgid "guestfs_wait_ready"
20540 #: ../src/guestfs-actions.pod:7337
20544 " guestfs_wait_ready (guestfs_h *g);\n"
20550 #: ../src/guestfs-actions.pod:7340
20551 msgid "This function is a no op."
20556 #: ../src/guestfs-actions.pod:7342
20558 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20559 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20560 "is no longer necessary because C<guestfs_launch> now does the waiting."
20565 #: ../src/guestfs-actions.pod:7347
20567 "If you see any calls to this function in code then you can just remove them, "
20568 "unless you want to retain compatibility with older versions of the API."
20572 #: ../src/guestfs-actions.pod:7353
20574 "This function is deprecated. In new code, use the C<launch> call instead."
20579 #: ../src/guestfs-actions.pod:7362
20580 msgid "guestfs_wc_c"
20585 #: ../src/guestfs-actions.pod:7364
20589 " guestfs_wc_c (guestfs_h *g,\n"
20590 " const char *path);\n"
20596 #: ../src/guestfs-actions.pod:7368 ../fish/guestfish-actions.pod:4896
20598 "This command counts the characters in a file, using the C<wc -c> external "
20604 #: ../src/guestfs-actions.pod:7375
20605 msgid "guestfs_wc_l"
20610 #: ../src/guestfs-actions.pod:7377
20614 " guestfs_wc_l (guestfs_h *g,\n"
20615 " const char *path);\n"
20621 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4903
20623 "This command counts the lines in a file, using the C<wc -l> external command."
20628 #: ../src/guestfs-actions.pod:7388
20629 msgid "guestfs_wc_w"
20634 #: ../src/guestfs-actions.pod:7390
20638 " guestfs_wc_w (guestfs_h *g,\n"
20639 " const char *path);\n"
20645 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4910
20647 "This command counts the words in a file, using the C<wc -w> external command."
20652 #: ../src/guestfs-actions.pod:7401
20653 msgid "guestfs_write"
20658 #: ../src/guestfs-actions.pod:7403
20662 " guestfs_write (guestfs_h *g,\n"
20663 " const char *path,\n"
20664 " const char *content,\n"
20665 " size_t content_size);\n"
20671 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4917
20673 "This call creates a file called C<path>. The content of the file is the "
20674 "string C<content> (which can contain any 8 bit data)."
20679 #: ../src/guestfs-actions.pod:7419
20680 msgid "guestfs_write_file"
20685 #: ../src/guestfs-actions.pod:7421
20689 " guestfs_write_file (guestfs_h *g,\n"
20690 " const char *path,\n"
20691 " const char *content,\n"
20698 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4927
20700 "This call creates a file called C<path>. The contents of the file is the "
20701 "string C<content> (which can contain any 8 bit data), with length C<size>."
20706 #: ../src/guestfs-actions.pod:7431 ../fish/guestfish-actions.pod:4931
20708 "As a special case, if C<size> is C<0> then the length is calculated using "
20709 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20714 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4935
20716 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20717 "I<not> work, even if the length is specified."
20722 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4941
20724 "This function is deprecated. In new code, use the C<write> call instead."
20729 #: ../src/guestfs-actions.pod:7452
20730 msgid "guestfs_zegrep"
20735 #: ../src/guestfs-actions.pod:7454
20739 " guestfs_zegrep (guestfs_h *g,\n"
20740 " const char *regex,\n"
20741 " const char *path);\n"
20747 #: ../src/guestfs-actions.pod:7459 ../fish/guestfish-actions.pod:4952
20749 "This calls the external C<zegrep> program and returns the matching lines."
20754 #: ../src/guestfs-actions.pod:7471
20755 msgid "guestfs_zegrepi"
20760 #: ../src/guestfs-actions.pod:7473
20764 " guestfs_zegrepi (guestfs_h *g,\n"
20765 " const char *regex,\n"
20766 " const char *path);\n"
20772 #: ../src/guestfs-actions.pod:7478 ../fish/guestfish-actions.pod:4962
20774 "This calls the external C<zegrep -i> program and returns the matching lines."
20779 #: ../src/guestfs-actions.pod:7490
20780 msgid "guestfs_zero"
20785 #: ../src/guestfs-actions.pod:7492
20789 " guestfs_zero (guestfs_h *g,\n"
20790 " const char *device);\n"
20796 #: ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:4972
20797 msgid "This command writes zeroes over the first few blocks of C<device>."
20802 #: ../src/guestfs-actions.pod:7498 ../fish/guestfish-actions.pod:4974
20804 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20805 "securely wipe the device). It should be sufficient to remove any partition "
20806 "tables, filesystem superblocks and so on."
20810 #: ../src/guestfs-actions.pod:7502
20812 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
20813 "C<guestfs_is_zero_device>"
20818 #: ../src/guestfs-actions.pod:7514
20819 msgid "guestfs_zero_device"
20824 #: ../src/guestfs-actions.pod:7516
20828 " guestfs_zero_device (guestfs_h *g,\n"
20829 " const char *device);\n"
20835 #: ../src/guestfs-actions.pod:7520
20837 "This command writes zeroes over the entire C<device>. Compare with "
20838 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20843 #: ../src/guestfs-actions.pod:7534
20844 msgid "(Added in 1.3.1)"
20849 #: ../src/guestfs-actions.pod:7536
20850 msgid "guestfs_zerofree"
20855 #: ../src/guestfs-actions.pod:7538
20859 " guestfs_zerofree (guestfs_h *g,\n"
20860 " const char *device);\n"
20866 #: ../src/guestfs-actions.pod:7542 ../fish/guestfish-actions.pod:4996
20868 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20869 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20870 "possible to compress the filesystem more effectively."
20875 #: ../src/guestfs-actions.pod:7547 ../fish/guestfish-actions.pod:5001
20876 msgid "You should B<not> run this program if the filesystem is mounted."
20881 #: ../src/guestfs-actions.pod:7550 ../fish/guestfish-actions.pod:5004
20883 "It is possible that using this program can damage the filesystem or data on "
20889 #: ../src/guestfs-actions.pod:7557
20890 msgid "guestfs_zfgrep"
20895 #: ../src/guestfs-actions.pod:7559
20899 " guestfs_zfgrep (guestfs_h *g,\n"
20900 " const char *pattern,\n"
20901 " const char *path);\n"
20907 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5011
20909 "This calls the external C<zfgrep> program and returns the matching lines."
20914 #: ../src/guestfs-actions.pod:7576
20915 msgid "guestfs_zfgrepi"
20920 #: ../src/guestfs-actions.pod:7578
20924 " guestfs_zfgrepi (guestfs_h *g,\n"
20925 " const char *pattern,\n"
20926 " const char *path);\n"
20932 #: ../src/guestfs-actions.pod:7583 ../fish/guestfish-actions.pod:5021
20934 "This calls the external C<zfgrep -i> program and returns the matching lines."
20939 #: ../src/guestfs-actions.pod:7595
20940 msgid "guestfs_zfile"
20945 #: ../src/guestfs-actions.pod:7597
20949 " guestfs_zfile (guestfs_h *g,\n"
20950 " const char *meth,\n"
20951 " const char *path);\n"
20957 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5031
20959 "This command runs C<file> after first decompressing C<path> using C<method>."
20964 #: ../src/guestfs-actions.pod:7605 ../fish/guestfish-actions.pod:5034
20965 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20970 #: ../src/guestfs-actions.pod:7607
20972 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20978 #: ../src/guestfs-actions.pod:7613 ../fish/guestfish-actions.pod:5039
20980 "This function is deprecated. In new code, use the C<file> call instead."
20985 #: ../src/guestfs-actions.pod:7622
20986 msgid "guestfs_zgrep"
20991 #: ../src/guestfs-actions.pod:7624
20995 " guestfs_zgrep (guestfs_h *g,\n"
20996 " const char *regex,\n"
20997 " const char *path);\n"
21003 #: ../src/guestfs-actions.pod:7629 ../fish/guestfish-actions.pod:5050
21005 "This calls the external C<zgrep> program and returns the matching lines."
21010 #: ../src/guestfs-actions.pod:7641
21011 msgid "guestfs_zgrepi"
21016 #: ../src/guestfs-actions.pod:7643
21020 " guestfs_zgrepi (guestfs_h *g,\n"
21021 " const char *regex,\n"
21022 " const char *path);\n"
21028 #: ../src/guestfs-actions.pod:7648 ../fish/guestfish-actions.pod:5060
21030 "This calls the external C<zgrep -i> program and returns the matching lines."
21035 #: ../src/guestfs-availability.pod:3
21041 #: ../src/guestfs-availability.pod:5
21043 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
21044 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
21045 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
21046 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
21047 "L</guestfs_aug_save> L</guestfs_aug_set>"
21052 #: ../src/guestfs-availability.pod:21
21058 #: ../src/guestfs-availability.pod:23
21060 "The following functions: L</guestfs_inotify_add_watch> L</"
21061 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
21062 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
21067 #: ../src/guestfs-availability.pod:31
21068 msgid "B<linuxfsuuid>"
21073 #: ../src/guestfs-availability.pod:33
21075 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
21076 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
21081 #: ../src/guestfs-availability.pod:40
21082 msgid "B<linuxmodules>"
21087 #: ../src/guestfs-availability.pod:42
21088 msgid "The following functions: L</guestfs_modprobe>"
21093 #: ../src/guestfs-availability.pod:45
21094 msgid "B<linuxxattrs>"
21099 #: ../src/guestfs-availability.pod:47
21101 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
21102 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
21103 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
21104 "guestfs_setxattr>"
21109 #: ../src/guestfs-availability.pod:58
21115 #: ../src/guestfs-availability.pod:60
21117 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
21118 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
21119 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
21124 #: ../src/guestfs-availability.pod:69
21130 #: ../src/guestfs-availability.pod:71
21132 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
21133 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
21134 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
21135 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
21136 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
21137 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
21138 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
21143 #: ../src/guestfs-availability.pod:94
21149 #: ../src/guestfs-availability.pod:96
21151 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
21152 "guestfs_mknod_b> L</guestfs_mknod_c>"
21157 #: ../src/guestfs-availability.pod:102
21163 #: ../src/guestfs-availability.pod:104
21164 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
21169 #: ../src/guestfs-availability.pod:107
21170 msgid "B<ntfsprogs>"
21175 #: ../src/guestfs-availability.pod:109
21177 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
21182 #: ../src/guestfs-availability.pod:113
21183 msgid "B<realpath>"
21188 #: ../src/guestfs-availability.pod:115
21189 msgid "The following functions: L</guestfs_realpath>"
21194 #: ../src/guestfs-availability.pod:118
21200 #: ../src/guestfs-availability.pod:120
21202 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
21203 "guestfs_scrub_freespace>"
21208 #: ../src/guestfs-availability.pod:125
21214 #: ../src/guestfs-availability.pod:127
21215 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
21220 #: ../src/guestfs-availability.pod:131
21226 #: ../src/guestfs-availability.pod:133
21227 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
21232 #: ../src/guestfs-availability.pod:137
21233 msgid "B<zerofree>"
21238 #: ../src/guestfs-availability.pod:139
21239 msgid "The following functions: L</guestfs_zerofree>"
21244 #: ../src/guestfs-structs.pod:1
21245 msgid "guestfs_int_bool"
21250 #: ../src/guestfs-structs.pod:3
21253 " struct guestfs_int_bool {\n"
21262 #: ../src/guestfs-structs.pod:8
21265 " struct guestfs_int_bool_list {\n"
21266 " uint32_t len; /* Number of elements in list. */\n"
21267 " struct guestfs_int_bool *val; /* Elements. */\n"
21274 #: ../src/guestfs-structs.pod:13
21277 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
21278 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
21284 #: ../src/guestfs-structs.pod:16
21285 msgid "guestfs_lvm_pv"
21290 #: ../src/guestfs-structs.pod:18
21293 " struct guestfs_lvm_pv {\n"
21294 " char *pv_name;\n"
21295 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21296 " char pv_uuid[32];\n"
21298 " uint64_t pv_size;\n"
21299 " uint64_t dev_size;\n"
21300 " uint64_t pv_free;\n"
21301 " uint64_t pv_used;\n"
21302 " char *pv_attr;\n"
21303 " int64_t pv_pe_count;\n"
21304 " int64_t pv_pe_alloc_count;\n"
21305 " char *pv_tags;\n"
21306 " uint64_t pe_start;\n"
21307 " int64_t pv_mda_count;\n"
21308 " uint64_t pv_mda_free;\n"
21315 #: ../src/guestfs-structs.pod:36
21318 " struct guestfs_lvm_pv_list {\n"
21319 " uint32_t len; /* Number of elements in list. */\n"
21320 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21327 #: ../src/guestfs-structs.pod:41
21330 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21331 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21337 #: ../src/guestfs-structs.pod:44
21338 msgid "guestfs_lvm_vg"
21343 #: ../src/guestfs-structs.pod:46
21346 " struct guestfs_lvm_vg {\n"
21347 " char *vg_name;\n"
21348 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21349 " char vg_uuid[32];\n"
21351 " char *vg_attr;\n"
21352 " uint64_t vg_size;\n"
21353 " uint64_t vg_free;\n"
21354 " char *vg_sysid;\n"
21355 " uint64_t vg_extent_size;\n"
21356 " int64_t vg_extent_count;\n"
21357 " int64_t vg_free_count;\n"
21358 " int64_t max_lv;\n"
21359 " int64_t max_pv;\n"
21360 " int64_t pv_count;\n"
21361 " int64_t lv_count;\n"
21362 " int64_t snap_count;\n"
21363 " int64_t vg_seqno;\n"
21364 " char *vg_tags;\n"
21365 " int64_t vg_mda_count;\n"
21366 " uint64_t vg_mda_free;\n"
21373 #: ../src/guestfs-structs.pod:69
21376 " struct guestfs_lvm_vg_list {\n"
21377 " uint32_t len; /* Number of elements in list. */\n"
21378 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21385 #: ../src/guestfs-structs.pod:74
21388 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21389 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21395 #: ../src/guestfs-structs.pod:77
21396 msgid "guestfs_lvm_lv"
21401 #: ../src/guestfs-structs.pod:79
21404 " struct guestfs_lvm_lv {\n"
21405 " char *lv_name;\n"
21406 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21407 " char lv_uuid[32];\n"
21408 " char *lv_attr;\n"
21409 " int64_t lv_major;\n"
21410 " int64_t lv_minor;\n"
21411 " int64_t lv_kernel_major;\n"
21412 " int64_t lv_kernel_minor;\n"
21413 " uint64_t lv_size;\n"
21414 " int64_t seg_count;\n"
21416 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21417 " float snap_percent;\n"
21418 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21419 " float copy_percent;\n"
21420 " char *move_pv;\n"
21421 " char *lv_tags;\n"
21422 " char *mirror_log;\n"
21423 " char *modules;\n"
21430 #: ../src/guestfs-structs.pod:101
21433 " struct guestfs_lvm_lv_list {\n"
21434 " uint32_t len; /* Number of elements in list. */\n"
21435 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21442 #: ../src/guestfs-structs.pod:106
21445 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21446 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21452 #: ../src/guestfs-structs.pod:111
21455 " struct guestfs_stat {\n"
21459 " int64_t nlink;\n"
21464 " int64_t blksize;\n"
21465 " int64_t blocks;\n"
21466 " int64_t atime;\n"
21467 " int64_t mtime;\n"
21468 " int64_t ctime;\n"
21475 #: ../src/guestfs-structs.pod:127
21478 " struct guestfs_stat_list {\n"
21479 " uint32_t len; /* Number of elements in list. */\n"
21480 " struct guestfs_stat *val; /* Elements. */\n"
21487 #: ../src/guestfs-structs.pod:132
21490 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21491 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21497 #: ../src/guestfs-structs.pod:137
21500 " struct guestfs_statvfs {\n"
21501 " int64_t bsize;\n"
21502 " int64_t frsize;\n"
21503 " int64_t blocks;\n"
21504 " int64_t bfree;\n"
21505 " int64_t bavail;\n"
21506 " int64_t files;\n"
21507 " int64_t ffree;\n"
21508 " int64_t favail;\n"
21511 " int64_t namemax;\n"
21518 #: ../src/guestfs-structs.pod:151
21521 " struct guestfs_statvfs_list {\n"
21522 " uint32_t len; /* Number of elements in list. */\n"
21523 " struct guestfs_statvfs *val; /* Elements. */\n"
21530 #: ../src/guestfs-structs.pod:156
21533 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21534 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21540 #: ../src/guestfs-structs.pod:159
21541 msgid "guestfs_dirent"
21546 #: ../src/guestfs-structs.pod:161
21549 " struct guestfs_dirent {\n"
21559 #: ../src/guestfs-structs.pod:167
21562 " struct guestfs_dirent_list {\n"
21563 " uint32_t len; /* Number of elements in list. */\n"
21564 " struct guestfs_dirent *val; /* Elements. */\n"
21571 #: ../src/guestfs-structs.pod:172
21574 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21575 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21581 #: ../src/guestfs-structs.pod:177
21584 " struct guestfs_version {\n"
21585 " int64_t major;\n"
21586 " int64_t minor;\n"
21587 " int64_t release;\n"
21595 #: ../src/guestfs-structs.pod:184
21598 " struct guestfs_version_list {\n"
21599 " uint32_t len; /* Number of elements in list. */\n"
21600 " struct guestfs_version *val; /* Elements. */\n"
21607 #: ../src/guestfs-structs.pod:189
21610 " void guestfs_free_version (struct guestfs_free_version *);\n"
21611 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21617 #: ../src/guestfs-structs.pod:192
21618 msgid "guestfs_xattr"
21623 #: ../src/guestfs-structs.pod:194
21626 " struct guestfs_xattr {\n"
21627 " char *attrname;\n"
21628 " /* The next two fields describe a byte array. */\n"
21629 " uint32_t attrval_len;\n"
21630 " char *attrval;\n"
21637 #: ../src/guestfs-structs.pod:201
21640 " struct guestfs_xattr_list {\n"
21641 " uint32_t len; /* Number of elements in list. */\n"
21642 " struct guestfs_xattr *val; /* Elements. */\n"
21649 #: ../src/guestfs-structs.pod:206
21652 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21653 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21659 #: ../src/guestfs-structs.pod:209
21660 msgid "guestfs_inotify_event"
21665 #: ../src/guestfs-structs.pod:211
21668 " struct guestfs_inotify_event {\n"
21669 " int64_t in_wd;\n"
21670 " uint32_t in_mask;\n"
21671 " uint32_t in_cookie;\n"
21672 " char *in_name;\n"
21679 #: ../src/guestfs-structs.pod:218
21682 " struct guestfs_inotify_event_list {\n"
21683 " uint32_t len; /* Number of elements in list. */\n"
21684 " struct guestfs_inotify_event *val; /* Elements. */\n"
21691 #: ../src/guestfs-structs.pod:223
21694 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21695 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21701 #: ../src/guestfs-structs.pod:226
21702 msgid "guestfs_partition"
21707 #: ../src/guestfs-structs.pod:228
21710 " struct guestfs_partition {\n"
21711 " int32_t part_num;\n"
21712 " uint64_t part_start;\n"
21713 " uint64_t part_end;\n"
21714 " uint64_t part_size;\n"
21721 #: ../src/guestfs-structs.pod:235
21724 " struct guestfs_partition_list {\n"
21725 " uint32_t len; /* Number of elements in list. */\n"
21726 " struct guestfs_partition *val; /* Elements. */\n"
21733 #: ../src/guestfs-structs.pod:240
21736 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21737 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21743 #: ../src/guestfs-structs.pod:243
21744 msgid "guestfs_application"
21749 #: ../src/guestfs-structs.pod:245
21752 " struct guestfs_application {\n"
21753 " char *app_name;\n"
21754 " char *app_display_name;\n"
21755 " int32_t app_epoch;\n"
21756 " char *app_version;\n"
21757 " char *app_release;\n"
21758 " char *app_install_path;\n"
21759 " char *app_trans_path;\n"
21760 " char *app_publisher;\n"
21761 " char *app_url;\n"
21762 " char *app_source_package;\n"
21763 " char *app_summary;\n"
21764 " char *app_description;\n"
21771 #: ../src/guestfs-structs.pod:260
21774 " struct guestfs_application_list {\n"
21775 " uint32_t len; /* Number of elements in list. */\n"
21776 " struct guestfs_application *val; /* Elements. */\n"
21783 #: ../src/guestfs-structs.pod:265
21786 " void guestfs_free_application (struct guestfs_free_application *);\n"
21787 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21793 #: ../fish/guestfish.pod:5
21794 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21799 #: ../fish/guestfish.pod:9
21802 " guestfish [--options] [commands]\n"
21808 #: ../fish/guestfish.pod:11
21817 #: ../fish/guestfish.pod:13
21820 " guestfish [--ro|--rw] -a disk.img\n"
21826 #: ../fish/guestfish.pod:15
21829 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21835 #: ../fish/guestfish.pod:17
21838 " guestfish -d libvirt-domain\n"
21844 #: ../fish/guestfish.pod:19
21847 " guestfish [--ro|--rw] -a disk.img -i\n"
21853 #: ../fish/guestfish.pod:21
21856 " guestfish -d libvirt-domain -i\n"
21862 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
21863 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21869 #: ../fish/guestfish.pod:25
21871 "Using guestfish in read/write mode on live virtual machines can be "
21872 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21873 "option to use guestfish safely if the disk image or virtual machine might be "
21879 #: ../fish/guestfish.pod:32
21881 "Guestfish is a shell and command-line tool for examining and modifying "
21882 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21883 "functionality of the guestfs API, see L<guestfs(3)>."
21888 #: ../fish/guestfish.pod:36
21890 "Guestfish gives you structured access to the libguestfs API, from shell "
21891 "scripts or the command line or interactively. If you want to rescue a "
21892 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21898 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
21899 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
21905 #: ../fish/guestfish.pod:43
21906 msgid "As an interactive shell"
21911 #: ../fish/guestfish.pod:45
21920 #: ../fish/guestfish.pod:47
21923 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21924 " editing virtual machine filesystems.\n"
21930 #: ../fish/guestfish.pod:50
21933 " Type: 'help' for a list of commands\n"
21934 " 'man' to read the manual\n"
21935 " 'quit' to quit the shell\n"
21941 #: ../fish/guestfish.pod:54
21944 " ><fs> add-ro disk.img\n"
21946 " ><fs> list-filesystems\n"
21947 " /dev/sda1: ext4\n"
21948 " /dev/vg_guest/lv_root: ext4\n"
21949 " /dev/vg_guest/lv_swap: swap\n"
21950 " ><fs> mount /dev/vg_guest/lv_root /\n"
21951 " ><fs> cat /etc/fstab\n"
21953 " # Created by anaconda\n"
21961 #: ../fish/guestfish.pod:67
21962 msgid "From shell scripts"
21967 #: ../fish/guestfish.pod:69
21968 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21973 #: ../fish/guestfish.pod:71
21976 " guestfish <<_EOF_\n"
21979 " mount /dev/vg_guest/lv_root /\n"
21980 " write /etc/motd \"Welcome, new users\"\n"
21987 #: ../fish/guestfish.pod:78
21988 msgid "List the LVM logical volumes in a disk image:"
21993 #: ../fish/guestfish.pod:80
21996 " guestfish -a disk.img --ro <<_EOF_\n"
22005 #: ../fish/guestfish.pod:85
22006 msgid "List all the filesystems in a disk image:"
22011 #: ../fish/guestfish.pod:87
22014 " guestfish -a disk.img --ro <<_EOF_\n"
22016 " list-filesystems\n"
22023 #: ../fish/guestfish.pod:92
22024 msgid "On one command line"
22029 #: ../fish/guestfish.pod:94
22030 msgid "Update C</etc/resolv.conf> in a guest:"
22035 #: ../fish/guestfish.pod:96
22039 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
22040 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
22046 #: ../fish/guestfish.pod:100
22047 msgid "Edit C</boot/grub/grub.conf> interactively:"
22052 #: ../fish/guestfish.pod:102
22055 " guestfish --rw --add disk.img \\\n"
22056 " --mount /dev/vg_guest/lv_root \\\n"
22057 " --mount /dev/sda1:/boot \\\n"
22058 " edit /boot/grub/grub.conf\n"
22064 #: ../fish/guestfish.pod:107
22065 msgid "Mount disks automatically"
22070 #: ../fish/guestfish.pod:109
22072 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
22077 #: ../fish/guestfish.pod:112
22080 " guestfish --ro -a disk.img -i cat /etc/group\n"
22086 #: ../fish/guestfish.pod:114
22089 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
22095 #: ../fish/guestfish.pod:116
22096 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
22101 #: ../fish/guestfish.pod:118
22104 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
22110 #: ../fish/guestfish.pod:120
22111 msgid "As a script interpreter"
22116 #: ../fish/guestfish.pod:122
22117 msgid "Create a 100MB disk containing an ext2-formatted partition:"
22122 #: ../fish/guestfish.pod:124
22125 " #!/usr/bin/guestfish -f\n"
22126 " sparse test1.img 100M\n"
22128 " part-disk /dev/sda mbr\n"
22129 " mkfs ext2 /dev/sda1\n"
22135 #: ../fish/guestfish.pod:130
22136 msgid "Start with a prepared disk"
22141 #: ../fish/guestfish.pod:132
22143 "An alternate way to create a 100MB disk called C<test1.img> containing a "
22144 "single ext2-formatted partition:"
22149 #: ../fish/guestfish.pod:135
22152 " guestfish -N fs\n"
22158 #: ../fish/guestfish.pod:137
22159 msgid "To list what is available do:"
22164 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
22167 " guestfish -N help | less\n"
22173 #: ../fish/guestfish.pod:141
22174 msgid "Remote control"
22179 #: ../fish/guestfish.pod:143
22182 " eval \"`guestfish --listen`\"\n"
22183 " guestfish --remote add-ro disk.img\n"
22184 " guestfish --remote run\n"
22185 " guestfish --remote lvs\n"
22191 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
22192 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
22193 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
22194 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
22200 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
22201 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
22202 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
22203 #: ../tools/virt-list-partitions.pl:62
22209 #: ../fish/guestfish.pod:154
22210 msgid "Displays general help on options."
22215 #: ../fish/guestfish.pod:156
22221 #: ../fish/guestfish.pod:158
22222 msgid "B<--cmd-help>"
22227 #: ../fish/guestfish.pod:160
22228 msgid "Lists all available guestfish commands."
22233 #: ../fish/guestfish.pod:162
22239 #: ../fish/guestfish.pod:164
22240 msgid "B<--cmd-help cmd>"
22245 #: ../fish/guestfish.pod:166
22246 msgid "Displays detailed help on a single command C<cmd>."
22251 #: ../fish/guestfish.pod:168
22252 msgid "B<-a image>"
22257 #: ../fish/guestfish.pod:170
22258 msgid "B<--add image>"
22263 #: ../fish/guestfish.pod:172
22264 msgid "Add a block device or virtual machine image to the shell."
22269 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
22271 "The format of the disk image is auto-detected. To override this and force a "
22272 "particular format use the I<--format=..> option."
22276 #: ../fish/guestfish.pod:177
22278 "Using this flag is mostly equivalent to using the C<add> command, with "
22279 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
22280 "the I<--format=...> flag was given."
22285 #: ../fish/guestfish.pod:181
22291 #: ../fish/guestfish.pod:183
22292 msgid "B<--connect URI>"
22297 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22299 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22300 "URI to use. The default is to use the default libvirt connection."
22305 #: ../fish/guestfish.pod:189
22311 #: ../fish/guestfish.pod:191
22313 "If using the I<--listen> option and a csh-like shell, use this option. See "
22314 "section L</REMOTE CONTROL AND CSH> below."
22319 #: ../fish/guestfish.pod:194
22320 msgid "B<-d libvirt-domain>"
22325 #: ../fish/guestfish.pod:196
22326 msgid "B<--domain libvirt-domain>"
22331 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22333 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22334 "used, then any libvirt domain can be used. However in write mode, only "
22335 "libvirt domains which are shut down can be named here."
22339 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
22340 msgid "Domain UUIDs can be used instead of names."
22345 #: ../fish/guestfish.pod:204
22347 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22348 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22349 "if the I<--format:...> flag was given."
22354 #: ../fish/guestfish.pod:208
22360 #: ../fish/guestfish.pod:210
22361 msgid "B<--no-dest-paths>"
22366 #: ../fish/guestfish.pod:212
22368 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22369 "to hit the tab key to complete paths on the guest filesystem, but this "
22370 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22371 "allow this feature to be disabled."
22376 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22377 msgid "B<--echo-keys>"
22382 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
22384 "When prompting for keys and passphrases, guestfish normally turns echoing "
22385 "off so you cannot see what you are typing. If you are not worried about "
22386 "Tempest attacks and there is no one else in the room you can specify this "
22387 "flag to see what you are typing."
22392 #: ../fish/guestfish.pod:224
22398 #: ../fish/guestfish.pod:226
22399 msgid "B<--file file>"
22404 #: ../fish/guestfish.pod:228
22405 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22410 #: ../fish/guestfish.pod:231
22413 " #!/usr/bin/guestfish -f\n"
22419 #: ../fish/guestfish.pod:233
22420 msgid "B<--format=raw|qcow2|..>"
22425 #: ../fish/guestfish.pod:235
22426 msgid "B<--format>"
22431 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
22433 "The default for the I<-a> option is to auto-detect the format of the disk "
22434 "image. Using this forces the disk format for I<-a> options which follow on "
22435 "the command line. Using I<--format> with no argument switches back to auto-"
22436 "detection for subsequent I<-a> options."
22441 #: ../fish/guestfish.pod:244
22444 " guestfish --format=raw -a disk.img\n"
22450 #: ../fish/guestfish.pod:246
22451 msgid "forces raw format (no auto-detection) for C<disk.img>."
22456 #: ../fish/guestfish.pod:248
22459 " guestfish --format=raw -a disk.img --format -a another.img\n"
22465 #: ../fish/guestfish.pod:250
22467 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22468 "detection for C<another.img>."
22473 #: ../fish/guestfish.pod:253
22475 "If you have untrusted raw-format guest disk images, you should use this "
22476 "option to specify the disk format. This avoids a possible security problem "
22477 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22482 #: ../fish/guestfish.pod:258
22488 #: ../fish/guestfish.pod:260
22489 msgid "B<--inspector>"
22494 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
22496 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22497 "system and mount filesystems as they would be mounted on the real virtual "
22503 #: ../fish/guestfish.pod:266
22504 msgid "Typical usage is either:"
22509 #: ../fish/guestfish.pod:268
22512 " guestfish -d myguest -i\n"
22518 #: ../fish/guestfish.pod:270
22519 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22524 #: ../fish/guestfish.pod:272
22527 " guestfish --ro -d myguest -i\n"
22533 #: ../fish/guestfish.pod:274
22534 msgid "(for active domains, readonly), or specify the block device directly:"
22539 #: ../fish/guestfish.pod:276
22542 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22548 #: ../fish/guestfish.pod:278
22550 "Note that the command line syntax changed slightly over older versions of "
22551 "guestfish. You can still use the old syntax:"
22556 #: ../fish/guestfish.pod:281
22559 " guestfish [--ro] -i disk.img\n"
22565 #: ../fish/guestfish.pod:283
22568 " guestfish [--ro] -i libvirt-domain\n"
22574 #: ../fish/guestfish.pod:285
22576 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22577 "then using other commands to mount the filesystems that were found."
22582 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22583 msgid "B<--keys-from-stdin>"
22588 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
22590 "Read key or passphrase parameters from stdin. The default is to try to read "
22591 "passphrases from the user by opening C</dev/tty>."
22596 #: ../fish/guestfish.pod:294
22597 msgid "B<--listen>"
22602 #: ../fish/guestfish.pod:296
22604 "Fork into the background and listen for remote commands. See section L</"
22605 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22609 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22614 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
22616 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22617 "ATTACHING TO RUNNING DAEMONS>)."
22621 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22622 msgid "B<-m dev[:mountpoint[:options]]>"
22626 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
22627 msgid "B<--mount dev[:mountpoint[:options]]>"
22632 #: ../fish/guestfish.pod:308
22633 msgid "Mount the named partition or logical volume on the given mountpoint."
22638 #: ../fish/guestfish.pod:310
22639 msgid "If the mountpoint is omitted, it defaults to C</>."
22644 #: ../fish/guestfish.pod:312
22645 msgid "You have to mount something on C</> before most commands will work."
22650 #: ../fish/guestfish.pod:314
22652 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22658 #: ../fish/guestfish.pod:317
22660 "If you don't know what filesystems a disk image contains, you can either run "
22661 "guestfish without this option, then list the partitions, filesystems and LVs "
22662 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22663 "commands), or you can use the L<virt-filesystems(1)> program."
22667 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
22669 "The third (and rarely used) part of the mount parameter is the list of mount "
22670 "options used to mount the underlying filesystem. If this is not given, then "
22671 "the mount options are either the empty string or C<ro> (the latter if the "
22672 "I<--ro> flag is used). By specifying the mount options, you override this "
22673 "default choice. Probably the only time you would use this is to enable ACLs "
22674 "and/or extended attributes if the filesystem can support them:"
22678 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
22681 " -m /dev/sda1:/:acl,user_xattr\n"
22686 #: ../fish/guestfish.pod:333
22687 msgid "Using this flag is equivalent to using the C<mount-options> command."
22692 #: ../fish/guestfish.pod:335
22698 #: ../fish/guestfish.pod:337
22699 msgid "B<--no-sync>"
22704 #: ../fish/guestfish.pod:339
22706 "Disable autosync. This is enabled by default. See the discussion of "
22707 "autosync in the L<guestfs(3)> manpage."
22712 #: ../fish/guestfish.pod:342
22718 #: ../fish/guestfish.pod:344
22719 msgid "B<--new type>"
22724 #: ../fish/guestfish.pod:346
22730 #: ../fish/guestfish.pod:348
22732 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22733 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22734 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22740 #: ../fish/guestfish.pod:353
22741 msgid "B<--progress-bars>"
22746 #: ../fish/guestfish.pod:355
22747 msgid "Enable progress bars, even when guestfish is used non-interactively."
22752 #: ../fish/guestfish.pod:357
22754 "Progress bars are enabled by default when guestfish is used as an "
22755 "interactive shell."
22760 #: ../fish/guestfish.pod:360
22761 msgid "B<--no-progress-bars>"
22766 #: ../fish/guestfish.pod:362
22767 msgid "Disable progress bars."
22772 #: ../fish/guestfish.pod:364
22773 msgid "B<--remote[=pid]>"
22778 #: ../fish/guestfish.pod:366
22780 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22781 "CONTROL GUESTFISH OVER A SOCKET> below."
22786 #: ../fish/guestfish.pod:369
22792 #: ../fish/guestfish.pod:371
22798 #: ../fish/guestfish.pod:373
22800 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22801 "mounts are done read-only."
22806 #: ../fish/guestfish.pod:376
22808 "The option must always be used if the disk image or virtual machine might be "
22809 "running, and is generally recommended in cases where you don't need write "
22810 "access to the disk."
22815 #: ../fish/guestfish.pod:380
22817 "Note that prepared disk images created with I<-N> are not affected by this "
22818 "option. Also commands like C<add> are not affected - you have to specify "
22819 "the C<readonly:true> option explicitly if you need it."
22824 #: ../fish/guestfish.pod:384
22825 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22830 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
22831 msgid "B<--selinux>"
22836 #: ../fish/guestfish.pod:388
22837 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22842 #: ../fish/guestfish.pod:390
22848 #: ../fish/guestfish.pod:392
22849 msgid "B<--verbose>"
22854 #: ../fish/guestfish.pod:394
22856 "Enable very verbose messages. This is particularly useful if you find a bug."
22861 #: ../fish/guestfish.pod:397
22867 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
22868 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22869 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22870 msgid "B<--version>"
22875 #: ../fish/guestfish.pod:401
22876 msgid "Display the guestfish / libguestfs version number and exit."
22881 #: ../fish/guestfish.pod:403
22887 #: ../fish/guestfish.pod:405
22892 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
22894 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22895 "mounts are done read-write."
22899 #: ../fish/guestfish.pod:410
22900 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22905 #: ../fish/guestfish.pod:412
22911 #: ../fish/guestfish.pod:414
22912 msgid "Echo each command before executing it."
22917 #: ../fish/guestfish.pod:418
22918 msgid "COMMANDS ON COMMAND LINE"
22923 #: ../fish/guestfish.pod:420
22925 "Any additional (non-option) arguments are treated as commands to execute."
22930 #: ../fish/guestfish.pod:423
22932 "Commands to execute should be separated by a colon (C<:>), where the colon "
22933 "is a separate parameter. Thus:"
22938 #: ../fish/guestfish.pod:426
22941 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22947 #: ../fish/guestfish.pod:428
22949 "If there are no additional arguments, then we enter a shell, either an "
22950 "interactive shell with a prompt (if the input is a terminal) or a non-"
22951 "interactive shell."
22956 #: ../fish/guestfish.pod:432
22958 "In either command line mode or non-interactive shell, the first command that "
22959 "gives an error causes the whole shell to exit. In interactive mode (with a "
22960 "prompt) if a command fails, you can continue to enter commands."
22965 #: ../fish/guestfish.pod:437
22966 msgid "USING launch (OR run)"
22971 #: ../fish/guestfish.pod:439
22973 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22974 "then launch it, then mount any disks you need, and finally issue actions/"
22975 "commands. So the general order of the day is:"
22980 #: ../fish/guestfish.pod:447
22981 msgid "add or -a/--add"
22986 #: ../fish/guestfish.pod:451
22987 msgid "launch (aka run)"
22992 #: ../fish/guestfish.pod:455
22993 msgid "mount or -m/--mount"
22998 #: ../fish/guestfish.pod:459
22999 msgid "any other commands"
23004 #: ../fish/guestfish.pod:463
23006 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
23007 "guest before mounting or performing any other commands."
23012 #: ../fish/guestfish.pod:466
23014 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
23015 "I<--new> options were given then C<run> is done automatically, simply "
23016 "because guestfish can't perform the action you asked for without doing this."
23021 #: ../fish/guestfish.pod:471
23022 msgid "OPENING DISKS FOR READ AND WRITE"
23026 #: ../fish/guestfish.pod:473
23028 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
23029 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
23030 "I<-i> and I<-m> open disk images read-only or for writing."
23034 #: ../fish/guestfish.pod:478
23036 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
23037 "opening disk images supplied on the command line for write. To open a disk "
23038 "image read-only you have to do I<-a image --ro>."
23043 #: ../fish/guestfish.pod:482
23045 "This matters: If you accidentally open a live VM disk image writable then "
23046 "you will cause irreversible disk corruption."
23050 #: ../fish/guestfish.pod:485
23052 "By libguestfs 1.12 we intend to change the default the other way. Disk "
23053 "images will be opened read-only. You will have to either specify "
23054 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
23055 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
23056 "access for disk images specified by those other command line options."
23060 #: ../fish/guestfish.pod:492
23062 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
23063 "which does nothing (it is already the default). However it is highly "
23064 "recommended that you use this option to indicate that you need write access, "
23065 "and prepare your scripts for the day when this option will be required for "
23071 #: ../fish/guestfish.pod:498
23073 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
23074 "other libguestfs program apart from guestfish and guestmount."
23079 #: ../fish/guestfish.pod:501
23085 #: ../fish/guestfish.pod:503
23087 "You can quote ordinary parameters using either single or double quotes. For "
23093 #: ../fish/guestfish.pod:506
23096 " add \"file with a space.img\"\n"
23102 #: ../fish/guestfish.pod:508
23105 " rm '/file name'\n"
23111 #: ../fish/guestfish.pod:510
23120 #: ../fish/guestfish.pod:512
23122 "A few commands require a list of strings to be passed. For these, use a "
23123 "whitespace-separated list, enclosed in quotes. Strings containing "
23124 "whitespace to be passed through must be enclosed in single quotes. A "
23125 "literal single quote must be escaped with a backslash."
23130 #: ../fish/guestfish.pod:517
23133 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
23134 " command \"/bin/echo 'foo bar'\"\n"
23135 " command \"/bin/echo \\'foo\\'\"\n"
23141 #: ../fish/guestfish.pod:521
23142 msgid "OPTIONAL ARGUMENTS"
23147 #: ../fish/guestfish.pod:523
23149 "Some commands take optional arguments. These arguments appear in this "
23150 "documentation as C<[argname:..]>. You can use them as in these examples:"
23155 #: ../fish/guestfish.pod:527
23158 " add-drive-opts filename\n"
23164 #: ../fish/guestfish.pod:529
23167 " add-drive-opts filename readonly:true\n"
23173 #: ../fish/guestfish.pod:531
23176 " add-drive-opts filename format:qcow2 readonly:false\n"
23182 #: ../fish/guestfish.pod:533
23184 "Each optional argument can appear at most once. All optional arguments must "
23185 "appear after the required ones."
23190 #: ../fish/guestfish.pod:536
23196 #: ../fish/guestfish.pod:538
23198 "This section applies to all commands which can take integers as parameters."
23203 #: ../fish/guestfish.pod:541
23204 msgid "SIZE SUFFIX"
23209 #: ../fish/guestfish.pod:543
23211 "When the command takes a parameter measured in bytes, you can use one of the "
23212 "following suffixes to specify kilobytes, megabytes and larger sizes:"
23217 #: ../fish/guestfish.pod:549
23218 msgid "B<k> or B<K> or B<KiB>"
23223 #: ../fish/guestfish.pod:551
23224 msgid "The size in kilobytes (multiplied by 1024)."
23229 #: ../fish/guestfish.pod:553
23235 #: ../fish/guestfish.pod:555
23236 msgid "The size in SI 1000 byte units."
23241 #: ../fish/guestfish.pod:557
23242 msgid "B<M> or B<MiB>"
23247 #: ../fish/guestfish.pod:559
23248 msgid "The size in megabytes (multiplied by 1048576)."
23253 #: ../fish/guestfish.pod:561
23259 #: ../fish/guestfish.pod:563
23260 msgid "The size in SI 1000000 byte units."
23265 #: ../fish/guestfish.pod:565
23266 msgid "B<G> or B<GiB>"
23271 #: ../fish/guestfish.pod:567
23272 msgid "The size in gigabytes (multiplied by 2**30)."
23277 #: ../fish/guestfish.pod:569
23283 #: ../fish/guestfish.pod:571
23284 msgid "The size in SI 10**9 byte units."
23289 #: ../fish/guestfish.pod:573
23290 msgid "B<T> or B<TiB>"
23295 #: ../fish/guestfish.pod:575
23296 msgid "The size in terabytes (multiplied by 2**40)."
23301 #: ../fish/guestfish.pod:577
23307 #: ../fish/guestfish.pod:579
23308 msgid "The size in SI 10**12 byte units."
23313 #: ../fish/guestfish.pod:581
23314 msgid "B<P> or B<PiB>"
23319 #: ../fish/guestfish.pod:583
23320 msgid "The size in petabytes (multiplied by 2**50)."
23325 #: ../fish/guestfish.pod:585
23331 #: ../fish/guestfish.pod:587
23332 msgid "The size in SI 10**15 byte units."
23337 #: ../fish/guestfish.pod:589
23338 msgid "B<E> or B<EiB>"
23343 #: ../fish/guestfish.pod:591
23344 msgid "The size in exabytes (multiplied by 2**60)."
23349 #: ../fish/guestfish.pod:593
23355 #: ../fish/guestfish.pod:595
23356 msgid "The size in SI 10**18 byte units."
23361 #: ../fish/guestfish.pod:597
23362 msgid "B<Z> or B<ZiB>"
23367 #: ../fish/guestfish.pod:599
23368 msgid "The size in zettabytes (multiplied by 2**70)."
23373 #: ../fish/guestfish.pod:601
23379 #: ../fish/guestfish.pod:603
23380 msgid "The size in SI 10**21 byte units."
23385 #: ../fish/guestfish.pod:605
23386 msgid "B<Y> or B<YiB>"
23391 #: ../fish/guestfish.pod:607
23392 msgid "The size in yottabytes (multiplied by 2**80)."
23397 #: ../fish/guestfish.pod:609
23403 #: ../fish/guestfish.pod:611
23404 msgid "The size in SI 10**24 byte units."
23409 #: ../fish/guestfish.pod:617
23412 " truncate-size /file 1G\n"
23418 #: ../fish/guestfish.pod:619
23419 msgid "would truncate the file to 1 gigabyte."
23424 #: ../fish/guestfish.pod:621
23426 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23427 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23428 "suffix will probably not do what you expect."
23433 #: ../fish/guestfish.pod:625
23434 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23439 #: ../fish/guestfish.pod:627
23441 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23442 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23447 #: ../fish/guestfish.pod:630
23450 " 1234 decimal number 1234\n"
23451 " 02322 octal number, equivalent to decimal 1234\n"
23452 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23458 #: ../fish/guestfish.pod:634
23460 "When using the C<chmod> command, you almost always want to specify an octal "
23461 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23462 "L<chmod(1)> program):"
23467 #: ../fish/guestfish.pod:638
23470 " chmod 0777 /public # OK\n"
23471 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23477 #: ../fish/guestfish.pod:641
23479 "Commands that return numbers usually print them in decimal, but some "
23480 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23481 "octal, preceeded by C<0>)."
23486 #: ../fish/guestfish.pod:645
23487 msgid "WILDCARDS AND GLOBBING"
23492 #: ../fish/guestfish.pod:647
23494 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23495 "(globbing) by default. So for example the following will not do what you "
23501 #: ../fish/guestfish.pod:651
23510 #: ../fish/guestfish.pod:653
23512 "Assuming you don't have a directory called literally C</home/*> then the "
23513 "above command will return an error."
23518 #: ../fish/guestfish.pod:656
23519 msgid "To perform wildcard expansion, use the C<glob> command."
23524 #: ../fish/guestfish.pod:658
23527 " glob rm-rf /home/*\n"
23533 #: ../fish/guestfish.pod:660
23535 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23536 "many times), equivalent to:"
23541 #: ../fish/guestfish.pod:663
23544 " rm-rf /home/jim\n"
23545 " rm-rf /home/joe\n"
23546 " rm-rf /home/mary\n"
23552 #: ../fish/guestfish.pod:667
23553 msgid "C<glob> only works on simple guest paths and not on device names."
23558 #: ../fish/guestfish.pod:669
23560 "If you have several parameters, each containing a wildcard, then glob will "
23561 "perform a Cartesian product."
23566 #: ../fish/guestfish.pod:672
23572 #: ../fish/guestfish.pod:674
23574 "Any line which starts with a I<#> character is treated as a comment and "
23575 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23576 "a command. For example:"
23581 #: ../fish/guestfish.pod:678
23584 " # this is a comment\n"
23585 " # this is a comment\n"
23586 " foo # NOT a comment\n"
23592 #: ../fish/guestfish.pod:682
23593 msgid "Blank lines are also ignored."
23598 #: ../fish/guestfish.pod:684
23599 msgid "RUNNING COMMANDS LOCALLY"
23604 #: ../fish/guestfish.pod:686
23606 "Any line which starts with a I<!> character is treated as a command sent to "
23607 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23612 #: ../fish/guestfish.pod:690
23616 " tgz-out /remote local/remote-data.tar.gz\n"
23622 #: ../fish/guestfish.pod:693
23624 "will create a directory C<local> on the host, and then export the contents "
23625 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23626 "(See C<tgz-out>)."
23631 #: ../fish/guestfish.pod:697
23633 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23634 "effect, due to the way that subprocesses work in Unix."
23638 #: ../fish/guestfish.pod:700
23639 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23643 #: ../fish/guestfish.pod:702
23645 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23646 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23647 "and executed as guestfish commands."
23651 #: ../fish/guestfish.pod:706
23653 "Thus you can use shell script to construct arbitrary guestfish commands "
23654 "which are then parsed by guestfish."
23658 #: ../fish/guestfish.pod:709
23660 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23661 "through C</foo.100>) using guestfish commands alone. However this is simple "
23662 "if we use a shell script to create the guestfish commands for us:"
23666 #: ../fish/guestfish.pod:714
23669 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23674 #: ../fish/guestfish.pod:716
23675 msgid "or with names like C</foo.001>:"
23679 #: ../fish/guestfish.pod:718
23682 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23687 #: ../fish/guestfish.pod:720
23689 "When using guestfish interactively it can be helpful to just run the shell "
23690 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23691 "ordinary I<!> local command), see what guestfish commands it would run, and "
23692 "when you are happy with those prepend the C<E<lt>> character to run the "
23693 "guestfish commands for real."
23698 #: ../fish/guestfish.pod:726
23704 #: ../fish/guestfish.pod:728
23706 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23707 "command (a guestfish command) to the second command (any host command). For "
23713 #: ../fish/guestfish.pod:732
23716 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23722 #: ../fish/guestfish.pod:734
23724 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23725 "program). The above command would list all accounts in the guest filesystem "
23726 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23731 #: ../fish/guestfish.pod:739
23734 " hexdump /bin/ls | head\n"
23735 " list-devices | tail -1\n"
23736 " tgz-out / - | tar ztf -\n"
23742 #: ../fish/guestfish.pod:743
23744 "The space before the pipe symbol is required, any space after the pipe "
23745 "symbol is optional. Everything after the pipe symbol is just passed "
23746 "straight to the host shell, so it can contain redirections, globs and "
23747 "anything else that makes sense on the host side."
23752 #: ../fish/guestfish.pod:748
23754 "To use a literal argument which begins with a pipe symbol, you have to quote "
23760 #: ../fish/guestfish.pod:751
23769 #: ../fish/guestfish.pod:753
23770 msgid "HOME DIRECTORIES"
23775 #: ../fish/guestfish.pod:755
23777 "If a parameter starts with the character C<~> then the tilde may be expanded "
23778 "as a home directory path (either C<~> for the current user's home directory, "
23779 "or C<~user> for another user)."
23784 #: ../fish/guestfish.pod:759
23786 "Note that home directory expansion happens for users known I<on the host>, "
23787 "not in the guest filesystem."
23792 #: ../fish/guestfish.pod:762
23794 "To use a literal argument which begins with a tilde, you have to quote it, "
23800 #: ../fish/guestfish.pod:765
23809 #: ../fish/guestfish.pod:769
23811 "Libguestfs has some support for Linux guests encrypted according to the "
23812 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23813 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23814 "LUKS is supported."
23819 #: ../fish/guestfish.pod:774
23820 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23825 #: ../fish/guestfish.pod:776
23828 " ><fs> vfs-type /dev/sda2\n"
23835 #: ../fish/guestfish.pod:779
23837 "Then open those devices using L</luks-open>. This creates a device-mapper "
23838 "device called C</dev/mapper/luksdev>."
23843 #: ../fish/guestfish.pod:782
23846 " ><fs> luks-open /dev/sda2 luksdev\n"
23847 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23853 #: ../fish/guestfish.pod:785
23855 "Finally you have to tell LVM to scan for volume groups on the newly created "
23861 #: ../fish/guestfish.pod:788
23865 " vg-activate-all true\n"
23871 #: ../fish/guestfish.pod:791
23872 msgid "The logical volume(s) can now be mounted in the usual way."
23877 #: ../fish/guestfish.pod:793
23879 "Before closing a LUKS device you must unmount any logical volumes on it and "
23880 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23881 "one. Then you can close the mapper device:"
23886 #: ../fish/guestfish.pod:797
23889 " vg-activate false /dev/VG\n"
23890 " luks-close /dev/mapper/luksdev\n"
23896 #: ../fish/guestfish.pod:800
23897 msgid "WINDOWS PATHS"
23901 #: ../fish/guestfish.pod:802
23903 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23904 "letters and paths (with some limitations). The following commands are "
23910 #: ../fish/guestfish.pod:806
23913 " file /WINDOWS/system32/config/system.LOG\n"
23919 #: ../fish/guestfish.pod:808
23922 " file win:\\windows\\system32\\config\\system.log\n"
23927 #: ../fish/guestfish.pod:810
23930 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23935 #: ../fish/guestfish.pod:812
23937 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23938 "where the drive is mounted, prepending that to the path, changing all "
23939 "backslash characters to forward slash, then resolving the result using L</"
23940 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23941 "the parameter might be rewritten like this:"
23945 #: ../fish/guestfish.pod:818
23948 " win:e:\\foo\\bar => /e/FOO/bar\n"
23953 #: ../fish/guestfish.pod:820
23954 msgid "This only works in argument positions that expect a path."
23959 #: ../fish/guestfish.pod:822
23960 msgid "UPLOADING AND DOWNLOADING FILES"
23965 #: ../fish/guestfish.pod:824
23967 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23968 "others which upload from or download to a local file, you can use the "
23969 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23974 #: ../fish/guestfish.pod:828
23983 #: ../fish/guestfish.pod:830
23985 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23990 #: ../fish/guestfish.pod:833
23993 " tar-out /etc - | tar tf -\n"
23999 #: ../fish/guestfish.pod:835
24001 "writes the tarball to stdout and then pipes that into the external \"tar\" "
24002 "command (see L</PIPES>)."
24007 #: ../fish/guestfish.pod:838
24009 "When using C<-> to read from stdin, the input is read up to the end of "
24010 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
24011 "some arbitrary end marker:"
24016 #: ../fish/guestfish.pod:842
24019 " upload -<<END /foo\n"
24029 #: ../fish/guestfish.pod:848
24031 "Any string of characters can be used instead of C<END>. The end marker must "
24032 "appear on a line of its own, without any preceeding or following characters "
24033 "(not even spaces)."
24038 #: ../fish/guestfish.pod:852
24040 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
24041 "upload local files (so-called \"FileIn\" parameters in the generator)."
24046 #: ../fish/guestfish.pod:855
24047 msgid "EXIT ON ERROR BEHAVIOUR"
24052 #: ../fish/guestfish.pod:857
24054 "By default, guestfish will ignore any errors when in interactive mode (ie. "
24055 "taking commands from a human over a tty), and will exit on the first error "
24056 "in non-interactive mode (scripts, commands given on the command line)."
24061 #: ../fish/guestfish.pod:862
24063 "If you prefix a command with a I<-> character, then that command will not "
24064 "cause guestfish to exit, even if that (one) command returns an error."
24069 #: ../fish/guestfish.pod:866
24070 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
24075 #: ../fish/guestfish.pod:868
24077 "Guestfish can be remote-controlled over a socket. This is useful "
24078 "particularly in shell scripts where you want to make several different "
24079 "changes to a filesystem, but you don't want the overhead of starting up a "
24080 "guestfish process each time."
24085 #: ../fish/guestfish.pod:873
24086 msgid "Start a guestfish server process using:"
24091 #: ../fish/guestfish.pod:875
24094 " eval \"`guestfish --listen`\"\n"
24100 #: ../fish/guestfish.pod:877
24101 msgid "and then send it commands by doing:"
24106 #: ../fish/guestfish.pod:879
24109 " guestfish --remote cmd [...]\n"
24115 #: ../fish/guestfish.pod:881
24116 msgid "To cause the server to exit, send it the exit command:"
24121 #: ../fish/guestfish.pod:883
24124 " guestfish --remote exit\n"
24130 #: ../fish/guestfish.pod:885
24132 "Note that the server will normally exit if there is an error in a command. "
24133 "You can change this in the usual way. See section L</EXIT ON ERROR "
24139 #: ../fish/guestfish.pod:889
24140 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
24145 #: ../fish/guestfish.pod:891
24147 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
24148 "is how the I<--remote> option knows where to send the commands. You can "
24149 "have several guestfish listener processes running using:"
24154 #: ../fish/guestfish.pod:895
24157 " eval \"`guestfish --listen`\"\n"
24158 " pid1=$GUESTFISH_PID\n"
24159 " eval \"`guestfish --listen`\"\n"
24160 " pid2=$GUESTFISH_PID\n"
24162 " guestfish --remote=$pid1 cmd\n"
24163 " guestfish --remote=$pid2 cmd\n"
24169 #: ../fish/guestfish.pod:903
24170 msgid "REMOTE CONTROL AND CSH"
24175 #: ../fish/guestfish.pod:905
24177 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
24183 #: ../fish/guestfish.pod:908
24186 " eval \"`guestfish --listen --csh`\"\n"
24192 #: ../fish/guestfish.pod:910
24193 msgid "REMOTE CONTROL DETAILS"
24198 #: ../fish/guestfish.pod:912
24200 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
24201 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
24202 "and C<$PID> is the process ID of the server."
24207 #: ../fish/guestfish.pod:916
24208 msgid "Guestfish client and server versions must match exactly."
24213 #: ../fish/guestfish.pod:918
24214 msgid "PREPARED DISK IMAGES"
24219 #: ../fish/guestfish.pod:920
24221 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
24222 "preformatted disk images that guestfish can make for you to save typing. "
24223 "This is particularly useful for testing purposes. This option is used "
24224 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
24225 "can be mixed with I<-a>)."
24230 #: ../fish/guestfish.pod:926
24232 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
24233 "the second and so on. Existing files in the current directory are "
24239 #: ../fish/guestfish.pod:930
24241 "The type briefly describes how the disk should be sized, partitioned, how "
24242 "filesystem(s) should be created, and how content should be added. "
24243 "Optionally the type can be followed by extra parameters, separated by C<:> "
24244 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
24245 "allocated disk, containing a single partition, with the partition formatted "
24246 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
24252 #: ../fish/guestfish.pod:938
24253 msgid "To list the available types and any extra parameters they take, run:"
24258 #: ../fish/guestfish.pod:942
24260 "Note that the prepared filesystem is not mounted. You would usually have to "
24261 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
24266 #: ../fish/guestfish.pod:946
24268 "If any I<-N> or I<--new> options are given, the guest is automatically "
24274 #: ../fish/guestfish.pod:951
24275 msgid "Create a 100MB disk with an ext4-formatted partition:"
24280 #: ../fish/guestfish.pod:953
24283 " guestfish -N fs:ext4\n"
24289 #: ../fish/guestfish.pod:955
24290 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24295 #: ../fish/guestfish.pod:957
24298 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24304 #: ../fish/guestfish.pod:959
24305 msgid "Create a blank 200MB disk:"
24310 #: ../fish/guestfish.pod:961
24313 " guestfish -N disk:200M\n"
24319 #: ../fish/guestfish.pod:963
24320 msgid "PROGRESS BARS"
24325 #: ../fish/guestfish.pod:965
24327 "Some (not all) long-running commands send progress notification messages as "
24328 "they are running. Guestfish turns these messages into progress bars."
24333 #: ../fish/guestfish.pod:969
24335 "When a command that supports progress bars takes longer than two seconds to "
24336 "run, and if progress bars are enabled, then you will see one appearing below "
24342 #: ../fish/guestfish.pod:973
24345 " ><fs> copy-size /large-file /another-file 2048M\n"
24346 " / 10% [#####-----------------------------------------] 00:30\n"
24352 #: ../fish/guestfish.pod:976
24354 "The spinner on the left hand side moves round once for every progress "
24355 "notification received from the backend. This is a (reasonably) golden "
24356 "assurance that the command is \"doing something\" even if the progress bar "
24357 "is not moving, because the command is able to send the progress "
24358 "notifications. When the bar reaches 100% and the command finishes, the "
24359 "spinner disappears."
24364 #: ../fish/guestfish.pod:983
24366 "Progress bars are enabled by default when guestfish is used interactively. "
24367 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24368 "and you can disable them completely using I<--no-progress-bars>."
24373 #: ../fish/guestfish.pod:988
24374 msgid "GUESTFISH COMMANDS"
24379 #: ../fish/guestfish.pod:990
24381 "The commands in this section are guestfish convenience commands, in other "
24382 "words, they are not part of the L<guestfs(3)> API."
24387 #: ../fish/guestfish.pod:993
24393 #: ../fish/guestfish.pod:995
24403 #: ../fish/guestfish.pod:998
24404 msgid "Without any parameter, this provides general help."
24409 #: ../fish/guestfish.pod:1000
24410 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24415 #: ../fish/guestfish.pod:1002
24416 msgid "quit | exit"
24421 #: ../fish/guestfish.pod:1004
24422 msgid "This exits guestfish. You can also use C<^D> key."
24427 #: ../fish/guestfish.pod:1006
24428 msgid "@FISH_COMMANDS@"
24433 #: ../fish/guestfish.pod:1008
24439 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24445 #: ../fish/guestfish.pod:1014
24447 "guestfish returns 0 if the commands completed without error, or 1 if there "
24453 #: ../fish/guestfish.pod:1021
24459 #: ../fish/guestfish.pod:1023
24461 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24466 #: ../fish/guestfish.pod:1026
24467 msgid "GUESTFISH_DISPLAY_IMAGE"
24471 #: ../fish/guestfish.pod:1028
24473 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
24474 "If not set, it uses L<display(1)>."
24479 #: ../fish/guestfish.pod:1031
24480 msgid "GUESTFISH_PID"
24485 #: ../fish/guestfish.pod:1033
24487 "Used with the I<--remote> option to specify the remote guestfish process to "
24488 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24493 #: ../fish/guestfish.pod:1037
24499 #: ../fish/guestfish.pod:1039
24501 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24502 "not specified, the external L<hexedit(1)> program is used."
24507 #: ../fish/guestfish.pod:1043
24513 #: ../fish/guestfish.pod:1045
24515 "If compiled with GNU readline support, various files in the home directory "
24516 "can be used. See L</FILES>."
24521 #: ../fish/guestfish.pod:1054
24523 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24524 "effect as using the B<-v> option."
24529 #: ../fish/guestfish.pod:1066
24531 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24532 "the discussion of paths in L<guestfs(3)>."
24537 #: ../fish/guestfish.pod:1077
24538 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24543 #: ../fish/guestfish.pod:1079
24549 #: ../fish/guestfish.pod:1081
24551 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24557 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
24562 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
24563 msgid "$HOME/.libguestfs-tools.rc"
24567 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
24568 msgid "/etc/libguestfs-tools.conf"
24572 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
24574 "This configuration file controls the default read-only or read-write mode "
24575 "(I<--ro> or I<--rw>)."
24579 #: ../fish/guestfish.pod:1108
24580 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24585 #: ../fish/guestfish.pod:1110
24586 msgid "$HOME/.guestfish"
24591 #: ../fish/guestfish.pod:1112
24593 "If compiled with GNU readline support, then the command history is saved in "
24599 #: ../fish/guestfish.pod:1115
24600 msgid "$HOME/.inputrc"
24605 #: ../fish/guestfish.pod:1117
24606 msgid "/etc/inputrc"
24611 #: ../fish/guestfish.pod:1119
24613 "If compiled with GNU readline support, then these files can be used to "
24614 "configure readline. For further information, please see L<readline(3)/"
24615 "INITIALIZATION FILE>."
24620 #: ../fish/guestfish.pod:1123
24621 msgid "To write rules which only apply to guestfish, use:"
24626 #: ../fish/guestfish.pod:1125
24637 #: ../fish/guestfish.pod:1129
24639 "Variables that you can set in inputrc that change the behaviour of guestfish "
24640 "in useful ways include:"
24645 #: ../fish/guestfish.pod:1134
24646 msgid "completion-ignore-case (default: on)"
24651 #: ../fish/guestfish.pod:1136
24653 "By default, guestfish will ignore case when tab-completing paths on the "
24659 #: ../fish/guestfish.pod:1139
24662 " set completion-ignore-case off\n"
24668 #: ../fish/guestfish.pod:1141
24669 msgid "to make guestfish case sensitive."
24674 #: ../fish/guestfish.pod:1145
24680 #: ../fish/guestfish.pod:1147
24681 msgid "test2.img (etc)"
24685 #: ../fish/guestfish.pod:1149
24687 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24688 "will be created in the file C<test1.img> in the current directory. The "
24689 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24690 "the same name will be overwritten."
24694 #: ../fish/guestfish.pod:1158
24696 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24697 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24698 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24699 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24700 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24701 ">, L<display(1)>, L<hexedit(1)>."
24706 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
24707 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
24708 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24709 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24711 "This program is free software; you can redistribute it and/or modify it "
24712 "under the terms of the GNU General Public License as published by the Free "
24713 "Software Foundation; either version 2 of the License, or (at your option) "
24714 "any later version."
24719 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
24720 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
24721 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24722 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24724 "This program is distributed in the hope that it will be useful, but WITHOUT "
24725 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24726 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24732 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
24733 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
24734 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24735 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24737 "You should have received a copy of the GNU General Public License along with "
24738 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24739 "Ave, Cambridge, MA 02139, USA."
24744 #: ../fish/guestfish-actions.pod:1
24750 #: ../fish/guestfish-actions.pod:3
24753 " add-cdrom filename\n"
24759 #: ../fish/guestfish-actions.pod:15
24761 "This call checks for the existence of C<filename>. This stops you from "
24762 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24763 "and C<http:> URLs. To specify those, use the general L</config> call "
24769 #: ../fish/guestfish-actions.pod:22
24771 "If you just want to add an ISO file (often you use this as an efficient way "
24772 "to transfer large files into the guest), then you should probably use L</add-"
24773 "drive-ro> instead."
24778 #: ../fish/guestfish-actions.pod:35
24784 #: ../fish/guestfish-actions.pod:37
24789 #: ../fish/guestfish-actions.pod:39
24792 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
24798 #: ../fish/guestfish-actions.pod:41
24800 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24801 "It works by connecting to libvirt, requesting the domain and domain XML from "
24802 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24807 #: ../fish/guestfish-actions.pod:76
24809 "The other optional parameters are passed directly through to L</add-drive-"
24815 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
24816 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3077
24817 #: ../fish/guestfish-actions.pod:3250
24819 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24824 #: ../fish/guestfish-actions.pod:81
24830 #: ../fish/guestfish-actions.pod:83
24833 " add-drive filename\n"
24839 #: ../fish/guestfish-actions.pod:85
24841 "This function is the equivalent of calling L</add-drive-opts> with no "
24842 "optional parameters, so the disk is added writable, with the format being "
24843 "detected automatically."
24848 #: ../fish/guestfish-actions.pod:89
24850 "Automatic detection of the format opens you up to a potential security hole "
24851 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24852 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24853 "you should think about replacing calls to this function with calls to L</add-"
24854 "drive-opts>, and specifying the format."
24859 #: ../fish/guestfish-actions.pod:96
24860 msgid "add-drive-opts"
24865 #: ../fish/guestfish-actions.pod:98
24871 #: ../fish/guestfish-actions.pod:100
24874 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24880 #: ../fish/guestfish-actions.pod:127
24882 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24883 "add-drive-ro>) then the format is automatically detected. Possible formats "
24884 "include C<raw> and C<qcow2>."
24889 #: ../fish/guestfish-actions.pod:138
24891 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24892 "add-drive-with-if> call (q.v.)"
24897 #: ../fish/guestfish-actions.pod:145
24898 msgid "add-drive-ro"
24903 #: ../fish/guestfish-actions.pod:147
24909 #: ../fish/guestfish-actions.pod:149
24912 " add-drive-ro filename\n"
24918 #: ../fish/guestfish-actions.pod:151
24920 "This function is the equivalent of calling L</add-drive-opts> with the "
24921 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24922 "is added read-only, with the format being detected automatically."
24927 #: ../fish/guestfish-actions.pod:156
24928 msgid "add-drive-ro-with-if"
24933 #: ../fish/guestfish-actions.pod:158
24936 " add-drive-ro-with-if filename iface\n"
24942 #: ../fish/guestfish-actions.pod:160
24944 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24945 "interface emulation to use at run time."
24950 #: ../fish/guestfish-actions.pod:170
24951 msgid "add-drive-with-if"
24956 #: ../fish/guestfish-actions.pod:172
24959 " add-drive-with-if filename iface\n"
24965 #: ../fish/guestfish-actions.pod:174
24967 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24968 "interface emulation to use at run time."
24973 #: ../fish/guestfish-actions.pod:184
24979 #: ../fish/guestfish-actions.pod:186
24982 " aug-clear augpath\n"
24988 #: ../fish/guestfish-actions.pod:191
24994 #: ../fish/guestfish-actions.pod:193
25003 #: ../fish/guestfish-actions.pod:195
25005 "Close the current Augeas handle and free up any resources used by it. After "
25006 "calling this, you have to call L</aug-init> again before you can use any "
25007 "other Augeas functions."
25012 #: ../fish/guestfish-actions.pod:200
25013 msgid "aug-defnode"
25018 #: ../fish/guestfish-actions.pod:202
25021 " aug-defnode name expr val\n"
25027 #: ../fish/guestfish-actions.pod:207
25029 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
25030 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
25031 "containing that single node."
25036 #: ../fish/guestfish-actions.pod:215
25042 #: ../fish/guestfish-actions.pod:217
25045 " aug-defvar name expr\n"
25051 #: ../fish/guestfish-actions.pod:226
25057 #: ../fish/guestfish-actions.pod:228
25060 " aug-get augpath\n"
25066 #: ../fish/guestfish-actions.pod:233
25072 #: ../fish/guestfish-actions.pod:235
25075 " aug-init root flags\n"
25081 #: ../fish/guestfish-actions.pod:241
25082 msgid "You must call this before using any other L</aug-*> commands."
25087 #: ../fish/guestfish-actions.pod:276
25088 msgid "Do not load the tree in L</aug-init>."
25093 #: ../fish/guestfish-actions.pod:280
25094 msgid "To close the handle, you can call L</aug-close>."
25099 #: ../fish/guestfish-actions.pod:284
25105 #: ../fish/guestfish-actions.pod:286
25108 " aug-insert augpath label true|false\n"
25114 #: ../fish/guestfish-actions.pod:296
25120 #: ../fish/guestfish-actions.pod:298
25129 #: ../fish/guestfish-actions.pod:305
25135 #: ../fish/guestfish-actions.pod:307
25138 " aug-ls augpath\n"
25144 #: ../fish/guestfish-actions.pod:309
25146 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
25147 "resulting nodes into alphabetical order."
25152 #: ../fish/guestfish-actions.pod:312
25158 #: ../fish/guestfish-actions.pod:314
25161 " aug-match augpath\n"
25167 #: ../fish/guestfish-actions.pod:320
25173 #: ../fish/guestfish-actions.pod:322
25176 " aug-mv src dest\n"
25182 #: ../fish/guestfish-actions.pod:327
25188 #: ../fish/guestfish-actions.pod:329
25191 " aug-rm augpath\n"
25197 #: ../fish/guestfish-actions.pod:335
25203 #: ../fish/guestfish-actions.pod:337
25212 #: ../fish/guestfish-actions.pod:341
25214 "The flags which were passed to L</aug-init> affect exactly how files are "
25220 #: ../fish/guestfish-actions.pod:344
25226 #: ../fish/guestfish-actions.pod:346
25229 " aug-set augpath val\n"
25235 #: ../fish/guestfish-actions.pod:350
25237 "In the Augeas API, it is possible to clear a node by setting the value to "
25238 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
25239 "this call. Instead you must use the L</aug-clear> call."
25244 #: ../fish/guestfish-actions.pod:355
25250 #: ../fish/guestfish-actions.pod:357
25253 " available 'groups ...'\n"
25259 #: ../fish/guestfish-actions.pod:363
25261 "The libguestfs groups, and the functions that those groups correspond to, "
25262 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
25263 "runtime by calling L</available-all-groups>."
25268 #: ../fish/guestfish-actions.pod:387
25269 msgid "You must call L</launch> before calling this function."
25274 #: ../fish/guestfish-actions.pod:409
25276 "This call was added in version C<1.0.80>. In previous versions of "
25277 "libguestfs all you could do would be to speculatively execute a command to "
25278 "find out if the daemon implemented it. See also L</version>."
25283 #: ../fish/guestfish-actions.pod:416
25284 msgid "available-all-groups"
25289 #: ../fish/guestfish-actions.pod:418
25292 " available-all-groups\n"
25298 #: ../fish/guestfish-actions.pod:420
25300 "This command returns a list of all optional groups that this daemon knows "
25301 "about. Note this returns both supported and unsupported groups. To find "
25302 "out which ones the daemon can actually support you have to call L</"
25303 "available> on each member of the returned list."
25308 #: ../fish/guestfish-actions.pod:426
25309 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25314 #: ../fish/guestfish-actions.pod:428
25320 #: ../fish/guestfish-actions.pod:430
25323 " base64-in (base64file|-) filename\n"
25329 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25330 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
25331 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
25332 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4535
25333 #: ../fish/guestfish-actions.pod:4546 ../fish/guestfish-actions.pod:4557
25334 #: ../fish/guestfish-actions.pod:4609 ../fish/guestfish-actions.pod:4618
25335 #: ../fish/guestfish-actions.pod:4672 ../fish/guestfish-actions.pod:4695
25336 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25341 #: ../fish/guestfish-actions.pod:437
25347 #: ../fish/guestfish-actions.pod:439
25350 " base64-out filename (base64file|-)\n"
25356 #: ../fish/guestfish-actions.pod:446
25357 msgid "blockdev-flushbufs"
25362 #: ../fish/guestfish-actions.pod:448
25365 " blockdev-flushbufs device\n"
25371 #: ../fish/guestfish-actions.pod:455
25372 msgid "blockdev-getbsz"
25377 #: ../fish/guestfish-actions.pod:457
25380 " blockdev-getbsz device\n"
25386 #: ../fish/guestfish-actions.pod:466
25387 msgid "blockdev-getro"
25392 #: ../fish/guestfish-actions.pod:468
25395 " blockdev-getro device\n"
25401 #: ../fish/guestfish-actions.pod:475
25402 msgid "blockdev-getsize64"
25407 #: ../fish/guestfish-actions.pod:477
25410 " blockdev-getsize64 device\n"
25416 #: ../fish/guestfish-actions.pod:481
25417 msgid "See also L</blockdev-getsz>."
25422 #: ../fish/guestfish-actions.pod:485
25423 msgid "blockdev-getss"
25428 #: ../fish/guestfish-actions.pod:487
25431 " blockdev-getss device\n"
25437 #: ../fish/guestfish-actions.pod:492
25439 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25444 #: ../fish/guestfish-actions.pod:497
25445 msgid "blockdev-getsz"
25450 #: ../fish/guestfish-actions.pod:499
25453 " blockdev-getsz device\n"
25459 #: ../fish/guestfish-actions.pod:504
25461 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25462 "blockdev-getsize64> for the more useful I<size in bytes>."
25467 #: ../fish/guestfish-actions.pod:510
25468 msgid "blockdev-rereadpt"
25473 #: ../fish/guestfish-actions.pod:512
25476 " blockdev-rereadpt device\n"
25482 #: ../fish/guestfish-actions.pod:518
25483 msgid "blockdev-setbsz"
25488 #: ../fish/guestfish-actions.pod:520
25491 " blockdev-setbsz device blocksize\n"
25497 #: ../fish/guestfish-actions.pod:529
25498 msgid "blockdev-setro"
25503 #: ../fish/guestfish-actions.pod:531
25506 " blockdev-setro device\n"
25512 #: ../fish/guestfish-actions.pod:537
25513 msgid "blockdev-setrw"
25518 #: ../fish/guestfish-actions.pod:539
25521 " blockdev-setrw device\n"
25527 #: ../fish/guestfish-actions.pod:545
25528 msgid "case-sensitive-path"
25533 #: ../fish/guestfish-actions.pod:547
25536 " case-sensitive-path path\n"
25542 #: ../fish/guestfish-actions.pod:571
25544 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25545 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25546 "the directories were originally created under Windows)."
25551 #: ../fish/guestfish-actions.pod:579
25552 msgid "See also L</realpath>."
25557 #: ../fish/guestfish-actions.pod:581
25563 #: ../fish/guestfish-actions.pod:583
25572 #: ../fish/guestfish-actions.pod:587
25574 "Note that this function cannot correctly handle binary files (specifically, "
25575 "files containing C<\\0> character which is treated as end of string). For "
25576 "those you need to use the L</read-file> or L</download> functions which have "
25577 "a more complex interface."
25582 #: ../fish/guestfish-actions.pod:595
25588 #: ../fish/guestfish-actions.pod:597
25591 " checksum csumtype path\n"
25597 #: ../fish/guestfish-actions.pod:640
25598 msgid "To get the checksum for a device, use L</checksum-device>."
25603 #: ../fish/guestfish-actions.pod:642
25604 msgid "To get the checksums for many files, use L</checksums-out>."
25609 #: ../fish/guestfish-actions.pod:644
25610 msgid "checksum-device"
25615 #: ../fish/guestfish-actions.pod:646
25618 " checksum-device csumtype device\n"
25624 #: ../fish/guestfish-actions.pod:648
25626 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25627 "device named C<device>. For the types of checksums supported see the L</"
25628 "checksum> command."
25633 #: ../fish/guestfish-actions.pod:652
25634 msgid "checksums-out"
25639 #: ../fish/guestfish-actions.pod:654
25642 " checksums-out csumtype directory (sumsfile|-)\n"
25648 #: ../fish/guestfish-actions.pod:670
25654 #: ../fish/guestfish-actions.pod:672
25657 " chmod mode path\n"
25663 #: ../fish/guestfish-actions.pod:683
25669 #: ../fish/guestfish-actions.pod:685
25672 " chown owner group path\n"
25678 #: ../fish/guestfish-actions.pod:693
25684 #: ../fish/guestfish-actions.pod:695
25687 " command 'arguments ...'\n"
25693 #: ../fish/guestfish-actions.pod:702
25695 "The single parameter is an argv-style list of arguments. The first element "
25696 "is the name of the program to run. Subsequent elements are parameters. The "
25697 "list must be non-empty (ie. must contain a program name). Note that the "
25698 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25703 #: ../fish/guestfish-actions.pod:730
25704 msgid "command-lines"
25709 #: ../fish/guestfish-actions.pod:732
25712 " command-lines 'arguments ...'\n"
25718 #: ../fish/guestfish-actions.pod:734
25720 "This is the same as L</command>, but splits the result into a list of lines."
25725 #: ../fish/guestfish-actions.pod:737
25726 msgid "See also: L</sh-lines>"
25731 #: ../fish/guestfish-actions.pod:742
25737 #: ../fish/guestfish-actions.pod:744
25740 " config qemuparam qemuvalue\n"
25746 #: ../fish/guestfish-actions.pod:755
25752 #: ../fish/guestfish-actions.pod:757
25755 " copy-size src dest size\n"
25761 #: ../fish/guestfish-actions.pod:765
25767 #: ../fish/guestfish-actions.pod:767
25776 #: ../fish/guestfish-actions.pod:772
25782 #: ../fish/guestfish-actions.pod:774
25791 #: ../fish/guestfish-actions.pod:779
25797 #: ../fish/guestfish-actions.pod:781
25806 #: ../fish/guestfish-actions.pod:788
25808 "If the destination is a device, it must be as large or larger than the "
25809 "source file or device, otherwise the copy will fail. This command cannot do "
25810 "partial copies (see L</copy-size>)."
25815 #: ../fish/guestfish-actions.pod:792
25821 #: ../fish/guestfish-actions.pod:794
25830 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
25832 "This command is mostly useful for interactive sessions. It is I<not> "
25833 "intended that you try to parse the output string. Use L</statvfs> from "
25839 #: ../fish/guestfish-actions.pod:802
25845 #: ../fish/guestfish-actions.pod:804
25854 #: ../fish/guestfish-actions.pod:813
25860 #: ../fish/guestfish-actions.pod:815
25869 #: ../fish/guestfish-actions.pod:821
25871 "Another way to get the same information is to enable verbose messages with "
25872 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25873 "before running the program."
25878 #: ../fish/guestfish-actions.pod:826
25884 #: ../fish/guestfish-actions.pod:828
25887 " download remotefilename (filename|-)\n"
25893 #: ../fish/guestfish-actions.pod:835
25894 msgid "See also L</upload>, L</cat>."
25899 #: ../fish/guestfish-actions.pod:839
25900 msgid "download-offset"
25905 #: ../fish/guestfish-actions.pod:841
25908 " download-offset remotefilename (filename|-) offset size\n"
25914 #: ../fish/guestfish-actions.pod:849
25916 "Note that there is no limit on the amount of data that can be downloaded "
25917 "with this call, unlike with L</pread>, and this call always reads the full "
25918 "amount unless an error occurs."
25923 #: ../fish/guestfish-actions.pod:854
25924 msgid "See also L</download>, L</pread>."
25929 #: ../fish/guestfish-actions.pod:858
25930 msgid "drop-caches"
25935 #: ../fish/guestfish-actions.pod:860
25938 " drop-caches whattodrop\n"
25944 #: ../fish/guestfish-actions.pod:872
25950 #: ../fish/guestfish-actions.pod:874
25959 #: ../fish/guestfish-actions.pod:886
25965 #: ../fish/guestfish-actions.pod:888
25968 " e2fsck-f device\n"
25974 #: ../fish/guestfish-actions.pod:894
25976 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25977 "should use L</fsck>."
25982 #: ../fish/guestfish-actions.pod:897
25983 msgid "echo-daemon"
25988 #: ../fish/guestfish-actions.pod:899
25991 " echo-daemon 'words ...'\n"
25997 #: ../fish/guestfish-actions.pod:906
25998 msgid "See also L</ping-daemon>."
26003 #: ../fish/guestfish-actions.pod:908
26009 #: ../fish/guestfish-actions.pod:910
26012 " egrep regex path\n"
26018 #: ../fish/guestfish-actions.pod:918
26024 #: ../fish/guestfish-actions.pod:920
26027 " egrepi regex path\n"
26033 #: ../fish/guestfish-actions.pod:928
26039 #: ../fish/guestfish-actions.pod:930
26042 " equal file1 file2\n"
26048 #: ../fish/guestfish-actions.pod:937
26054 #: ../fish/guestfish-actions.pod:939
26063 #: ../fish/guestfish-actions.pod:944
26064 msgid "See also L</is-file>, L</is-dir>, L</stat>."
26069 #: ../fish/guestfish-actions.pod:946
26075 #: ../fish/guestfish-actions.pod:948
26078 " fallocate path len\n"
26084 #: ../fish/guestfish-actions.pod:965
26085 msgid "fallocate64"
26090 #: ../fish/guestfish-actions.pod:967
26093 " fallocate64 path len\n"
26099 #: ../fish/guestfish-actions.pod:973
26101 "Note that this call allocates disk blocks for the file. To create a sparse "
26102 "file use L</truncate-size> instead."
26107 #: ../fish/guestfish-actions.pod:976
26109 "The deprecated call L</fallocate> does the same, but owing to an oversight "
26110 "it only allowed 30 bit lengths to be specified, effectively limiting the "
26111 "maximum size of files created through that call to 1GB."
26116 #: ../fish/guestfish-actions.pod:985
26122 #: ../fish/guestfish-actions.pod:987
26125 " fgrep pattern path\n"
26131 #: ../fish/guestfish-actions.pod:995
26137 #: ../fish/guestfish-actions.pod:997
26140 " fgrepi pattern path\n"
26146 #: ../fish/guestfish-actions.pod:1005
26152 #: ../fish/guestfish-actions.pod:1007
26160 #: ../fish/guestfish-actions.pod:1023
26162 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
26163 "(etc), L</is-zero>."
26168 #: ../fish/guestfish-actions.pod:1026
26169 msgid "file-architecture"
26174 #: ../fish/guestfish-actions.pod:1028
26177 " file-architecture filename\n"
26183 #: ../fish/guestfish-actions.pod:1131
26189 #: ../fish/guestfish-actions.pod:1133
26198 #: ../fish/guestfish-actions.pod:1137
26200 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
26201 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
26206 #: ../fish/guestfish-actions.pod:1141
26212 #: ../fish/guestfish-actions.pod:1143
26215 " fill c len path\n"
26221 #: ../fish/guestfish-actions.pod:1149
26223 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26224 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
26225 "L</fill-pattern>."
26230 #: ../fish/guestfish-actions.pod:1154
26231 msgid "fill-pattern"
26236 #: ../fish/guestfish-actions.pod:1156
26239 " fill-pattern pattern len path\n"
26245 #: ../fish/guestfish-actions.pod:1158
26247 "This function is like L</fill> except that it creates a new file of length "
26248 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
26249 "is truncated if necessary to ensure the length of the file is exactly C<len> "
26255 #: ../fish/guestfish-actions.pod:1163
26261 #: ../fish/guestfish-actions.pod:1165
26264 " find directory\n"
26270 #: ../fish/guestfish-actions.pod:1179
26271 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
26276 #: ../fish/guestfish-actions.pod:1192
26277 msgid "See also L</find0>."
26282 #: ../fish/guestfish-actions.pod:1197
26288 #: ../fish/guestfish-actions.pod:1199
26291 " find0 directory (files|-)\n"
26297 #: ../fish/guestfish-actions.pod:1205
26299 "This command works the same way as L</find> with the following exceptions:"
26304 #: ../fish/guestfish-actions.pod:1232
26305 msgid "findfs-label"
26310 #: ../fish/guestfish-actions.pod:1234
26313 " findfs-label label\n"
26319 #: ../fish/guestfish-actions.pod:1240
26320 msgid "To find the label of a filesystem, use L</vfs-label>."
26325 #: ../fish/guestfish-actions.pod:1242
26326 msgid "findfs-uuid"
26331 #: ../fish/guestfish-actions.pod:1244
26334 " findfs-uuid uuid\n"
26340 #: ../fish/guestfish-actions.pod:1250
26341 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26346 #: ../fish/guestfish-actions.pod:1252
26352 #: ../fish/guestfish-actions.pod:1254
26355 " fsck fstype device\n"
26361 #: ../fish/guestfish-actions.pod:1284
26367 #: ../fish/guestfish-actions.pod:1286
26375 #: ../fish/guestfish-actions.pod:1293
26376 msgid "get-attach-method"
26380 #: ../fish/guestfish-actions.pod:1295
26383 " get-attach-method\n"
26388 #: ../fish/guestfish-actions.pod:1297
26389 msgid "Return the current attach method. See L</set-attach-method>."
26394 #: ../fish/guestfish-actions.pod:1299
26395 msgid "get-autosync"
26400 #: ../fish/guestfish-actions.pod:1301
26409 #: ../fish/guestfish-actions.pod:1305
26415 #: ../fish/guestfish-actions.pod:1307
26424 #: ../fish/guestfish-actions.pod:1311
26425 msgid "get-e2label"
26430 #: ../fish/guestfish-actions.pod:1313
26433 " get-e2label device\n"
26439 #: ../fish/guestfish-actions.pod:1325
26445 #: ../fish/guestfish-actions.pod:1327
26448 " get-e2uuid device\n"
26454 #: ../fish/guestfish-actions.pod:1339
26455 msgid "get-memsize"
26460 #: ../fish/guestfish-actions.pod:1341
26469 #: ../fish/guestfish-actions.pod:1346
26471 "If L</set-memsize> was not called on this handle, and if "
26472 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26473 "value for memsize."
26478 #: ../fish/guestfish-actions.pod:1353
26479 msgid "get-network"
26484 #: ../fish/guestfish-actions.pod:1355
26493 #: ../fish/guestfish-actions.pod:1359
26499 #: ../fish/guestfish-actions.pod:1361
26508 #: ../fish/guestfish-actions.pod:1368
26514 #: ../fish/guestfish-actions.pod:1370
26520 #: ../fish/guestfish-actions.pod:1372
26529 #: ../fish/guestfish-actions.pod:1379
26535 #: ../fish/guestfish-actions.pod:1381
26544 #: ../fish/guestfish-actions.pod:1388
26545 msgid "get-recovery-proc"
26550 #: ../fish/guestfish-actions.pod:1390
26553 " get-recovery-proc\n"
26559 #: ../fish/guestfish-actions.pod:1394
26560 msgid "get-selinux"
26565 #: ../fish/guestfish-actions.pod:1396
26574 #: ../fish/guestfish-actions.pod:1398
26576 "This returns the current setting of the selinux flag which is passed to the "
26577 "appliance at boot time. See L</set-selinux>."
26582 #: ../fish/guestfish-actions.pod:1404
26588 #: ../fish/guestfish-actions.pod:1406
26597 #: ../fish/guestfish-actions.pod:1413
26603 #: ../fish/guestfish-actions.pod:1415
26612 #: ../fish/guestfish-actions.pod:1419
26618 #: ../fish/guestfish-actions.pod:1421
26627 #: ../fish/guestfish-actions.pod:1423
26629 "Return the current umask. By default the umask is C<022> unless it has been "
26630 "set by calling L</umask>."
26635 #: ../fish/guestfish-actions.pod:1426
26636 msgid "get-verbose"
26641 #: ../fish/guestfish-actions.pod:1428
26650 #: ../fish/guestfish-actions.pod:1432
26656 #: ../fish/guestfish-actions.pod:1434
26665 #: ../fish/guestfish-actions.pod:1438
26666 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26671 #: ../fish/guestfish-actions.pod:1441
26677 #: ../fish/guestfish-actions.pod:1443
26680 " getxattr path name\n"
26686 #: ../fish/guestfish-actions.pod:1445
26688 "Get a single extended attribute from file C<path> named C<name>. This call "
26689 "follows symlinks. If you want to lookup an extended attribute for the "
26690 "symlink itself, use L</lgetxattr>."
26695 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
26697 "Normally it is better to get all extended attributes from a file in one go "
26698 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26699 "buggy and do not provide a way to list out attributes. For these "
26700 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26701 "attributes you want in advance and call this function."
26706 #: ../fish/guestfish-actions.pod:1459
26707 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26712 #: ../fish/guestfish-actions.pod:1461
26718 #: ../fish/guestfish-actions.pod:1463
26721 " getxattrs path\n"
26727 #: ../fish/guestfish-actions.pod:1471
26728 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26733 #: ../fish/guestfish-actions.pod:1473
26734 msgid "glob-expand"
26739 #: ../fish/guestfish-actions.pod:1475
26742 " glob-expand pattern\n"
26748 #: ../fish/guestfish-actions.pod:1488
26754 #: ../fish/guestfish-actions.pod:1490
26757 " grep regex path\n"
26763 #: ../fish/guestfish-actions.pod:1498
26769 #: ../fish/guestfish-actions.pod:1500
26772 " grepi regex path\n"
26778 #: ../fish/guestfish-actions.pod:1508
26779 msgid "grub-install"
26784 #: ../fish/guestfish-actions.pod:1510
26787 " grub-install root device\n"
26793 #: ../fish/guestfish-actions.pod:1526
26799 #: ../fish/guestfish-actions.pod:1528
26808 #: ../fish/guestfish-actions.pod:1536
26814 #: ../fish/guestfish-actions.pod:1538
26817 " head-n nrlines path\n"
26823 #: ../fish/guestfish-actions.pod:1551
26829 #: ../fish/guestfish-actions.pod:1553
26838 #: ../fish/guestfish-actions.pod:1561
26844 #: ../fish/guestfish-actions.pod:1563
26847 " initrd-cat initrdpath filename\n"
26853 #: ../fish/guestfish-actions.pod:1575
26854 msgid "See also L</initrd-list>."
26859 #: ../fish/guestfish-actions.pod:1580
26860 msgid "initrd-list"
26865 #: ../fish/guestfish-actions.pod:1582
26868 " initrd-list path\n"
26874 #: ../fish/guestfish-actions.pod:1594
26875 msgid "inotify-add-watch"
26880 #: ../fish/guestfish-actions.pod:1596
26883 " inotify-add-watch path mask\n"
26889 #: ../fish/guestfish-actions.pod:1608
26890 msgid "inotify-close"
26895 #: ../fish/guestfish-actions.pod:1610
26904 #: ../fish/guestfish-actions.pod:1616
26905 msgid "inotify-files"
26910 #: ../fish/guestfish-actions.pod:1618
26919 #: ../fish/guestfish-actions.pod:1620
26921 "This function is a helpful wrapper around L</inotify-read> which just "
26922 "returns a list of pathnames of objects that were touched. The returned "
26923 "pathnames are sorted and deduplicated."
26928 #: ../fish/guestfish-actions.pod:1624
26929 msgid "inotify-init"
26934 #: ../fish/guestfish-actions.pod:1626
26937 " inotify-init maxevents\n"
26943 #: ../fish/guestfish-actions.pod:1632
26945 "C<maxevents> is the maximum number of events which will be queued up between "
26946 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26947 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26948 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26949 "but records the fact that it threw them away by setting a flag "
26950 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26955 #: ../fish/guestfish-actions.pod:1642
26957 "Before any events are generated, you have to add some watches to the "
26958 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26959 "L</inotify-watch-all>."
26964 #: ../fish/guestfish-actions.pod:1648
26966 "Queued up events should be read periodically by calling L</inotify-read> (or "
26967 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26968 "If you don't read the events out often enough then you risk the internal "
26969 "queue overflowing."
26974 #: ../fish/guestfish-actions.pod:1655
26976 "The handle should be closed after use by calling L</inotify-close>. This "
26977 "also removes any watches automatically."
26982 #: ../fish/guestfish-actions.pod:1664
26983 msgid "inotify-read"
26988 #: ../fish/guestfish-actions.pod:1666
26997 #: ../fish/guestfish-actions.pod:1679
26998 msgid "inotify-rm-watch"
27003 #: ../fish/guestfish-actions.pod:1681
27006 " inotify-rm-watch wd\n"
27012 #: ../fish/guestfish-actions.pod:1683
27013 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
27018 #: ../fish/guestfish-actions.pod:1686
27019 msgid "inspect-get-arch"
27024 #: ../fish/guestfish-actions.pod:1688
27027 " inspect-get-arch root\n"
27033 #: ../fish/guestfish-actions.pod:1690
27035 "This returns the architecture of the inspected operating system. The "
27036 "possible return values are listed under L</file-architecture>."
27041 #: ../fish/guestfish-actions.pod:1699
27042 msgid "inspect-get-distro"
27047 #: ../fish/guestfish-actions.pod:1701
27050 " inspect-get-distro root\n"
27055 #: ../fish/guestfish-actions.pod:1782
27056 msgid "inspect-get-drive-mappings"
27060 #: ../fish/guestfish-actions.pod:1784
27063 " inspect-get-drive-mappings root\n"
27068 #: ../fish/guestfish-actions.pod:1811
27070 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27071 "get-mountpoints>, L</inspect-get-filesystems>."
27076 #: ../fish/guestfish-actions.pod:1815
27077 msgid "inspect-get-filesystems"
27082 #: ../fish/guestfish-actions.pod:1817
27085 " inspect-get-filesystems root\n"
27091 #: ../fish/guestfish-actions.pod:1827
27093 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27094 "get-mountpoints>."
27098 #: ../fish/guestfish-actions.pod:1830
27099 msgid "inspect-get-format"
27103 #: ../fish/guestfish-actions.pod:1832
27106 " inspect-get-format root\n"
27112 #: ../fish/guestfish-actions.pod:1861
27113 msgid "inspect-get-hostname"
27118 #: ../fish/guestfish-actions.pod:1863
27121 " inspect-get-hostname root\n"
27126 #: ../fish/guestfish-actions.pod:1873
27127 msgid "inspect-get-icon"
27131 #: ../fish/guestfish-actions.pod:1875
27134 " inspect-get-icon root [favicon:..] [highquality:..]\n"
27140 #: ../fish/guestfish-actions.pod:1939
27141 msgid "inspect-get-major-version"
27146 #: ../fish/guestfish-actions.pod:1941
27149 " inspect-get-major-version root\n"
27155 #: ../fish/guestfish-actions.pod:1957
27156 msgid "inspect-get-minor-version"
27161 #: ../fish/guestfish-actions.pod:1959
27164 " inspect-get-minor-version root\n"
27170 #: ../fish/guestfish-actions.pod:1966
27172 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27173 "get-major-version>."
27178 #: ../fish/guestfish-actions.pod:1969
27179 msgid "inspect-get-mountpoints"
27184 #: ../fish/guestfish-actions.pod:1971
27187 " inspect-get-mountpoints root\n"
27192 #: ../fish/guestfish-actions.pod:1990
27194 "For operating systems like Windows which still use drive letters, this call "
27195 "will only return an entry for the first drive \"mounted on\" C</>. For "
27196 "information about the mapping of drive letters to partitions, see L</inspect-"
27197 "get-drive-mappings>."
27202 #: ../fish/guestfish-actions.pod:1996
27204 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27205 "get-filesystems>."
27210 #: ../fish/guestfish-actions.pod:1999
27211 msgid "inspect-get-package-format"
27216 #: ../fish/guestfish-actions.pod:2001
27219 " inspect-get-package-format root\n"
27225 #: ../fish/guestfish-actions.pod:2003
27227 "This function and L</inspect-get-package-management> return the package "
27228 "format and package management tool used by the inspected operating system. "
27229 "For example for Fedora these functions would return C<rpm> (package format) "
27230 "and C<yum> (package management)."
27235 #: ../fish/guestfish-actions.pod:2018
27236 msgid "inspect-get-package-management"
27241 #: ../fish/guestfish-actions.pod:2020
27244 " inspect-get-package-management root\n"
27250 #: ../fish/guestfish-actions.pod:2022
27252 "L</inspect-get-package-format> and this function return the package format "
27253 "and package management tool used by the inspected operating system. For "
27254 "example for Fedora these functions would return C<rpm> (package format) and "
27255 "C<yum> (package management)."
27260 #: ../fish/guestfish-actions.pod:2039
27261 msgid "inspect-get-product-name"
27266 #: ../fish/guestfish-actions.pod:2041
27269 " inspect-get-product-name root\n"
27274 #: ../fish/guestfish-actions.pod:2053
27275 msgid "inspect-get-product-variant"
27279 #: ../fish/guestfish-actions.pod:2055
27282 " inspect-get-product-variant root\n"
27287 #: ../fish/guestfish-actions.pod:2076
27289 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27290 "get-product-name>, L</inspect-get-major-version>."
27295 #: ../fish/guestfish-actions.pod:2080
27296 msgid "inspect-get-roots"
27301 #: ../fish/guestfish-actions.pod:2082
27304 " inspect-get-roots\n"
27310 #: ../fish/guestfish-actions.pod:2084
27312 "This function is a convenient way to get the list of root devices, as "
27313 "returned from a previous call to L</inspect-os>, but without redoing the "
27314 "whole inspection process."
27319 #: ../fish/guestfish-actions.pod:2088
27321 "This returns an empty list if either no root devices were found or the "
27322 "caller has not called L</inspect-os>."
27327 #: ../fish/guestfish-actions.pod:2093
27328 msgid "inspect-get-type"
27333 #: ../fish/guestfish-actions.pod:2095
27336 " inspect-get-type root\n"
27341 #: ../fish/guestfish-actions.pod:2125
27342 msgid "inspect-get-windows-current-control-set"
27346 #: ../fish/guestfish-actions.pod:2127
27349 " inspect-get-windows-current-control-set root\n"
27355 #: ../fish/guestfish-actions.pod:2138
27356 msgid "inspect-get-windows-systemroot"
27361 #: ../fish/guestfish-actions.pod:2140
27364 " inspect-get-windows-systemroot root\n"
27369 #: ../fish/guestfish-actions.pod:2151
27370 msgid "inspect-is-live"
27374 #: ../fish/guestfish-actions.pod:2153
27377 " inspect-is-live root\n"
27382 #: ../fish/guestfish-actions.pod:2155
27384 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27385 "then this returns true if a live image was detected on the disk."
27389 #: ../fish/guestfish-actions.pod:2161
27390 msgid "inspect-is-multipart"
27394 #: ../fish/guestfish-actions.pod:2163
27397 " inspect-is-multipart root\n"
27402 #: ../fish/guestfish-actions.pod:2165
27404 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27405 "then this returns true if the disk is part of a set."
27409 #: ../fish/guestfish-actions.pod:2171
27410 msgid "inspect-is-netinst"
27414 #: ../fish/guestfish-actions.pod:2173
27417 " inspect-is-netinst root\n"
27422 #: ../fish/guestfish-actions.pod:2175
27424 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27425 "then this returns true if the disk is a network installer, ie. not a self-"
27426 "contained install CD but one which is likely to require network access to "
27427 "complete the install."
27432 #: ../fish/guestfish-actions.pod:2183
27433 msgid "inspect-list-applications"
27438 #: ../fish/guestfish-actions.pod:2185
27441 " inspect-list-applications root\n"
27447 #: ../fish/guestfish-actions.pod:2189
27449 "I<Note:> This call works differently from other parts of the inspection "
27450 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27451 "then mount up the disks, before calling this. Listing applications is a "
27452 "significantly more difficult operation which requires access to the full "
27453 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27454 "are just returning data cached in the libguestfs handle, this call actually "
27455 "reads parts of the mounted filesystems during the call."
27460 #: ../fish/guestfish-actions.pod:2279
27466 #: ../fish/guestfish-actions.pod:2281
27475 #: ../fish/guestfish-actions.pod:2296
27477 "You can pass the root string(s) returned to other L</inspect-get-*> "
27478 "functions in order to query further information about each operating system, "
27479 "such as the name and version."
27484 #: ../fish/guestfish-actions.pod:2301
27486 "This function uses other libguestfs features such as L</mount-ro> and L</"
27487 "umount-all> in order to mount and unmount filesystems and look at the "
27488 "contents. This should be called with no disks currently mounted. The "
27489 "function may also use Augeas, so any existing Augeas handle will be closed."
27494 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
27495 #: ../fish/guestfish-actions.pod:2557
27496 msgid "See also L</list-filesystems>."
27501 #: ../fish/guestfish-actions.pod:2315
27502 msgid "is-blockdev"
27507 #: ../fish/guestfish-actions.pod:2317
27510 " is-blockdev path\n"
27516 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
27517 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
27518 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
27519 #: ../fish/guestfish-actions.pod:2421
27520 msgid "See also L</stat>."
27525 #: ../fish/guestfish-actions.pod:2324
27531 #: ../fish/guestfish-actions.pod:2326
27540 #: ../fish/guestfish-actions.pod:2333
27546 #: ../fish/guestfish-actions.pod:2335
27549 " is-chardev path\n"
27555 #: ../fish/guestfish-actions.pod:2342
27561 #: ../fish/guestfish-actions.pod:2344
27570 #: ../fish/guestfish-actions.pod:2351
27576 #: ../fish/guestfish-actions.pod:2353
27585 #: ../fish/guestfish-actions.pod:2361
27591 #: ../fish/guestfish-actions.pod:2363
27600 #: ../fish/guestfish-actions.pod:2370
27606 #: ../fish/guestfish-actions.pod:2372
27615 #: ../fish/guestfish-actions.pod:2380
27616 msgid "is-launching"
27621 #: ../fish/guestfish-actions.pod:2382
27630 #: ../fish/guestfish-actions.pod:2389
27636 #: ../fish/guestfish-actions.pod:2391
27645 #: ../fish/guestfish-actions.pod:2396
27651 #: ../fish/guestfish-actions.pod:2398
27660 #: ../fish/guestfish-actions.pod:2405
27666 #: ../fish/guestfish-actions.pod:2407
27669 " is-socket path\n"
27675 #: ../fish/guestfish-actions.pod:2414
27681 #: ../fish/guestfish-actions.pod:2416
27684 " is-symlink path\n"
27689 #: ../fish/guestfish-actions.pod:2423
27694 #: ../fish/guestfish-actions.pod:2425
27702 #: ../fish/guestfish-actions.pod:2430
27703 msgid "is-zero-device"
27707 #: ../fish/guestfish-actions.pod:2432
27710 " is-zero-device device\n"
27716 #: ../fish/guestfish-actions.pod:2438
27717 msgid "kill-subprocess"
27722 #: ../fish/guestfish-actions.pod:2440
27725 " kill-subprocess\n"
27731 #: ../fish/guestfish-actions.pod:2444
27737 #: ../fish/guestfish-actions.pod:2446
27743 #: ../fish/guestfish-actions.pod:2448
27752 #: ../fish/guestfish-actions.pod:2456
27758 #: ../fish/guestfish-actions.pod:2458
27761 " lchown owner group path\n"
27767 #: ../fish/guestfish-actions.pod:2460
27769 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27770 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27776 #: ../fish/guestfish-actions.pod:2468
27782 #: ../fish/guestfish-actions.pod:2470
27785 " lgetxattr path name\n"
27791 #: ../fish/guestfish-actions.pod:2486
27792 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27797 #: ../fish/guestfish-actions.pod:2488
27803 #: ../fish/guestfish-actions.pod:2490
27806 " lgetxattrs path\n"
27812 #: ../fish/guestfish-actions.pod:2492
27814 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27815 "it returns the extended attributes of the link itself."
27819 #: ../fish/guestfish-actions.pod:2496
27824 #: ../fish/guestfish-actions.pod:2498
27833 #: ../fish/guestfish-actions.pod:2503
27834 msgid "list-devices"
27839 #: ../fish/guestfish-actions.pod:2505
27848 #: ../fish/guestfish-actions.pod:2513
27849 msgid "list-filesystems"
27854 #: ../fish/guestfish-actions.pod:2515
27857 " list-filesystems\n"
27863 #: ../fish/guestfish-actions.pod:2534
27865 "This command runs other libguestfs commands, which might include L</mount> "
27866 "and L</umount>, and therefore you should use this soon after launch and only "
27867 "when nothing is mounted."
27872 #: ../fish/guestfish-actions.pod:2538
27874 "Not all of the filesystems returned will be mountable. In particular, swap "
27875 "partitions are returned in the list. Also this command does not check that "
27876 "each filesystem found is valid and mountable, and some filesystems might be "
27877 "mountable but require special options. Filesystems may not all belong to a "
27878 "single logical operating system (use L</inspect-os> to look for OSes)."
27883 #: ../fish/guestfish-actions.pod:2546
27884 msgid "list-partitions"
27889 #: ../fish/guestfish-actions.pod:2548
27892 " list-partitions\n"
27898 #: ../fish/guestfish-actions.pod:2554
27900 "This does not return logical volumes. For that you will need to call L</"
27906 #: ../fish/guestfish-actions.pod:2559
27912 #: ../fish/guestfish-actions.pod:2561
27921 #: ../fish/guestfish-actions.pod:2569
27927 #: ../fish/guestfish-actions.pod:2571
27930 " ln target linkname\n"
27936 #: ../fish/guestfish-actions.pod:2575
27942 #: ../fish/guestfish-actions.pod:2577
27945 " ln-f target linkname\n"
27951 #: ../fish/guestfish-actions.pod:2582
27957 #: ../fish/guestfish-actions.pod:2584
27960 " ln-s target linkname\n"
27966 #: ../fish/guestfish-actions.pod:2588
27972 #: ../fish/guestfish-actions.pod:2590
27975 " ln-sf target linkname\n"
27981 #: ../fish/guestfish-actions.pod:2595
27982 msgid "lremovexattr"
27987 #: ../fish/guestfish-actions.pod:2597
27990 " lremovexattr xattr path\n"
27996 #: ../fish/guestfish-actions.pod:2599
27998 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27999 "it removes an extended attribute of the link itself."
28004 #: ../fish/guestfish-actions.pod:2603
28010 #: ../fish/guestfish-actions.pod:2605
28019 #: ../fish/guestfish-actions.pod:2611
28021 "This command is mostly useful for interactive sessions. Programs should "
28022 "probably use L</readdir> instead."
28027 #: ../fish/guestfish-actions.pod:2614
28033 #: ../fish/guestfish-actions.pod:2616
28036 " lsetxattr xattr val vallen path\n"
28042 #: ../fish/guestfish-actions.pod:2618
28044 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
28045 "sets an extended attribute of the link itself."
28050 #: ../fish/guestfish-actions.pod:2622
28056 #: ../fish/guestfish-actions.pod:2624
28065 #: ../fish/guestfish-actions.pod:2628
28067 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
28068 "the link is stat-ed, not the file it refers to."
28073 #: ../fish/guestfish-actions.pod:2634
28079 #: ../fish/guestfish-actions.pod:2636
28082 " lstatlist path 'names ...'\n"
28088 #: ../fish/guestfish-actions.pod:2638
28090 "This call allows you to perform the L</lstat> operation on multiple files, "
28091 "where all files are in the directory C<path>. C<names> is the list of files "
28092 "from this directory."
28097 #: ../fish/guestfish-actions.pod:2647
28099 "This call is intended for programs that want to efficiently list a directory "
28100 "contents without making many round-trips. See also L</lxattrlist> for a "
28101 "similarly efficient call for getting extended attributes. Very long "
28102 "directory listings might cause the protocol message size to be exceeded, "
28103 "causing this call to fail. The caller must split up such requests into "
28104 "smaller groups of names."
28109 #: ../fish/guestfish-actions.pod:2655
28110 msgid "luks-add-key"
28115 #: ../fish/guestfish-actions.pod:2657
28118 " luks-add-key device keyslot\n"
28124 #: ../fish/guestfish-actions.pod:2664
28126 "Note that if C<keyslot> already contains a key, then this command will "
28127 "fail. You have to use L</luks-kill-slot> first to remove that key."
28132 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2690
28133 #: ../fish/guestfish-actions.pod:2703 ../fish/guestfish-actions.pod:2717
28134 #: ../fish/guestfish-actions.pod:2740 ../fish/guestfish-actions.pod:2750
28136 "This command has one or more key or passphrase parameters. Guestfish will "
28137 "prompt for these separately."
28142 #: ../fish/guestfish-actions.pod:2671
28148 #: ../fish/guestfish-actions.pod:2673
28151 " luks-close device\n"
28157 #: ../fish/guestfish-actions.pod:2675
28159 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
28160 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
28161 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
28167 #: ../fish/guestfish-actions.pod:2681
28168 msgid "luks-format"
28173 #: ../fish/guestfish-actions.pod:2683
28176 " luks-format device keyslot\n"
28182 #: ../fish/guestfish-actions.pod:2696
28183 msgid "luks-format-cipher"
28188 #: ../fish/guestfish-actions.pod:2698
28191 " luks-format-cipher device keyslot cipher\n"
28197 #: ../fish/guestfish-actions.pod:2700
28199 "This command is the same as L</luks-format> but it also allows you to set "
28200 "the C<cipher> used."
28205 #: ../fish/guestfish-actions.pod:2709
28206 msgid "luks-kill-slot"
28211 #: ../fish/guestfish-actions.pod:2711
28214 " luks-kill-slot device keyslot\n"
28220 #: ../fish/guestfish-actions.pod:2720
28226 #: ../fish/guestfish-actions.pod:2722
28229 " luks-open device mapname\n"
28235 #: ../fish/guestfish-actions.pod:2736
28237 "If this block device contains LVM volume groups, then calling L</vgscan> "
28238 "followed by L</vg-activate-all> will make them visible."
28243 #: ../fish/guestfish-actions.pod:2743
28244 msgid "luks-open-ro"
28249 #: ../fish/guestfish-actions.pod:2745
28252 " luks-open-ro device mapname\n"
28258 #: ../fish/guestfish-actions.pod:2747
28260 "This is the same as L</luks-open> except that a read-only mapping is created."
28265 #: ../fish/guestfish-actions.pod:2753
28271 #: ../fish/guestfish-actions.pod:2755
28274 " lvcreate logvol volgroup mbytes\n"
28280 #: ../fish/guestfish-actions.pod:2760
28281 msgid "lvm-canonical-lv-name"
28286 #: ../fish/guestfish-actions.pod:2762
28289 " lvm-canonical-lv-name lvname\n"
28295 #: ../fish/guestfish-actions.pod:2771
28296 msgid "See also L</is-lv>."
28301 #: ../fish/guestfish-actions.pod:2773
28302 msgid "lvm-clear-filter"
28307 #: ../fish/guestfish-actions.pod:2775
28310 " lvm-clear-filter\n"
28316 #: ../fish/guestfish-actions.pod:2777
28318 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
28324 #: ../fish/guestfish-actions.pod:2783
28325 msgid "lvm-remove-all"
28330 #: ../fish/guestfish-actions.pod:2785
28333 " lvm-remove-all\n"
28339 #: ../fish/guestfish-actions.pod:2793
28340 msgid "lvm-set-filter"
28345 #: ../fish/guestfish-actions.pod:2795
28348 " lvm-set-filter 'devices ...'\n"
28354 #: ../fish/guestfish-actions.pod:2820
28360 #: ../fish/guestfish-actions.pod:2822
28363 " lvremove device\n"
28369 #: ../fish/guestfish-actions.pod:2830
28375 #: ../fish/guestfish-actions.pod:2832
28378 " lvrename logvol newlogvol\n"
28384 #: ../fish/guestfish-actions.pod:2836
28390 #: ../fish/guestfish-actions.pod:2838
28393 " lvresize device mbytes\n"
28399 #: ../fish/guestfish-actions.pod:2844
28400 msgid "lvresize-free"
28405 #: ../fish/guestfish-actions.pod:2846
28408 " lvresize-free lv percent\n"
28414 #: ../fish/guestfish-actions.pod:2854
28420 #: ../fish/guestfish-actions.pod:2856
28429 #: ../fish/guestfish-actions.pod:2864
28430 msgid "See also L</lvs-full>, L</list-filesystems>."
28435 #: ../fish/guestfish-actions.pod:2866
28441 #: ../fish/guestfish-actions.pod:2868
28450 #: ../fish/guestfish-actions.pod:2873
28456 #: ../fish/guestfish-actions.pod:2875
28465 #: ../fish/guestfish-actions.pod:2879
28471 #: ../fish/guestfish-actions.pod:2881
28474 " lxattrlist path 'names ...'\n"
28480 #: ../fish/guestfish-actions.pod:2897
28482 "This call is intended for programs that want to efficiently list a directory "
28483 "contents without making many round-trips. See also L</lstatlist> for a "
28484 "similarly efficient call for getting standard stats. Very long directory "
28485 "listings might cause the protocol message size to be exceeded, causing this "
28486 "call to fail. The caller must split up such requests into smaller groups of "
28492 #: ../fish/guestfish-actions.pod:2905
28498 #: ../fish/guestfish-actions.pod:2907
28507 #: ../fish/guestfish-actions.pod:2911
28513 #: ../fish/guestfish-actions.pod:2913
28516 " mkdir-mode path mode\n"
28522 #: ../fish/guestfish-actions.pod:2922
28523 msgid "See also L</mkdir>, L</umask>"
28528 #: ../fish/guestfish-actions.pod:2924
28534 #: ../fish/guestfish-actions.pod:2926
28543 #: ../fish/guestfish-actions.pod:2931
28549 #: ../fish/guestfish-actions.pod:2933
28552 " mkdtemp template\n"
28558 #: ../fish/guestfish-actions.pod:2954
28564 #: ../fish/guestfish-actions.pod:2956
28567 " mke2fs-J fstype blocksize device journal\n"
28573 #: ../fish/guestfish-actions.pod:2964
28574 msgid "See also L</mke2journal>."
28579 #: ../fish/guestfish-actions.pod:2966
28585 #: ../fish/guestfish-actions.pod:2968
28588 " mke2fs-JL fstype blocksize device label\n"
28594 #: ../fish/guestfish-actions.pod:2973
28595 msgid "See also L</mke2journal-L>."
28600 #: ../fish/guestfish-actions.pod:2975
28606 #: ../fish/guestfish-actions.pod:2977
28609 " mke2fs-JU fstype blocksize device uuid\n"
28615 #: ../fish/guestfish-actions.pod:2982
28616 msgid "See also L</mke2journal-U>."
28621 #: ../fish/guestfish-actions.pod:2984
28622 msgid "mke2journal"
28627 #: ../fish/guestfish-actions.pod:2986
28630 " mke2journal blocksize device\n"
28636 #: ../fish/guestfish-actions.pod:2993
28637 msgid "mke2journal-L"
28642 #: ../fish/guestfish-actions.pod:2995
28645 " mke2journal-L blocksize label device\n"
28651 #: ../fish/guestfish-actions.pod:2999
28652 msgid "mke2journal-U"
28657 #: ../fish/guestfish-actions.pod:3001
28660 " mke2journal-U blocksize uuid device\n"
28666 #: ../fish/guestfish-actions.pod:3005
28672 #: ../fish/guestfish-actions.pod:3007
28675 " mkfifo mode path\n"
28681 #: ../fish/guestfish-actions.pod:3009
28683 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28684 "is just a convenient wrapper around L</mknod>."
28689 #: ../fish/guestfish-actions.pod:3015
28695 #: ../fish/guestfish-actions.pod:3017
28698 " mkfs fstype device\n"
28704 #: ../fish/guestfish-actions.pod:3023
28710 #: ../fish/guestfish-actions.pod:3025
28713 " mkfs-b fstype blocksize device\n"
28719 #: ../fish/guestfish-actions.pod:3027
28721 "This call is similar to L</mkfs>, but it allows you to control the block "
28722 "size of the resulting filesystem. Supported block sizes depend on the "
28723 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28728 #: ../fish/guestfish-actions.pod:3042
28733 #: ../fish/guestfish-actions.pod:3044
28736 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28742 #: ../fish/guestfish-actions.pod:3079
28743 msgid "mkmountpoint"
28748 #: ../fish/guestfish-actions.pod:3081
28751 " mkmountpoint exemptpath\n"
28757 #: ../fish/guestfish-actions.pod:3083
28759 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28760 "to create extra mountpoints before mounting the first filesystem."
28765 #: ../fish/guestfish-actions.pod:3107
28767 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28768 "unexpected errors if you try to mix these calls. It is safest to manually "
28769 "unmount filesystems and remove mountpoints after use."
28774 #: ../fish/guestfish-actions.pod:3111
28776 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28777 "for this to work for manual mountpoints, you must ensure that the innermost "
28778 "mountpoints have the longest pathnames, as in the example code above."
28782 #: ../fish/guestfish-actions.pod:3118
28784 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28785 "L</umount-all> to be called when the handle is closed which can also trigger "
28791 #: ../fish/guestfish-actions.pod:3122
28797 #: ../fish/guestfish-actions.pod:3124
28800 " mknod mode devmajor devminor path\n"
28806 #: ../fish/guestfish-actions.pod:3134
28808 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28809 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28810 "regular file). These constants are available in the standard Linux header "
28811 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28812 "wrappers around this command which bitwise OR in the appropriate constant "
28818 #: ../fish/guestfish-actions.pod:3144
28824 #: ../fish/guestfish-actions.pod:3146
28827 " mknod-b mode devmajor devminor path\n"
28833 #: ../fish/guestfish-actions.pod:3148
28835 "This call creates a block device node called C<path> with mode C<mode> and "
28836 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28837 "wrapper around L</mknod>."
28842 #: ../fish/guestfish-actions.pod:3154
28848 #: ../fish/guestfish-actions.pod:3156
28851 " mknod-c mode devmajor devminor path\n"
28857 #: ../fish/guestfish-actions.pod:3158
28859 "This call creates a char device node called C<path> with mode C<mode> and "
28860 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28861 "wrapper around L</mknod>."
28866 #: ../fish/guestfish-actions.pod:3164
28872 #: ../fish/guestfish-actions.pod:3166
28881 #: ../fish/guestfish-actions.pod:3170
28887 #: ../fish/guestfish-actions.pod:3172
28890 " mkswap-L label device\n"
28896 #: ../fish/guestfish-actions.pod:3180
28902 #: ../fish/guestfish-actions.pod:3182
28905 " mkswap-U uuid device\n"
28911 #: ../fish/guestfish-actions.pod:3186
28912 msgid "mkswap-file"
28917 #: ../fish/guestfish-actions.pod:3188
28920 " mkswap-file path\n"
28926 #: ../fish/guestfish-actions.pod:3192
28928 "This command just writes a swap file signature to an existing file. To "
28929 "create the file itself, use something like L</fallocate>."
28934 #: ../fish/guestfish-actions.pod:3195
28940 #: ../fish/guestfish-actions.pod:3197
28943 " modprobe modulename\n"
28949 #: ../fish/guestfish-actions.pod:3204
28955 #: ../fish/guestfish-actions.pod:3206
28958 " mount device mountpoint\n"
28964 #: ../fish/guestfish-actions.pod:3222
28966 "B<Important note:> When you use this call, the filesystem options C<sync> "
28967 "and C<noatime> are set implicitly. This was originally done because we "
28968 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28969 "very large negative performance impact and negligible effect on "
28970 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28971 "code that needs performance, and instead use L</mount-options> (use an empty "
28972 "string for the first parameter if you don't want any options)."
28976 #: ../fish/guestfish-actions.pod:3239
28981 #: ../fish/guestfish-actions.pod:3241
28984 " mount-9p mounttag mountpoint [options:..]\n"
28990 #: ../fish/guestfish-actions.pod:3252
28996 #: ../fish/guestfish-actions.pod:3254
28999 " mount-loop file mountpoint\n"
29005 #: ../fish/guestfish-actions.pod:3260
29006 msgid "mount-options"
29011 #: ../fish/guestfish-actions.pod:3262
29014 " mount-options options device mountpoint\n"
29020 #: ../fish/guestfish-actions.pod:3264
29022 "This is the same as the L</mount> command, but it allows you to set the "
29023 "mount options as for the L<mount(8)> I<-o> flag."
29028 #: ../fish/guestfish-actions.pod:3272
29034 #: ../fish/guestfish-actions.pod:3274
29037 " mount-ro device mountpoint\n"
29043 #: ../fish/guestfish-actions.pod:3276
29045 "This is the same as the L</mount> command, but it mounts the filesystem with "
29046 "the read-only (I<-o ro>) flag."
29051 #: ../fish/guestfish-actions.pod:3279
29057 #: ../fish/guestfish-actions.pod:3281
29060 " mount-vfs options vfstype device mountpoint\n"
29066 #: ../fish/guestfish-actions.pod:3283
29068 "This is the same as the L</mount> command, but it allows you to set both the "
29069 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
29074 #: ../fish/guestfish-actions.pod:3287
29075 msgid "mountpoints"
29080 #: ../fish/guestfish-actions.pod:3289
29089 #: ../fish/guestfish-actions.pod:3291
29091 "This call is similar to L</mounts>. That call returns a list of devices. "
29092 "This one returns a hash table (map) of device name to directory where the "
29093 "device is mounted."
29098 #: ../fish/guestfish-actions.pod:3295
29104 #: ../fish/guestfish-actions.pod:3297
29113 #: ../fish/guestfish-actions.pod:3304
29114 msgid "See also: L</mountpoints>"
29119 #: ../fish/guestfish-actions.pod:3306
29125 #: ../fish/guestfish-actions.pod:3308
29134 #: ../fish/guestfish-actions.pod:3313
29135 msgid "ntfs-3g-probe"
29140 #: ../fish/guestfish-actions.pod:3315
29143 " ntfs-3g-probe true|false device\n"
29149 #: ../fish/guestfish-actions.pod:3329
29155 #: ../fish/guestfish-actions.pod:3331
29158 " ntfsresize device\n"
29164 #: ../fish/guestfish-actions.pod:3337
29165 msgid "ntfsresize-size"
29170 #: ../fish/guestfish-actions.pod:3339
29173 " ntfsresize-size device size\n"
29179 #: ../fish/guestfish-actions.pod:3341
29181 "This command is the same as L</ntfsresize> except that it allows you to "
29182 "specify the new size (in bytes) explicitly."
29187 #: ../fish/guestfish-actions.pod:3344
29193 #: ../fish/guestfish-actions.pod:3346
29196 " part-add device prlogex startsect endsect\n"
29202 #: ../fish/guestfish-actions.pod:3348
29204 "This command adds a partition to C<device>. If there is no partition table "
29205 "on the device, call L</part-init> first."
29210 #: ../fish/guestfish-actions.pod:3360
29212 "Creating a partition which covers the whole disk is not so easy. Use L</"
29213 "part-disk> to do that."
29218 #: ../fish/guestfish-actions.pod:3363
29224 #: ../fish/guestfish-actions.pod:3365
29227 " part-del device partnum\n"
29233 #: ../fish/guestfish-actions.pod:3373
29239 #: ../fish/guestfish-actions.pod:3375
29242 " part-disk device parttype\n"
29248 #: ../fish/guestfish-actions.pod:3377
29250 "This command is simply a combination of L</part-init> followed by L</part-"
29251 "add> to create a single primary partition covering the whole disk."
29256 #: ../fish/guestfish-actions.pod:3381
29258 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29259 "possible values are described in L</part-init>."
29264 #: ../fish/guestfish-actions.pod:3387
29265 msgid "part-get-bootable"
29270 #: ../fish/guestfish-actions.pod:3389
29273 " part-get-bootable device partnum\n"
29279 #: ../fish/guestfish-actions.pod:3394
29280 msgid "See also L</part-set-bootable>."
29285 #: ../fish/guestfish-actions.pod:3396
29286 msgid "part-get-mbr-id"
29291 #: ../fish/guestfish-actions.pod:3398
29294 " part-get-mbr-id device partnum\n"
29300 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3541
29302 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29303 "undefined results for other partition table types (see L</part-get-"
29309 #: ../fish/guestfish-actions.pod:3407
29310 msgid "part-get-parttype"
29315 #: ../fish/guestfish-actions.pod:3409
29318 " part-get-parttype device\n"
29324 #: ../fish/guestfish-actions.pod:3414
29326 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29327 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29328 "possible, although unusual. See L</part-init> for a full list."
29333 #: ../fish/guestfish-actions.pod:3419
29339 #: ../fish/guestfish-actions.pod:3421
29342 " part-init device parttype\n"
29348 #: ../fish/guestfish-actions.pod:3427
29350 "Initially there are no partitions. Following this, you should call L</part-"
29351 "add> for each partition required."
29356 #: ../fish/guestfish-actions.pod:3490
29362 #: ../fish/guestfish-actions.pod:3492
29365 " part-list device\n"
29371 #: ../fish/guestfish-actions.pod:3507
29373 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29374 "the device's sector size, see L</blockdev-getss>."
29379 #: ../fish/guestfish-actions.pod:3520
29380 msgid "part-set-bootable"
29385 #: ../fish/guestfish-actions.pod:3522
29388 " part-set-bootable device partnum true|false\n"
29394 #: ../fish/guestfish-actions.pod:3531
29395 msgid "part-set-mbr-id"
29400 #: ../fish/guestfish-actions.pod:3533
29403 " part-set-mbr-id device partnum idbyte\n"
29409 #: ../fish/guestfish-actions.pod:3545
29410 msgid "part-set-name"
29415 #: ../fish/guestfish-actions.pod:3547
29418 " part-set-name device partnum name\n"
29424 #: ../fish/guestfish-actions.pod:3555
29425 msgid "part-to-dev"
29430 #: ../fish/guestfish-actions.pod:3557
29433 " part-to-dev partition\n"
29439 #: ../fish/guestfish-actions.pod:3563
29441 "The named partition must exist, for example as a string returned from L</"
29442 "list-partitions>."
29447 #: ../fish/guestfish-actions.pod:3566
29448 msgid "ping-daemon"
29453 #: ../fish/guestfish-actions.pod:3568
29462 #: ../fish/guestfish-actions.pod:3575
29468 #: ../fish/guestfish-actions.pod:3577
29471 " pread path count offset\n"
29477 #: ../fish/guestfish-actions.pod:3585
29478 msgid "See also L</pwrite>, L</pread-device>."
29483 #: ../fish/guestfish-actions.pod:3590
29484 msgid "pread-device"
29489 #: ../fish/guestfish-actions.pod:3592
29492 " pread-device device count offset\n"
29498 #: ../fish/guestfish-actions.pod:3600
29499 msgid "See also L</pread>."
29504 #: ../fish/guestfish-actions.pod:3605
29510 #: ../fish/guestfish-actions.pod:3607
29513 " pvcreate device\n"
29519 #: ../fish/guestfish-actions.pod:3613
29525 #: ../fish/guestfish-actions.pod:3615
29528 " pvremove device\n"
29534 #: ../fish/guestfish-actions.pod:3624
29540 #: ../fish/guestfish-actions.pod:3626
29543 " pvresize device\n"
29549 #: ../fish/guestfish-actions.pod:3631
29550 msgid "pvresize-size"
29555 #: ../fish/guestfish-actions.pod:3633
29558 " pvresize-size device size\n"
29564 #: ../fish/guestfish-actions.pod:3635
29566 "This command is the same as L</pvresize> except that it allows you to "
29567 "specify the new size (in bytes) explicitly."
29572 #: ../fish/guestfish-actions.pod:3638
29578 #: ../fish/guestfish-actions.pod:3640
29587 #: ../fish/guestfish-actions.pod:3648
29588 msgid "See also L</pvs-full>."
29593 #: ../fish/guestfish-actions.pod:3650
29599 #: ../fish/guestfish-actions.pod:3652
29608 #: ../fish/guestfish-actions.pod:3657
29614 #: ../fish/guestfish-actions.pod:3659
29623 #: ../fish/guestfish-actions.pod:3663
29629 #: ../fish/guestfish-actions.pod:3665
29632 " pwrite path content offset\n"
29638 #: ../fish/guestfish-actions.pod:3676
29639 msgid "See also L</pread>, L</pwrite-device>."
29644 #: ../fish/guestfish-actions.pod:3681
29645 msgid "pwrite-device"
29650 #: ../fish/guestfish-actions.pod:3683
29653 " pwrite-device device content offset\n"
29659 #: ../fish/guestfish-actions.pod:3693
29660 msgid "See also L</pwrite>."
29665 #: ../fish/guestfish-actions.pod:3698
29671 #: ../fish/guestfish-actions.pod:3700
29674 " read-file path\n"
29680 #: ../fish/guestfish-actions.pod:3705
29682 "Unlike L</cat>, this function can correctly handle files that contain "
29683 "embedded ASCII NUL characters. However unlike L</download>, this function "
29684 "is limited in the total size of file that can be handled."
29689 #: ../fish/guestfish-actions.pod:3713
29695 #: ../fish/guestfish-actions.pod:3715
29698 " read-lines path\n"
29704 #: ../fish/guestfish-actions.pod:3722
29706 "Note that this function cannot correctly handle binary files (specifically, "
29707 "files containing C<\\0> character which is treated as end of line). For "
29708 "those you need to use the L</read-file> function which has a more complex "
29714 #: ../fish/guestfish-actions.pod:3727
29720 #: ../fish/guestfish-actions.pod:3729
29729 #: ../fish/guestfish-actions.pod:3781
29731 "This function is primarily intended for use by programs. To get a simple "
29732 "list of names, use L</ls>. To get a printable directory for human "
29733 "consumption, use L</ll>."
29738 #: ../fish/guestfish-actions.pod:3785
29744 #: ../fish/guestfish-actions.pod:3787
29753 #: ../fish/guestfish-actions.pod:3791
29754 msgid "readlinklist"
29759 #: ../fish/guestfish-actions.pod:3793
29762 " readlinklist path 'names ...'\n"
29768 #: ../fish/guestfish-actions.pod:3817
29774 #: ../fish/guestfish-actions.pod:3819
29783 #: ../fish/guestfish-actions.pod:3824
29784 msgid "removexattr"
29789 #: ../fish/guestfish-actions.pod:3826
29792 " removexattr xattr path\n"
29798 #: ../fish/guestfish-actions.pod:3831
29799 msgid "See also: L</lremovexattr>, L<attr(5)>."
29804 #: ../fish/guestfish-actions.pod:3833
29810 #: ../fish/guestfish-actions.pod:3835
29813 " resize2fs device\n"
29819 #: ../fish/guestfish-actions.pod:3840
29821 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29822 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29823 "gives an error about this and sometimes not. In any case, it is always safe "
29824 "to call L</e2fsck-f> before calling this function."
29828 #: ../fish/guestfish-actions.pod:3846
29829 msgid "resize2fs-M"
29833 #: ../fish/guestfish-actions.pod:3848
29836 " resize2fs-M device\n"
29841 #: ../fish/guestfish-actions.pod:3850
29843 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29844 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29849 #: ../fish/guestfish-actions.pod:3854
29851 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29852 "and read the C<Block size> and C<Block count> values. These two numbers, "
29853 "multiplied together, give the resulting size of the minimal filesystem in "
29859 #: ../fish/guestfish-actions.pod:3859
29860 msgid "resize2fs-size"
29865 #: ../fish/guestfish-actions.pod:3861
29868 " resize2fs-size device size\n"
29874 #: ../fish/guestfish-actions.pod:3863
29876 "This command is the same as L</resize2fs> except that it allows you to "
29877 "specify the new size (in bytes) explicitly."
29882 #: ../fish/guestfish-actions.pod:3866
29888 #: ../fish/guestfish-actions.pod:3868
29897 #: ../fish/guestfish-actions.pod:3872
29903 #: ../fish/guestfish-actions.pod:3874
29912 #: ../fish/guestfish-actions.pod:3880
29918 #: ../fish/guestfish-actions.pod:3882
29927 #: ../fish/guestfish-actions.pod:3886
29928 msgid "rmmountpoint"
29933 #: ../fish/guestfish-actions.pod:3888
29936 " rmmountpoint exemptpath\n"
29942 #: ../fish/guestfish-actions.pod:3890
29944 "This calls removes a mountpoint that was previously created with L</"
29945 "mkmountpoint>. See L</mkmountpoint> for full details."
29950 #: ../fish/guestfish-actions.pod:3894
29951 msgid "scrub-device"
29956 #: ../fish/guestfish-actions.pod:3896
29959 " scrub-device device\n"
29965 #: ../fish/guestfish-actions.pod:3907
29971 #: ../fish/guestfish-actions.pod:3909
29974 " scrub-file file\n"
29980 #: ../fish/guestfish-actions.pod:3919
29981 msgid "scrub-freespace"
29986 #: ../fish/guestfish-actions.pod:3921
29989 " scrub-freespace dir\n"
29995 #: ../fish/guestfish-actions.pod:3923
29997 "This command creates the directory C<dir> and then fills it with files until "
29998 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29999 "deletes them. The intention is to scrub any free space on the partition "
30000 "containing C<dir>."
30005 #: ../fish/guestfish-actions.pod:3932
30011 #: ../fish/guestfish-actions.pod:3934
30017 #: ../fish/guestfish-actions.pod:3936
30020 " set-append append\n"
30025 #: ../fish/guestfish-actions.pod:3947
30026 msgid "set-attach-method"
30030 #: ../fish/guestfish-actions.pod:3949
30031 msgid "attach-method"
30035 #: ../fish/guestfish-actions.pod:3951
30038 " set-attach-method attachmethod\n"
30044 #: ../fish/guestfish-actions.pod:3973
30045 msgid "set-autosync"
30050 #: ../fish/guestfish-actions.pod:3975
30056 #: ../fish/guestfish-actions.pod:3977
30059 " set-autosync true|false\n"
30065 #: ../fish/guestfish-actions.pod:3987
30071 #: ../fish/guestfish-actions.pod:3989
30077 #: ../fish/guestfish-actions.pod:3991
30080 " set-direct true|false\n"
30086 #: ../fish/guestfish-actions.pod:3997
30088 "One consequence of this is that log messages aren't caught by the library "
30089 "and handled by L</set-log-message-callback>, but go straight to stdout."
30094 #: ../fish/guestfish-actions.pod:4006
30095 msgid "set-e2label"
30100 #: ../fish/guestfish-actions.pod:4008
30103 " set-e2label device label\n"
30109 #: ../fish/guestfish-actions.pod:4014
30111 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
30112 "label on a filesystem."
30117 #: ../fish/guestfish-actions.pod:4017
30123 #: ../fish/guestfish-actions.pod:4019
30126 " set-e2uuid device uuid\n"
30132 #: ../fish/guestfish-actions.pod:4026
30134 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
30135 "UUID of a filesystem."
30140 #: ../fish/guestfish-actions.pod:4029
30141 msgid "set-memsize"
30146 #: ../fish/guestfish-actions.pod:4031
30152 #: ../fish/guestfish-actions.pod:4033
30155 " set-memsize memsize\n"
30161 #: ../fish/guestfish-actions.pod:4035
30163 "This sets the memory size in megabytes allocated to the qemu subprocess. "
30164 "This only has any effect if called before L</launch>."
30169 #: ../fish/guestfish-actions.pod:4046
30170 msgid "set-network"
30175 #: ../fish/guestfish-actions.pod:4048
30181 #: ../fish/guestfish-actions.pod:4050
30184 " set-network true|false\n"
30190 #: ../fish/guestfish-actions.pod:4058
30192 "You must call this before calling L</launch>, otherwise it has no effect."
30197 #: ../fish/guestfish-actions.pod:4061
30203 #: ../fish/guestfish-actions.pod:4063
30209 #: ../fish/guestfish-actions.pod:4065
30212 " set-path searchpath\n"
30218 #: ../fish/guestfish-actions.pod:4074
30224 #: ../fish/guestfish-actions.pod:4076
30230 #: ../fish/guestfish-actions.pod:4078
30239 #: ../fish/guestfish-actions.pod:4098
30240 msgid "set-recovery-proc"
30245 #: ../fish/guestfish-actions.pod:4100
30246 msgid "recovery-proc"
30251 #: ../fish/guestfish-actions.pod:4102
30254 " set-recovery-proc true|false\n"
30260 #: ../fish/guestfish-actions.pod:4104
30262 "If this is called with the parameter C<false> then L</launch> does not "
30263 "create a recovery process. The purpose of the recovery process is to stop "
30264 "runaway qemu processes in the case where the main program aborts abruptly."
30269 #: ../fish/guestfish-actions.pod:4109
30271 "This only has any effect if called before L</launch>, and the default is "
30277 #: ../fish/guestfish-actions.pod:4118
30278 msgid "set-selinux"
30283 #: ../fish/guestfish-actions.pod:4120
30289 #: ../fish/guestfish-actions.pod:4122
30292 " set-selinux true|false\n"
30298 #: ../fish/guestfish-actions.pod:4133
30304 #: ../fish/guestfish-actions.pod:4135
30310 #: ../fish/guestfish-actions.pod:4137
30313 " set-trace true|false\n"
30318 #: ../fish/guestfish-actions.pod:4149
30320 "Trace messages are normally sent to C<stderr>, unless you register a "
30321 "callback to send them somewhere else (see L</set-event-callback>)."
30326 #: ../fish/guestfish-actions.pod:4153
30327 msgid "set-verbose"
30332 #: ../fish/guestfish-actions.pod:4155
30338 #: ../fish/guestfish-actions.pod:4157
30341 " set-verbose true|false\n"
30346 #: ../fish/guestfish-actions.pod:4164
30348 "Verbose messages are normally sent to C<stderr>, unless you register a "
30349 "callback to send them somewhere else (see L</set-event-callback>)."
30354 #: ../fish/guestfish-actions.pod:4168
30360 #: ../fish/guestfish-actions.pod:4170
30363 " setcon context\n"
30369 #: ../fish/guestfish-actions.pod:4177
30375 #: ../fish/guestfish-actions.pod:4179
30378 " setxattr xattr val vallen path\n"
30384 #: ../fish/guestfish-actions.pod:4185
30385 msgid "See also: L</lsetxattr>, L<attr(5)>."
30390 #: ../fish/guestfish-actions.pod:4187
30396 #: ../fish/guestfish-actions.pod:4189
30399 " sfdisk device cyls heads sectors 'lines ...'\n"
30405 #: ../fish/guestfish-actions.pod:4211
30406 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30411 #: ../fish/guestfish-actions.pod:4224
30417 #: ../fish/guestfish-actions.pod:4226
30420 " sfdiskM device 'lines ...'\n"
30426 #: ../fish/guestfish-actions.pod:4228
30428 "This is a simplified interface to the L</sfdisk> command, where partition "
30429 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30430 "you don't need to specify the cyls, heads and sectors parameters which were "
30431 "rarely if ever used anyway."
30436 #: ../fish/guestfish-actions.pod:4234
30437 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30442 #: ../fish/guestfish-actions.pod:4247
30448 #: ../fish/guestfish-actions.pod:4249
30451 " sfdisk-N device partnum cyls heads sectors line\n"
30457 #: ../fish/guestfish-actions.pod:4254
30459 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30460 "cyls/heads/sectors parameters."
30465 #: ../fish/guestfish-actions.pod:4257
30466 msgid "See also: L</part-add>"
30471 #: ../fish/guestfish-actions.pod:4269
30472 msgid "sfdisk-disk-geometry"
30477 #: ../fish/guestfish-actions.pod:4271
30480 " sfdisk-disk-geometry device\n"
30486 #: ../fish/guestfish-actions.pod:4273
30488 "This displays the disk geometry of C<device> read from the partition table. "
30489 "Especially in the case where the underlying block device has been resized, "
30490 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30491 "kernel-geometry>)."
30496 #: ../fish/guestfish-actions.pod:4281
30497 msgid "sfdisk-kernel-geometry"
30502 #: ../fish/guestfish-actions.pod:4283
30505 " sfdisk-kernel-geometry device\n"
30511 #: ../fish/guestfish-actions.pod:4290
30517 #: ../fish/guestfish-actions.pod:4292
30520 " sfdisk-l device\n"
30526 #: ../fish/guestfish-actions.pod:4298
30527 msgid "See also: L</part-list>"
30532 #: ../fish/guestfish-actions.pod:4307
30538 #: ../fish/guestfish-actions.pod:4309
30547 #: ../fish/guestfish-actions.pod:4314
30548 msgid "This is like L</command>, but passes the command to:"
30553 #: ../fish/guestfish-actions.pod:4322
30554 msgid "All the provisos about L</command> apply to this call."
30559 #: ../fish/guestfish-actions.pod:4324
30565 #: ../fish/guestfish-actions.pod:4326
30568 " sh-lines command\n"
30574 #: ../fish/guestfish-actions.pod:4328
30575 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30580 #: ../fish/guestfish-actions.pod:4331
30581 msgid "See also: L</command-lines>"
30586 #: ../fish/guestfish-actions.pod:4333
30592 #: ../fish/guestfish-actions.pod:4335
30601 #: ../fish/guestfish-actions.pod:4339
30607 #: ../fish/guestfish-actions.pod:4341
30616 #: ../fish/guestfish-actions.pod:4347
30622 #: ../fish/guestfish-actions.pod:4349
30631 #: ../fish/guestfish-actions.pod:4357
30637 #: ../fish/guestfish-actions.pod:4359
30646 #: ../fish/guestfish-actions.pod:4367
30652 #: ../fish/guestfish-actions.pod:4369
30655 " strings-e encoding path\n"
30661 #: ../fish/guestfish-actions.pod:4371
30663 "This is like the L</strings> command, but allows you to specify the encoding "
30664 "of strings that are looked for in the source file C<path>."
30669 #: ../fish/guestfish-actions.pod:4381
30671 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30672 "ISO-8859-X (this is what L</strings> uses)."
30677 #: ../fish/guestfish-actions.pod:4413
30678 msgid "swapoff-device"
30683 #: ../fish/guestfish-actions.pod:4415
30686 " swapoff-device device\n"
30692 #: ../fish/guestfish-actions.pod:4417
30694 "This command disables the libguestfs appliance swap device or partition "
30695 "named C<device>. See L</swapon-device>."
30700 #: ../fish/guestfish-actions.pod:4421
30701 msgid "swapoff-file"
30706 #: ../fish/guestfish-actions.pod:4423
30709 " swapoff-file file\n"
30715 #: ../fish/guestfish-actions.pod:4427
30716 msgid "swapoff-label"
30721 #: ../fish/guestfish-actions.pod:4429
30724 " swapoff-label label\n"
30730 #: ../fish/guestfish-actions.pod:4434
30731 msgid "swapoff-uuid"
30736 #: ../fish/guestfish-actions.pod:4436
30739 " swapoff-uuid uuid\n"
30745 #: ../fish/guestfish-actions.pod:4441
30746 msgid "swapon-device"
30751 #: ../fish/guestfish-actions.pod:4443
30754 " swapon-device device\n"
30760 #: ../fish/guestfish-actions.pod:4445
30762 "This command enables the libguestfs appliance to use the swap device or "
30763 "partition named C<device>. The increased memory is made available for all "
30764 "commands, for example those run using L</command> or L</sh>."
30769 #: ../fish/guestfish-actions.pod:4457
30770 msgid "swapon-file"
30775 #: ../fish/guestfish-actions.pod:4459
30778 " swapon-file file\n"
30784 #: ../fish/guestfish-actions.pod:4461
30786 "This command enables swap to a file. See L</swapon-device> for other notes."
30791 #: ../fish/guestfish-actions.pod:4464
30792 msgid "swapon-label"
30797 #: ../fish/guestfish-actions.pod:4466
30800 " swapon-label label\n"
30806 #: ../fish/guestfish-actions.pod:4468
30808 "This command enables swap to a labeled swap partition. See L</swapon-"
30809 "device> for other notes."
30814 #: ../fish/guestfish-actions.pod:4471
30815 msgid "swapon-uuid"
30820 #: ../fish/guestfish-actions.pod:4473
30823 " swapon-uuid uuid\n"
30829 #: ../fish/guestfish-actions.pod:4475
30831 "This command enables swap to a swap partition with the given UUID. See L</"
30832 "swapon-device> for other notes."
30837 #: ../fish/guestfish-actions.pod:4478
30843 #: ../fish/guestfish-actions.pod:4480
30852 #: ../fish/guestfish-actions.pod:4488
30858 #: ../fish/guestfish-actions.pod:4490
30867 #: ../fish/guestfish-actions.pod:4498
30873 #: ../fish/guestfish-actions.pod:4500
30876 " tail-n nrlines path\n"
30882 #: ../fish/guestfish-actions.pod:4513
30888 #: ../fish/guestfish-actions.pod:4515
30891 " tar-in (tarfile|-) directory\n"
30897 #: ../fish/guestfish-actions.pod:4520
30898 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30903 #: ../fish/guestfish-actions.pod:4525
30909 #: ../fish/guestfish-actions.pod:4527
30912 " tar-out directory (tarfile|-)\n"
30918 #: ../fish/guestfish-actions.pod:4532
30919 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30924 #: ../fish/guestfish-actions.pod:4537
30930 #: ../fish/guestfish-actions.pod:4539
30933 " tgz-in (tarball|-) directory\n"
30939 #: ../fish/guestfish-actions.pod:4544
30940 msgid "To upload an uncompressed tarball, use L</tar-in>."
30945 #: ../fish/guestfish-actions.pod:4548
30951 #: ../fish/guestfish-actions.pod:4550
30954 " tgz-out directory (tarball|-)\n"
30960 #: ../fish/guestfish-actions.pod:4555
30961 msgid "To download an uncompressed tarball, use L</tar-out>."
30966 #: ../fish/guestfish-actions.pod:4559
30972 #: ../fish/guestfish-actions.pod:4561
30981 #: ../fish/guestfish-actions.pod:4570
30987 #: ../fish/guestfish-actions.pod:4572
30996 #: ../fish/guestfish-actions.pod:4577
30997 msgid "truncate-size"
31002 #: ../fish/guestfish-actions.pod:4579
31005 " truncate-size path size\n"
31011 #: ../fish/guestfish-actions.pod:4584
31013 "If the current file size is less than C<size> then the file is extended to "
31014 "the required size with zero bytes. This creates a sparse file (ie. disk "
31015 "blocks are not allocated for the file until you write to it). To create a "
31016 "non-sparse file of zeroes, use L</fallocate64> instead."
31021 #: ../fish/guestfish-actions.pod:4590
31027 #: ../fish/guestfish-actions.pod:4592
31030 " tune2fs-l device\n"
31036 #: ../fish/guestfish-actions.pod:4602
31042 #: ../fish/guestfish-actions.pod:4604
31045 " txz-in (tarball|-) directory\n"
31051 #: ../fish/guestfish-actions.pod:4611
31057 #: ../fish/guestfish-actions.pod:4613
31060 " txz-out directory (tarball|-)\n"
31066 #: ../fish/guestfish-actions.pod:4620
31072 #: ../fish/guestfish-actions.pod:4622
31081 #: ../fish/guestfish-actions.pod:4636
31082 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
31087 #: ../fish/guestfish-actions.pod:4641
31093 #: ../fish/guestfish-actions.pod:4643
31099 #: ../fish/guestfish-actions.pod:4645
31102 " umount pathordevice\n"
31108 #: ../fish/guestfish-actions.pod:4651
31114 #: ../fish/guestfish-actions.pod:4653
31115 msgid "unmount-all"
31120 #: ../fish/guestfish-actions.pod:4655
31129 #: ../fish/guestfish-actions.pod:4661
31135 #: ../fish/guestfish-actions.pod:4663
31138 " upload (filename|-) remotefilename\n"
31144 #: ../fish/guestfish-actions.pod:4670
31145 msgid "See also L</download>."
31150 #: ../fish/guestfish-actions.pod:4674
31151 msgid "upload-offset"
31156 #: ../fish/guestfish-actions.pod:4676
31159 " upload-offset (filename|-) remotefilename offset\n"
31165 #: ../fish/guestfish-actions.pod:4688
31167 "Note that there is no limit on the amount of data that can be uploaded with "
31168 "this call, unlike with L</pwrite>, and this call always writes the full "
31169 "amount unless an error occurs."
31174 #: ../fish/guestfish-actions.pod:4693
31175 msgid "See also L</upload>, L</pwrite>."
31180 #: ../fish/guestfish-actions.pod:4697
31186 #: ../fish/guestfish-actions.pod:4699
31189 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
31195 #: ../fish/guestfish-actions.pod:4718
31201 #: ../fish/guestfish-actions.pod:4720
31210 #: ../fish/guestfish-actions.pod:4747
31212 "I<Note:> Don't use this call to test for availability of features. In "
31213 "enterprise distributions we backport features from later versions into "
31214 "earlier versions, making this an unreliable way to test for features. Use "
31215 "L</available> instead."
31220 #: ../fish/guestfish-actions.pod:4753
31226 #: ../fish/guestfish-actions.pod:4755
31229 " vfs-label device\n"
31235 #: ../fish/guestfish-actions.pod:4762
31236 msgid "To find a filesystem from the label, use L</findfs-label>."
31241 #: ../fish/guestfish-actions.pod:4764
31247 #: ../fish/guestfish-actions.pod:4766
31250 " vfs-type device\n"
31256 #: ../fish/guestfish-actions.pod:4776
31262 #: ../fish/guestfish-actions.pod:4778
31265 " vfs-uuid device\n"
31271 #: ../fish/guestfish-actions.pod:4785
31272 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
31277 #: ../fish/guestfish-actions.pod:4787
31278 msgid "vg-activate"
31283 #: ../fish/guestfish-actions.pod:4789
31286 " vg-activate true|false 'volgroups ...'\n"
31292 #: ../fish/guestfish-actions.pod:4802
31293 msgid "vg-activate-all"
31298 #: ../fish/guestfish-actions.pod:4804
31301 " vg-activate-all true|false\n"
31307 #: ../fish/guestfish-actions.pod:4814
31313 #: ../fish/guestfish-actions.pod:4816
31316 " vgcreate volgroup 'physvols ...'\n"
31322 #: ../fish/guestfish-actions.pod:4821
31328 #: ../fish/guestfish-actions.pod:4823
31331 " vglvuuids vgname\n"
31337 #: ../fish/guestfish-actions.pod:4828
31339 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
31340 "logical volumes and volume groups."
31345 #: ../fish/guestfish-actions.pod:4831
31346 msgid "See also L</vgpvuuids>."
31351 #: ../fish/guestfish-actions.pod:4833
31357 #: ../fish/guestfish-actions.pod:4835
31360 " vgpvuuids vgname\n"
31366 #: ../fish/guestfish-actions.pod:4840
31368 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31369 "physical volumes and volume groups."
31374 #: ../fish/guestfish-actions.pod:4843
31375 msgid "See also L</vglvuuids>."
31380 #: ../fish/guestfish-actions.pod:4845
31386 #: ../fish/guestfish-actions.pod:4847
31389 " vgremove vgname\n"
31395 #: ../fish/guestfish-actions.pod:4854
31401 #: ../fish/guestfish-actions.pod:4856
31404 " vgrename volgroup newvolgroup\n"
31410 #: ../fish/guestfish-actions.pod:4860
31416 #: ../fish/guestfish-actions.pod:4862
31425 #: ../fish/guestfish-actions.pod:4870
31426 msgid "See also L</vgs-full>."
31431 #: ../fish/guestfish-actions.pod:4872
31437 #: ../fish/guestfish-actions.pod:4874
31446 #: ../fish/guestfish-actions.pod:4879
31452 #: ../fish/guestfish-actions.pod:4881
31461 #: ../fish/guestfish-actions.pod:4886
31467 #: ../fish/guestfish-actions.pod:4888
31476 #: ../fish/guestfish-actions.pod:4892
31482 #: ../fish/guestfish-actions.pod:4894
31491 #: ../fish/guestfish-actions.pod:4899
31497 #: ../fish/guestfish-actions.pod:4901
31506 #: ../fish/guestfish-actions.pod:4906
31512 #: ../fish/guestfish-actions.pod:4908
31521 #: ../fish/guestfish-actions.pod:4913
31527 #: ../fish/guestfish-actions.pod:4915
31530 " write path content\n"
31536 #: ../fish/guestfish-actions.pod:4923
31542 #: ../fish/guestfish-actions.pod:4925
31545 " write-file path content size\n"
31551 #: ../fish/guestfish-actions.pod:4948
31557 #: ../fish/guestfish-actions.pod:4950
31560 " zegrep regex path\n"
31566 #: ../fish/guestfish-actions.pod:4958
31572 #: ../fish/guestfish-actions.pod:4960
31575 " zegrepi regex path\n"
31581 #: ../fish/guestfish-actions.pod:4968
31587 #: ../fish/guestfish-actions.pod:4970
31595 #: ../fish/guestfish-actions.pod:4978
31596 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
31601 #: ../fish/guestfish-actions.pod:4981
31602 msgid "zero-device"
31607 #: ../fish/guestfish-actions.pod:4983
31610 " zero-device device\n"
31616 #: ../fish/guestfish-actions.pod:4985
31618 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31619 "which just zeroes the first few blocks of a device."
31624 #: ../fish/guestfish-actions.pod:4992
31630 #: ../fish/guestfish-actions.pod:4994
31633 " zerofree device\n"
31639 #: ../fish/guestfish-actions.pod:5007
31645 #: ../fish/guestfish-actions.pod:5009
31648 " zfgrep pattern path\n"
31654 #: ../fish/guestfish-actions.pod:5017
31660 #: ../fish/guestfish-actions.pod:5019
31663 " zfgrepi pattern path\n"
31669 #: ../fish/guestfish-actions.pod:5027
31675 #: ../fish/guestfish-actions.pod:5029
31678 " zfile meth path\n"
31684 #: ../fish/guestfish-actions.pod:5036
31686 "Since 1.0.63, use L</file> instead which can now process compressed files."
31691 #: ../fish/guestfish-actions.pod:5046
31697 #: ../fish/guestfish-actions.pod:5048
31700 " zgrep regex path\n"
31706 #: ../fish/guestfish-actions.pod:5056
31712 #: ../fish/guestfish-actions.pod:5058
31715 " zgrepi regex path\n"
31721 #: ../fish/guestfish-commands.pod:1
31727 #: ../fish/guestfish-commands.pod:3
31733 #: ../fish/guestfish-commands.pod:5
31736 " alloc filename size\n"
31742 #: ../fish/guestfish-commands.pod:7
31744 "This creates an empty (zeroed) file of the given size, and then adds so it "
31745 "can be further examined."
31750 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
31751 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31756 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
31757 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31762 #: ../fish/guestfish-commands.pod:14
31764 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31765 "image, see L</PREPARED DISK IMAGES>."
31770 #: ../fish/guestfish-commands.pod:17
31776 #: ../fish/guestfish-commands.pod:19
31779 " copy-in local [local ...] /remotedir\n"
31785 #: ../fish/guestfish-commands.pod:21
31787 "C<copy-in> copies local files or directories recursively into the disk "
31788 "image, placing them in the directory called C</remotedir> (which must "
31789 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31790 "other commands as necessary."
31795 #: ../fish/guestfish-commands.pod:26
31797 "Multiple local files and directories can be specified, but the last "
31798 "parameter must always be a remote directory. Wildcards cannot be used."
31803 #: ../fish/guestfish-commands.pod:30
31809 #: ../fish/guestfish-commands.pod:32
31812 " copy-out remote [remote ...] localdir\n"
31818 #: ../fish/guestfish-commands.pod:34
31820 "C<copy-out> copies remote files or directories recursively out of the disk "
31821 "image, placing them on the host disk in a local directory called C<localdir> "
31822 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31823 "download>, L</tar-out> and other commands as necessary."
31828 #: ../fish/guestfish-commands.pod:40
31830 "Multiple remote files and directories can be specified, but the last "
31831 "parameter must always be a local directory. To download to the current "
31832 "directory, use C<.> as in:"
31837 #: ../fish/guestfish-commands.pod:44
31840 " copy-out /home .\n"
31846 #: ../fish/guestfish-commands.pod:46
31848 "Wildcards cannot be used in the ordinary command, but you can use them with "
31849 "the help of L</glob> like this:"
31854 #: ../fish/guestfish-commands.pod:49
31857 " glob copy-out /home/* .\n"
31862 #: ../fish/guestfish-commands.pod:51
31867 #: ../fish/guestfish-commands.pod:53
31870 " display filename\n"
31875 #: ../fish/guestfish-commands.pod:55
31877 "Use C<display> (a graphical display program) to display an image file. It "
31878 "downloads the file, and runs C<display> on it."
31882 #: ../fish/guestfish-commands.pod:58
31884 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
31885 "environment variable. For example to use the GNOME display program:"
31889 #: ../fish/guestfish-commands.pod:61
31892 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
31897 #: ../fish/guestfish-commands.pod:63
31898 msgid "See also L<display(1)>."
31903 #: ../fish/guestfish-commands.pod:65
31909 #: ../fish/guestfish-commands.pod:67
31912 " echo [params ...]\n"
31918 #: ../fish/guestfish-commands.pod:69
31919 msgid "This echos the parameters to the terminal."
31924 #: ../fish/guestfish-commands.pod:71
31930 #: ../fish/guestfish-commands.pod:73
31936 #: ../fish/guestfish-commands.pod:75
31942 #: ../fish/guestfish-commands.pod:77
31951 #: ../fish/guestfish-commands.pod:79
31953 "This is used to edit a file. It downloads the file, edits it locally using "
31954 "your editor, then uploads the result."
31959 #: ../fish/guestfish-commands.pod:82
31961 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31962 "or C<emacs> you will get those corresponding editors."
31967 #: ../fish/guestfish-commands.pod:86
31973 #: ../fish/guestfish-commands.pod:88
31976 " glob command args...\n"
31982 #: ../fish/guestfish-commands.pod:90
31984 "Expand wildcards in any paths in the args list, and run C<command> "
31985 "repeatedly on each matching path."
31990 #: ../fish/guestfish-commands.pod:93
31991 msgid "See L</WILDCARDS AND GLOBBING>."
31996 #: ../fish/guestfish-commands.pod:95
32002 #: ../fish/guestfish-commands.pod:97
32005 " hexedit <filename|device>\n"
32006 " hexedit <filename|device> <max>\n"
32007 " hexedit <filename|device> <start> <max>\n"
32013 #: ../fish/guestfish-commands.pod:101
32015 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
32021 #: ../fish/guestfish-commands.pod:104
32023 "This command works by downloading potentially the whole file or device, "
32024 "editing it locally, then uploading it. If the file or device is large, you "
32025 "have to specify which part you wish to edit by using C<max> and/or C<start> "
32026 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
32027 "usual modifiers allowed such as C<1M> (1 megabyte)."
32032 #: ../fish/guestfish-commands.pod:111
32033 msgid "For example to edit the first few sectors of a disk you might do:"
32038 #: ../fish/guestfish-commands.pod:114
32041 " hexedit /dev/sda 1M\n"
32047 #: ../fish/guestfish-commands.pod:116
32049 "which would allow you to edit anywhere within the first megabyte of the disk."
32054 #: ../fish/guestfish-commands.pod:119
32055 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
32060 #: ../fish/guestfish-commands.pod:121
32063 " hexedit /dev/sda1 0x400 0x400\n"
32069 #: ../fish/guestfish-commands.pod:123
32070 msgid "(assuming the superblock is in the standard location)."
32075 #: ../fish/guestfish-commands.pod:125
32077 "This command requires the external L<hexedit(1)> program. You can specify "
32078 "another program to use by setting the C<HEXEDITOR> environment variable."
32083 #: ../fish/guestfish-commands.pod:129
32084 msgid "See also L</hexdump>."
32089 #: ../fish/guestfish-commands.pod:131
32095 #: ../fish/guestfish-commands.pod:133
32104 #: ../fish/guestfish-commands.pod:135
32106 "Change the local directory, ie. the current directory of guestfish itself."
32111 #: ../fish/guestfish-commands.pod:138
32112 msgid "Note that C<!cd> won't do what you might expect."
32117 #: ../fish/guestfish-commands.pod:140
32123 #: ../fish/guestfish-commands.pod:142
32129 #: ../fish/guestfish-commands.pod:144
32138 #: ../fish/guestfish-commands.pod:146
32139 msgid "Opens the manual page for guestfish."
32144 #: ../fish/guestfish-commands.pod:148
32150 #: ../fish/guestfish-commands.pod:150
32156 #: ../fish/guestfish-commands.pod:152
32165 #: ../fish/guestfish-commands.pod:154
32174 #: ../fish/guestfish-commands.pod:156
32175 msgid "This is used to view a file."
32180 #: ../fish/guestfish-commands.pod:158
32182 "The default viewer is C<$PAGER>. However if you use the alternate command "
32183 "C<less> you will get the C<less> command specifically."
32188 #: ../fish/guestfish-commands.pod:161
32194 #: ../fish/guestfish-commands.pod:163
32203 #: ../fish/guestfish-commands.pod:165
32205 "Close and reopen the libguestfs handle. It is not necessary to use this "
32206 "normally, because the handle is closed properly when guestfish exits. "
32207 "However this is occasionally useful for testing."
32212 #: ../fish/guestfish-commands.pod:169
32218 #: ../fish/guestfish-commands.pod:171
32221 " sparse filename size\n"
32227 #: ../fish/guestfish-commands.pod:173
32229 "This creates an empty sparse file of the given size, and then adds so it can "
32230 "be further examined."
32235 #: ../fish/guestfish-commands.pod:176
32237 "In all respects it works the same as the L</alloc> command, except that the "
32238 "image file is allocated sparsely, which means that disk blocks are not "
32239 "assigned to the file until they are needed. Sparse disk files only use "
32240 "space when written to, but they are slower and there is a danger you could "
32241 "run out of real disk space during a write operation."
32246 #: ../fish/guestfish-commands.pod:186
32252 #: ../fish/guestfish-commands.pod:188
32261 #: ../fish/guestfish-commands.pod:190
32263 "This command returns a list of the optional groups known to the daemon, and "
32264 "indicates which ones are supported by this build of the libguestfs appliance."
32269 #: ../fish/guestfish-commands.pod:194
32270 msgid "See also L<guestfs(3)/AVAILABILITY>."
32275 #: ../fish/guestfish-commands.pod:196
32281 #: ../fish/guestfish-commands.pod:198
32284 " time command args...\n"
32290 #: ../fish/guestfish-commands.pod:200
32292 "Run the command as usual, but print the elapsed time afterwards. This can "
32293 "be useful for benchmarking operations."
32298 #: ../test-tool/libguestfs-test-tool.pod:5
32299 msgid "libguestfs-test-tool - End user tests for libguestfs"
32304 #: ../test-tool/libguestfs-test-tool.pod:9
32307 " libguestfs-test-tool [--options]\n"
32313 #: ../test-tool/libguestfs-test-tool.pod:13
32315 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
32316 "and developers, to allow them to check basic libguestfs functionality is "
32317 "working. This is needed because libguestfs occasionally breaks for reasons "
32318 "beyond our control: usually because of changes in the underlying qemu or "
32319 "kernel packages, or the host environment."
32324 #: ../test-tool/libguestfs-test-tool.pod:20
32325 msgid "If you suspect a problem in libguestfs, then just run:"
32330 #: ../test-tool/libguestfs-test-tool.pod:22
32333 " libguestfs-test-tool\n"
32339 #: ../test-tool/libguestfs-test-tool.pod:24
32340 msgid "It will print lots of diagnostic messages."
32345 #: ../test-tool/libguestfs-test-tool.pod:26
32346 msgid "If it runs to completion successfully, you will see this near the end:"
32351 #: ../test-tool/libguestfs-test-tool.pod:28
32354 " ===== TEST FINISHED OK =====\n"
32360 #: ../test-tool/libguestfs-test-tool.pod:30
32361 msgid "and the test tool will exit with code 0."
32366 #: ../test-tool/libguestfs-test-tool.pod:32
32368 "If it fails (and/or exits with non-zero error code), please paste the "
32369 "B<complete, unedited> output of the test tool into a bug report. More "
32370 "information about reporting bugs can be found on the L<http://libguestfs.org/"
32376 #: ../test-tool/libguestfs-test-tool.pod:41
32382 #: ../test-tool/libguestfs-test-tool.pod:43
32383 msgid "Display short usage information and exit."
32388 #: ../test-tool/libguestfs-test-tool.pod:45
32389 msgid "I<--qemu qemu_binary>"
32394 #: ../test-tool/libguestfs-test-tool.pod:47
32396 "If you have downloaded another qemu binary, point this option at the full "
32397 "path of the binary to try it."
32402 #: ../test-tool/libguestfs-test-tool.pod:50
32403 msgid "I<--qemudir qemu_source_dir>"
32408 #: ../test-tool/libguestfs-test-tool.pod:52
32410 "If you have compiled qemu from source, point this option at the source "
32411 "directory to try it."
32416 #: ../test-tool/libguestfs-test-tool.pod:55
32417 msgid "I<--timeout N>"
32422 #: ../test-tool/libguestfs-test-tool.pod:57
32424 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32425 "does not usually need to be adjusted unless your machine is very slow."
32430 #: ../test-tool/libguestfs-test-tool.pod:63
32431 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32436 #: ../test-tool/libguestfs-test-tool.pod:65
32438 "If you have compiled another version of qemu from source and would like to "
32439 "try that, then you can use the I<--qemudir> option to point to the qemu "
32440 "source directory."
32445 #: ../test-tool/libguestfs-test-tool.pod:69
32447 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32448 "option to point to the binary."
32453 #: ../test-tool/libguestfs-test-tool.pod:72
32455 "When using an alternate qemu with libguestfs, usually you would need to "
32456 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32457 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32458 "use either of the I<--qemudir> or I<--qemu> options."
32463 #: ../test-tool/libguestfs-test-tool.pod:79
32465 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32466 "I<1> if there was an error."
32471 #: ../test-tool/libguestfs-test-tool.pod:84
32473 "For the full list of environment variables which may affect libguestfs, "
32474 "please see the L<guestfs(3)> manual page."
32479 #: ../test-tool/libguestfs-test-tool.pod:89
32480 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32485 #: ../fuse/guestmount.pod:5
32487 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32492 #: ../fuse/guestmount.pod:9
32495 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32501 #: ../fuse/guestmount.pod:11
32504 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32510 #: ../fuse/guestmount.pod:13
32513 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32519 #: ../fuse/guestmount.pod:17
32521 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32522 "machines. If you do this, you risk disk corruption in the VM."
32527 #: ../fuse/guestmount.pod:22
32529 "The guestmount program can be used to mount virtual machine filesystems and "
32530 "other disk images on the host. It uses libguestfs for access to the guest "
32531 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32532 "a mountable device."
32537 #: ../fuse/guestmount.pod:27
32539 "Along with other options, you have to give at least one device (I<-a> "
32540 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32541 "option) or use the I<-i> inspection option. How this works is better "
32542 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32548 #: ../fuse/guestmount.pod:33
32550 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32551 "by you, and the filesystem will not be visible to any other users unless you "
32552 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32553 "the filesystem, use the C<fusermount -u> command."
32558 #: ../fuse/guestmount.pod:41
32560 "For a typical Windows guest which has its main filesystem on the first "
32566 #: ../fuse/guestmount.pod:44
32569 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32575 #: ../fuse/guestmount.pod:46
32577 "For a typical Linux guest which has a /boot filesystem on the first "
32578 "partition, and the root filesystem on a logical volume:"
32583 #: ../fuse/guestmount.pod:49
32586 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32592 #: ../fuse/guestmount.pod:51
32593 msgid "To get libguestfs to detect guest mountpoints for you:"
32598 #: ../fuse/guestmount.pod:53
32601 " guestmount -a guest.img -i --ro /mnt\n"
32607 #: ../fuse/guestmount.pod:55
32608 msgid "For a libvirt guest called \"Guest\" you could do:"
32613 #: ../fuse/guestmount.pod:57
32616 " guestmount -d Guest -i --ro /mnt\n"
32622 #: ../fuse/guestmount.pod:59
32624 "If you don't know what filesystems are contained in a guest or disk image, "
32625 "use L<virt-filesystems(1)> first:"
32630 #: ../fuse/guestmount.pod:62
32633 " virt-filesystems MyGuest\n"
32639 #: ../fuse/guestmount.pod:64
32641 "If you want to trace the libguestfs calls but without excessive debugging "
32642 "information, we recommend:"
32647 #: ../fuse/guestmount.pod:67
32650 " guestmount [...] --trace /mnt\n"
32656 #: ../fuse/guestmount.pod:69
32657 msgid "If you want to debug the program, we recommend:"
32662 #: ../fuse/guestmount.pod:71
32665 " guestmount [...] --trace --verbose /mnt\n"
32670 #: ../fuse/guestmount.pod:73
32675 #: ../fuse/guestmount.pod:75
32676 msgid "Other users cannot see the filesystem by default"
32680 #: ../fuse/guestmount.pod:77
32682 "If you mount a filesystem as one user (eg. root), then other users will not "
32683 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32684 "option when mounting:"
32688 #: ../fuse/guestmount.pod:81
32691 " sudo guestmount [...] -o allow_other /mnt\n"
32697 #: ../fuse/guestmount.pod:87
32698 msgid "B<-a image> | B<--add image>"
32703 #: ../fuse/guestmount.pod:89
32704 msgid "Add a block device or virtual machine image."
32709 #: ../fuse/guestmount.pod:94
32710 msgid "B<-c URI> | B<--connect URI>"
32715 #: ../fuse/guestmount.pod:100
32716 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32721 #: ../fuse/guestmount.pod:108
32722 msgid "B<--dir-cache-timeout N>"
32727 #: ../fuse/guestmount.pod:110
32729 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32730 "seconds. The readdir cache [actually, there are several semi-independent "
32731 "caches] is populated after a readdir(2) call with the stat and extended "
32732 "attributes of the files in the directory, in anticipation that they will be "
32733 "requested soon after."
32738 #: ../fuse/guestmount.pod:116
32740 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32741 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32742 "requests, only cache existing ones."
32747 #: ../fuse/guestmount.pod:127
32748 msgid "B<--format=raw|qcow2|..> | B<--format>"
32753 #: ../fuse/guestmount.pod:134
32755 "If you have untrusted raw-format guest disk images, you should use this "
32756 "option to specify the disk format. This avoids a possible security problem "
32757 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32758 "guestfs_add_drive_opts>."
32763 #: ../fuse/guestmount.pod:139
32764 msgid "B<--fuse-help>"
32769 #: ../fuse/guestmount.pod:141
32770 msgid "Display help on special FUSE options (see I<-o> below)."
32775 #: ../fuse/guestmount.pod:145
32776 msgid "Display brief help and exit."
32781 #: ../fuse/guestmount.pod:147
32782 msgid "B<-i> | B<--inspector>"
32787 #: ../fuse/guestmount.pod:167
32789 "Mount the named partition or logical volume on the given mountpoint B<in the "
32790 "guest> (this has nothing to do with mountpoints in the host)."
32795 #: ../fuse/guestmount.pod:170
32797 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32798 "something on C</>."
32803 #: ../fuse/guestmount.pod:183
32804 msgid "B<-n> | B<--no-sync>"
32809 #: ../fuse/guestmount.pod:185
32811 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32812 "unmounted. If you specify this option, then we don't attempt to sync the "
32813 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32818 #: ../fuse/guestmount.pod:190
32819 msgid "B<-o option> | B<--option option>"
32824 #: ../fuse/guestmount.pod:192
32825 msgid "Pass extra options to FUSE."
32830 #: ../fuse/guestmount.pod:194
32832 "To get a list of all the extra options supported by FUSE, use the command "
32833 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32834 "of them are a good idea."
32839 #: ../fuse/guestmount.pod:198
32842 " guestmount --fuse-help\n"
32848 #: ../fuse/guestmount.pod:200
32849 msgid "Some potentially useful FUSE options:"
32854 #: ../fuse/guestmount.pod:204
32855 msgid "B<-o allow_other>"
32860 #: ../fuse/guestmount.pod:206
32861 msgid "Allow other users to see the filesystem."
32866 #: ../fuse/guestmount.pod:208
32867 msgid "B<-o attr_timeout=N>"
32872 #: ../fuse/guestmount.pod:210
32873 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32878 #: ../fuse/guestmount.pod:212
32879 msgid "B<-o kernel_cache>"
32884 #: ../fuse/guestmount.pod:214
32886 "Allow the kernel to cache files (reduces the number of reads that have to go "
32887 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32888 "afford the extra memory usage."
32893 #: ../fuse/guestmount.pod:218
32894 msgid "B<-o uid=N> B<-o gid=N>"
32899 #: ../fuse/guestmount.pod:220
32901 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32902 "the chosen values."
32907 #: ../fuse/guestmount.pod:225
32908 msgid "B<-r> | B<--ro>"
32913 #: ../fuse/guestmount.pod:227
32915 "Add devices and mount everything read-only. Also disallow writes and make "
32916 "the disk appear read-only to FUSE."
32921 #: ../fuse/guestmount.pod:230
32923 "This is highly recommended if you are not going to edit the guest disk. If "
32924 "the guest is running and this option is I<not> supplied, then there is a "
32925 "strong risk of disk corruption in the guest. We try to prevent this from "
32926 "happening, but it is not always possible."
32931 #: ../fuse/guestmount.pod:235
32932 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32937 #: ../fuse/guestmount.pod:239
32938 msgid "Enable SELinux support for the guest."
32943 #: ../fuse/guestmount.pod:241
32944 msgid "B<-v> | B<--verbose>"
32949 #: ../fuse/guestmount.pod:243
32950 msgid "Enable verbose messages from underlying libguestfs."
32955 #: ../fuse/guestmount.pod:245
32956 msgid "B<-V> | B<--version>"
32961 #: ../fuse/guestmount.pod:247
32962 msgid "Display the program version and exit."
32967 #: ../fuse/guestmount.pod:249
32968 msgid "B<-w> | B<--rw>"
32972 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
32973 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32978 #: ../fuse/guestmount.pod:256
32979 msgid "B<-x> | B<--trace>"
32984 #: ../fuse/guestmount.pod:258
32985 msgid "Trace libguestfs calls and entry into each FUSE function."
32990 #: ../fuse/guestmount.pod:260
32991 msgid "This also stops the daemon from forking into the background."
32996 #: ../fuse/guestmount.pod:281
32998 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32999 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
33005 #: ../fuse/guestmount.pod:296
33006 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
33011 #: ../tools/virt-win-reg.pl:37
33013 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33018 #: ../tools/virt-win-reg.pl:41
33021 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33027 #: ../tools/virt-win-reg.pl:43
33030 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33036 #: ../tools/virt-win-reg.pl:45
33039 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33045 #: ../tools/virt-win-reg.pl:47
33048 " virt-win-reg --merge domname [input.reg ...]\n"
33054 #: ../tools/virt-win-reg.pl:49
33057 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33062 #: ../tools/virt-win-reg.pl:53
33064 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33065 "virtual machines. If you do this, you I<will> get irreversible disk "
33066 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33067 "but doesn't catch all cases."
33071 #: ../tools/virt-win-reg.pl:58
33073 "Modifying the Windows Registry is an inherently risky operation. The format "
33074 "is deliberately obscure and undocumented, and Registry changes can leave the "
33075 "system unbootable. Therefore when using the I<--merge> option, make sure "
33076 "you have a reliable backup first."
33081 #: ../tools/virt-win-reg.pl:65
33083 "This program can export and merge Windows Registry entries from a Windows "
33089 #: ../tools/virt-win-reg.pl:68
33091 "The first parameter is the libvirt guest name or the raw disk image of a "
33096 #: ../tools/virt-win-reg.pl:71
33098 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33099 "exported (recursively). For example:"
33104 #: ../tools/virt-win-reg.pl:74
33107 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33113 #: ../tools/virt-win-reg.pl:76
33115 "You can also display single values from within registry keys, for example:"
33120 #: ../tools/virt-win-reg.pl:79
33123 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33124 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33125 " Windows 7 Enterprise\n"
33130 #: ../tools/virt-win-reg.pl:83
33132 "With I<--merge>, you can merge a textual regedit file into the Windows "
33138 #: ../tools/virt-win-reg.pl:86
33141 " $ virt-win-reg --merge Windows7 changes.reg\n"
33147 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33153 #: ../tools/virt-win-reg.pl:90
33155 "This program is only meant for simple access to the registry. If you want "
33156 "to do complicated things with the registry, we suggest you download the "
33157 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33158 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33159 "L<hivexregedit(1)>."
33164 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
33165 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
33166 #: ../tools/virt-list-partitions.pl:64
33167 msgid "Display brief help."
33172 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
33173 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
33174 #: ../tools/virt-list-partitions.pl:72
33175 msgid "Display version number and exit."
33180 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33186 #: ../tools/virt-win-reg.pl:122
33187 msgid "Enable debugging messages."
33192 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
33193 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
33194 msgid "B<--connect URI> | B<-c URI>"
33199 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
33200 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
33202 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
33203 "to the default libvirt hypervisor."
33208 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
33209 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
33211 "If you specify guest block devices directly, then libvirt is not used at all."
33216 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
33217 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
33218 msgid "B<--format> raw"
33223 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
33224 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
33226 "Specify the format of disk images given on the command line. If this is "
33227 "omitted then the format is autodetected from the content of the disk image."
33232 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
33233 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
33235 "If disk images are requested from libvirt, then this program asks libvirt "
33236 "for this information. In this case, the value of the format parameter is "
33242 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
33243 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
33245 "If working with untrusted raw-format guest disk images, you should ensure "
33246 "the format is always specified."
33251 #: ../tools/virt-win-reg.pl:157
33257 #: ../tools/virt-win-reg.pl:159
33259 "In merge mode, this merges a textual regedit file into the Windows Registry "
33260 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33261 "displays or exports Registry entries instead."
33265 #: ../tools/virt-win-reg.pl:163
33267 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33268 "result in disk corruption. However exporting (without this flag) is always "
33274 #: ../tools/virt-win-reg.pl:171
33275 msgid "B<--encoding> UTF-16LE|ASCII"
33280 #: ../tools/virt-win-reg.pl:173
33282 "When merging (only), you may need to specify the encoding for strings to be "
33283 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33284 "(3)/ENCODING STRINGS>."
33289 #: ../tools/virt-win-reg.pl:177
33291 "The default is to use UTF-16LE, which should work with recent versions of "
33296 #: ../tools/virt-win-reg.pl:184
33297 msgid "B<--unsafe-printable-strings>"
33301 #: ../tools/virt-win-reg.pl:186
33303 "When exporting (only), assume strings are UTF-16LE and print them as strings "
33304 "instead of hex sequences. Remove the final zero codepoint from strings if "
33309 #: ../tools/virt-win-reg.pl:190
33311 "This is unsafe and does not preserve the fidelity of strings in the original "
33312 "Registry for various reasons:"
33316 #: ../tools/virt-win-reg.pl:197
33318 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
33319 "other encodings will be corrupted by this transformation."
33323 #: ../tools/virt-win-reg.pl:202
33325 "Assumes that everything which has type 1 or 2 is really a string and that "
33326 "everything else is not a string, but the type field in real Registries is "
33331 #: ../tools/virt-win-reg.pl:208
33333 "Loses information about whether a zero codepoint followed the string in the "
33338 #: ../tools/virt-win-reg.pl:213
33340 "This all happens because the Registry itself contains no information about "
33341 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
33345 #: ../tools/virt-win-reg.pl:217
33347 "You should only use this option for quick hacking and debugging of the "
33348 "Registry contents, and I<never> use it if the output is going to be passed "
33349 "into another program or stored in another Registry."
33354 #: ../tools/virt-win-reg.pl:554
33355 msgid "SUPPORTED SYSTEMS"
33360 #: ../tools/virt-win-reg.pl:556
33362 "The program currently supports Windows NT-derived guests starting with "
33363 "Windows XP through to at least Windows 7."
33367 #: ../tools/virt-win-reg.pl:559
33368 msgid "The following Registry keys are supported:"
33372 #: ../tools/virt-win-reg.pl:563
33373 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
33377 #: ../tools/virt-win-reg.pl:565
33378 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
33382 #: ../tools/virt-win-reg.pl:567
33383 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
33387 #: ../tools/virt-win-reg.pl:569
33388 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
33392 #: ../tools/virt-win-reg.pl:571
33393 msgid "C<HKEY_USERS\\.DEFAULT>"
33397 #: ../tools/virt-win-reg.pl:573
33398 msgid "C<HKEY_USERS\\I<SID>>"
33402 #: ../tools/virt-win-reg.pl:575
33403 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
33407 #: ../tools/virt-win-reg.pl:577
33408 msgid "C<HKEY_USERS\\I<username>>"
33412 #: ../tools/virt-win-reg.pl:579
33414 "where I<username> is a local user name (this is a libguestfs extension)."
33419 #: ../tools/virt-win-reg.pl:583
33421 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33426 #: ../tools/virt-win-reg.pl:586
33428 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
33429 "supported (there is no \"current user\")."
33434 #: ../tools/virt-win-reg.pl:589
33440 #: ../tools/virt-win-reg.pl:591
33442 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33443 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33444 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33445 "Windows-style line endings, you may need to reencode the whole file before "
33446 "or after processing."
33450 #: ../tools/virt-win-reg.pl:597
33452 "To reencode a file from Windows format to Linux (before processing it with "
33453 "the I<--merge> option), you would do something like this:"
33458 #: ../tools/virt-win-reg.pl:600
33461 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33467 #: ../tools/virt-win-reg.pl:602
33469 "To go in the opposite direction, after exporting and before sending the file "
33470 "to a Windows user, do something like this:"
33475 #: ../tools/virt-win-reg.pl:605
33478 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33484 #: ../tools/virt-win-reg.pl:607
33485 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33490 #: ../tools/virt-win-reg.pl:609
33492 "If you are unsure about the current encoding, use the L<file(1)> command. "
33493 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33494 "style (CRLF) line endings, like this:"
33499 #: ../tools/virt-win-reg.pl:613
33502 " $ file software.reg\n"
33503 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33504 " with CRLF line terminators\n"
33509 #: ../tools/virt-win-reg.pl:617
33510 msgid "This file would need conversion before you could I<--merge> it."
33515 #: ../tools/virt-win-reg.pl:619
33516 msgid "CurrentControlSet etc."
33521 #: ../tools/virt-win-reg.pl:621
33523 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33524 "Registry at the level of the hive file, and therefore you cannot modify "
33530 #: ../tools/virt-win-reg.pl:625
33532 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33533 "circumstances it might refer to another control set. The way to find out is "
33534 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33539 #: ../tools/virt-win-reg.pl:629
33542 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33543 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33544 " \"Current\"=dword:00000001\n"
33545 " \"Default\"=dword:00000001\n"
33546 " \"Failed\"=dword:00000000\n"
33547 " \"LastKnownGood\"=dword:00000002\n"
33553 #: ../tools/virt-win-reg.pl:636
33554 msgid "\"Current\" is the one which Windows will choose when it boots."
33559 #: ../tools/virt-win-reg.pl:638
33561 "Similarly, other C<Current...> keys in the path may need to be replaced."
33566 #: ../tools/virt-win-reg.pl:641
33567 msgid "WINDOWS TIPS"
33572 #: ../tools/virt-win-reg.pl:643
33574 "Note that some of these tips modify the guest disk image. The guest I<must> "
33575 "be shut off, else you will get disk corruption."
33580 #: ../tools/virt-win-reg.pl:646
33581 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33586 #: ../tools/virt-win-reg.pl:648
33588 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33589 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33590 "is uploaded into C<C:\\>:"
33595 #: ../tools/virt-win-reg.pl:652
33598 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33604 #: ../tools/virt-win-reg.pl:654
33605 msgid "Prepare a regedit file containing the registry change:"
33610 #: ../tools/virt-win-reg.pl:656
33613 " cat > test.reg <<'EOF'\n"
33614 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33615 " \"Test\"=\"c:\\\\test.bat\"\n"
33622 #: ../tools/virt-win-reg.pl:661
33624 "In this example we use the key C<RunOnce> which means that the script will "
33625 "run precisely once when the first user logs in. If you want it to run every "
33626 "time a user logs in, replace C<RunOnce> with C<Run>."
33631 #: ../tools/virt-win-reg.pl:665
33632 msgid "Now update the registry:"
33637 #: ../tools/virt-win-reg.pl:667
33640 " virt-win-reg --merge WindowsGuest test.reg\n"
33646 #: ../tools/virt-win-reg.pl:669
33647 msgid "INSTALLING A SERVICE"
33652 #: ../tools/virt-win-reg.pl:671
33654 "This section assumes you are familiar with Windows services, and you either "
33655 "have a program which handles the Windows Service Control Protocol directly "
33656 "or you want to run any program using a service wrapper like SrvAny or the "
33662 #: ../tools/virt-win-reg.pl:676
33664 "First upload the program and optionally the service wrapper. In this case "
33665 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33670 #: ../tools/virt-win-reg.pl:680
33673 " guestfish -i -d WindowsGuest <<EOF\n"
33674 " upload rhsrvany.exe /rhsrvany.exe\n"
33675 " upload test.exe /test.exe\n"
33682 #: ../tools/virt-win-reg.pl:685
33684 "Prepare a regedit file containing the registry changes. In this example, "
33685 "the first registry change is needed for the service itself or the service "
33686 "wrapper (if used). The second registry change is only needed because I am "
33687 "using the RHSrvAny service wrapper."
33692 #: ../tools/virt-win-reg.pl:690
33695 " cat > service.reg <<'EOF'\n"
33696 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33697 " \"Type\"=dword:00000010\n"
33698 " \"Start\"=dword:00000002\n"
33699 " \"ErrorControl\"=dword:00000001\n"
33700 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33701 " \"DisplayName\"=\"RHSrvAny\"\n"
33702 " \"ObjectName\"=\"NetworkService\"\n"
33708 #: ../tools/virt-win-reg.pl:699
33711 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33712 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33713 " \"PWD\"=\"c:\\\\Temp\"\n"
33720 #: ../tools/virt-win-reg.pl:710
33722 "For use of C<ControlSet001> see the section above in this manual page. You "
33723 "may need to adjust this according to the control set that is in use by the "
33729 #: ../tools/virt-win-reg.pl:716
33731 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33732 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33733 "privileged account."
33738 #: ../tools/virt-win-reg.pl:722
33740 "For the meaning of the magic numbers, see this Microsoft KB article: "
33741 "L<http://support.microsoft.com/kb/103000>."
33746 #: ../tools/virt-win-reg.pl:727
33747 msgid "Update the registry:"
33752 #: ../tools/virt-win-reg.pl:729
33755 " virt-win-reg --merge WindowsGuest service.reg\n"
33761 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
33762 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
33763 #: ../tools/virt-list-partitions.pl:250
33764 msgid "SHELL QUOTING"
33769 #: ../tools/virt-win-reg.pl:733
33771 "Be careful when passing parameters containing C<\\> (backslash) in the "
33772 "shell. Usually you will have to use 'single quotes' or double backslashes "
33773 "(but not both) to protect them from the shell."
33778 #: ../tools/virt-win-reg.pl:737
33779 msgid "Paths and value names are case-insensitive."
33784 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
33785 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
33786 #: ../tools/virt-list-partitions.pl:252
33788 "Libvirt guest names can contain arbitrary characters, some of which have "
33789 "meaning to the shell such as C<#> and space. You may need to quote or "
33790 "escape these characters on the command line. See the shell manual page L<sh"
33791 "(1)> for details."
33796 #: ../tools/virt-win-reg.pl:746
33798 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33799 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33800 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33805 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
33807 "When reporting bugs, please enable debugging and capture the I<complete> "
33813 #: ../tools/virt-win-reg.pl:764
33816 " export LIBGUESTFS_DEBUG=1\n"
33817 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33823 #: ../tools/virt-win-reg.pl:767
33825 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33831 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
33832 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
33833 #: ../tools/virt-list-partitions.pl:269
33839 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
33840 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
33841 #: ../tools/virt-list-partitions.pl:271
33842 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33847 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
33848 msgid "Copyright (C) 2010 Red Hat Inc."
33853 #: ../tools/virt-list-filesystems.pl:32
33855 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33860 #: ../tools/virt-list-filesystems.pl:36
33863 " virt-list-filesystems [--options] domname\n"
33869 #: ../tools/virt-list-filesystems.pl:38
33872 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33878 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33880 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33886 #: ../tools/virt-list-filesystems.pl:45
33888 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33889 "are contained in a virtual machine or disk image."
33894 #: ../tools/virt-list-filesystems.pl:49
33896 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33897 "functionality. For more complex cases you should look at the L<guestfish(1)"
33903 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33904 msgid "B<-l> | B<--long>"
33909 #: ../tools/virt-list-filesystems.pl:108
33911 "With this option, C<virt-list-filesystems> displays the type of each "
33912 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33917 #: ../tools/virt-list-filesystems.pl:115
33918 msgid "B<-a> | B<--all>"
33923 #: ../tools/virt-list-filesystems.pl:117
33925 "Normally we only show mountable filesystems. If this option is given then "
33926 "swap devices are shown too."
33931 #: ../tools/virt-list-filesystems.pl:191
33933 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33934 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33935 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33940 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33941 msgid "Copyright (C) 2009 Red Hat Inc."
33946 #: ../tools/virt-tar.pl:33
33947 msgid "virt-tar - Extract or upload files to a virtual machine"
33952 #: ../tools/virt-tar.pl:37
33955 " virt-tar [--options] -x domname directory tarball\n"
33961 #: ../tools/virt-tar.pl:39
33964 " virt-tar [--options] -u domname tarball directory\n"
33970 #: ../tools/virt-tar.pl:41
33973 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33979 #: ../tools/virt-tar.pl:43
33982 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33987 #: ../tools/virt-tar.pl:47
33989 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33990 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33995 #: ../tools/virt-tar.pl:52
33996 msgid "Download C</home> from the VM into a local tarball:"
34001 #: ../tools/virt-tar.pl:54
34004 " virt-tar -x domname /home home.tar\n"
34010 #: ../tools/virt-tar.pl:56
34013 " virt-tar -zx domname /home home.tar.gz\n"
34019 #: ../tools/virt-tar.pl:58
34020 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34025 #: ../tools/virt-tar.pl:60
34028 " virt-tar -u domname uploadstuff.tar /tmp\n"
34034 #: ../tools/virt-tar.pl:62
34037 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34042 #: ../tools/virt-tar.pl:66
34044 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34045 "virtual machines. If you do this, you risk disk corruption in the VM. "
34046 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34050 #: ../tools/virt-tar.pl:71
34052 "You can use I<-x> (extract) on live virtual machines, but you might get "
34053 "inconsistent results or errors if there is filesystem activity inside the "
34054 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34055 "work, but the only way to guarantee consistent results is if the virtual "
34056 "machine is shut down."
34061 #: ../tools/virt-tar.pl:79
34063 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34064 "parts of a guest filesystem. There are many possibilities: making backups, "
34065 "uploading data files, snooping on guest activity, fixing or customizing "
34071 #: ../tools/virt-tar.pl:84
34073 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34074 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34075 "should look at the L<guestfish(1)> tool."
34079 #: ../tools/virt-tar.pl:88
34081 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34082 "its contents (recursively) from the virtual machine into a local tarball. "
34083 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34084 "virtual machine. You cannot use these two options together."
34088 #: ../tools/virt-tar.pl:94
34090 "In addition, you may need to use the I<-z> (gZip) option to enable "
34091 "compression. When uploading, you have to specify I<-z> if the upload file "
34092 "is compressed because virt-tar won't detect this on its own."
34097 #: ../tools/virt-tar.pl:98
34099 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34100 "example it cannot do PKZip files or bzip2 compression. If you want that "
34101 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34102 "the L<libguestfs(3)> API)."
34107 #: ../tools/virt-tar.pl:156
34108 msgid "B<-x> | B<--extract> | B<--download>"
34113 #: ../tools/virt-tar.pl:158
34114 msgid "B<-u> | B<--upload>"
34118 #: ../tools/virt-tar.pl:160
34120 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34125 #: ../tools/virt-tar.pl:163
34127 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34128 "Please read the L</WARNING> section above before using this option."
34133 #: ../tools/virt-tar.pl:167
34134 msgid "You must specify exactly one of these options."
34139 #: ../tools/virt-tar.pl:173
34140 msgid "B<-z> | B<--gzip>"
34145 #: ../tools/virt-tar.pl:175
34146 msgid "Specify that the input or output tarball is gzip-compressed."
34150 #: ../tools/virt-tar.pl:288
34152 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34153 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34154 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34160 #: ../tools/virt-make-fs.pl:37
34161 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34166 #: ../tools/virt-make-fs.pl:41
34169 " virt-make-fs [--options] input.tar output.img\n"
34175 #: ../tools/virt-make-fs.pl:43
34178 " virt-make-fs [--options] input.tar.gz output.img\n"
34184 #: ../tools/virt-make-fs.pl:45
34187 " virt-make-fs [--options] directory output.img\n"
34193 #: ../tools/virt-make-fs.pl:49
34195 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34196 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34197 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34198 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34199 "you want to attach these filesystems to existing virtual machines (eg. to "
34200 "import large amounts of read-only data to a VM)."
34205 #: ../tools/virt-make-fs.pl:57
34206 msgid "Basic usage is:"
34211 #: ../tools/virt-make-fs.pl:59
34214 " virt-make-fs input output\n"
34220 #: ../tools/virt-make-fs.pl:61
34222 "where C<input> is either a directory containing files that you want to add, "
34223 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34224 "C<output> is a disk image. The input type is detected automatically. The "
34225 "output disk image defaults to a raw ext2 image unless you specify extra "
34226 "flags (see L</OPTIONS> below)."
34231 #: ../tools/virt-make-fs.pl:67
34232 msgid "EXTRA SPACE"
34236 #: ../tools/virt-make-fs.pl:69
34238 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34239 "the files that it contains, but might have extra space. Depending on how "
34240 "you are going to use the output, you might think this extra space is wasted "
34241 "and want to minimize it, or you might want to leave space so that more files "
34242 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34243 "but you can use the I<--size> flag to leave space in the filesystem if you "
34248 #: ../tools/virt-make-fs.pl:77
34250 "An alternative way to leave extra space but not make the output image any "
34251 "bigger is to use an alternative disk image format (instead of the default "
34252 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34253 "image format (check your hypervisor supports this before using it). This "
34254 "allows you to choose a large I<--size> but the extra space won't actually be "
34255 "allocated in the image until you try to store something in it."
34259 #: ../tools/virt-make-fs.pl:85
34261 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34262 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34263 "to build another image from scratch."
34268 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34269 #: ../tools/virt-make-fs.pl:142
34275 #: ../tools/virt-make-fs.pl:91
34278 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34284 #: ../tools/virt-make-fs.pl:93
34285 msgid "FILESYSTEM TYPE"
34290 #: ../tools/virt-make-fs.pl:95
34292 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34293 "libguestfs supports can be used (but I<not> read-only formats like "
34294 "ISO9660). Here are some of the more common choices:"
34299 #: ../tools/virt-make-fs.pl:101
34305 #: ../tools/virt-make-fs.pl:103
34307 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34308 "you are not going to use the filesystem in a way that requires the journal, "
34309 "then this is just wasted overhead."
34314 #: ../tools/virt-make-fs.pl:107
34315 msgid "I<ntfs> or I<vfat>"
34320 #: ../tools/virt-make-fs.pl:109
34321 msgid "Useful if exporting data to a Windows guest."
34326 #: ../tools/virt-make-fs.pl:111
34328 "I<Note for vfat>: The tar archive or local directory must only contain files "
34329 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34330 "program running within libguestfs is unable to change the ownership of non-"
34331 "root files, since vfat itself does not support this."
34336 #: ../tools/virt-make-fs.pl:116
34342 #: ../tools/virt-make-fs.pl:118
34344 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34345 "total filesystem size."
34350 #: ../tools/virt-make-fs.pl:125
34353 " virt-make-fs --type=minix input minixfs.img\n"
34359 #: ../tools/virt-make-fs.pl:127
34360 msgid "TO PARTITION OR NOT TO PARTITION"
34365 #: ../tools/virt-make-fs.pl:129
34366 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34371 #: ../tools/virt-make-fs.pl:131
34373 "Adding a partition can make the disk image more compatible with certain "
34374 "virtualized operating systems which don't expect to see a filesystem "
34375 "directly located on a block device (Linux doesn't care and will happily "
34376 "handle both types)."
34381 #: ../tools/virt-make-fs.pl:136
34383 "On the other hand, if you have a partition table then the output image is no "
34384 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34385 "directly on a partitioned disk image. (However libguestfs tools such as "
34386 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34391 #: ../tools/virt-make-fs.pl:144
34392 msgid "Add an MBR partition:"
34397 #: ../tools/virt-make-fs.pl:146
34400 " virt-make-fs --partition -- input disk.img\n"
34406 #: ../tools/virt-make-fs.pl:148
34408 "If the output disk image could be terabyte-sized or larger, it's better to "
34409 "use an EFI/GPT-compatible partition table:"
34414 #: ../tools/virt-make-fs.pl:151
34417 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34423 #: ../tools/virt-make-fs.pl:179
34424 msgid "Enable debugging information."
34429 #: ../tools/virt-make-fs.pl:185
34430 msgid "B<--size=E<lt>NE<gt>>"
34435 #: ../tools/virt-make-fs.pl:187
34436 msgid "B<--size=+E<lt>NE<gt>>"
34441 #: ../tools/virt-make-fs.pl:189
34442 msgid "B<-s E<lt>NE<gt>>"
34447 #: ../tools/virt-make-fs.pl:191
34448 msgid "B<-s +E<lt>NE<gt>>"
34452 #: ../tools/virt-make-fs.pl:193
34454 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34459 #: ../tools/virt-make-fs.pl:196
34461 "If this option is I<not> given, then the output image will be just large "
34462 "enough to contain all the files, with not much wasted space."
34467 #: ../tools/virt-make-fs.pl:199
34469 "To choose a fixed size output disk, specify an absolute number followed by b/"
34470 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34471 "Petabytes or Exabytes. This must be large enough to contain all the input "
34472 "files, else you will get an error."
34476 #: ../tools/virt-make-fs.pl:204
34478 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34479 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34480 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34481 "the input files, and (approximately) an extra 200 MB free space."
34486 #: ../tools/virt-make-fs.pl:210
34488 "Note that virt-make-fs estimates free space, and therefore will not produce "
34489 "filesystems containing precisely the free space requested. (It is much more "
34490 "expensive and time-consuming to produce a filesystem which has precisely the "
34491 "desired free space)."
34496 #: ../tools/virt-make-fs.pl:219
34497 msgid "B<--format=E<lt>fmtE<gt>>"
34502 #: ../tools/virt-make-fs.pl:221
34503 msgid "B<-F E<lt>fmtE<gt>>"
34508 #: ../tools/virt-make-fs.pl:223
34509 msgid "Choose the output disk image format."
34514 #: ../tools/virt-make-fs.pl:225
34515 msgid "The default is C<raw> (raw disk image)."
34520 #: ../tools/virt-make-fs.pl:227
34522 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34523 "that would really make sense here is C<qcow2>."
34528 #: ../tools/virt-make-fs.pl:234
34529 msgid "B<--type=E<lt>fsE<gt>>"
34534 #: ../tools/virt-make-fs.pl:236
34535 msgid "B<-t E<lt>fsE<gt>>"
34540 #: ../tools/virt-make-fs.pl:238
34541 msgid "Choose the output filesystem type."
34546 #: ../tools/virt-make-fs.pl:240
34547 msgid "The default is C<ext2>."
34552 #: ../tools/virt-make-fs.pl:242
34554 "Any filesystem which is supported read-write by libguestfs can be used here."
34559 #: ../tools/virt-make-fs.pl:249
34560 msgid "B<--partition>"
34565 #: ../tools/virt-make-fs.pl:251
34566 msgid "B<--partition=E<lt>parttypeE<gt>>"
34571 #: ../tools/virt-make-fs.pl:253
34573 "If specified, this flag adds an MBR partition table to the output disk image."
34577 #: ../tools/virt-make-fs.pl:256
34579 "You can change the partition table type, eg. I<--partition=gpt> for large "
34584 #: ../tools/virt-make-fs.pl:259
34586 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34587 "might consider the next parameter to be the partition type. For example:"
34592 #: ../tools/virt-make-fs.pl:263
34595 " virt-make-fs --partition input.tar ...\n"
34600 #: ../tools/virt-make-fs.pl:265
34602 "would cause virt-make-fs to think you wanted to use a partition type of "
34603 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34604 "dash) between options and the input file argument:"
34609 #: ../tools/virt-make-fs.pl:269
34612 " virt-make-fs --partition -- input.tar ...\n"
34617 #: ../tools/virt-make-fs.pl:541
34619 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34620 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34621 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34626 #: ../tools/virt-make-fs.pl:558
34629 " export LIBGUESTFS_DEBUG=1\n"
34630 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34636 #: ../tools/virt-make-fs.pl:561
34638 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34644 #: ../tools/virt-list-partitions.pl:32
34646 "virt-list-partitions - List partitions in a virtual machine or disk image"
34651 #: ../tools/virt-list-partitions.pl:36
34654 " virt-list-partitions [--options] domname\n"
34660 #: ../tools/virt-list-partitions.pl:38
34663 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34669 #: ../tools/virt-list-partitions.pl:45
34671 "C<virt-list-partitions> is a command line tool to list the partitions that "
34672 "are contained in a virtual machine or disk image. It is mainly useful as a "
34673 "first step to using L<virt-resize(1)>."
34678 #: ../tools/virt-list-partitions.pl:50
34680 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34681 "functionality. For more complex cases you should look at the L<guestfish(1)"
34687 #: ../tools/virt-list-partitions.pl:107
34688 msgid "B<-h> | B<--human-readable>"
34693 #: ../tools/virt-list-partitions.pl:109
34694 msgid "Show sizes in human-readable form (eg. \"1G\")."
34699 #: ../tools/virt-list-partitions.pl:117
34701 "With this option, C<virt-list-partitions> displays the type and size of each "
34702 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34707 #: ../tools/virt-list-partitions.pl:124
34708 msgid "B<-t> | B<--total>"
34713 #: ../tools/virt-list-partitions.pl:126
34715 "Display the total size of each block device (as a separate row or rows)."
34720 #: ../tools/virt-list-partitions.pl:259
34722 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34723 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34724 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34729 #: ../tools/virt-list-partitions.pl:275
34730 msgid "Copyright (C) 2009-2010 Red Hat Inc."