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-05-17 17:29+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:1606
931 #: ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614
932 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1626
933 #: ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1634
934 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648
935 #: ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1790
936 #: ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1799
937 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1865
938 #: ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1874
939 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
940 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
941 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
942 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
943 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
944 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081
945 #: ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089
946 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1101
947 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1115
948 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
949 #: ../fish/guestfish-actions.pod:1213 ../fish/guestfish-actions.pod:1217
950 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1227
951 #: ../fish/guestfish-actions.pod:1269 ../fish/guestfish-actions.pod:1273
952 #: ../fish/guestfish-actions.pod:1278 ../tools/virt-win-reg.pl:195
953 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
954 #: ../tools/virt-win-reg.pl:707 ../tools/virt-win-reg.pl:713
955 #: ../tools/virt-win-reg.pl:719
961 #: ../src/guestfs.pod:390
963 "The kernel version that the command runs under will be different from what "
969 #: ../src/guestfs.pod:395
971 "If the command needs to communicate with daemons, then most likely they "
977 #: ../src/guestfs.pod:400
978 msgid "The command will be running in limited memory."
983 #: ../src/guestfs.pod:404
985 "The network may not be available unless you enable it (see L</"
986 "guestfs_set_network>)."
991 #: ../src/guestfs.pod:409
992 msgid "Only supports Linux guests (not Windows, BSD, etc)."
997 #: ../src/guestfs.pod:413
999 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1004 #: ../src/guestfs.pod:418
1006 "For SELinux guests, you may need to enable SELinux and load policy first. "
1007 "See L</SELINUX> in this manpage."
1012 #: ../src/guestfs.pod:423
1014 "I<Security:> It is not safe to run commands from untrusted, possibly "
1015 "malicious guests. These commands may attempt to exploit your program by "
1016 "sending unexpected output. They could also try to exploit the Linux kernel "
1017 "or qemu provided by the libguestfs appliance. They could use the network "
1018 "provided by the libguestfs appliance to bypass ordinary network partitions "
1019 "and firewalls. They could use the elevated privileges or different SELinux "
1020 "context of your program to their advantage."
1025 #: ../src/guestfs.pod:432
1027 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1028 "(a script which runs when the guest next boots normally), and to have this "
1029 "script run the commands you want in the normal context of the running guest, "
1030 "network security and so on. For information about other security issues, "
1036 #: ../src/guestfs.pod:440
1038 "The two main API calls to run commands are L</guestfs_command> and L</"
1039 "guestfs_sh> (there are also variations)."
1044 #: ../src/guestfs.pod:443
1046 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1047 "shell globs, redirections, etc will work."
1052 #: ../src/guestfs.pod:446
1053 msgid "CONFIGURATION FILES"
1058 #: ../src/guestfs.pod:448
1060 "To read and write configuration files in Linux guest filesystems, we "
1061 "strongly recommend using Augeas. For example, Augeas understands how to "
1062 "read and write, say, a Linux shadow password file or X.org configuration "
1063 "file, and so avoids you having to write that code."
1068 #: ../src/guestfs.pod:453
1070 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1071 "document Augeas itself here because there is excellent documentation on the "
1072 "L<http://augeas.net/> website."
1077 #: ../src/guestfs.pod:457
1079 "If you don't want to use Augeas (you fool!) then try calling L</"
1080 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1086 #: ../src/guestfs.pod:461
1092 #: ../src/guestfs.pod:463
1094 "We support SELinux guests. To ensure that labeling happens correctly in "
1095 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1100 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1101 #: ../src/guestfs.pod:2426
1107 #: ../src/guestfs.pod:471
1108 msgid "Before launching, do:"
1113 #: ../src/guestfs.pod:473
1116 " guestfs_set_selinux (g, 1);\n"
1122 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1123 #: ../src/guestfs.pod:2451
1129 #: ../src/guestfs.pod:477
1131 "After mounting the guest's filesystem(s), load the policy. This is best "
1132 "done by running the L<load_policy(8)> command in the guest itself:"
1137 #: ../src/guestfs.pod:481
1140 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1146 #: ../src/guestfs.pod:483
1148 "(Older versions of C<load_policy> require you to specify the name of the "
1154 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1160 #: ../src/guestfs.pod:488
1162 "Optionally, set the security context for the API. The correct security "
1163 "context to use can only be known by inspecting the guest. As an example:"
1168 #: ../src/guestfs.pod:492
1171 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1177 #: ../src/guestfs.pod:496
1178 msgid "This will work for running commands and editing existing files."
1183 #: ../src/guestfs.pod:498
1185 "When new files are created, you may need to label them explicitly, for "
1186 "example by running the external command C<restorecon pathname>."
1191 #: ../src/guestfs.pod:502
1197 #: ../src/guestfs.pod:504
1199 "Certain calls are affected by the current file mode creation mask (the "
1200 "\"umask\"). In particular ones which create files or directories, such as "
1201 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1202 "either the default mode that the file is created with or modifies the mode "
1208 #: ../src/guestfs.pod:510
1210 "The default umask is C<022>, so files are created with modes such as C<0644> "
1211 "and directories with C<0755>."
1216 #: ../src/guestfs.pod:513
1218 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1219 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1220 "guestfs_chmod> after creating each file or directory."
1225 #: ../src/guestfs.pod:517
1226 msgid "For more information about umask, see L<umask(2)>."
1231 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1232 msgid "ENCRYPTED DISKS"
1237 #: ../src/guestfs.pod:521
1239 "Libguestfs allows you to access Linux guests which have been encrypted using "
1240 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1241 "standard. This includes nearly all whole disk encryption systems used by "
1242 "modern Linux guests."
1247 #: ../src/guestfs.pod:527
1249 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1250 "returns the string C<crypto_LUKS>)."
1255 #: ../src/guestfs.pod:530
1257 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1258 "will require the passphrase!"
1263 #: ../src/guestfs.pod:533
1265 "Opening a LUKS device creates a new device mapper device called C</dev/"
1266 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1267 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1268 "from and encrypted to the underlying block device respectively."
1273 #: ../src/guestfs.pod:539
1275 "LVM volume groups on the device can be made visible by calling L</"
1276 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1277 "(s) can now be mounted in the usual way."
1282 #: ../src/guestfs.pod:543
1284 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1285 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1286 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1287 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1288 "underlying encrypted block device)."
1293 #: ../src/guestfs.pod:550
1298 #: ../src/guestfs.pod:552
1300 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1301 "contains operating systems, an install CD or a live CD. (These APIs used to "
1302 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1303 "version 1.5.3 the most frequently used part of this library has been "
1304 "rewritten in C and moved into the core code)."
1309 #: ../src/guestfs.pod:559
1311 "Add all disks belonging to the unknown virtual machine and call L</"
1312 "guestfs_launch> in the usual way."
1317 #: ../src/guestfs.pod:562
1319 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1320 "and certain heuristics, and returns a list of operating systems that were "
1321 "found. An empty list means none were found. A single element is the root "
1322 "filesystem of the operating system. For dual- or multi-boot guests, "
1323 "multiple roots can be returned, each one corresponding to a separate "
1324 "operating system. (Multi-boot virtual machines are extremely rare in the "
1325 "world of virtualization, but since this scenario can happen, we have built "
1326 "libguestfs to deal with it.)"
1331 #: ../src/guestfs.pod:571
1333 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1334 "to get additional details about that operating system. For example, call L</"
1335 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1336 "Windows and Linux-based operating systems respectively."
1341 #: ../src/guestfs.pod:577
1343 "Un*x-like and Linux-based operating systems usually consist of several "
1344 "filesystems which are mounted at boot time (for example, a separate boot "
1345 "partition mounted on C</boot>). The inspection rules are able to detect how "
1346 "filesystems correspond to mount points. Call "
1347 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1348 "hash table like this example:"
1353 #: ../src/guestfs.pod:584
1356 " /boot => /dev/sda1\n"
1357 " / => /dev/vg_guest/lv_root\n"
1358 " /usr => /dev/vg_guest/lv_usr\n"
1364 #: ../src/guestfs.pod:588
1366 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1367 "filesystems as suggested."
1372 #: ../src/guestfs.pod:591
1374 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1375 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1380 #: ../src/guestfs.pod:595
1382 "Inspection currently only works for some common operating systems. "
1383 "Contributors are welcome to send patches for other operating systems that we "
1384 "currently cannot detect."
1389 #: ../src/guestfs.pod:599
1391 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1392 "for more details. The L</guestfs_inspect_os> function just ignores any "
1393 "encrypted devices."
1398 #: ../src/guestfs.pod:603
1400 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1401 "inspection and caches the results in the guest handle. Subsequent calls to "
1402 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1403 "read the disks. If you change the content of the guest disks, you can redo "
1404 "inspection by calling L</guestfs_inspect_os> again. (L</"
1405 "guestfs_inspect_list_applications> works a little differently from the other "
1406 "calls and does read the disks. See documentation for that function for "
1411 #: ../src/guestfs.pod:612
1412 msgid "INSPECTING INSTALL DISKS"
1416 #: ../src/guestfs.pod:614
1418 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1423 #: ../src/guestfs.pod:617
1425 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1426 "system, which currently can be C<installed> (a regular operating system) or "
1427 "C<installer> (some sort of install disk)."
1431 #: ../src/guestfs.pod:621
1433 "Further information is available about the operating system that can be "
1434 "installed using the regular inspection APIs like L</"
1435 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1439 #: ../src/guestfs.pod:626
1441 "Some additional information specific to installer disks is also available "
1442 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1443 "guestfs_inspect_is_multipart> calls."
1448 #: ../src/guestfs.pod:631
1449 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1454 #: ../src/guestfs.pod:633
1456 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1457 "ntfs-3g.org/> driver."
1462 #: ../src/guestfs.pod:636
1463 msgid "DRIVE LETTERS AND PATHS"
1468 #: ../src/guestfs.pod:638
1470 "DOS and Windows still use drive letters, and the filesystems are always "
1471 "treated as case insensitive by Windows itself, and therefore you might find "
1472 "a Windows configuration file referring to a path like C<c:\\windows"
1473 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1474 "might be referred to as C</WINDOWS/System32>."
1478 #: ../src/guestfs.pod:644
1480 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1481 "L</guestfs_inspect_get_drive_mappings>)"
1485 #: ../src/guestfs.pod:647
1487 "Dealing with separator characters (backslash vs forward slash) is outside "
1488 "the scope of libguestfs, but usually a simple character replacement will "
1493 #: ../src/guestfs.pod:651
1495 "To resolve the case insensitivity of paths, call L</"
1496 "guestfs_case_sensitive_path>."
1501 #: ../src/guestfs.pod:654
1502 msgid "ACCESSING THE WINDOWS REGISTRY"
1507 #: ../src/guestfs.pod:656
1509 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1510 "files, through the library C<hivex> which is part of the libguestfs project "
1511 "although ships as a separate tarball. You have to locate and download the "
1512 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1513 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1514 "reg(1)> for more help on this issue."
1519 #: ../src/guestfs.pod:664
1520 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1525 #: ../src/guestfs.pod:666
1527 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1528 "provide something which looks like a Linux symlink. The way it tries to do "
1529 "the rewriting is described here:"
1534 #: ../src/guestfs.pod:670
1536 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1542 #: ../src/guestfs.pod:672
1544 "The essential problem is that ntfs-3g simply does not have enough "
1545 "information to do a correct job. NTFS links can contain drive letters and "
1546 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1547 "It is almost certainly the case that libguestfs callers should ignore what "
1548 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1553 #: ../src/guestfs.pod:679
1555 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1556 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1557 "attribute, and read the raw reparse data from that (you can find the format "
1558 "documented in various places around the web)."
1563 #: ../src/guestfs.pod:684
1564 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1569 #: ../src/guestfs.pod:686
1571 "There are other useful extended attributes that can be read from ntfs-3g "
1572 "filesystems (using L</guestfs_getxattr>). See:"
1577 #: ../src/guestfs.pod:689
1579 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1584 #: ../src/guestfs.pod:691
1585 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1590 #: ../src/guestfs.pod:693
1592 "Although we don't want to discourage you from using the C API, we will "
1593 "mention here that the same API is also available in other languages."
1597 #: ../src/guestfs.pod:696
1599 "The API is broadly identical in all supported languages. This means that "
1600 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1601 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1602 "OCaml. In other words, a straightforward, predictable isomorphism between "
1608 #: ../src/guestfs.pod:702
1610 "Error messages are automatically transformed into exceptions if the language "
1616 #: ../src/guestfs.pod:705
1618 "We don't try to \"object orientify\" parts of the API in OO languages, "
1619 "although contributors are welcome to write higher level APIs above what we "
1620 "provide in their favourite languages if they wish."
1625 #: ../src/guestfs.pod:711
1631 #: ../src/guestfs.pod:713
1633 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1634 "identical to the C API. C++ classes and exceptions are not used."
1639 #: ../src/guestfs.pod:717
1645 #: ../src/guestfs.pod:719
1647 "The C# bindings are highly experimental. Please read the warnings at the "
1648 "top of C<csharp/Libguestfs.cs>."
1653 #: ../src/guestfs.pod:722
1659 #: ../src/guestfs.pod:724
1661 "This is the only language binding that is working but incomplete. Only "
1662 "calls which return simple integers have been bound in Haskell, and we are "
1663 "looking for help to complete this binding."
1668 #: ../src/guestfs.pod:728
1674 #: ../src/guestfs.pod:730
1676 "Full documentation is contained in the Javadoc which is distributed with "
1682 #: ../src/guestfs.pod:733
1687 #: ../src/guestfs.pod:735
1688 msgid "See L<guestfs-ocaml(3)>."
1693 #: ../src/guestfs.pod:737
1698 #: ../src/guestfs.pod:739
1699 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1704 #: ../src/guestfs.pod:741
1710 #: ../src/guestfs.pod:743
1712 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1713 "the php-libguestfs package for your distribution."
1718 #: ../src/guestfs.pod:746
1719 msgid "The PHP binding only works correctly on 64 bit machines."
1724 #: ../src/guestfs.pod:748
1729 #: ../src/guestfs.pod:750
1730 msgid "See L<guestfs-python(3)>."
1735 #: ../src/guestfs.pod:752
1740 #: ../src/guestfs.pod:754
1741 msgid "See L<guestfs-ruby(3)>."
1746 #: ../src/guestfs.pod:756
1747 msgid "B<shell scripts>"
1751 #: ../src/guestfs.pod:758
1752 msgid "See L<guestfish(1)>."
1757 #: ../src/guestfs.pod:762
1758 msgid "LIBGUESTFS GOTCHAS"
1763 #: ../src/guestfs.pod:764
1765 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1766 "system [...] that works in the way it is documented but is counterintuitive "
1767 "and almost invites mistakes.\""
1772 #: ../src/guestfs.pod:768
1774 "Since we developed libguestfs and the associated tools, there are several "
1775 "things we would have designed differently, but are now stuck with for "
1776 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1777 "release, you can expect these to change. Beware of them."
1782 #: ../src/guestfs.pod:776
1783 msgid "Autosync / forgetting to sync."
1787 #: ../src/guestfs.pod:778
1789 "I<Update:> Autosync is enabled by default for all API users starting from "
1790 "libguestfs 1.5.24. This section only applies to older versions."
1795 #: ../src/guestfs.pod:781
1797 "When modifying a filesystem from C or another language, you B<must> unmount "
1798 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1799 "libguestfs handle. You can also call:"
1804 #: ../src/guestfs.pod:785
1807 " guestfs_set_autosync (g, 1);\n"
1813 #: ../src/guestfs.pod:787
1815 "to have the unmount/sync done automatically for you when the handle 'g' is "
1816 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1821 #: ../src/guestfs.pod:791
1823 "If you forget to do this, then it is entirely possible that your changes "
1824 "won't be written out, or will be partially written, or (very rarely) that "
1825 "you'll get disk corruption."
1830 #: ../src/guestfs.pod:795
1832 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1833 "guestfish scripts that forget to sync will work just fine, which can make "
1834 "this very puzzling if you are trying to debug a problem."
1839 #: ../src/guestfs.pod:799
1840 msgid "Mount option C<-o sync> should not be the default."
1845 #: ../src/guestfs.pod:801
1847 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1848 "However C<-o sync> does not add any reliability benefit, but does have a "
1849 "very large performance impact."
1854 #: ../src/guestfs.pod:805
1856 "The work around is to use L</guestfs_mount_options> and set the mount "
1857 "options that you actually want to use."
1862 #: ../src/guestfs.pod:808
1863 msgid "Read-only should be the default."
1868 #: ../src/guestfs.pod:810
1870 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1871 "specify I<--rw> if you want to make changes to the image."
1876 #: ../src/guestfs.pod:813
1877 msgid "This would reduce the potential to corrupt live VM images."
1882 #: ../src/guestfs.pod:815
1884 "Note that many filesystems change the disk when you just mount and unmount, "
1885 "even if you didn't perform any writes. You need to use L</"
1886 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1891 #: ../src/guestfs.pod:819
1892 msgid "guestfish command line is hard to use."
1897 #: ../src/guestfs.pod:821
1899 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1900 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1901 "exist, so it fails. In earlier versions of guestfish the error message was "
1902 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1903 "we should have used C<guestfish -c command> to run commands."
1908 #: ../src/guestfs.pod:828
1909 msgid "guestfish megabyte modifiers don't work right on all commands"
1914 #: ../src/guestfs.pod:830
1916 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1917 "other modifiers). What guestfish actually does is to multiply the number "
1918 "part by the modifier part and pass the result to the C API. However this "
1919 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1920 "expecting some other unit (eg. megabytes)."
1925 #: ../src/guestfs.pod:837
1926 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1931 #: ../src/guestfs.pod:839
1934 " lvcreate LV VG 100M\n"
1940 #: ../src/guestfs.pod:841
1942 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1943 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1944 "megabytes * megabytes) logical volume. The error message you get from this "
1945 "is also a little obscure."
1950 #: ../src/guestfs.pod:846
1952 "This could be fixed in the generator by specially marking parameters and "
1953 "return values which take bytes or other units."
1958 #: ../src/guestfs.pod:849
1959 msgid "Ambiguity between devices and paths"
1964 #: ../src/guestfs.pod:851
1966 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1967 "sdb2>) and a similar pathname. A file might just happen to be called "
1968 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1973 #: ../src/guestfs.pod:856
1975 "In the current API we usually resolve this ambiguity by having two separate "
1976 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1977 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1978 "detecting if the path supplied begins with C</dev/>."
1983 #: ../src/guestfs.pod:862
1985 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1986 "make paths/devices into structured names. One way to do this would be to "
1987 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1988 "aspect of grub. Another way would be to use a structured type, equivalent "
1989 "to this OCaml type:"
1994 #: ../src/guestfs.pod:868
1997 " type path = Path of string | Device of int | Partition of int * int\n"
2003 #: ../src/guestfs.pod:870
2004 msgid "which would allow you to pass arguments like:"
2009 #: ../src/guestfs.pod:872
2012 " Path \"/foo/bar\"\n"
2013 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2014 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2015 " Path \"/dev/sdb2\" (* not a device *)\n"
2021 #: ../src/guestfs.pod:877
2023 "As you can see there are still problems to resolve even with this "
2024 "representation. Also consider how it might work in guestfish."
2029 #: ../src/guestfs.pod:882
2030 msgid "KEYS AND PASSPHRASES"
2035 #: ../src/guestfs.pod:884
2037 "Certain libguestfs calls take a parameter that contains sensitive key "
2038 "material, passed in as a C string."
2043 #: ../src/guestfs.pod:887
2045 "In the future we would hope to change the libguestfs implementation so that "
2046 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2047 "swap. However this is I<not> done at the moment, because of the complexity "
2048 "of such an implementation."
2053 #: ../src/guestfs.pod:892
2055 "Therefore you should be aware that any key parameter you pass to libguestfs "
2056 "might end up being written out to the swap partition. If this is a concern, "
2057 "scrub the swap partition or don't use libguestfs on encrypted devices."
2062 #: ../src/guestfs.pod:897
2063 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2068 #: ../src/guestfs.pod:899
2070 "All high-level libguestfs actions are synchronous. If you want to use "
2071 "libguestfs asynchronously then you must create a thread."
2076 #: ../src/guestfs.pod:902
2078 "Only use the handle from a single thread. Either use the handle exclusively "
2079 "from one thread, or provide your own mutex so that two threads cannot issue "
2080 "calls on the same handle at the same time."
2085 #: ../src/guestfs.pod:906
2087 "See the graphical program guestfs-browser for one possible architecture for "
2088 "multithreaded programs using libvirt and libguestfs."
2093 #: ../src/guestfs.pod:909
2098 #: ../src/guestfs.pod:911
2100 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2106 #: ../src/guestfs.pod:914
2108 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2109 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2114 #: ../src/guestfs.pod:917
2116 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2117 "to change the directories that libguestfs will search in. The value is a "
2118 "colon-separated list of paths. The current directory is I<not> searched "
2119 "unless the path contains an empty element or C<.>. For example "
2120 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2121 "then C</usr/lib/guestfs>."
2126 #: ../src/guestfs.pod:924
2127 msgid "QEMU WRAPPERS"
2132 #: ../src/guestfs.pod:926
2134 "If you want to compile your own qemu, run qemu from a non-standard location, "
2135 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2141 #: ../src/guestfs.pod:930
2143 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2144 "last command in the shell script (so that qemu replaces the shell and "
2145 "becomes the direct child of the libguestfs-using program). If you don't do "
2146 "this, then the qemu process won't be cleaned up correctly."
2151 #: ../src/guestfs.pod:935
2153 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2159 #: ../src/guestfs.pod:938
2163 " qemudir=/home/rjones/d/qemu\n"
2164 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2170 #: ../src/guestfs.pod:942
2172 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2173 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2179 #: ../src/guestfs.pod:946
2182 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2188 #: ../src/guestfs.pod:948
2190 "Note that libguestfs also calls qemu with the -help and -version options in "
2191 "order to determine features."
2195 #: ../src/guestfs.pod:951
2196 msgid "ATTACHING TO RUNNING DAEMONS"
2200 #: ../src/guestfs.pod:953
2202 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2203 "babies. Use with caution."
2207 #: ../src/guestfs.pod:956
2209 "I<Note (2):> This section explains how to attach to a running daemon from a "
2210 "low level perspective. For most users, simply using virt tools such as "
2211 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2215 #: ../src/guestfs.pod:960
2216 msgid "Using guestfs_set_attach_method"
2220 #: ../src/guestfs.pod:962
2222 "By calling L</guestfs_set_attach_method> you can change how the library "
2223 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2224 "ARCHITECTURE> for some background)."
2228 #: ../src/guestfs.pod:966
2230 "The normal attach method is C<appliance>, where a small appliance is created "
2231 "containing the daemon, and then the library connects to this."
2235 #: ../src/guestfs.pod:969
2237 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2238 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2239 "daemon over the Unix domain socket."
2243 #: ../src/guestfs.pod:973
2245 "The normal use for this is to connect to a running virtual machine that "
2246 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2247 "files inside the live virtual machine."
2251 #: ../src/guestfs.pod:977
2252 msgid "Using guestfs_add_domain with live flag"
2256 #: ../src/guestfs.pod:979
2258 "L</guestfs_add_domain> provides some help for getting the correct attach "
2259 "method. If you pass the C<live> option to this function, then (if the "
2260 "virtual machine is running) it will examine the libvirt XML looking for a "
2261 "virtio-serial channel to connect to:"
2265 #: ../src/guestfs.pod:985
2272 " <channel type='unix'>\n"
2273 " <source mode='bind' path='/path/to/socket'/>\n"
2274 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2283 #: ../src/guestfs.pod:997
2285 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2286 "method to C<unix:/path/to/socket>."
2290 #: ../src/guestfs.pod:1000
2292 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2293 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2294 "to attach to and modify live virtual machines."
2298 #: ../src/guestfs.pod:1004
2300 "The virtual machine needs to have been set up beforehand so that it has the "
2301 "virtio-serial channel and so that guestfsd is running inside it."
2306 #: ../src/guestfs.pod:1008
2307 msgid "ABI GUARANTEE"
2312 #: ../src/guestfs.pod:1010
2314 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2315 "actions as outlined in this section. Although we will deprecate some "
2316 "actions, for example if they get replaced by newer calls, we will keep the "
2317 "old actions forever. This allows you the developer to program in confidence "
2318 "against the libguestfs API."
2323 #: ../src/guestfs.pod:1016
2324 msgid "BLOCK DEVICE NAMING"
2329 #: ../src/guestfs.pod:1018
2331 "In the kernel there is now quite a profusion of schemata for naming block "
2332 "devices (in this context, by I<block device> I mean a physical or virtual "
2333 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2334 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2335 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2336 "for the old IDE driver (particularly for SATA devices) those devices also "
2337 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2338 "paravirtualized drivers. This has created several different naming systems, "
2339 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2344 #: ../src/guestfs.pod:1030
2346 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2347 "Linux kernel to access block devices. We can run a variety of appliances "
2348 "based on a variety of Linux kernels."
2353 #: ../src/guestfs.pod:1034
2355 "This causes a problem for libguestfs because many API calls use device or "
2356 "partition names. Working scripts and the recipe (example) scripts that we "
2357 "make available over the internet could fail if the naming scheme changes."
2362 #: ../src/guestfs.pod:1039
2364 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2365 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2366 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2367 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2372 #: ../src/guestfs.pod:1045
2374 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2375 "L</guestfs_list_partitions> and similar calls return the true names of the "
2376 "devices and partitions as known to the appliance."
2381 #: ../src/guestfs.pod:1050
2382 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2387 #: ../src/guestfs.pod:1052
2389 "Usually this translation is transparent. However in some (very rare) cases "
2390 "you may need to know the exact algorithm. Such cases include where you use "
2391 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2392 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2397 #: ../src/guestfs.pod:1058
2399 "The algorithm is applied only to I<parameters> which are known to be either "
2400 "device or partition names. Return values from functions such as L</"
2401 "guestfs_list_devices> are never changed."
2406 #: ../src/guestfs.pod:1066
2407 msgid "Is the string a parameter which is a device or partition name?"
2412 #: ../src/guestfs.pod:1070
2413 msgid "Does the string begin with C</dev/sd>?"
2418 #: ../src/guestfs.pod:1074
2420 "Does the named device exist? If so, we use that device. However if I<not> "
2421 "then we continue with this algorithm."
2426 #: ../src/guestfs.pod:1079
2427 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2432 #: ../src/guestfs.pod:1081
2433 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2438 #: ../src/guestfs.pod:1083
2439 msgid "If that named device exists, use it. If not, continue."
2444 #: ../src/guestfs.pod:1087
2445 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2450 #: ../src/guestfs.pod:1089
2451 msgid "If that named device exists, use it. If not, return an error."
2456 #: ../src/guestfs.pod:1093
2457 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2462 #: ../src/guestfs.pod:1095
2464 "Although the standard naming scheme and automatic translation is useful for "
2465 "simple programs and guestfish scripts, for larger programs it is best not to "
2466 "rely on this mechanism."
2471 #: ../src/guestfs.pod:1099
2473 "Where possible for maximum future portability programs using libguestfs "
2474 "should use these future-proof techniques:"
2479 #: ../src/guestfs.pod:1106
2481 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2482 "device names, and then use those names directly."
2487 #: ../src/guestfs.pod:1109
2489 "Since those device names exist by definition, they will never be translated."
2494 #: ../src/guestfs.pod:1114
2496 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2497 "filesystem labels."
2502 #: ../src/guestfs.pod:1119
2508 #: ../src/guestfs.pod:1121
2510 "This section discusses security implications of using libguestfs, "
2511 "particularly with untrusted or malicious guests or disk images."
2516 #: ../src/guestfs.pod:1124
2517 msgid "GENERAL SECURITY CONSIDERATIONS"
2522 #: ../src/guestfs.pod:1126
2524 "Be careful with any files or data that you download from a guest (by "
2525 "\"download\" we mean not just the L</guestfs_download> command but any "
2526 "command that reads files, filenames, directories or anything else from a "
2527 "disk image). An attacker could manipulate the data to fool your program "
2528 "into doing the wrong thing. Consider cases such as:"
2533 #: ../src/guestfs.pod:1136
2534 msgid "the data (file etc) not being present"
2539 #: ../src/guestfs.pod:1140
2540 msgid "being present but empty"
2545 #: ../src/guestfs.pod:1144
2546 msgid "being much larger than normal"
2551 #: ../src/guestfs.pod:1148
2552 msgid "containing arbitrary 8 bit data"
2557 #: ../src/guestfs.pod:1152
2558 msgid "being in an unexpected character encoding"
2563 #: ../src/guestfs.pod:1156
2564 msgid "containing homoglyphs."
2569 #: ../src/guestfs.pod:1160
2570 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2575 #: ../src/guestfs.pod:1162
2577 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2578 "(VFS) module can sometimes be escalated into exploits by deliberately "
2579 "creating a malicious, malformed filesystem. These exploits are very severe "
2580 "for two reasons. Firstly there are very many filesystem drivers in the "
2581 "kernel, and many of them are infrequently used and not much developer "
2582 "attention has been paid to the code. Linux userspace helps potential "
2583 "crackers by detecting the filesystem type and automatically choosing the "
2584 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2585 "the administrator. Secondly, a kernel-level exploit is like a local root "
2586 "exploit (worse in some ways), giving immediate and total access to the "
2587 "system right down to the hardware level."
2592 #: ../src/guestfs.pod:1175
2594 "That explains why you should never mount a filesystem from an untrusted "
2595 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2596 "inside a qemu virtual machine, usually running as a non-root user. The "
2597 "attacker would need to write a filesystem which first exploited the kernel, "
2598 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2599 "the libguestfs protocol, and finally to be as serious as the host kernel "
2600 "exploit it would need to escalate its privileges to root. This multi-step "
2601 "escalation, performed by a static piece of data, is thought to be extremely "
2602 "hard to do, although we never say 'never' about security issues."
2607 #: ../src/guestfs.pod:1186
2609 "In any case callers can reduce the attack surface by forcing the filesystem "
2610 "type when mounting (use L</guestfs_mount_vfs>)."
2615 #: ../src/guestfs.pod:1189
2616 msgid "PROTOCOL SECURITY"
2621 #: ../src/guestfs.pod:1191
2623 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2624 "defined upper message size. However a program that uses libguestfs must "
2625 "also take care - for example you can write a program that downloads a binary "
2626 "from a disk image and executes it locally, and no amount of protocol "
2627 "security will save you from the consequences."
2632 #: ../src/guestfs.pod:1197
2633 msgid "INSPECTION SECURITY"
2638 #: ../src/guestfs.pod:1199
2640 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2641 "directly from the guest, and these could contain any 8 bit data. Callers "
2642 "should be careful to escape these before printing them to a structured file "
2643 "(for example, use HTML escaping if creating a web page)."
2648 #: ../src/guestfs.pod:1205
2650 "Guest configuration may be altered in unusual ways by the administrator of "
2651 "the virtual machine, and may not reflect reality (particularly for untrusted "
2652 "or actively malicious guests). For example we parse the hostname from "
2653 "configuration files like C</etc/sysconfig/network> that we find in the "
2654 "guest, but the guest administrator can easily manipulate these files to "
2655 "provide the wrong hostname."
2660 #: ../src/guestfs.pod:1213
2662 "The inspection API parses guest configuration using two external libraries: "
2663 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2664 "designed to be robust in the face of malicious data, although denial of "
2665 "service attacks are still possible, for example with oversized configuration "
2671 #: ../src/guestfs.pod:1219
2672 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2677 #: ../src/guestfs.pod:1221
2679 "Be very cautious about running commands from the guest. By running a "
2680 "command in the guest, you are giving CPU time to a binary that you do not "
2681 "control, under the same user account as the library, albeit wrapped in qemu "
2682 "virtualization. More information and alternatives can be found in the "
2683 "section L</RUNNING COMMANDS>."
2688 #: ../src/guestfs.pod:1227
2689 msgid "CVE-2010-3851"
2694 #: ../src/guestfs.pod:1229
2695 msgid "https://bugzilla.redhat.com/642934"
2700 #: ../src/guestfs.pod:1231
2702 "This security bug concerns the automatic disk format detection that qemu "
2703 "does on disk images."
2708 #: ../src/guestfs.pod:1234
2710 "A raw disk image is just the raw bytes, there is no header. Other disk "
2711 "images like qcow2 contain a special header. Qemu deals with this by looking "
2712 "for one of the known headers, and if none is found then assuming the disk "
2713 "image must be raw."
2718 #: ../src/guestfs.pod:1239
2720 "This allows a guest which has been given a raw disk image to write some "
2721 "other header. At next boot (or when the disk image is accessed by "
2722 "libguestfs) qemu would do autodetection and think the disk image format was, "
2723 "say, qcow2 based on the header written by the guest."
2728 #: ../src/guestfs.pod:1244
2730 "This in itself would not be a problem, but qcow2 offers many features, one "
2731 "of which is to allow a disk image to refer to another image (called the "
2732 "\"backing disk\"). It does this by placing the path to the backing disk "
2733 "into the qcow2 header. This path is not validated and could point to any "
2734 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2735 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2736 "control of the attacker."
2741 #: ../src/guestfs.pod:1252
2743 "In libguestfs this is rather hard to exploit except under two circumstances:"
2748 #: ../src/guestfs.pod:1259
2749 msgid "You have enabled the network or have opened the disk in write mode."
2754 #: ../src/guestfs.pod:1263
2756 "You are also running untrusted code from the guest (see L</RUNNING "
2762 #: ../src/guestfs.pod:1268
2764 "The way to avoid this is to specify the expected disk format when adding "
2765 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2766 "should always do this if the disk is raw format, and it's a good idea for "
2772 #: ../src/guestfs.pod:1273
2774 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2775 "format is fetched from libvirt and passed through."
2780 #: ../src/guestfs.pod:1276
2782 "For libguestfs tools, use the I<--format> command line parameter as "
2788 #: ../src/guestfs.pod:1279
2789 msgid "CONNECTION MANAGEMENT"
2794 #: ../src/guestfs.pod:1281
2800 #: ../src/guestfs.pod:1283
2802 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2803 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2804 "handle and release all resources used."
2808 #: ../src/guestfs.pod:1287
2810 "For information on using multiple handles and threads, see the section L</"
2811 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2816 #: ../src/guestfs.pod:1290
2817 msgid "guestfs_create"
2822 #: ../src/guestfs.pod:1292
2825 " guestfs_h *guestfs_create (void);\n"
2831 #: ../src/guestfs.pod:1294
2832 msgid "Create a connection handle."
2836 #: ../src/guestfs.pod:1296
2838 "On success this returns a non-NULL pointer to a handle. On error it returns "
2843 #: ../src/guestfs.pod:1299
2845 "You have to \"configure\" the handle after creating it. This includes "
2846 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2847 "handle at least once."
2852 #: ../src/guestfs.pod:1303
2853 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2857 #: ../src/guestfs.pod:1305
2859 "You may also want to configure error handling for the handle. See the L</"
2860 "ERROR HANDLING> section below."
2865 #: ../src/guestfs.pod:1308
2866 msgid "guestfs_close"
2871 #: ../src/guestfs.pod:1310
2874 " void guestfs_close (guestfs_h *g);\n"
2880 #: ../src/guestfs.pod:1312
2881 msgid "This closes the connection handle and frees up all resources used."
2885 #: ../src/guestfs.pod:1314
2887 "If autosync was set on the handle and the handle was launched, then this "
2888 "implicitly calls various functions to unmount filesystems and sync the "
2889 "disk. See L</guestfs_set_autosync> for more details."
2893 #: ../src/guestfs.pod:1318
2894 msgid "If a close callback was set on the handle, then it is called."
2899 #: ../src/guestfs.pod:1320
2900 msgid "ERROR HANDLING"
2905 #: ../src/guestfs.pod:1322
2907 "API functions can return errors. For example, almost all functions that "
2908 "return C<int> will return C<-1> to indicate an error."
2913 #: ../src/guestfs.pod:1325
2915 "Additional information is available for errors: an error message string and "
2916 "optionally an error number (errno) if the thing that failed was a system "
2922 #: ../src/guestfs.pod:1329
2924 "You can get at the additional information about the last error on the handle "
2925 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2926 "up an error handler with L</guestfs_set_error_handler>."
2931 #: ../src/guestfs.pod:1334
2933 "When the handle is created, a default error handler is installed which "
2934 "prints the error message string to C<stderr>. For small short-running "
2935 "command line programs it is sufficient to do:"
2940 #: ../src/guestfs.pod:1338
2943 " if (guestfs_launch (g) == -1)\n"
2944 " exit (EXIT_FAILURE);\n"
2950 #: ../src/guestfs.pod:1341
2952 "since the default error handler will ensure that an error message has been "
2953 "printed to C<stderr> before the program exits."
2958 #: ../src/guestfs.pod:1344
2960 "For other programs the caller will almost certainly want to install an "
2961 "alternate error handler or do error handling in-line like this:"
2966 #: ../src/guestfs.pod:1347
2969 " g = guestfs_create ();\n"
2975 #: ../src/guestfs.pod:1349
2978 " /* This disables the default behaviour of printing errors\n"
2980 " guestfs_set_error_handler (g, NULL, NULL);\n"
2986 #: ../src/guestfs.pod:1353
2989 " if (guestfs_launch (g) == -1) {\n"
2990 " /* Examine the error message and print it etc. */\n"
2991 " char *msg = guestfs_last_error (g);\n"
2992 " int errnum = guestfs_last_errno (g);\n"
2993 " fprintf (stderr, \"%s\\n\", msg);\n"
3001 #: ../src/guestfs.pod:1361
3003 "Out of memory errors are handled differently. The default action is to call "
3004 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3005 "guestfs_set_out_of_memory_handler>."
3010 #: ../src/guestfs.pod:1365
3012 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3013 "because there is no handle if this happens there is no way to get additional "
3014 "error information. However L</guestfs_create> is supposed to be a "
3015 "lightweight operation which can only fail because of insufficient memory (it "
3016 "returns NULL in this case)."
3021 #: ../src/guestfs.pod:1371
3022 msgid "guestfs_last_error"
3027 #: ../src/guestfs.pod:1373
3030 " const char *guestfs_last_error (guestfs_h *g);\n"
3036 #: ../src/guestfs.pod:1375
3038 "This returns the last error message that happened on C<g>. If there has not "
3039 "been an error since the handle was created, then this returns C<NULL>."
3044 #: ../src/guestfs.pod:1379
3046 "The lifetime of the returned string is until the next error occurs, or L</"
3047 "guestfs_close> is called."
3052 #: ../src/guestfs.pod:1382
3053 msgid "guestfs_last_errno"
3058 #: ../src/guestfs.pod:1384
3061 " int guestfs_last_errno (guestfs_h *g);\n"
3067 #: ../src/guestfs.pod:1386
3068 msgid "This returns the last error number (errno) that happened on C<g>."
3073 #: ../src/guestfs.pod:1388
3074 msgid "If successful, an errno integer not equal to zero is returned."
3079 #: ../src/guestfs.pod:1390
3081 "If no error, this returns 0. This call can return 0 in three situations:"
3086 #: ../src/guestfs.pod:1397
3087 msgid "There has not been any error on the handle."
3092 #: ../src/guestfs.pod:1401
3094 "There has been an error but the errno was meaningless. This corresponds to "
3095 "the case where the error did not come from a failed system call, but for "
3096 "some other reason."
3101 #: ../src/guestfs.pod:1407
3103 "There was an error from a failed system call, but for some reason the errno "
3104 "was not captured and returned. This usually indicates a bug in libguestfs."
3109 #: ../src/guestfs.pod:1413
3111 "Libguestfs tries to convert the errno from inside the applicance into a "
3112 "corresponding errno for the caller (not entirely trivial: the appliance "
3113 "might be running a completely different operating system from the library "
3114 "and error numbers are not standardized across Un*xen). If this could not be "
3115 "done, then the error is translated to C<EINVAL>. In practice this should "
3116 "only happen in very rare circumstances."
3121 #: ../src/guestfs.pod:1421
3122 msgid "guestfs_set_error_handler"
3127 #: ../src/guestfs.pod:1423
3130 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3132 " const char *msg);\n"
3133 " void guestfs_set_error_handler (guestfs_h *g,\n"
3134 " guestfs_error_handler_cb cb,\n"
3141 #: ../src/guestfs.pod:1430
3143 "The callback C<cb> will be called if there is an error. The parameters "
3144 "passed to the callback are an opaque data pointer and the error message "
3150 #: ../src/guestfs.pod:1434
3152 "C<errno> is not passed to the callback. To get that the callback must call "
3153 "L</guestfs_last_errno>."
3158 #: ../src/guestfs.pod:1437
3160 "Note that the message string C<msg> is freed as soon as the callback "
3161 "function returns, so if you want to stash it somewhere you must make your "
3167 #: ../src/guestfs.pod:1441
3168 msgid "The default handler prints messages on C<stderr>."
3173 #: ../src/guestfs.pod:1443
3174 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3179 #: ../src/guestfs.pod:1445
3180 msgid "guestfs_get_error_handler"
3185 #: ../src/guestfs.pod:1447
3188 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3189 " void **opaque_rtn);\n"
3195 #: ../src/guestfs.pod:1450
3196 msgid "Returns the current error handler callback."
3201 #: ../src/guestfs.pod:1452
3202 msgid "guestfs_set_out_of_memory_handler"
3207 #: ../src/guestfs.pod:1454
3210 " typedef void (*guestfs_abort_cb) (void);\n"
3211 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3212 " guestfs_abort_cb);\n"
3218 #: ../src/guestfs.pod:1458
3220 "The callback C<cb> will be called if there is an out of memory situation. "
3221 "I<Note this callback must not return>."
3226 #: ../src/guestfs.pod:1461
3227 msgid "The default is to call L<abort(3)>."
3232 #: ../src/guestfs.pod:1463
3234 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3239 #: ../src/guestfs.pod:1466
3240 msgid "guestfs_get_out_of_memory_handler"
3245 #: ../src/guestfs.pod:1468
3248 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3254 #: ../src/guestfs.pod:1470
3255 msgid "This returns the current out of memory handler."
3260 #: ../src/guestfs.pod:1472
3266 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
3272 #: ../src/guestfs.pod:1476
3278 #: ../src/guestfs.pod:1478
3284 #: ../src/guestfs.pod:1480
3285 msgid "AVAILABILITY"
3290 #: ../src/guestfs.pod:1482
3291 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3296 #: ../src/guestfs.pod:1484
3298 "Using L</guestfs_available> you can test availability of the following "
3299 "groups of functions. This test queries the appliance to see if the "
3300 "appliance you are currently using supports the functionality."
3305 #: ../src/guestfs.pod:1489
3306 msgid "@AVAILABILITY@"
3311 #: ../src/guestfs.pod:1491
3312 msgid "GUESTFISH supported COMMAND"
3317 #: ../src/guestfs.pod:1493
3319 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3320 "prints out the available groups and whether they are supported by this build "
3321 "of libguestfs. Note however that you have to do C<run> first."
3326 #: ../src/guestfs.pod:1498
3327 msgid "SINGLE CALLS AT COMPILE TIME"
3332 #: ../src/guestfs.pod:1500
3334 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3335 "function, such as:"
3340 #: ../src/guestfs.pod:1503
3343 " #define LIBGUESTFS_HAVE_DD 1\n"
3349 #: ../src/guestfs.pod:1505
3350 msgid "if L</guestfs_dd> is available."
3355 #: ../src/guestfs.pod:1507
3357 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3358 "function is available at compile time, we recommended using build tools such "
3359 "as autoconf or cmake. For example in autotools you could use:"
3364 #: ../src/guestfs.pod:1512
3367 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3368 " AC_CHECK_FUNCS([guestfs_dd])\n"
3374 #: ../src/guestfs.pod:1515
3376 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3382 #: ../src/guestfs.pod:1518
3383 msgid "SINGLE CALLS AT RUN TIME"
3388 #: ../src/guestfs.pod:1520
3390 "Testing at compile time doesn't guarantee that a function really exists in "
3391 "the library. The reason is that you might be dynamically linked against a "
3392 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3393 "This situation unfortunately results in a segmentation fault, which is a "
3394 "shortcoming of the C dynamic linking system itself."
3399 #: ../src/guestfs.pod:1527
3401 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3402 "in this example program (note that you still need the compile time check as "
3408 #: ../src/guestfs.pod:1531
3411 " #include <stdio.h>\n"
3412 " #include <stdlib.h>\n"
3413 " #include <unistd.h>\n"
3414 " #include <dlfcn.h>\n"
3415 " #include <guestfs.h>\n"
3421 #: ../src/guestfs.pod:1537
3426 " #ifdef LIBGUESTFS_HAVE_DD\n"
3428 " int has_function;\n"
3434 #: ../src/guestfs.pod:1543
3437 " /* Test if the function guestfs_dd is really available. */\n"
3438 " dl = dlopen (NULL, RTLD_LAZY);\n"
3440 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3441 " exit (EXIT_FAILURE);\n"
3443 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3450 #: ../src/guestfs.pod:1552
3453 " if (!has_function)\n"
3454 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3456 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3457 " /* Now it's safe to call\n"
3458 " guestfs_dd (g, \"foo\", \"bar\");\n"
3462 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3470 #: ../src/guestfs.pod:1565
3472 "You may think the above is an awful lot of hassle, and it is. There are "
3473 "other ways outside of the C linking system to ensure that this kind of "
3474 "incompatibility never arises, such as using package versioning:"
3479 #: ../src/guestfs.pod:1570
3482 " Requires: libguestfs >= 1.0.80\n"
3488 #: ../src/guestfs.pod:1572
3489 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3494 #: ../src/guestfs.pod:1574
3496 "A recent feature of the API is the introduction of calls which take optional "
3497 "arguments. In C these are declared 3 ways. The main way is as a call which "
3498 "takes variable arguments (ie. C<...>), as in this example:"
3503 #: ../src/guestfs.pod:1579
3506 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3512 #: ../src/guestfs.pod:1581
3514 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3515 "call with no optional arguments specified:"
3520 #: ../src/guestfs.pod:1584
3523 " guestfs_add_drive_opts (g, filename, -1);\n"
3529 #: ../src/guestfs.pod:1586
3530 msgid "With a single optional argument:"
3535 #: ../src/guestfs.pod:1588
3538 " guestfs_add_drive_opts (g, filename,\n"
3539 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3546 #: ../src/guestfs.pod:1592
3552 #: ../src/guestfs.pod:1594
3555 " guestfs_add_drive_opts (g, filename,\n"
3556 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3557 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3564 #: ../src/guestfs.pod:1599
3566 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3572 #: ../src/guestfs.pod:1602
3573 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3578 #: ../src/guestfs.pod:1604
3580 "The second variant has the same name with the suffix C<_va>, which works the "
3581 "same way but takes a C<va_list>. See the C manual for details. For the "
3582 "example function, this is declared:"
3587 #: ../src/guestfs.pod:1608
3590 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3597 #: ../src/guestfs.pod:1611
3598 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3603 #: ../src/guestfs.pod:1613
3605 "The third variant is useful where you need to construct these calls. You "
3606 "pass in a structure where you fill in the optional fields. The structure "
3607 "has a bitmask as the first element which you must set to indicate which "
3608 "fields you have filled in. For our example function the structure and call "
3614 #: ../src/guestfs.pod:1619
3617 " struct guestfs_add_drive_opts_argv {\n"
3618 " uint64_t bitmask;\n"
3620 " const char *format;\n"
3623 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3624 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3630 #: ../src/guestfs.pod:1628
3631 msgid "You could call it like this:"
3636 #: ../src/guestfs.pod:1630
3639 " struct guestfs_add_drive_opts_argv optargs = {\n"
3640 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3641 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3643 " .format = \"qcow2\"\n"
3650 #: ../src/guestfs.pod:1637
3653 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3659 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3660 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:9
3661 #: ../fish/guestfish-actions.pod:1265 ../tools/virt-win-reg.pl:703
3667 #: ../src/guestfs.pod:1645
3668 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3673 #: ../src/guestfs.pod:1650
3674 msgid "You do not need to fill in all fields of the structure."
3679 #: ../src/guestfs.pod:1654
3681 "There must be a one-to-one correspondence between fields of the structure "
3682 "that are filled in, and bits set in the bitmask."
3687 #: ../src/guestfs.pod:1659
3688 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3693 #: ../src/guestfs.pod:1661
3695 "In other languages, optional arguments are expressed in the way that is "
3696 "natural for that language. We refer you to the language-specific "
3697 "documentation for more details on that."
3702 #: ../src/guestfs.pod:1665
3703 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3708 #: ../src/guestfs.pod:1667
3709 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3713 #: ../src/guestfs.pod:1669
3715 "B<Note:> This section documents the generic event mechanism introduced in "
3716 "libguestfs 1.10, which you should use in new code if possible. The old "
3717 "functions C<guestfs_set_log_message_callback>, "
3718 "C<guestfs_set_subprocess_quit_callback>, "
3719 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3720 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3721 "page. Because of the ABI guarantee, the old functions continue to work."
3725 #: ../src/guestfs.pod:1678
3727 "Handles generate events when certain things happen, such as log messages "
3728 "being generated, progress messages during long-running operations, or the "
3729 "handle being closed. The API calls described below let you register a "
3730 "callback to be called when events happen. You can register multiple "
3731 "callbacks (for the same, different or overlapping sets of events), and "
3732 "individually remove callbacks. If callbacks are not removed, then they "
3733 "remain in force until the handle is closed."
3737 #: ../src/guestfs.pod:1686
3739 "In the current implementation, events are only generated synchronously: that "
3740 "means that events (and hence callbacks) can only happen while you are in the "
3741 "middle of making another libguestfs call. The callback is called in the "
3746 #: ../src/guestfs.pod:1691
3748 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3749 "unsigned integers, or a message buffer. Payloads are discussed later on."
3753 #: ../src/guestfs.pod:1695
3754 msgid "CLASSES OF EVENTS"
3758 #: ../src/guestfs.pod:1699
3759 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3763 #: ../src/guestfs.pod:1702
3765 "The callback function will be called while the handle is being closed "
3766 "(synchronously from L</guestfs_close>)."
3771 #: ../src/guestfs.pod:1705
3773 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3774 "handles that are open when the program exits. This means that this callback "
3775 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3776 "problems in higher-level languages (eg. if your HLL interpreter has already "
3777 "been cleaned up by the time this is called, and if your callback then jumps "
3778 "into some HLL function)."
3782 #: ../src/guestfs.pod:1712
3784 "If no callback is registered: the handle is closed without any callback "
3789 #: ../src/guestfs.pod:1715
3790 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3794 #: ../src/guestfs.pod:1718
3796 "The callback function will be called when the child process quits, either "
3797 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3798 "corresponds to a transition from any state to the CONFIG state)."
3802 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3803 msgid "If no callback is registered: the event is ignored."
3807 #: ../src/guestfs.pod:1724
3808 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3812 #: ../src/guestfs.pod:1727
3814 "The callback function will be called when the child process becomes ready "
3815 "first time after it has been launched. (This corresponds to a transition "
3816 "from LAUNCHING to the READY state)."
3820 #: ../src/guestfs.pod:1733
3821 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3826 #: ../src/guestfs.pod:1736
3828 "Some long-running operations can generate progress messages. If this "
3829 "callback is registered, then it will be called each time a progress message "
3830 "is generated (usually two seconds after the operation started, and three "
3831 "times per second thereafter until it completes, although the frequency may "
3832 "change in future versions)."
3836 #: ../src/guestfs.pod:1742
3838 "The callback receives in the payload four unsigned 64 bit numbers which are "
3839 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3843 #: ../src/guestfs.pod:1745
3845 "The units of C<total> are not defined, although for some operations C<total> "
3846 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3847 "or megabytes), and C<position> may be the portion which has been transferred."
3852 #: ../src/guestfs.pod:1750
3853 msgid "The only defined and stable parts of the API are:"
3858 #: ../src/guestfs.pod:1756
3860 "The callback can display to the user some type of progress bar or indicator "
3861 "which shows the ratio of C<position>:C<total>."
3866 #: ../src/guestfs.pod:1761
3867 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3871 #: ../src/guestfs.pod:1765
3873 "If any progress notification is sent during a call, then a final progress "
3874 "notification is always sent when C<position> = C<total> (I<unless> the call "
3875 "fails with an error)."
3880 #: ../src/guestfs.pod:1769
3882 "This is to simplify caller code, so callers can easily set the progress "
3883 "indicator to \"100%\" at the end of the operation, without requiring special "
3884 "code to detect this case."
3888 #: ../src/guestfs.pod:1775
3890 "For some calls we are unable to estimate the progress of the call, but we "
3891 "can still generate progress messages to indicate activity. This is known as "
3892 "\"pulse mode\", and is directly supported by certain progress bar "
3893 "implementations (eg. GtkProgressBar)."
3897 #: ../src/guestfs.pod:1780
3899 "For these calls, zero or more progress messages are generated with "
3900 "C<position = 0> and C<total = 1>, followed by a final message with "
3901 "C<position = total = 1>."
3905 #: ../src/guestfs.pod:1784
3907 "As noted above, if the call fails with an error then the final message may "
3912 #: ../src/guestfs.pod:1789
3914 "The callback also receives the procedure number (C<proc_nr>) and serial "
3915 "number (C<serial>) of the call. These are only useful for debugging "
3916 "protocol issues, and the callback can normally ignore them. The callback "
3917 "may want to print these numbers in error messages or debugging messages."
3921 #: ../src/guestfs.pod:1795
3922 msgid "If no callback is registered: progress messages are discarded."
3926 #: ../src/guestfs.pod:1797
3927 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3931 #: ../src/guestfs.pod:1800
3933 "The callback function is called whenever a log message is generated by qemu, "
3934 "the appliance kernel, guestfsd (daemon), or utility programs."
3938 #: ../src/guestfs.pod:1803
3940 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3941 "guestfs_launch>) then additional debug messages are generated."
3945 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3947 "If no callback is registered: the messages are discarded unless the verbose "
3948 "flag is set in which case they are sent to stderr. You can override the "
3949 "printing of verbose messages to stderr by setting up a callback."
3953 #: ../src/guestfs.pod:1811
3954 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3958 #: ../src/guestfs.pod:1814
3960 "The callback function is called whenever a log message is generated by the "
3961 "library part of libguestfs."
3965 #: ../src/guestfs.pod:1817
3967 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3968 "messages are generated."
3972 #: ../src/guestfs.pod:1825
3973 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3977 #: ../src/guestfs.pod:1828
3979 "The callback function is called whenever a trace message is generated. This "
3980 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3984 #: ../src/guestfs.pod:1831
3986 "If no callback is registered: the messages are sent to stderr. You can "
3987 "override the printing of trace messages to stderr by setting up a callback."
3991 #: ../src/guestfs.pod:1837
3992 msgid "guestfs_set_event_callback"
3996 #: ../src/guestfs.pod:1839
3999 " int guestfs_set_event_callback (guestfs_h *g,\n"
4000 " guestfs_event_callback cb,\n"
4001 " uint64_t event_bitmask,\n"
4008 #: ../src/guestfs.pod:1845
4010 "This function registers a callback (C<cb>) for all event classes in the "
4015 #: ../src/guestfs.pod:1848
4017 "For example, to register for all log message events, you could call this "
4018 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4019 "To register a single callback for all possible classes of events, use "
4020 "C<GUESTFS_EVENT_ALL>."
4024 #: ../src/guestfs.pod:1854
4025 msgid "C<flags> should always be passed as 0."
4029 #: ../src/guestfs.pod:1856
4031 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4032 "it for any purpose."
4036 #: ../src/guestfs.pod:1859
4038 "The return value is the event handle (an integer) which you can use to "
4039 "delete the callback (see below)."
4043 #: ../src/guestfs.pod:1862
4045 "If there is an error, this function returns C<-1>, and sets the error in the "
4046 "handle in the usual way (see L</guestfs_last_error> etc.)"
4050 #: ../src/guestfs.pod:1865
4052 "Callbacks remain in effect until they are deleted, or until the handle is "
4057 #: ../src/guestfs.pod:1868
4059 "In the case where multiple callbacks are registered for a particular event "
4060 "class, all of the callbacks are called. The order in which multiple "
4061 "callbacks are called is not defined."
4065 #: ../src/guestfs.pod:1872
4066 msgid "guestfs_delete_event_callback"
4070 #: ../src/guestfs.pod:1874
4073 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4078 #: ../src/guestfs.pod:1876
4080 "Delete a callback that was previously registered. C<event_handle> should be "
4081 "the integer that was returned by a previous call to "
4082 "C<guestfs_set_event_callback> on the same handle."
4086 #: ../src/guestfs.pod:1880
4087 msgid "guestfs_event_callback"
4091 #: ../src/guestfs.pod:1882
4094 " typedef void (*guestfs_event_callback) (\n"
4097 " uint64_t event,\n"
4098 " int event_handle,\n"
4100 " const char *buf, size_t buf_len,\n"
4101 " const uint64_t *array, size_t array_len);\n"
4106 #: ../src/guestfs.pod:1891
4108 "This is the type of the event callback function that you have to provide."
4112 #: ../src/guestfs.pod:1894
4114 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4115 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4116 "handle, and C<flags> which in the current API you should ignore."
4120 #: ../src/guestfs.pod:1898
4122 "The remaining parameters contain the event payload (if any). Each event may "
4123 "contain a payload, which usually relates to the event class, but for future "
4124 "proofing your code should be written to handle any payload for any event "
4129 #: ../src/guestfs.pod:1903
4131 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4132 "there is no message buffer). Note that this message buffer can contain "
4133 "arbitrary 8 bit data, including NUL bytes."
4137 #: ../src/guestfs.pod:1907
4139 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4140 "moment this is only used for progress messages."
4144 #: ../src/guestfs.pod:1910
4145 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4149 #: ../src/guestfs.pod:1912
4151 "One motivation for the generic event API was to allow GUI programs to "
4152 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4153 "unconditionally to C<stderr>."
4157 #: ../src/guestfs.pod:1916
4159 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4160 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4161 "messages are not events; you must capture error messages separately)."
4165 #: ../src/guestfs.pod:1921
4167 "Programs have to set up a callback to capture the classes of events of "
4172 #: ../src/guestfs.pod:1924
4176 " guestfs_set_event_callback\n"
4177 " (g, message_callback,\n"
4178 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4179 " GUESTFS_EVENT_TRACE,\n"
4180 " 0, NULL) == -1)\n"
4181 " if (eh == -1) {\n"
4182 " // handle error in the usual way\n"
4188 #: ../src/guestfs.pod:1934
4190 "The callback can then direct messages to the appropriate place. In this "
4191 "example, messages are directed to syslog:"
4195 #: ../src/guestfs.pod:1937
4199 " message_callback (\n"
4202 " uint64_t event,\n"
4203 " int event_handle,\n"
4205 " const char *buf, size_t buf_len,\n"
4206 " const uint64_t *array, size_t array_len)\n"
4208 " const int priority = LOG_USER|LOG_INFO;\n"
4209 " if (buf_len > 0)\n"
4210 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4217 #: ../src/guestfs.pod:1952
4218 msgid "PRIVATE DATA AREA"
4222 #: ../src/guestfs.pod:1954
4224 "You can attach named pieces of private data to the libguestfs handle, fetch "
4225 "them by name, and walk over them, for the lifetime of the handle. This is "
4226 "called the private data area and is only available from the C API."
4231 #: ../src/guestfs.pod:1959
4232 msgid "To attach a named piece of data, use the following call:"
4237 #: ../src/guestfs.pod:1961
4240 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4245 #: ../src/guestfs.pod:1963
4247 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4248 "pointer (which can be C<NULL>). Any previous item with the same key is "
4253 #: ../src/guestfs.pod:1967
4255 "You can use any C<key> you want, but your key should I<not> start with an "
4256 "underscore character. Keys beginning with an underscore character are "
4257 "reserved for internal libguestfs purposes (eg. for implementing language "
4258 "bindings). It is recommended that you prefix the key with some unique "
4259 "string to avoid collisions with other users."
4264 #: ../src/guestfs.pod:1973
4265 msgid "To retrieve the pointer, use:"
4270 #: ../src/guestfs.pod:1975
4273 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4279 #: ../src/guestfs.pod:1977
4281 "This function returns C<NULL> if either no data is found associated with "
4282 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4287 #: ../src/guestfs.pod:1981
4289 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4290 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4291 "all. In particular, libguestfs does I<not> try to free the data when the "
4292 "handle is closed. If the data must be freed, then the caller must either "
4293 "free it before calling L</guestfs_close> or must set up a close callback to "
4294 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4298 #: ../src/guestfs.pod:1988
4299 msgid "To walk over all entries, use these two functions:"
4303 #: ../src/guestfs.pod:1990
4306 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4311 #: ../src/guestfs.pod:1992
4314 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4319 #: ../src/guestfs.pod:1994
4321 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4322 "not have any particular meaning -- keys are not returned in any defined "
4323 "order). A pointer to the key is returned in C<*key_rtn> and the "
4324 "corresponding data pointer is returned from the function. C<NULL> is "
4325 "returned if there are no keys stored in the handle."
4329 #: ../src/guestfs.pod:2000
4331 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4332 "value of this function is also C<NULL> is there are no further entries to "
4337 #: ../src/guestfs.pod:2004
4338 msgid "Notes about walking over entries:"
4342 #: ../src/guestfs.pod:2010
4344 "You must not call C<guestfs_set_private> while walking over the entries."
4348 #: ../src/guestfs.pod:2015
4350 "The handle maintains an internal iterator which is reset when you call "
4351 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4352 "call C<guestfs_set_private>."
4356 #: ../src/guestfs.pod:2021
4357 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4361 #: ../src/guestfs.pod:2023
4364 " guestfs_set_private (g, key, NULL);\n"
4369 #: ../src/guestfs.pod:2025
4370 msgid "then that C<key> is not returned when walking."
4374 #: ../src/guestfs.pod:2029
4376 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4377 "C<guestfs_next_private> or C<guestfs_set_private>."
4381 #: ../src/guestfs.pod:2035
4383 "The following example code shows how to print all keys and data pointers "
4384 "that are associated with the handle C<g>:"
4388 #: ../src/guestfs.pod:2038
4391 " const char *key;\n"
4392 " void *data = guestfs_first_private (g, &key);\n"
4393 " while (data != NULL)\n"
4395 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4396 " data = guestfs_next_private (g, &key);\n"
4402 #: ../src/guestfs.pod:2046
4404 "More commonly you are only interested in keys that begin with an application-"
4405 "specific prefix C<foo_>. Modify the loop like so:"
4409 #: ../src/guestfs.pod:2049
4412 " const char *key;\n"
4413 " void *data = guestfs_first_private (g, &key);\n"
4414 " while (data != NULL)\n"
4416 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4417 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4418 " data = guestfs_next_private (g, &key);\n"
4424 #: ../src/guestfs.pod:2058
4426 "If you need to modify keys while walking, then you have to jump back to the "
4427 "beginning of the loop. For example, to delete all keys prefixed with "
4432 #: ../src/guestfs.pod:2062
4435 " const char *key;\n"
4438 " data = guestfs_first_private (g, &key);\n"
4439 " while (data != NULL)\n"
4441 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4443 " guestfs_set_private (g, key, NULL);\n"
4444 " /* note that 'key' pointer is now invalid, and so is\n"
4445 " the internal iterator */\n"
4448 " data = guestfs_next_private (g, &key);\n"
4454 #: ../src/guestfs.pod:2078
4456 "Note that the above loop is guaranteed to terminate because the keys are "
4457 "being deleted, but other manipulations of keys within the loop might not "
4458 "terminate unless you also maintain an indication of which keys have been "
4464 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4470 #: ../src/guestfs.pod:2085
4472 "<!-- old anchor for the next section --> <a name="
4473 "\"state_machine_and_low_level_event_api\"/>"
4478 #: ../src/guestfs.pod:2090
4479 msgid "ARCHITECTURE"
4484 #: ../src/guestfs.pod:2092
4486 "Internally, libguestfs is implemented by running an appliance (a special "
4487 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4488 "process of the main program."
4493 #: ../src/guestfs.pod:2096
4496 " ___________________\n"
4498 " | main program |\n"
4500 " | | child process / appliance\n"
4501 " | | __________________________\n"
4503 " +-------------------+ RPC | +-----------------+ |\n"
4504 " | libguestfs <--------------------> guestfsd | |\n"
4505 " | | | +-----------------+ |\n"
4506 " \\___________________/ | | Linux kernel | |\n"
4507 " | +--^--------------+ |\n"
4508 " \\_________|________________/\n"
4514 " \\______________/\n"
4520 #: ../src/guestfs.pod:2116
4522 "The library, linked to the main program, creates the child process and hence "
4523 "the appliance in the L</guestfs_launch> function."
4528 #: ../src/guestfs.pod:2119
4530 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4531 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4532 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4533 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4534 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4535 "attached to the qemu process which translates device access by the "
4536 "appliance's Linux kernel into accesses to the image."
4541 #: ../src/guestfs.pod:2128
4543 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4544 "Although the disk image you are attached to might also be used by some "
4545 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4546 "care if both libguestfs's qemu process and your virtual machine are trying "
4547 "to update the disk image at the same time, since these usually results in "
4548 "massive disk corruption)."
4553 #: ../src/guestfs.pod:2135
4554 msgid "STATE MACHINE"
4559 #: ../src/guestfs.pod:2137
4560 msgid "libguestfs uses a state machine to model the child process:"
4565 #: ../src/guestfs.pod:2139
4577 " / | \\ \\ guestfs_launch\n"
4578 " / | _\\__V______\n"
4580 " / | | LAUNCHING |\n"
4581 " / | \\___________/\n"
4583 " / | guestfs_launch\n"
4585 " ______ / __|____V\n"
4586 " / \\ ------> / \\\n"
4587 " | BUSY | | READY |\n"
4588 " \\______/ <------ \\________/\n"
4594 #: ../src/guestfs.pod:2161
4596 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4597 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4598 "(3) alternating between READY and BUSY as commands are issued to, and "
4599 "carried out by, the child process."
4604 #: ../src/guestfs.pod:2166
4606 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4607 "asynchronously at any time (eg. due to some internal error), and that causes "
4608 "the state to transition back to CONFIG."
4613 #: ../src/guestfs.pod:2170
4615 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4616 "issued when in the CONFIG state."
4621 #: ../src/guestfs.pod:2173
4623 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4624 "L</guestfs_launch> blocks until the child process is READY to accept "
4625 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4626 "moves the state from CONFIG to LAUNCHING while it is running."
4631 #: ../src/guestfs.pod:2179
4633 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4634 "state. These API calls block waiting for the command to be carried out (ie. "
4635 "the state to transition to BUSY and then back to READY). There are no non-"
4636 "blocking versions, and no way to issue more than one command per handle at "
4642 #: ../src/guestfs.pod:2185
4644 "Finally, the child process sends asynchronous messages back to the main "
4645 "program, such as kernel log messages. You can register a callback to "
4646 "receive these messages."
4651 #: ../src/guestfs.pod:2189
4657 #: ../src/guestfs.pod:2191
4658 msgid "COMMUNICATION PROTOCOL"
4663 #: ../src/guestfs.pod:2193
4665 "Don't rely on using this protocol directly. This section documents how it "
4666 "currently works, but it may change at any time."
4671 #: ../src/guestfs.pod:2196
4673 "The protocol used to talk between the library and the daemon running inside "
4674 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4675 "1014, RFC 1832, RFC 4506)."
4680 #: ../src/guestfs.pod:2200
4682 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4683 "this file is automatically generated)."
4688 #: ../src/guestfs.pod:2203
4690 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4691 "and C<FileOut> parameters, which are handled with very simple request/reply "
4692 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4693 "parameters, which use the same request and reply messages, but they may also "
4694 "be followed by files sent using a chunked encoding."
4699 #: ../src/guestfs.pod:2210
4700 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4705 #: ../src/guestfs.pod:2212
4706 msgid "For ordinary functions, the request message is:"
4711 #: ../src/guestfs.pod:2214
4714 " total length (header + arguments,\n"
4715 " but not including the length word itself)\n"
4716 " struct guestfs_message_header (encoded as XDR)\n"
4717 " struct guestfs_<foo>_args (encoded as XDR)\n"
4723 #: ../src/guestfs.pod:2219
4725 "The total length field allows the daemon to allocate a fixed size buffer "
4726 "into which it slurps the rest of the message. As a result, the total length "
4727 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4728 "effective size of any request is limited to somewhere under this size."
4733 #: ../src/guestfs.pod:2225
4735 "Note also that many functions don't take any arguments, in which case the "
4736 "C<guestfs_I<foo>_args> is completely omitted."
4741 #: ../src/guestfs.pod:2228
4743 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4744 "receiver knows what type of args structure to expect, or none at all."
4749 #: ../src/guestfs.pod:2232
4751 "For functions that take optional arguments, the optional arguments are "
4752 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4753 "arguments. A bitmask in the header indicates which optional arguments are "
4754 "meaningful. The bitmask is also checked to see if it contains bits set "
4755 "which the daemon does not know about (eg. if more optional arguments were "
4756 "added in a later version of the library), and this causes the call to be "
4762 #: ../src/guestfs.pod:2240
4763 msgid "The reply message for ordinary functions is:"
4768 #: ../src/guestfs.pod:2242
4771 " total length (header + ret,\n"
4772 " but not including the length word itself)\n"
4773 " struct guestfs_message_header (encoded as XDR)\n"
4774 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4780 #: ../src/guestfs.pod:2247
4782 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4783 "functions that return no formal return values."
4788 #: ../src/guestfs.pod:2250
4790 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4795 #: ../src/guestfs.pod:2253
4797 "In the case of an error, a flag is set in the header, and the reply message "
4798 "is slightly changed:"
4803 #: ../src/guestfs.pod:2256
4806 " total length (header + error,\n"
4807 " but not including the length word itself)\n"
4808 " struct guestfs_message_header (encoded as XDR)\n"
4809 " struct guestfs_message_error (encoded as XDR)\n"
4815 #: ../src/guestfs.pod:2261
4817 "The C<guestfs_message_error> structure contains the error message as a "
4823 #: ../src/guestfs.pod:2264
4824 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4829 #: ../src/guestfs.pod:2266
4831 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4832 "The normal request message is sent (see above). However this is followed by "
4833 "a sequence of file chunks."
4838 #: ../src/guestfs.pod:2270
4841 " total length (header + arguments,\n"
4842 " but not including the length word itself,\n"
4843 " and not including the chunks)\n"
4844 " struct guestfs_message_header (encoded as XDR)\n"
4845 " struct guestfs_<foo>_args (encoded as XDR)\n"
4846 " sequence of chunks for FileIn param #0\n"
4847 " sequence of chunks for FileIn param #1 etc.\n"
4853 #: ../src/guestfs.pod:2278
4854 msgid "The \"sequence of chunks\" is:"
4859 #: ../src/guestfs.pod:2280
4862 " length of chunk (not including length word itself)\n"
4863 " struct guestfs_chunk (encoded as XDR)\n"
4864 " length of chunk\n"
4865 " struct guestfs_chunk (encoded as XDR)\n"
4867 " length of chunk\n"
4868 " struct guestfs_chunk (with data.data_len == 0)\n"
4874 #: ../src/guestfs.pod:2288
4876 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4877 "is set in the final chunk to indicate either successful completion or early "
4883 #: ../src/guestfs.pod:2292
4885 "At time of writing there are no functions that have more than one FileIn "
4886 "parameter. However this is (theoretically) supported, by sending the "
4887 "sequence of chunks for each FileIn parameter one after another (from left to "
4893 #: ../src/guestfs.pod:2297
4895 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4896 "transfer. The library does this by sending a chunk with a special flag set "
4897 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4898 "RPC, does I<not> send any reply, and goes back to reading the next request."
4903 #: ../src/guestfs.pod:2303
4905 "The daemon may also cancel. It does this by writing a special word "
4906 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4907 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4908 "cancel chunk). The special word is chosen so that even if cancellation "
4909 "happens right at the end of the transfer (after the library has finished "
4910 "writing and has started listening for the reply), the \"spurious\" cancel "
4911 "flag will not be confused with the reply message."
4916 #: ../src/guestfs.pod:2312
4918 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4919 "limit), and also files where the size is not known in advance (eg. from "
4920 "pipes or sockets). However the chunks are rather small "
4921 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4922 "to keep much in memory."
4927 #: ../src/guestfs.pod:2318
4928 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4933 #: ../src/guestfs.pod:2320
4935 "The protocol for FileOut parameters is exactly the same as for FileIn "
4936 "parameters, but with the roles of daemon and library reversed."
4941 #: ../src/guestfs.pod:2323
4944 " total length (header + ret,\n"
4945 " but not including the length word itself,\n"
4946 " and not including the chunks)\n"
4947 " struct guestfs_message_header (encoded as XDR)\n"
4948 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4949 " sequence of chunks for FileOut param #0\n"
4950 " sequence of chunks for FileOut param #1 etc.\n"
4956 #: ../src/guestfs.pod:2331
4957 msgid "INITIAL MESSAGE"
4962 #: ../src/guestfs.pod:2333
4964 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4965 "which indicates that the guest and daemon is alive. This is what L</"
4966 "guestfs_launch> waits for."
4971 #: ../src/guestfs.pod:2337
4972 msgid "PROGRESS NOTIFICATION MESSAGES"
4977 #: ../src/guestfs.pod:2339
4979 "The daemon may send progress notification messages at any time. These are "
4980 "distinguished by the normal length word being replaced by "
4981 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4985 #: ../src/guestfs.pod:2343
4987 "The library turns them into progress callbacks (see L</"
4988 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4994 #: ../src/guestfs.pod:2347
4996 "The daemon self-limits the frequency of progress messages it sends (see "
4997 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5003 #: ../src/guestfs.pod:2351
5004 msgid "LIBGUESTFS VERSION NUMBERS"
5009 #: ../src/guestfs.pod:2353
5011 "Since April 2010, libguestfs has started to make separate development and "
5012 "stable releases, along with corresponding branches in our git repository. "
5013 "These separate releases can be identified by version number:"
5018 #: ../src/guestfs.pod:2358
5021 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5022 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5028 " | `-------- sub-version\n"
5030 " `------ always '1' because we don't change the ABI\n"
5036 #: ../src/guestfs.pod:2369
5037 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5042 #: ../src/guestfs.pod:2371
5044 "As time passes we cherry pick fixes from the development branch and backport "
5045 "those into the stable branch, the effect being that the stable branch should "
5046 "get more stable and less buggy over time. So the stable releases are ideal "
5047 "for people who don't need new features but would just like the software to "
5053 #: ../src/guestfs.pod:2377
5054 msgid "Our criteria for backporting changes are:"
5059 #: ../src/guestfs.pod:2383
5061 "Documentation changes which don't affect any code are backported unless the "
5062 "documentation refers to a future feature which is not in stable."
5067 #: ../src/guestfs.pod:2389
5069 "Bug fixes which are not controversial, fix obvious problems, and have been "
5070 "well tested are backported."
5075 #: ../src/guestfs.pod:2394
5077 "Simple rearrangements of code which shouldn't affect how it works get "
5078 "backported. This is so that the code in the two branches doesn't get too "
5079 "far out of step, allowing us to backport future fixes more easily."
5084 #: ../src/guestfs.pod:2400
5086 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5087 "exceptional case: the new feature is required in order to implement an "
5088 "important bug fix."
5093 #: ../src/guestfs.pod:2406
5095 "A new stable branch starts when we think the new features in development are "
5096 "substantial and compelling enough over the current stable branch to warrant "
5097 "it. When that happens we create new stable and development versions 1.N.0 "
5098 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5099 "stable at this point, but by backporting fixes from development, that branch "
5100 "will stabilize over time."
5104 #: ../src/guestfs.pod:2414
5105 msgid "EXTENDING LIBGUESTFS"
5109 #: ../src/guestfs.pod:2416
5110 msgid "ADDING A NEW API ACTION"
5114 #: ../src/guestfs.pod:2418
5116 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5117 "documentation) are generated, and this makes it easy to extend the "
5122 #: ../src/guestfs.pod:2422
5123 msgid "To add a new API action there are two changes:"
5127 #: ../src/guestfs.pod:2428
5129 "You need to add a description of the call (name, parameters, return type, "
5130 "tests, documentation) to C<generator/generator_actions.ml>."
5134 #: ../src/guestfs.pod:2431
5136 "There are two sorts of API action, depending on whether the call goes "
5137 "through to the daemon in the appliance, or is serviced entirely by the "
5138 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5139 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5140 "an example of the latter, since a trace flag is maintained in the handle and "
5141 "all tracing is done on the library side."
5145 #: ../src/guestfs.pod:2439
5147 "Most new actions are of the first type, and get added to the "
5148 "C<daemon_functions> list. Each function has a unique procedure number used "
5149 "in the RPC protocol which is assigned to that action when we publish "
5150 "libguestfs and cannot be reused. Take the latest procedure number and "
5155 #: ../src/guestfs.pod:2445
5157 "For library-only actions of the second type, add to the "
5158 "C<non_daemon_functions> list. Since these functions are serviced by the "
5159 "library and do not travel over the RPC mechanism to the daemon, these "
5160 "functions do not need a procedure number, and so the procedure number is set "
5165 #: ../src/guestfs.pod:2453
5166 msgid "Implement the action (in C):"
5170 #: ../src/guestfs.pod:2455
5172 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5173 "C<daemon/> directory."
5177 #: ../src/guestfs.pod:2458
5179 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5180 "(note: double underscore) in the C<src/> directory."
5184 #: ../src/guestfs.pod:2461
5185 msgid "In either case, use another function as an example of what to do."
5189 #: ../src/guestfs.pod:2465
5190 msgid "After making these changes, use C<make> to compile."
5194 #: ../src/guestfs.pod:2467
5196 "Note that you don't need to implement the RPC, language bindings, manual "
5197 "pages or anything else. It's all automatically generated from the OCaml "
5202 #: ../src/guestfs.pod:2471
5203 msgid "ADDING TESTS FOR AN API ACTION"
5207 #: ../src/guestfs.pod:2473
5209 "You can supply zero or as many tests as you want per API call. The tests "
5210 "can either be added as part of the API description (C<generator/"
5211 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5212 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5213 "slower, so if possible use the first method."
5217 #: ../src/guestfs.pod:2479
5219 "The following describes the test environment used when you add an API test "
5220 "in C<generator_actions.ml>."
5224 #: ../src/guestfs.pod:2482
5225 msgid "The test environment has 4 block devices:"
5229 #: ../src/guestfs.pod:2486
5230 msgid "C</dev/sda> 500MB"
5234 #: ../src/guestfs.pod:2488
5235 msgid "General block device for testing."
5239 #: ../src/guestfs.pod:2490
5240 msgid "C</dev/sdb> 50MB"
5244 #: ../src/guestfs.pod:2492
5246 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5251 #: ../src/guestfs.pod:2495
5252 msgid "C</dev/sdc> 10MB"
5256 #: ../src/guestfs.pod:2497
5257 msgid "Used in a few tests where two block devices are needed."
5261 #: ../src/guestfs.pod:2499
5266 #: ../src/guestfs.pod:2501
5267 msgid "ISO with fixed content (see C<images/test.iso>)."
5271 #: ../src/guestfs.pod:2505
5273 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5274 "appliance and block devices are reused between tests. So don't try testing "
5275 "L</guestfs_kill_subprocess> :-x"
5279 #: ../src/guestfs.pod:2509
5281 "Each test starts with an initial scenario, selected using one of the "
5282 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5283 "initialize the disks mentioned above in a particular way as documented in "
5284 "C<generator_types.ml>. You should not assume anything about the previous "
5285 "contents of other disks that are not initialized."
5289 #: ../src/guestfs.pod:2515
5291 "You can add a prerequisite clause to any individual test. This is a run-"
5292 "time check, which, if it fails, causes the test to be skipped. Useful if "
5293 "testing a command which might not work on all variations of libguestfs "
5294 "builds. A test that has prerequisite of C<Always> means to run "
5299 #: ../src/guestfs.pod:2521
5301 "In addition, packagers can skip individual tests by setting environment "
5302 "variables before running C<make check>."
5306 #: ../src/guestfs.pod:2524
5309 " SKIP_TEST_<CMD>_<NUM>=1\n"
5314 #: ../src/guestfs.pod:2526
5315 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5319 #: ../src/guestfs.pod:2528
5324 #: ../src/guestfs.pod:2530
5327 " SKIP_TEST_<CMD>=1\n"
5332 #: ../src/guestfs.pod:2532
5333 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5337 #: ../src/guestfs.pod:2534
5338 msgid "Packagers can run only certain tests by setting for example:"
5342 #: ../src/guestfs.pod:2536
5345 " TEST_ONLY=\"vfs_type zerofree\"\n"
5350 #: ../src/guestfs.pod:2538
5352 "See C<capitests/tests.c> for more details of how these environment variables "
5357 #: ../src/guestfs.pod:2541
5358 msgid "DEBUGGING NEW API ACTIONS"
5362 #: ../src/guestfs.pod:2543
5363 msgid "Test new actions work before submitting them."
5367 #: ../src/guestfs.pod:2545
5368 msgid "You can use guestfish to try out new commands."
5372 #: ../src/guestfs.pod:2547
5374 "Debugging the daemon is a problem because it runs inside a minimal "
5375 "environment. However you can fprintf messages in the daemon to stderr, and "
5376 "they will show up if you use C<guestfish -v>."
5380 #: ../src/guestfs.pod:2551
5381 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5385 #: ../src/guestfs.pod:2553
5387 "Our C source code generally adheres to some basic code-formatting "
5388 "conventions. The existing code base is not totally consistent on this "
5389 "front, but we do prefer that contributed code be formatted similarly. In "
5390 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5391 "indentation level, and other than that, follow the K&R style."
5395 #: ../src/guestfs.pod:2559
5397 "If you use Emacs, add the following to one of one of your start-up files (e."
5398 "g., ~/.emacs), to help ensure that you get indentation right:"
5402 #: ../src/guestfs.pod:2562
5405 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5406 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5407 " (add-hook 'find-file-hook\n"
5408 " '(lambda () (if (and buffer-file-name\n"
5409 " (string-match \"/libguestfs\\\\>\"\n"
5410 " (buffer-file-name))\n"
5411 " (not (string-equal mode-name \"Change Log\"))\n"
5412 " (not (string-equal mode-name \"Makefile\")))\n"
5413 " (setq indent-tabs-mode nil))))\n"
5418 #: ../src/guestfs.pod:2572
5421 " ;;; When editing C sources in libguestfs, use this style.\n"
5422 " (defun libguestfs-c-mode ()\n"
5423 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5425 " (c-set-style \"K&R\")\n"
5426 " (setq c-indent-level 2)\n"
5427 " (setq c-basic-offset 2))\n"
5428 " (add-hook 'c-mode-hook\n"
5429 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5430 " (buffer-file-name))\n"
5431 " (libguestfs-c-mode))))\n"
5436 #: ../src/guestfs.pod:2584
5437 msgid "Enable warnings when compiling (and fix any problems this finds):"
5441 #: ../src/guestfs.pod:2587
5444 " ./configure --enable-gcc-warnings\n"
5449 #: ../src/guestfs.pod:2589
5450 msgid "Useful targets are:"
5454 #: ../src/guestfs.pod:2591
5457 " make syntax-check # checks the syntax of the C code\n"
5458 " make check # runs the test suite\n"
5463 #: ../src/guestfs.pod:2594
5464 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5468 #: ../src/guestfs.pod:2596
5470 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5471 "which are used to do shell quoting."
5475 #: ../src/guestfs.pod:2601
5480 #: ../src/guestfs.pod:2603
5482 "Simple shell quoted string. Any spaces or other shell characters are "
5487 #: ../src/guestfs.pod:2606
5492 #: ../src/guestfs.pod:2608
5494 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5500 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5501 msgid "For example:"
5505 #: ../src/guestfs.pod:2615
5508 " asprintf (&cmd, \"cat %R\", path);\n"
5513 #: ../src/guestfs.pod:2617
5514 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5518 #: ../src/guestfs.pod:2619
5520 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5521 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5522 "they are not passed via the shell (instead, straight to exec). You probably "
5523 "want to use the C<sysroot_path()> function however."
5527 #: ../src/guestfs.pod:2625
5528 msgid "SUBMITTING YOUR NEW API ACTIONS"
5532 #: ../src/guestfs.pod:2627
5534 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5535 "libguestfs> and CC to L<rjones@redhat.com>."
5539 #: ../src/guestfs.pod:2631
5540 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5544 #: ../src/guestfs.pod:2633
5545 msgid "We support i18n (gettext anyhow) in the library."
5549 #: ../src/guestfs.pod:2635
5551 "However many messages come from the daemon, and we don't translate those at "
5552 "the moment. One reason is that the appliance generally has all locale files "
5553 "removed from it, because they take up a lot of space. So we'd have to readd "
5554 "some of those, as well as copying our PO files into the appliance."
5558 #: ../src/guestfs.pod:2641
5560 "Debugging messages are never translated, since they are intended for the "
5565 #: ../src/guestfs.pod:2644
5566 msgid "SOURCE CODE SUBDIRECTORIES"
5570 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5827
5571 #: ../fish/guestfish-actions.pod:3920
5572 msgid "C<appliance>"
5576 #: ../src/guestfs.pod:2650
5577 msgid "The libguestfs appliance, build scripts and so on."
5581 #: ../src/guestfs.pod:2652
5582 msgid "C<capitests>"
5586 #: ../src/guestfs.pod:2654
5587 msgid "Automated tests of the C API."
5591 #: ../src/guestfs.pod:2656
5596 #: ../src/guestfs.pod:2658
5598 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5603 #: ../src/guestfs.pod:2661
5608 #: ../src/guestfs.pod:2663
5609 msgid "Outside contributions, experimental parts."
5613 #: ../src/guestfs.pod:2665
5618 #: ../src/guestfs.pod:2667
5620 "The daemon that runs inside the libguestfs appliance and carries out actions."
5624 #: ../src/guestfs.pod:2670
5629 #: ../src/guestfs.pod:2672
5630 msgid "L<virt-df(1)> command and documentation."
5634 #: ../src/guestfs.pod:2674
5639 #: ../src/guestfs.pod:2676
5640 msgid "L<virt-edit(1)> command and documentation."
5644 #: ../src/guestfs.pod:2678
5649 #: ../src/guestfs.pod:2680
5650 msgid "C API example code."
5654 #: ../src/guestfs.pod:2682
5659 #: ../src/guestfs.pod:2684
5661 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5662 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5663 "L<virt-tar-out(1)>."
5667 #: ../src/guestfs.pod:2688
5672 #: ../src/guestfs.pod:2690
5674 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5678 #: ../src/guestfs.pod:2692
5679 msgid "C<generator>"
5683 #: ../src/guestfs.pod:2694
5685 "The crucially important generator, used to automatically generate large "
5686 "amounts of boilerplate C code for things like RPC and bindings."
5690 #: ../src/guestfs.pod:2697
5695 #: ../src/guestfs.pod:2699
5696 msgid "Files used by the test suite."
5700 #: ../src/guestfs.pod:2701
5701 msgid "Some \"phony\" guest images which we test against."
5705 #: ../src/guestfs.pod:2703
5706 msgid "C<inspector>"
5710 #: ../src/guestfs.pod:2705
5711 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5715 #: ../src/guestfs.pod:2707
5720 #: ../src/guestfs.pod:2709
5721 msgid "Logo used on the website. The fish is called Arthur by the way."
5725 #: ../src/guestfs.pod:2711
5730 #: ../src/guestfs.pod:2713
5731 msgid "M4 macros used by autoconf."
5735 #: ../src/guestfs.pod:2715
5740 #: ../src/guestfs.pod:2717
5741 msgid "Translations of simple gettext strings."
5745 #: ../src/guestfs.pod:2719
5750 #: ../src/guestfs.pod:2721
5752 "The build infrastructure and PO files for translations of manpages and POD "
5753 "files. Eventually this will be combined with the C<po> directory, but that "
5754 "is rather complicated."
5758 #: ../src/guestfs.pod:2725
5759 msgid "C<regressions>"
5763 #: ../src/guestfs.pod:2727
5764 msgid "Regression tests."
5768 #: ../src/guestfs.pod:2729
5773 #: ../src/guestfs.pod:2731
5774 msgid "L<virt-rescue(1)> command and documentation."
5778 #: ../src/guestfs.pod:2733
5783 #: ../src/guestfs.pod:2735
5784 msgid "Source code to the C library."
5788 #: ../src/guestfs.pod:2737
5793 #: ../src/guestfs.pod:2739
5794 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5798 #: ../src/guestfs.pod:2741
5799 msgid "C<test-tool>"
5803 #: ../src/guestfs.pod:2743
5805 "Test tool for end users to test if their qemu/kernel combination will work "
5810 #: ../src/guestfs.pod:2746
5815 #: ../src/guestfs.pod:2748
5820 #: ../src/guestfs.pod:2750
5825 #: ../src/guestfs.pod:2752
5830 #: ../src/guestfs.pod:2754
5835 #: ../src/guestfs.pod:2756
5840 #: ../src/guestfs.pod:2758
5845 #: ../src/guestfs.pod:2760
5850 #: ../src/guestfs.pod:2762
5851 msgid "Language bindings."
5855 #: ../src/guestfs.pod:2766
5861 #: ../src/guestfs.pod:2768
5862 msgid "PROTOCOL LIMITS"
5867 #: ../src/guestfs.pod:2770
5869 "Internally libguestfs uses a message-based protocol to pass API calls and "
5870 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5871 "plenty more detail about this). The maximum message size used by the "
5872 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5873 "aware of this limit. The API calls which may be affected are individually "
5874 "documented, with a link back to this section of the documentation."
5879 #: ../src/guestfs.pod:2778
5881 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5882 "a simple string. Because this string is at some point internally encoded as "
5883 "a message, the maximum size that it can return is slightly under 4 MB. If "
5884 "the requested file is larger than this then you will get an error."
5889 #: ../src/guestfs.pod:2784
5891 "In order to transfer large files into and out of the guest filesystem, you "
5892 "need to use particular calls that support this. The sections L</UPLOADING> "
5893 "and L</DOWNLOADING> document how to do this."
5898 #: ../src/guestfs.pod:2788
5900 "You might also consider mounting the disk image using our FUSE filesystem "
5901 "support (L<guestmount(1)>)."
5905 #: ../src/guestfs.pod:2791
5906 msgid "MAXIMUM NUMBER OF DISKS"
5910 #: ../src/guestfs.pod:2793
5911 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5915 #: ../src/guestfs.pod:2796
5917 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5918 "slots. However febootstrap only understands disks with names C</dev/vda> "
5919 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5924 #: ../src/guestfs.pod:2801
5926 "We are working to substantially raise this limit in future versions but it "
5927 "requires complex changes to qemu."
5931 #: ../src/guestfs.pod:2804
5933 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5934 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5935 "requires changes to qemu."
5939 #: ../src/guestfs.pod:2808
5940 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5944 #: ../src/guestfs.pod:2810
5945 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5949 #: ../src/guestfs.pod:2812
5951 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5952 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5956 #: ../src/guestfs.pod:2815
5958 "If you attach a disk with more than 15 partitions, the extra partitions are "
5959 "ignored by libguestfs."
5963 #: ../src/guestfs.pod:2818
5964 msgid "MAXIMUM SIZE OF A DISK"
5968 #: ../src/guestfs.pod:2820
5969 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5973 #: ../src/guestfs.pod:2822
5975 "We have tested block devices up to 1 exabyte (2**60 or "
5976 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5981 #: ../src/guestfs.pod:2826
5983 "Although libguestfs probably does not impose any limit, the underlying host "
5984 "storage will. If you store disk images on a host ext4 filesystem, then the "
5985 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5986 "TB). If you store disk images as host logical volumes then you are limited "
5987 "by the maximum size of an LV."
5991 #: ../src/guestfs.pod:2832
5993 "For the hugest disk image files, we recommend using XFS on the host for "
5998 #: ../src/guestfs.pod:2835
5999 msgid "MAXIMUM SIZE OF A PARTITION"
6003 #: ../src/guestfs.pod:2837
6005 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6006 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6007 "address a partition located beyond 2 TB on the disk."
6011 #: ../src/guestfs.pod:2841
6013 "It is recommended that you use GPT partitions on disks which are larger than "
6014 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6015 "which are theoretically larger than the largest disk we could support."
6019 #: ../src/guestfs.pod:2846
6020 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6024 #: ../src/guestfs.pod:2848
6026 "This depends on the filesystem type. libguestfs itself does not impose any "
6027 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6028 "what these limits are."
6032 #: ../src/guestfs.pod:2852
6033 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6037 #: ../src/guestfs.pod:2854
6039 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6040 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6041 "uploads and downloads."
6045 #: ../src/guestfs.pod:2858
6046 msgid "INSPECTION LIMITS"
6050 #: ../src/guestfs.pod:2860
6052 "The inspection code has several arbitrary limits on things like the size of "
6053 "Windows Registry hive it will read, and the length of product name. These "
6054 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6055 "memory and disk space on the host, and should not be reached in practice. "
6056 "See the source code for more information."
6061 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017
6062 #: ../test-tool/libguestfs-test-tool.pod:82
6063 msgid "ENVIRONMENT VARIABLES"
6068 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1043
6069 msgid "LIBGUESTFS_APPEND"
6074 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1045
6075 msgid "Pass additional options to the guest kernel."
6080 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1047
6081 msgid "LIBGUESTFS_DEBUG"
6086 #: ../src/guestfs.pod:2876
6088 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6089 "effect as calling C<guestfs_set_verbose (g, 1)>."
6094 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
6095 msgid "LIBGUESTFS_MEMSIZE"
6100 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1054
6102 "Set the memory allocated to the qemu process, in megabytes. For example:"
6107 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
6110 " LIBGUESTFS_MEMSIZE=700\n"
6116 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
6117 msgid "LIBGUESTFS_PATH"
6121 #: ../src/guestfs.pod:2888
6123 "Set the path that libguestfs uses to search for a supermin appliance. See "
6124 "the discussion of paths in section L</PATH> above."
6129 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
6130 msgid "LIBGUESTFS_QEMU"
6135 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1066
6137 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6138 "which was found at compile time by the configure script is used."
6143 #: ../src/guestfs.pod:2897
6144 msgid "See also L</QEMU WRAPPERS> above."
6149 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1070
6150 msgid "LIBGUESTFS_TRACE"
6155 #: ../src/guestfs.pod:2901
6157 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6158 "effect as calling C<guestfs_set_trace (g, 1)>."
6163 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1079
6168 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1081
6170 "Location of temporary directory, defaults to C</tmp> except for the cached "
6171 "supermin appliance which defaults to C</var/tmp>."
6175 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
6177 "If libguestfs was compiled to use the supermin appliance then the real "
6178 "appliance is cached in this directory, shared between all handles belonging "
6179 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6180 "use in case C</var/tmp> is not large enough."
6185 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1151
6186 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:269
6187 #: ../tools/virt-win-reg.pl:743 ../tools/virt-list-filesystems.pl:189
6188 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6189 #: ../tools/virt-list-partitions.pl:257
6194 #: ../src/guestfs.pod:2919
6196 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6197 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6198 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6199 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6200 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6201 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6202 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6207 #: ../src/guestfs.pod:2946
6209 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6210 "(8)>, L<disktype(1)>."
6215 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:758
6216 #: ../tools/virt-make-fs.pl:553
6222 #: ../src/guestfs.pod:2955
6223 msgid "To get a list of bugs against libguestfs use this link:"
6228 #: ../src/guestfs.pod:2957
6230 "L<https://bugzilla.redhat.com/buglist.cgi?"
6231 "component=libguestfs&product=Virtualization+Tools>"
6236 #: ../src/guestfs.pod:2959
6237 msgid "To report a new bug against libguestfs use this link:"
6242 #: ../src/guestfs.pod:2961
6244 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6245 "component=libguestfs&product=Virtualization+Tools>"
6250 #: ../src/guestfs.pod:2963
6251 msgid "When reporting a bug, please check:"
6256 #: ../src/guestfs.pod:2969
6257 msgid "That the bug hasn't been reported already."
6262 #: ../src/guestfs.pod:2973
6263 msgid "That you are testing a recent version."
6268 #: ../src/guestfs.pod:2977
6269 msgid "Describe the bug accurately, and give a way to reproduce it."
6274 #: ../src/guestfs.pod:2981
6276 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6282 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1174
6283 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:280
6289 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1176
6290 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:282
6291 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6296 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1178
6297 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:284
6298 #: ../tools/virt-win-reg.pl:773 ../tools/virt-list-filesystems.pl:206
6299 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6300 #: ../tools/virt-list-partitions.pl:273
6305 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1180
6306 #: ../test-tool/libguestfs-test-tool.pod:99
6307 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6312 #: ../src/guestfs.pod:2995
6314 "This library is free software; you can redistribute it and/or modify it "
6315 "under the terms of the GNU Lesser General Public License as published by the "
6316 "Free Software Foundation; either version 2 of the License, or (at your "
6317 "option) any later version."
6322 #: ../src/guestfs.pod:3000
6324 "This library is distributed in the hope that it will be useful, but WITHOUT "
6325 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6326 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6332 #: ../src/guestfs.pod:3005
6334 "You should have received a copy of the GNU Lesser General Public License "
6335 "along with this library; if not, write to the Free Software Foundation, "
6336 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6341 #: ../src/guestfs-actions.pod:1
6342 msgid "guestfs_add_cdrom"
6347 #: ../src/guestfs-actions.pod:3
6351 " guestfs_add_cdrom (guestfs_h *g,\n"
6352 " const char *filename);\n"
6358 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6359 msgid "This function adds a virtual CD-ROM disk image to the guest."
6363 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6364 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6369 #: ../src/guestfs-actions.pod:17
6371 "This call checks for the existence of C<filename>. This stops you from "
6372 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6373 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6379 #: ../src/guestfs-actions.pod:24
6381 "If you just want to add an ISO file (often you use this as an efficient way "
6382 "to transfer large files into the guest), then you should probably use "
6383 "C<guestfs_add_drive_ro> instead."
6388 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6389 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6390 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6391 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6392 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6393 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6394 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6395 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6396 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6397 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6398 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6399 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
6400 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
6401 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
6402 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
6403 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
6404 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
6405 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
6406 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1723
6407 #: ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:2272
6408 #: ../src/guestfs-actions.pod:2416 ../src/guestfs-actions.pod:2477
6409 #: ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:3465
6410 #: ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3505
6411 #: ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3674
6412 #: ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701
6413 #: ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3752
6414 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3844
6415 #: ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884
6416 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3939
6417 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977
6418 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4024
6419 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4076
6420 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
6421 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4214
6422 #: ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4247
6423 #: ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4316
6424 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4350
6425 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4378
6426 #: ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4410
6427 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4488
6428 #: ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4592
6429 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4630
6430 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4659
6431 #: ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4687
6432 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4737
6433 #: ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4779
6434 #: ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4810
6435 #: ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:4896
6436 #: ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:4938
6437 #: ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:4973
6438 #: ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5164
6439 #: ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5204
6440 #: ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5302
6441 #: ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5332
6442 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5635
6443 #: ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5673
6444 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5697
6445 #: ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5723
6446 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5753
6447 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5793
6448 #: ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5842
6449 #: ../src/guestfs-actions.pod:5858 ../src/guestfs-actions.pod:5881
6450 #: ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918
6451 #: ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:5958
6452 #: ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6003
6453 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6046
6454 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6089
6455 #: ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6123
6456 #: ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6190
6457 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6345
6458 #: ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6478
6459 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
6460 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6539
6461 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6565
6462 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6639
6463 #: ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6672
6464 #: ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6705
6465 #: ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6738
6466 #: ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6788
6467 #: ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842
6468 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6894
6469 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:7049
6470 #: ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7081
6471 #: ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7149
6472 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-actions.pod:7227
6473 #: ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7314
6474 #: ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7399
6475 #: ../src/guestfs-actions.pod:7428
6476 msgid "This function returns 0 on success or -1 on error."
6481 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6482 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6483 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6485 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6491 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6492 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6493 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
6494 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:4742
6495 #: ../src/guestfs-actions.pod:6168 ../src/guestfs-actions.pod:6198
6496 #: ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6290
6497 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7322
6498 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:31
6499 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6500 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1324
6501 #: ../fish/guestfish-actions.pod:1338 ../fish/guestfish-actions.pod:3013
6502 #: ../fish/guestfish-actions.pod:3210 ../fish/guestfish-actions.pod:4182
6503 #: ../fish/guestfish-actions.pod:4205 ../fish/guestfish-actions.pod:4227
6504 #: ../fish/guestfish-actions.pod:4265 ../fish/guestfish-actions.pod:4906
6505 #: ../fish/guestfish-actions.pod:5003
6507 "Deprecated functions will not be removed from the API, but the fact that "
6508 "they are deprecated indicates that there are problems with correct use of "
6514 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6515 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1922
6516 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:2123
6517 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3487
6518 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:5860
6519 #: ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:6091
6520 #: ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6707
6521 #: ../src/guestfs-actions.pod:7236
6522 msgid "(Added in 0.3)"
6527 #: ../src/guestfs-actions.pod:41
6528 msgid "guestfs_add_domain"
6533 #: ../src/guestfs-actions.pod:43
6537 " guestfs_add_domain (guestfs_h *g,\n"
6538 " const char *dom,\n"
6545 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6546 #: ../src/guestfs-actions.pod:4449
6548 "You may supply a list of optional arguments to this call. Use zero or more "
6549 "of the following pairs of parameters, and terminate the list with C<-1> on "
6550 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6554 #: ../src/guestfs-actions.pod:53
6557 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6558 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6559 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6560 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6561 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6567 #: ../src/guestfs-actions.pod:59
6569 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6570 "It works by connecting to libvirt, requesting the domain and domain XML from "
6571 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6577 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6579 "The number of disks added is returned. This operation is atomic: if an "
6580 "error is returned, then no disks are added."
6585 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6587 "This function does some minimal checks to make sure the libvirt domain is "
6588 "not running (unless C<readonly> is true). In a future version we will try "
6589 "to acquire the libvirt lock on each disk."
6594 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6596 "Disks must be accessible locally. This often means that adding disks from a "
6597 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6598 "unless those disks are accessible via the same device path locally too."
6602 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6604 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6605 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6606 "libvirt URI (or one set through an environment variable, see the libvirt "
6607 "documentation for full details)."
6611 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6613 "The optional C<live> flag controls whether this call will try to connect to "
6614 "a running virtual machine C<guestfsd> process if it sees a suitable "
6615 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6616 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6617 "DAEMONS> for more information."
6621 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6623 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6624 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6625 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6631 #: ../src/guestfs-actions.pod:94
6633 "The other optional parameters are passed directly through to "
6634 "C<guestfs_add_drive_opts>."
6639 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6640 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6641 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6642 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6643 #: ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1883
6644 #: ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2032
6645 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
6646 #: ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:2786
6647 #: ../src/guestfs-actions.pod:2807 ../src/guestfs-actions.pod:4882
6648 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5416
6649 #: ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:6815
6650 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7260
6651 #: ../src/guestfs-actions.pod:7273
6652 msgid "On error this function returns -1."
6657 #: ../src/guestfs-actions.pod:99
6658 msgid "(Added in 1.7.4)"
6663 #: ../src/guestfs-actions.pod:101
6664 msgid "guestfs_add_domain_va"
6669 #: ../src/guestfs-actions.pod:103
6673 " guestfs_add_domain_va (guestfs_h *g,\n"
6674 " const char *dom,\n"
6681 #: ../src/guestfs-actions.pod:108
6682 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6687 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6688 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6689 #: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4514
6690 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6695 #: ../src/guestfs-actions.pod:112
6696 msgid "guestfs_add_domain_argv"
6701 #: ../src/guestfs-actions.pod:114
6705 " guestfs_add_domain_argv (guestfs_h *g,\n"
6706 " const char *dom,\n"
6707 " const struct guestfs_add_domain_argv *optargs);\n"
6713 #: ../src/guestfs-actions.pod:119
6714 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6719 #: ../src/guestfs-actions.pod:123
6720 msgid "guestfs_add_drive"
6725 #: ../src/guestfs-actions.pod:125
6729 " guestfs_add_drive (guestfs_h *g,\n"
6730 " const char *filename);\n"
6736 #: ../src/guestfs-actions.pod:129
6738 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6739 "optional parameters, so the disk is added writable, with the format being "
6740 "detected automatically."
6745 #: ../src/guestfs-actions.pod:133
6747 "Automatic detection of the format opens you up to a potential security hole "
6748 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6749 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6750 "you should think about replacing calls to this function with calls to "
6751 "C<guestfs_add_drive_opts>, and specifying the format."
6756 #: ../src/guestfs-actions.pod:144
6757 msgid "guestfs_add_drive_opts"
6762 #: ../src/guestfs-actions.pod:146
6766 " guestfs_add_drive_opts (guestfs_h *g,\n"
6767 " const char *filename,\n"
6774 #: ../src/guestfs-actions.pod:156
6777 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6778 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6779 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6785 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6787 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6788 "The first time you call this function, the disk appears as C</dev/sda>, the "
6789 "second time as C</dev/sdb>, and so on."
6794 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6796 "You don't necessarily need to be root when using libguestfs. However you "
6797 "obviously do need sufficient permissions to access the filename for whatever "
6798 "operations you want to perform (ie. read access if you just want to read the "
6799 "image or write access if you want to modify the image)."
6804 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6805 msgid "This call checks that C<filename> exists."
6810 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4460
6811 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3024
6812 msgid "The optional arguments are:"
6817 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6823 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6825 "If true then the image is treated as read-only. Writes are still allowed, "
6826 "but they are stored in a temporary snapshot overlay which is discarded at "
6827 "the end. The disk that you add is not modified."
6832 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6838 #: ../src/guestfs-actions.pod:185
6840 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6841 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6842 "Possible formats include C<raw> and C<qcow2>."
6847 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6849 "Automatic detection of the format opens you up to a potential security hole "
6850 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6851 "RHBZ#642934. Specifying the format closes this security hole."
6856 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6862 #: ../src/guestfs-actions.pod:196
6864 "This rarely-used option lets you emulate the behaviour of the deprecated "
6865 "C<guestfs_add_drive_with_if> call (q.v.)"
6870 #: ../src/guestfs-actions.pod:203
6871 msgid "(Added in 1.5.23)"
6876 #: ../src/guestfs-actions.pod:205
6877 msgid "guestfs_add_drive_opts_va"
6882 #: ../src/guestfs-actions.pod:207
6886 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6887 " const char *filename,\n"
6894 #: ../src/guestfs-actions.pod:212
6895 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6900 #: ../src/guestfs-actions.pod:216
6901 msgid "guestfs_add_drive_opts_argv"
6906 #: ../src/guestfs-actions.pod:218
6910 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6911 " const char *filename,\n"
6912 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6918 #: ../src/guestfs-actions.pod:223
6919 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6924 #: ../src/guestfs-actions.pod:227
6925 msgid "guestfs_add_drive_ro"
6930 #: ../src/guestfs-actions.pod:229
6934 " guestfs_add_drive_ro (guestfs_h *g,\n"
6935 " const char *filename);\n"
6941 #: ../src/guestfs-actions.pod:233
6943 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6944 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6945 "disk is added read-only, with the format being detected automatically."
6950 #: ../src/guestfs-actions.pod:240
6951 msgid "(Added in 1.0.38)"
6956 #: ../src/guestfs-actions.pod:242
6957 msgid "guestfs_add_drive_ro_with_if"
6962 #: ../src/guestfs-actions.pod:244
6966 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6967 " const char *filename,\n"
6968 " const char *iface);\n"
6974 #: ../src/guestfs-actions.pod:249
6976 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6977 "QEMU interface emulation to use at run time."
6982 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6983 #: ../src/guestfs-actions.pod:2362
6984 msgid "(Added in 1.0.84)"
6989 #: ../src/guestfs-actions.pod:263
6990 msgid "guestfs_add_drive_with_if"
6995 #: ../src/guestfs-actions.pod:265
6999 " guestfs_add_drive_with_if (guestfs_h *g,\n"
7000 " const char *filename,\n"
7001 " const char *iface);\n"
7007 #: ../src/guestfs-actions.pod:270
7009 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7010 "QEMU interface emulation to use at run time."
7015 #: ../src/guestfs-actions.pod:284
7016 msgid "guestfs_aug_clear"
7021 #: ../src/guestfs-actions.pod:286
7025 " guestfs_aug_clear (guestfs_h *g,\n"
7026 " const char *augpath);\n"
7032 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7034 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7035 "L<augtool(1)> C<clear> command."
7040 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2112
7041 msgid "(Added in 1.3.4)"
7046 #: ../src/guestfs-actions.pod:297
7047 msgid "guestfs_aug_close"
7052 #: ../src/guestfs-actions.pod:299
7056 " guestfs_aug_close (guestfs_h *g);\n"
7062 #: ../src/guestfs-actions.pod:302
7064 "Close the current Augeas handle and free up any resources used by it. After "
7065 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7066 "any other Augeas functions."
7071 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7072 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7073 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7074 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7075 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7076 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7077 #: ../src/guestfs-actions.pod:5493
7078 msgid "(Added in 0.7)"
7083 #: ../src/guestfs-actions.pod:311
7084 msgid "guestfs_aug_defnode"
7089 #: ../src/guestfs-actions.pod:313
7092 " struct guestfs_int_bool *\n"
7093 " guestfs_aug_defnode (guestfs_h *g,\n"
7094 " const char *name,\n"
7095 " const char *expr,\n"
7096 " const char *val);\n"
7102 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7104 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7109 #: ../src/guestfs-actions.pod:322
7111 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7112 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7113 "containing that single node."
7118 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7120 "On success this returns a pair containing the number of nodes in the "
7121 "nodeset, and a boolean flag if a node was created."
7126 #: ../src/guestfs-actions.pod:330
7128 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7129 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7134 #: ../src/guestfs-actions.pod:336
7135 msgid "guestfs_aug_defvar"
7140 #: ../src/guestfs-actions.pod:338
7144 " guestfs_aug_defvar (guestfs_h *g,\n"
7145 " const char *name,\n"
7146 " const char *expr);\n"
7152 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7154 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7155 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7160 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7162 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7163 "evaluates to something which is not a nodeset."
7168 #: ../src/guestfs-actions.pod:354
7169 msgid "guestfs_aug_get"
7174 #: ../src/guestfs-actions.pod:356
7178 " guestfs_aug_get (guestfs_h *g,\n"
7179 " const char *augpath);\n"
7185 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7187 "Look up the value associated with C<path>. If C<path> matches exactly one "
7188 "node, the C<value> is returned."
7193 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
7194 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
7195 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
7196 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
7197 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
7198 #: ../src/guestfs-actions.pod:1551 ../src/guestfs-actions.pod:1663
7199 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843
7200 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:1944
7201 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2135
7202 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2534
7203 #: ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2738
7204 #: ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2878
7205 #: ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:2933
7206 #: ../src/guestfs-actions.pod:2970 ../src/guestfs-actions.pod:3030
7207 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
7208 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3996
7209 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4276
7210 #: ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5221
7211 #: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5569
7212 #: ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6251
7213 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6284
7214 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6989
7215 #: ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026
7216 #: ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7485
7218 "This function returns a string, or NULL on error. I<The caller must free "
7219 "the returned string after use>."
7224 #: ../src/guestfs-actions.pod:368
7225 msgid "guestfs_aug_init"
7230 #: ../src/guestfs-actions.pod:370
7234 " guestfs_aug_init (guestfs_h *g,\n"
7235 " const char *root,\n"
7242 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7244 "Create a new Augeas handle for editing configuration files. If there was "
7245 "any previous Augeas handle associated with this guestfs session, then it is "
7251 #: ../src/guestfs-actions.pod:379
7252 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7257 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7259 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7264 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7266 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7267 "logical I<or> of the following integers:"
7272 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7273 msgid "C<AUG_SAVE_BACKUP> = 1"
7278 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7279 msgid "Keep the original file with a C<.augsave> extension."
7284 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7285 msgid "C<AUG_SAVE_NEWFILE> = 2"
7290 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7292 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7293 "original. Overrides C<AUG_SAVE_BACKUP>."
7298 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7299 msgid "C<AUG_TYPE_CHECK> = 4"
7304 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7305 msgid "Typecheck lenses (can be expensive)."
7310 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7311 msgid "C<AUG_NO_STDINC> = 8"
7316 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7317 msgid "Do not use standard load path for modules."
7322 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7323 msgid "C<AUG_SAVE_NOOP> = 16"
7328 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7329 msgid "Make save a no-op, just record what would have been changed."
7334 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7335 msgid "C<AUG_NO_LOAD> = 32"
7340 #: ../src/guestfs-actions.pod:414
7341 msgid "Do not load the tree in C<guestfs_aug_init>."
7346 #: ../src/guestfs-actions.pod:418
7347 msgid "To close the handle, you can call C<guestfs_aug_close>."
7352 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7353 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7358 #: ../src/guestfs-actions.pod:426
7359 msgid "guestfs_aug_insert"
7364 #: ../src/guestfs-actions.pod:428
7368 " guestfs_aug_insert (guestfs_h *g,\n"
7369 " const char *augpath,\n"
7370 " const char *label,\n"
7377 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7379 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7380 "or after C<path> (depending on the boolean flag C<before>)."
7385 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7387 "C<path> must match exactly one existing node in the tree, and C<label> must "
7388 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7393 #: ../src/guestfs-actions.pod:446
7394 msgid "guestfs_aug_load"
7399 #: ../src/guestfs-actions.pod:448
7403 " guestfs_aug_load (guestfs_h *g);\n"
7409 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7410 msgid "Load files into the tree."
7415 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7416 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7421 #: ../src/guestfs-actions.pod:460
7422 msgid "guestfs_aug_ls"
7427 #: ../src/guestfs-actions.pod:462
7431 " guestfs_aug_ls (guestfs_h *g,\n"
7432 " const char *augpath);\n"
7438 #: ../src/guestfs-actions.pod:466
7440 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7441 "sorting the resulting nodes into alphabetical order."
7446 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7447 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
7448 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
7449 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
7450 #: ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2207
7451 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
7452 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
7453 #: ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2429
7454 #: ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2987
7455 #: ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3566
7456 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3733
7457 #: ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4843
7458 #: ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5489
7459 #: ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:6331
7460 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6447
7461 #: ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6617
7462 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
7463 #: ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7338
7464 #: ../src/guestfs-actions.pod:7357 ../src/guestfs-actions.pod:7442
7465 #: ../src/guestfs-actions.pod:7461 ../src/guestfs-actions.pod:7507
7466 #: ../src/guestfs-actions.pod:7526
7468 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7469 ">), or NULL if there was an error. I<The caller must free the strings and "
7470 "the array after use>."
7475 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
7476 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
7477 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3385
7478 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4029
7479 #: ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4249
7480 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4847
7481 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5699
7482 #: ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5725
7483 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6831
7484 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:7083
7485 #: ../src/guestfs-actions.pod:7326
7486 msgid "(Added in 0.8)"
7491 #: ../src/guestfs-actions.pod:475
7492 msgid "guestfs_aug_match"
7497 #: ../src/guestfs-actions.pod:477
7501 " guestfs_aug_match (guestfs_h *g,\n"
7502 " const char *augpath);\n"
7508 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7510 "Returns a list of paths which match the path expression C<path>. The "
7511 "returned paths are sufficiently qualified so that they match exactly one "
7512 "node in the current tree."
7517 #: ../src/guestfs-actions.pod:491
7518 msgid "guestfs_aug_mv"
7523 #: ../src/guestfs-actions.pod:493
7527 " guestfs_aug_mv (guestfs_h *g,\n"
7528 " const char *src,\n"
7529 " const char *dest);\n"
7535 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7537 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7538 "C<dest> is overwritten if it exists."
7543 #: ../src/guestfs-actions.pod:505
7544 msgid "guestfs_aug_rm"
7549 #: ../src/guestfs-actions.pod:507
7553 " guestfs_aug_rm (guestfs_h *g,\n"
7554 " const char *augpath);\n"
7560 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7561 msgid "Remove C<path> and all of its children."
7566 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7567 msgid "On success this returns the number of entries which were removed."
7572 #: ../src/guestfs-actions.pod:519
7573 msgid "guestfs_aug_save"
7578 #: ../src/guestfs-actions.pod:521
7582 " guestfs_aug_save (guestfs_h *g);\n"
7588 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7589 msgid "This writes all pending changes to disk."
7594 #: ../src/guestfs-actions.pod:526
7596 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7602 #: ../src/guestfs-actions.pod:533
7603 msgid "guestfs_aug_set"
7608 #: ../src/guestfs-actions.pod:535
7612 " guestfs_aug_set (guestfs_h *g,\n"
7613 " const char *augpath,\n"
7614 " const char *val);\n"
7620 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7621 msgid "Set the value associated with C<path> to C<val>."
7626 #: ../src/guestfs-actions.pod:542
7628 "In the Augeas API, it is possible to clear a node by setting the value to "
7629 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7630 "this call. Instead you must use the C<guestfs_aug_clear> call."
7635 #: ../src/guestfs-actions.pod:551
7636 msgid "guestfs_available"
7641 #: ../src/guestfs-actions.pod:553
7645 " guestfs_available (guestfs_h *g,\n"
7646 " char *const *groups);\n"
7652 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7654 "This command is used to check the availability of some groups of "
7655 "functionality in the appliance, which not all builds of the libguestfs "
7656 "appliance will be able to provide."
7661 #: ../src/guestfs-actions.pod:561
7663 "The libguestfs groups, and the functions that those groups correspond to, "
7664 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7665 "runtime by calling C<guestfs_available_all_groups>."
7670 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7672 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7673 "\"]> would check for the availability of the Linux inotify functions and "
7674 "Augeas (configuration file editing) functions."
7679 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7680 msgid "The command returns no error if I<all> requested groups are available."
7685 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7687 "It fails with an error if one or more of the requested groups is unavailable "
7693 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7695 "If an unknown group name is included in the list of groups then an error is "
7701 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7707 #: ../src/guestfs-actions.pod:585
7708 msgid "You must call C<guestfs_launch> before calling this function."
7713 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7715 "The reason is because we don't know what groups are supported by the "
7716 "appliance/daemon until it is running and can be queried."
7721 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7723 "If a group of functions is available, this does not necessarily mean that "
7724 "they will work. You still have to check for errors when calling individual "
7725 "API functions even if they are available."
7730 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7732 "It is usually the job of distro packagers to build complete functionality "
7733 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7734 "with all requirements satisfied, will support everything."
7739 #: ../src/guestfs-actions.pod:607
7741 "This call was added in version C<1.0.80>. In previous versions of "
7742 "libguestfs all you could do would be to speculatively execute a command to "
7743 "find out if the daemon implemented it. See also C<guestfs_version>."
7748 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7749 msgid "(Added in 1.0.80)"
7754 #: ../src/guestfs-actions.pod:618
7755 msgid "guestfs_available_all_groups"
7760 #: ../src/guestfs-actions.pod:620
7764 " guestfs_available_all_groups (guestfs_h *g);\n"
7770 #: ../src/guestfs-actions.pod:623
7772 "This command returns a list of all optional groups that this daemon knows "
7773 "about. Note this returns both supported and unsupported groups. To find "
7774 "out which ones the daemon can actually support you have to call "
7775 "C<guestfs_available> on each member of the returned list."
7780 #: ../src/guestfs-actions.pod:629
7781 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7786 #: ../src/guestfs-actions.pod:635
7787 msgid "(Added in 1.3.15)"
7792 #: ../src/guestfs-actions.pod:637
7793 msgid "guestfs_base64_in"
7798 #: ../src/guestfs-actions.pod:639
7802 " guestfs_base64_in (guestfs_h *g,\n"
7803 " const char *base64file,\n"
7804 " const char *filename);\n"
7810 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7812 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7817 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7818 msgid "(Added in 1.3.5)"
7823 #: ../src/guestfs-actions.pod:651
7824 msgid "guestfs_base64_out"
7829 #: ../src/guestfs-actions.pod:653
7833 " guestfs_base64_out (guestfs_h *g,\n"
7834 " const char *filename,\n"
7835 " const char *base64file);\n"
7841 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7843 "This command downloads the contents of C<filename>, writing it out to local "
7844 "file C<base64file> encoded as base64."
7849 #: ../src/guestfs-actions.pod:665
7850 msgid "guestfs_blockdev_flushbufs"
7855 #: ../src/guestfs-actions.pod:667
7859 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7860 " const char *device);\n"
7866 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7868 "This tells the kernel to flush internal buffers associated with C<device>."
7873 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7874 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7875 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7876 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7877 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7878 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7879 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7880 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7881 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7882 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7883 msgid "This uses the L<blockdev(8)> command."
7888 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7889 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7890 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7891 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7892 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7893 msgid "(Added in 0.9.3)"
7898 #: ../src/guestfs-actions.pod:680
7899 msgid "guestfs_blockdev_getbsz"
7904 #: ../src/guestfs-actions.pod:682
7908 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7909 " const char *device);\n"
7915 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7916 msgid "This returns the block size of a device."
7921 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7922 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7924 "(Note this is different from both I<size in blocks> and I<filesystem block "
7930 #: ../src/guestfs-actions.pod:697
7931 msgid "guestfs_blockdev_getro"
7936 #: ../src/guestfs-actions.pod:699
7940 " guestfs_blockdev_getro (guestfs_h *g,\n"
7941 " const char *device);\n"
7947 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7949 "Returns a boolean indicating if the block device is read-only (true if read-"
7950 "only, false if not)."
7955 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7956 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1920
7957 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2003
7958 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2073
7959 #: ../src/guestfs-actions.pod:2098 ../src/guestfs-actions.pod:2121
7960 #: ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111
7961 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3293
7962 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3322
7963 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3352
7964 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3383
7965 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3410
7966 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3439
7967 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4992
7968 msgid "This function returns a C truth value on success or -1 on error."
7973 #: ../src/guestfs-actions.pod:712
7974 msgid "guestfs_blockdev_getsize64"
7979 #: ../src/guestfs-actions.pod:714
7983 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7984 " const char *device);\n"
7990 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7991 msgid "This returns the size of the device in bytes."
7996 #: ../src/guestfs-actions.pod:720
7997 msgid "See also C<guestfs_blockdev_getsz>."
8002 #: ../src/guestfs-actions.pod:728
8003 msgid "guestfs_blockdev_getss"
8008 #: ../src/guestfs-actions.pod:730
8012 " guestfs_blockdev_getss (guestfs_h *g,\n"
8013 " const char *device);\n"
8019 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8021 "This returns the size of sectors on a block device. Usually 512, but can be "
8022 "larger for modern devices."
8027 #: ../src/guestfs-actions.pod:737
8029 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8035 #: ../src/guestfs-actions.pod:746
8036 msgid "guestfs_blockdev_getsz"
8041 #: ../src/guestfs-actions.pod:748
8045 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8046 " const char *device);\n"
8052 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8054 "This returns the size of the device in units of 512-byte sectors (even if "
8055 "the sectorsize isn't 512 bytes ... weird)."
8060 #: ../src/guestfs-actions.pod:755
8062 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8063 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8068 #: ../src/guestfs-actions.pod:765
8069 msgid "guestfs_blockdev_rereadpt"
8074 #: ../src/guestfs-actions.pod:767
8078 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8079 " const char *device);\n"
8085 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8086 msgid "Reread the partition table on C<device>."
8091 #: ../src/guestfs-actions.pod:779
8092 msgid "guestfs_blockdev_setbsz"
8097 #: ../src/guestfs-actions.pod:781
8101 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8102 " const char *device,\n"
8103 " int blocksize);\n"
8109 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8110 msgid "This sets the block size of a device."
8115 #: ../src/guestfs-actions.pod:797
8116 msgid "guestfs_blockdev_setro"
8121 #: ../src/guestfs-actions.pod:799
8125 " guestfs_blockdev_setro (guestfs_h *g,\n"
8126 " const char *device);\n"
8132 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8133 msgid "Sets the block device named C<device> to read-only."
8138 #: ../src/guestfs-actions.pod:811
8139 msgid "guestfs_blockdev_setrw"
8144 #: ../src/guestfs-actions.pod:813
8148 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8149 " const char *device);\n"
8155 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8156 msgid "Sets the block device named C<device> to read-write."
8161 #: ../src/guestfs-actions.pod:825
8162 msgid "guestfs_case_sensitive_path"
8167 #: ../src/guestfs-actions.pod:827
8171 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8172 " const char *path);\n"
8178 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
8180 "This can be used to resolve case insensitive paths on a filesystem which is "
8181 "case sensitive. The use case is to resolve paths which you have read from "
8182 "Windows configuration files or the Windows Registry, to the true path."
8187 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
8189 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8190 "(and probably others), which is that although the underlying filesystem is "
8191 "case-insensitive, the driver exports the filesystem to Linux as case-"
8197 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
8199 "One consequence of this is that special directories such as C<c:\\windows> "
8200 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8201 "precise details of how they were created. In Windows itself this would not "
8207 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
8209 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8215 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
8217 "This function resolves the true case of each element in the path and returns "
8218 "the case-sensitive path."
8223 #: ../src/guestfs-actions.pod:853
8225 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8226 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8227 "how the directories were originally created under Windows)."
8232 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
8233 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8238 #: ../src/guestfs-actions.pod:861
8239 msgid "See also C<guestfs_realpath>."
8244 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7011
8245 msgid "(Added in 1.0.75)"
8250 #: ../src/guestfs-actions.pod:868
8256 #: ../src/guestfs-actions.pod:870
8260 " guestfs_cat (guestfs_h *g,\n"
8261 " const char *path);\n"
8267 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5479
8268 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3679
8269 msgid "Return the contents of the file named C<path>."
8274 #: ../src/guestfs-actions.pod:876
8276 "Note that this function cannot correctly handle binary files (specifically, "
8277 "files containing C<\\0> character which is treated as end of string). For "
8278 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8279 "functions which have a more complex interface."
8284 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
8285 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
8286 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
8287 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1769
8288 #: ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246
8289 #: ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313
8290 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2359
8291 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5287
8292 #: ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5444
8293 #: ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:6396
8294 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6597
8295 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:7290
8296 #: ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7342
8297 #: ../src/guestfs-actions.pod:7361 ../src/guestfs-actions.pod:7446
8298 #: ../src/guestfs-actions.pod:7465 ../src/guestfs-actions.pod:7511
8299 #: ../src/guestfs-actions.pod:7530 ../fish/guestfish-actions.pod:592
8300 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8301 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8302 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8303 #: ../fish/guestfish-actions.pod:1197 ../fish/guestfish-actions.pod:1498
8304 #: ../fish/guestfish-actions.pod:1508 ../fish/guestfish-actions.pod:1536
8305 #: ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1561
8306 #: ../fish/guestfish-actions.pod:1580 ../fish/guestfish-actions.pod:3549
8307 #: ../fish/guestfish-actions.pod:3564 ../fish/guestfish-actions.pod:3640
8308 #: ../fish/guestfish-actions.pod:3657 ../fish/guestfish-actions.pod:3672
8309 #: ../fish/guestfish-actions.pod:4326 ../fish/guestfish-actions.pod:4372
8310 #: ../fish/guestfish-actions.pod:4457 ../fish/guestfish-actions.pod:4472
8311 #: ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4900
8312 #: ../fish/guestfish-actions.pod:4917 ../fish/guestfish-actions.pod:4927
8313 #: ../fish/guestfish-actions.pod:4975 ../fish/guestfish-actions.pod:4985
8314 #: ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024
8316 "Because of the message protocol, there is a transfer limit of somewhere "
8317 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8322 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3570
8323 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3649
8324 #: ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:4142
8325 #: ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5367
8326 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7170
8327 #: ../src/guestfs-actions.pod:7184
8328 msgid "(Added in 0.4)"
8333 #: ../src/guestfs-actions.pod:889
8334 msgid "guestfs_checksum"
8339 #: ../src/guestfs-actions.pod:891
8343 " guestfs_checksum (guestfs_h *g,\n"
8344 " const char *csumtype,\n"
8345 " const char *path);\n"
8351 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
8353 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8358 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
8360 "The type of checksum to compute is given by the C<csumtype> parameter which "
8361 "must have one of the following values:"
8366 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
8372 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
8374 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8380 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
8386 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
8387 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8392 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
8398 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
8399 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8404 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
8410 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
8411 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8416 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
8422 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
8423 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8428 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
8434 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
8435 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8440 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
8446 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
8447 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8452 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
8453 msgid "The checksum is returned as a printable string."
8458 #: ../src/guestfs-actions.pod:937
8459 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8464 #: ../src/guestfs-actions.pod:939
8465 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8470 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
8471 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3309
8472 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3399
8473 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:6867
8474 msgid "(Added in 1.0.2)"
8479 #: ../src/guestfs-actions.pod:946
8480 msgid "guestfs_checksum_device"
8485 #: ../src/guestfs-actions.pod:948
8489 " guestfs_checksum_device (guestfs_h *g,\n"
8490 " const char *csumtype,\n"
8491 " const char *device);\n"
8497 #: ../src/guestfs-actions.pod:953
8499 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8500 "device named C<device>. For the types of checksums supported see the "
8501 "C<guestfs_checksum> command."
8506 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4898
8507 #: ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4994
8508 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5188
8509 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6790
8510 #: ../src/guestfs-actions.pod:7196
8511 msgid "(Added in 1.3.2)"
8516 #: ../src/guestfs-actions.pod:962
8517 msgid "guestfs_checksums_out"
8522 #: ../src/guestfs-actions.pod:964
8526 " guestfs_checksums_out (guestfs_h *g,\n"
8527 " const char *csumtype,\n"
8528 " const char *directory,\n"
8529 " const char *sumsfile);\n"
8535 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
8537 "This command computes the checksums of all regular files in C<directory> and "
8538 "then emits a list of those checksums to the local output file C<sumsfile>."
8543 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
8545 "This can be used for verifying the integrity of a virtual machine. However "
8546 "to be properly secure you should pay attention to the output of the checksum "
8547 "command (it uses the ones from GNU coreutils). In particular when the "
8548 "filename is not printable, coreutils uses a special backslash syntax. For "
8549 "more information, see the GNU coreutils info file."
8554 #: ../src/guestfs-actions.pod:984
8555 msgid "(Added in 1.3.7)"
8560 #: ../src/guestfs-actions.pod:986
8561 msgid "guestfs_chmod"
8566 #: ../src/guestfs-actions.pod:988
8570 " guestfs_chmod (guestfs_h *g,\n"
8572 " const char *path);\n"
8578 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
8580 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8586 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
8588 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8589 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8595 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4393
8596 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
8597 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:681
8598 #: ../fish/guestfish-actions.pod:2988 ../fish/guestfish-actions.pod:3117
8599 #: ../fish/guestfish-actions.pod:3127 ../fish/guestfish-actions.pod:3137
8600 msgid "The mode actually set is affected by the umask."
8605 #: ../src/guestfs-actions.pod:1006
8606 msgid "guestfs_chown"
8611 #: ../src/guestfs-actions.pod:1008
8615 " guestfs_chown (guestfs_h *g,\n"
8618 " const char *path);\n"
8624 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
8625 msgid "Change the file owner to C<owner> and group to C<group>."
8630 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3501
8631 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2446
8633 "Only numeric uid and gid are supported. If you want to use names, you will "
8634 "need to locate and parse the password file yourself (Augeas support makes "
8635 "this relatively easy)."
8640 #: ../src/guestfs-actions.pod:1024
8641 msgid "guestfs_command"
8646 #: ../src/guestfs-actions.pod:1026
8650 " guestfs_command (guestfs_h *g,\n"
8651 " char *const *arguments);\n"
8657 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
8659 "This call runs a command from the guest filesystem. The filesystem must be "
8660 "mounted, and must contain a compatible operating system (ie. something "
8661 "Linux, with the same or compatible processor architecture)."
8666 #: ../src/guestfs-actions.pod:1035
8668 "The single parameter is an argv-style list of arguments. The first element "
8669 "is the name of the program to run. Subsequent elements are parameters. The "
8670 "list must be non-empty (ie. must contain a program name). Note that the "
8671 "command runs directly, and is I<not> invoked via the shell (see "
8677 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
8678 msgid "The return value is anything printed to I<stdout> by the command."
8683 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
8685 "If the command returns a non-zero exit status, then this function returns an "
8686 "error message. The error message string is the content of I<stderr> from "
8692 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
8694 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8695 "bin>. If you require a program from another location, you should provide "
8696 "the full path in the first parameter."
8701 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8703 "Shared libraries and data files required by the program must be available on "
8704 "filesystems which are mounted in the correct places. It is the caller's "
8705 "responsibility to ensure all filesystems that are needed are mounted at the "
8711 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8712 #: ../src/guestfs-actions.pod:1554
8713 msgid "(Added in 0.9.1)"
8718 #: ../src/guestfs-actions.pod:1068
8719 msgid "guestfs_command_lines"
8724 #: ../src/guestfs-actions.pod:1070
8728 " guestfs_command_lines (guestfs_h *g,\n"
8729 " char *const *arguments);\n"
8735 #: ../src/guestfs-actions.pod:1074
8737 "This is the same as C<guestfs_command>, but splits the result into a list of "
8743 #: ../src/guestfs-actions.pod:1077
8744 msgid "See also: C<guestfs_sh_lines>"
8749 #: ../src/guestfs-actions.pod:1088
8750 msgid "guestfs_config"
8755 #: ../src/guestfs-actions.pod:1090
8759 " guestfs_config (guestfs_h *g,\n"
8760 " const char *qemuparam,\n"
8761 " const char *qemuvalue);\n"
8766 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8768 "This can be used to add arbitrary qemu command line parameters of the form "
8769 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8770 "setting some parameters which would interfere with parameters that we use."
8775 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8776 msgid "The first character of C<param> string must be a C<-> (dash)."
8781 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8782 msgid "C<value> can be NULL."
8787 #: ../src/guestfs-actions.pod:1108
8788 msgid "guestfs_copy_size"
8793 #: ../src/guestfs-actions.pod:1110
8797 " guestfs_copy_size (guestfs_h *g,\n"
8798 " const char *src,\n"
8799 " const char *dest,\n"
8806 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8808 "This command copies exactly C<size> bytes from one source device or file "
8809 "C<src> to another destination device or file C<dest>."
8814 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8816 "Note this will fail if the source is too short or if the destination is not "
8821 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8822 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8823 #: ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:1725
8824 #: ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:6862
8825 #: ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7382
8826 #: ../src/guestfs-actions.pod:7401
8828 "This long-running command can generate progress notification messages so "
8829 "that the caller can display a progress bar or indicator. To receive these "
8830 "messages, the caller must register a progress event callback. See L<guestfs"
8831 "(3)/GUESTFS_EVENT_PROGRESS>."
8836 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4169
8837 #: ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:7103
8838 #: ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7209
8839 msgid "(Added in 1.0.87)"
8844 #: ../src/guestfs-actions.pod:1131
8850 #: ../src/guestfs-actions.pod:1133
8854 " guestfs_cp (guestfs_h *g,\n"
8855 " const char *src,\n"
8856 " const char *dest);\n"
8862 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8864 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8865 "destination filename or destination directory."
8870 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8871 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8872 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4861
8873 #: ../src/guestfs-actions.pod:5238
8874 msgid "(Added in 1.0.18)"
8879 #: ../src/guestfs-actions.pod:1145
8880 msgid "guestfs_cp_a"
8885 #: ../src/guestfs-actions.pod:1147
8889 " guestfs_cp_a (guestfs_h *g,\n"
8890 " const char *src,\n"
8891 " const char *dest);\n"
8897 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8899 "This copies a file or directory from C<src> to C<dest> recursively using the "
8905 #: ../src/guestfs-actions.pod:1159
8911 #: ../src/guestfs-actions.pod:1161
8915 " guestfs_dd (guestfs_h *g,\n"
8916 " const char *src,\n"
8917 " const char *dest);\n"
8923 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8925 "This command copies from one source device or file C<src> to another "
8926 "destination device or file C<dest>. Normally you would use this to copy to "
8927 "or from a device or partition, for example to duplicate a filesystem."
8932 #: ../src/guestfs-actions.pod:1171
8934 "If the destination is a device, it must be as large or larger than the "
8935 "source file or device, otherwise the copy will fail. This command cannot do "
8936 "partial copies (see C<guestfs_copy_size>)."
8941 #: ../src/guestfs-actions.pod:1179
8947 #: ../src/guestfs-actions.pod:1181
8951 " guestfs_df (guestfs_h *g);\n"
8957 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8958 msgid "This command runs the C<df> command to report disk space used."
8963 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8965 "This command is mostly useful for interactive sessions. It is I<not> "
8966 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8972 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8973 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2292
8974 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2384
8975 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4761
8976 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6624
8977 #: ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7262
8978 #: ../src/guestfs-actions.pod:7275
8979 msgid "(Added in 1.0.54)"
8984 #: ../src/guestfs-actions.pod:1195
8985 msgid "guestfs_df_h"
8990 #: ../src/guestfs-actions.pod:1197
8994 " guestfs_df_h (guestfs_h *g);\n"
9000 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
9002 "This command runs the C<df -h> command to report disk space used in human-"
9008 #: ../src/guestfs-actions.pod:1212
9009 msgid "guestfs_dmesg"
9014 #: ../src/guestfs-actions.pod:1214
9018 " guestfs_dmesg (guestfs_h *g);\n"
9024 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
9026 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9027 "This is sometimes useful for extended debugging of problems."
9032 #: ../src/guestfs-actions.pod:1221
9034 "Another way to get the same information is to enable verbose messages with "
9035 "C<guestfs_set_verbose> or by setting the environment variable "
9036 "C<LIBGUESTFS_DEBUG=1> before running the program."
9041 #: ../src/guestfs-actions.pod:1231
9042 msgid "guestfs_download"
9047 #: ../src/guestfs-actions.pod:1233
9051 " guestfs_download (guestfs_h *g,\n"
9052 " const char *remotefilename,\n"
9053 " const char *filename);\n"
9059 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
9060 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9062 "Download file C<remotefilename> and save it as C<filename> on the local "
9068 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6856
9069 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4630
9070 msgid "C<filename> can also be a named pipe."
9075 #: ../src/guestfs-actions.pod:1243
9076 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9081 #: ../src/guestfs-actions.pod:1254
9082 msgid "guestfs_download_offset"
9087 #: ../src/guestfs-actions.pod:1256
9091 " guestfs_download_offset (guestfs_h *g,\n"
9092 " const char *remotefilename,\n"
9093 " const char *filename,\n"
9094 " int64_t offset,\n"
9101 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
9103 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9104 "region must be within the file or device)."
9109 #: ../src/guestfs-actions.pod:1269
9111 "Note that there is no limit on the amount of data that can be downloaded "
9112 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9113 "full amount unless an error occurs."
9118 #: ../src/guestfs-actions.pod:1274
9119 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9124 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6901
9125 msgid "(Added in 1.5.17)"
9130 #: ../src/guestfs-actions.pod:1285
9131 msgid "guestfs_drop_caches"
9136 #: ../src/guestfs-actions.pod:1287
9140 " guestfs_drop_caches (guestfs_h *g,\n"
9141 " int whattodrop);\n"
9147 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
9149 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9150 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9151 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9156 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
9157 msgid "Setting C<whattodrop> to 3 should drop everything."
9162 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
9164 "This automatically calls L<sync(2)> before the operation, so that the "
9165 "maximum guest memory is freed."
9170 #: ../src/guestfs-actions.pod:1305
9176 #: ../src/guestfs-actions.pod:1307
9180 " guestfs_du (guestfs_h *g,\n"
9181 " const char *path);\n"
9187 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
9189 "This command runs the C<du -s> command to estimate file space usage for "
9195 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
9197 "C<path> can be a file or a directory. If C<path> is a directory then the "
9198 "estimate includes the contents of the directory and all subdirectories "
9204 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
9206 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9211 #: ../src/guestfs-actions.pod:1330
9212 msgid "guestfs_e2fsck_f"
9217 #: ../src/guestfs-actions.pod:1332
9221 " guestfs_e2fsck_f (guestfs_h *g,\n"
9222 " const char *device);\n"
9227 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
9229 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9230 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9236 #: ../src/guestfs-actions.pod:1340
9238 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9239 "Normally you should use C<guestfs_fsck>."
9244 #: ../src/guestfs-actions.pod:1345
9245 msgid "(Added in 1.0.29)"
9250 #: ../src/guestfs-actions.pod:1347
9251 msgid "guestfs_echo_daemon"
9256 #: ../src/guestfs-actions.pod:1349
9260 " guestfs_echo_daemon (guestfs_h *g,\n"
9261 " char *const *words);\n"
9267 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
9269 "This command concatenates the list of C<words> passed with single spaces "
9270 "between them and returns the resulting string."
9275 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
9276 msgid "You can use this command to test the connection through to the daemon."
9281 #: ../src/guestfs-actions.pod:1358
9282 msgid "See also C<guestfs_ping_daemon>."
9287 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2100
9288 #: ../src/guestfs-actions.pod:6072
9289 msgid "(Added in 1.0.69)"
9294 #: ../src/guestfs-actions.pod:1365
9295 msgid "guestfs_egrep"
9300 #: ../src/guestfs-actions.pod:1367
9304 " guestfs_egrep (guestfs_h *g,\n"
9305 " const char *regex,\n"
9306 " const char *path);\n"
9312 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
9314 "This calls the external C<egrep> program and returns the matching lines."
9319 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
9320 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
9321 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2230
9322 #: ../src/guestfs-actions.pod:2249 ../src/guestfs-actions.pod:2405
9323 #: ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2433
9324 #: ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:2501
9325 #: ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:3662
9326 #: ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:3689
9327 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4689
9328 #: ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5621
9329 #: ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6480
9330 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
9331 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6541
9332 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6567
9333 #: ../src/guestfs-actions.pod:7345 ../src/guestfs-actions.pod:7364
9334 #: ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7468
9335 #: ../src/guestfs-actions.pod:7514 ../src/guestfs-actions.pod:7533
9336 msgid "(Added in 1.0.66)"
9341 #: ../src/guestfs-actions.pod:1384
9342 msgid "guestfs_egrepi"
9347 #: ../src/guestfs-actions.pod:1386
9351 " guestfs_egrepi (guestfs_h *g,\n"
9352 " const char *regex,\n"
9353 " const char *path);\n"
9359 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
9361 "This calls the external C<egrep -i> program and returns the matching lines."
9366 #: ../src/guestfs-actions.pod:1403
9367 msgid "guestfs_equal"
9372 #: ../src/guestfs-actions.pod:1405
9376 " guestfs_equal (guestfs_h *g,\n"
9377 " const char *file1,\n"
9378 " const char *file2);\n"
9384 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
9386 "This compares the two files C<file1> and C<file2> and returns true if their "
9387 "content is exactly equal, or false otherwise."
9392 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
9393 msgid "The external L<cmp(1)> program is used for the comparison."
9398 #: ../src/guestfs-actions.pod:1419
9399 msgid "guestfs_exists"
9404 #: ../src/guestfs-actions.pod:1421
9408 " guestfs_exists (guestfs_h *g,\n"
9409 " const char *path);\n"
9415 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
9417 "This returns C<true> if and only if there is a file, directory (or anything) "
9418 "with the given C<path> name."
9423 #: ../src/guestfs-actions.pod:1428
9424 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9429 #: ../src/guestfs-actions.pod:1434
9430 msgid "guestfs_fallocate"
9435 #: ../src/guestfs-actions.pod:1436
9439 " guestfs_fallocate (guestfs_h *g,\n"
9440 " const char *path,\n"
9447 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
9448 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9450 "This command preallocates a file (containing zero bytes) named C<path> of "
9451 "size C<len> bytes. If the file exists already, it is overwritten."
9456 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
9458 "Do not confuse this with the guestfish-specific C<alloc> command which "
9459 "allocates a file in the host and attaches it as a device."
9464 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
9466 "This function is deprecated. In new code, use the C<fallocate64> call "
9472 #: ../src/guestfs-actions.pod:1460
9473 msgid "guestfs_fallocate64"
9478 #: ../src/guestfs-actions.pod:1462
9482 " guestfs_fallocate64 (guestfs_h *g,\n"
9483 " const char *path,\n"
9490 #: ../src/guestfs-actions.pod:1471
9492 "Note that this call allocates disk blocks for the file. To create a sparse "
9493 "file use C<guestfs_truncate_size> instead."
9498 #: ../src/guestfs-actions.pod:1474
9500 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9501 "oversight it only allowed 30 bit lengths to be specified, effectively "
9502 "limiting the maximum size of files created through that call to 1GB."
9507 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
9509 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9510 "commands which create a file in the host and attach it as a device."
9515 #: ../src/guestfs-actions.pod:1485
9516 msgid "(Added in 1.3.17)"
9521 #: ../src/guestfs-actions.pod:1487
9522 msgid "guestfs_fgrep"
9527 #: ../src/guestfs-actions.pod:1489
9531 " guestfs_fgrep (guestfs_h *g,\n"
9532 " const char *pattern,\n"
9533 " const char *path);\n"
9539 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
9541 "This calls the external C<fgrep> program and returns the matching lines."
9546 #: ../src/guestfs-actions.pod:1506
9547 msgid "guestfs_fgrepi"
9552 #: ../src/guestfs-actions.pod:1508
9556 " guestfs_fgrepi (guestfs_h *g,\n"
9557 " const char *pattern,\n"
9558 " const char *path);\n"
9564 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
9566 "This calls the external C<fgrep -i> program and returns the matching lines."
9571 #: ../src/guestfs-actions.pod:1525
9572 msgid "guestfs_file"
9577 #: ../src/guestfs-actions.pod:1527
9581 " guestfs_file (guestfs_h *g,\n"
9582 " const char *path);\n"
9588 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
9590 "This call uses the standard L<file(1)> command to determine the type or "
9591 "contents of the file."
9596 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
9598 "This call will also transparently look inside various types of compressed "
9603 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
9605 "The exact command which runs is C<file -zb path>. Note in particular that "
9606 "the filename is not prepended to the output (the I<-b> option)."
9611 #: ../src/guestfs-actions.pod:1541
9613 "This command can also be used on C</dev/> devices (and partitions, LV "
9614 "names). You can for example use this to determine if a device contains a "
9615 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9620 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
9622 "If the C<path> does not begin with C</dev/> then this command only works for "
9623 "the content of regular files. For other file types (directory, symbolic "
9624 "link etc) it will just return the string C<directory> etc."
9629 #: ../src/guestfs-actions.pod:1556
9630 msgid "guestfs_file_architecture"
9635 #: ../src/guestfs-actions.pod:1558
9639 " guestfs_file_architecture (guestfs_h *g,\n"
9640 " const char *filename);\n"
9646 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
9648 "This detects the architecture of the binary C<filename>, and returns it if "
9654 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1036
9655 msgid "Currently defined architectures are:"
9660 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1040
9666 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
9668 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9669 "irrespective of the precise processor requirements of the binary."
9674 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1045
9680 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1047
9681 msgid "64 bit x86-64."
9686 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1049
9692 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1051
9693 msgid "32 bit SPARC."
9698 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1053
9704 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1055
9705 msgid "64 bit SPARC V9 and above."
9710 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1057
9716 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1059
9717 msgid "Intel Itanium."
9722 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1061
9728 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1063
9729 msgid "32 bit Power PC."
9734 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1065
9740 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1067
9741 msgid "64 bit Power PC."
9746 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1071
9747 msgid "Libguestfs may return other architecture strings in future."
9752 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1073
9753 msgid "The function works on at least the following types of files:"
9758 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1079
9759 msgid "many types of Un*x and Linux binary"
9764 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1083
9765 msgid "many types of Un*x and Linux shared library"
9770 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1087
9771 msgid "Windows Win32 and Win64 binaries"
9776 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1091
9777 msgid "Windows Win32 and Win64 DLLs"
9782 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1093
9783 msgid "Win32 binaries and DLLs return C<i386>."
9788 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1095
9789 msgid "Win64 binaries and DLLs return C<x86_64>."
9794 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1099
9795 msgid "Linux kernel modules"
9800 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1103
9801 msgid "Linux new-style initrd images"
9806 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1107
9807 msgid "some non-x86 Linux vmlinuz kernels"
9812 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1111
9813 msgid "What it can't do currently:"
9818 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1117
9819 msgid "static libraries (libfoo.a)"
9824 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1121
9825 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9830 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1125
9831 msgid "x86 Linux vmlinuz kernels"
9836 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1127
9838 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9839 "compressed code, and are horribly hard to unpack. If you want to find the "
9840 "architecture of a kernel, use the architecture of the associated initrd or "
9841 "kernel module(s) instead."
9846 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1829
9847 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:2537
9848 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2700
9849 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2809
9850 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2936
9851 #: ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3280
9852 #: ../src/guestfs-actions.pod:3412
9853 msgid "(Added in 1.5.3)"
9858 #: ../src/guestfs-actions.pod:1668
9859 msgid "guestfs_filesize"
9864 #: ../src/guestfs-actions.pod:1670
9868 " guestfs_filesize (guestfs_h *g,\n"
9869 " const char *file);\n"
9875 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1138
9876 msgid "This command returns the size of C<file> in bytes."
9881 #: ../src/guestfs-actions.pod:1676
9883 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9884 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9885 "devices, use C<guestfs_blockdev_getsize64>."
9890 #: ../src/guestfs-actions.pod:1682
9891 msgid "(Added in 1.0.82)"
9896 #: ../src/guestfs-actions.pod:1684
9897 msgid "guestfs_fill"
9902 #: ../src/guestfs-actions.pod:1686
9906 " guestfs_fill (guestfs_h *g,\n"
9909 " const char *path);\n"
9915 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1148
9917 "This command creates a new file called C<path>. The initial content of the "
9918 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9924 #: ../src/guestfs-actions.pod:1696
9926 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9927 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9928 "bytes use C<guestfs_fill_pattern>."
9933 #: ../src/guestfs-actions.pod:1708
9934 msgid "(Added in 1.0.79)"
9939 #: ../src/guestfs-actions.pod:1710
9940 msgid "guestfs_fill_pattern"
9945 #: ../src/guestfs-actions.pod:1712
9949 " guestfs_fill_pattern (guestfs_h *g,\n"
9950 " const char *pattern,\n"
9952 " const char *path);\n"
9958 #: ../src/guestfs-actions.pod:1718
9960 "This function is like C<guestfs_fill> except that it creates a new file of "
9961 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9962 "pattern is truncated if necessary to ensure the length of the file is "
9963 "exactly C<len> bytes."
9968 #: ../src/guestfs-actions.pod:1730
9969 msgid "(Added in 1.3.12)"
9974 #: ../src/guestfs-actions.pod:1732
9975 msgid "guestfs_find"
9980 #: ../src/guestfs-actions.pod:1734
9984 " guestfs_find (guestfs_h *g,\n"
9985 " const char *directory);\n"
9991 #: ../src/guestfs-actions.pod:1738 ../fish/guestfish-actions.pod:1170
9993 "This command lists out all files and directories, recursively, starting at "
9994 "C<directory>. It is essentially equivalent to running the shell command "
9995 "C<find directory -print> but some post-processing happens on the output, "
10001 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
10003 "This returns a list of strings I<without any prefix>. Thus if the directory "
10009 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1178
10020 #: ../src/guestfs-actions.pod:1750
10022 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10027 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1185
10039 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
10040 msgid "If C<directory> is not a directory, then this command returns an error."
10045 #: ../src/guestfs-actions.pod:1761 ../fish/guestfish-actions.pod:1193
10046 msgid "The returned list is sorted."
10051 #: ../src/guestfs-actions.pod:1763
10052 msgid "See also C<guestfs_find0>."
10057 #: ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:4106
10058 #: ../src/guestfs-actions.pod:5656
10059 msgid "(Added in 1.0.27)"
10064 #: ../src/guestfs-actions.pod:1774
10065 msgid "guestfs_find0"
10070 #: ../src/guestfs-actions.pod:1776
10074 " guestfs_find0 (guestfs_h *g,\n"
10075 " const char *directory,\n"
10076 " const char *files);\n"
10082 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1204
10084 "This command lists out all files and directories, recursively, starting at "
10085 "C<directory>, placing the resulting list in the external file called "
10091 #: ../src/guestfs-actions.pod:1785
10093 "This command works the same way as C<guestfs_find> with the following "
10099 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1215
10100 msgid "The resulting list is written to an external file."
10105 #: ../src/guestfs-actions.pod:1796 ../fish/guestfish-actions.pod:1219
10107 "Items (filenames) in the result are separated by C<\\0> characters. See "
10108 "L<find(1)> option I<-print0>."
10113 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1224
10114 msgid "This command is not limited in the number of names that it can return."
10119 #: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1229
10120 msgid "The result list is not sorted."
10125 #: ../src/guestfs-actions.pod:1812
10126 msgid "(Added in 1.0.74)"
10131 #: ../src/guestfs-actions.pod:1814
10132 msgid "guestfs_findfs_label"
10137 #: ../src/guestfs-actions.pod:1816
10141 " guestfs_findfs_label (guestfs_h *g,\n"
10142 " const char *label);\n"
10148 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
10150 "This command searches the filesystems and returns the one which has the "
10151 "given label. An error is returned if no such filesystem can be found."
10156 #: ../src/guestfs-actions.pod:1824
10157 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10162 #: ../src/guestfs-actions.pod:1831
10163 msgid "guestfs_findfs_uuid"
10168 #: ../src/guestfs-actions.pod:1833
10172 " guestfs_findfs_uuid (guestfs_h *g,\n"
10173 " const char *uuid);\n"
10179 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1249
10181 "This command searches the filesystems and returns the one which has the "
10182 "given UUID. An error is returned if no such filesystem can be found."
10187 #: ../src/guestfs-actions.pod:1841
10188 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10193 #: ../src/guestfs-actions.pod:1848
10194 msgid "guestfs_fsck"
10199 #: ../src/guestfs-actions.pod:1850
10203 " guestfs_fsck (guestfs_h *g,\n"
10204 " const char *fstype,\n"
10205 " const char *device);\n"
10211 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
10213 "This runs the filesystem checker (fsck) on C<device> which should have "
10214 "filesystem type C<fstype>."
10219 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1262
10221 "The returned integer is the status. See L<fsck(8)> for the list of status "
10222 "codes from C<fsck>."
10227 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1271
10228 msgid "Multiple status codes can be summed together."
10233 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1275
10235 "A non-zero return code can mean \"success\", for example if errors have been "
10236 "corrected on the filesystem."
10241 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1280
10242 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10247 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1285
10249 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10254 #: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:7387
10255 msgid "(Added in 1.0.16)"
10260 #: ../src/guestfs-actions.pod:1887
10261 msgid "guestfs_get_append"
10266 #: ../src/guestfs-actions.pod:1889
10270 " guestfs_get_append (guestfs_h *g);\n"
10276 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
10278 "Return the additional kernel options which are added to the guest kernel "
10284 #: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1294
10285 msgid "If C<NULL> then no options are added."
10290 #: ../src/guestfs-actions.pod:1897
10292 "This function returns a string which may be NULL. There is no way to return "
10293 "an error from this function. The string is owned by the guest handle and "
10294 "must I<not> be freed."
10299 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5334
10300 #: ../src/guestfs-actions.pod:5814 ../src/guestfs-actions.pod:6235
10301 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6270
10302 #: ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:7051
10303 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7430
10304 msgid "(Added in 1.0.26)"
10308 #: ../src/guestfs-actions.pod:1903
10309 msgid "guestfs_get_attach_method"
10313 #: ../src/guestfs-actions.pod:1905
10317 " guestfs_get_attach_method (guestfs_h *g);\n"
10322 #: ../src/guestfs-actions.pod:1908
10323 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10328 #: ../src/guestfs-actions.pod:1913
10329 msgid "guestfs_get_autosync"
10334 #: ../src/guestfs-actions.pod:1915
10338 " guestfs_get_autosync (guestfs_h *g);\n"
10344 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1306
10345 msgid "Get the autosync flag."
10350 #: ../src/guestfs-actions.pod:1924
10351 msgid "guestfs_get_direct"
10356 #: ../src/guestfs-actions.pod:1926
10360 " guestfs_get_direct (guestfs_h *g);\n"
10366 #: ../src/guestfs-actions.pod:1929 ../fish/guestfish-actions.pod:1312
10367 msgid "Return the direct appliance mode flag."
10372 #: ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:5883
10373 msgid "(Added in 1.0.72)"
10378 #: ../src/guestfs-actions.pod:1935
10379 msgid "guestfs_get_e2label"
10384 #: ../src/guestfs-actions.pod:1937
10388 " guestfs_get_e2label (guestfs_h *g,\n"
10389 " const char *device);\n"
10395 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1318
10397 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10402 #: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1321
10404 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10409 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:1975
10410 #: ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5920
10411 msgid "(Added in 1.0.15)"
10416 #: ../src/guestfs-actions.pod:1956
10417 msgid "guestfs_get_e2uuid"
10422 #: ../src/guestfs-actions.pod:1958
10426 " guestfs_get_e2uuid (guestfs_h *g,\n"
10427 " const char *device);\n"
10433 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1332
10435 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10440 #: ../src/guestfs-actions.pod:1968 ../fish/guestfish-actions.pod:1335
10442 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10447 #: ../src/guestfs-actions.pod:1977
10448 msgid "guestfs_get_memsize"
10453 #: ../src/guestfs-actions.pod:1979
10457 " guestfs_get_memsize (guestfs_h *g);\n"
10463 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1346
10465 "This gets the memory size in megabytes allocated to the qemu subprocess."
10470 #: ../src/guestfs-actions.pod:1985
10472 "If C<guestfs_set_memsize> was not called on this handle, and if "
10473 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10474 "value for memsize."
10479 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2070
10480 #: ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:6043
10481 #: ../fish/guestfish-actions.pod:1353 ../fish/guestfish-actions.pod:1404
10482 #: ../fish/guestfish-actions.pod:4005 ../fish/guestfish-actions.pod:4092
10484 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10489 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:4397
10490 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4613
10491 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4644
10492 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4674
10493 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5941
10494 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6817
10495 msgid "(Added in 1.0.55)"
10500 #: ../src/guestfs-actions.pod:1996
10501 msgid "guestfs_get_network"
10506 #: ../src/guestfs-actions.pod:1998
10510 " guestfs_get_network (guestfs_h *g);\n"
10516 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1360
10517 msgid "This returns the enable network flag."
10522 #: ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:5960
10523 msgid "(Added in 1.5.4)"
10528 #: ../src/guestfs-actions.pod:2007
10529 msgid "guestfs_get_path"
10534 #: ../src/guestfs-actions.pod:2009
10538 " guestfs_get_path (guestfs_h *g);\n"
10544 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1366
10545 msgid "Return the current search path."
10550 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1368
10552 "This is always non-NULL. If it wasn't set already, then this will return "
10553 "the default path."
10558 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2046
10560 "This function returns a string, or NULL on error. The string is owned by "
10561 "the guest handle and must I<not> be freed."
10566 #: ../src/guestfs-actions.pod:2022
10567 msgid "guestfs_get_pid"
10572 #: ../src/guestfs-actions.pod:2024
10576 " guestfs_get_pid (guestfs_h *g);\n"
10582 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
10584 "Return the process ID of the qemu subprocess. If there is no qemu "
10585 "subprocess, then this will return an error."
10590 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1380
10591 msgid "This is an internal call used for debugging and testing."
10596 #: ../src/guestfs-actions.pod:2034
10597 msgid "(Added in 1.0.56)"
10602 #: ../src/guestfs-actions.pod:2036
10603 msgid "guestfs_get_qemu"
10608 #: ../src/guestfs-actions.pod:2038
10612 " guestfs_get_qemu (guestfs_h *g);\n"
10618 #: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1386
10619 msgid "Return the current qemu binary."
10624 #: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1388
10626 "This is always non-NULL. If it wasn't set already, then this will return "
10627 "the default qemu binary name."
10632 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:6005
10633 msgid "(Added in 1.0.6)"
10638 #: ../src/guestfs-actions.pod:2051
10639 msgid "guestfs_get_recovery_proc"
10644 #: ../src/guestfs-actions.pod:2053
10648 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10654 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1395
10655 msgid "Return the recovery process enabled flag."
10660 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3507
10661 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:4204
10662 #: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:5264
10663 #: ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:6029
10664 #: ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6740
10665 #: ../src/guestfs-actions.pod:6932
10666 msgid "(Added in 1.0.77)"
10671 #: ../src/guestfs-actions.pod:2062
10672 msgid "guestfs_get_selinux"
10677 #: ../src/guestfs-actions.pod:2064
10681 " guestfs_get_selinux (guestfs_h *g);\n"
10687 #: ../src/guestfs-actions.pod:2067
10689 "This returns the current setting of the selinux flag which is passed to the "
10690 "appliance at boot time. See C<guestfs_set_selinux>."
10695 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2138
10696 #: ../src/guestfs-actions.pod:6048 ../src/guestfs-actions.pod:6106
10697 msgid "(Added in 1.0.67)"
10702 #: ../src/guestfs-actions.pod:2077
10703 msgid "guestfs_get_state"
10708 #: ../src/guestfs-actions.pod:2079
10712 " guestfs_get_state (guestfs_h *g);\n"
10718 #: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1411
10720 "This returns the current state as an opaque integer. This is only useful "
10721 "for printing debug and internal error messages."
10726 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
10727 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
10728 #: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:1414
10729 #: ../fish/guestfish-actions.pod:2328 ../fish/guestfish-actions.pod:2346
10730 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2400
10731 msgid "For more information on states, see L<guestfs(3)>."
10736 #: ../src/guestfs-actions.pod:2091
10737 msgid "guestfs_get_trace"
10742 #: ../src/guestfs-actions.pod:2093
10746 " guestfs_get_trace (guestfs_h *g);\n"
10752 #: ../src/guestfs-actions.pod:2096 ../fish/guestfish-actions.pod:1420
10753 msgid "Return the command trace flag."
10758 #: ../src/guestfs-actions.pod:2102
10759 msgid "guestfs_get_umask"
10764 #: ../src/guestfs-actions.pod:2104
10768 " guestfs_get_umask (guestfs_h *g);\n"
10774 #: ../src/guestfs-actions.pod:2107
10776 "Return the current umask. By default the umask is C<022> unless it has been "
10777 "set by calling C<guestfs_umask>."
10782 #: ../src/guestfs-actions.pod:2114
10783 msgid "guestfs_get_verbose"
10788 #: ../src/guestfs-actions.pod:2116
10792 " guestfs_get_verbose (guestfs_h *g);\n"
10798 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1433
10799 msgid "This returns the verbose messages flag."
10804 #: ../src/guestfs-actions.pod:2125
10805 msgid "guestfs_getcon"
10810 #: ../src/guestfs-actions.pod:2127
10814 " guestfs_getcon (guestfs_h *g);\n"
10820 #: ../src/guestfs-actions.pod:2130 ../fish/guestfish-actions.pod:1439
10821 msgid "This gets the SELinux security context of the daemon."
10826 #: ../src/guestfs-actions.pod:2132
10828 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10833 #: ../src/guestfs-actions.pod:2140
10834 msgid "guestfs_getxattr"
10839 #: ../src/guestfs-actions.pod:2142
10843 " guestfs_getxattr (guestfs_h *g,\n"
10844 " const char *path,\n"
10845 " const char *name,\n"
10846 " size_t *size_r);\n"
10852 #: ../src/guestfs-actions.pod:2148
10854 "Get a single extended attribute from file C<path> named C<name>. This call "
10855 "follows symlinks. If you want to lookup an extended attribute for the "
10856 "symlink itself, use C<guestfs_lgetxattr>."
10861 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3521
10863 "Normally it is better to get all extended attributes from a file in one go "
10864 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10865 "implementations are buggy and do not provide a way to list out attributes. "
10866 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10867 "extended attributes you want in advance and call this function."
10872 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
10873 #: ../fish/guestfish-actions.pod:1459 ../fish/guestfish-actions.pod:2465
10875 "Extended attribute values are blobs of binary data. If there is no extended "
10876 "attribute named C<name>, this returns an error."
10881 #: ../src/guestfs-actions.pod:2162
10882 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10887 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2355
10888 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:5257
10889 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5464
10891 "This function returns a buffer, or NULL on error. The size of the returned "
10892 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10897 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:3537
10898 msgid "(Added in 1.7.24)"
10903 #: ../src/guestfs-actions.pod:2170
10904 msgid "guestfs_getxattrs"
10909 #: ../src/guestfs-actions.pod:2172
10912 " struct guestfs_xattr_list *\n"
10913 " guestfs_getxattrs (guestfs_h *g,\n"
10914 " const char *path);\n"
10920 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
10922 "This call lists the extended attributes of the file or directory C<path>."
10927 #: ../src/guestfs-actions.pod:2179 ../fish/guestfish-actions.pod:1471
10929 "At the system call level, this is a combination of the L<listxattr(2)> and "
10930 "L<getxattr(2)> calls."
10935 #: ../src/guestfs-actions.pod:2182
10936 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10941 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
10942 #: ../src/guestfs-actions.pod:4200
10944 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10945 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10950 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3553
10951 #: ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754
10952 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:6125
10953 #: ../src/guestfs-actions.pod:7495
10954 msgid "(Added in 1.0.59)"
10959 #: ../src/guestfs-actions.pod:2190
10960 msgid "guestfs_glob_expand"
10965 #: ../src/guestfs-actions.pod:2192
10969 " guestfs_glob_expand (guestfs_h *g,\n"
10970 " const char *pattern);\n"
10976 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1480
10978 "This command searches for all the pathnames matching C<pattern> according to "
10979 "the wildcard expansion rules used by the shell."
10984 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
10986 "If no paths match, then this returns an empty list (note: not an error)."
10991 #: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1487
10993 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10994 "GLOB_BRACE>. See that manual page for more details."
10999 #: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:6318
11000 #: ../src/guestfs-actions.pod:6335
11001 msgid "(Added in 1.0.50)"
11006 #: ../src/guestfs-actions.pod:2213
11007 msgid "guestfs_grep"
11012 #: ../src/guestfs-actions.pod:2215
11016 " guestfs_grep (guestfs_h *g,\n"
11017 " const char *regex,\n"
11018 " const char *path);\n"
11024 #: ../src/guestfs-actions.pod:2220 ../fish/guestfish-actions.pod:1495
11025 msgid "This calls the external C<grep> program and returns the matching lines."
11030 #: ../src/guestfs-actions.pod:2232
11031 msgid "guestfs_grepi"
11036 #: ../src/guestfs-actions.pod:2234
11040 " guestfs_grepi (guestfs_h *g,\n"
11041 " const char *regex,\n"
11042 " const char *path);\n"
11048 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1505
11050 "This calls the external C<grep -i> program and returns the matching lines."
11055 #: ../src/guestfs-actions.pod:2251
11056 msgid "guestfs_grub_install"
11061 #: ../src/guestfs-actions.pod:2253
11065 " guestfs_grub_install (guestfs_h *g,\n"
11066 " const char *root,\n"
11067 " const char *device);\n"
11073 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
11075 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11076 "the root directory being C<root>."
11081 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1518
11083 "Note: If grub-install reports the error \"No suitable drive was found in the "
11084 "generated device map.\" it may be that you need to create a C</boot/grub/"
11085 "device.map> file first that contains the mapping between grub device names "
11086 "and Linux device names. It is usually sufficient to create a file "
11092 #: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1525
11095 " (hd0) /dev/vda\n"
11101 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1527
11102 msgid "replacing C</dev/vda> with the name of the installation device."
11107 #: ../src/guestfs-actions.pod:2274
11108 msgid "(Added in 1.0.17)"
11113 #: ../src/guestfs-actions.pod:2276
11114 msgid "guestfs_head"
11119 #: ../src/guestfs-actions.pod:2278
11123 " guestfs_head (guestfs_h *g,\n"
11124 " const char *path);\n"
11130 #: ../src/guestfs-actions.pod:2282 ../fish/guestfish-actions.pod:1533
11132 "This command returns up to the first 10 lines of a file as a list of strings."
11137 #: ../src/guestfs-actions.pod:2294
11138 msgid "guestfs_head_n"
11143 #: ../src/guestfs-actions.pod:2296
11147 " guestfs_head_n (guestfs_h *g,\n"
11149 " const char *path);\n"
11155 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
11157 "If the parameter C<nrlines> is a positive number, this returns the first "
11158 "C<nrlines> lines of the file C<path>."
11163 #: ../src/guestfs-actions.pod:2304 ../fish/guestfish-actions.pod:1546
11165 "If the parameter C<nrlines> is a negative number, this returns lines from "
11166 "the file C<path>, excluding the last C<nrlines> lines."
11171 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:6615
11172 #: ../fish/guestfish-actions.pod:1549 ../fish/guestfish-actions.pod:4470
11173 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11178 #: ../src/guestfs-actions.pod:2318
11179 msgid "guestfs_hexdump"
11184 #: ../src/guestfs-actions.pod:2320
11188 " guestfs_hexdump (guestfs_h *g,\n"
11189 " const char *path);\n"
11195 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1558
11197 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11198 "readable, canonical hex dump of the file."
11203 #: ../src/guestfs-actions.pod:2333 ../src/guestfs-actions.pod:6399
11204 #: ../src/guestfs-actions.pod:6454
11205 msgid "(Added in 1.0.22)"
11210 #: ../src/guestfs-actions.pod:2335
11211 msgid "guestfs_initrd_cat"
11216 #: ../src/guestfs-actions.pod:2337
11220 " guestfs_initrd_cat (guestfs_h *g,\n"
11221 " const char *initrdpath,\n"
11222 " const char *filename,\n"
11223 " size_t *size_r);\n"
11229 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1568
11231 "This command unpacks the file C<filename> from the initrd file called "
11232 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11238 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1572
11240 "For example, in guestfish you could use the following command to examine the "
11241 "boot script (usually called C</init>) contained in a Linux initrd or "
11247 #: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1576
11250 " initrd-cat /boot/initrd-<version>.img init\n"
11256 #: ../src/guestfs-actions.pod:2353
11257 msgid "See also C<guestfs_initrd_list>."
11262 #: ../src/guestfs-actions.pod:2364
11263 msgid "guestfs_initrd_list"
11268 #: ../src/guestfs-actions.pod:2366
11272 " guestfs_initrd_list (guestfs_h *g,\n"
11273 " const char *path);\n"
11279 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1587
11280 msgid "This command lists out files contained in an initrd."
11285 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1589
11287 "The files are listed without any initial C</> character. The files are "
11288 "listed in the order they appear (not necessarily alphabetical). Directory "
11289 "names are listed as separate items."
11294 #: ../src/guestfs-actions.pod:2376 ../fish/guestfish-actions.pod:1593
11296 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11297 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11303 #: ../src/guestfs-actions.pod:2386
11304 msgid "guestfs_inotify_add_watch"
11309 #: ../src/guestfs-actions.pod:2388
11313 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11314 " const char *path,\n"
11321 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1601
11322 msgid "Watch C<path> for the events listed in C<mask>."
11327 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1603
11329 "Note that if C<path> is a directory then events within that directory are "
11330 "watched, but this does I<not> happen recursively (in subdirectories)."
11335 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1607
11337 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11338 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11343 #: ../src/guestfs-actions.pod:2407
11344 msgid "guestfs_inotify_close"
11349 #: ../src/guestfs-actions.pod:2409
11353 " guestfs_inotify_close (guestfs_h *g);\n"
11359 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1615
11361 "This closes the inotify handle which was previously opened by inotify_init. "
11362 "It removes all watches, throws away any pending events, and deallocates all "
11368 #: ../src/guestfs-actions.pod:2420
11369 msgid "guestfs_inotify_files"
11374 #: ../src/guestfs-actions.pod:2422
11378 " guestfs_inotify_files (guestfs_h *g);\n"
11384 #: ../src/guestfs-actions.pod:2425
11386 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11387 "returns a list of pathnames of objects that were touched. The returned "
11388 "pathnames are sorted and deduplicated."
11393 #: ../src/guestfs-actions.pod:2435
11394 msgid "guestfs_inotify_init"
11399 #: ../src/guestfs-actions.pod:2437
11403 " guestfs_inotify_init (guestfs_h *g,\n"
11404 " int maxevents);\n"
11410 #: ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1631
11412 "This command creates a new inotify handle. The inotify subsystem can be "
11413 "used to notify events which happen to objects in the guest filesystem."
11418 #: ../src/guestfs-actions.pod:2445
11420 "C<maxevents> is the maximum number of events which will be queued up between "
11421 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11422 "passed as C<0>, then the kernel (or previously set) default is used. For "
11423 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11424 "throws away events, but records the fact that it threw them away by setting "
11425 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11426 "C<guestfs_inotify_read>)."
11431 #: ../src/guestfs-actions.pod:2455
11433 "Before any events are generated, you have to add some watches to the "
11434 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11435 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11440 #: ../src/guestfs-actions.pod:2461
11442 "Queued up events should be read periodically by calling "
11443 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11444 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11445 "often enough then you risk the internal queue overflowing."
11450 #: ../src/guestfs-actions.pod:2468
11452 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11453 "This also removes any watches automatically."
11458 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1662
11460 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11461 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11462 "that there is one global inotify handle per libguestfs instance."
11467 #: ../src/guestfs-actions.pod:2481
11468 msgid "guestfs_inotify_read"
11473 #: ../src/guestfs-actions.pod:2483
11476 " struct guestfs_inotify_event_list *\n"
11477 " guestfs_inotify_read (guestfs_h *g);\n"
11483 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
11485 "Return the complete queue of events that have happened since the previous "
11491 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1674
11492 msgid "If no events have happened, this returns an empty list."
11497 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
11499 "I<Note>: In order to make sure that all events have been read, you must call "
11500 "this function repeatedly until it returns an empty list. The reason is that "
11501 "the call will read events up to the maximum appliance-to-host message size "
11502 "and leave remaining events in the queue."
11507 #: ../src/guestfs-actions.pod:2497
11509 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11510 "there was an error. I<The caller must call "
11511 "C<guestfs_free_inotify_event_list> after use>."
11516 #: ../src/guestfs-actions.pod:2503
11517 msgid "guestfs_inotify_rm_watch"
11522 #: ../src/guestfs-actions.pod:2505
11526 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11533 #: ../src/guestfs-actions.pod:2509
11535 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11540 #: ../src/guestfs-actions.pod:2516
11541 msgid "guestfs_inspect_get_arch"
11546 #: ../src/guestfs-actions.pod:2518
11550 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11551 " const char *root);\n"
11557 #: ../src/guestfs-actions.pod:2522 ../src/guestfs-actions.pod:2545
11558 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2682
11559 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2747
11560 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2796
11561 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860
11562 #: ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2920
11563 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2999
11564 #: ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3062
11565 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
11566 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3138
11568 "This function should only be called with a root device string as returned by "
11569 "C<guestfs_inspect_os>."
11574 #: ../src/guestfs-actions.pod:2525
11576 "This returns the architecture of the inspected operating system. The "
11577 "possible return values are listed under C<guestfs_file_architecture>."
11582 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1700
11584 "If the architecture could not be determined, then the string C<unknown> is "
11590 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2625
11591 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:2756
11592 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2876
11593 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2931
11594 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3028
11595 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
11596 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3109
11597 #: ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3231
11598 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:1703
11599 #: ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1877
11600 #: ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1913
11601 #: ../fish/guestfish-actions.pod:1983 ../fish/guestfish-actions.pod:2007
11602 #: ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2067
11603 #: ../fish/guestfish-actions.pod:2102 ../fish/guestfish-actions.pod:2118
11604 #: ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147
11605 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2175
11606 #: ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2308
11607 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11612 #: ../src/guestfs-actions.pod:2539
11613 msgid "guestfs_inspect_get_distro"
11618 #: ../src/guestfs-actions.pod:2541
11622 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11623 " const char *root);\n"
11629 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
11631 "This returns the distro (distribution) of the inspected operating system."
11636 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1715
11637 msgid "Currently defined distros are:"
11642 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1719
11643 msgid "\"archlinux\""
11648 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1721
11649 msgid "Arch Linux."
11653 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1723
11658 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1725
11664 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1727
11670 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1729
11676 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1731
11682 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1733
11688 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1735
11694 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1737
11700 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1739
11701 msgid "\"linuxmint\""
11706 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1741
11707 msgid "Linux Mint."
11712 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1743
11713 msgid "\"mandriva\""
11718 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1745
11724 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1747
11730 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1749
11736 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1751
11742 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1753
11748 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1755
11749 msgid "\"redhat-based\""
11754 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1757
11755 msgid "Some Red Hat-derived distro."
11760 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1759
11765 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1761
11766 msgid "Red Hat Enterprise Linux."
11770 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1763
11771 msgid "\"scientificlinux\""
11775 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1765
11776 msgid "Scientific Linux."
11780 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1767
11781 msgid "\"slackware\""
11785 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1769
11791 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1771
11797 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1773
11803 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2727
11804 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1775
11805 #: ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:2093
11806 msgid "\"unknown\""
11811 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1777
11812 msgid "The distro could not be determined."
11817 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3011
11818 #: ../fish/guestfish-actions.pod:1779 ../fish/guestfish-actions.pod:2085
11819 msgid "\"windows\""
11824 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1781
11826 "Windows does not have distributions. This string is returned if the OS type "
11832 #: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733
11833 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:1786
11834 #: ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:2099
11836 "Future versions of libguestfs may return other strings here. The caller "
11837 "should be prepared to handle any string."
11841 #: ../src/guestfs-actions.pod:2632
11842 msgid "guestfs_inspect_get_drive_mappings"
11846 #: ../src/guestfs-actions.pod:2634
11850 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11851 " const char *root);\n"
11856 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1798
11858 "This call is useful for Windows which uses a primitive system of assigning "
11859 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11860 "Windows Registry to find out how disks/partitions are mapped to drive "
11861 "letters, and returns a hash table as in the example below:"
11865 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
11868 " C => /dev/vda2\n"
11869 " E => /dev/vdb1\n"
11870 " F => /dev/vdc1\n"
11875 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
11877 "Note that keys are drive letters. For Windows, the key is case insensitive "
11878 "and just contains the drive letter, without the customary colon separator "
11883 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1812
11885 "In future we may support other operating systems that also used drive "
11886 "letters, but the keys for those might not be case insensitive and might be "
11887 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11892 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
11894 "For Windows guests, currently only hard drive mappings are returned. "
11895 "Removable disks (eg. DVD-ROMs) are ignored."
11899 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1820
11901 "For guests that do not use drive mappings, or if the drive mappings could "
11902 "not be determined, this returns an empty hash table."
11906 #: ../src/guestfs-actions.pod:2666
11908 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11909 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11914 #: ../src/guestfs-actions.pod:2670 ../src/guestfs-actions.pod:2846
11915 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:4823
11916 #: ../src/guestfs-actions.pod:6756
11918 "This function returns a NULL-terminated array of strings, or NULL if there "
11919 "was an error. The array of strings will always have length C<2n+1>, where "
11920 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11921 "caller must free the strings and the array after use>."
11926 #: ../src/guestfs-actions.pod:2676
11927 msgid "guestfs_inspect_get_filesystems"
11932 #: ../src/guestfs-actions.pod:2678
11936 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11937 " const char *root);\n"
11943 #: ../src/guestfs-actions.pod:2685 ../fish/guestfish-actions.pod:1834
11945 "This returns a list of all the filesystems that we think are associated with "
11946 "this operating system. This includes the root filesystem, other ordinary "
11947 "filesystems, and non-mounted devices like swap partitions."
11952 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1839
11954 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11955 "to be shared between operating systems."
11960 #: ../src/guestfs-actions.pod:2693
11962 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11963 "C<guestfs_inspect_get_mountpoints>."
11967 #: ../src/guestfs-actions.pod:2702
11968 msgid "guestfs_inspect_get_format"
11972 #: ../src/guestfs-actions.pod:2704
11976 " guestfs_inspect_get_format (guestfs_h *g,\n"
11977 " const char *root);\n"
11982 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
11984 "This returns the format of the inspected operating system. You can use it "
11985 "to detect install images, live CDs and similar."
11989 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1855
11990 msgid "Currently defined formats are:"
11994 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1859
11995 msgid "\"installed\""
11999 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
12000 msgid "This is an installed operating system."
12004 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1863
12005 msgid "\"installer\""
12009 #: ../src/guestfs-actions.pod:2724 ../fish/guestfish-actions.pod:1865
12011 "The disk image being inspected is not an installed operating system, but a "
12012 "I<bootable> install disk, live CD, or similar."
12016 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
12017 msgid "The format of this disk image is not known."
12022 #: ../src/guestfs-actions.pod:2741
12023 msgid "guestfs_inspect_get_hostname"
12028 #: ../src/guestfs-actions.pod:2743
12032 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12033 " const char *root);\n"
12039 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
12041 "This function returns the hostname of the operating system as found by "
12042 "inspection of the guest's configuration files."
12047 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1889
12049 "If the hostname could not be determined, then the string C<unknown> is "
12055 #: ../src/guestfs-actions.pod:2761
12056 msgid "(Added in 1.7.9)"
12061 #: ../src/guestfs-actions.pod:2763
12062 msgid "guestfs_inspect_get_major_version"
12067 #: ../src/guestfs-actions.pod:2765
12071 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12072 " const char *root);\n"
12078 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
12080 "This returns the major version number of the inspected operating system."
12085 #: ../src/guestfs-actions.pod:2775 ../fish/guestfish-actions.pod:1904
12087 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12088 "popular public names used by the operating system. Notably the operating "
12089 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12090 "1). You can find out the real versions corresponding to releases of Windows "
12091 "by consulting Wikipedia or MSDN."
12096 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2802
12097 #: ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1925
12098 msgid "If the version could not be determined, then C<0> is returned."
12103 #: ../src/guestfs-actions.pod:2790
12104 msgid "guestfs_inspect_get_minor_version"
12109 #: ../src/guestfs-actions.pod:2792
12113 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12114 " const char *root);\n"
12120 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1922
12122 "This returns the minor version number of the inspected operating system."
12127 #: ../src/guestfs-actions.pod:2804
12129 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12130 "C<guestfs_inspect_get_major_version>."
12135 #: ../src/guestfs-actions.pod:2811
12136 msgid "guestfs_inspect_get_mountpoints"
12141 #: ../src/guestfs-actions.pod:2813
12145 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12146 " const char *root);\n"
12151 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1937
12153 "This returns a hash of where we think the filesystems associated with this "
12154 "operating system should be mounted. Callers should note that this is at "
12155 "best an educated guess made by reading configuration files such as C</etc/"
12156 "fstab>. I<In particular note> that this may return filesystems which are "
12157 "non-existent or not mountable and callers should be prepared to handle or "
12158 "ignore failures if they try to mount them."
12163 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1946
12165 "Each element in the returned hashtable has a key which is the path of the "
12166 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12167 "mounted there (eg. C</dev/sda1>)."
12172 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1951
12174 "Non-mounted devices such as swap devices are I<not> returned in this list."
12178 #: ../src/guestfs-actions.pod:2837
12180 "For operating systems like Windows which still use drive letters, this call "
12181 "will only return an entry for the first drive \"mounted on\" C</>. For "
12182 "information about the mapping of drive letters to partitions, see "
12183 "C<guestfs_inspect_get_drive_mappings>."
12188 #: ../src/guestfs-actions.pod:2843
12190 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12191 "C<guestfs_inspect_get_filesystems>."
12196 #: ../src/guestfs-actions.pod:2854
12197 msgid "guestfs_inspect_get_package_format"
12202 #: ../src/guestfs-actions.pod:2856
12206 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12207 " const char *root);\n"
12213 #: ../src/guestfs-actions.pod:2863
12215 "This function and C<guestfs_inspect_get_package_management> return the "
12216 "package format and package management tool used by the inspected operating "
12217 "system. For example for Fedora these functions would return C<rpm> (package "
12218 "format) and C<yum> (package management)."
12223 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1976
12225 "This returns the string C<unknown> if we could not determine the package "
12226 "format I<or> if the operating system does not have a real packaging system "
12232 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1980
12234 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12235 "Future versions of libguestfs may return other strings."
12240 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:2912
12241 msgid "(Added in 1.7.5)"
12246 #: ../src/guestfs-actions.pod:2883
12247 msgid "guestfs_inspect_get_package_management"
12252 #: ../src/guestfs-actions.pod:2885
12256 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12257 " const char *root);\n"
12263 #: ../src/guestfs-actions.pod:2892
12265 "C<guestfs_inspect_get_package_format> and this function return the package "
12266 "format and package management tool used by the inspected operating system. "
12267 "For example for Fedora these functions would return C<rpm> (package format) "
12268 "and C<yum> (package management)."
12273 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1998
12275 "This returns the string C<unknown> if we could not determine the package "
12276 "management tool I<or> if the operating system does not have a real packaging "
12277 "system (eg. Windows)."
12282 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2002
12284 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12285 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12286 "libguestfs may return other strings."
12291 #: ../src/guestfs-actions.pod:2914
12292 msgid "guestfs_inspect_get_product_name"
12297 #: ../src/guestfs-actions.pod:2916
12301 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12302 " const char *root);\n"
12308 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2016
12310 "This returns the product name of the inspected operating system. The "
12311 "product name is generally some freeform string which can be displayed to the "
12312 "user, but should not be parsed by programs."
12317 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2021
12319 "If the product name could not be determined, then the string C<unknown> is "
12324 #: ../src/guestfs-actions.pod:2938
12325 msgid "guestfs_inspect_get_product_variant"
12329 #: ../src/guestfs-actions.pod:2940
12333 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12334 " const char *root);\n"
12339 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
12340 msgid "This returns the product variant of the inspected operating system."
12344 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2036
12346 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12347 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12348 "is usually a string such as C<Client> or C<Server> (other values are "
12349 "possible). This can be used to distinguish consumer and enterprise versions "
12350 "of Windows that have the same version number (for example, Windows 7 and "
12351 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12352 "the latter is C<Server>)."
12356 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2045
12358 "For enterprise Linux guests, in future we intend this to return the product "
12359 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12360 "implemented at present."
12364 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2049
12366 "If the product variant could not be determined, then the string C<unknown> "
12371 #: ../src/guestfs-actions.pod:2966
12373 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12374 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12379 #: ../src/guestfs-actions.pod:2973
12380 msgid "guestfs_inspect_get_roots"
12385 #: ../src/guestfs-actions.pod:2975
12389 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12395 #: ../src/guestfs-actions.pod:2978
12397 "This function is a convenient way to get the list of root devices, as "
12398 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12399 "the whole inspection process."
12404 #: ../src/guestfs-actions.pod:2982
12406 "This returns an empty list if either no root devices were found or the "
12407 "caller has not called C<guestfs_inspect_os>."
12412 #: ../src/guestfs-actions.pod:2991
12413 msgid "(Added in 1.7.3)"
12418 #: ../src/guestfs-actions.pod:2993
12419 msgid "guestfs_inspect_get_type"
12424 #: ../src/guestfs-actions.pod:2995
12428 " guestfs_inspect_get_type (guestfs_h *g,\n"
12429 " const char *root);\n"
12435 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2076
12437 "This returns the type of the inspected operating system. Currently defined "
12443 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2081
12449 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2083
12450 msgid "Any Linux-based operating system."
12455 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2087
12456 msgid "Any Microsoft Windows operating system."
12461 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2089
12462 msgid "\"freebsd\""
12467 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2091
12473 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2095
12474 msgid "The operating system type could not be determined."
12478 #: ../src/guestfs-actions.pod:3035
12479 msgid "guestfs_inspect_get_windows_current_control_set"
12483 #: ../src/guestfs-actions.pod:3037
12487 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12488 " const char *root);\n"
12493 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
12495 "This returns the Windows CurrentControlSet of the inspected guest. The "
12496 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12500 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2114
12502 "This call assumes that the guest is Windows and that the Registry could be "
12503 "examined by inspection. If this is not the case then an error is returned."
12508 #: ../src/guestfs-actions.pod:3056
12509 msgid "guestfs_inspect_get_windows_systemroot"
12514 #: ../src/guestfs-actions.pod:3058
12518 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12519 " const char *root);\n"
12525 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
12527 "This returns the Windows systemroot of the inspected guest. The systemroot "
12528 "is a directory path such as C</WINDOWS>."
12533 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
12535 "This call assumes that the guest is Windows and that the systemroot could be "
12536 "determined by inspection. If this is not the case then an error is returned."
12541 #: ../src/guestfs-actions.pod:3077
12542 msgid "(Added in 1.5.25)"
12546 #: ../src/guestfs-actions.pod:3079
12547 msgid "guestfs_inspect_is_live"
12551 #: ../src/guestfs-actions.pod:3081
12555 " guestfs_inspect_is_live (guestfs_h *g,\n"
12556 " const char *root);\n"
12561 #: ../src/guestfs-actions.pod:3088
12563 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12564 "disk), then this returns true if a live image was detected on the disk."
12568 #: ../src/guestfs-actions.pod:3096
12569 msgid "guestfs_inspect_is_multipart"
12573 #: ../src/guestfs-actions.pod:3098
12577 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12578 " const char *root);\n"
12583 #: ../src/guestfs-actions.pod:3105
12585 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12586 "disk), then this returns true if the disk is part of a set."
12590 #: ../src/guestfs-actions.pod:3113
12591 msgid "guestfs_inspect_is_netinst"
12595 #: ../src/guestfs-actions.pod:3115
12599 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12600 " const char *root);\n"
12605 #: ../src/guestfs-actions.pod:3122
12607 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12608 "disk), then this returns true if the disk is a network installer, ie. not a "
12609 "self-contained install CD but one which is likely to require network access "
12610 "to complete the install."
12615 #: ../src/guestfs-actions.pod:3132
12616 msgid "guestfs_inspect_list_applications"
12621 #: ../src/guestfs-actions.pod:3134
12624 " struct guestfs_application_list *\n"
12625 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12626 " const char *root);\n"
12632 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2184
12633 msgid "Return the list of applications installed in the operating system."
12638 #: ../src/guestfs-actions.pod:3143
12640 "I<Note:> This call works differently from other parts of the inspection "
12641 "API. You have to call C<guestfs_inspect_os>, then "
12642 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12643 "this. Listing applications is a significantly more difficult operation "
12644 "which requires access to the full filesystem. Also note that unlike the "
12645 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12646 "the libguestfs handle, this call actually reads parts of the mounted "
12647 "filesystems during the call."
12652 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
12654 "This returns an empty list if the inspection code was not able to determine "
12655 "the list of applications."
12660 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2199
12661 msgid "The application structure contains the following fields:"
12666 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2203
12667 msgid "C<app_name>"
12672 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
12674 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12675 "guests, this is the package name."
12680 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2208
12681 msgid "C<app_display_name>"
12686 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
12688 "The display name of the application, sometimes localized to the install "
12689 "language of the guest operating system."
12694 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
12696 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12697 "to display something can use C<app_name> instead."
12702 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2216
12703 msgid "C<app_epoch>"
12708 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
12710 "For package managers which use epochs, this contains the epoch of the "
12711 "package (an integer). If unavailable, this is returned as C<0>."
12716 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2221
12717 msgid "C<app_version>"
12722 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
12724 "The version string of the application or package. If unavailable this is "
12725 "returned as an empty string C<\"\">."
12730 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2226
12731 msgid "C<app_release>"
12736 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2228
12738 "The release string of the application or package, for package managers that "
12739 "use this. If unavailable this is returned as an empty string C<\"\">."
12744 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2232
12745 msgid "C<app_install_path>"
12750 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2234
12752 "The installation path of the application (on operating systems such as "
12753 "Windows which use installation paths). This path is in the format used by "
12754 "the guest operating system, it is not a libguestfs path."
12759 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2239
12760 msgid "If unavailable this is returned as an empty string C<\"\">."
12765 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2241
12766 msgid "C<app_trans_path>"
12771 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
12773 "The install path translated into a libguestfs path. If unavailable this is "
12774 "returned as an empty string C<\"\">."
12779 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2246
12780 msgid "C<app_publisher>"
12785 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2248
12787 "The name of the publisher of the application, for package managers that use "
12788 "this. If unavailable this is returned as an empty string C<\"\">."
12793 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2252
12799 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
12801 "The URL (eg. upstream URL) of the application. If unavailable this is "
12802 "returned as an empty string C<\"\">."
12807 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2257
12808 msgid "C<app_source_package>"
12813 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
12815 "For packaging systems which support this, the name of the source package. "
12816 "If unavailable this is returned as an empty string C<\"\">."
12821 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2262
12822 msgid "C<app_summary>"
12827 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
12829 "A short (usually one line) description of the application or package. If "
12830 "unavailable this is returned as an empty string C<\"\">."
12835 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2267
12836 msgid "C<app_description>"
12841 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2269
12843 "A longer description of the application or package. If unavailable this is "
12844 "returned as an empty string C<\"\">."
12849 #: ../src/guestfs-actions.pod:3233
12851 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12852 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12858 #: ../src/guestfs-actions.pod:3237
12859 msgid "(Added in 1.7.8)"
12864 #: ../src/guestfs-actions.pod:3239
12865 msgid "guestfs_inspect_os"
12870 #: ../src/guestfs-actions.pod:3241
12874 " guestfs_inspect_os (guestfs_h *g);\n"
12880 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2280
12882 "This function uses other libguestfs functions and certain heuristics to "
12883 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12884 "for operating systems."
12889 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2284
12890 msgid "The list returned is empty if no operating systems were found."
12895 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2286
12897 "If one operating system was found, then this returns a list with a single "
12898 "element, which is the name of the root filesystem of this operating system. "
12899 "It is also possible for this function to return a list containing more than "
12900 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12901 "element being the root filesystem of one of the operating systems."
12906 #: ../src/guestfs-actions.pod:3257
12908 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12909 "functions in order to query further information about each operating system, "
12910 "such as the name and version."
12915 #: ../src/guestfs-actions.pod:3262
12917 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12918 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12919 "the contents. This should be called with no disks currently mounted. The "
12920 "function may also use Augeas, so any existing Augeas handle will be closed."
12925 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2304
12927 "This function cannot decrypt encrypted disks. The caller must do that first "
12928 "(supplying the necessary keys) if the disk is encrypted."
12933 #: ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3564
12934 #: ../src/guestfs-actions.pod:3626
12935 msgid "See also C<guestfs_list_filesystems>."
12940 #: ../src/guestfs-actions.pod:3282
12941 msgid "guestfs_is_blockdev"
12946 #: ../src/guestfs-actions.pod:3284
12950 " guestfs_is_blockdev (guestfs_h *g,\n"
12951 " const char *path);\n"
12957 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2316
12959 "This returns C<true> if and only if there is a block device with the given "
12965 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
12966 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3365
12967 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3437
12968 #: ../src/guestfs-actions.pod:3452
12969 msgid "See also C<guestfs_stat>."
12974 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324
12975 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3441
12976 #: ../src/guestfs-actions.pod:3456
12977 msgid "(Added in 1.5.10)"
12982 #: ../src/guestfs-actions.pod:3297
12983 msgid "guestfs_is_busy"
12988 #: ../src/guestfs-actions.pod:3299
12992 " guestfs_is_busy (guestfs_h *g);\n"
12998 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2325
13000 "This returns true iff this handle is busy processing a command (in the "
13006 #: ../src/guestfs-actions.pod:3311
13007 msgid "guestfs_is_chardev"
13012 #: ../src/guestfs-actions.pod:3313
13016 " guestfs_is_chardev (guestfs_h *g,\n"
13017 " const char *path);\n"
13023 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2334
13025 "This returns C<true> if and only if there is a character device with the "
13026 "given C<path> name."
13031 #: ../src/guestfs-actions.pod:3326
13032 msgid "guestfs_is_config"
13037 #: ../src/guestfs-actions.pod:3328
13041 " guestfs_is_config (guestfs_h *g);\n"
13047 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2343
13049 "This returns true iff this handle is being configured (in the C<CONFIG> "
13055 #: ../src/guestfs-actions.pod:3340
13056 msgid "guestfs_is_dir"
13061 #: ../src/guestfs-actions.pod:3342
13065 " guestfs_is_dir (guestfs_h *g,\n"
13066 " const char *path);\n"
13072 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2352
13074 "This returns C<true> if and only if there is a directory with the given "
13075 "C<path> name. Note that it returns false for other objects like files."
13080 #: ../src/guestfs-actions.pod:3356
13081 msgid "guestfs_is_fifo"
13086 #: ../src/guestfs-actions.pod:3358
13090 " guestfs_is_fifo (guestfs_h *g,\n"
13091 " const char *path);\n"
13097 #: ../src/guestfs-actions.pod:3362 ../fish/guestfish-actions.pod:2362
13099 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13100 "given C<path> name."
13105 #: ../src/guestfs-actions.pod:3371
13106 msgid "guestfs_is_file"
13111 #: ../src/guestfs-actions.pod:3373
13115 " guestfs_is_file (guestfs_h *g,\n"
13116 " const char *path);\n"
13122 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2371
13124 "This returns C<true> if and only if there is a regular file with the given "
13125 "C<path> name. Note that it returns false for other objects like directories."
13130 #: ../src/guestfs-actions.pod:3387
13131 msgid "guestfs_is_launching"
13136 #: ../src/guestfs-actions.pod:3389
13140 " guestfs_is_launching (guestfs_h *g);\n"
13146 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2381
13148 "This returns true iff this handle is launching the subprocess (in the "
13149 "C<LAUNCHING> state)."
13154 #: ../src/guestfs-actions.pod:3401
13155 msgid "guestfs_is_lv"
13160 #: ../src/guestfs-actions.pod:3403
13164 " guestfs_is_lv (guestfs_h *g,\n"
13165 " const char *device);\n"
13171 #: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2390
13173 "This command tests whether C<device> is a logical volume, and returns true "
13174 "iff this is the case."
13179 #: ../src/guestfs-actions.pod:3414
13180 msgid "guestfs_is_ready"
13185 #: ../src/guestfs-actions.pod:3416
13189 " guestfs_is_ready (guestfs_h *g);\n"
13195 #: ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:2397
13197 "This returns true iff this handle is ready to accept commands (in the "
13203 #: ../src/guestfs-actions.pod:3428
13204 msgid "guestfs_is_socket"
13209 #: ../src/guestfs-actions.pod:3430
13213 " guestfs_is_socket (guestfs_h *g,\n"
13214 " const char *path);\n"
13220 #: ../src/guestfs-actions.pod:3434 ../fish/guestfish-actions.pod:2406
13222 "This returns C<true> if and only if there is a Unix domain socket with the "
13223 "given C<path> name."
13228 #: ../src/guestfs-actions.pod:3443
13229 msgid "guestfs_is_symlink"
13234 #: ../src/guestfs-actions.pod:3445
13238 " guestfs_is_symlink (guestfs_h *g,\n"
13239 " const char *path);\n"
13245 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2415
13247 "This returns C<true> if and only if there is a symbolic link with the given "
13253 #: ../src/guestfs-actions.pod:3458
13254 msgid "guestfs_kill_subprocess"
13259 #: ../src/guestfs-actions.pod:3460
13263 " guestfs_kill_subprocess (guestfs_h *g);\n"
13269 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2424
13270 msgid "This kills the qemu subprocess. You should never need to call this."
13275 #: ../src/guestfs-actions.pod:3469
13276 msgid "guestfs_launch"
13281 #: ../src/guestfs-actions.pod:3471
13285 " guestfs_launch (guestfs_h *g);\n"
13291 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2432
13293 "Internally libguestfs is implemented by running a virtual machine using "
13299 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2435
13301 "You should call this after configuring the handle (eg. adding drives) but "
13302 "before performing any actions."
13307 #: ../src/guestfs-actions.pod:3489
13308 msgid "guestfs_lchown"
13313 #: ../src/guestfs-actions.pod:3491
13317 " guestfs_lchown (guestfs_h *g,\n"
13320 " const char *path);\n"
13326 #: ../src/guestfs-actions.pod:3497
13328 "Change the file owner to C<owner> and group to C<group>. This is like "
13329 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13330 "changed, not the target."
13335 #: ../src/guestfs-actions.pod:3509
13336 msgid "guestfs_lgetxattr"
13341 #: ../src/guestfs-actions.pod:3511
13345 " guestfs_lgetxattr (guestfs_h *g,\n"
13346 " const char *path,\n"
13347 " const char *name,\n"
13348 " size_t *size_r);\n"
13354 #: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2454
13356 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13357 "is a symlink, then this call returns an extended attribute from the symlink."
13362 #: ../src/guestfs-actions.pod:3531
13363 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13368 #: ../src/guestfs-actions.pod:3539
13369 msgid "guestfs_lgetxattrs"
13374 #: ../src/guestfs-actions.pod:3541
13377 " struct guestfs_xattr_list *\n"
13378 " guestfs_lgetxattrs (guestfs_h *g,\n"
13379 " const char *path);\n"
13385 #: ../src/guestfs-actions.pod:3545
13387 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13388 "then it returns the extended attributes of the link itself."
13393 #: ../src/guestfs-actions.pod:3555
13394 msgid "guestfs_list_devices"
13399 #: ../src/guestfs-actions.pod:3557
13403 " guestfs_list_devices (guestfs_h *g);\n"
13409 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2482
13410 msgid "List all the block devices."
13415 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2484
13416 msgid "The full block device names are returned, eg. C</dev/sda>."
13421 #: ../src/guestfs-actions.pod:3572
13422 msgid "guestfs_list_filesystems"
13427 #: ../src/guestfs-actions.pod:3574
13431 " guestfs_list_filesystems (guestfs_h *g);\n"
13437 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2492
13439 "This inspection command looks for filesystems on partitions, block devices "
13440 "and logical volumes, returning a list of devices containing filesystems and "
13446 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2496
13448 "The return value is a hash, where the keys are the devices containing "
13449 "filesystems, and the values are the filesystem types. For example:"
13454 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2500
13457 " \"/dev/sda1\" => \"ntfs\"\n"
13458 " \"/dev/sda2\" => \"ext2\"\n"
13459 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13460 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13466 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2505
13468 "The value can have the special value \"unknown\", meaning the content of the "
13469 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13474 #: ../src/guestfs-actions.pod:3594
13476 "This command runs other libguestfs commands, which might include "
13477 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13478 "soon after launch and only when nothing is mounted."
13483 #: ../src/guestfs-actions.pod:3598
13485 "Not all of the filesystems returned will be mountable. In particular, swap "
13486 "partitions are returned in the list. Also this command does not check that "
13487 "each filesystem found is valid and mountable, and some filesystems might be "
13488 "mountable but require special options. Filesystems may not all belong to a "
13489 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13494 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:5224
13495 msgid "(Added in 1.5.15)"
13500 #: ../src/guestfs-actions.pod:3614
13501 msgid "guestfs_list_partitions"
13506 #: ../src/guestfs-actions.pod:3616
13510 " guestfs_list_partitions (guestfs_h *g);\n"
13516 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2525
13517 msgid "List all the partitions detected on all block devices."
13522 #: ../src/guestfs-actions.pod:3621 ../fish/guestfish-actions.pod:2527
13523 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13528 #: ../src/guestfs-actions.pod:3623
13530 "This does not return logical volumes. For that you will need to call "
13536 #: ../src/guestfs-actions.pod:3634
13542 #: ../src/guestfs-actions.pod:3636
13546 " guestfs_ll (guestfs_h *g,\n"
13547 " const char *directory);\n"
13553 #: ../src/guestfs-actions.pod:3640 ../fish/guestfish-actions.pod:2538
13555 "List the files in C<directory> (relative to the root directory, there is no "
13556 "cwd) in the format of 'ls -la'."
13561 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2541
13563 "This command is mostly useful for interactive sessions. It is I<not> "
13564 "intended that you try to parse the output string."
13569 #: ../src/guestfs-actions.pod:3651
13575 #: ../src/guestfs-actions.pod:3653
13579 " guestfs_ln (guestfs_h *g,\n"
13580 " const char *target,\n"
13581 " const char *linkname);\n"
13587 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2548
13588 msgid "This command creates a hard link using the C<ln> command."
13593 #: ../src/guestfs-actions.pod:3664
13594 msgid "guestfs_ln_f"
13599 #: ../src/guestfs-actions.pod:3666
13603 " guestfs_ln_f (guestfs_h *g,\n"
13604 " const char *target,\n"
13605 " const char *linkname);\n"
13610 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2554
13612 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13613 "option removes the link (C<linkname>) if it exists already."
13618 #: ../src/guestfs-actions.pod:3678
13619 msgid "guestfs_ln_s"
13624 #: ../src/guestfs-actions.pod:3680
13628 " guestfs_ln_s (guestfs_h *g,\n"
13629 " const char *target,\n"
13630 " const char *linkname);\n"
13636 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2561
13637 msgid "This command creates a symbolic link using the C<ln -s> command."
13642 #: ../src/guestfs-actions.pod:3691
13643 msgid "guestfs_ln_sf"
13648 #: ../src/guestfs-actions.pod:3693
13652 " guestfs_ln_sf (guestfs_h *g,\n"
13653 " const char *target,\n"
13654 " const char *linkname);\n"
13659 #: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2567
13661 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13662 "option removes the link (C<linkname>) if it exists already."
13667 #: ../src/guestfs-actions.pod:3705
13668 msgid "guestfs_lremovexattr"
13673 #: ../src/guestfs-actions.pod:3707
13677 " guestfs_lremovexattr (guestfs_h *g,\n"
13678 " const char *xattr,\n"
13679 " const char *path);\n"
13685 #: ../src/guestfs-actions.pod:3712
13687 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13688 "link, then it removes an extended attribute of the link itself."
13693 #: ../src/guestfs-actions.pod:3720
13699 #: ../src/guestfs-actions.pod:3722
13703 " guestfs_ls (guestfs_h *g,\n"
13704 " const char *directory);\n"
13710 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2582
13712 "List the files in C<directory> (relative to the root directory, there is no "
13713 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13718 #: ../src/guestfs-actions.pod:3730
13720 "This command is mostly useful for interactive sessions. Programs should "
13721 "probably use C<guestfs_readdir> instead."
13726 #: ../src/guestfs-actions.pod:3739
13727 msgid "guestfs_lsetxattr"
13732 #: ../src/guestfs-actions.pod:3741
13736 " guestfs_lsetxattr (guestfs_h *g,\n"
13737 " const char *xattr,\n"
13738 " const char *val,\n"
13740 " const char *path);\n"
13746 #: ../src/guestfs-actions.pod:3748
13748 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13749 "then it sets an extended attribute of the link itself."
13754 #: ../src/guestfs-actions.pod:3756
13755 msgid "guestfs_lstat"
13760 #: ../src/guestfs-actions.pod:3758
13763 " struct guestfs_stat *\n"
13764 " guestfs_lstat (guestfs_h *g,\n"
13765 " const char *path);\n"
13771 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:6355
13772 #: ../fish/guestfish-actions.pod:2601 ../fish/guestfish-actions.pod:4305
13773 msgid "Returns file information for the given C<path>."
13778 #: ../src/guestfs-actions.pod:3764
13780 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13781 "link, then the link is stat-ed, not the file it refers to."
13786 #: ../src/guestfs-actions.pod:3768 ../fish/guestfish-actions.pod:2607
13787 msgid "This is the same as the C<lstat(2)> system call."
13792 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6359
13794 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13795 "error. I<The caller must call C<guestfs_free_stat> after use>."
13800 #: ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:6363
13801 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6762
13802 msgid "(Added in 0.9.2)"
13807 #: ../src/guestfs-actions.pod:3776
13808 msgid "guestfs_lstatlist"
13813 #: ../src/guestfs-actions.pod:3778
13816 " struct guestfs_stat_list *\n"
13817 " guestfs_lstatlist (guestfs_h *g,\n"
13818 " const char *path,\n"
13819 " char *const *names);\n"
13825 #: ../src/guestfs-actions.pod:3783
13827 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13828 "files, where all files are in the directory C<path>. C<names> is the list "
13829 "of files from this directory."
13834 #: ../src/guestfs-actions.pod:3787 ../fish/guestfish-actions.pod:2617
13836 "On return you get a list of stat structs, with a one-to-one correspondence "
13837 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13838 "then the C<ino> field of that structure is set to C<-1>."
13843 #: ../src/guestfs-actions.pod:3792
13845 "This call is intended for programs that want to efficiently list a directory "
13846 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13847 "for a similarly efficient call for getting extended attributes. Very long "
13848 "directory listings might cause the protocol message size to be exceeded, "
13849 "causing this call to fail. The caller must split up such requests into "
13850 "smaller groups of names."
13855 #: ../src/guestfs-actions.pod:3800
13857 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13858 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13863 #: ../src/guestfs-actions.pod:3806
13864 msgid "guestfs_luks_add_key"
13869 #: ../src/guestfs-actions.pod:3808
13873 " guestfs_luks_add_key (guestfs_h *g,\n"
13874 " const char *device,\n"
13875 " const char *key,\n"
13876 " const char *newkey,\n"
13883 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2634
13885 "This command adds a new key on LUKS device C<device>. C<key> is any "
13886 "existing key, and is used to access the device. C<newkey> is the new key to "
13887 "add. C<keyslot> is the key slot that will be replaced."
13892 #: ../src/guestfs-actions.pod:3820
13894 "Note that if C<keyslot> already contains a key, then this command will "
13895 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13900 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
13901 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
13902 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960
13904 "This function takes a key or passphrase parameter which could contain "
13905 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13911 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3870
13912 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3913
13913 msgid "(Added in 1.5.2)"
13918 #: ../src/guestfs-actions.pod:3832
13919 msgid "guestfs_luks_close"
13924 #: ../src/guestfs-actions.pod:3834
13928 " guestfs_luks_close (guestfs_h *g,\n"
13929 " const char *device);\n"
13935 #: ../src/guestfs-actions.pod:3838
13937 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13938 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13939 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13940 "underlying block device."
13945 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3945
13946 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4014
13947 #: ../src/guestfs-actions.pod:4062
13948 msgid "(Added in 1.5.1)"
13953 #: ../src/guestfs-actions.pod:3848
13954 msgid "guestfs_luks_format"
13959 #: ../src/guestfs-actions.pod:3850
13963 " guestfs_luks_format (guestfs_h *g,\n"
13964 " const char *device,\n"
13965 " const char *key,\n"
13972 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2660
13974 "This command erases existing data on C<device> and formats the device as a "
13975 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13976 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13981 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3886
13982 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4975
13983 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6162
13984 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6225
13985 #: ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:2668
13986 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2765
13987 #: ../fish/guestfish-actions.pod:3346 ../fish/guestfish-actions.pod:3866
13988 #: ../fish/guestfish-actions.pod:4176 ../fish/guestfish-actions.pod:4199
13989 #: ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4950
13991 "B<This command is dangerous. Without careful use you can easily destroy all "
13997 #: ../src/guestfs-actions.pod:3872
13998 msgid "guestfs_luks_format_cipher"
14003 #: ../src/guestfs-actions.pod:3874
14007 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14008 " const char *device,\n"
14009 " const char *key,\n"
14011 " const char *cipher);\n"
14017 #: ../src/guestfs-actions.pod:3881
14019 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14020 "set the C<cipher> used."
14025 #: ../src/guestfs-actions.pod:3895
14026 msgid "guestfs_luks_kill_slot"
14031 #: ../src/guestfs-actions.pod:3897
14035 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14036 " const char *device,\n"
14037 " const char *key,\n"
14044 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2688
14046 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14047 "device C<device>. C<key> must be one of the I<other> keys."
14052 #: ../src/guestfs-actions.pod:3915
14053 msgid "guestfs_luks_open"
14058 #: ../src/guestfs-actions.pod:3917
14062 " guestfs_luks_open (guestfs_h *g,\n"
14063 " const char *device,\n"
14064 " const char *key,\n"
14065 " const char *mapname);\n"
14071 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2699
14073 "This command opens a block device which has been encrypted according to the "
14074 "Linux Unified Key Setup (LUKS) standard."
14079 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2702
14080 msgid "C<device> is the encrypted block device or partition."
14085 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2704
14087 "The caller must supply one of the keys associated with the LUKS block "
14088 "device, in the C<key> parameter."
14093 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2707
14095 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14096 "writes to this block device are decrypted from and encrypted to the "
14097 "underlying C<device> respectively."
14102 #: ../src/guestfs-actions.pod:3935
14104 "If this block device contains LVM volume groups, then calling "
14105 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14111 #: ../src/guestfs-actions.pod:3947
14112 msgid "guestfs_luks_open_ro"
14117 #: ../src/guestfs-actions.pod:3949
14121 " guestfs_luks_open_ro (guestfs_h *g,\n"
14122 " const char *device,\n"
14123 " const char *key,\n"
14124 " const char *mapname);\n"
14130 #: ../src/guestfs-actions.pod:3955
14132 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14138 #: ../src/guestfs-actions.pod:3966
14139 msgid "guestfs_lvcreate"
14144 #: ../src/guestfs-actions.pod:3968
14148 " guestfs_lvcreate (guestfs_h *g,\n"
14149 " const char *logvol,\n"
14150 " const char *volgroup,\n"
14157 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2732
14159 "This creates an LVM logical volume called C<logvol> on the volume group "
14160 "C<volgroup>, with C<size> megabytes."
14165 #: ../src/guestfs-actions.pod:3981
14166 msgid "guestfs_lvm_canonical_lv_name"
14171 #: ../src/guestfs-actions.pod:3983
14175 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14176 " const char *lvname);\n"
14182 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2739
14184 "This converts alternative naming schemes for LVs that you might find to the "
14185 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14191 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:2743
14193 "This command returns an error if the C<lvname> parameter does not refer to a "
14199 #: ../src/guestfs-actions.pod:3994
14200 msgid "See also C<guestfs_is_lv>."
14205 #: ../src/guestfs-actions.pod:3999
14206 msgid "(Added in 1.5.24)"
14211 #: ../src/guestfs-actions.pod:4001
14212 msgid "guestfs_lvm_clear_filter"
14217 #: ../src/guestfs-actions.pod:4003
14221 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14227 #: ../src/guestfs-actions.pod:4006
14229 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14230 "see every block device."
14235 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4051
14236 #: ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2786
14238 "This command also clears the LVM cache and performs a volume group scan."
14243 #: ../src/guestfs-actions.pod:4016
14244 msgid "guestfs_lvm_remove_all"
14249 #: ../src/guestfs-actions.pod:4018
14253 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14259 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2762
14261 "This command removes all LVM logical volumes, volume groups and physical "
14267 #: ../src/guestfs-actions.pod:4031
14268 msgid "guestfs_lvm_set_filter"
14273 #: ../src/guestfs-actions.pod:4033
14277 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14278 " char *const *devices);\n"
14284 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2772
14286 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14287 "block devices in the list C<devices>, and will ignore all other attached "
14293 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2776
14295 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14296 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14297 "there are two types of duplication possible: either cloned PVs/VGs which "
14298 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14299 "same name. In normal operation you cannot create this situation, but you "
14300 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14301 "inside the LVM metadata."
14306 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2789
14307 msgid "You can filter whole block devices or individual partitions."
14312 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2791
14314 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14315 "filesystem), even if you are not filtering out that VG."
14320 #: ../src/guestfs-actions.pod:4064
14321 msgid "guestfs_lvremove"
14326 #: ../src/guestfs-actions.pod:4066
14330 " guestfs_lvremove (guestfs_h *g,\n"
14331 " const char *device);\n"
14337 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2799
14339 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14340 "LV, such as C</dev/VG/LV>."
14345 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2802
14347 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14353 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:5321
14354 #: ../src/guestfs-actions.pod:7138
14355 msgid "(Added in 1.0.13)"
14360 #: ../src/guestfs-actions.pod:4080
14361 msgid "guestfs_lvrename"
14366 #: ../src/guestfs-actions.pod:4082
14370 " guestfs_lvrename (guestfs_h *g,\n"
14371 " const char *logvol,\n"
14372 " const char *newlogvol);\n"
14378 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2809
14379 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14384 #: ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:7151
14385 msgid "(Added in 1.0.83)"
14390 #: ../src/guestfs-actions.pod:4093
14391 msgid "guestfs_lvresize"
14396 #: ../src/guestfs-actions.pod:4095
14400 " guestfs_lvresize (guestfs_h *g,\n"
14401 " const char *device,\n"
14408 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2815
14410 "This resizes (expands or shrinks) an existing LVM logical volume to "
14411 "C<mbytes>. When reducing, data in the reduced part is lost."
14416 #: ../src/guestfs-actions.pod:4108
14417 msgid "guestfs_lvresize_free"
14422 #: ../src/guestfs-actions.pod:4110
14426 " guestfs_lvresize_free (guestfs_h *g,\n"
14427 " const char *lv,\n"
14434 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2823
14436 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14437 "remaining free space in the volume group. Commonly you would call this with "
14438 "pc = 100 which expands the logical volume as much as possible, using all "
14439 "remaining free space in the volume group."
14444 #: ../src/guestfs-actions.pod:4123
14445 msgid "(Added in 1.3.3)"
14450 #: ../src/guestfs-actions.pod:4125
14451 msgid "guestfs_lvs"
14456 #: ../src/guestfs-actions.pod:4127
14460 " guestfs_lvs (guestfs_h *g);\n"
14466 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2833
14468 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14474 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2836
14476 "This returns a list of the logical volume device names (eg. C</dev/"
14477 "VolGroup00/LogVol00>)."
14482 #: ../src/guestfs-actions.pod:4136
14483 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14488 #: ../src/guestfs-actions.pod:4144
14489 msgid "guestfs_lvs_full"
14494 #: ../src/guestfs-actions.pod:4146
14497 " struct guestfs_lvm_lv_list *\n"
14498 " guestfs_lvs_full (guestfs_h *g);\n"
14504 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2845
14506 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14507 "(8)> command. The \"full\" version includes all fields."
14512 #: ../src/guestfs-actions.pod:4152
14514 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14515 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14520 #: ../src/guestfs-actions.pod:4158
14521 msgid "guestfs_lvuuid"
14526 #: ../src/guestfs-actions.pod:4160
14530 " guestfs_lvuuid (guestfs_h *g,\n"
14531 " const char *device);\n"
14537 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2852
14538 msgid "This command returns the UUID of the LVM LV C<device>."
14543 #: ../src/guestfs-actions.pod:4171
14544 msgid "guestfs_lxattrlist"
14549 #: ../src/guestfs-actions.pod:4173
14552 " struct guestfs_xattr_list *\n"
14553 " guestfs_lxattrlist (guestfs_h *g,\n"
14554 " const char *path,\n"
14555 " char *const *names);\n"
14561 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2858
14563 "This call allows you to get the extended attributes of multiple files, where "
14564 "all files are in the directory C<path>. C<names> is the list of files from "
14570 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2862
14572 "On return you get a flat list of xattr structs which must be interpreted "
14573 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14574 "C<attrval> in this struct is zero-length to indicate there was an error "
14575 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14576 "number (the number of following attributes for this file, which could be C<"
14577 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14578 "for the first named file. This repeats for the second and subsequent files."
14583 #: ../src/guestfs-actions.pod:4192
14585 "This call is intended for programs that want to efficiently list a directory "
14586 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14587 "a similarly efficient call for getting standard stats. Very long directory "
14588 "listings might cause the protocol message size to be exceeded, causing this "
14589 "call to fail. The caller must split up such requests into smaller groups of "
14595 #: ../src/guestfs-actions.pod:4206
14596 msgid "guestfs_mkdir"
14601 #: ../src/guestfs-actions.pod:4208
14605 " guestfs_mkdir (guestfs_h *g,\n"
14606 " const char *path);\n"
14612 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2884
14613 msgid "Create a directory named C<path>."
14618 #: ../src/guestfs-actions.pod:4218
14619 msgid "guestfs_mkdir_mode"
14624 #: ../src/guestfs-actions.pod:4220
14628 " guestfs_mkdir_mode (guestfs_h *g,\n"
14629 " const char *path,\n"
14636 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2890
14638 "This command creates a directory, setting the initial permissions of the "
14639 "directory to C<mode>."
14644 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2893
14646 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14647 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14653 #: ../src/guestfs-actions.pod:4232
14654 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14659 #: ../src/guestfs-actions.pod:4238
14660 msgid "guestfs_mkdir_p"
14665 #: ../src/guestfs-actions.pod:4240
14669 " guestfs_mkdir_p (guestfs_h *g,\n"
14670 " const char *path);\n"
14676 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2903
14678 "Create a directory named C<path>, creating any parent directories as "
14679 "necessary. This is like the C<mkdir -p> shell command."
14684 #: ../src/guestfs-actions.pod:4251
14685 msgid "guestfs_mkdtemp"
14690 #: ../src/guestfs-actions.pod:4253
14694 " guestfs_mkdtemp (guestfs_h *g,\n"
14695 " const char *template);\n"
14701 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2910
14703 "This command creates a temporary directory. The C<template> parameter "
14704 "should be a full pathname for the temporary directory name with the final "
14705 "six characters being \"XXXXXX\"."
14710 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2915
14712 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14713 "being suitable for Windows filesystems."
14718 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2918
14719 msgid "The name of the temporary directory that was created is returned."
14724 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2921
14725 msgid "The temporary directory is created with mode 0700 and is owned by root."
14730 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2924
14732 "The caller is responsible for deleting the temporary directory and its "
14733 "contents after use."
14738 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2927
14739 msgid "See also: L<mkdtemp(3)>"
14744 #: ../src/guestfs-actions.pod:4281
14745 msgid "guestfs_mke2fs_J"
14750 #: ../src/guestfs-actions.pod:4283
14754 " guestfs_mke2fs_J (guestfs_h *g,\n"
14755 " const char *fstype,\n"
14756 " int blocksize,\n"
14757 " const char *device,\n"
14758 " const char *journal);\n"
14764 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2933
14766 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14767 "C<journal>. It is equivalent to the command:"
14772 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2937
14775 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14781 #: ../src/guestfs-actions.pod:4296
14782 msgid "See also C<guestfs_mke2journal>."
14787 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4318
14788 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4352
14789 #: ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380
14790 #: ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4704
14791 msgid "(Added in 1.0.68)"
14796 #: ../src/guestfs-actions.pod:4302
14797 msgid "guestfs_mke2fs_JL"
14802 #: ../src/guestfs-actions.pod:4304
14806 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14807 " const char *fstype,\n"
14808 " int blocksize,\n"
14809 " const char *device,\n"
14810 " const char *label);\n"
14816 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2945
14818 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14819 "the journal labeled C<label>."
14824 #: ../src/guestfs-actions.pod:4314
14825 msgid "See also C<guestfs_mke2journal_L>."
14830 #: ../src/guestfs-actions.pod:4320
14831 msgid "guestfs_mke2fs_JU"
14836 #: ../src/guestfs-actions.pod:4322
14840 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14841 " const char *fstype,\n"
14842 " int blocksize,\n"
14843 " const char *device,\n"
14844 " const char *uuid);\n"
14850 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2954
14852 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14853 "the journal with UUID C<uuid>."
14858 #: ../src/guestfs-actions.pod:4332
14859 msgid "See also C<guestfs_mke2journal_U>."
14864 #: ../src/guestfs-actions.pod:4338
14865 msgid "guestfs_mke2journal"
14870 #: ../src/guestfs-actions.pod:4340
14874 " guestfs_mke2journal (guestfs_h *g,\n"
14875 " int blocksize,\n"
14876 " const char *device);\n"
14882 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2963
14884 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14890 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2966
14893 " mke2fs -O journal_dev -b blocksize device\n"
14899 #: ../src/guestfs-actions.pod:4354
14900 msgid "guestfs_mke2journal_L"
14905 #: ../src/guestfs-actions.pod:4356
14909 " guestfs_mke2journal_L (guestfs_h *g,\n"
14910 " int blocksize,\n"
14911 " const char *label,\n"
14912 " const char *device);\n"
14918 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2972
14919 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14924 #: ../src/guestfs-actions.pod:4368
14925 msgid "guestfs_mke2journal_U"
14930 #: ../src/guestfs-actions.pod:4370
14934 " guestfs_mke2journal_U (guestfs_h *g,\n"
14935 " int blocksize,\n"
14936 " const char *uuid,\n"
14937 " const char *device);\n"
14943 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2978
14944 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14949 #: ../src/guestfs-actions.pod:4382
14950 msgid "guestfs_mkfifo"
14955 #: ../src/guestfs-actions.pod:4384
14959 " guestfs_mkfifo (guestfs_h *g,\n"
14961 " const char *path);\n"
14967 #: ../src/guestfs-actions.pod:4389
14969 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14970 "is just a convenient wrapper around C<guestfs_mknod>."
14975 #: ../src/guestfs-actions.pod:4399
14976 msgid "guestfs_mkfs"
14981 #: ../src/guestfs-actions.pod:4401
14985 " guestfs_mkfs (guestfs_h *g,\n"
14986 " const char *fstype,\n"
14987 " const char *device);\n"
14993 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2994
14995 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14996 "volume). The filesystem type is C<fstype>, for example C<ext3>."
15001 #: ../src/guestfs-actions.pod:4414
15002 msgid "guestfs_mkfs_b"
15007 #: ../src/guestfs-actions.pod:4416
15011 " guestfs_mkfs_b (guestfs_h *g,\n"
15012 " const char *fstype,\n"
15013 " int blocksize,\n"
15014 " const char *device);\n"
15020 #: ../src/guestfs-actions.pod:4422
15022 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15023 "block size of the resulting filesystem. Supported block sizes depend on the "
15024 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15029 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4470
15030 #: ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3034
15032 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15038 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:3010
15040 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15045 #: ../src/guestfs-actions.pod:4441
15046 msgid "guestfs_mkfs_opts"
15051 #: ../src/guestfs-actions.pod:4443
15055 " guestfs_mkfs_opts (guestfs_h *g,\n"
15056 " const char *fstype,\n"
15057 " const char *device,\n"
15063 #: ../src/guestfs-actions.pod:4454
15066 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15067 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15073 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3021
15075 "This function creates a filesystem on C<device>. The filesystem type is "
15076 "C<fstype>, for example C<ext3>."
15081 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3028
15082 msgid "C<blocksize>"
15087 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3030
15089 "The filesystem block size. Supported block sizes depend on the filesystem "
15090 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15095 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3037
15096 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15100 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3039
15101 msgid "C<features>"
15105 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3041
15106 msgid "This passes the I<-O> parameter to the external mkfs program."
15110 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3043
15112 "For certain filesystem types, this allows extra filesystem features to be "
15113 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15117 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3047
15119 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15124 #: ../src/guestfs-actions.pod:4490
15125 msgid "(Added in 1.7.19)"
15130 #: ../src/guestfs-actions.pod:4492
15131 msgid "guestfs_mkfs_opts_va"
15136 #: ../src/guestfs-actions.pod:4494
15140 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15141 " const char *fstype,\n"
15142 " const char *device,\n"
15143 " va_list args);\n"
15149 #: ../src/guestfs-actions.pod:4500
15150 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15155 #: ../src/guestfs-actions.pod:4504
15156 msgid "guestfs_mkfs_opts_argv"
15161 #: ../src/guestfs-actions.pod:4506
15165 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15166 " const char *fstype,\n"
15167 " const char *device,\n"
15168 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15174 #: ../src/guestfs-actions.pod:4512
15175 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15180 #: ../src/guestfs-actions.pod:4516
15181 msgid "guestfs_mkmountpoint"
15186 #: ../src/guestfs-actions.pod:4518
15190 " guestfs_mkmountpoint (guestfs_h *g,\n"
15191 " const char *exemptpath);\n"
15197 #: ../src/guestfs-actions.pod:4522
15199 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15200 "that can be used to create extra mountpoints before mounting the first "
15206 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3062
15208 "These calls are I<only> necessary in some very limited circumstances, mainly "
15209 "the case where you want to mount a mix of unrelated and/or read-only "
15210 "filesystems together."
15215 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3066
15217 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15218 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15219 "inside that. You can unpack this as follows in guestfish:"
15224 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3071
15227 " add-ro Fedora-11-i686-Live.iso\n"
15229 " mkmountpoint /cd\n"
15230 " mkmountpoint /sqsh\n"
15231 " mkmountpoint /ext3fs\n"
15232 " mount /dev/sda /cd\n"
15233 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15234 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15240 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3080
15241 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15246 #: ../src/guestfs-actions.pod:4546
15248 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15249 "may get unexpected errors if you try to mix these calls. It is safest to "
15250 "manually unmount filesystems and remove mountpoints after use."
15255 #: ../src/guestfs-actions.pod:4550
15257 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15258 "first, so for this to work for manual mountpoints, you must ensure that the "
15259 "innermost mountpoints have the longest pathnames, as in the example code "
15265 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3091
15267 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15271 #: ../src/guestfs-actions.pod:4557
15273 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15274 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15275 "can also trigger these issues."
15280 #: ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4829
15281 #: ../src/guestfs-actions.pod:5739
15282 msgid "(Added in 1.0.62)"
15287 #: ../src/guestfs-actions.pod:4565
15288 msgid "guestfs_mknod"
15293 #: ../src/guestfs-actions.pod:4567
15297 " guestfs_mknod (guestfs_h *g,\n"
15301 " const char *path);\n"
15307 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3101
15309 "This call creates block or character special devices, or named pipes (FIFOs)."
15314 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3104
15316 "The C<mode> parameter should be the mode, using the standard constants. "
15317 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15318 "used when creating block and character special devices."
15323 #: ../src/guestfs-actions.pod:4582
15325 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15326 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15327 "regular file). These constants are available in the standard Linux header "
15328 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15329 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15330 "the appropriate constant for you."
15335 #: ../src/guestfs-actions.pod:4596
15336 msgid "guestfs_mknod_b"
15341 #: ../src/guestfs-actions.pod:4598
15345 " guestfs_mknod_b (guestfs_h *g,\n"
15349 " const char *path);\n"
15355 #: ../src/guestfs-actions.pod:4605
15357 "This call creates a block device node called C<path> with mode C<mode> and "
15358 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15359 "wrapper around C<guestfs_mknod>."
15364 #: ../src/guestfs-actions.pod:4615
15365 msgid "guestfs_mknod_c"
15370 #: ../src/guestfs-actions.pod:4617
15374 " guestfs_mknod_c (guestfs_h *g,\n"
15378 " const char *path);\n"
15384 #: ../src/guestfs-actions.pod:4624
15386 "This call creates a char device node called C<path> with mode C<mode> and "
15387 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15388 "wrapper around C<guestfs_mknod>."
15393 #: ../src/guestfs-actions.pod:4634
15394 msgid "guestfs_mkswap"
15399 #: ../src/guestfs-actions.pod:4636
15403 " guestfs_mkswap (guestfs_h *g,\n"
15404 " const char *device);\n"
15410 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3143
15411 msgid "Create a swap partition on C<device>."
15416 #: ../src/guestfs-actions.pod:4646
15417 msgid "guestfs_mkswap_L"
15422 #: ../src/guestfs-actions.pod:4648
15426 " guestfs_mkswap_L (guestfs_h *g,\n"
15427 " const char *label,\n"
15428 " const char *device);\n"
15434 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3149
15435 msgid "Create a swap partition on C<device> with label C<label>."
15440 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3151
15442 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15443 "sda>), just to a partition. This appears to be a limitation of the kernel "
15449 #: ../src/guestfs-actions.pod:4663
15450 msgid "guestfs_mkswap_U"
15455 #: ../src/guestfs-actions.pod:4665
15459 " guestfs_mkswap_U (guestfs_h *g,\n"
15460 " const char *uuid,\n"
15461 " const char *device);\n"
15467 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3159
15468 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15473 #: ../src/guestfs-actions.pod:4676
15474 msgid "guestfs_mkswap_file"
15479 #: ../src/guestfs-actions.pod:4678
15483 " guestfs_mkswap_file (guestfs_h *g,\n"
15484 " const char *path);\n"
15490 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3165
15491 msgid "Create a swap file."
15496 #: ../src/guestfs-actions.pod:4684
15498 "This command just writes a swap file signature to an existing file. To "
15499 "create the file itself, use something like C<guestfs_fallocate>."
15504 #: ../src/guestfs-actions.pod:4691
15505 msgid "guestfs_modprobe"
15510 #: ../src/guestfs-actions.pod:4693
15514 " guestfs_modprobe (guestfs_h *g,\n"
15515 " const char *modulename);\n"
15521 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3174
15522 msgid "This loads a kernel module in the appliance."
15527 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3176
15529 "The kernel module must have been whitelisted when libguestfs was built (see "
15530 "C<appliance/kmod.whitelist.in> in the source)."
15535 #: ../src/guestfs-actions.pod:4706
15536 msgid "guestfs_mount"
15541 #: ../src/guestfs-actions.pod:4708
15545 " guestfs_mount (guestfs_h *g,\n"
15546 " const char *device,\n"
15547 " const char *mountpoint);\n"
15553 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3183
15555 "Mount a guest disk at a position in the filesystem. Block devices are named "
15556 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15557 "those block devices contain partitions, they will have the usual names (eg. "
15558 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15563 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3189
15565 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15566 "mounted on C</> before others can be mounted. Other filesystems can only be "
15567 "mounted on directories which already exist."
15572 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3194
15574 "The mounted filesystem is writable, if we have sufficient permissions on the "
15575 "underlying device."
15580 #: ../src/guestfs-actions.pod:4727
15582 "B<Important note:> When you use this call, the filesystem options C<sync> "
15583 "and C<noatime> are set implicitly. This was originally done because we "
15584 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15585 "very large negative performance impact and negligible effect on "
15586 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15587 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15588 "(use an empty string for the first parameter if you don't want any options)."
15592 #: ../src/guestfs-actions.pod:4739 ../fish/guestfish-actions.pod:3207
15594 "This function is deprecated. In new code, use the C<mount_options> call "
15600 #: ../src/guestfs-actions.pod:4748
15601 msgid "guestfs_mount_loop"
15606 #: ../src/guestfs-actions.pod:4750
15610 " guestfs_mount_loop (guestfs_h *g,\n"
15611 " const char *file,\n"
15612 " const char *mountpoint);\n"
15618 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3218
15620 "This command lets you mount C<file> (a filesystem image in a file) on a "
15621 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15627 #: ../src/guestfs-actions.pod:4763
15628 msgid "guestfs_mount_options"
15633 #: ../src/guestfs-actions.pod:4765
15637 " guestfs_mount_options (guestfs_h *g,\n"
15638 " const char *options,\n"
15639 " const char *device,\n"
15640 " const char *mountpoint);\n"
15646 #: ../src/guestfs-actions.pod:4771
15648 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15649 "the mount options as for the L<mount(8)> I<-o> flag."
15654 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3230
15656 "If the C<options> parameter is an empty string, then no options are passed "
15657 "(all options default to whatever the filesystem uses)."
15662 #: ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:4795
15663 #: ../src/guestfs-actions.pod:4812
15664 msgid "(Added in 1.0.10)"
15669 #: ../src/guestfs-actions.pod:4783
15670 msgid "guestfs_mount_ro"
15675 #: ../src/guestfs-actions.pod:4785
15679 " guestfs_mount_ro (guestfs_h *g,\n"
15680 " const char *device,\n"
15681 " const char *mountpoint);\n"
15687 #: ../src/guestfs-actions.pod:4790
15689 "This is the same as the C<guestfs_mount> command, but it mounts the "
15690 "filesystem with the read-only (I<-o ro>) flag."
15695 #: ../src/guestfs-actions.pod:4797
15696 msgid "guestfs_mount_vfs"
15701 #: ../src/guestfs-actions.pod:4799
15705 " guestfs_mount_vfs (guestfs_h *g,\n"
15706 " const char *options,\n"
15707 " const char *vfstype,\n"
15708 " const char *device,\n"
15709 " const char *mountpoint);\n"
15715 #: ../src/guestfs-actions.pod:4806
15717 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15718 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15724 #: ../src/guestfs-actions.pod:4814
15725 msgid "guestfs_mountpoints"
15730 #: ../src/guestfs-actions.pod:4816
15734 " guestfs_mountpoints (guestfs_h *g);\n"
15740 #: ../src/guestfs-actions.pod:4819
15742 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15743 "devices. This one returns a hash table (map) of device name to directory "
15744 "where the device is mounted."
15749 #: ../src/guestfs-actions.pod:4831
15750 msgid "guestfs_mounts"
15755 #: ../src/guestfs-actions.pod:4833
15759 " guestfs_mounts (guestfs_h *g);\n"
15765 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3261
15767 "This returns the list of currently mounted filesystems. It returns the list "
15768 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15773 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3264
15774 msgid "Some internal mounts are not shown."
15779 #: ../src/guestfs-actions.pod:4841
15780 msgid "See also: C<guestfs_mountpoints>"
15785 #: ../src/guestfs-actions.pod:4849
15791 #: ../src/guestfs-actions.pod:4851
15795 " guestfs_mv (guestfs_h *g,\n"
15796 " const char *src,\n"
15797 " const char *dest);\n"
15803 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3272
15805 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15806 "destination filename or destination directory."
15811 #: ../src/guestfs-actions.pod:4863
15812 msgid "guestfs_ntfs_3g_probe"
15817 #: ../src/guestfs-actions.pod:4865
15821 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15823 " const char *device);\n"
15829 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3279
15831 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15832 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15833 "write, and some cannot be mounted at all)."
15838 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3283
15840 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15841 "can be mounted read-write. Set it to false if you want to test if the "
15842 "volume can be mounted read-only."
15847 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3287
15849 "The return value is an integer which C<0> if the operation would succeed, or "
15850 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15855 #: ../src/guestfs-actions.pod:4884
15856 msgid "(Added in 1.0.43)"
15861 #: ../src/guestfs-actions.pod:4886
15862 msgid "guestfs_ntfsresize"
15867 #: ../src/guestfs-actions.pod:4888
15871 " guestfs_ntfsresize (guestfs_h *g,\n"
15872 " const char *device);\n"
15878 #: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3295
15880 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15881 "size of the underlying device. See also L<ntfsresize(8)>."
15886 #: ../src/guestfs-actions.pod:4900
15887 msgid "guestfs_ntfsresize_size"
15892 #: ../src/guestfs-actions.pod:4902
15896 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15897 " const char *device,\n"
15898 " int64_t size);\n"
15904 #: ../src/guestfs-actions.pod:4907
15906 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15907 "to specify the new size (in bytes) explicitly."
15912 #: ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:5348
15913 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5687
15914 #: ../src/guestfs-actions.pod:7293
15915 msgid "(Added in 1.3.14)"
15920 #: ../src/guestfs-actions.pod:4914
15921 msgid "guestfs_part_add"
15926 #: ../src/guestfs-actions.pod:4916
15930 " guestfs_part_add (guestfs_h *g,\n"
15931 " const char *device,\n"
15932 " const char *prlogex,\n"
15933 " int64_t startsect,\n"
15934 " int64_t endsect);\n"
15940 #: ../src/guestfs-actions.pod:4923
15942 "This command adds a partition to C<device>. If there is no partition table "
15943 "on the device, call C<guestfs_part_init> first."
15948 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3313
15950 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15951 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15952 "C<logical>) and C<e> (or C<extended>) partition types."
15957 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3318
15959 "C<startsect> and C<endsect> are the start and end of the partition in "
15960 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15961 "from the end of the disk (C<-1> is the last sector)."
15966 #: ../src/guestfs-actions.pod:4935
15968 "Creating a partition which covers the whole disk is not so easy. Use "
15969 "C<guestfs_part_disk> to do that."
15974 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4978
15975 #: ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5109
15976 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5166
15977 #: ../src/guestfs-actions.pod:5206
15978 msgid "(Added in 1.0.78)"
15983 #: ../src/guestfs-actions.pod:4942
15984 msgid "guestfs_part_del"
15989 #: ../src/guestfs-actions.pod:4944
15993 " guestfs_part_del (guestfs_h *g,\n"
15994 " const char *device,\n"
16001 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3329
16002 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16007 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3331
16009 "Note that in the case of MBR partitioning, deleting an extended partition "
16010 "also deletes any logical partitions it contains."
16015 #: ../src/guestfs-actions.pod:4959
16016 msgid "guestfs_part_disk"
16021 #: ../src/guestfs-actions.pod:4961
16025 " guestfs_part_disk (guestfs_h *g,\n"
16026 " const char *device,\n"
16027 " const char *parttype);\n"
16033 #: ../src/guestfs-actions.pod:4966
16035 "This command is simply a combination of C<guestfs_part_init> followed by "
16036 "C<guestfs_part_add> to create a single primary partition covering the whole "
16042 #: ../src/guestfs-actions.pod:4970
16044 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16045 "possible values are described in C<guestfs_part_init>."
16050 #: ../src/guestfs-actions.pod:4980
16051 msgid "guestfs_part_get_bootable"
16056 #: ../src/guestfs-actions.pod:4982
16060 " guestfs_part_get_bootable (guestfs_h *g,\n"
16061 " const char *device,\n"
16068 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3353
16070 "This command returns true if the partition C<partnum> on C<device> has the "
16071 "bootable flag set."
16076 #: ../src/guestfs-actions.pod:4990
16077 msgid "See also C<guestfs_part_set_bootable>."
16082 #: ../src/guestfs-actions.pod:4996
16083 msgid "guestfs_part_get_mbr_id"
16088 #: ../src/guestfs-actions.pod:4998
16092 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16093 " const char *device,\n"
16100 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3362
16102 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16103 "partition C<partnum>."
16108 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5182
16110 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16111 "undefined results for other partition table types (see "
16112 "C<guestfs_part_get_parttype>)."
16117 #: ../src/guestfs-actions.pod:5014
16118 msgid "guestfs_part_get_parttype"
16123 #: ../src/guestfs-actions.pod:5016
16127 " guestfs_part_get_parttype (guestfs_h *g,\n"
16128 " const char *device);\n"
16134 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3373
16136 "This command examines the partition table on C<device> and returns the "
16137 "partition table type (format) being used."
16142 #: ../src/guestfs-actions.pod:5023
16144 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16145 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16146 "possible, although unusual. See C<guestfs_part_init> for a full list."
16151 #: ../src/guestfs-actions.pod:5033
16152 msgid "guestfs_part_init"
16157 #: ../src/guestfs-actions.pod:5035
16161 " guestfs_part_init (guestfs_h *g,\n"
16162 " const char *device,\n"
16163 " const char *parttype);\n"
16169 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
16171 "This creates an empty partition table on C<device> of one of the partition "
16172 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16173 "(for large disks)."
16178 #: ../src/guestfs-actions.pod:5044
16180 "Initially there are no partitions. Following this, you should call "
16181 "C<guestfs_part_add> for each partition required."
16186 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3392
16187 msgid "Possible values for C<parttype> are:"
16192 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3396
16193 msgid "B<efi> | B<gpt>"
16198 #: ../src/guestfs-actions.pod:5053 ../fish/guestfish-actions.pod:3398
16199 msgid "Intel EFI / GPT partition table."
16204 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3400
16206 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16207 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16208 "the C<mbr> format."
16213 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3404
16214 msgid "B<mbr> | B<msdos>"
16219 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3406
16221 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16222 "Windows. This partition type will B<only> work for device sizes up to 2 "
16223 "TB. For large disks we recommend using C<gpt>."
16228 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3413
16230 "Other partition table types that may work but are not supported include:"
16235 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3418
16241 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3420
16242 msgid "AIX disk labels."
16247 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3422
16248 msgid "B<amiga> | B<rdb>"
16253 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3424
16254 msgid "Amiga \"Rigid Disk Block\" format."
16259 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3426
16265 #: ../src/guestfs-actions.pod:5083 ../fish/guestfish-actions.pod:3428
16266 msgid "BSD disk labels."
16271 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3430
16277 #: ../src/guestfs-actions.pod:5087 ../fish/guestfish-actions.pod:3432
16278 msgid "DASD, used on IBM mainframes."
16283 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3434
16289 #: ../src/guestfs-actions.pod:5091 ../fish/guestfish-actions.pod:3436
16290 msgid "MIPS/SGI volumes."
16295 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3438
16301 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3440
16302 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16307 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3442
16313 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3444
16314 msgid "NEC PC-98 format, common in Japan apparently."
16319 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3446
16325 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3448
16326 msgid "Sun disk labels."
16331 #: ../src/guestfs-actions.pod:5111
16332 msgid "guestfs_part_list"
16337 #: ../src/guestfs-actions.pod:5113
16340 " struct guestfs_partition_list *\n"
16341 " guestfs_part_list (guestfs_h *g,\n"
16342 " const char *device);\n"
16348 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3456
16350 "This command parses the partition table on C<device> and returns the list of "
16351 "partitions found."
16356 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3459
16357 msgid "The fields in the returned structure are:"
16362 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3463
16363 msgid "B<part_num>"
16368 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3465
16369 msgid "Partition number, counting from 1."
16374 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3467
16375 msgid "B<part_start>"
16380 #: ../src/guestfs-actions.pod:5130
16382 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16383 "the device's sector size, see C<guestfs_blockdev_getss>."
16388 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3472
16389 msgid "B<part_end>"
16394 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3474
16395 msgid "End of the partition in bytes."
16400 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3476
16401 msgid "B<part_size>"
16406 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3478
16407 msgid "Size of the partition in bytes."
16412 #: ../src/guestfs-actions.pod:5143
16414 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16415 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16421 #: ../src/guestfs-actions.pod:5149
16422 msgid "guestfs_part_set_bootable"
16427 #: ../src/guestfs-actions.pod:5151
16431 " guestfs_part_set_bootable (guestfs_h *g,\n"
16432 " const char *device,\n"
16434 " int bootable);\n"
16440 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3486
16442 "This sets the bootable flag on partition numbered C<partnum> on device "
16443 "C<device>. Note that partitions are numbered from 1."
16448 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3489
16450 "The bootable flag is used by some operating systems (notably Windows) to "
16451 "determine which partition to boot from. It is by no means universally "
16457 #: ../src/guestfs-actions.pod:5168
16458 msgid "guestfs_part_set_mbr_id"
16463 #: ../src/guestfs-actions.pod:5170
16467 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16468 " const char *device,\n"
16476 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:3497
16478 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16479 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16480 "documentation are in fact hexadecimal numbers, but usually documented "
16481 "without any leading \"0x\" which might be confusing."
16486 #: ../src/guestfs-actions.pod:5190
16487 msgid "guestfs_part_set_name"
16492 #: ../src/guestfs-actions.pod:5192
16496 " guestfs_part_set_name (guestfs_h *g,\n"
16497 " const char *device,\n"
16499 " const char *name);\n"
16505 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3511
16507 "This sets the partition name on partition numbered C<partnum> on device "
16508 "C<device>. Note that partitions are numbered from 1."
16513 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3514
16515 "The partition name can only be set on certain types of partition table. "
16516 "This works on C<gpt> but not on C<mbr> partitions."
16521 #: ../src/guestfs-actions.pod:5208
16522 msgid "guestfs_part_to_dev"
16527 #: ../src/guestfs-actions.pod:5210
16531 " guestfs_part_to_dev (guestfs_h *g,\n"
16532 " const char *partition);\n"
16538 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3521
16540 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16541 "partition number, returning the device name (eg. \"/dev/sdb\")."
16546 #: ../src/guestfs-actions.pod:5218
16548 "The named partition must exist, for example as a string returned from "
16549 "C<guestfs_list_partitions>."
16554 #: ../src/guestfs-actions.pod:5226
16555 msgid "guestfs_ping_daemon"
16560 #: ../src/guestfs-actions.pod:5228
16564 " guestfs_ping_daemon (guestfs_h *g);\n"
16570 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3532
16572 "This is a test probe into the guestfs daemon running inside the qemu "
16573 "subprocess. Calling this function checks that the daemon responds to the "
16574 "ping message, without affecting the daemon or attached block device(s) in "
16580 #: ../src/guestfs-actions.pod:5240
16581 msgid "guestfs_pread"
16586 #: ../src/guestfs-actions.pod:5242
16590 " guestfs_pread (guestfs_h *g,\n"
16591 " const char *path,\n"
16593 " int64_t offset,\n"
16594 " size_t *size_r);\n"
16600 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3541
16602 "This command lets you read part of a file. It reads C<count> bytes of the "
16603 "file, starting at C<offset>, from file C<path>."
16608 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278
16609 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3559
16611 "This may read fewer bytes than requested. For further details see the "
16612 "L<pread(2)> system call."
16617 #: ../src/guestfs-actions.pod:5255
16618 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16623 #: ../src/guestfs-actions.pod:5266
16624 msgid "guestfs_pread_device"
16629 #: ../src/guestfs-actions.pod:5268
16633 " guestfs_pread_device (guestfs_h *g,\n"
16634 " const char *device,\n"
16636 " int64_t offset,\n"
16637 " size_t *size_r);\n"
16643 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3556
16645 "This command lets you read part of a file. It reads C<count> bytes of "
16646 "C<device>, starting at C<offset>."
16651 #: ../src/guestfs-actions.pod:5281
16652 msgid "See also C<guestfs_pread>."
16657 #: ../src/guestfs-actions.pod:5290
16658 msgid "(Added in 1.5.21)"
16663 #: ../src/guestfs-actions.pod:5292
16664 msgid "guestfs_pvcreate"
16669 #: ../src/guestfs-actions.pod:5294
16673 " guestfs_pvcreate (guestfs_h *g,\n"
16674 " const char *device);\n"
16680 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3571
16682 "This creates an LVM physical volume on the named C<device>, where C<device> "
16683 "should usually be a partition name such as C</dev/sda1>."
16688 #: ../src/guestfs-actions.pod:5306
16689 msgid "guestfs_pvremove"
16694 #: ../src/guestfs-actions.pod:5308
16698 " guestfs_pvremove (guestfs_h *g,\n"
16699 " const char *device);\n"
16705 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3579
16707 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16713 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3582
16715 "The implementation uses the C<pvremove> command which refuses to wipe "
16716 "physical volumes that contain any volume groups, so you have to remove those "
16722 #: ../src/guestfs-actions.pod:5323
16723 msgid "guestfs_pvresize"
16728 #: ../src/guestfs-actions.pod:5325
16732 " guestfs_pvresize (guestfs_h *g,\n"
16733 " const char *device);\n"
16739 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3590
16741 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16742 "the new size of the underlying device."
16747 #: ../src/guestfs-actions.pod:5336
16748 msgid "guestfs_pvresize_size"
16753 #: ../src/guestfs-actions.pod:5338
16757 " guestfs_pvresize_size (guestfs_h *g,\n"
16758 " const char *device,\n"
16759 " int64_t size);\n"
16765 #: ../src/guestfs-actions.pod:5343
16767 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16768 "specify the new size (in bytes) explicitly."
16773 #: ../src/guestfs-actions.pod:5350
16774 msgid "guestfs_pvs"
16779 #: ../src/guestfs-actions.pod:5352
16783 " guestfs_pvs (guestfs_h *g);\n"
16789 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3604
16791 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16797 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3607
16799 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16805 #: ../src/guestfs-actions.pod:5361
16806 msgid "See also C<guestfs_pvs_full>."
16811 #: ../src/guestfs-actions.pod:5369
16812 msgid "guestfs_pvs_full"
16817 #: ../src/guestfs-actions.pod:5371
16820 " struct guestfs_lvm_pv_list *\n"
16821 " guestfs_pvs_full (guestfs_h *g);\n"
16827 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3616
16829 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16830 "(8)> command. The \"full\" version includes all fields."
16835 #: ../src/guestfs-actions.pod:5377
16837 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16838 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16843 #: ../src/guestfs-actions.pod:5383
16844 msgid "guestfs_pvuuid"
16849 #: ../src/guestfs-actions.pod:5385
16853 " guestfs_pvuuid (guestfs_h *g,\n"
16854 " const char *device);\n"
16860 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3623
16861 msgid "This command returns the UUID of the LVM PV C<device>."
16866 #: ../src/guestfs-actions.pod:5396
16867 msgid "guestfs_pwrite"
16872 #: ../src/guestfs-actions.pod:5398
16876 " guestfs_pwrite (guestfs_h *g,\n"
16877 " const char *path,\n"
16878 " const char *content,\n"
16879 " size_t content_size,\n"
16880 " int64_t offset);\n"
16886 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3629
16888 "This command writes to part of a file. It writes the data buffer C<content> "
16889 "to the file C<path> starting at offset C<offset>."
16894 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3632
16896 "This command implements the L<pwrite(2)> system call, and like that system "
16897 "call it may not write the full data requested. The return value is the "
16898 "number of bytes that were actually written to the file. This could even be "
16899 "0, although short writes are unlikely for regular files in ordinary "
16905 #: ../src/guestfs-actions.pod:5414
16906 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16911 #: ../src/guestfs-actions.pod:5423
16912 msgid "guestfs_pwrite_device"
16917 #: ../src/guestfs-actions.pod:5425
16921 " guestfs_pwrite_device (guestfs_h *g,\n"
16922 " const char *device,\n"
16923 " const char *content,\n"
16924 " size_t content_size,\n"
16925 " int64_t offset);\n"
16931 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3647
16933 "This command writes to part of a device. It writes the data buffer "
16934 "C<content> to C<device> starting at offset C<offset>."
16939 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3650
16941 "This command implements the L<pwrite(2)> system call, and like that system "
16942 "call it may not write the full data requested (although short writes to disk "
16943 "devices and partitions are probably impossible with standard Linux kernels)."
16948 #: ../src/guestfs-actions.pod:5440
16949 msgid "See also C<guestfs_pwrite>."
16954 #: ../src/guestfs-actions.pod:5447
16955 msgid "(Added in 1.5.20)"
16960 #: ../src/guestfs-actions.pod:5449
16961 msgid "guestfs_read_file"
16966 #: ../src/guestfs-actions.pod:5451
16970 " guestfs_read_file (guestfs_h *g,\n"
16971 " const char *path,\n"
16972 " size_t *size_r);\n"
16978 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3664
16979 msgid "This calls returns the contents of the file C<path> as a buffer."
16984 #: ../src/guestfs-actions.pod:5459
16986 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16987 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16988 "function is limited in the total size of file that can be handled."
16993 #: ../src/guestfs-actions.pod:5471
16994 msgid "(Added in 1.0.63)"
16999 #: ../src/guestfs-actions.pod:5473
17000 msgid "guestfs_read_lines"
17005 #: ../src/guestfs-actions.pod:5475
17009 " guestfs_read_lines (guestfs_h *g,\n"
17010 " const char *path);\n"
17016 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3681
17018 "The file contents are returned as a list of lines. Trailing C<LF> and "
17019 "C<CRLF> character sequences are I<not> returned."
17024 #: ../src/guestfs-actions.pod:5484
17026 "Note that this function cannot correctly handle binary files (specifically, "
17027 "files containing C<\\0> character which is treated as end of line). For "
17028 "those you need to use the C<guestfs_read_file> function which has a more "
17029 "complex interface."
17034 #: ../src/guestfs-actions.pod:5495
17035 msgid "guestfs_readdir"
17040 #: ../src/guestfs-actions.pod:5497
17043 " struct guestfs_dirent_list *\n"
17044 " guestfs_readdir (guestfs_h *g,\n"
17045 " const char *dir);\n"
17051 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3693
17052 msgid "This returns the list of directory entries in directory C<dir>."
17057 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3695
17059 "All entries in the directory are returned, including C<.> and C<..>. The "
17060 "entries are I<not> sorted, but returned in the same order as the underlying "
17066 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3699
17068 "Also this call returns basic file type information about each file. The "
17069 "C<ftyp> field will contain one of the following characters:"
17074 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3704
17080 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3706
17081 msgid "Block special"
17086 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3708
17092 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3710
17093 msgid "Char special"
17098 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3712
17104 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3714
17110 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3716
17116 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3718
17117 msgid "FIFO (named pipe)"
17122 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3720
17128 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3722
17129 msgid "Symbolic link"
17134 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3724
17140 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3726
17141 msgid "Regular file"
17146 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3728
17152 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3730
17158 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3732
17164 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3734
17165 msgid "Unknown file type"
17170 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3736
17176 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3738
17178 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17183 #: ../src/guestfs-actions.pod:5551
17185 "This function is primarily intended for use by programs. To get a simple "
17186 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17187 "consumption, use C<guestfs_ll>."
17192 #: ../src/guestfs-actions.pod:5555
17194 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17195 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17200 #: ../src/guestfs-actions.pod:5561
17201 msgid "guestfs_readlink"
17206 #: ../src/guestfs-actions.pod:5563
17210 " guestfs_readlink (guestfs_h *g,\n"
17211 " const char *path);\n"
17217 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3751
17218 msgid "This command reads the target of a symbolic link."
17223 #: ../src/guestfs-actions.pod:5574
17224 msgid "guestfs_readlinklist"
17229 #: ../src/guestfs-actions.pod:5576
17233 " guestfs_readlinklist (guestfs_h *g,\n"
17234 " const char *path,\n"
17235 " char *const *names);\n"
17241 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3757
17243 "This call allows you to do a C<readlink> operation on multiple files, where "
17244 "all files are in the directory C<path>. C<names> is the list of files from "
17250 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
17252 "On return you get a list of strings, with a one-to-one correspondence to the "
17253 "C<names> list. Each string is the value of the symbolic link."
17258 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3765
17260 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17261 "result string is the empty string C<\"\">. However the whole operation is "
17262 "completed even if there were C<readlink(2)> errors, and so you can call this "
17263 "function with names where you don't know if they are symbolic links already "
17264 "(albeit slightly less efficient)."
17269 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3772
17271 "This call is intended for programs that want to efficiently list a directory "
17272 "contents without making many round-trips. Very long directory listings "
17273 "might cause the protocol message size to be exceeded, causing this call to "
17274 "fail. The caller must split up such requests into smaller groups of names."
17279 #: ../src/guestfs-actions.pod:5609
17280 msgid "guestfs_realpath"
17285 #: ../src/guestfs-actions.pod:5611
17289 " guestfs_realpath (guestfs_h *g,\n"
17290 " const char *path);\n"
17296 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3783
17298 "Return the canonicalized absolute pathname of C<path>. The returned path "
17299 "has no C<.>, C<..> or symbolic link path elements."
17304 #: ../src/guestfs-actions.pod:5623
17305 msgid "guestfs_removexattr"
17310 #: ../src/guestfs-actions.pod:5625
17314 " guestfs_removexattr (guestfs_h *g,\n"
17315 " const char *xattr,\n"
17316 " const char *path);\n"
17322 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3790
17324 "This call removes the extended attribute named C<xattr> of the file C<path>."
17329 #: ../src/guestfs-actions.pod:5633
17330 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17335 #: ../src/guestfs-actions.pod:5639
17336 msgid "guestfs_resize2fs"
17341 #: ../src/guestfs-actions.pod:5641
17345 " guestfs_resize2fs (guestfs_h *g,\n"
17346 " const char *device);\n"
17352 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3799
17354 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17355 "underlying device."
17360 #: ../src/guestfs-actions.pod:5648
17362 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17363 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17364 "sometimes gives an error about this and sometimes not. In any case, it is "
17365 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17369 #: ../src/guestfs-actions.pod:5658
17370 msgid "guestfs_resize2fs_M"
17374 #: ../src/guestfs-actions.pod:5660
17378 " guestfs_resize2fs_M (guestfs_h *g,\n"
17379 " const char *device);\n"
17384 #: ../src/guestfs-actions.pod:5664
17386 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17387 "resized to its minimum size. This works like the I<-M> option to the "
17388 "C<resize2fs> command."
17392 #: ../src/guestfs-actions.pod:5668
17394 "To get the resulting size of the filesystem you should call "
17395 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17396 "These two numbers, multiplied together, give the resulting size of the "
17397 "minimal filesystem in bytes."
17402 #: ../src/guestfs-actions.pod:5675
17403 msgid "guestfs_resize2fs_size"
17408 #: ../src/guestfs-actions.pod:5677
17412 " guestfs_resize2fs_size (guestfs_h *g,\n"
17413 " const char *device,\n"
17414 " int64_t size);\n"
17420 #: ../src/guestfs-actions.pod:5682
17422 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17423 "to specify the new size (in bytes) explicitly."
17428 #: ../src/guestfs-actions.pod:5689
17434 #: ../src/guestfs-actions.pod:5691
17438 " guestfs_rm (guestfs_h *g,\n"
17439 " const char *path);\n"
17445 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3832
17446 msgid "Remove the single file C<path>."
17451 #: ../src/guestfs-actions.pod:5701
17452 msgid "guestfs_rm_rf"
17457 #: ../src/guestfs-actions.pod:5703
17461 " guestfs_rm_rf (guestfs_h *g,\n"
17462 " const char *path);\n"
17468 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3838
17470 "Remove the file or directory C<path>, recursively removing the contents if "
17471 "its a directory. This is like the C<rm -rf> shell command."
17476 #: ../src/guestfs-actions.pod:5715
17477 msgid "guestfs_rmdir"
17482 #: ../src/guestfs-actions.pod:5717
17486 " guestfs_rmdir (guestfs_h *g,\n"
17487 " const char *path);\n"
17493 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3846
17494 msgid "Remove the single directory C<path>."
17499 #: ../src/guestfs-actions.pod:5727
17500 msgid "guestfs_rmmountpoint"
17505 #: ../src/guestfs-actions.pod:5729
17509 " guestfs_rmmountpoint (guestfs_h *g,\n"
17510 " const char *exemptpath);\n"
17516 #: ../src/guestfs-actions.pod:5733
17518 "This calls removes a mountpoint that was previously created with "
17519 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17524 #: ../src/guestfs-actions.pod:5741
17525 msgid "guestfs_scrub_device"
17530 #: ../src/guestfs-actions.pod:5743
17534 " guestfs_scrub_device (guestfs_h *g,\n"
17535 " const char *device);\n"
17541 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3860
17543 "This command writes patterns over C<device> to make data retrieval more "
17549 #: ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5771
17550 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3863
17551 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:3891
17553 "It is an interface to the L<scrub(1)> program. See that manual page for "
17559 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5776
17560 #: ../src/guestfs-actions.pod:5795
17561 msgid "(Added in 1.0.52)"
17566 #: ../src/guestfs-actions.pod:5760
17567 msgid "guestfs_scrub_file"
17572 #: ../src/guestfs-actions.pod:5762
17576 " guestfs_scrub_file (guestfs_h *g,\n"
17577 " const char *file);\n"
17583 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3873
17585 "This command writes patterns over a file to make data retrieval more "
17591 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3876
17592 msgid "The file is I<removed> after scrubbing."
17597 #: ../src/guestfs-actions.pod:5778
17598 msgid "guestfs_scrub_freespace"
17603 #: ../src/guestfs-actions.pod:5780
17607 " guestfs_scrub_freespace (guestfs_h *g,\n"
17608 " const char *dir);\n"
17614 #: ../src/guestfs-actions.pod:5784
17616 "This command creates the directory C<dir> and then fills it with files until "
17617 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17618 "and deletes them. The intention is to scrub any free space on the partition "
17619 "containing C<dir>."
17624 #: ../src/guestfs-actions.pod:5797
17625 msgid "guestfs_set_append"
17630 #: ../src/guestfs-actions.pod:5799
17634 " guestfs_set_append (guestfs_h *g,\n"
17635 " const char *append);\n"
17641 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3900
17643 "This function is used to add additional options to the guest kernel command "
17649 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3903
17651 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17652 "environment variable."
17657 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3906
17659 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17660 "(libguestfs always adds a few of its own)."
17664 #: ../src/guestfs-actions.pod:5816
17665 msgid "guestfs_set_attach_method"
17669 #: ../src/guestfs-actions.pod:5818
17673 " guestfs_set_attach_method (guestfs_h *g,\n"
17674 " const char *attachmethod);\n"
17679 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3915
17681 "Set the method that libguestfs uses to connect to the back end guestfsd "
17682 "daemon. Possible methods are:"
17686 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3922
17688 "Launch an appliance and connect to it. This is the ordinary method and the "
17693 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3925
17694 msgid "C<unix:I<path>>"
17698 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3927
17699 msgid "Connect to the Unix domain socket I<path>."
17703 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3929
17705 "This method lets you connect to an existing daemon or (using virtio-serial) "
17706 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17707 "RUNNING DAEMONS>."
17712 #: ../src/guestfs-actions.pod:5844
17713 msgid "guestfs_set_autosync"
17718 #: ../src/guestfs-actions.pod:5846
17722 " guestfs_set_autosync (guestfs_h *g,\n"
17723 " int autosync);\n"
17728 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3941
17730 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17731 "effort attempt to make filesystems consistent and synchronized when the "
17732 "handle is closed (also if the program exits without closing handles)."
17737 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3946
17739 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17740 "disabled by default)."
17745 #: ../src/guestfs-actions.pod:5862
17746 msgid "guestfs_set_direct"
17751 #: ../src/guestfs-actions.pod:5864
17755 " guestfs_set_direct (guestfs_h *g,\n"
17762 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3955
17764 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17765 "passed directly through to the appliance once it is launched."
17770 #: ../src/guestfs-actions.pod:5872
17772 "One consequence of this is that log messages aren't caught by the library "
17773 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17779 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3963
17780 msgid "You probably don't want to use this unless you know what you are doing."
17785 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3966
17786 msgid "The default is disabled."
17791 #: ../src/guestfs-actions.pod:5885
17792 msgid "guestfs_set_e2label"
17797 #: ../src/guestfs-actions.pod:5887
17801 " guestfs_set_e2label (guestfs_h *g,\n"
17802 " const char *device,\n"
17803 " const char *label);\n"
17809 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3972
17811 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17812 "C<label>. Filesystem labels are limited to 16 characters."
17817 #: ../src/guestfs-actions.pod:5896
17819 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17820 "the existing label on a filesystem."
17825 #: ../src/guestfs-actions.pod:5903
17826 msgid "guestfs_set_e2uuid"
17831 #: ../src/guestfs-actions.pod:5905
17835 " guestfs_set_e2uuid (guestfs_h *g,\n"
17836 " const char *device,\n"
17837 " const char *uuid);\n"
17843 #: ../src/guestfs-actions.pod:5910 ../fish/guestfish-actions.pod:3983
17845 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17846 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17847 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17852 #: ../src/guestfs-actions.pod:5915
17854 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17855 "the existing UUID of a filesystem."
17860 #: ../src/guestfs-actions.pod:5922
17861 msgid "guestfs_set_memsize"
17866 #: ../src/guestfs-actions.pod:5924
17870 " guestfs_set_memsize (guestfs_h *g,\n"
17877 #: ../src/guestfs-actions.pod:5928
17879 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17880 "This only has any effect if called before C<guestfs_launch>."
17885 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:4001
17887 "You can also change this by setting the environment variable "
17888 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17893 #: ../src/guestfs-actions.pod:5943
17894 msgid "guestfs_set_network"
17899 #: ../src/guestfs-actions.pod:5945
17903 " guestfs_set_network (guestfs_h *g,\n"
17910 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4014
17912 "If C<network> is true, then the network is enabled in the libguestfs "
17913 "appliance. The default is false."
17918 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4017
17920 "This affects whether commands are able to access the network (see L<guestfs"
17921 "(3)/RUNNING COMMANDS>)."
17926 #: ../src/guestfs-actions.pod:5955
17928 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17934 #: ../src/guestfs-actions.pod:5962
17935 msgid "guestfs_set_path"
17940 #: ../src/guestfs-actions.pod:5964
17944 " guestfs_set_path (guestfs_h *g,\n"
17945 " const char *searchpath);\n"
17951 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4029
17952 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17957 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:4031
17959 "The default is C<$libdir/guestfs> unless overridden by setting "
17960 "C<LIBGUESTFS_PATH> environment variable."
17965 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4034
17966 msgid "Setting C<path> to C<NULL> restores the default path."
17971 #: ../src/guestfs-actions.pod:5979
17972 msgid "guestfs_set_qemu"
17977 #: ../src/guestfs-actions.pod:5981
17981 " guestfs_set_qemu (guestfs_h *g,\n"
17982 " const char *qemu);\n"
17988 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4042
17989 msgid "Set the qemu binary that we will use."
17994 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:4044
17996 "The default is chosen when the library was compiled by the configure script."
18001 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4047
18003 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18009 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4050
18010 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18015 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4052
18017 "Note that you should call this function as early as possible after creating "
18018 "the handle. This is because some pre-launch operations depend on testing "
18019 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18020 "don't retest features, and so you might see inconsistent results. Using the "
18021 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18022 "the qemu binary at the same time as the handle is created."
18027 #: ../src/guestfs-actions.pod:6007
18028 msgid "guestfs_set_recovery_proc"
18033 #: ../src/guestfs-actions.pod:6009
18037 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18038 " int recoveryproc);\n"
18044 #: ../src/guestfs-actions.pod:6013
18046 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18047 "not create a recovery process. The purpose of the recovery process is to "
18048 "stop runaway qemu processes in the case where the main program aborts "
18054 #: ../src/guestfs-actions.pod:6018
18056 "This only has any effect if called before C<guestfs_launch>, and the default "
18062 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4074
18064 "About the only time when you would want to disable this is if the main "
18065 "process will fork itself into the background (\"daemonize\" itself). In "
18066 "this case the recovery process thinks that the main program has disappeared "
18067 "and so kills qemu, which is not very helpful."
18072 #: ../src/guestfs-actions.pod:6031
18073 msgid "guestfs_set_selinux"
18078 #: ../src/guestfs-actions.pod:6033
18082 " guestfs_set_selinux (guestfs_h *g,\n"
18089 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4086
18091 "This sets the selinux flag that is passed to the appliance at boot time. "
18092 "The default is C<selinux=0> (disabled)."
18097 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4089
18099 "Note that if SELinux is enabled, it is always in Permissive mode "
18100 "(C<enforcing=0>)."
18105 #: ../src/guestfs-actions.pod:6050
18106 msgid "guestfs_set_trace"
18111 #: ../src/guestfs-actions.pod:6052
18115 " guestfs_set_trace (guestfs_h *g,\n"
18121 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4101
18123 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18124 "return values are traced."
18129 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4104
18131 "If you want to trace C API calls into libguestfs (and other libraries) then "
18132 "possibly a better way is to use the external ltrace(1) command."
18137 #: ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:4108
18139 "Command traces are disabled unless the environment variable "
18140 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18144 #: ../src/guestfs-actions.pod:6066
18146 "Trace messages are normally sent to C<stderr>, unless you register a "
18147 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18152 #: ../src/guestfs-actions.pod:6074
18153 msgid "guestfs_set_verbose"
18158 #: ../src/guestfs-actions.pod:6076
18162 " guestfs_set_verbose (guestfs_h *g,\n"
18168 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4121
18169 msgid "If C<verbose> is true, this turns on verbose messages."
18174 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4123
18176 "Verbose messages are disabled unless the environment variable "
18177 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18181 #: ../src/guestfs-actions.pod:6085
18183 "Verbose messages are normally sent to C<stderr>, unless you register a "
18184 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18189 #: ../src/guestfs-actions.pod:6093
18190 msgid "guestfs_setcon"
18195 #: ../src/guestfs-actions.pod:6095
18199 " guestfs_setcon (guestfs_h *g,\n"
18200 " const char *context);\n"
18206 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4134
18208 "This sets the SELinux security context of the daemon to the string "
18214 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4137
18215 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18220 #: ../src/guestfs-actions.pod:6108
18221 msgid "guestfs_setxattr"
18226 #: ../src/guestfs-actions.pod:6110
18230 " guestfs_setxattr (guestfs_h *g,\n"
18231 " const char *xattr,\n"
18232 " const char *val,\n"
18234 " const char *path);\n"
18240 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4143
18242 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18243 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18248 #: ../src/guestfs-actions.pod:6121
18249 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18254 #: ../src/guestfs-actions.pod:6127
18255 msgid "guestfs_sfdisk"
18260 #: ../src/guestfs-actions.pod:6129
18264 " guestfs_sfdisk (guestfs_h *g,\n"
18265 " const char *device,\n"
18269 " char *const *lines);\n"
18275 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4153
18277 "This is a direct interface to the L<sfdisk(8)> program for creating "
18278 "partitions on block devices."
18283 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4156
18284 msgid "C<device> should be a block device, for example C</dev/sda>."
18289 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4158
18291 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18292 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18293 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18294 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18295 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18296 "the kernel) cannot work out the right geometry and you will need to tell it."
18301 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4166
18303 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18304 "refer to the L<sfdisk(8)> manpage."
18309 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4169
18311 "To create a single partition occupying the whole disk, you would pass "
18312 "C<lines> as a single element list, when the single element being the string "
18318 #: ../src/guestfs-actions.pod:6157
18320 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18324 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195
18325 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4179
18326 #: ../fish/guestfish-actions.pod:4202 ../fish/guestfish-actions.pod:4224
18328 "This function is deprecated. In new code, use the C<part_add> call instead."
18333 #: ../src/guestfs-actions.pod:6174
18334 msgid "guestfs_sfdiskM"
18339 #: ../src/guestfs-actions.pod:6176
18343 " guestfs_sfdiskM (guestfs_h *g,\n"
18344 " const char *device,\n"
18345 " char *const *lines);\n"
18351 #: ../src/guestfs-actions.pod:6181
18353 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18354 "partition sizes are specified in megabytes only (rounded to the nearest "
18355 "cylinder) and you don't need to specify the cyls, heads and sectors "
18356 "parameters which were rarely if ever used anyway."
18361 #: ../src/guestfs-actions.pod:6187
18363 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18364 "C<guestfs_part_disk>"
18369 #: ../src/guestfs-actions.pod:6204
18370 msgid "guestfs_sfdisk_N"
18375 #: ../src/guestfs-actions.pod:6206
18379 " guestfs_sfdisk_N (guestfs_h *g,\n"
18380 " const char *device,\n"
18385 " const char *line);\n"
18391 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4213
18393 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18394 "(note: C<n> counts from 1)."
18399 #: ../src/guestfs-actions.pod:6218
18401 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18402 "for the cyls/heads/sectors parameters."
18407 #: ../src/guestfs-actions.pod:6221
18408 msgid "See also: C<guestfs_part_add>"
18413 #: ../src/guestfs-actions.pod:6237
18414 msgid "guestfs_sfdisk_disk_geometry"
18419 #: ../src/guestfs-actions.pod:6239
18423 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18424 " const char *device);\n"
18430 #: ../src/guestfs-actions.pod:6243
18432 "This displays the disk geometry of C<device> read from the partition table. "
18433 "Especially in the case where the underlying block device has been resized, "
18434 "this can be different from the kernel's idea of the geometry (see "
18435 "C<guestfs_sfdisk_kernel_geometry>)."
18440 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6264
18441 #: ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4249
18442 msgid "The result is in human-readable format, and not designed to be parsed."
18447 #: ../src/guestfs-actions.pod:6256
18448 msgid "guestfs_sfdisk_kernel_geometry"
18453 #: ../src/guestfs-actions.pod:6258
18457 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18458 " const char *device);\n"
18464 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4247
18465 msgid "This displays the kernel's idea of the geometry of C<device>."
18470 #: ../src/guestfs-actions.pod:6272
18471 msgid "guestfs_sfdisk_l"
18476 #: ../src/guestfs-actions.pod:6274
18480 " guestfs_sfdisk_l (guestfs_h *g,\n"
18481 " const char *device);\n"
18487 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4256
18489 "This displays the partition table on C<device>, in the human-readable output "
18490 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18495 #: ../src/guestfs-actions.pod:6282
18496 msgid "See also: C<guestfs_part_list>"
18500 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4262
18502 "This function is deprecated. In new code, use the C<part_list> call instead."
18507 #: ../src/guestfs-actions.pod:6296
18513 #: ../src/guestfs-actions.pod:6298
18517 " guestfs_sh (guestfs_h *g,\n"
18518 " const char *command);\n"
18524 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4273
18526 "This call runs a command from the guest filesystem via the guest's C</bin/"
18532 #: ../src/guestfs-actions.pod:6305
18533 msgid "This is like C<guestfs_command>, but passes the command to:"
18538 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4278
18541 " /bin/sh -c \"command\"\n"
18547 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4280
18549 "Depending on the guest's shell, this usually results in wildcards being "
18550 "expanded, shell expressions being interpolated and so on."
18555 #: ../src/guestfs-actions.pod:6313
18556 msgid "All the provisos about C<guestfs_command> apply to this call."
18561 #: ../src/guestfs-actions.pod:6320
18562 msgid "guestfs_sh_lines"
18567 #: ../src/guestfs-actions.pod:6322
18571 " guestfs_sh_lines (guestfs_h *g,\n"
18572 " const char *command);\n"
18578 #: ../src/guestfs-actions.pod:6326
18580 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18586 #: ../src/guestfs-actions.pod:6329
18587 msgid "See also: C<guestfs_command_lines>"
18592 #: ../src/guestfs-actions.pod:6337
18593 msgid "guestfs_sleep"
18598 #: ../src/guestfs-actions.pod:6339
18602 " guestfs_sleep (guestfs_h *g,\n"
18609 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4299
18610 msgid "Sleep for C<secs> seconds."
18615 #: ../src/guestfs-actions.pod:6347
18616 msgid "(Added in 1.0.41)"
18621 #: ../src/guestfs-actions.pod:6349 ../src/guestfs-structs.pod:109
18622 msgid "guestfs_stat"
18627 #: ../src/guestfs-actions.pod:6351
18630 " struct guestfs_stat *\n"
18631 " guestfs_stat (guestfs_h *g,\n"
18632 " const char *path);\n"
18638 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4307
18639 msgid "This is the same as the C<stat(2)> system call."
18644 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-structs.pod:135
18645 msgid "guestfs_statvfs"
18650 #: ../src/guestfs-actions.pod:6367
18653 " struct guestfs_statvfs *\n"
18654 " guestfs_statvfs (guestfs_h *g,\n"
18655 " const char *path);\n"
18661 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4313
18663 "Returns file system statistics for any mounted file system. C<path> should "
18664 "be a file or directory in the mounted file system (typically it is the mount "
18665 "point itself, but it doesn't need to be)."
18670 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4317
18671 msgid "This is the same as the C<statvfs(2)> system call."
18676 #: ../src/guestfs-actions.pod:6377
18678 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18679 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18684 #: ../src/guestfs-actions.pod:6383
18685 msgid "guestfs_strings"
18690 #: ../src/guestfs-actions.pod:6385
18694 " guestfs_strings (guestfs_h *g,\n"
18695 " const char *path);\n"
18701 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4323
18703 "This runs the L<strings(1)> command on a file and returns the list of "
18704 "printable strings found."
18709 #: ../src/guestfs-actions.pod:6401
18710 msgid "guestfs_strings_e"
18715 #: ../src/guestfs-actions.pod:6403
18719 " guestfs_strings_e (guestfs_h *g,\n"
18720 " const char *encoding,\n"
18721 " const char *path);\n"
18727 #: ../src/guestfs-actions.pod:6408
18729 "This is like the C<guestfs_strings> command, but allows you to specify the "
18730 "encoding of strings that are looked for in the source file C<path>."
18735 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4337
18736 msgid "Allowed encodings are:"
18741 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4341
18747 #: ../src/guestfs-actions.pod:6418
18749 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18750 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18755 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4346
18761 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4348
18762 msgid "Single 8-bit-byte characters."
18767 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4350
18773 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4352
18774 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18779 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4355
18780 msgid "l (lower case letter L)"
18785 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4357
18787 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18788 "examining binaries in Windows guests."
18793 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4360
18799 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4362
18800 msgid "32-bit big endian such as UCS-4BE."
18805 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4364
18811 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4366
18812 msgid "32-bit little endian such as UCS-4LE."
18817 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4370
18818 msgid "The returned strings are transcoded to UTF-8."
18823 #: ../src/guestfs-actions.pod:6456
18824 msgid "guestfs_swapoff_device"
18829 #: ../src/guestfs-actions.pod:6458
18833 " guestfs_swapoff_device (guestfs_h *g,\n"
18834 " const char *device);\n"
18840 #: ../src/guestfs-actions.pod:6462
18842 "This command disables the libguestfs appliance swap device or partition "
18843 "named C<device>. See C<guestfs_swapon_device>."
18848 #: ../src/guestfs-actions.pod:6470
18849 msgid "guestfs_swapoff_file"
18854 #: ../src/guestfs-actions.pod:6472
18858 " guestfs_swapoff_file (guestfs_h *g,\n"
18859 " const char *file);\n"
18865 #: ../src/guestfs-actions.pod:6476 ../fish/guestfish-actions.pod:4387
18866 msgid "This command disables the libguestfs appliance swap on file."
18871 #: ../src/guestfs-actions.pod:6482
18872 msgid "guestfs_swapoff_label"
18877 #: ../src/guestfs-actions.pod:6484
18881 " guestfs_swapoff_label (guestfs_h *g,\n"
18882 " const char *label);\n"
18888 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4393
18890 "This command disables the libguestfs appliance swap on labeled swap "
18896 #: ../src/guestfs-actions.pod:6495
18897 msgid "guestfs_swapoff_uuid"
18902 #: ../src/guestfs-actions.pod:6497
18906 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18907 " const char *uuid);\n"
18913 #: ../src/guestfs-actions.pod:6501 ../fish/guestfish-actions.pod:4400
18915 "This command disables the libguestfs appliance swap partition with the given "
18921 #: ../src/guestfs-actions.pod:6508
18922 msgid "guestfs_swapon_device"
18927 #: ../src/guestfs-actions.pod:6510
18931 " guestfs_swapon_device (guestfs_h *g,\n"
18932 " const char *device);\n"
18938 #: ../src/guestfs-actions.pod:6514
18940 "This command enables the libguestfs appliance to use the swap device or "
18941 "partition named C<device>. The increased memory is made available for all "
18942 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18947 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4412
18949 "Note that you should not swap to existing guest swap partitions unless you "
18950 "know what you are doing. They may contain hibernation information, or other "
18951 "information that the guest doesn't want you to trash. You also risk leaking "
18952 "information about the host to the guest this way. Instead, attach a new "
18953 "host device to the guest and swap on that."
18958 #: ../src/guestfs-actions.pod:6530
18959 msgid "guestfs_swapon_file"
18964 #: ../src/guestfs-actions.pod:6532
18968 " guestfs_swapon_file (guestfs_h *g,\n"
18969 " const char *file);\n"
18975 #: ../src/guestfs-actions.pod:6536
18977 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18983 #: ../src/guestfs-actions.pod:6543
18984 msgid "guestfs_swapon_label"
18989 #: ../src/guestfs-actions.pod:6545
18993 " guestfs_swapon_label (guestfs_h *g,\n"
18994 " const char *label);\n"
19000 #: ../src/guestfs-actions.pod:6549
19002 "This command enables swap to a labeled swap partition. See "
19003 "C<guestfs_swapon_device> for other notes."
19008 #: ../src/guestfs-actions.pod:6556
19009 msgid "guestfs_swapon_uuid"
19014 #: ../src/guestfs-actions.pod:6558
19018 " guestfs_swapon_uuid (guestfs_h *g,\n"
19019 " const char *uuid);\n"
19025 #: ../src/guestfs-actions.pod:6562
19027 "This command enables swap to a swap partition with the given UUID. See "
19028 "C<guestfs_swapon_device> for other notes."
19033 #: ../src/guestfs-actions.pod:6569
19034 msgid "guestfs_sync"
19039 #: ../src/guestfs-actions.pod:6571
19043 " guestfs_sync (guestfs_h *g);\n"
19049 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4444
19051 "This syncs the disk, so that any writes are flushed through to the "
19052 "underlying disk image."
19057 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4447
19059 "You should always call this if you have modified a disk image, before "
19060 "closing the handle."
19065 #: ../src/guestfs-actions.pod:6584
19066 msgid "guestfs_tail"
19071 #: ../src/guestfs-actions.pod:6586
19075 " guestfs_tail (guestfs_h *g,\n"
19076 " const char *path);\n"
19082 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4454
19084 "This command returns up to the last 10 lines of a file as a list of strings."
19089 #: ../src/guestfs-actions.pod:6602
19090 msgid "guestfs_tail_n"
19095 #: ../src/guestfs-actions.pod:6604
19099 " guestfs_tail_n (guestfs_h *g,\n"
19101 " const char *path);\n"
19107 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4464
19109 "If the parameter C<nrlines> is a positive number, this returns the last "
19110 "C<nrlines> lines of the file C<path>."
19115 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4467
19117 "If the parameter C<nrlines> is a negative number, this returns lines from "
19118 "the file C<path>, starting with the C<-nrlines>th line."
19123 #: ../src/guestfs-actions.pod:6626
19124 msgid "guestfs_tar_in"
19129 #: ../src/guestfs-actions.pod:6628
19133 " guestfs_tar_in (guestfs_h *g,\n"
19134 " const char *tarfile,\n"
19135 " const char *directory);\n"
19141 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4479
19143 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19144 "tar file) into C<directory>."
19149 #: ../src/guestfs-actions.pod:6636
19151 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19156 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6658
19157 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6690
19158 msgid "(Added in 1.0.3)"
19163 #: ../src/guestfs-actions.pod:6643
19164 msgid "guestfs_tar_out"
19169 #: ../src/guestfs-actions.pod:6645
19173 " guestfs_tar_out (guestfs_h *g,\n"
19174 " const char *directory,\n"
19175 " const char *tarfile);\n"
19181 #: ../src/guestfs-actions.pod:6650 ../fish/guestfish-actions.pod:4491
19183 "This command packs the contents of C<directory> and downloads it to local "
19189 #: ../src/guestfs-actions.pod:6653
19191 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19192 "C<guestfs_txz_out>."
19197 #: ../src/guestfs-actions.pod:6660
19198 msgid "guestfs_tgz_in"
19203 #: ../src/guestfs-actions.pod:6662
19207 " guestfs_tgz_in (guestfs_h *g,\n"
19208 " const char *tarball,\n"
19209 " const char *directory);\n"
19215 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4503
19217 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19218 "tar file) into C<directory>."
19223 #: ../src/guestfs-actions.pod:6670
19224 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19229 #: ../src/guestfs-actions.pod:6676
19230 msgid "guestfs_tgz_out"
19235 #: ../src/guestfs-actions.pod:6678
19239 " guestfs_tgz_out (guestfs_h *g,\n"
19240 " const char *directory,\n"
19241 " const char *tarball);\n"
19247 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4514
19249 "This command packs the contents of C<directory> and downloads it to local "
19255 #: ../src/guestfs-actions.pod:6686
19256 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19261 #: ../src/guestfs-actions.pod:6692
19262 msgid "guestfs_touch"
19267 #: ../src/guestfs-actions.pod:6694
19271 " guestfs_touch (guestfs_h *g,\n"
19272 " const char *path);\n"
19278 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4525
19280 "Touch acts like the L<touch(1)> command. It can be used to update the "
19281 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19287 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4529
19289 "This command only works on regular files, and will fail on other file types "
19290 "such as directories, symbolic links, block special etc."
19295 #: ../src/guestfs-actions.pod:6709
19296 msgid "guestfs_truncate"
19301 #: ../src/guestfs-actions.pod:6711
19305 " guestfs_truncate (guestfs_h *g,\n"
19306 " const char *path);\n"
19312 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4536
19314 "This command truncates C<path> to a zero-length file. The file must exist "
19320 #: ../src/guestfs-actions.pod:6722
19321 msgid "guestfs_truncate_size"
19326 #: ../src/guestfs-actions.pod:6724
19330 " guestfs_truncate_size (guestfs_h *g,\n"
19331 " const char *path,\n"
19332 " int64_t size);\n"
19338 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4543
19340 "This command truncates C<path> to size C<size> bytes. The file must exist "
19346 #: ../src/guestfs-actions.pod:6732
19348 "If the current file size is less than C<size> then the file is extended to "
19349 "the required size with zero bytes. This creates a sparse file (ie. disk "
19350 "blocks are not allocated for the file until you write to it). To create a "
19351 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19356 #: ../src/guestfs-actions.pod:6742
19357 msgid "guestfs_tune2fs_l"
19362 #: ../src/guestfs-actions.pod:6744
19366 " guestfs_tune2fs_l (guestfs_h *g,\n"
19367 " const char *device);\n"
19373 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4556
19375 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19381 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4559
19383 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19384 "for more details. The list of fields returned isn't clearly defined, and "
19385 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19386 "and the filesystem itself."
19391 #: ../src/guestfs-actions.pod:6764
19392 msgid "guestfs_txz_in"
19397 #: ../src/guestfs-actions.pod:6766
19401 " guestfs_txz_in (guestfs_h *g,\n"
19402 " const char *tarball,\n"
19403 " const char *directory);\n"
19409 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4568
19411 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19412 "tar file) into C<directory>."
19417 #: ../src/guestfs-actions.pod:6778
19418 msgid "guestfs_txz_out"
19423 #: ../src/guestfs-actions.pod:6780
19427 " guestfs_txz_out (guestfs_h *g,\n"
19428 " const char *directory,\n"
19429 " const char *tarball);\n"
19435 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4577
19437 "This command packs the contents of C<directory> and downloads it to local "
19438 "file C<tarball> (as an xz compressed tar archive)."
19443 #: ../src/guestfs-actions.pod:6792
19444 msgid "guestfs_umask"
19449 #: ../src/guestfs-actions.pod:6794
19453 " guestfs_umask (guestfs_h *g,\n"
19460 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4586
19462 "This function sets the mask used for creating new files and device nodes to "
19468 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4589
19470 "Typical umask values would be C<022> which creates new files with "
19471 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19472 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19477 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4594
19479 "The default umask is C<022>. This is important because it means that "
19480 "directories and device nodes will be created with C<0644> or C<0755> mode "
19481 "even if you specify C<0777>."
19486 #: ../src/guestfs-actions.pod:6810
19488 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19489 "C<guestfs_mkdir>."
19494 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4601
19495 msgid "This call returns the previous umask."
19500 #: ../src/guestfs-actions.pod:6819
19501 msgid "guestfs_umount"
19506 #: ../src/guestfs-actions.pod:6821
19510 " guestfs_umount (guestfs_h *g,\n"
19511 " const char *pathordevice);\n"
19517 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4609
19519 "This unmounts the given filesystem. The filesystem may be specified either "
19520 "by its mountpoint (path) or the device which contains the filesystem."
19525 #: ../src/guestfs-actions.pod:6833
19526 msgid "guestfs_umount_all"
19531 #: ../src/guestfs-actions.pod:6835
19535 " guestfs_umount_all (guestfs_h *g);\n"
19541 #: ../src/guestfs-actions.pod:6838 ../fish/guestfish-actions.pod:4619
19542 msgid "This unmounts all mounted filesystems."
19547 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4621
19548 msgid "Some internal mounts are not unmounted by this call."
19553 #: ../src/guestfs-actions.pod:6846
19554 msgid "guestfs_upload"
19559 #: ../src/guestfs-actions.pod:6848
19563 " guestfs_upload (guestfs_h *g,\n"
19564 " const char *filename,\n"
19565 " const char *remotefilename);\n"
19571 #: ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6877
19572 #: ../fish/guestfish-actions.pod:4627 ../fish/guestfish-actions.pod:4640
19573 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19578 #: ../src/guestfs-actions.pod:6858
19579 msgid "See also C<guestfs_download>."
19584 #: ../src/guestfs-actions.pod:6869
19585 msgid "guestfs_upload_offset"
19590 #: ../src/guestfs-actions.pod:6871
19594 " guestfs_upload_offset (guestfs_h *g,\n"
19595 " const char *filename,\n"
19596 " const char *remotefilename,\n"
19597 " int64_t offset);\n"
19603 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4643
19605 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19606 "The intention is to overwrite parts of existing files or devices, although "
19607 "if a non-existant file is specified then it is created with a \"hole\" "
19608 "before C<offset>. The size of the data written is implicit in the size of "
19609 "the source C<filename>."
19614 #: ../src/guestfs-actions.pod:6887
19616 "Note that there is no limit on the amount of data that can be uploaded with "
19617 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19618 "full amount unless an error occurs."
19623 #: ../src/guestfs-actions.pod:6892
19624 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19629 #: ../src/guestfs-actions.pod:6903
19630 msgid "guestfs_utimens"
19635 #: ../src/guestfs-actions.pod:6905
19639 " guestfs_utimens (guestfs_h *g,\n"
19640 " const char *path,\n"
19641 " int64_t atsecs,\n"
19642 " int64_t atnsecs,\n"
19643 " int64_t mtsecs,\n"
19644 " int64_t mtnsecs);\n"
19650 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4663
19651 msgid "This command sets the timestamps of a file with nanosecond precision."
19656 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4666
19658 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19664 #: ../src/guestfs-actions.pod:6919 ../fish/guestfish-actions.pod:4669
19666 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19667 "nanoseconds from the epoch."
19672 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4672
19674 "If the C<*nsecs> field contains the special value C<-1> then the "
19675 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19676 "ignored in this case)."
19681 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4676
19683 "If the C<*nsecs> field contains the special value C<-2> then the "
19684 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19690 #: ../src/guestfs-actions.pod:6934 ../src/guestfs-structs.pod:175
19691 msgid "guestfs_version"
19696 #: ../src/guestfs-actions.pod:6936
19699 " struct guestfs_version *\n"
19700 " guestfs_version (guestfs_h *g);\n"
19706 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4684
19708 "Return the libguestfs version number that the program is linked against."
19713 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4687
19715 "Note that because of dynamic linking this is not necessarily the version of "
19716 "libguestfs that you compiled against. You can compile the program, and then "
19717 "at runtime dynamically link against a completely different C<libguestfs.so> "
19723 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4692
19725 "This call was added in version C<1.0.58>. In previous versions of "
19726 "libguestfs there was no way to get the version number. From C code you can "
19727 "use dynamic linker functions to find out if this symbol exists (if it "
19728 "doesn't, then it's an earlier version)."
19733 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4698
19735 "The call returns a structure with four elements. The first three (C<major>, "
19736 "C<minor> and C<release>) are numbers and correspond to the usual version "
19737 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19738 "but may be used for distro-specific information."
19743 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4704
19745 "To construct the original version string: C<$major.$minor.$release$extra>"
19750 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4707
19751 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19756 #: ../src/guestfs-actions.pod:6964
19758 "I<Note:> Don't use this call to test for availability of features. In "
19759 "enterprise distributions we backport features from later versions into "
19760 "earlier versions, making this an unreliable way to test for features. Use "
19761 "C<guestfs_available> instead."
19766 #: ../src/guestfs-actions.pod:6970
19768 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19769 "error. I<The caller must call C<guestfs_free_version> after use>."
19774 #: ../src/guestfs-actions.pod:6974
19775 msgid "(Added in 1.0.58)"
19780 #: ../src/guestfs-actions.pod:6976
19781 msgid "guestfs_vfs_label"
19786 #: ../src/guestfs-actions.pod:6978
19790 " guestfs_vfs_label (guestfs_h *g,\n"
19791 " const char *device);\n"
19797 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4719
19798 msgid "This returns the filesystem label of the filesystem on C<device>."
19803 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4722
19804 msgid "If the filesystem is unlabeled, this returns the empty string."
19809 #: ../src/guestfs-actions.pod:6987
19810 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19815 #: ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7029
19816 msgid "(Added in 1.3.18)"
19821 #: ../src/guestfs-actions.pod:6994
19822 msgid "guestfs_vfs_type"
19827 #: ../src/guestfs-actions.pod:6996
19831 " guestfs_vfs_type (guestfs_h *g,\n"
19832 " const char *device);\n"
19838 #: ../src/guestfs-actions.pod:7000 ../fish/guestfish-actions.pod:4730
19840 "This command gets the filesystem type corresponding to the filesystem on "
19846 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4733
19848 "For most filesystems, the result is the name of the Linux VFS module which "
19849 "would be used to mount this filesystem if you mounted it without specifying "
19850 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19855 #: ../src/guestfs-actions.pod:7013
19856 msgid "guestfs_vfs_uuid"
19861 #: ../src/guestfs-actions.pod:7015
19865 " guestfs_vfs_uuid (guestfs_h *g,\n"
19866 " const char *device);\n"
19872 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4742
19873 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19878 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4745
19879 msgid "If the filesystem does not have a UUID, this returns the empty string."
19884 #: ../src/guestfs-actions.pod:7024
19885 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19890 #: ../src/guestfs-actions.pod:7031
19891 msgid "guestfs_vg_activate"
19896 #: ../src/guestfs-actions.pod:7033
19900 " guestfs_vg_activate (guestfs_h *g,\n"
19902 " char *const *volgroups);\n"
19908 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4753
19910 "This command activates or (if C<activate> is false) deactivates all logical "
19911 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19912 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19913 "deactivated, then those devices disappear."
19918 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4759
19919 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19924 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4761
19926 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19927 "activated or deactivated."
19932 #: ../src/guestfs-actions.pod:7053
19933 msgid "guestfs_vg_activate_all"
19938 #: ../src/guestfs-actions.pod:7055
19942 " guestfs_vg_activate_all (guestfs_h *g,\n"
19943 " int activate);\n"
19949 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4768
19951 "This command activates or (if C<activate> is false) deactivates all logical "
19952 "volumes in all volume groups. If activated, then they are made known to the "
19953 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19954 "those devices disappear."
19959 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4774
19960 msgid "This command is the same as running C<vgchange -a y|n>"
19965 #: ../src/guestfs-actions.pod:7071
19966 msgid "guestfs_vgcreate"
19971 #: ../src/guestfs-actions.pod:7073
19975 " guestfs_vgcreate (guestfs_h *g,\n"
19976 " const char *volgroup,\n"
19977 " char *const *physvols);\n"
19983 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4780
19985 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19986 "of physical volumes C<physvols>."
19991 #: ../src/guestfs-actions.pod:7085
19992 msgid "guestfs_vglvuuids"
19997 #: ../src/guestfs-actions.pod:7087
20001 " guestfs_vglvuuids (guestfs_h *g,\n"
20002 " const char *vgname);\n"
20008 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4787
20010 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20011 "volumes created in this volume group."
20016 #: ../src/guestfs-actions.pod:7094
20018 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20019 "associate logical volumes and volume groups."
20024 #: ../src/guestfs-actions.pod:7097
20025 msgid "See also C<guestfs_vgpvuuids>."
20030 #: ../src/guestfs-actions.pod:7105
20031 msgid "guestfs_vgpvuuids"
20036 #: ../src/guestfs-actions.pod:7107
20040 " guestfs_vgpvuuids (guestfs_h *g,\n"
20041 " const char *vgname);\n"
20047 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4799
20049 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20050 "volumes that this volume group resides on."
20055 #: ../src/guestfs-actions.pod:7114
20057 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20058 "associate physical volumes and volume groups."
20063 #: ../src/guestfs-actions.pod:7117
20064 msgid "See also C<guestfs_vglvuuids>."
20069 #: ../src/guestfs-actions.pod:7125
20070 msgid "guestfs_vgremove"
20075 #: ../src/guestfs-actions.pod:7127
20079 " guestfs_vgremove (guestfs_h *g,\n"
20080 " const char *vgname);\n"
20086 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4811
20087 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20092 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4813
20094 "This also forcibly removes all logical volumes in the volume group (if any)."
20099 #: ../src/guestfs-actions.pod:7140
20100 msgid "guestfs_vgrename"
20105 #: ../src/guestfs-actions.pod:7142
20109 " guestfs_vgrename (guestfs_h *g,\n"
20110 " const char *volgroup,\n"
20111 " const char *newvolgroup);\n"
20117 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4820
20118 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20123 #: ../src/guestfs-actions.pod:7153
20124 msgid "guestfs_vgs"
20129 #: ../src/guestfs-actions.pod:7155
20133 " guestfs_vgs (guestfs_h *g);\n"
20139 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4826
20141 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20147 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4829
20149 "This returns a list of just the volume group names that were detected (eg. "
20155 #: ../src/guestfs-actions.pod:7164
20156 msgid "See also C<guestfs_vgs_full>."
20161 #: ../src/guestfs-actions.pod:7172
20162 msgid "guestfs_vgs_full"
20167 #: ../src/guestfs-actions.pod:7174
20170 " struct guestfs_lvm_vg_list *\n"
20171 " guestfs_vgs_full (guestfs_h *g);\n"
20177 #: ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:4838
20179 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20180 "> command. The \"full\" version includes all fields."
20185 #: ../src/guestfs-actions.pod:7180
20187 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20188 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20193 #: ../src/guestfs-actions.pod:7186
20194 msgid "guestfs_vgscan"
20199 #: ../src/guestfs-actions.pod:7188
20203 " guestfs_vgscan (guestfs_h *g);\n"
20209 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4845
20211 "This rescans all block devices and rebuilds the list of LVM physical "
20212 "volumes, volume groups and logical volumes."
20217 #: ../src/guestfs-actions.pod:7198
20218 msgid "guestfs_vguuid"
20223 #: ../src/guestfs-actions.pod:7200
20227 " guestfs_vguuid (guestfs_h *g,\n"
20228 " const char *vgname);\n"
20234 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4852
20235 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20240 #: ../src/guestfs-actions.pod:7211
20241 msgid "guestfs_wait_ready"
20246 #: ../src/guestfs-actions.pod:7213
20250 " guestfs_wait_ready (guestfs_h *g);\n"
20256 #: ../src/guestfs-actions.pod:7216
20257 msgid "This function is a no op."
20262 #: ../src/guestfs-actions.pod:7218
20264 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20265 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20266 "is no longer necessary because C<guestfs_launch> now does the waiting."
20271 #: ../src/guestfs-actions.pod:7223
20273 "If you see any calls to this function in code then you can just remove them, "
20274 "unless you want to retain compatibility with older versions of the API."
20278 #: ../src/guestfs-actions.pod:7229
20280 "This function is deprecated. In new code, use the C<launch> call instead."
20285 #: ../src/guestfs-actions.pod:7238
20286 msgid "guestfs_wc_c"
20291 #: ../src/guestfs-actions.pod:7240
20295 " guestfs_wc_c (guestfs_h *g,\n"
20296 " const char *path);\n"
20302 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4858
20304 "This command counts the characters in a file, using the C<wc -c> external "
20310 #: ../src/guestfs-actions.pod:7251
20311 msgid "guestfs_wc_l"
20316 #: ../src/guestfs-actions.pod:7253
20320 " guestfs_wc_l (guestfs_h *g,\n"
20321 " const char *path);\n"
20327 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4865
20329 "This command counts the lines in a file, using the C<wc -l> external command."
20334 #: ../src/guestfs-actions.pod:7264
20335 msgid "guestfs_wc_w"
20340 #: ../src/guestfs-actions.pod:7266
20344 " guestfs_wc_w (guestfs_h *g,\n"
20345 " const char *path);\n"
20351 #: ../src/guestfs-actions.pod:7270 ../fish/guestfish-actions.pod:4872
20353 "This command counts the words in a file, using the C<wc -w> external command."
20358 #: ../src/guestfs-actions.pod:7277
20359 msgid "guestfs_write"
20364 #: ../src/guestfs-actions.pod:7279
20368 " guestfs_write (guestfs_h *g,\n"
20369 " const char *path,\n"
20370 " const char *content,\n"
20371 " size_t content_size);\n"
20377 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4879
20379 "This call creates a file called C<path>. The content of the file is the "
20380 "string C<content> (which can contain any 8 bit data)."
20385 #: ../src/guestfs-actions.pod:7295
20386 msgid "guestfs_write_file"
20391 #: ../src/guestfs-actions.pod:7297
20395 " guestfs_write_file (guestfs_h *g,\n"
20396 " const char *path,\n"
20397 " const char *content,\n"
20404 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4889
20406 "This call creates a file called C<path>. The contents of the file is the "
20407 "string C<content> (which can contain any 8 bit data), with length C<size>."
20412 #: ../src/guestfs-actions.pod:7307 ../fish/guestfish-actions.pod:4893
20414 "As a special case, if C<size> is C<0> then the length is calculated using "
20415 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20420 #: ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:4897
20422 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20423 "I<not> work, even if the length is specified."
20428 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4903
20430 "This function is deprecated. In new code, use the C<write> call instead."
20435 #: ../src/guestfs-actions.pod:7328
20436 msgid "guestfs_zegrep"
20441 #: ../src/guestfs-actions.pod:7330
20445 " guestfs_zegrep (guestfs_h *g,\n"
20446 " const char *regex,\n"
20447 " const char *path);\n"
20453 #: ../src/guestfs-actions.pod:7335 ../fish/guestfish-actions.pod:4914
20455 "This calls the external C<zegrep> program and returns the matching lines."
20460 #: ../src/guestfs-actions.pod:7347
20461 msgid "guestfs_zegrepi"
20466 #: ../src/guestfs-actions.pod:7349
20470 " guestfs_zegrepi (guestfs_h *g,\n"
20471 " const char *regex,\n"
20472 " const char *path);\n"
20478 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:4924
20480 "This calls the external C<zegrep -i> program and returns the matching lines."
20485 #: ../src/guestfs-actions.pod:7366
20486 msgid "guestfs_zero"
20491 #: ../src/guestfs-actions.pod:7368
20495 " guestfs_zero (guestfs_h *g,\n"
20496 " const char *device);\n"
20502 #: ../src/guestfs-actions.pod:7372 ../fish/guestfish-actions.pod:4934
20503 msgid "This command writes zeroes over the first few blocks of C<device>."
20508 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4936
20510 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20511 "securely wipe the device). It should be sufficient to remove any partition "
20512 "tables, filesystem superblocks and so on."
20517 #: ../src/guestfs-actions.pod:7378
20518 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20523 #: ../src/guestfs-actions.pod:7389
20524 msgid "guestfs_zero_device"
20529 #: ../src/guestfs-actions.pod:7391
20533 " guestfs_zero_device (guestfs_h *g,\n"
20534 " const char *device);\n"
20540 #: ../src/guestfs-actions.pod:7395
20542 "This command writes zeroes over the entire C<device>. Compare with "
20543 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20548 #: ../src/guestfs-actions.pod:7409
20549 msgid "(Added in 1.3.1)"
20554 #: ../src/guestfs-actions.pod:7411
20555 msgid "guestfs_zerofree"
20560 #: ../src/guestfs-actions.pod:7413
20564 " guestfs_zerofree (guestfs_h *g,\n"
20565 " const char *device);\n"
20571 #: ../src/guestfs-actions.pod:7417 ../fish/guestfish-actions.pod:4957
20573 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20574 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20575 "possible to compress the filesystem more effectively."
20580 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4962
20581 msgid "You should B<not> run this program if the filesystem is mounted."
20586 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4965
20588 "It is possible that using this program can damage the filesystem or data on "
20594 #: ../src/guestfs-actions.pod:7432
20595 msgid "guestfs_zfgrep"
20600 #: ../src/guestfs-actions.pod:7434
20604 " guestfs_zfgrep (guestfs_h *g,\n"
20605 " const char *pattern,\n"
20606 " const char *path);\n"
20612 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4972
20614 "This calls the external C<zfgrep> program and returns the matching lines."
20619 #: ../src/guestfs-actions.pod:7451
20620 msgid "guestfs_zfgrepi"
20625 #: ../src/guestfs-actions.pod:7453
20629 " guestfs_zfgrepi (guestfs_h *g,\n"
20630 " const char *pattern,\n"
20631 " const char *path);\n"
20637 #: ../src/guestfs-actions.pod:7458 ../fish/guestfish-actions.pod:4982
20639 "This calls the external C<zfgrep -i> program and returns the matching lines."
20644 #: ../src/guestfs-actions.pod:7470
20645 msgid "guestfs_zfile"
20650 #: ../src/guestfs-actions.pod:7472
20654 " guestfs_zfile (guestfs_h *g,\n"
20655 " const char *meth,\n"
20656 " const char *path);\n"
20662 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4992
20664 "This command runs C<file> after first decompressing C<path> using C<method>."
20669 #: ../src/guestfs-actions.pod:7480 ../fish/guestfish-actions.pod:4995
20670 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20675 #: ../src/guestfs-actions.pod:7482
20677 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20683 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:5000
20685 "This function is deprecated. In new code, use the C<file> call instead."
20690 #: ../src/guestfs-actions.pod:7497
20691 msgid "guestfs_zgrep"
20696 #: ../src/guestfs-actions.pod:7499
20700 " guestfs_zgrep (guestfs_h *g,\n"
20701 " const char *regex,\n"
20702 " const char *path);\n"
20708 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5011
20710 "This calls the external C<zgrep> program and returns the matching lines."
20715 #: ../src/guestfs-actions.pod:7516
20716 msgid "guestfs_zgrepi"
20721 #: ../src/guestfs-actions.pod:7518
20725 " guestfs_zgrepi (guestfs_h *g,\n"
20726 " const char *regex,\n"
20727 " const char *path);\n"
20733 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:5021
20735 "This calls the external C<zgrep -i> program and returns the matching lines."
20740 #: ../src/guestfs-availability.pod:3
20746 #: ../src/guestfs-availability.pod:5
20748 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20749 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20750 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20751 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20752 "L</guestfs_aug_save> L</guestfs_aug_set>"
20757 #: ../src/guestfs-availability.pod:21
20763 #: ../src/guestfs-availability.pod:23
20765 "The following functions: L</guestfs_inotify_add_watch> L</"
20766 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20767 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20772 #: ../src/guestfs-availability.pod:31
20773 msgid "B<linuxfsuuid>"
20778 #: ../src/guestfs-availability.pod:33
20780 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20781 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20786 #: ../src/guestfs-availability.pod:40
20787 msgid "B<linuxmodules>"
20792 #: ../src/guestfs-availability.pod:42
20793 msgid "The following functions: L</guestfs_modprobe>"
20798 #: ../src/guestfs-availability.pod:45
20799 msgid "B<linuxxattrs>"
20804 #: ../src/guestfs-availability.pod:47
20806 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20807 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20808 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20809 "guestfs_setxattr>"
20814 #: ../src/guestfs-availability.pod:58
20820 #: ../src/guestfs-availability.pod:60
20822 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20823 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20824 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20829 #: ../src/guestfs-availability.pod:69
20835 #: ../src/guestfs-availability.pod:71
20837 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20838 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20839 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20840 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20841 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20842 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20843 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20848 #: ../src/guestfs-availability.pod:94
20854 #: ../src/guestfs-availability.pod:96
20856 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20857 "guestfs_mknod_b> L</guestfs_mknod_c>"
20862 #: ../src/guestfs-availability.pod:102
20868 #: ../src/guestfs-availability.pod:104
20869 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20874 #: ../src/guestfs-availability.pod:107
20875 msgid "B<ntfsprogs>"
20880 #: ../src/guestfs-availability.pod:109
20882 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20887 #: ../src/guestfs-availability.pod:113
20888 msgid "B<realpath>"
20893 #: ../src/guestfs-availability.pod:115
20894 msgid "The following functions: L</guestfs_realpath>"
20899 #: ../src/guestfs-availability.pod:118
20905 #: ../src/guestfs-availability.pod:120
20907 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20908 "guestfs_scrub_freespace>"
20913 #: ../src/guestfs-availability.pod:125
20919 #: ../src/guestfs-availability.pod:127
20920 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20925 #: ../src/guestfs-availability.pod:131
20931 #: ../src/guestfs-availability.pod:133
20932 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20937 #: ../src/guestfs-availability.pod:137
20938 msgid "B<zerofree>"
20943 #: ../src/guestfs-availability.pod:139
20944 msgid "The following functions: L</guestfs_zerofree>"
20949 #: ../src/guestfs-structs.pod:1
20950 msgid "guestfs_int_bool"
20955 #: ../src/guestfs-structs.pod:3
20958 " struct guestfs_int_bool {\n"
20967 #: ../src/guestfs-structs.pod:8
20970 " struct guestfs_int_bool_list {\n"
20971 " uint32_t len; /* Number of elements in list. */\n"
20972 " struct guestfs_int_bool *val; /* Elements. */\n"
20979 #: ../src/guestfs-structs.pod:13
20982 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20983 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20989 #: ../src/guestfs-structs.pod:16
20990 msgid "guestfs_lvm_pv"
20995 #: ../src/guestfs-structs.pod:18
20998 " struct guestfs_lvm_pv {\n"
20999 " char *pv_name;\n"
21000 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21001 " char pv_uuid[32];\n"
21003 " uint64_t pv_size;\n"
21004 " uint64_t dev_size;\n"
21005 " uint64_t pv_free;\n"
21006 " uint64_t pv_used;\n"
21007 " char *pv_attr;\n"
21008 " int64_t pv_pe_count;\n"
21009 " int64_t pv_pe_alloc_count;\n"
21010 " char *pv_tags;\n"
21011 " uint64_t pe_start;\n"
21012 " int64_t pv_mda_count;\n"
21013 " uint64_t pv_mda_free;\n"
21020 #: ../src/guestfs-structs.pod:36
21023 " struct guestfs_lvm_pv_list {\n"
21024 " uint32_t len; /* Number of elements in list. */\n"
21025 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21032 #: ../src/guestfs-structs.pod:41
21035 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21036 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21042 #: ../src/guestfs-structs.pod:44
21043 msgid "guestfs_lvm_vg"
21048 #: ../src/guestfs-structs.pod:46
21051 " struct guestfs_lvm_vg {\n"
21052 " char *vg_name;\n"
21053 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21054 " char vg_uuid[32];\n"
21056 " char *vg_attr;\n"
21057 " uint64_t vg_size;\n"
21058 " uint64_t vg_free;\n"
21059 " char *vg_sysid;\n"
21060 " uint64_t vg_extent_size;\n"
21061 " int64_t vg_extent_count;\n"
21062 " int64_t vg_free_count;\n"
21063 " int64_t max_lv;\n"
21064 " int64_t max_pv;\n"
21065 " int64_t pv_count;\n"
21066 " int64_t lv_count;\n"
21067 " int64_t snap_count;\n"
21068 " int64_t vg_seqno;\n"
21069 " char *vg_tags;\n"
21070 " int64_t vg_mda_count;\n"
21071 " uint64_t vg_mda_free;\n"
21078 #: ../src/guestfs-structs.pod:69
21081 " struct guestfs_lvm_vg_list {\n"
21082 " uint32_t len; /* Number of elements in list. */\n"
21083 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21090 #: ../src/guestfs-structs.pod:74
21093 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21094 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21100 #: ../src/guestfs-structs.pod:77
21101 msgid "guestfs_lvm_lv"
21106 #: ../src/guestfs-structs.pod:79
21109 " struct guestfs_lvm_lv {\n"
21110 " char *lv_name;\n"
21111 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21112 " char lv_uuid[32];\n"
21113 " char *lv_attr;\n"
21114 " int64_t lv_major;\n"
21115 " int64_t lv_minor;\n"
21116 " int64_t lv_kernel_major;\n"
21117 " int64_t lv_kernel_minor;\n"
21118 " uint64_t lv_size;\n"
21119 " int64_t seg_count;\n"
21121 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21122 " float snap_percent;\n"
21123 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21124 " float copy_percent;\n"
21125 " char *move_pv;\n"
21126 " char *lv_tags;\n"
21127 " char *mirror_log;\n"
21128 " char *modules;\n"
21135 #: ../src/guestfs-structs.pod:101
21138 " struct guestfs_lvm_lv_list {\n"
21139 " uint32_t len; /* Number of elements in list. */\n"
21140 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21147 #: ../src/guestfs-structs.pod:106
21150 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21151 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21157 #: ../src/guestfs-structs.pod:111
21160 " struct guestfs_stat {\n"
21164 " int64_t nlink;\n"
21169 " int64_t blksize;\n"
21170 " int64_t blocks;\n"
21171 " int64_t atime;\n"
21172 " int64_t mtime;\n"
21173 " int64_t ctime;\n"
21180 #: ../src/guestfs-structs.pod:127
21183 " struct guestfs_stat_list {\n"
21184 " uint32_t len; /* Number of elements in list. */\n"
21185 " struct guestfs_stat *val; /* Elements. */\n"
21192 #: ../src/guestfs-structs.pod:132
21195 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21196 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21202 #: ../src/guestfs-structs.pod:137
21205 " struct guestfs_statvfs {\n"
21206 " int64_t bsize;\n"
21207 " int64_t frsize;\n"
21208 " int64_t blocks;\n"
21209 " int64_t bfree;\n"
21210 " int64_t bavail;\n"
21211 " int64_t files;\n"
21212 " int64_t ffree;\n"
21213 " int64_t favail;\n"
21216 " int64_t namemax;\n"
21223 #: ../src/guestfs-structs.pod:151
21226 " struct guestfs_statvfs_list {\n"
21227 " uint32_t len; /* Number of elements in list. */\n"
21228 " struct guestfs_statvfs *val; /* Elements. */\n"
21235 #: ../src/guestfs-structs.pod:156
21238 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21239 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21245 #: ../src/guestfs-structs.pod:159
21246 msgid "guestfs_dirent"
21251 #: ../src/guestfs-structs.pod:161
21254 " struct guestfs_dirent {\n"
21264 #: ../src/guestfs-structs.pod:167
21267 " struct guestfs_dirent_list {\n"
21268 " uint32_t len; /* Number of elements in list. */\n"
21269 " struct guestfs_dirent *val; /* Elements. */\n"
21276 #: ../src/guestfs-structs.pod:172
21279 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21280 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21286 #: ../src/guestfs-structs.pod:177
21289 " struct guestfs_version {\n"
21290 " int64_t major;\n"
21291 " int64_t minor;\n"
21292 " int64_t release;\n"
21300 #: ../src/guestfs-structs.pod:184
21303 " struct guestfs_version_list {\n"
21304 " uint32_t len; /* Number of elements in list. */\n"
21305 " struct guestfs_version *val; /* Elements. */\n"
21312 #: ../src/guestfs-structs.pod:189
21315 " void guestfs_free_version (struct guestfs_free_version *);\n"
21316 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21322 #: ../src/guestfs-structs.pod:192
21323 msgid "guestfs_xattr"
21328 #: ../src/guestfs-structs.pod:194
21331 " struct guestfs_xattr {\n"
21332 " char *attrname;\n"
21333 " /* The next two fields describe a byte array. */\n"
21334 " uint32_t attrval_len;\n"
21335 " char *attrval;\n"
21342 #: ../src/guestfs-structs.pod:201
21345 " struct guestfs_xattr_list {\n"
21346 " uint32_t len; /* Number of elements in list. */\n"
21347 " struct guestfs_xattr *val; /* Elements. */\n"
21354 #: ../src/guestfs-structs.pod:206
21357 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21358 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21364 #: ../src/guestfs-structs.pod:209
21365 msgid "guestfs_inotify_event"
21370 #: ../src/guestfs-structs.pod:211
21373 " struct guestfs_inotify_event {\n"
21374 " int64_t in_wd;\n"
21375 " uint32_t in_mask;\n"
21376 " uint32_t in_cookie;\n"
21377 " char *in_name;\n"
21384 #: ../src/guestfs-structs.pod:218
21387 " struct guestfs_inotify_event_list {\n"
21388 " uint32_t len; /* Number of elements in list. */\n"
21389 " struct guestfs_inotify_event *val; /* Elements. */\n"
21396 #: ../src/guestfs-structs.pod:223
21399 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21400 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21406 #: ../src/guestfs-structs.pod:226
21407 msgid "guestfs_partition"
21412 #: ../src/guestfs-structs.pod:228
21415 " struct guestfs_partition {\n"
21416 " int32_t part_num;\n"
21417 " uint64_t part_start;\n"
21418 " uint64_t part_end;\n"
21419 " uint64_t part_size;\n"
21426 #: ../src/guestfs-structs.pod:235
21429 " struct guestfs_partition_list {\n"
21430 " uint32_t len; /* Number of elements in list. */\n"
21431 " struct guestfs_partition *val; /* Elements. */\n"
21438 #: ../src/guestfs-structs.pod:240
21441 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21442 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21448 #: ../src/guestfs-structs.pod:243
21449 msgid "guestfs_application"
21454 #: ../src/guestfs-structs.pod:245
21457 " struct guestfs_application {\n"
21458 " char *app_name;\n"
21459 " char *app_display_name;\n"
21460 " int32_t app_epoch;\n"
21461 " char *app_version;\n"
21462 " char *app_release;\n"
21463 " char *app_install_path;\n"
21464 " char *app_trans_path;\n"
21465 " char *app_publisher;\n"
21466 " char *app_url;\n"
21467 " char *app_source_package;\n"
21468 " char *app_summary;\n"
21469 " char *app_description;\n"
21476 #: ../src/guestfs-structs.pod:260
21479 " struct guestfs_application_list {\n"
21480 " uint32_t len; /* Number of elements in list. */\n"
21481 " struct guestfs_application *val; /* Elements. */\n"
21488 #: ../src/guestfs-structs.pod:265
21491 " void guestfs_free_application (struct guestfs_free_application *);\n"
21492 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21498 #: ../fish/guestfish.pod:5
21499 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21504 #: ../fish/guestfish.pod:9
21507 " guestfish [--options] [commands]\n"
21513 #: ../fish/guestfish.pod:11
21522 #: ../fish/guestfish.pod:13
21525 " guestfish [--ro|--rw] -a disk.img\n"
21531 #: ../fish/guestfish.pod:15
21534 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21540 #: ../fish/guestfish.pod:17
21543 " guestfish -d libvirt-domain\n"
21549 #: ../fish/guestfish.pod:19
21552 " guestfish [--ro|--rw] -a disk.img -i\n"
21558 #: ../fish/guestfish.pod:21
21561 " guestfish -d libvirt-domain -i\n"
21567 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
21568 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21574 #: ../fish/guestfish.pod:25
21576 "Using guestfish in read/write mode on live virtual machines can be "
21577 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21578 "option to use guestfish safely if the disk image or virtual machine might be "
21584 #: ../fish/guestfish.pod:32
21586 "Guestfish is a shell and command-line tool for examining and modifying "
21587 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21588 "functionality of the guestfs API, see L<guestfs(3)>."
21593 #: ../fish/guestfish.pod:36
21595 "Guestfish gives you structured access to the libguestfs API, from shell "
21596 "scripts or the command line or interactively. If you want to rescue a "
21597 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21603 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
21604 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
21610 #: ../fish/guestfish.pod:43
21611 msgid "As an interactive shell"
21616 #: ../fish/guestfish.pod:45
21625 #: ../fish/guestfish.pod:47
21628 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21629 " editing virtual machine filesystems.\n"
21635 #: ../fish/guestfish.pod:50
21638 " Type: 'help' for a list of commands\n"
21639 " 'man' to read the manual\n"
21640 " 'quit' to quit the shell\n"
21646 #: ../fish/guestfish.pod:54
21649 " ><fs> add-ro disk.img\n"
21651 " ><fs> list-filesystems\n"
21652 " /dev/sda1: ext4\n"
21653 " /dev/vg_guest/lv_root: ext4\n"
21654 " /dev/vg_guest/lv_swap: swap\n"
21655 " ><fs> mount /dev/vg_guest/lv_root /\n"
21656 " ><fs> cat /etc/fstab\n"
21658 " # Created by anaconda\n"
21666 #: ../fish/guestfish.pod:67
21667 msgid "From shell scripts"
21672 #: ../fish/guestfish.pod:69
21673 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21678 #: ../fish/guestfish.pod:71
21681 " guestfish <<_EOF_\n"
21684 " mount /dev/vg_guest/lv_root /\n"
21685 " write /etc/motd \"Welcome, new users\"\n"
21692 #: ../fish/guestfish.pod:78
21693 msgid "List the LVM logical volumes in a disk image:"
21698 #: ../fish/guestfish.pod:80
21701 " guestfish -a disk.img --ro <<_EOF_\n"
21710 #: ../fish/guestfish.pod:85
21711 msgid "List all the filesystems in a disk image:"
21716 #: ../fish/guestfish.pod:87
21719 " guestfish -a disk.img --ro <<_EOF_\n"
21721 " list-filesystems\n"
21728 #: ../fish/guestfish.pod:92
21729 msgid "On one command line"
21734 #: ../fish/guestfish.pod:94
21735 msgid "Update C</etc/resolv.conf> in a guest:"
21740 #: ../fish/guestfish.pod:96
21744 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21745 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21751 #: ../fish/guestfish.pod:100
21752 msgid "Edit C</boot/grub/grub.conf> interactively:"
21757 #: ../fish/guestfish.pod:102
21760 " guestfish --rw --add disk.img \\\n"
21761 " --mount /dev/vg_guest/lv_root \\\n"
21762 " --mount /dev/sda1:/boot \\\n"
21763 " edit /boot/grub/grub.conf\n"
21769 #: ../fish/guestfish.pod:107
21770 msgid "Mount disks automatically"
21775 #: ../fish/guestfish.pod:109
21777 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21782 #: ../fish/guestfish.pod:112
21785 " guestfish --ro -a disk.img -i cat /etc/group\n"
21791 #: ../fish/guestfish.pod:114
21794 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21800 #: ../fish/guestfish.pod:116
21801 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21806 #: ../fish/guestfish.pod:118
21809 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21815 #: ../fish/guestfish.pod:120
21816 msgid "As a script interpreter"
21821 #: ../fish/guestfish.pod:122
21822 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21827 #: ../fish/guestfish.pod:124
21830 " #!/usr/bin/guestfish -f\n"
21831 " sparse test1.img 100M\n"
21833 " part-disk /dev/sda mbr\n"
21834 " mkfs ext2 /dev/sda1\n"
21840 #: ../fish/guestfish.pod:130
21841 msgid "Start with a prepared disk"
21846 #: ../fish/guestfish.pod:132
21848 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21849 "single ext2-formatted partition:"
21854 #: ../fish/guestfish.pod:135
21857 " guestfish -N fs\n"
21863 #: ../fish/guestfish.pod:137
21864 msgid "To list what is available do:"
21869 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
21872 " guestfish -N help | less\n"
21878 #: ../fish/guestfish.pod:141
21879 msgid "Remote control"
21884 #: ../fish/guestfish.pod:143
21887 " eval \"`guestfish --listen`\"\n"
21888 " guestfish --remote add-ro disk.img\n"
21889 " guestfish --remote run\n"
21890 " guestfish --remote lvs\n"
21896 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21897 #: ../fuse/guestmount.pod:73 ../tools/virt-win-reg.pl:96
21898 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21899 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21905 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:133
21906 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
21907 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21908 #: ../tools/virt-list-partitions.pl:62
21914 #: ../fish/guestfish.pod:154
21915 msgid "Displays general help on options."
21920 #: ../fish/guestfish.pod:156
21926 #: ../fish/guestfish.pod:158
21927 msgid "B<--cmd-help>"
21932 #: ../fish/guestfish.pod:160
21933 msgid "Lists all available guestfish commands."
21938 #: ../fish/guestfish.pod:162
21944 #: ../fish/guestfish.pod:164
21945 msgid "B<--cmd-help cmd>"
21950 #: ../fish/guestfish.pod:166
21951 msgid "Displays detailed help on a single command C<cmd>."
21956 #: ../fish/guestfish.pod:168
21957 msgid "B<-a image>"
21962 #: ../fish/guestfish.pod:170
21963 msgid "B<--add image>"
21968 #: ../fish/guestfish.pod:172
21969 msgid "Add a block device or virtual machine image to the shell."
21974 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21976 "The format of the disk image is auto-detected. To override this and force a "
21977 "particular format use the I<--format=..> option."
21981 #: ../fish/guestfish.pod:177
21983 "Using this flag is mostly equivalent to using the C<add> command, with "
21984 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21985 "the I<--format=...> flag was given."
21990 #: ../fish/guestfish.pod:181
21996 #: ../fish/guestfish.pod:183
21997 msgid "B<--connect URI>"
22002 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
22004 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22005 "URI to use. The default is to use the default libvirt connection."
22010 #: ../fish/guestfish.pod:189
22016 #: ../fish/guestfish.pod:191
22018 "If using the I<--listen> option and a csh-like shell, use this option. See "
22019 "section L</REMOTE CONTROL AND CSH> below."
22024 #: ../fish/guestfish.pod:194
22025 msgid "B<-d libvirt-domain>"
22030 #: ../fish/guestfish.pod:196
22031 msgid "B<--domain libvirt-domain>"
22036 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
22038 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22039 "used, then any libvirt domain can be used. However in write mode, only "
22040 "libvirt domains which are shut down can be named here."
22044 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:96
22045 msgid "Domain UUIDs can be used instead of names."
22050 #: ../fish/guestfish.pod:204
22052 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22053 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22054 "if the I<--format:...> flag was given."
22059 #: ../fish/guestfish.pod:208
22065 #: ../fish/guestfish.pod:210
22066 msgid "B<--no-dest-paths>"
22071 #: ../fish/guestfish.pod:212
22073 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22074 "to hit the tab key to complete paths on the guest filesystem, but this "
22075 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22076 "allow this feature to be disabled."
22081 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
22082 msgid "B<--echo-keys>"
22087 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:112
22089 "When prompting for keys and passphrases, guestfish normally turns echoing "
22090 "off so you cannot see what you are typing. If you are not worried about "
22091 "Tempest attacks and there is no one else in the room you can specify this "
22092 "flag to see what you are typing."
22097 #: ../fish/guestfish.pod:224
22103 #: ../fish/guestfish.pod:226
22104 msgid "B<--file file>"
22109 #: ../fish/guestfish.pod:228
22110 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22115 #: ../fish/guestfish.pod:231
22118 " #!/usr/bin/guestfish -f\n"
22124 #: ../fish/guestfish.pod:233
22125 msgid "B<--format=raw|qcow2|..>"
22130 #: ../fish/guestfish.pod:235
22131 msgid "B<--format>"
22136 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:119
22138 "The default for the I<-a> option is to auto-detect the format of the disk "
22139 "image. Using this forces the disk format for I<-a> options which follow on "
22140 "the command line. Using I<--format> with no argument switches back to auto-"
22141 "detection for subsequent I<-a> options."
22146 #: ../fish/guestfish.pod:244
22149 " guestfish --format=raw -a disk.img\n"
22155 #: ../fish/guestfish.pod:246
22156 msgid "forces raw format (no auto-detection) for C<disk.img>."
22161 #: ../fish/guestfish.pod:248
22164 " guestfish --format=raw -a disk.img --format -a another.img\n"
22170 #: ../fish/guestfish.pod:250
22172 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22173 "detection for C<another.img>."
22178 #: ../fish/guestfish.pod:253
22180 "If you have untrusted raw-format guest disk images, you should use this "
22181 "option to specify the disk format. This avoids a possible security problem "
22182 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22187 #: ../fish/guestfish.pod:258
22193 #: ../fish/guestfish.pod:260
22194 msgid "B<--inspector>"
22199 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:139
22201 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22202 "system and mount filesystems as they would be mounted on the real virtual "
22208 #: ../fish/guestfish.pod:266
22209 msgid "Typical usage is either:"
22214 #: ../fish/guestfish.pod:268
22217 " guestfish -d myguest -i\n"
22223 #: ../fish/guestfish.pod:270
22224 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22229 #: ../fish/guestfish.pod:272
22232 " guestfish --ro -d myguest -i\n"
22238 #: ../fish/guestfish.pod:274
22239 msgid "(for active domains, readonly), or specify the block device directly:"
22244 #: ../fish/guestfish.pod:276
22247 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22253 #: ../fish/guestfish.pod:278
22255 "Note that the command line syntax changed slightly over older versions of "
22256 "guestfish. You can still use the old syntax:"
22261 #: ../fish/guestfish.pod:281
22264 " guestfish [--ro] -i disk.img\n"
22270 #: ../fish/guestfish.pod:283
22273 " guestfish [--ro] -i libvirt-domain\n"
22279 #: ../fish/guestfish.pod:285
22281 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22282 "then using other commands to mount the filesystems that were found."
22287 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22288 msgid "B<--keys-from-stdin>"
22293 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:145
22295 "Read key or passphrase parameters from stdin. The default is to try to read "
22296 "passphrases from the user by opening C</dev/tty>."
22301 #: ../fish/guestfish.pod:294
22302 msgid "B<--listen>"
22307 #: ../fish/guestfish.pod:296
22309 "Fork into the background and listen for remote commands. See section L</"
22310 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22314 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22319 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:150
22321 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22322 "ATTACHING TO RUNNING DAEMONS>)."
22326 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22327 msgid "B<-m dev[:mountpoint[:options]]>"
22331 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:155
22332 msgid "B<--mount dev[:mountpoint[:options]]>"
22337 #: ../fish/guestfish.pod:308
22338 msgid "Mount the named partition or logical volume on the given mountpoint."
22343 #: ../fish/guestfish.pod:310
22344 msgid "If the mountpoint is omitted, it defaults to C</>."
22349 #: ../fish/guestfish.pod:312
22350 msgid "You have to mount something on C</> before most commands will work."
22355 #: ../fish/guestfish.pod:314
22357 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22363 #: ../fish/guestfish.pod:317
22365 "If you don't know what filesystems a disk image contains, you can either run "
22366 "guestfish without this option, then list the partitions, filesystems and LVs "
22367 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22368 "commands), or you can use the L<virt-filesystems(1)> program."
22372 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:163
22374 "The third (and rarely used) part of the mount parameter is the list of mount "
22375 "options used to mount the underlying filesystem. If this is not given, then "
22376 "the mount options are either the empty string or C<ro> (the latter if the "
22377 "I<--ro> flag is used). By specifying the mount options, you override this "
22378 "default choice. Probably the only time you would use this is to enable ACLs "
22379 "and/or extended attributes if the filesystem can support them:"
22383 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:171
22386 " -m /dev/sda1:/:acl,user_xattr\n"
22391 #: ../fish/guestfish.pod:333
22392 msgid "Using this flag is equivalent to using the C<mount-options> command."
22397 #: ../fish/guestfish.pod:335
22403 #: ../fish/guestfish.pod:337
22404 msgid "B<--no-sync>"
22409 #: ../fish/guestfish.pod:339
22411 "Disable autosync. This is enabled by default. See the discussion of "
22412 "autosync in the L<guestfs(3)> manpage."
22417 #: ../fish/guestfish.pod:342
22423 #: ../fish/guestfish.pod:344
22424 msgid "B<--new type>"
22429 #: ../fish/guestfish.pod:346
22435 #: ../fish/guestfish.pod:348
22437 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22438 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22439 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22445 #: ../fish/guestfish.pod:353
22446 msgid "B<--progress-bars>"
22451 #: ../fish/guestfish.pod:355
22452 msgid "Enable progress bars, even when guestfish is used non-interactively."
22457 #: ../fish/guestfish.pod:357
22459 "Progress bars are enabled by default when guestfish is used as an "
22460 "interactive shell."
22465 #: ../fish/guestfish.pod:360
22466 msgid "B<--no-progress-bars>"
22471 #: ../fish/guestfish.pod:362
22472 msgid "Disable progress bars."
22477 #: ../fish/guestfish.pod:364
22478 msgid "B<--remote[=pid]>"
22483 #: ../fish/guestfish.pod:366
22485 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22486 "CONTROL GUESTFISH OVER A SOCKET> below."
22491 #: ../fish/guestfish.pod:369
22497 #: ../fish/guestfish.pod:371
22503 #: ../fish/guestfish.pod:373
22505 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22506 "mounts are done read-only."
22511 #: ../fish/guestfish.pod:376
22513 "The option must always be used if the disk image or virtual machine might be "
22514 "running, and is generally recommended in cases where you don't need write "
22515 "access to the disk."
22520 #: ../fish/guestfish.pod:380
22522 "Note that prepared disk images created with I<-N> are not affected by this "
22523 "option. Also commands like C<add> are not affected - you have to specify "
22524 "the C<readonly:true> option explicitly if you need it."
22529 #: ../fish/guestfish.pod:384
22530 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22535 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:227
22536 msgid "B<--selinux>"
22541 #: ../fish/guestfish.pod:388
22542 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22547 #: ../fish/guestfish.pod:390
22553 #: ../fish/guestfish.pod:392
22554 msgid "B<--verbose>"
22559 #: ../fish/guestfish.pod:394
22561 "Enable very verbose messages. This is particularly useful if you find a bug."
22566 #: ../fish/guestfish.pod:397
22572 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
22573 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22574 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22575 msgid "B<--version>"
22580 #: ../fish/guestfish.pod:401
22581 msgid "Display the guestfish / libguestfs version number and exit."
22586 #: ../fish/guestfish.pod:403
22592 #: ../fish/guestfish.pod:405
22597 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:241
22599 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22600 "mounts are done read-write."
22604 #: ../fish/guestfish.pod:410
22605 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22610 #: ../fish/guestfish.pod:412
22616 #: ../fish/guestfish.pod:414
22617 msgid "Echo each command before executing it."
22622 #: ../fish/guestfish.pod:418
22623 msgid "COMMANDS ON COMMAND LINE"
22628 #: ../fish/guestfish.pod:420
22630 "Any additional (non-option) arguments are treated as commands to execute."
22635 #: ../fish/guestfish.pod:423
22637 "Commands to execute should be separated by a colon (C<:>), where the colon "
22638 "is a separate parameter. Thus:"
22643 #: ../fish/guestfish.pod:426
22646 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22652 #: ../fish/guestfish.pod:428
22654 "If there are no additional arguments, then we enter a shell, either an "
22655 "interactive shell with a prompt (if the input is a terminal) or a non-"
22656 "interactive shell."
22661 #: ../fish/guestfish.pod:432
22663 "In either command line mode or non-interactive shell, the first command that "
22664 "gives an error causes the whole shell to exit. In interactive mode (with a "
22665 "prompt) if a command fails, you can continue to enter commands."
22670 #: ../fish/guestfish.pod:437
22671 msgid "USING launch (OR run)"
22676 #: ../fish/guestfish.pod:439
22678 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22679 "then launch it, then mount any disks you need, and finally issue actions/"
22680 "commands. So the general order of the day is:"
22685 #: ../fish/guestfish.pod:447
22686 msgid "add or -a/--add"
22691 #: ../fish/guestfish.pod:451
22692 msgid "launch (aka run)"
22697 #: ../fish/guestfish.pod:455
22698 msgid "mount or -m/--mount"
22703 #: ../fish/guestfish.pod:459
22704 msgid "any other commands"
22709 #: ../fish/guestfish.pod:463
22711 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22712 "guest before mounting or performing any other commands."
22717 #: ../fish/guestfish.pod:466
22719 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22720 "I<--new> options were given then C<run> is done automatically, simply "
22721 "because guestfish can't perform the action you asked for without doing this."
22726 #: ../fish/guestfish.pod:471
22727 msgid "OPENING DISKS FOR READ AND WRITE"
22731 #: ../fish/guestfish.pod:473
22733 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22734 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22735 "I<-i> and I<-m> open disk images read-only or for writing."
22739 #: ../fish/guestfish.pod:478
22741 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22742 "opening disk images supplied on the command line for write. To open a disk "
22743 "image read-only you have to do I<-a image --ro>."
22748 #: ../fish/guestfish.pod:482
22750 "This matters: If you accidentally open a live VM disk image writable then "
22751 "you will cause irreversible disk corruption."
22755 #: ../fish/guestfish.pod:485
22757 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22758 "images will be opened read-only. You will have to either specify "
22759 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22760 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22761 "access for disk images specified by those other command line options."
22765 #: ../fish/guestfish.pod:492
22767 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22768 "which does nothing (it is already the default). However it is highly "
22769 "recommended that you use this option to indicate that you need write access, "
22770 "and prepare your scripts for the day when this option will be required for "
22776 #: ../fish/guestfish.pod:498
22778 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22779 "other libguestfs program apart from guestfish and guestmount."
22784 #: ../fish/guestfish.pod:501
22790 #: ../fish/guestfish.pod:503
22792 "You can quote ordinary parameters using either single or double quotes. For "
22798 #: ../fish/guestfish.pod:506
22801 " add \"file with a space.img\"\n"
22807 #: ../fish/guestfish.pod:508
22810 " rm '/file name'\n"
22816 #: ../fish/guestfish.pod:510
22825 #: ../fish/guestfish.pod:512
22827 "A few commands require a list of strings to be passed. For these, use a "
22828 "whitespace-separated list, enclosed in quotes. Strings containing "
22829 "whitespace to be passed through must be enclosed in single quotes. A "
22830 "literal single quote must be escaped with a backslash."
22835 #: ../fish/guestfish.pod:517
22838 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22839 " command \"/bin/echo 'foo bar'\"\n"
22840 " command \"/bin/echo \\'foo\\'\"\n"
22846 #: ../fish/guestfish.pod:521
22847 msgid "OPTIONAL ARGUMENTS"
22852 #: ../fish/guestfish.pod:523
22854 "Some commands take optional arguments. These arguments appear in this "
22855 "documentation as C<[argname:..]>. You can use them as in these examples:"
22860 #: ../fish/guestfish.pod:527
22863 " add-drive-opts filename\n"
22869 #: ../fish/guestfish.pod:529
22872 " add-drive-opts filename readonly:true\n"
22878 #: ../fish/guestfish.pod:531
22881 " add-drive-opts filename format:qcow2 readonly:false\n"
22887 #: ../fish/guestfish.pod:533
22889 "Each optional argument can appear at most once. All optional arguments must "
22890 "appear after the required ones."
22895 #: ../fish/guestfish.pod:536
22901 #: ../fish/guestfish.pod:538
22903 "This section applies to all commands which can take integers as parameters."
22908 #: ../fish/guestfish.pod:541
22909 msgid "SIZE SUFFIX"
22914 #: ../fish/guestfish.pod:543
22916 "When the command takes a parameter measured in bytes, you can use one of the "
22917 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22922 #: ../fish/guestfish.pod:549
22923 msgid "B<k> or B<K> or B<KiB>"
22928 #: ../fish/guestfish.pod:551
22929 msgid "The size in kilobytes (multiplied by 1024)."
22934 #: ../fish/guestfish.pod:553
22940 #: ../fish/guestfish.pod:555
22941 msgid "The size in SI 1000 byte units."
22946 #: ../fish/guestfish.pod:557
22947 msgid "B<M> or B<MiB>"
22952 #: ../fish/guestfish.pod:559
22953 msgid "The size in megabytes (multiplied by 1048576)."
22958 #: ../fish/guestfish.pod:561
22964 #: ../fish/guestfish.pod:563
22965 msgid "The size in SI 1000000 byte units."
22970 #: ../fish/guestfish.pod:565
22971 msgid "B<G> or B<GiB>"
22976 #: ../fish/guestfish.pod:567
22977 msgid "The size in gigabytes (multiplied by 2**30)."
22982 #: ../fish/guestfish.pod:569
22988 #: ../fish/guestfish.pod:571
22989 msgid "The size in SI 10**9 byte units."
22994 #: ../fish/guestfish.pod:573
22995 msgid "B<T> or B<TiB>"
23000 #: ../fish/guestfish.pod:575
23001 msgid "The size in terabytes (multiplied by 2**40)."
23006 #: ../fish/guestfish.pod:577
23012 #: ../fish/guestfish.pod:579
23013 msgid "The size in SI 10**12 byte units."
23018 #: ../fish/guestfish.pod:581
23019 msgid "B<P> or B<PiB>"
23024 #: ../fish/guestfish.pod:583
23025 msgid "The size in petabytes (multiplied by 2**50)."
23030 #: ../fish/guestfish.pod:585
23036 #: ../fish/guestfish.pod:587
23037 msgid "The size in SI 10**15 byte units."
23042 #: ../fish/guestfish.pod:589
23043 msgid "B<E> or B<EiB>"
23048 #: ../fish/guestfish.pod:591
23049 msgid "The size in exabytes (multiplied by 2**60)."
23054 #: ../fish/guestfish.pod:593
23060 #: ../fish/guestfish.pod:595
23061 msgid "The size in SI 10**18 byte units."
23066 #: ../fish/guestfish.pod:597
23067 msgid "B<Z> or B<ZiB>"
23072 #: ../fish/guestfish.pod:599
23073 msgid "The size in zettabytes (multiplied by 2**70)."
23078 #: ../fish/guestfish.pod:601
23084 #: ../fish/guestfish.pod:603
23085 msgid "The size in SI 10**21 byte units."
23090 #: ../fish/guestfish.pod:605
23091 msgid "B<Y> or B<YiB>"
23096 #: ../fish/guestfish.pod:607
23097 msgid "The size in yottabytes (multiplied by 2**80)."
23102 #: ../fish/guestfish.pod:609
23108 #: ../fish/guestfish.pod:611
23109 msgid "The size in SI 10**24 byte units."
23114 #: ../fish/guestfish.pod:617
23117 " truncate-size /file 1G\n"
23123 #: ../fish/guestfish.pod:619
23124 msgid "would truncate the file to 1 gigabyte."
23129 #: ../fish/guestfish.pod:621
23131 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23132 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23133 "suffix will probably not do what you expect."
23138 #: ../fish/guestfish.pod:625
23139 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23144 #: ../fish/guestfish.pod:627
23146 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23147 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23152 #: ../fish/guestfish.pod:630
23155 " 1234 decimal number 1234\n"
23156 " 02322 octal number, equivalent to decimal 1234\n"
23157 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23163 #: ../fish/guestfish.pod:634
23165 "When using the C<chmod> command, you almost always want to specify an octal "
23166 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23167 "L<chmod(1)> program):"
23172 #: ../fish/guestfish.pod:638
23175 " chmod 0777 /public # OK\n"
23176 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23182 #: ../fish/guestfish.pod:641
23184 "Commands that return numbers usually print them in decimal, but some "
23185 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23186 "octal, preceeded by C<0>)."
23191 #: ../fish/guestfish.pod:645
23192 msgid "WILDCARDS AND GLOBBING"
23197 #: ../fish/guestfish.pod:647
23199 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23200 "(globbing) by default. So for example the following will not do what you "
23206 #: ../fish/guestfish.pod:651
23215 #: ../fish/guestfish.pod:653
23217 "Assuming you don't have a directory called literally C</home/*> then the "
23218 "above command will return an error."
23223 #: ../fish/guestfish.pod:656
23224 msgid "To perform wildcard expansion, use the C<glob> command."
23229 #: ../fish/guestfish.pod:658
23232 " glob rm-rf /home/*\n"
23238 #: ../fish/guestfish.pod:660
23240 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23241 "many times), equivalent to:"
23246 #: ../fish/guestfish.pod:663
23249 " rm-rf /home/jim\n"
23250 " rm-rf /home/joe\n"
23251 " rm-rf /home/mary\n"
23257 #: ../fish/guestfish.pod:667
23258 msgid "C<glob> only works on simple guest paths and not on device names."
23263 #: ../fish/guestfish.pod:669
23265 "If you have several parameters, each containing a wildcard, then glob will "
23266 "perform a Cartesian product."
23271 #: ../fish/guestfish.pod:672
23277 #: ../fish/guestfish.pod:674
23279 "Any line which starts with a I<#> character is treated as a comment and "
23280 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23281 "a command. For example:"
23286 #: ../fish/guestfish.pod:678
23289 " # this is a comment\n"
23290 " # this is a comment\n"
23291 " foo # NOT a comment\n"
23297 #: ../fish/guestfish.pod:682
23298 msgid "Blank lines are also ignored."
23303 #: ../fish/guestfish.pod:684
23304 msgid "RUNNING COMMANDS LOCALLY"
23309 #: ../fish/guestfish.pod:686
23311 "Any line which starts with a I<!> character is treated as a command sent to "
23312 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23317 #: ../fish/guestfish.pod:690
23321 " tgz-out /remote local/remote-data.tar.gz\n"
23327 #: ../fish/guestfish.pod:693
23329 "will create a directory C<local> on the host, and then export the contents "
23330 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23331 "(See C<tgz-out>)."
23336 #: ../fish/guestfish.pod:697
23338 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23339 "effect, due to the way that subprocesses work in Unix."
23343 #: ../fish/guestfish.pod:700
23344 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23348 #: ../fish/guestfish.pod:702
23350 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23351 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23352 "and executed as guestfish commands."
23356 #: ../fish/guestfish.pod:706
23358 "Thus you can use shell script to construct arbitrary guestfish commands "
23359 "which are then parsed by guestfish."
23363 #: ../fish/guestfish.pod:709
23365 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23366 "through C</foo.100>) using guestfish commands alone. However this is simple "
23367 "if we use a shell script to create the guestfish commands for us:"
23371 #: ../fish/guestfish.pod:714
23374 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23379 #: ../fish/guestfish.pod:716
23380 msgid "or with names like C</foo.001>:"
23384 #: ../fish/guestfish.pod:718
23387 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23392 #: ../fish/guestfish.pod:720
23394 "When using guestfish interactively it can be helpful to just run the shell "
23395 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23396 "ordinary I<!> local command), see what guestfish commands it would run, and "
23397 "when you are happy with those prepend the C<E<lt>> character to run the "
23398 "guestfish commands for real."
23403 #: ../fish/guestfish.pod:726
23409 #: ../fish/guestfish.pod:728
23411 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23412 "command (a guestfish command) to the second command (any host command). For "
23418 #: ../fish/guestfish.pod:732
23421 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23427 #: ../fish/guestfish.pod:734
23429 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23430 "program). The above command would list all accounts in the guest filesystem "
23431 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23436 #: ../fish/guestfish.pod:739
23439 " hexdump /bin/ls | head\n"
23440 " list-devices | tail -1\n"
23441 " tgz-out / - | tar ztf -\n"
23447 #: ../fish/guestfish.pod:743
23449 "The space before the pipe symbol is required, any space after the pipe "
23450 "symbol is optional. Everything after the pipe symbol is just passed "
23451 "straight to the host shell, so it can contain redirections, globs and "
23452 "anything else that makes sense on the host side."
23457 #: ../fish/guestfish.pod:748
23459 "To use a literal argument which begins with a pipe symbol, you have to quote "
23465 #: ../fish/guestfish.pod:751
23474 #: ../fish/guestfish.pod:753
23475 msgid "HOME DIRECTORIES"
23480 #: ../fish/guestfish.pod:755
23482 "If a parameter starts with the character C<~> then the tilde may be expanded "
23483 "as a home directory path (either C<~> for the current user's home directory, "
23484 "or C<~user> for another user)."
23489 #: ../fish/guestfish.pod:759
23491 "Note that home directory expansion happens for users known I<on the host>, "
23492 "not in the guest filesystem."
23497 #: ../fish/guestfish.pod:762
23499 "To use a literal argument which begins with a tilde, you have to quote it, "
23505 #: ../fish/guestfish.pod:765
23514 #: ../fish/guestfish.pod:769
23516 "Libguestfs has some support for Linux guests encrypted according to the "
23517 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23518 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23519 "LUKS is supported."
23524 #: ../fish/guestfish.pod:774
23525 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23530 #: ../fish/guestfish.pod:776
23533 " ><fs> vfs-type /dev/sda2\n"
23540 #: ../fish/guestfish.pod:779
23542 "Then open those devices using L</luks-open>. This creates a device-mapper "
23543 "device called C</dev/mapper/luksdev>."
23548 #: ../fish/guestfish.pod:782
23551 " ><fs> luks-open /dev/sda2 luksdev\n"
23552 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23558 #: ../fish/guestfish.pod:785
23560 "Finally you have to tell LVM to scan for volume groups on the newly created "
23566 #: ../fish/guestfish.pod:788
23570 " vg-activate-all true\n"
23576 #: ../fish/guestfish.pod:791
23577 msgid "The logical volume(s) can now be mounted in the usual way."
23582 #: ../fish/guestfish.pod:793
23584 "Before closing a LUKS device you must unmount any logical volumes on it and "
23585 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23586 "one. Then you can close the mapper device:"
23591 #: ../fish/guestfish.pod:797
23594 " vg-activate false /dev/VG\n"
23595 " luks-close /dev/mapper/luksdev\n"
23601 #: ../fish/guestfish.pod:800
23602 msgid "WINDOWS PATHS"
23606 #: ../fish/guestfish.pod:802
23608 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23609 "letters and paths (with some limitations). The following commands are "
23615 #: ../fish/guestfish.pod:806
23618 " file /WINDOWS/system32/config/system.LOG\n"
23624 #: ../fish/guestfish.pod:808
23627 " file win:\\windows\\system32\\config\\system.log\n"
23632 #: ../fish/guestfish.pod:810
23635 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23640 #: ../fish/guestfish.pod:812
23642 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23643 "where the drive is mounted, prepending that to the path, changing all "
23644 "backslash characters to forward slash, then resolving the result using L</"
23645 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23646 "the parameter might be rewritten like this:"
23650 #: ../fish/guestfish.pod:818
23653 " win:e:\\foo\\bar => /e/FOO/bar\n"
23658 #: ../fish/guestfish.pod:820
23659 msgid "This only works in argument positions that expect a path."
23664 #: ../fish/guestfish.pod:822
23665 msgid "UPLOADING AND DOWNLOADING FILES"
23670 #: ../fish/guestfish.pod:824
23672 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23673 "others which upload from or download to a local file, you can use the "
23674 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23679 #: ../fish/guestfish.pod:828
23688 #: ../fish/guestfish.pod:830
23690 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23695 #: ../fish/guestfish.pod:833
23698 " tar-out /etc - | tar tf -\n"
23704 #: ../fish/guestfish.pod:835
23706 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23707 "command (see L</PIPES>)."
23712 #: ../fish/guestfish.pod:838
23714 "When using C<-> to read from stdin, the input is read up to the end of "
23715 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23716 "some arbitrary end marker:"
23721 #: ../fish/guestfish.pod:842
23724 " upload -<<END /foo\n"
23734 #: ../fish/guestfish.pod:848
23736 "Any string of characters can be used instead of C<END>. The end marker must "
23737 "appear on a line of its own, without any preceeding or following characters "
23738 "(not even spaces)."
23743 #: ../fish/guestfish.pod:852
23745 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23746 "upload local files (so-called \"FileIn\" parameters in the generator)."
23751 #: ../fish/guestfish.pod:855
23752 msgid "EXIT ON ERROR BEHAVIOUR"
23757 #: ../fish/guestfish.pod:857
23759 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23760 "taking commands from a human over a tty), and will exit on the first error "
23761 "in non-interactive mode (scripts, commands given on the command line)."
23766 #: ../fish/guestfish.pod:862
23768 "If you prefix a command with a I<-> character, then that command will not "
23769 "cause guestfish to exit, even if that (one) command returns an error."
23774 #: ../fish/guestfish.pod:866
23775 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23780 #: ../fish/guestfish.pod:868
23782 "Guestfish can be remote-controlled over a socket. This is useful "
23783 "particularly in shell scripts where you want to make several different "
23784 "changes to a filesystem, but you don't want the overhead of starting up a "
23785 "guestfish process each time."
23790 #: ../fish/guestfish.pod:873
23791 msgid "Start a guestfish server process using:"
23796 #: ../fish/guestfish.pod:875
23799 " eval \"`guestfish --listen`\"\n"
23805 #: ../fish/guestfish.pod:877
23806 msgid "and then send it commands by doing:"
23811 #: ../fish/guestfish.pod:879
23814 " guestfish --remote cmd [...]\n"
23820 #: ../fish/guestfish.pod:881
23821 msgid "To cause the server to exit, send it the exit command:"
23826 #: ../fish/guestfish.pod:883
23829 " guestfish --remote exit\n"
23835 #: ../fish/guestfish.pod:885
23837 "Note that the server will normally exit if there is an error in a command. "
23838 "You can change this in the usual way. See section L</EXIT ON ERROR "
23844 #: ../fish/guestfish.pod:889
23845 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23850 #: ../fish/guestfish.pod:891
23852 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23853 "is how the I<--remote> option knows where to send the commands. You can "
23854 "have several guestfish listener processes running using:"
23859 #: ../fish/guestfish.pod:895
23862 " eval \"`guestfish --listen`\"\n"
23863 " pid1=$GUESTFISH_PID\n"
23864 " eval \"`guestfish --listen`\"\n"
23865 " pid2=$GUESTFISH_PID\n"
23867 " guestfish --remote=$pid1 cmd\n"
23868 " guestfish --remote=$pid2 cmd\n"
23874 #: ../fish/guestfish.pod:903
23875 msgid "REMOTE CONTROL AND CSH"
23880 #: ../fish/guestfish.pod:905
23882 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23888 #: ../fish/guestfish.pod:908
23891 " eval \"`guestfish --listen --csh`\"\n"
23897 #: ../fish/guestfish.pod:910
23898 msgid "REMOTE CONTROL DETAILS"
23903 #: ../fish/guestfish.pod:912
23905 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23906 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23907 "and C<$PID> is the process ID of the server."
23912 #: ../fish/guestfish.pod:916
23913 msgid "Guestfish client and server versions must match exactly."
23918 #: ../fish/guestfish.pod:918
23919 msgid "PREPARED DISK IMAGES"
23924 #: ../fish/guestfish.pod:920
23926 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23927 "preformatted disk images that guestfish can make for you to save typing. "
23928 "This is particularly useful for testing purposes. This option is used "
23929 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23930 "can be mixed with I<-a>)."
23935 #: ../fish/guestfish.pod:926
23937 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23938 "the second and so on. Existing files in the current directory are "
23944 #: ../fish/guestfish.pod:930
23946 "The type briefly describes how the disk should be sized, partitioned, how "
23947 "filesystem(s) should be created, and how content should be added. "
23948 "Optionally the type can be followed by extra parameters, separated by C<:> "
23949 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23950 "allocated disk, containing a single partition, with the partition formatted "
23951 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23957 #: ../fish/guestfish.pod:938
23958 msgid "To list the available types and any extra parameters they take, run:"
23963 #: ../fish/guestfish.pod:942
23965 "Note that the prepared filesystem is not mounted. You would usually have to "
23966 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23971 #: ../fish/guestfish.pod:946
23973 "If any I<-N> or I<--new> options are given, the guest is automatically "
23979 #: ../fish/guestfish.pod:951
23980 msgid "Create a 100MB disk with an ext4-formatted partition:"
23985 #: ../fish/guestfish.pod:953
23988 " guestfish -N fs:ext4\n"
23994 #: ../fish/guestfish.pod:955
23995 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24000 #: ../fish/guestfish.pod:957
24003 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24009 #: ../fish/guestfish.pod:959
24010 msgid "Create a blank 200MB disk:"
24015 #: ../fish/guestfish.pod:961
24018 " guestfish -N disk:200M\n"
24024 #: ../fish/guestfish.pod:963
24025 msgid "PROGRESS BARS"
24030 #: ../fish/guestfish.pod:965
24032 "Some (not all) long-running commands send progress notification messages as "
24033 "they are running. Guestfish turns these messages into progress bars."
24038 #: ../fish/guestfish.pod:969
24040 "When a command that supports progress bars takes longer than two seconds to "
24041 "run, and if progress bars are enabled, then you will see one appearing below "
24047 #: ../fish/guestfish.pod:973
24050 " ><fs> copy-size /large-file /another-file 2048M\n"
24051 " / 10% [#####-----------------------------------------] 00:30\n"
24057 #: ../fish/guestfish.pod:976
24059 "The spinner on the left hand side moves round once for every progress "
24060 "notification received from the backend. This is a (reasonably) golden "
24061 "assurance that the command is \"doing something\" even if the progress bar "
24062 "is not moving, because the command is able to send the progress "
24063 "notifications. When the bar reaches 100% and the command finishes, the "
24064 "spinner disappears."
24069 #: ../fish/guestfish.pod:983
24071 "Progress bars are enabled by default when guestfish is used interactively. "
24072 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24073 "and you can disable them completely using I<--no-progress-bars>."
24078 #: ../fish/guestfish.pod:988
24079 msgid "GUESTFISH COMMANDS"
24084 #: ../fish/guestfish.pod:990
24086 "The commands in this section are guestfish convenience commands, in other "
24087 "words, they are not part of the L<guestfs(3)> API."
24092 #: ../fish/guestfish.pod:993
24098 #: ../fish/guestfish.pod:995
24108 #: ../fish/guestfish.pod:998
24109 msgid "Without any parameter, this provides general help."
24114 #: ../fish/guestfish.pod:1000
24115 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24120 #: ../fish/guestfish.pod:1002
24121 msgid "quit | exit"
24126 #: ../fish/guestfish.pod:1004
24127 msgid "This exits guestfish. You can also use C<^D> key."
24132 #: ../fish/guestfish.pod:1006
24133 msgid "@FISH_COMMANDS@"
24138 #: ../fish/guestfish.pod:1008
24144 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24150 #: ../fish/guestfish.pod:1014
24152 "guestfish returns 0 if the commands completed without error, or 1 if there "
24158 #: ../fish/guestfish.pod:1021
24164 #: ../fish/guestfish.pod:1023
24166 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24172 #: ../fish/guestfish.pod:1026
24173 msgid "GUESTFISH_PID"
24178 #: ../fish/guestfish.pod:1028
24180 "Used with the I<--remote> option to specify the remote guestfish process to "
24181 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24186 #: ../fish/guestfish.pod:1032
24192 #: ../fish/guestfish.pod:1034
24194 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24195 "not specified, the external L<hexedit(1)> program is used."
24200 #: ../fish/guestfish.pod:1038
24206 #: ../fish/guestfish.pod:1040
24208 "If compiled with GNU readline support, various files in the home directory "
24209 "can be used. See L</FILES>."
24214 #: ../fish/guestfish.pod:1049
24216 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24217 "effect as using the B<-v> option."
24222 #: ../fish/guestfish.pod:1061
24224 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24225 "the discussion of paths in L<guestfs(3)>."
24230 #: ../fish/guestfish.pod:1072
24231 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24236 #: ../fish/guestfish.pod:1074
24242 #: ../fish/guestfish.pod:1076
24244 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24250 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:254
24255 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
24256 msgid "$HOME/.libguestfs-tools.rc"
24260 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
24261 msgid "/etc/libguestfs-tools.conf"
24265 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:262
24267 "This configuration file controls the default read-only or read-write mode "
24268 "(I<--ro> or I<--rw>)."
24272 #: ../fish/guestfish.pod:1103
24273 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24278 #: ../fish/guestfish.pod:1105
24279 msgid "$HOME/.guestfish"
24284 #: ../fish/guestfish.pod:1107
24286 "If compiled with GNU readline support, then the command history is saved in "
24292 #: ../fish/guestfish.pod:1110
24293 msgid "$HOME/.inputrc"
24298 #: ../fish/guestfish.pod:1112
24299 msgid "/etc/inputrc"
24304 #: ../fish/guestfish.pod:1114
24306 "If compiled with GNU readline support, then these files can be used to "
24307 "configure readline. For further information, please see L<readline(3)/"
24308 "INITIALIZATION FILE>."
24313 #: ../fish/guestfish.pod:1118
24314 msgid "To write rules which only apply to guestfish, use:"
24319 #: ../fish/guestfish.pod:1120
24330 #: ../fish/guestfish.pod:1124
24332 "Variables that you can set in inputrc that change the behaviour of guestfish "
24333 "in useful ways include:"
24338 #: ../fish/guestfish.pod:1129
24339 msgid "completion-ignore-case (default: on)"
24344 #: ../fish/guestfish.pod:1131
24346 "By default, guestfish will ignore case when tab-completing paths on the "
24352 #: ../fish/guestfish.pod:1134
24355 " set completion-ignore-case off\n"
24361 #: ../fish/guestfish.pod:1136
24362 msgid "to make guestfish case sensitive."
24367 #: ../fish/guestfish.pod:1140
24373 #: ../fish/guestfish.pod:1142
24374 msgid "test2.img (etc)"
24378 #: ../fish/guestfish.pod:1144
24380 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24381 "will be created in the file C<test1.img> in the current directory. The "
24382 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24383 "the same name will be overwritten."
24387 #: ../fish/guestfish.pod:1153
24389 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24390 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24391 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24392 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24393 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24394 ">, L<hexedit(1)>."
24399 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102
24400 #: ../fuse/guestmount.pod:289 ../tools/virt-win-reg.pl:777
24401 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24402 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24404 "This program is free software; you can redistribute it and/or modify it "
24405 "under the terms of the GNU General Public License as published by the Free "
24406 "Software Foundation; either version 2 of the License, or (at your option) "
24407 "any later version."
24412 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107
24413 #: ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:782
24414 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24415 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24417 "This program is distributed in the hope that it will be useful, but WITHOUT "
24418 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24419 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24425 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112
24426 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:787
24427 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24428 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24430 "You should have received a copy of the GNU General Public License along with "
24431 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24432 "Ave, Cambridge, MA 02139, USA."
24437 #: ../fish/guestfish-actions.pod:1
24443 #: ../fish/guestfish-actions.pod:3
24446 " add-cdrom filename\n"
24452 #: ../fish/guestfish-actions.pod:15
24454 "This call checks for the existence of C<filename>. This stops you from "
24455 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24456 "and C<http:> URLs. To specify those, use the general L</config> call "
24462 #: ../fish/guestfish-actions.pod:22
24464 "If you just want to add an ISO file (often you use this as an efficient way "
24465 "to transfer large files into the guest), then you should probably use L</add-"
24466 "drive-ro> instead."
24471 #: ../fish/guestfish-actions.pod:35
24477 #: ../fish/guestfish-actions.pod:37
24482 #: ../fish/guestfish-actions.pod:39
24485 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
24491 #: ../fish/guestfish-actions.pod:41
24493 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24494 "It works by connecting to libvirt, requesting the domain and domain XML from "
24495 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24500 #: ../fish/guestfish-actions.pod:76
24502 "The other optional parameters are passed directly through to L</add-drive-"
24508 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
24509 #: ../fish/guestfish-actions.pod:3052
24511 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24516 #: ../fish/guestfish-actions.pod:81
24522 #: ../fish/guestfish-actions.pod:83
24525 " add-drive filename\n"
24531 #: ../fish/guestfish-actions.pod:85
24533 "This function is the equivalent of calling L</add-drive-opts> with no "
24534 "optional parameters, so the disk is added writable, with the format being "
24535 "detected automatically."
24540 #: ../fish/guestfish-actions.pod:89
24542 "Automatic detection of the format opens you up to a potential security hole "
24543 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24544 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24545 "you should think about replacing calls to this function with calls to L</add-"
24546 "drive-opts>, and specifying the format."
24551 #: ../fish/guestfish-actions.pod:96
24552 msgid "add-drive-opts"
24557 #: ../fish/guestfish-actions.pod:98
24563 #: ../fish/guestfish-actions.pod:100
24566 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24572 #: ../fish/guestfish-actions.pod:127
24574 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24575 "add-drive-ro>) then the format is automatically detected. Possible formats "
24576 "include C<raw> and C<qcow2>."
24581 #: ../fish/guestfish-actions.pod:138
24583 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24584 "add-drive-with-if> call (q.v.)"
24589 #: ../fish/guestfish-actions.pod:145
24590 msgid "add-drive-ro"
24595 #: ../fish/guestfish-actions.pod:147
24601 #: ../fish/guestfish-actions.pod:149
24604 " add-drive-ro filename\n"
24610 #: ../fish/guestfish-actions.pod:151
24612 "This function is the equivalent of calling L</add-drive-opts> with the "
24613 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24614 "is added read-only, with the format being detected automatically."
24619 #: ../fish/guestfish-actions.pod:156
24620 msgid "add-drive-ro-with-if"
24625 #: ../fish/guestfish-actions.pod:158
24628 " add-drive-ro-with-if filename iface\n"
24634 #: ../fish/guestfish-actions.pod:160
24636 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24637 "interface emulation to use at run time."
24642 #: ../fish/guestfish-actions.pod:170
24643 msgid "add-drive-with-if"
24648 #: ../fish/guestfish-actions.pod:172
24651 " add-drive-with-if filename iface\n"
24657 #: ../fish/guestfish-actions.pod:174
24659 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24660 "interface emulation to use at run time."
24665 #: ../fish/guestfish-actions.pod:184
24671 #: ../fish/guestfish-actions.pod:186
24674 " aug-clear augpath\n"
24680 #: ../fish/guestfish-actions.pod:191
24686 #: ../fish/guestfish-actions.pod:193
24695 #: ../fish/guestfish-actions.pod:195
24697 "Close the current Augeas handle and free up any resources used by it. After "
24698 "calling this, you have to call L</aug-init> again before you can use any "
24699 "other Augeas functions."
24704 #: ../fish/guestfish-actions.pod:200
24705 msgid "aug-defnode"
24710 #: ../fish/guestfish-actions.pod:202
24713 " aug-defnode name expr val\n"
24719 #: ../fish/guestfish-actions.pod:207
24721 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24722 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24723 "containing that single node."
24728 #: ../fish/guestfish-actions.pod:215
24734 #: ../fish/guestfish-actions.pod:217
24737 " aug-defvar name expr\n"
24743 #: ../fish/guestfish-actions.pod:226
24749 #: ../fish/guestfish-actions.pod:228
24752 " aug-get augpath\n"
24758 #: ../fish/guestfish-actions.pod:233
24764 #: ../fish/guestfish-actions.pod:235
24767 " aug-init root flags\n"
24773 #: ../fish/guestfish-actions.pod:241
24774 msgid "You must call this before using any other L</aug-*> commands."
24779 #: ../fish/guestfish-actions.pod:276
24780 msgid "Do not load the tree in L</aug-init>."
24785 #: ../fish/guestfish-actions.pod:280
24786 msgid "To close the handle, you can call L</aug-close>."
24791 #: ../fish/guestfish-actions.pod:284
24797 #: ../fish/guestfish-actions.pod:286
24800 " aug-insert augpath label true|false\n"
24806 #: ../fish/guestfish-actions.pod:296
24812 #: ../fish/guestfish-actions.pod:298
24821 #: ../fish/guestfish-actions.pod:305
24827 #: ../fish/guestfish-actions.pod:307
24830 " aug-ls augpath\n"
24836 #: ../fish/guestfish-actions.pod:309
24838 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24839 "resulting nodes into alphabetical order."
24844 #: ../fish/guestfish-actions.pod:312
24850 #: ../fish/guestfish-actions.pod:314
24853 " aug-match augpath\n"
24859 #: ../fish/guestfish-actions.pod:320
24865 #: ../fish/guestfish-actions.pod:322
24868 " aug-mv src dest\n"
24874 #: ../fish/guestfish-actions.pod:327
24880 #: ../fish/guestfish-actions.pod:329
24883 " aug-rm augpath\n"
24889 #: ../fish/guestfish-actions.pod:335
24895 #: ../fish/guestfish-actions.pod:337
24904 #: ../fish/guestfish-actions.pod:341
24906 "The flags which were passed to L</aug-init> affect exactly how files are "
24912 #: ../fish/guestfish-actions.pod:344
24918 #: ../fish/guestfish-actions.pod:346
24921 " aug-set augpath val\n"
24927 #: ../fish/guestfish-actions.pod:350
24929 "In the Augeas API, it is possible to clear a node by setting the value to "
24930 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24931 "this call. Instead you must use the L</aug-clear> call."
24936 #: ../fish/guestfish-actions.pod:355
24942 #: ../fish/guestfish-actions.pod:357
24945 " available 'groups ...'\n"
24951 #: ../fish/guestfish-actions.pod:363
24953 "The libguestfs groups, and the functions that those groups correspond to, "
24954 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24955 "runtime by calling L</available-all-groups>."
24960 #: ../fish/guestfish-actions.pod:387
24961 msgid "You must call L</launch> before calling this function."
24966 #: ../fish/guestfish-actions.pod:409
24968 "This call was added in version C<1.0.80>. In previous versions of "
24969 "libguestfs all you could do would be to speculatively execute a command to "
24970 "find out if the daemon implemented it. See also L</version>."
24975 #: ../fish/guestfish-actions.pod:416
24976 msgid "available-all-groups"
24981 #: ../fish/guestfish-actions.pod:418
24984 " available-all-groups\n"
24990 #: ../fish/guestfish-actions.pod:420
24992 "This command returns a list of all optional groups that this daemon knows "
24993 "about. Note this returns both supported and unsupported groups. To find "
24994 "out which ones the daemon can actually support you have to call L</"
24995 "available> on each member of the returned list."
25000 #: ../fish/guestfish-actions.pod:426
25001 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25006 #: ../fish/guestfish-actions.pod:428
25012 #: ../fish/guestfish-actions.pod:430
25015 " base64-in (base64file|-) filename\n"
25021 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25022 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
25023 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1233
25024 #: ../fish/guestfish-actions.pod:4485 ../fish/guestfish-actions.pod:4497
25025 #: ../fish/guestfish-actions.pod:4508 ../fish/guestfish-actions.pod:4519
25026 #: ../fish/guestfish-actions.pod:4571 ../fish/guestfish-actions.pod:4580
25027 #: ../fish/guestfish-actions.pod:4634 ../fish/guestfish-actions.pod:4657
25028 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25033 #: ../fish/guestfish-actions.pod:437
25039 #: ../fish/guestfish-actions.pod:439
25042 " base64-out filename (base64file|-)\n"
25048 #: ../fish/guestfish-actions.pod:446
25049 msgid "blockdev-flushbufs"
25054 #: ../fish/guestfish-actions.pod:448
25057 " blockdev-flushbufs device\n"
25063 #: ../fish/guestfish-actions.pod:455
25064 msgid "blockdev-getbsz"
25069 #: ../fish/guestfish-actions.pod:457
25072 " blockdev-getbsz device\n"
25078 #: ../fish/guestfish-actions.pod:466
25079 msgid "blockdev-getro"
25084 #: ../fish/guestfish-actions.pod:468
25087 " blockdev-getro device\n"
25093 #: ../fish/guestfish-actions.pod:475
25094 msgid "blockdev-getsize64"
25099 #: ../fish/guestfish-actions.pod:477
25102 " blockdev-getsize64 device\n"
25108 #: ../fish/guestfish-actions.pod:481
25109 msgid "See also L</blockdev-getsz>."
25114 #: ../fish/guestfish-actions.pod:485
25115 msgid "blockdev-getss"
25120 #: ../fish/guestfish-actions.pod:487
25123 " blockdev-getss device\n"
25129 #: ../fish/guestfish-actions.pod:492
25131 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25136 #: ../fish/guestfish-actions.pod:497
25137 msgid "blockdev-getsz"
25142 #: ../fish/guestfish-actions.pod:499
25145 " blockdev-getsz device\n"
25151 #: ../fish/guestfish-actions.pod:504
25153 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25154 "blockdev-getsize64> for the more useful I<size in bytes>."
25159 #: ../fish/guestfish-actions.pod:510
25160 msgid "blockdev-rereadpt"
25165 #: ../fish/guestfish-actions.pod:512
25168 " blockdev-rereadpt device\n"
25174 #: ../fish/guestfish-actions.pod:518
25175 msgid "blockdev-setbsz"
25180 #: ../fish/guestfish-actions.pod:520
25183 " blockdev-setbsz device blocksize\n"
25189 #: ../fish/guestfish-actions.pod:529
25190 msgid "blockdev-setro"
25195 #: ../fish/guestfish-actions.pod:531
25198 " blockdev-setro device\n"
25204 #: ../fish/guestfish-actions.pod:537
25205 msgid "blockdev-setrw"
25210 #: ../fish/guestfish-actions.pod:539
25213 " blockdev-setrw device\n"
25219 #: ../fish/guestfish-actions.pod:545
25220 msgid "case-sensitive-path"
25225 #: ../fish/guestfish-actions.pod:547
25228 " case-sensitive-path path\n"
25234 #: ../fish/guestfish-actions.pod:571
25236 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25237 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25238 "the directories were originally created under Windows)."
25243 #: ../fish/guestfish-actions.pod:579
25244 msgid "See also L</realpath>."
25249 #: ../fish/guestfish-actions.pod:581
25255 #: ../fish/guestfish-actions.pod:583
25264 #: ../fish/guestfish-actions.pod:587
25266 "Note that this function cannot correctly handle binary files (specifically, "
25267 "files containing C<\\0> character which is treated as end of string). For "
25268 "those you need to use the L</read-file> or L</download> functions which have "
25269 "a more complex interface."
25274 #: ../fish/guestfish-actions.pod:595
25280 #: ../fish/guestfish-actions.pod:597
25283 " checksum csumtype path\n"
25289 #: ../fish/guestfish-actions.pod:640
25290 msgid "To get the checksum for a device, use L</checksum-device>."
25295 #: ../fish/guestfish-actions.pod:642
25296 msgid "To get the checksums for many files, use L</checksums-out>."
25301 #: ../fish/guestfish-actions.pod:644
25302 msgid "checksum-device"
25307 #: ../fish/guestfish-actions.pod:646
25310 " checksum-device csumtype device\n"
25316 #: ../fish/guestfish-actions.pod:648
25318 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25319 "device named C<device>. For the types of checksums supported see the L</"
25320 "checksum> command."
25325 #: ../fish/guestfish-actions.pod:652
25326 msgid "checksums-out"
25331 #: ../fish/guestfish-actions.pod:654
25334 " checksums-out csumtype directory (sumsfile|-)\n"
25340 #: ../fish/guestfish-actions.pod:670
25346 #: ../fish/guestfish-actions.pod:672
25349 " chmod mode path\n"
25355 #: ../fish/guestfish-actions.pod:683
25361 #: ../fish/guestfish-actions.pod:685
25364 " chown owner group path\n"
25370 #: ../fish/guestfish-actions.pod:693
25376 #: ../fish/guestfish-actions.pod:695
25379 " command 'arguments ...'\n"
25385 #: ../fish/guestfish-actions.pod:702
25387 "The single parameter is an argv-style list of arguments. The first element "
25388 "is the name of the program to run. Subsequent elements are parameters. The "
25389 "list must be non-empty (ie. must contain a program name). Note that the "
25390 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25395 #: ../fish/guestfish-actions.pod:730
25396 msgid "command-lines"
25401 #: ../fish/guestfish-actions.pod:732
25404 " command-lines 'arguments ...'\n"
25410 #: ../fish/guestfish-actions.pod:734
25412 "This is the same as L</command>, but splits the result into a list of lines."
25417 #: ../fish/guestfish-actions.pod:737
25418 msgid "See also: L</sh-lines>"
25423 #: ../fish/guestfish-actions.pod:742
25429 #: ../fish/guestfish-actions.pod:744
25432 " config qemuparam qemuvalue\n"
25438 #: ../fish/guestfish-actions.pod:755
25444 #: ../fish/guestfish-actions.pod:757
25447 " copy-size src dest size\n"
25453 #: ../fish/guestfish-actions.pod:765
25459 #: ../fish/guestfish-actions.pod:767
25468 #: ../fish/guestfish-actions.pod:772
25474 #: ../fish/guestfish-actions.pod:774
25483 #: ../fish/guestfish-actions.pod:779
25489 #: ../fish/guestfish-actions.pod:781
25498 #: ../fish/guestfish-actions.pod:788
25500 "If the destination is a device, it must be as large or larger than the "
25501 "source file or device, otherwise the copy will fail. This command cannot do "
25502 "partial copies (see L</copy-size>)."
25507 #: ../fish/guestfish-actions.pod:792
25513 #: ../fish/guestfish-actions.pod:794
25522 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
25524 "This command is mostly useful for interactive sessions. It is I<not> "
25525 "intended that you try to parse the output string. Use L</statvfs> from "
25531 #: ../fish/guestfish-actions.pod:802
25537 #: ../fish/guestfish-actions.pod:804
25546 #: ../fish/guestfish-actions.pod:813
25552 #: ../fish/guestfish-actions.pod:815
25561 #: ../fish/guestfish-actions.pod:821
25563 "Another way to get the same information is to enable verbose messages with "
25564 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25565 "before running the program."
25570 #: ../fish/guestfish-actions.pod:826
25576 #: ../fish/guestfish-actions.pod:828
25579 " download remotefilename (filename|-)\n"
25585 #: ../fish/guestfish-actions.pod:835
25586 msgid "See also L</upload>, L</cat>."
25591 #: ../fish/guestfish-actions.pod:839
25592 msgid "download-offset"
25597 #: ../fish/guestfish-actions.pod:841
25600 " download-offset remotefilename (filename|-) offset size\n"
25606 #: ../fish/guestfish-actions.pod:849
25608 "Note that there is no limit on the amount of data that can be downloaded "
25609 "with this call, unlike with L</pread>, and this call always reads the full "
25610 "amount unless an error occurs."
25615 #: ../fish/guestfish-actions.pod:854
25616 msgid "See also L</download>, L</pread>."
25621 #: ../fish/guestfish-actions.pod:858
25622 msgid "drop-caches"
25627 #: ../fish/guestfish-actions.pod:860
25630 " drop-caches whattodrop\n"
25636 #: ../fish/guestfish-actions.pod:872
25642 #: ../fish/guestfish-actions.pod:874
25651 #: ../fish/guestfish-actions.pod:886
25657 #: ../fish/guestfish-actions.pod:888
25660 " e2fsck-f device\n"
25666 #: ../fish/guestfish-actions.pod:894
25668 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25669 "should use L</fsck>."
25674 #: ../fish/guestfish-actions.pod:897
25675 msgid "echo-daemon"
25680 #: ../fish/guestfish-actions.pod:899
25683 " echo-daemon 'words ...'\n"
25689 #: ../fish/guestfish-actions.pod:906
25690 msgid "See also L</ping-daemon>."
25695 #: ../fish/guestfish-actions.pod:908
25701 #: ../fish/guestfish-actions.pod:910
25704 " egrep regex path\n"
25710 #: ../fish/guestfish-actions.pod:918
25716 #: ../fish/guestfish-actions.pod:920
25719 " egrepi regex path\n"
25725 #: ../fish/guestfish-actions.pod:928
25731 #: ../fish/guestfish-actions.pod:930
25734 " equal file1 file2\n"
25740 #: ../fish/guestfish-actions.pod:937
25746 #: ../fish/guestfish-actions.pod:939
25755 #: ../fish/guestfish-actions.pod:944
25756 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25761 #: ../fish/guestfish-actions.pod:946
25767 #: ../fish/guestfish-actions.pod:948
25770 " fallocate path len\n"
25776 #: ../fish/guestfish-actions.pod:965
25777 msgid "fallocate64"
25782 #: ../fish/guestfish-actions.pod:967
25785 " fallocate64 path len\n"
25791 #: ../fish/guestfish-actions.pod:973
25793 "Note that this call allocates disk blocks for the file. To create a sparse "
25794 "file use L</truncate-size> instead."
25799 #: ../fish/guestfish-actions.pod:976
25801 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25802 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25803 "maximum size of files created through that call to 1GB."
25808 #: ../fish/guestfish-actions.pod:985
25814 #: ../fish/guestfish-actions.pod:987
25817 " fgrep pattern path\n"
25823 #: ../fish/guestfish-actions.pod:995
25829 #: ../fish/guestfish-actions.pod:997
25832 " fgrepi pattern path\n"
25838 #: ../fish/guestfish-actions.pod:1005
25844 #: ../fish/guestfish-actions.pod:1007
25853 #: ../fish/guestfish-actions.pod:1019
25855 "This command can also be used on C</dev/> devices (and partitions, LV "
25856 "names). You can for example use this to determine if a device contains a "
25857 "filesystem, although it's usually better to use L</vfs-type>."
25862 #: ../fish/guestfish-actions.pod:1029
25863 msgid "file-architecture"
25868 #: ../fish/guestfish-actions.pod:1031
25871 " file-architecture filename\n"
25877 #: ../fish/guestfish-actions.pod:1134
25883 #: ../fish/guestfish-actions.pod:1136
25892 #: ../fish/guestfish-actions.pod:1140
25894 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25895 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25900 #: ../fish/guestfish-actions.pod:1144
25906 #: ../fish/guestfish-actions.pod:1146
25909 " fill c len path\n"
25915 #: ../fish/guestfish-actions.pod:1152
25917 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25918 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25919 "L</fill-pattern>."
25924 #: ../fish/guestfish-actions.pod:1157
25925 msgid "fill-pattern"
25930 #: ../fish/guestfish-actions.pod:1159
25933 " fill-pattern pattern len path\n"
25939 #: ../fish/guestfish-actions.pod:1161
25941 "This function is like L</fill> except that it creates a new file of length "
25942 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25943 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25949 #: ../fish/guestfish-actions.pod:1166
25955 #: ../fish/guestfish-actions.pod:1168
25958 " find directory\n"
25964 #: ../fish/guestfish-actions.pod:1182
25965 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25970 #: ../fish/guestfish-actions.pod:1195
25971 msgid "See also L</find0>."
25976 #: ../fish/guestfish-actions.pod:1200
25982 #: ../fish/guestfish-actions.pod:1202
25985 " find0 directory (files|-)\n"
25991 #: ../fish/guestfish-actions.pod:1208
25993 "This command works the same way as L</find> with the following exceptions:"
25998 #: ../fish/guestfish-actions.pod:1235
25999 msgid "findfs-label"
26004 #: ../fish/guestfish-actions.pod:1237
26007 " findfs-label label\n"
26013 #: ../fish/guestfish-actions.pod:1243
26014 msgid "To find the label of a filesystem, use L</vfs-label>."
26019 #: ../fish/guestfish-actions.pod:1245
26020 msgid "findfs-uuid"
26025 #: ../fish/guestfish-actions.pod:1247
26028 " findfs-uuid uuid\n"
26034 #: ../fish/guestfish-actions.pod:1253
26035 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26040 #: ../fish/guestfish-actions.pod:1255
26046 #: ../fish/guestfish-actions.pod:1257
26049 " fsck fstype device\n"
26055 #: ../fish/guestfish-actions.pod:1287
26061 #: ../fish/guestfish-actions.pod:1289
26069 #: ../fish/guestfish-actions.pod:1296
26070 msgid "get-attach-method"
26074 #: ../fish/guestfish-actions.pod:1298
26077 " get-attach-method\n"
26082 #: ../fish/guestfish-actions.pod:1300
26083 msgid "Return the current attach method. See L</set-attach-method>."
26088 #: ../fish/guestfish-actions.pod:1302
26089 msgid "get-autosync"
26094 #: ../fish/guestfish-actions.pod:1304
26103 #: ../fish/guestfish-actions.pod:1308
26109 #: ../fish/guestfish-actions.pod:1310
26118 #: ../fish/guestfish-actions.pod:1314
26119 msgid "get-e2label"
26124 #: ../fish/guestfish-actions.pod:1316
26127 " get-e2label device\n"
26133 #: ../fish/guestfish-actions.pod:1328
26139 #: ../fish/guestfish-actions.pod:1330
26142 " get-e2uuid device\n"
26148 #: ../fish/guestfish-actions.pod:1342
26149 msgid "get-memsize"
26154 #: ../fish/guestfish-actions.pod:1344
26163 #: ../fish/guestfish-actions.pod:1349
26165 "If L</set-memsize> was not called on this handle, and if "
26166 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26167 "value for memsize."
26172 #: ../fish/guestfish-actions.pod:1356
26173 msgid "get-network"
26178 #: ../fish/guestfish-actions.pod:1358
26187 #: ../fish/guestfish-actions.pod:1362
26193 #: ../fish/guestfish-actions.pod:1364
26202 #: ../fish/guestfish-actions.pod:1371
26208 #: ../fish/guestfish-actions.pod:1373
26214 #: ../fish/guestfish-actions.pod:1375
26223 #: ../fish/guestfish-actions.pod:1382
26229 #: ../fish/guestfish-actions.pod:1384
26238 #: ../fish/guestfish-actions.pod:1391
26239 msgid "get-recovery-proc"
26244 #: ../fish/guestfish-actions.pod:1393
26247 " get-recovery-proc\n"
26253 #: ../fish/guestfish-actions.pod:1397
26254 msgid "get-selinux"
26259 #: ../fish/guestfish-actions.pod:1399
26268 #: ../fish/guestfish-actions.pod:1401
26270 "This returns the current setting of the selinux flag which is passed to the "
26271 "appliance at boot time. See L</set-selinux>."
26276 #: ../fish/guestfish-actions.pod:1407
26282 #: ../fish/guestfish-actions.pod:1409
26291 #: ../fish/guestfish-actions.pod:1416
26297 #: ../fish/guestfish-actions.pod:1418
26306 #: ../fish/guestfish-actions.pod:1422
26312 #: ../fish/guestfish-actions.pod:1424
26321 #: ../fish/guestfish-actions.pod:1426
26323 "Return the current umask. By default the umask is C<022> unless it has been "
26324 "set by calling L</umask>."
26329 #: ../fish/guestfish-actions.pod:1429
26330 msgid "get-verbose"
26335 #: ../fish/guestfish-actions.pod:1431
26344 #: ../fish/guestfish-actions.pod:1435
26350 #: ../fish/guestfish-actions.pod:1437
26359 #: ../fish/guestfish-actions.pod:1441
26360 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26365 #: ../fish/guestfish-actions.pod:1444
26371 #: ../fish/guestfish-actions.pod:1446
26374 " getxattr path name\n"
26380 #: ../fish/guestfish-actions.pod:1448
26382 "Get a single extended attribute from file C<path> named C<name>. This call "
26383 "follows symlinks. If you want to lookup an extended attribute for the "
26384 "symlink itself, use L</lgetxattr>."
26389 #: ../fish/guestfish-actions.pod:1452 ../fish/guestfish-actions.pod:2458
26391 "Normally it is better to get all extended attributes from a file in one go "
26392 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26393 "buggy and do not provide a way to list out attributes. For these "
26394 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26395 "attributes you want in advance and call this function."
26400 #: ../fish/guestfish-actions.pod:1462
26401 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26406 #: ../fish/guestfish-actions.pod:1464
26412 #: ../fish/guestfish-actions.pod:1466
26415 " getxattrs path\n"
26421 #: ../fish/guestfish-actions.pod:1474
26422 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26427 #: ../fish/guestfish-actions.pod:1476
26428 msgid "glob-expand"
26433 #: ../fish/guestfish-actions.pod:1478
26436 " glob-expand pattern\n"
26442 #: ../fish/guestfish-actions.pod:1491
26448 #: ../fish/guestfish-actions.pod:1493
26451 " grep regex path\n"
26457 #: ../fish/guestfish-actions.pod:1501
26463 #: ../fish/guestfish-actions.pod:1503
26466 " grepi regex path\n"
26472 #: ../fish/guestfish-actions.pod:1511
26473 msgid "grub-install"
26478 #: ../fish/guestfish-actions.pod:1513
26481 " grub-install root device\n"
26487 #: ../fish/guestfish-actions.pod:1529
26493 #: ../fish/guestfish-actions.pod:1531
26502 #: ../fish/guestfish-actions.pod:1539
26508 #: ../fish/guestfish-actions.pod:1541
26511 " head-n nrlines path\n"
26517 #: ../fish/guestfish-actions.pod:1554
26523 #: ../fish/guestfish-actions.pod:1556
26532 #: ../fish/guestfish-actions.pod:1564
26538 #: ../fish/guestfish-actions.pod:1566
26541 " initrd-cat initrdpath filename\n"
26547 #: ../fish/guestfish-actions.pod:1578
26548 msgid "See also L</initrd-list>."
26553 #: ../fish/guestfish-actions.pod:1583
26554 msgid "initrd-list"
26559 #: ../fish/guestfish-actions.pod:1585
26562 " initrd-list path\n"
26568 #: ../fish/guestfish-actions.pod:1597
26569 msgid "inotify-add-watch"
26574 #: ../fish/guestfish-actions.pod:1599
26577 " inotify-add-watch path mask\n"
26583 #: ../fish/guestfish-actions.pod:1611
26584 msgid "inotify-close"
26589 #: ../fish/guestfish-actions.pod:1613
26598 #: ../fish/guestfish-actions.pod:1619
26599 msgid "inotify-files"
26604 #: ../fish/guestfish-actions.pod:1621
26613 #: ../fish/guestfish-actions.pod:1623
26615 "This function is a helpful wrapper around L</inotify-read> which just "
26616 "returns a list of pathnames of objects that were touched. The returned "
26617 "pathnames are sorted and deduplicated."
26622 #: ../fish/guestfish-actions.pod:1627
26623 msgid "inotify-init"
26628 #: ../fish/guestfish-actions.pod:1629
26631 " inotify-init maxevents\n"
26637 #: ../fish/guestfish-actions.pod:1635
26639 "C<maxevents> is the maximum number of events which will be queued up between "
26640 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26641 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26642 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26643 "but records the fact that it threw them away by setting a flag "
26644 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26649 #: ../fish/guestfish-actions.pod:1645
26651 "Before any events are generated, you have to add some watches to the "
26652 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26653 "L</inotify-watch-all>."
26658 #: ../fish/guestfish-actions.pod:1651
26660 "Queued up events should be read periodically by calling L</inotify-read> (or "
26661 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26662 "If you don't read the events out often enough then you risk the internal "
26663 "queue overflowing."
26668 #: ../fish/guestfish-actions.pod:1658
26670 "The handle should be closed after use by calling L</inotify-close>. This "
26671 "also removes any watches automatically."
26676 #: ../fish/guestfish-actions.pod:1667
26677 msgid "inotify-read"
26682 #: ../fish/guestfish-actions.pod:1669
26691 #: ../fish/guestfish-actions.pod:1682
26692 msgid "inotify-rm-watch"
26697 #: ../fish/guestfish-actions.pod:1684
26700 " inotify-rm-watch wd\n"
26706 #: ../fish/guestfish-actions.pod:1686
26707 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26712 #: ../fish/guestfish-actions.pod:1689
26713 msgid "inspect-get-arch"
26718 #: ../fish/guestfish-actions.pod:1691
26721 " inspect-get-arch root\n"
26727 #: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1709
26728 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1831
26729 #: ../fish/guestfish-actions.pod:1849 ../fish/guestfish-actions.pod:1883
26730 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1919
26731 #: ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1967
26732 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2013
26733 #: ../fish/guestfish-actions.pod:2030 ../fish/guestfish-actions.pod:2073
26734 #: ../fish/guestfish-actions.pod:2108 ../fish/guestfish-actions.pod:2124
26735 #: ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153
26736 #: ../fish/guestfish-actions.pod:2166 ../fish/guestfish-actions.pod:2181
26738 "This function should only be called with a root device string as returned by "
26744 #: ../fish/guestfish-actions.pod:1696
26746 "This returns the architecture of the inspected operating system. The "
26747 "possible return values are listed under L</file-architecture>."
26752 #: ../fish/guestfish-actions.pod:1705
26753 msgid "inspect-get-distro"
26758 #: ../fish/guestfish-actions.pod:1707
26761 " inspect-get-distro root\n"
26766 #: ../fish/guestfish-actions.pod:1791
26767 msgid "inspect-get-drive-mappings"
26771 #: ../fish/guestfish-actions.pod:1793
26774 " inspect-get-drive-mappings root\n"
26779 #: ../fish/guestfish-actions.pod:1823
26781 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26782 "get-mountpoints>, L</inspect-get-filesystems>."
26787 #: ../fish/guestfish-actions.pod:1827
26788 msgid "inspect-get-filesystems"
26793 #: ../fish/guestfish-actions.pod:1829
26796 " inspect-get-filesystems root\n"
26802 #: ../fish/guestfish-actions.pod:1842
26804 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26805 "get-mountpoints>."
26809 #: ../fish/guestfish-actions.pod:1845
26810 msgid "inspect-get-format"
26814 #: ../fish/guestfish-actions.pod:1847
26817 " inspect-get-format root\n"
26823 #: ../fish/guestfish-actions.pod:1879
26824 msgid "inspect-get-hostname"
26829 #: ../fish/guestfish-actions.pod:1881
26832 " inspect-get-hostname root\n"
26838 #: ../fish/guestfish-actions.pod:1894
26839 msgid "inspect-get-major-version"
26844 #: ../fish/guestfish-actions.pod:1896
26847 " inspect-get-major-version root\n"
26853 #: ../fish/guestfish-actions.pod:1915
26854 msgid "inspect-get-minor-version"
26859 #: ../fish/guestfish-actions.pod:1917
26862 " inspect-get-minor-version root\n"
26868 #: ../fish/guestfish-actions.pod:1927
26870 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26871 "get-major-version>."
26876 #: ../fish/guestfish-actions.pod:1930
26877 msgid "inspect-get-mountpoints"
26882 #: ../fish/guestfish-actions.pod:1932
26885 " inspect-get-mountpoints root\n"
26890 #: ../fish/guestfish-actions.pod:1954
26892 "For operating systems like Windows which still use drive letters, this call "
26893 "will only return an entry for the first drive \"mounted on\" C</>. For "
26894 "information about the mapping of drive letters to partitions, see L</inspect-"
26895 "get-drive-mappings>."
26900 #: ../fish/guestfish-actions.pod:1960
26902 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26903 "get-filesystems>."
26908 #: ../fish/guestfish-actions.pod:1963
26909 msgid "inspect-get-package-format"
26914 #: ../fish/guestfish-actions.pod:1965
26917 " inspect-get-package-format root\n"
26923 #: ../fish/guestfish-actions.pod:1970
26925 "This function and L</inspect-get-package-management> return the package "
26926 "format and package management tool used by the inspected operating system. "
26927 "For example for Fedora these functions would return C<rpm> (package format) "
26928 "and C<yum> (package management)."
26933 #: ../fish/guestfish-actions.pod:1985
26934 msgid "inspect-get-package-management"
26939 #: ../fish/guestfish-actions.pod:1987
26942 " inspect-get-package-management root\n"
26948 #: ../fish/guestfish-actions.pod:1992
26950 "L</inspect-get-package-format> and this function return the package format "
26951 "and package management tool used by the inspected operating system. For "
26952 "example for Fedora these functions would return C<rpm> (package format) and "
26953 "C<yum> (package management)."
26958 #: ../fish/guestfish-actions.pod:2009
26959 msgid "inspect-get-product-name"
26964 #: ../fish/guestfish-actions.pod:2011
26967 " inspect-get-product-name root\n"
26972 #: ../fish/guestfish-actions.pod:2026
26973 msgid "inspect-get-product-variant"
26977 #: ../fish/guestfish-actions.pod:2028
26980 " inspect-get-product-variant root\n"
26985 #: ../fish/guestfish-actions.pod:2052
26987 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26988 "get-product-name>, L</inspect-get-major-version>."
26993 #: ../fish/guestfish-actions.pod:2056
26994 msgid "inspect-get-roots"
26999 #: ../fish/guestfish-actions.pod:2058
27002 " inspect-get-roots\n"
27008 #: ../fish/guestfish-actions.pod:2060
27010 "This function is a convenient way to get the list of root devices, as "
27011 "returned from a previous call to L</inspect-os>, but without redoing the "
27012 "whole inspection process."
27017 #: ../fish/guestfish-actions.pod:2064
27019 "This returns an empty list if either no root devices were found or the "
27020 "caller has not called L</inspect-os>."
27025 #: ../fish/guestfish-actions.pod:2069
27026 msgid "inspect-get-type"
27031 #: ../fish/guestfish-actions.pod:2071
27034 " inspect-get-type root\n"
27039 #: ../fish/guestfish-actions.pod:2104
27040 msgid "inspect-get-windows-current-control-set"
27044 #: ../fish/guestfish-actions.pod:2106
27047 " inspect-get-windows-current-control-set root\n"
27053 #: ../fish/guestfish-actions.pod:2120
27054 msgid "inspect-get-windows-systemroot"
27059 #: ../fish/guestfish-actions.pod:2122
27062 " inspect-get-windows-systemroot root\n"
27067 #: ../fish/guestfish-actions.pod:2136
27068 msgid "inspect-is-live"
27072 #: ../fish/guestfish-actions.pod:2138
27075 " inspect-is-live root\n"
27080 #: ../fish/guestfish-actions.pod:2143
27082 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27083 "then this returns true if a live image was detected on the disk."
27087 #: ../fish/guestfish-actions.pod:2149
27088 msgid "inspect-is-multipart"
27092 #: ../fish/guestfish-actions.pod:2151
27095 " inspect-is-multipart root\n"
27100 #: ../fish/guestfish-actions.pod:2156
27102 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27103 "then this returns true if the disk is part of a set."
27107 #: ../fish/guestfish-actions.pod:2162
27108 msgid "inspect-is-netinst"
27112 #: ../fish/guestfish-actions.pod:2164
27115 " inspect-is-netinst root\n"
27120 #: ../fish/guestfish-actions.pod:2169
27122 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27123 "then this returns true if the disk is a network installer, ie. not a self-"
27124 "contained install CD but one which is likely to require network access to "
27125 "complete the install."
27130 #: ../fish/guestfish-actions.pod:2177
27131 msgid "inspect-list-applications"
27136 #: ../fish/guestfish-actions.pod:2179
27139 " inspect-list-applications root\n"
27145 #: ../fish/guestfish-actions.pod:2186
27147 "I<Note:> This call works differently from other parts of the inspection "
27148 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27149 "then mount up the disks, before calling this. Listing applications is a "
27150 "significantly more difficult operation which requires access to the full "
27151 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27152 "are just returning data cached in the libguestfs handle, this call actually "
27153 "reads parts of the mounted filesystems during the call."
27158 #: ../fish/guestfish-actions.pod:2276
27164 #: ../fish/guestfish-actions.pod:2278
27173 #: ../fish/guestfish-actions.pod:2293
27175 "You can pass the root string(s) returned to other L</inspect-get-*> "
27176 "functions in order to query further information about each operating system, "
27177 "such as the name and version."
27182 #: ../fish/guestfish-actions.pod:2298
27184 "This function uses other libguestfs features such as L</mount-ro> and L</"
27185 "umount-all> in order to mount and unmount filesystems and look at the "
27186 "contents. This should be called with no disks currently mounted. The "
27187 "function may also use Augeas, so any existing Augeas handle will be closed."
27192 #: ../fish/guestfish-actions.pod:2310 ../fish/guestfish-actions.pod:2486
27193 #: ../fish/guestfish-actions.pod:2532
27194 msgid "See also L</list-filesystems>."
27199 #: ../fish/guestfish-actions.pod:2312
27200 msgid "is-blockdev"
27205 #: ../fish/guestfish-actions.pod:2314
27208 " is-blockdev path\n"
27214 #: ../fish/guestfish-actions.pod:2319 ../fish/guestfish-actions.pod:2337
27215 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2365
27216 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2409
27217 #: ../fish/guestfish-actions.pod:2418
27218 msgid "See also L</stat>."
27223 #: ../fish/guestfish-actions.pod:2321
27229 #: ../fish/guestfish-actions.pod:2323
27238 #: ../fish/guestfish-actions.pod:2330
27244 #: ../fish/guestfish-actions.pod:2332
27247 " is-chardev path\n"
27253 #: ../fish/guestfish-actions.pod:2339
27259 #: ../fish/guestfish-actions.pod:2341
27268 #: ../fish/guestfish-actions.pod:2348
27274 #: ../fish/guestfish-actions.pod:2350
27283 #: ../fish/guestfish-actions.pod:2358
27289 #: ../fish/guestfish-actions.pod:2360
27298 #: ../fish/guestfish-actions.pod:2367
27304 #: ../fish/guestfish-actions.pod:2369
27313 #: ../fish/guestfish-actions.pod:2377
27314 msgid "is-launching"
27319 #: ../fish/guestfish-actions.pod:2379
27328 #: ../fish/guestfish-actions.pod:2386
27334 #: ../fish/guestfish-actions.pod:2388
27343 #: ../fish/guestfish-actions.pod:2393
27349 #: ../fish/guestfish-actions.pod:2395
27358 #: ../fish/guestfish-actions.pod:2402
27364 #: ../fish/guestfish-actions.pod:2404
27367 " is-socket path\n"
27373 #: ../fish/guestfish-actions.pod:2411
27379 #: ../fish/guestfish-actions.pod:2413
27382 " is-symlink path\n"
27388 #: ../fish/guestfish-actions.pod:2420
27389 msgid "kill-subprocess"
27394 #: ../fish/guestfish-actions.pod:2422
27397 " kill-subprocess\n"
27403 #: ../fish/guestfish-actions.pod:2426
27409 #: ../fish/guestfish-actions.pod:2428
27415 #: ../fish/guestfish-actions.pod:2430
27424 #: ../fish/guestfish-actions.pod:2438
27430 #: ../fish/guestfish-actions.pod:2440
27433 " lchown owner group path\n"
27439 #: ../fish/guestfish-actions.pod:2442
27441 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27442 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27448 #: ../fish/guestfish-actions.pod:2450
27454 #: ../fish/guestfish-actions.pod:2452
27457 " lgetxattr path name\n"
27463 #: ../fish/guestfish-actions.pod:2468
27464 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27469 #: ../fish/guestfish-actions.pod:2470
27475 #: ../fish/guestfish-actions.pod:2472
27478 " lgetxattrs path\n"
27484 #: ../fish/guestfish-actions.pod:2474
27486 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27487 "it returns the extended attributes of the link itself."
27492 #: ../fish/guestfish-actions.pod:2478
27493 msgid "list-devices"
27498 #: ../fish/guestfish-actions.pod:2480
27507 #: ../fish/guestfish-actions.pod:2488
27508 msgid "list-filesystems"
27513 #: ../fish/guestfish-actions.pod:2490
27516 " list-filesystems\n"
27522 #: ../fish/guestfish-actions.pod:2509
27524 "This command runs other libguestfs commands, which might include L</mount> "
27525 "and L</umount>, and therefore you should use this soon after launch and only "
27526 "when nothing is mounted."
27531 #: ../fish/guestfish-actions.pod:2513
27533 "Not all of the filesystems returned will be mountable. In particular, swap "
27534 "partitions are returned in the list. Also this command does not check that "
27535 "each filesystem found is valid and mountable, and some filesystems might be "
27536 "mountable but require special options. Filesystems may not all belong to a "
27537 "single logical operating system (use L</inspect-os> to look for OSes)."
27542 #: ../fish/guestfish-actions.pod:2521
27543 msgid "list-partitions"
27548 #: ../fish/guestfish-actions.pod:2523
27551 " list-partitions\n"
27557 #: ../fish/guestfish-actions.pod:2529
27559 "This does not return logical volumes. For that you will need to call L</"
27565 #: ../fish/guestfish-actions.pod:2534
27571 #: ../fish/guestfish-actions.pod:2536
27580 #: ../fish/guestfish-actions.pod:2544
27586 #: ../fish/guestfish-actions.pod:2546
27589 " ln target linkname\n"
27595 #: ../fish/guestfish-actions.pod:2550
27601 #: ../fish/guestfish-actions.pod:2552
27604 " ln-f target linkname\n"
27610 #: ../fish/guestfish-actions.pod:2557
27616 #: ../fish/guestfish-actions.pod:2559
27619 " ln-s target linkname\n"
27625 #: ../fish/guestfish-actions.pod:2563
27631 #: ../fish/guestfish-actions.pod:2565
27634 " ln-sf target linkname\n"
27640 #: ../fish/guestfish-actions.pod:2570
27641 msgid "lremovexattr"
27646 #: ../fish/guestfish-actions.pod:2572
27649 " lremovexattr xattr path\n"
27655 #: ../fish/guestfish-actions.pod:2574
27657 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27658 "it removes an extended attribute of the link itself."
27663 #: ../fish/guestfish-actions.pod:2578
27669 #: ../fish/guestfish-actions.pod:2580
27678 #: ../fish/guestfish-actions.pod:2586
27680 "This command is mostly useful for interactive sessions. Programs should "
27681 "probably use L</readdir> instead."
27686 #: ../fish/guestfish-actions.pod:2589
27692 #: ../fish/guestfish-actions.pod:2591
27695 " lsetxattr xattr val vallen path\n"
27701 #: ../fish/guestfish-actions.pod:2593
27703 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27704 "sets an extended attribute of the link itself."
27709 #: ../fish/guestfish-actions.pod:2597
27715 #: ../fish/guestfish-actions.pod:2599
27724 #: ../fish/guestfish-actions.pod:2603
27726 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27727 "the link is stat-ed, not the file it refers to."
27732 #: ../fish/guestfish-actions.pod:2609
27738 #: ../fish/guestfish-actions.pod:2611
27741 " lstatlist path 'names ...'\n"
27747 #: ../fish/guestfish-actions.pod:2613
27749 "This call allows you to perform the L</lstat> operation on multiple files, "
27750 "where all files are in the directory C<path>. C<names> is the list of files "
27751 "from this directory."
27756 #: ../fish/guestfish-actions.pod:2622
27758 "This call is intended for programs that want to efficiently list a directory "
27759 "contents without making many round-trips. See also L</lxattrlist> for a "
27760 "similarly efficient call for getting extended attributes. Very long "
27761 "directory listings might cause the protocol message size to be exceeded, "
27762 "causing this call to fail. The caller must split up such requests into "
27763 "smaller groups of names."
27768 #: ../fish/guestfish-actions.pod:2630
27769 msgid "luks-add-key"
27774 #: ../fish/guestfish-actions.pod:2632
27777 " luks-add-key device keyslot\n"
27783 #: ../fish/guestfish-actions.pod:2639
27785 "Note that if C<keyslot> already contains a key, then this command will "
27786 "fail. You have to use L</luks-kill-slot> first to remove that key."
27791 #: ../fish/guestfish-actions.pod:2643 ../fish/guestfish-actions.pod:2665
27792 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2692
27793 #: ../fish/guestfish-actions.pod:2715 ../fish/guestfish-actions.pod:2725
27795 "This command has one or more key or passphrase parameters. Guestfish will "
27796 "prompt for these separately."
27801 #: ../fish/guestfish-actions.pod:2646
27807 #: ../fish/guestfish-actions.pod:2648
27810 " luks-close device\n"
27816 #: ../fish/guestfish-actions.pod:2650
27818 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27819 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27820 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27826 #: ../fish/guestfish-actions.pod:2656
27827 msgid "luks-format"
27832 #: ../fish/guestfish-actions.pod:2658
27835 " luks-format device keyslot\n"
27841 #: ../fish/guestfish-actions.pod:2671
27842 msgid "luks-format-cipher"
27847 #: ../fish/guestfish-actions.pod:2673
27850 " luks-format-cipher device keyslot cipher\n"
27856 #: ../fish/guestfish-actions.pod:2675
27858 "This command is the same as L</luks-format> but it also allows you to set "
27859 "the C<cipher> used."
27864 #: ../fish/guestfish-actions.pod:2684
27865 msgid "luks-kill-slot"
27870 #: ../fish/guestfish-actions.pod:2686
27873 " luks-kill-slot device keyslot\n"
27879 #: ../fish/guestfish-actions.pod:2695
27885 #: ../fish/guestfish-actions.pod:2697
27888 " luks-open device mapname\n"
27894 #: ../fish/guestfish-actions.pod:2711
27896 "If this block device contains LVM volume groups, then calling L</vgscan> "
27897 "followed by L</vg-activate-all> will make them visible."
27902 #: ../fish/guestfish-actions.pod:2718
27903 msgid "luks-open-ro"
27908 #: ../fish/guestfish-actions.pod:2720
27911 " luks-open-ro device mapname\n"
27917 #: ../fish/guestfish-actions.pod:2722
27919 "This is the same as L</luks-open> except that a read-only mapping is created."
27924 #: ../fish/guestfish-actions.pod:2728
27930 #: ../fish/guestfish-actions.pod:2730
27933 " lvcreate logvol volgroup mbytes\n"
27939 #: ../fish/guestfish-actions.pod:2735
27940 msgid "lvm-canonical-lv-name"
27945 #: ../fish/guestfish-actions.pod:2737
27948 " lvm-canonical-lv-name lvname\n"
27954 #: ../fish/guestfish-actions.pod:2746
27955 msgid "See also L</is-lv>."
27960 #: ../fish/guestfish-actions.pod:2748
27961 msgid "lvm-clear-filter"
27966 #: ../fish/guestfish-actions.pod:2750
27969 " lvm-clear-filter\n"
27975 #: ../fish/guestfish-actions.pod:2752
27977 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27983 #: ../fish/guestfish-actions.pod:2758
27984 msgid "lvm-remove-all"
27989 #: ../fish/guestfish-actions.pod:2760
27992 " lvm-remove-all\n"
27998 #: ../fish/guestfish-actions.pod:2768
27999 msgid "lvm-set-filter"
28004 #: ../fish/guestfish-actions.pod:2770
28007 " lvm-set-filter 'devices ...'\n"
28013 #: ../fish/guestfish-actions.pod:2795
28019 #: ../fish/guestfish-actions.pod:2797
28022 " lvremove device\n"
28028 #: ../fish/guestfish-actions.pod:2805
28034 #: ../fish/guestfish-actions.pod:2807
28037 " lvrename logvol newlogvol\n"
28043 #: ../fish/guestfish-actions.pod:2811
28049 #: ../fish/guestfish-actions.pod:2813
28052 " lvresize device mbytes\n"
28058 #: ../fish/guestfish-actions.pod:2819
28059 msgid "lvresize-free"
28064 #: ../fish/guestfish-actions.pod:2821
28067 " lvresize-free lv percent\n"
28073 #: ../fish/guestfish-actions.pod:2829
28079 #: ../fish/guestfish-actions.pod:2831
28088 #: ../fish/guestfish-actions.pod:2839
28089 msgid "See also L</lvs-full>, L</list-filesystems>."
28094 #: ../fish/guestfish-actions.pod:2841
28100 #: ../fish/guestfish-actions.pod:2843
28109 #: ../fish/guestfish-actions.pod:2848
28115 #: ../fish/guestfish-actions.pod:2850
28124 #: ../fish/guestfish-actions.pod:2854
28130 #: ../fish/guestfish-actions.pod:2856
28133 " lxattrlist path 'names ...'\n"
28139 #: ../fish/guestfish-actions.pod:2872
28141 "This call is intended for programs that want to efficiently list a directory "
28142 "contents without making many round-trips. See also L</lstatlist> for a "
28143 "similarly efficient call for getting standard stats. Very long directory "
28144 "listings might cause the protocol message size to be exceeded, causing this "
28145 "call to fail. The caller must split up such requests into smaller groups of "
28151 #: ../fish/guestfish-actions.pod:2880
28157 #: ../fish/guestfish-actions.pod:2882
28166 #: ../fish/guestfish-actions.pod:2886
28172 #: ../fish/guestfish-actions.pod:2888
28175 " mkdir-mode path mode\n"
28181 #: ../fish/guestfish-actions.pod:2897
28182 msgid "See also L</mkdir>, L</umask>"
28187 #: ../fish/guestfish-actions.pod:2899
28193 #: ../fish/guestfish-actions.pod:2901
28202 #: ../fish/guestfish-actions.pod:2906
28208 #: ../fish/guestfish-actions.pod:2908
28211 " mkdtemp template\n"
28217 #: ../fish/guestfish-actions.pod:2929
28223 #: ../fish/guestfish-actions.pod:2931
28226 " mke2fs-J fstype blocksize device journal\n"
28232 #: ../fish/guestfish-actions.pod:2939
28233 msgid "See also L</mke2journal>."
28238 #: ../fish/guestfish-actions.pod:2941
28244 #: ../fish/guestfish-actions.pod:2943
28247 " mke2fs-JL fstype blocksize device label\n"
28253 #: ../fish/guestfish-actions.pod:2948
28254 msgid "See also L</mke2journal-L>."
28259 #: ../fish/guestfish-actions.pod:2950
28265 #: ../fish/guestfish-actions.pod:2952
28268 " mke2fs-JU fstype blocksize device uuid\n"
28274 #: ../fish/guestfish-actions.pod:2957
28275 msgid "See also L</mke2journal-U>."
28280 #: ../fish/guestfish-actions.pod:2959
28281 msgid "mke2journal"
28286 #: ../fish/guestfish-actions.pod:2961
28289 " mke2journal blocksize device\n"
28295 #: ../fish/guestfish-actions.pod:2968
28296 msgid "mke2journal-L"
28301 #: ../fish/guestfish-actions.pod:2970
28304 " mke2journal-L blocksize label device\n"
28310 #: ../fish/guestfish-actions.pod:2974
28311 msgid "mke2journal-U"
28316 #: ../fish/guestfish-actions.pod:2976
28319 " mke2journal-U blocksize uuid device\n"
28325 #: ../fish/guestfish-actions.pod:2980
28331 #: ../fish/guestfish-actions.pod:2982
28334 " mkfifo mode path\n"
28340 #: ../fish/guestfish-actions.pod:2984
28342 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28343 "is just a convenient wrapper around L</mknod>."
28348 #: ../fish/guestfish-actions.pod:2990
28354 #: ../fish/guestfish-actions.pod:2992
28357 " mkfs fstype device\n"
28363 #: ../fish/guestfish-actions.pod:2998
28369 #: ../fish/guestfish-actions.pod:3000
28372 " mkfs-b fstype blocksize device\n"
28378 #: ../fish/guestfish-actions.pod:3002
28380 "This call is similar to L</mkfs>, but it allows you to control the block "
28381 "size of the resulting filesystem. Supported block sizes depend on the "
28382 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28387 #: ../fish/guestfish-actions.pod:3017
28392 #: ../fish/guestfish-actions.pod:3019
28395 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28401 #: ../fish/guestfish-actions.pod:3054
28402 msgid "mkmountpoint"
28407 #: ../fish/guestfish-actions.pod:3056
28410 " mkmountpoint exemptpath\n"
28416 #: ../fish/guestfish-actions.pod:3058
28418 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28419 "to create extra mountpoints before mounting the first filesystem."
28424 #: ../fish/guestfish-actions.pod:3082
28426 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28427 "unexpected errors if you try to mix these calls. It is safest to manually "
28428 "unmount filesystems and remove mountpoints after use."
28433 #: ../fish/guestfish-actions.pod:3086
28435 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28436 "for this to work for manual mountpoints, you must ensure that the innermost "
28437 "mountpoints have the longest pathnames, as in the example code above."
28441 #: ../fish/guestfish-actions.pod:3093
28443 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28444 "L</umount-all> to be called when the handle is closed which can also trigger "
28450 #: ../fish/guestfish-actions.pod:3097
28456 #: ../fish/guestfish-actions.pod:3099
28459 " mknod mode devmajor devminor path\n"
28465 #: ../fish/guestfish-actions.pod:3109
28467 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28468 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28469 "regular file). These constants are available in the standard Linux header "
28470 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28471 "wrappers around this command which bitwise OR in the appropriate constant "
28477 #: ../fish/guestfish-actions.pod:3119
28483 #: ../fish/guestfish-actions.pod:3121
28486 " mknod-b mode devmajor devminor path\n"
28492 #: ../fish/guestfish-actions.pod:3123
28494 "This call creates a block device node called C<path> with mode C<mode> and "
28495 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28496 "wrapper around L</mknod>."
28501 #: ../fish/guestfish-actions.pod:3129
28507 #: ../fish/guestfish-actions.pod:3131
28510 " mknod-c mode devmajor devminor path\n"
28516 #: ../fish/guestfish-actions.pod:3133
28518 "This call creates a char device node called C<path> with mode C<mode> and "
28519 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28520 "wrapper around L</mknod>."
28525 #: ../fish/guestfish-actions.pod:3139
28531 #: ../fish/guestfish-actions.pod:3141
28540 #: ../fish/guestfish-actions.pod:3145
28546 #: ../fish/guestfish-actions.pod:3147
28549 " mkswap-L label device\n"
28555 #: ../fish/guestfish-actions.pod:3155
28561 #: ../fish/guestfish-actions.pod:3157
28564 " mkswap-U uuid device\n"
28570 #: ../fish/guestfish-actions.pod:3161
28571 msgid "mkswap-file"
28576 #: ../fish/guestfish-actions.pod:3163
28579 " mkswap-file path\n"
28585 #: ../fish/guestfish-actions.pod:3167
28587 "This command just writes a swap file signature to an existing file. To "
28588 "create the file itself, use something like L</fallocate>."
28593 #: ../fish/guestfish-actions.pod:3170
28599 #: ../fish/guestfish-actions.pod:3172
28602 " modprobe modulename\n"
28608 #: ../fish/guestfish-actions.pod:3179
28614 #: ../fish/guestfish-actions.pod:3181
28617 " mount device mountpoint\n"
28623 #: ../fish/guestfish-actions.pod:3197
28625 "B<Important note:> When you use this call, the filesystem options C<sync> "
28626 "and C<noatime> are set implicitly. This was originally done because we "
28627 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28628 "very large negative performance impact and negligible effect on "
28629 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28630 "code that needs performance, and instead use L</mount-options> (use an empty "
28631 "string for the first parameter if you don't want any options)."
28636 #: ../fish/guestfish-actions.pod:3214
28642 #: ../fish/guestfish-actions.pod:3216
28645 " mount-loop file mountpoint\n"
28651 #: ../fish/guestfish-actions.pod:3222
28652 msgid "mount-options"
28657 #: ../fish/guestfish-actions.pod:3224
28660 " mount-options options device mountpoint\n"
28666 #: ../fish/guestfish-actions.pod:3226
28668 "This is the same as the L</mount> command, but it allows you to set the "
28669 "mount options as for the L<mount(8)> I<-o> flag."
28674 #: ../fish/guestfish-actions.pod:3234
28680 #: ../fish/guestfish-actions.pod:3236
28683 " mount-ro device mountpoint\n"
28689 #: ../fish/guestfish-actions.pod:3238
28691 "This is the same as the L</mount> command, but it mounts the filesystem with "
28692 "the read-only (I<-o ro>) flag."
28697 #: ../fish/guestfish-actions.pod:3241
28703 #: ../fish/guestfish-actions.pod:3243
28706 " mount-vfs options vfstype device mountpoint\n"
28712 #: ../fish/guestfish-actions.pod:3245
28714 "This is the same as the L</mount> command, but it allows you to set both the "
28715 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28720 #: ../fish/guestfish-actions.pod:3249
28721 msgid "mountpoints"
28726 #: ../fish/guestfish-actions.pod:3251
28735 #: ../fish/guestfish-actions.pod:3253
28737 "This call is similar to L</mounts>. That call returns a list of devices. "
28738 "This one returns a hash table (map) of device name to directory where the "
28739 "device is mounted."
28744 #: ../fish/guestfish-actions.pod:3257
28750 #: ../fish/guestfish-actions.pod:3259
28759 #: ../fish/guestfish-actions.pod:3266
28760 msgid "See also: L</mountpoints>"
28765 #: ../fish/guestfish-actions.pod:3268
28771 #: ../fish/guestfish-actions.pod:3270
28780 #: ../fish/guestfish-actions.pod:3275
28781 msgid "ntfs-3g-probe"
28786 #: ../fish/guestfish-actions.pod:3277
28789 " ntfs-3g-probe true|false device\n"
28795 #: ../fish/guestfish-actions.pod:3291
28801 #: ../fish/guestfish-actions.pod:3293
28804 " ntfsresize device\n"
28810 #: ../fish/guestfish-actions.pod:3299
28811 msgid "ntfsresize-size"
28816 #: ../fish/guestfish-actions.pod:3301
28819 " ntfsresize-size device size\n"
28825 #: ../fish/guestfish-actions.pod:3303
28827 "This command is the same as L</ntfsresize> except that it allows you to "
28828 "specify the new size (in bytes) explicitly."
28833 #: ../fish/guestfish-actions.pod:3306
28839 #: ../fish/guestfish-actions.pod:3308
28842 " part-add device prlogex startsect endsect\n"
28848 #: ../fish/guestfish-actions.pod:3310
28850 "This command adds a partition to C<device>. If there is no partition table "
28851 "on the device, call L</part-init> first."
28856 #: ../fish/guestfish-actions.pod:3322
28858 "Creating a partition which covers the whole disk is not so easy. Use L</"
28859 "part-disk> to do that."
28864 #: ../fish/guestfish-actions.pod:3325
28870 #: ../fish/guestfish-actions.pod:3327
28873 " part-del device partnum\n"
28879 #: ../fish/guestfish-actions.pod:3335
28885 #: ../fish/guestfish-actions.pod:3337
28888 " part-disk device parttype\n"
28894 #: ../fish/guestfish-actions.pod:3339
28896 "This command is simply a combination of L</part-init> followed by L</part-"
28897 "add> to create a single primary partition covering the whole disk."
28902 #: ../fish/guestfish-actions.pod:3343
28904 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28905 "possible values are described in L</part-init>."
28910 #: ../fish/guestfish-actions.pod:3349
28911 msgid "part-get-bootable"
28916 #: ../fish/guestfish-actions.pod:3351
28919 " part-get-bootable device partnum\n"
28925 #: ../fish/guestfish-actions.pod:3356
28926 msgid "See also L</part-set-bootable>."
28931 #: ../fish/guestfish-actions.pod:3358
28932 msgid "part-get-mbr-id"
28937 #: ../fish/guestfish-actions.pod:3360
28940 " part-get-mbr-id device partnum\n"
28946 #: ../fish/guestfish-actions.pod:3365 ../fish/guestfish-actions.pod:3503
28948 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28949 "undefined results for other partition table types (see L</part-get-"
28955 #: ../fish/guestfish-actions.pod:3369
28956 msgid "part-get-parttype"
28961 #: ../fish/guestfish-actions.pod:3371
28964 " part-get-parttype device\n"
28970 #: ../fish/guestfish-actions.pod:3376
28972 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28973 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28974 "possible, although unusual. See L</part-init> for a full list."
28979 #: ../fish/guestfish-actions.pod:3381
28985 #: ../fish/guestfish-actions.pod:3383
28988 " part-init device parttype\n"
28994 #: ../fish/guestfish-actions.pod:3389
28996 "Initially there are no partitions. Following this, you should call L</part-"
28997 "add> for each partition required."
29002 #: ../fish/guestfish-actions.pod:3452
29008 #: ../fish/guestfish-actions.pod:3454
29011 " part-list device\n"
29017 #: ../fish/guestfish-actions.pod:3469
29019 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29020 "the device's sector size, see L</blockdev-getss>."
29025 #: ../fish/guestfish-actions.pod:3482
29026 msgid "part-set-bootable"
29031 #: ../fish/guestfish-actions.pod:3484
29034 " part-set-bootable device partnum true|false\n"
29040 #: ../fish/guestfish-actions.pod:3493
29041 msgid "part-set-mbr-id"
29046 #: ../fish/guestfish-actions.pod:3495
29049 " part-set-mbr-id device partnum idbyte\n"
29055 #: ../fish/guestfish-actions.pod:3507
29056 msgid "part-set-name"
29061 #: ../fish/guestfish-actions.pod:3509
29064 " part-set-name device partnum name\n"
29070 #: ../fish/guestfish-actions.pod:3517
29071 msgid "part-to-dev"
29076 #: ../fish/guestfish-actions.pod:3519
29079 " part-to-dev partition\n"
29085 #: ../fish/guestfish-actions.pod:3525
29087 "The named partition must exist, for example as a string returned from L</"
29088 "list-partitions>."
29093 #: ../fish/guestfish-actions.pod:3528
29094 msgid "ping-daemon"
29099 #: ../fish/guestfish-actions.pod:3530
29108 #: ../fish/guestfish-actions.pod:3537
29114 #: ../fish/guestfish-actions.pod:3539
29117 " pread path count offset\n"
29123 #: ../fish/guestfish-actions.pod:3547
29124 msgid "See also L</pwrite>, L</pread-device>."
29129 #: ../fish/guestfish-actions.pod:3552
29130 msgid "pread-device"
29135 #: ../fish/guestfish-actions.pod:3554
29138 " pread-device device count offset\n"
29144 #: ../fish/guestfish-actions.pod:3562
29145 msgid "See also L</pread>."
29150 #: ../fish/guestfish-actions.pod:3567
29156 #: ../fish/guestfish-actions.pod:3569
29159 " pvcreate device\n"
29165 #: ../fish/guestfish-actions.pod:3575
29171 #: ../fish/guestfish-actions.pod:3577
29174 " pvremove device\n"
29180 #: ../fish/guestfish-actions.pod:3586
29186 #: ../fish/guestfish-actions.pod:3588
29189 " pvresize device\n"
29195 #: ../fish/guestfish-actions.pod:3593
29196 msgid "pvresize-size"
29201 #: ../fish/guestfish-actions.pod:3595
29204 " pvresize-size device size\n"
29210 #: ../fish/guestfish-actions.pod:3597
29212 "This command is the same as L</pvresize> except that it allows you to "
29213 "specify the new size (in bytes) explicitly."
29218 #: ../fish/guestfish-actions.pod:3600
29224 #: ../fish/guestfish-actions.pod:3602
29233 #: ../fish/guestfish-actions.pod:3610
29234 msgid "See also L</pvs-full>."
29239 #: ../fish/guestfish-actions.pod:3612
29245 #: ../fish/guestfish-actions.pod:3614
29254 #: ../fish/guestfish-actions.pod:3619
29260 #: ../fish/guestfish-actions.pod:3621
29269 #: ../fish/guestfish-actions.pod:3625
29275 #: ../fish/guestfish-actions.pod:3627
29278 " pwrite path content offset\n"
29284 #: ../fish/guestfish-actions.pod:3638
29285 msgid "See also L</pread>, L</pwrite-device>."
29290 #: ../fish/guestfish-actions.pod:3643
29291 msgid "pwrite-device"
29296 #: ../fish/guestfish-actions.pod:3645
29299 " pwrite-device device content offset\n"
29305 #: ../fish/guestfish-actions.pod:3655
29306 msgid "See also L</pwrite>."
29311 #: ../fish/guestfish-actions.pod:3660
29317 #: ../fish/guestfish-actions.pod:3662
29320 " read-file path\n"
29326 #: ../fish/guestfish-actions.pod:3667
29328 "Unlike L</cat>, this function can correctly handle files that contain "
29329 "embedded ASCII NUL characters. However unlike L</download>, this function "
29330 "is limited in the total size of file that can be handled."
29335 #: ../fish/guestfish-actions.pod:3675
29341 #: ../fish/guestfish-actions.pod:3677
29344 " read-lines path\n"
29350 #: ../fish/guestfish-actions.pod:3684
29352 "Note that this function cannot correctly handle binary files (specifically, "
29353 "files containing C<\\0> character which is treated as end of line). For "
29354 "those you need to use the L</read-file> function which has a more complex "
29360 #: ../fish/guestfish-actions.pod:3689
29366 #: ../fish/guestfish-actions.pod:3691
29375 #: ../fish/guestfish-actions.pod:3743
29377 "This function is primarily intended for use by programs. To get a simple "
29378 "list of names, use L</ls>. To get a printable directory for human "
29379 "consumption, use L</ll>."
29384 #: ../fish/guestfish-actions.pod:3747
29390 #: ../fish/guestfish-actions.pod:3749
29399 #: ../fish/guestfish-actions.pod:3753
29400 msgid "readlinklist"
29405 #: ../fish/guestfish-actions.pod:3755
29408 " readlinklist path 'names ...'\n"
29414 #: ../fish/guestfish-actions.pod:3779
29420 #: ../fish/guestfish-actions.pod:3781
29429 #: ../fish/guestfish-actions.pod:3786
29430 msgid "removexattr"
29435 #: ../fish/guestfish-actions.pod:3788
29438 " removexattr xattr path\n"
29444 #: ../fish/guestfish-actions.pod:3793
29445 msgid "See also: L</lremovexattr>, L<attr(5)>."
29450 #: ../fish/guestfish-actions.pod:3795
29456 #: ../fish/guestfish-actions.pod:3797
29459 " resize2fs device\n"
29465 #: ../fish/guestfish-actions.pod:3802
29467 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29468 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29469 "gives an error about this and sometimes not. In any case, it is always safe "
29470 "to call L</e2fsck-f> before calling this function."
29474 #: ../fish/guestfish-actions.pod:3808
29475 msgid "resize2fs-M"
29479 #: ../fish/guestfish-actions.pod:3810
29482 " resize2fs-M device\n"
29487 #: ../fish/guestfish-actions.pod:3812
29489 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29490 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29495 #: ../fish/guestfish-actions.pod:3816
29497 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29498 "and read the C<Block size> and C<Block count> values. These two numbers, "
29499 "multiplied together, give the resulting size of the minimal filesystem in "
29505 #: ../fish/guestfish-actions.pod:3821
29506 msgid "resize2fs-size"
29511 #: ../fish/guestfish-actions.pod:3823
29514 " resize2fs-size device size\n"
29520 #: ../fish/guestfish-actions.pod:3825
29522 "This command is the same as L</resize2fs> except that it allows you to "
29523 "specify the new size (in bytes) explicitly."
29528 #: ../fish/guestfish-actions.pod:3828
29534 #: ../fish/guestfish-actions.pod:3830
29543 #: ../fish/guestfish-actions.pod:3834
29549 #: ../fish/guestfish-actions.pod:3836
29558 #: ../fish/guestfish-actions.pod:3842
29564 #: ../fish/guestfish-actions.pod:3844
29573 #: ../fish/guestfish-actions.pod:3848
29574 msgid "rmmountpoint"
29579 #: ../fish/guestfish-actions.pod:3850
29582 " rmmountpoint exemptpath\n"
29588 #: ../fish/guestfish-actions.pod:3852
29590 "This calls removes a mountpoint that was previously created with L</"
29591 "mkmountpoint>. See L</mkmountpoint> for full details."
29596 #: ../fish/guestfish-actions.pod:3856
29597 msgid "scrub-device"
29602 #: ../fish/guestfish-actions.pod:3858
29605 " scrub-device device\n"
29611 #: ../fish/guestfish-actions.pod:3869
29617 #: ../fish/guestfish-actions.pod:3871
29620 " scrub-file file\n"
29626 #: ../fish/guestfish-actions.pod:3881
29627 msgid "scrub-freespace"
29632 #: ../fish/guestfish-actions.pod:3883
29635 " scrub-freespace dir\n"
29641 #: ../fish/guestfish-actions.pod:3885
29643 "This command creates the directory C<dir> and then fills it with files until "
29644 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29645 "deletes them. The intention is to scrub any free space on the partition "
29646 "containing C<dir>."
29651 #: ../fish/guestfish-actions.pod:3894
29657 #: ../fish/guestfish-actions.pod:3896
29663 #: ../fish/guestfish-actions.pod:3898
29666 " set-append append\n"
29671 #: ../fish/guestfish-actions.pod:3909
29672 msgid "set-attach-method"
29676 #: ../fish/guestfish-actions.pod:3911
29677 msgid "attach-method"
29681 #: ../fish/guestfish-actions.pod:3913
29684 " set-attach-method attachmethod\n"
29690 #: ../fish/guestfish-actions.pod:3935
29691 msgid "set-autosync"
29696 #: ../fish/guestfish-actions.pod:3937
29702 #: ../fish/guestfish-actions.pod:3939
29705 " set-autosync true|false\n"
29711 #: ../fish/guestfish-actions.pod:3949
29717 #: ../fish/guestfish-actions.pod:3951
29723 #: ../fish/guestfish-actions.pod:3953
29726 " set-direct true|false\n"
29732 #: ../fish/guestfish-actions.pod:3959
29734 "One consequence of this is that log messages aren't caught by the library "
29735 "and handled by L</set-log-message-callback>, but go straight to stdout."
29740 #: ../fish/guestfish-actions.pod:3968
29741 msgid "set-e2label"
29746 #: ../fish/guestfish-actions.pod:3970
29749 " set-e2label device label\n"
29755 #: ../fish/guestfish-actions.pod:3976
29757 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29758 "label on a filesystem."
29763 #: ../fish/guestfish-actions.pod:3979
29769 #: ../fish/guestfish-actions.pod:3981
29772 " set-e2uuid device uuid\n"
29778 #: ../fish/guestfish-actions.pod:3988
29780 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29781 "UUID of a filesystem."
29786 #: ../fish/guestfish-actions.pod:3991
29787 msgid "set-memsize"
29792 #: ../fish/guestfish-actions.pod:3993
29798 #: ../fish/guestfish-actions.pod:3995
29801 " set-memsize memsize\n"
29807 #: ../fish/guestfish-actions.pod:3997
29809 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29810 "This only has any effect if called before L</launch>."
29815 #: ../fish/guestfish-actions.pod:4008
29816 msgid "set-network"
29821 #: ../fish/guestfish-actions.pod:4010
29827 #: ../fish/guestfish-actions.pod:4012
29830 " set-network true|false\n"
29836 #: ../fish/guestfish-actions.pod:4020
29838 "You must call this before calling L</launch>, otherwise it has no effect."
29843 #: ../fish/guestfish-actions.pod:4023
29849 #: ../fish/guestfish-actions.pod:4025
29855 #: ../fish/guestfish-actions.pod:4027
29858 " set-path searchpath\n"
29864 #: ../fish/guestfish-actions.pod:4036
29870 #: ../fish/guestfish-actions.pod:4038
29876 #: ../fish/guestfish-actions.pod:4040
29885 #: ../fish/guestfish-actions.pod:4060
29886 msgid "set-recovery-proc"
29891 #: ../fish/guestfish-actions.pod:4062
29892 msgid "recovery-proc"
29897 #: ../fish/guestfish-actions.pod:4064
29900 " set-recovery-proc true|false\n"
29906 #: ../fish/guestfish-actions.pod:4066
29908 "If this is called with the parameter C<false> then L</launch> does not "
29909 "create a recovery process. The purpose of the recovery process is to stop "
29910 "runaway qemu processes in the case where the main program aborts abruptly."
29915 #: ../fish/guestfish-actions.pod:4071
29917 "This only has any effect if called before L</launch>, and the default is "
29923 #: ../fish/guestfish-actions.pod:4080
29924 msgid "set-selinux"
29929 #: ../fish/guestfish-actions.pod:4082
29935 #: ../fish/guestfish-actions.pod:4084
29938 " set-selinux true|false\n"
29944 #: ../fish/guestfish-actions.pod:4095
29950 #: ../fish/guestfish-actions.pod:4097
29956 #: ../fish/guestfish-actions.pod:4099
29959 " set-trace true|false\n"
29964 #: ../fish/guestfish-actions.pod:4111
29966 "Trace messages are normally sent to C<stderr>, unless you register a "
29967 "callback to send them somewhere else (see L</set-event-callback>)."
29972 #: ../fish/guestfish-actions.pod:4115
29973 msgid "set-verbose"
29978 #: ../fish/guestfish-actions.pod:4117
29984 #: ../fish/guestfish-actions.pod:4119
29987 " set-verbose true|false\n"
29992 #: ../fish/guestfish-actions.pod:4126
29994 "Verbose messages are normally sent to C<stderr>, unless you register a "
29995 "callback to send them somewhere else (see L</set-event-callback>)."
30000 #: ../fish/guestfish-actions.pod:4130
30006 #: ../fish/guestfish-actions.pod:4132
30009 " setcon context\n"
30015 #: ../fish/guestfish-actions.pod:4139
30021 #: ../fish/guestfish-actions.pod:4141
30024 " setxattr xattr val vallen path\n"
30030 #: ../fish/guestfish-actions.pod:4147
30031 msgid "See also: L</lsetxattr>, L<attr(5)>."
30036 #: ../fish/guestfish-actions.pod:4149
30042 #: ../fish/guestfish-actions.pod:4151
30045 " sfdisk device cyls heads sectors 'lines ...'\n"
30051 #: ../fish/guestfish-actions.pod:4173
30052 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30057 #: ../fish/guestfish-actions.pod:4186
30063 #: ../fish/guestfish-actions.pod:4188
30066 " sfdiskM device 'lines ...'\n"
30072 #: ../fish/guestfish-actions.pod:4190
30074 "This is a simplified interface to the L</sfdisk> command, where partition "
30075 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30076 "you don't need to specify the cyls, heads and sectors parameters which were "
30077 "rarely if ever used anyway."
30082 #: ../fish/guestfish-actions.pod:4196
30083 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30088 #: ../fish/guestfish-actions.pod:4209
30094 #: ../fish/guestfish-actions.pod:4211
30097 " sfdisk-N device partnum cyls heads sectors line\n"
30103 #: ../fish/guestfish-actions.pod:4216
30105 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30106 "cyls/heads/sectors parameters."
30111 #: ../fish/guestfish-actions.pod:4219
30112 msgid "See also: L</part-add>"
30117 #: ../fish/guestfish-actions.pod:4231
30118 msgid "sfdisk-disk-geometry"
30123 #: ../fish/guestfish-actions.pod:4233
30126 " sfdisk-disk-geometry device\n"
30132 #: ../fish/guestfish-actions.pod:4235
30134 "This displays the disk geometry of C<device> read from the partition table. "
30135 "Especially in the case where the underlying block device has been resized, "
30136 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30137 "kernel-geometry>)."
30142 #: ../fish/guestfish-actions.pod:4243
30143 msgid "sfdisk-kernel-geometry"
30148 #: ../fish/guestfish-actions.pod:4245
30151 " sfdisk-kernel-geometry device\n"
30157 #: ../fish/guestfish-actions.pod:4252
30163 #: ../fish/guestfish-actions.pod:4254
30166 " sfdisk-l device\n"
30172 #: ../fish/guestfish-actions.pod:4260
30173 msgid "See also: L</part-list>"
30178 #: ../fish/guestfish-actions.pod:4269
30184 #: ../fish/guestfish-actions.pod:4271
30193 #: ../fish/guestfish-actions.pod:4276
30194 msgid "This is like L</command>, but passes the command to:"
30199 #: ../fish/guestfish-actions.pod:4284
30200 msgid "All the provisos about L</command> apply to this call."
30205 #: ../fish/guestfish-actions.pod:4286
30211 #: ../fish/guestfish-actions.pod:4288
30214 " sh-lines command\n"
30220 #: ../fish/guestfish-actions.pod:4290
30221 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30226 #: ../fish/guestfish-actions.pod:4293
30227 msgid "See also: L</command-lines>"
30232 #: ../fish/guestfish-actions.pod:4295
30238 #: ../fish/guestfish-actions.pod:4297
30247 #: ../fish/guestfish-actions.pod:4301
30253 #: ../fish/guestfish-actions.pod:4303
30262 #: ../fish/guestfish-actions.pod:4309
30268 #: ../fish/guestfish-actions.pod:4311
30277 #: ../fish/guestfish-actions.pod:4319
30283 #: ../fish/guestfish-actions.pod:4321
30292 #: ../fish/guestfish-actions.pod:4329
30298 #: ../fish/guestfish-actions.pod:4331
30301 " strings-e encoding path\n"
30307 #: ../fish/guestfish-actions.pod:4333
30309 "This is like the L</strings> command, but allows you to specify the encoding "
30310 "of strings that are looked for in the source file C<path>."
30315 #: ../fish/guestfish-actions.pod:4343
30317 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30318 "ISO-8859-X (this is what L</strings> uses)."
30323 #: ../fish/guestfish-actions.pod:4375
30324 msgid "swapoff-device"
30329 #: ../fish/guestfish-actions.pod:4377
30332 " swapoff-device device\n"
30338 #: ../fish/guestfish-actions.pod:4379
30340 "This command disables the libguestfs appliance swap device or partition "
30341 "named C<device>. See L</swapon-device>."
30346 #: ../fish/guestfish-actions.pod:4383
30347 msgid "swapoff-file"
30352 #: ../fish/guestfish-actions.pod:4385
30355 " swapoff-file file\n"
30361 #: ../fish/guestfish-actions.pod:4389
30362 msgid "swapoff-label"
30367 #: ../fish/guestfish-actions.pod:4391
30370 " swapoff-label label\n"
30376 #: ../fish/guestfish-actions.pod:4396
30377 msgid "swapoff-uuid"
30382 #: ../fish/guestfish-actions.pod:4398
30385 " swapoff-uuid uuid\n"
30391 #: ../fish/guestfish-actions.pod:4403
30392 msgid "swapon-device"
30397 #: ../fish/guestfish-actions.pod:4405
30400 " swapon-device device\n"
30406 #: ../fish/guestfish-actions.pod:4407
30408 "This command enables the libguestfs appliance to use the swap device or "
30409 "partition named C<device>. The increased memory is made available for all "
30410 "commands, for example those run using L</command> or L</sh>."
30415 #: ../fish/guestfish-actions.pod:4419
30416 msgid "swapon-file"
30421 #: ../fish/guestfish-actions.pod:4421
30424 " swapon-file file\n"
30430 #: ../fish/guestfish-actions.pod:4423
30432 "This command enables swap to a file. See L</swapon-device> for other notes."
30437 #: ../fish/guestfish-actions.pod:4426
30438 msgid "swapon-label"
30443 #: ../fish/guestfish-actions.pod:4428
30446 " swapon-label label\n"
30452 #: ../fish/guestfish-actions.pod:4430
30454 "This command enables swap to a labeled swap partition. See L</swapon-"
30455 "device> for other notes."
30460 #: ../fish/guestfish-actions.pod:4433
30461 msgid "swapon-uuid"
30466 #: ../fish/guestfish-actions.pod:4435
30469 " swapon-uuid uuid\n"
30475 #: ../fish/guestfish-actions.pod:4437
30477 "This command enables swap to a swap partition with the given UUID. See L</"
30478 "swapon-device> for other notes."
30483 #: ../fish/guestfish-actions.pod:4440
30489 #: ../fish/guestfish-actions.pod:4442
30498 #: ../fish/guestfish-actions.pod:4450
30504 #: ../fish/guestfish-actions.pod:4452
30513 #: ../fish/guestfish-actions.pod:4460
30519 #: ../fish/guestfish-actions.pod:4462
30522 " tail-n nrlines path\n"
30528 #: ../fish/guestfish-actions.pod:4475
30534 #: ../fish/guestfish-actions.pod:4477
30537 " tar-in (tarfile|-) directory\n"
30543 #: ../fish/guestfish-actions.pod:4482
30544 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30549 #: ../fish/guestfish-actions.pod:4487
30555 #: ../fish/guestfish-actions.pod:4489
30558 " tar-out directory (tarfile|-)\n"
30564 #: ../fish/guestfish-actions.pod:4494
30565 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30570 #: ../fish/guestfish-actions.pod:4499
30576 #: ../fish/guestfish-actions.pod:4501
30579 " tgz-in (tarball|-) directory\n"
30585 #: ../fish/guestfish-actions.pod:4506
30586 msgid "To upload an uncompressed tarball, use L</tar-in>."
30591 #: ../fish/guestfish-actions.pod:4510
30597 #: ../fish/guestfish-actions.pod:4512
30600 " tgz-out directory (tarball|-)\n"
30606 #: ../fish/guestfish-actions.pod:4517
30607 msgid "To download an uncompressed tarball, use L</tar-out>."
30612 #: ../fish/guestfish-actions.pod:4521
30618 #: ../fish/guestfish-actions.pod:4523
30627 #: ../fish/guestfish-actions.pod:4532
30633 #: ../fish/guestfish-actions.pod:4534
30642 #: ../fish/guestfish-actions.pod:4539
30643 msgid "truncate-size"
30648 #: ../fish/guestfish-actions.pod:4541
30651 " truncate-size path size\n"
30657 #: ../fish/guestfish-actions.pod:4546
30659 "If the current file size is less than C<size> then the file is extended to "
30660 "the required size with zero bytes. This creates a sparse file (ie. disk "
30661 "blocks are not allocated for the file until you write to it). To create a "
30662 "non-sparse file of zeroes, use L</fallocate64> instead."
30667 #: ../fish/guestfish-actions.pod:4552
30673 #: ../fish/guestfish-actions.pod:4554
30676 " tune2fs-l device\n"
30682 #: ../fish/guestfish-actions.pod:4564
30688 #: ../fish/guestfish-actions.pod:4566
30691 " txz-in (tarball|-) directory\n"
30697 #: ../fish/guestfish-actions.pod:4573
30703 #: ../fish/guestfish-actions.pod:4575
30706 " txz-out directory (tarball|-)\n"
30712 #: ../fish/guestfish-actions.pod:4582
30718 #: ../fish/guestfish-actions.pod:4584
30727 #: ../fish/guestfish-actions.pod:4598
30728 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30733 #: ../fish/guestfish-actions.pod:4603
30739 #: ../fish/guestfish-actions.pod:4605
30745 #: ../fish/guestfish-actions.pod:4607
30748 " umount pathordevice\n"
30754 #: ../fish/guestfish-actions.pod:4613
30760 #: ../fish/guestfish-actions.pod:4615
30761 msgid "unmount-all"
30766 #: ../fish/guestfish-actions.pod:4617
30775 #: ../fish/guestfish-actions.pod:4623
30781 #: ../fish/guestfish-actions.pod:4625
30784 " upload (filename|-) remotefilename\n"
30790 #: ../fish/guestfish-actions.pod:4632
30791 msgid "See also L</download>."
30796 #: ../fish/guestfish-actions.pod:4636
30797 msgid "upload-offset"
30802 #: ../fish/guestfish-actions.pod:4638
30805 " upload-offset (filename|-) remotefilename offset\n"
30811 #: ../fish/guestfish-actions.pod:4650
30813 "Note that there is no limit on the amount of data that can be uploaded with "
30814 "this call, unlike with L</pwrite>, and this call always writes the full "
30815 "amount unless an error occurs."
30820 #: ../fish/guestfish-actions.pod:4655
30821 msgid "See also L</upload>, L</pwrite>."
30826 #: ../fish/guestfish-actions.pod:4659
30832 #: ../fish/guestfish-actions.pod:4661
30835 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30841 #: ../fish/guestfish-actions.pod:4680
30847 #: ../fish/guestfish-actions.pod:4682
30856 #: ../fish/guestfish-actions.pod:4709
30858 "I<Note:> Don't use this call to test for availability of features. In "
30859 "enterprise distributions we backport features from later versions into "
30860 "earlier versions, making this an unreliable way to test for features. Use "
30861 "L</available> instead."
30866 #: ../fish/guestfish-actions.pod:4715
30872 #: ../fish/guestfish-actions.pod:4717
30875 " vfs-label device\n"
30881 #: ../fish/guestfish-actions.pod:4724
30882 msgid "To find a filesystem from the label, use L</findfs-label>."
30887 #: ../fish/guestfish-actions.pod:4726
30893 #: ../fish/guestfish-actions.pod:4728
30896 " vfs-type device\n"
30902 #: ../fish/guestfish-actions.pod:4738
30908 #: ../fish/guestfish-actions.pod:4740
30911 " vfs-uuid device\n"
30917 #: ../fish/guestfish-actions.pod:4747
30918 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30923 #: ../fish/guestfish-actions.pod:4749
30924 msgid "vg-activate"
30929 #: ../fish/guestfish-actions.pod:4751
30932 " vg-activate true|false 'volgroups ...'\n"
30938 #: ../fish/guestfish-actions.pod:4764
30939 msgid "vg-activate-all"
30944 #: ../fish/guestfish-actions.pod:4766
30947 " vg-activate-all true|false\n"
30953 #: ../fish/guestfish-actions.pod:4776
30959 #: ../fish/guestfish-actions.pod:4778
30962 " vgcreate volgroup 'physvols ...'\n"
30968 #: ../fish/guestfish-actions.pod:4783
30974 #: ../fish/guestfish-actions.pod:4785
30977 " vglvuuids vgname\n"
30983 #: ../fish/guestfish-actions.pod:4790
30985 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30986 "logical volumes and volume groups."
30991 #: ../fish/guestfish-actions.pod:4793
30992 msgid "See also L</vgpvuuids>."
30997 #: ../fish/guestfish-actions.pod:4795
31003 #: ../fish/guestfish-actions.pod:4797
31006 " vgpvuuids vgname\n"
31012 #: ../fish/guestfish-actions.pod:4802
31014 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31015 "physical volumes and volume groups."
31020 #: ../fish/guestfish-actions.pod:4805
31021 msgid "See also L</vglvuuids>."
31026 #: ../fish/guestfish-actions.pod:4807
31032 #: ../fish/guestfish-actions.pod:4809
31035 " vgremove vgname\n"
31041 #: ../fish/guestfish-actions.pod:4816
31047 #: ../fish/guestfish-actions.pod:4818
31050 " vgrename volgroup newvolgroup\n"
31056 #: ../fish/guestfish-actions.pod:4822
31062 #: ../fish/guestfish-actions.pod:4824
31071 #: ../fish/guestfish-actions.pod:4832
31072 msgid "See also L</vgs-full>."
31077 #: ../fish/guestfish-actions.pod:4834
31083 #: ../fish/guestfish-actions.pod:4836
31092 #: ../fish/guestfish-actions.pod:4841
31098 #: ../fish/guestfish-actions.pod:4843
31107 #: ../fish/guestfish-actions.pod:4848
31113 #: ../fish/guestfish-actions.pod:4850
31122 #: ../fish/guestfish-actions.pod:4854
31128 #: ../fish/guestfish-actions.pod:4856
31137 #: ../fish/guestfish-actions.pod:4861
31143 #: ../fish/guestfish-actions.pod:4863
31152 #: ../fish/guestfish-actions.pod:4868
31158 #: ../fish/guestfish-actions.pod:4870
31167 #: ../fish/guestfish-actions.pod:4875
31173 #: ../fish/guestfish-actions.pod:4877
31176 " write path content\n"
31182 #: ../fish/guestfish-actions.pod:4885
31188 #: ../fish/guestfish-actions.pod:4887
31191 " write-file path content size\n"
31197 #: ../fish/guestfish-actions.pod:4910
31203 #: ../fish/guestfish-actions.pod:4912
31206 " zegrep regex path\n"
31212 #: ../fish/guestfish-actions.pod:4920
31218 #: ../fish/guestfish-actions.pod:4922
31221 " zegrepi regex path\n"
31227 #: ../fish/guestfish-actions.pod:4930
31233 #: ../fish/guestfish-actions.pod:4932
31242 #: ../fish/guestfish-actions.pod:4940
31243 msgid "See also: L</zero-device>, L</scrub-device>."
31248 #: ../fish/guestfish-actions.pod:4942
31249 msgid "zero-device"
31254 #: ../fish/guestfish-actions.pod:4944
31257 " zero-device device\n"
31263 #: ../fish/guestfish-actions.pod:4946
31265 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31266 "which just zeroes the first few blocks of a device."
31271 #: ../fish/guestfish-actions.pod:4953
31277 #: ../fish/guestfish-actions.pod:4955
31280 " zerofree device\n"
31286 #: ../fish/guestfish-actions.pod:4968
31292 #: ../fish/guestfish-actions.pod:4970
31295 " zfgrep pattern path\n"
31301 #: ../fish/guestfish-actions.pod:4978
31307 #: ../fish/guestfish-actions.pod:4980
31310 " zfgrepi pattern path\n"
31316 #: ../fish/guestfish-actions.pod:4988
31322 #: ../fish/guestfish-actions.pod:4990
31325 " zfile meth path\n"
31331 #: ../fish/guestfish-actions.pod:4997
31333 "Since 1.0.63, use L</file> instead which can now process compressed files."
31338 #: ../fish/guestfish-actions.pod:5007
31344 #: ../fish/guestfish-actions.pod:5009
31347 " zgrep regex path\n"
31353 #: ../fish/guestfish-actions.pod:5017
31359 #: ../fish/guestfish-actions.pod:5019
31362 " zgrepi regex path\n"
31368 #: ../fish/guestfish-commands.pod:1
31374 #: ../fish/guestfish-commands.pod:3
31380 #: ../fish/guestfish-commands.pod:5
31383 " alloc filename size\n"
31389 #: ../fish/guestfish-commands.pod:7
31391 "This creates an empty (zeroed) file of the given size, and then adds so it "
31392 "can be further examined."
31397 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31398 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31403 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31404 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31409 #: ../fish/guestfish-commands.pod:14
31411 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31412 "image, see L</PREPARED DISK IMAGES>."
31417 #: ../fish/guestfish-commands.pod:17
31423 #: ../fish/guestfish-commands.pod:19
31426 " copy-in local [local ...] /remotedir\n"
31432 #: ../fish/guestfish-commands.pod:21
31434 "C<copy-in> copies local files or directories recursively into the disk "
31435 "image, placing them in the directory called C</remotedir> (which must "
31436 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31437 "other commands as necessary."
31442 #: ../fish/guestfish-commands.pod:26
31444 "Multiple local files and directories can be specified, but the last "
31445 "parameter must always be a remote directory. Wildcards cannot be used."
31450 #: ../fish/guestfish-commands.pod:30
31456 #: ../fish/guestfish-commands.pod:32
31459 " copy-out remote [remote ...] localdir\n"
31465 #: ../fish/guestfish-commands.pod:34
31467 "C<copy-out> copies remote files or directories recursively out of the disk "
31468 "image, placing them on the host disk in a local directory called C<localdir> "
31469 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31470 "download>, L</tar-out> and other commands as necessary."
31475 #: ../fish/guestfish-commands.pod:40
31477 "Multiple remote files and directories can be specified, but the last "
31478 "parameter must always be a local directory. To download to the current "
31479 "directory, use C<.> as in:"
31484 #: ../fish/guestfish-commands.pod:44
31487 " copy-out /home .\n"
31493 #: ../fish/guestfish-commands.pod:46
31495 "Wildcards cannot be used in the ordinary command, but you can use them with "
31496 "the help of L</glob> like this:"
31501 #: ../fish/guestfish-commands.pod:49
31504 " glob copy-out /home/* .\n"
31510 #: ../fish/guestfish-commands.pod:51
31516 #: ../fish/guestfish-commands.pod:53
31519 " echo [params ...]\n"
31525 #: ../fish/guestfish-commands.pod:55
31526 msgid "This echos the parameters to the terminal."
31531 #: ../fish/guestfish-commands.pod:57
31537 #: ../fish/guestfish-commands.pod:59
31543 #: ../fish/guestfish-commands.pod:61
31549 #: ../fish/guestfish-commands.pod:63
31558 #: ../fish/guestfish-commands.pod:65
31560 "This is used to edit a file. It downloads the file, edits it locally using "
31561 "your editor, then uploads the result."
31566 #: ../fish/guestfish-commands.pod:68
31568 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31569 "or C<emacs> you will get those corresponding editors."
31574 #: ../fish/guestfish-commands.pod:72
31580 #: ../fish/guestfish-commands.pod:74
31583 " glob command args...\n"
31589 #: ../fish/guestfish-commands.pod:76
31591 "Expand wildcards in any paths in the args list, and run C<command> "
31592 "repeatedly on each matching path."
31597 #: ../fish/guestfish-commands.pod:79
31598 msgid "See L</WILDCARDS AND GLOBBING>."
31603 #: ../fish/guestfish-commands.pod:81
31609 #: ../fish/guestfish-commands.pod:83
31612 " hexedit <filename|device>\n"
31613 " hexedit <filename|device> <max>\n"
31614 " hexedit <filename|device> <start> <max>\n"
31620 #: ../fish/guestfish-commands.pod:87
31622 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31628 #: ../fish/guestfish-commands.pod:90
31630 "This command works by downloading potentially the whole file or device, "
31631 "editing it locally, then uploading it. If the file or device is large, you "
31632 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31633 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31634 "usual modifiers allowed such as C<1M> (1 megabyte)."
31639 #: ../fish/guestfish-commands.pod:97
31640 msgid "For example to edit the first few sectors of a disk you might do:"
31645 #: ../fish/guestfish-commands.pod:100
31648 " hexedit /dev/sda 1M\n"
31654 #: ../fish/guestfish-commands.pod:102
31656 "which would allow you to edit anywhere within the first megabyte of the disk."
31661 #: ../fish/guestfish-commands.pod:105
31662 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31667 #: ../fish/guestfish-commands.pod:107
31670 " hexedit /dev/sda1 0x400 0x400\n"
31676 #: ../fish/guestfish-commands.pod:109
31677 msgid "(assuming the superblock is in the standard location)."
31682 #: ../fish/guestfish-commands.pod:111
31684 "This command requires the external L<hexedit(1)> program. You can specify "
31685 "another program to use by setting the C<HEXEDITOR> environment variable."
31690 #: ../fish/guestfish-commands.pod:115
31691 msgid "See also L</hexdump>."
31696 #: ../fish/guestfish-commands.pod:117
31702 #: ../fish/guestfish-commands.pod:119
31711 #: ../fish/guestfish-commands.pod:121
31713 "Change the local directory, ie. the current directory of guestfish itself."
31718 #: ../fish/guestfish-commands.pod:124
31719 msgid "Note that C<!cd> won't do what you might expect."
31724 #: ../fish/guestfish-commands.pod:126
31730 #: ../fish/guestfish-commands.pod:128
31736 #: ../fish/guestfish-commands.pod:130
31745 #: ../fish/guestfish-commands.pod:132
31746 msgid "Opens the manual page for guestfish."
31751 #: ../fish/guestfish-commands.pod:134
31757 #: ../fish/guestfish-commands.pod:136
31763 #: ../fish/guestfish-commands.pod:138
31772 #: ../fish/guestfish-commands.pod:140
31781 #: ../fish/guestfish-commands.pod:142
31782 msgid "This is used to view a file."
31787 #: ../fish/guestfish-commands.pod:144
31789 "The default viewer is C<$PAGER>. However if you use the alternate command "
31790 "C<less> you will get the C<less> command specifically."
31795 #: ../fish/guestfish-commands.pod:147
31801 #: ../fish/guestfish-commands.pod:149
31810 #: ../fish/guestfish-commands.pod:151
31812 "Close and reopen the libguestfs handle. It is not necessary to use this "
31813 "normally, because the handle is closed properly when guestfish exits. "
31814 "However this is occasionally useful for testing."
31819 #: ../fish/guestfish-commands.pod:155
31825 #: ../fish/guestfish-commands.pod:157
31828 " sparse filename size\n"
31834 #: ../fish/guestfish-commands.pod:159
31836 "This creates an empty sparse file of the given size, and then adds so it can "
31837 "be further examined."
31842 #: ../fish/guestfish-commands.pod:162
31844 "In all respects it works the same as the L</alloc> command, except that the "
31845 "image file is allocated sparsely, which means that disk blocks are not "
31846 "assigned to the file until they are needed. Sparse disk files only use "
31847 "space when written to, but they are slower and there is a danger you could "
31848 "run out of real disk space during a write operation."
31853 #: ../fish/guestfish-commands.pod:172
31859 #: ../fish/guestfish-commands.pod:174
31868 #: ../fish/guestfish-commands.pod:176
31870 "This command returns a list of the optional groups known to the daemon, and "
31871 "indicates which ones are supported by this build of the libguestfs appliance."
31876 #: ../fish/guestfish-commands.pod:180
31877 msgid "See also L<guestfs(3)/AVAILABILITY>."
31882 #: ../fish/guestfish-commands.pod:182
31888 #: ../fish/guestfish-commands.pod:184
31891 " time command args...\n"
31897 #: ../fish/guestfish-commands.pod:186
31899 "Run the command as usual, but print the elapsed time afterwards. This can "
31900 "be useful for benchmarking operations."
31905 #: ../test-tool/libguestfs-test-tool.pod:5
31906 msgid "libguestfs-test-tool - End user tests for libguestfs"
31911 #: ../test-tool/libguestfs-test-tool.pod:9
31914 " libguestfs-test-tool [--options]\n"
31920 #: ../test-tool/libguestfs-test-tool.pod:13
31922 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31923 "and developers, to allow them to check basic libguestfs functionality is "
31924 "working. This is needed because libguestfs occasionally breaks for reasons "
31925 "beyond our control: usually because of changes in the underlying qemu or "
31926 "kernel packages, or the host environment."
31931 #: ../test-tool/libguestfs-test-tool.pod:20
31932 msgid "If you suspect a problem in libguestfs, then just run:"
31937 #: ../test-tool/libguestfs-test-tool.pod:22
31940 " libguestfs-test-tool\n"
31946 #: ../test-tool/libguestfs-test-tool.pod:24
31947 msgid "It will print lots of diagnostic messages."
31952 #: ../test-tool/libguestfs-test-tool.pod:26
31953 msgid "If it runs to completion successfully, you will see this near the end:"
31958 #: ../test-tool/libguestfs-test-tool.pod:28
31961 " ===== TEST FINISHED OK =====\n"
31967 #: ../test-tool/libguestfs-test-tool.pod:30
31968 msgid "and the test tool will exit with code 0."
31973 #: ../test-tool/libguestfs-test-tool.pod:32
31975 "If it fails (and/or exits with non-zero error code), please paste the "
31976 "B<complete, unedited> output of the test tool into a bug report. More "
31977 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31983 #: ../test-tool/libguestfs-test-tool.pod:41
31989 #: ../test-tool/libguestfs-test-tool.pod:43
31990 msgid "Display short usage information and exit."
31995 #: ../test-tool/libguestfs-test-tool.pod:45
31996 msgid "I<--qemu qemu_binary>"
32001 #: ../test-tool/libguestfs-test-tool.pod:47
32003 "If you have downloaded another qemu binary, point this option at the full "
32004 "path of the binary to try it."
32009 #: ../test-tool/libguestfs-test-tool.pod:50
32010 msgid "I<--qemudir qemu_source_dir>"
32015 #: ../test-tool/libguestfs-test-tool.pod:52
32017 "If you have compiled qemu from source, point this option at the source "
32018 "directory to try it."
32023 #: ../test-tool/libguestfs-test-tool.pod:55
32024 msgid "I<--timeout N>"
32029 #: ../test-tool/libguestfs-test-tool.pod:57
32031 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32032 "does not usually need to be adjusted unless your machine is very slow."
32037 #: ../test-tool/libguestfs-test-tool.pod:63
32038 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32043 #: ../test-tool/libguestfs-test-tool.pod:65
32045 "If you have compiled another version of qemu from source and would like to "
32046 "try that, then you can use the I<--qemudir> option to point to the qemu "
32047 "source directory."
32052 #: ../test-tool/libguestfs-test-tool.pod:69
32054 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32055 "option to point to the binary."
32060 #: ../test-tool/libguestfs-test-tool.pod:72
32062 "When using an alternate qemu with libguestfs, usually you would need to "
32063 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32064 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32065 "use either of the I<--qemudir> or I<--qemu> options."
32070 #: ../test-tool/libguestfs-test-tool.pod:79
32072 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32073 "I<1> if there was an error."
32078 #: ../test-tool/libguestfs-test-tool.pod:84
32080 "For the full list of environment variables which may affect libguestfs, "
32081 "please see the L<guestfs(3)> manual page."
32086 #: ../test-tool/libguestfs-test-tool.pod:89
32087 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32092 #: ../fuse/guestmount.pod:5
32094 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32099 #: ../fuse/guestmount.pod:9
32102 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32108 #: ../fuse/guestmount.pod:11
32111 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32117 #: ../fuse/guestmount.pod:13
32120 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32126 #: ../fuse/guestmount.pod:17
32128 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32129 "machines. If you do this, you risk disk corruption in the VM."
32134 #: ../fuse/guestmount.pod:22
32136 "The guestmount program can be used to mount virtual machine filesystems and "
32137 "other disk images on the host. It uses libguestfs for access to the guest "
32138 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32139 "a mountable device."
32144 #: ../fuse/guestmount.pod:27
32146 "Along with other options, you have to give at least one device (I<-a> "
32147 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32148 "option) or use the I<-i> inspection option. How this works is better "
32149 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32155 #: ../fuse/guestmount.pod:33
32157 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32158 "by you, and the filesystem will not be visible to any other users unless you "
32159 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32160 "the filesystem, use the C<fusermount -u> command."
32165 #: ../fuse/guestmount.pod:41
32167 "For a typical Windows guest which has its main filesystem on the first "
32173 #: ../fuse/guestmount.pod:44
32176 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32182 #: ../fuse/guestmount.pod:46
32184 "For a typical Linux guest which has a /boot filesystem on the first "
32185 "partition, and the root filesystem on a logical volume:"
32190 #: ../fuse/guestmount.pod:49
32193 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32199 #: ../fuse/guestmount.pod:51
32200 msgid "To get libguestfs to detect guest mountpoints for you:"
32205 #: ../fuse/guestmount.pod:53
32208 " guestmount -a guest.img -i --ro /mnt\n"
32214 #: ../fuse/guestmount.pod:55
32215 msgid "For a libvirt guest called \"Guest\" you could do:"
32220 #: ../fuse/guestmount.pod:57
32223 " guestmount -d Guest -i --ro /mnt\n"
32229 #: ../fuse/guestmount.pod:59
32231 "If you don't know what filesystems are contained in a guest or disk image, "
32232 "use L<virt-filesystems(1)> first:"
32237 #: ../fuse/guestmount.pod:62
32240 " virt-filesystems MyGuest\n"
32246 #: ../fuse/guestmount.pod:64
32248 "If you want to trace the libguestfs calls but without excessive debugging "
32249 "information, we recommend:"
32254 #: ../fuse/guestmount.pod:67
32257 " guestmount [...] --trace /mnt\n"
32263 #: ../fuse/guestmount.pod:69
32264 msgid "If you want to debug the program, we recommend:"
32269 #: ../fuse/guestmount.pod:71
32272 " guestmount [...] --trace --verbose /mnt\n"
32278 #: ../fuse/guestmount.pod:77
32279 msgid "B<-a image> | B<--add image>"
32284 #: ../fuse/guestmount.pod:79
32285 msgid "Add a block device or virtual machine image."
32290 #: ../fuse/guestmount.pod:84
32291 msgid "B<-c URI> | B<--connect URI>"
32296 #: ../fuse/guestmount.pod:90
32297 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32302 #: ../fuse/guestmount.pod:98
32303 msgid "B<--dir-cache-timeout N>"
32308 #: ../fuse/guestmount.pod:100
32310 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32311 "seconds. The readdir cache [actually, there are several semi-independent "
32312 "caches] is populated after a readdir(2) call with the stat and extended "
32313 "attributes of the files in the directory, in anticipation that they will be "
32314 "requested soon after."
32319 #: ../fuse/guestmount.pod:106
32321 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32322 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32323 "requests, only cache existing ones."
32328 #: ../fuse/guestmount.pod:117
32329 msgid "B<--format=raw|qcow2|..> | B<--format>"
32334 #: ../fuse/guestmount.pod:124
32336 "If you have untrusted raw-format guest disk images, you should use this "
32337 "option to specify the disk format. This avoids a possible security problem "
32338 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32339 "guestfs_add_drive_opts>."
32344 #: ../fuse/guestmount.pod:129
32345 msgid "B<--fuse-help>"
32350 #: ../fuse/guestmount.pod:131
32351 msgid "Display help on special FUSE options (see I<-o> below)."
32356 #: ../fuse/guestmount.pod:135
32357 msgid "Display brief help and exit."
32362 #: ../fuse/guestmount.pod:137
32363 msgid "B<-i> | B<--inspector>"
32368 #: ../fuse/guestmount.pod:157
32370 "Mount the named partition or logical volume on the given mountpoint B<in the "
32371 "guest> (this has nothing to do with mountpoints in the host)."
32376 #: ../fuse/guestmount.pod:160
32378 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32379 "something on C</>."
32384 #: ../fuse/guestmount.pod:173
32385 msgid "B<-n> | B<--no-sync>"
32390 #: ../fuse/guestmount.pod:175
32392 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32393 "unmounted. If you specify this option, then we don't attempt to sync the "
32394 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32399 #: ../fuse/guestmount.pod:180
32400 msgid "B<-o option> | B<--option option>"
32405 #: ../fuse/guestmount.pod:182
32406 msgid "Pass extra options to FUSE."
32411 #: ../fuse/guestmount.pod:184
32413 "To get a list of all the extra options supported by FUSE, use the command "
32414 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32415 "of them are a good idea."
32420 #: ../fuse/guestmount.pod:188
32423 " guestmount --fuse-help\n"
32429 #: ../fuse/guestmount.pod:190
32430 msgid "Some potentially useful FUSE options:"
32435 #: ../fuse/guestmount.pod:194
32436 msgid "B<-o allow_other>"
32441 #: ../fuse/guestmount.pod:196
32442 msgid "Allow other users to see the filesystem."
32447 #: ../fuse/guestmount.pod:198
32448 msgid "B<-o attr_timeout=N>"
32453 #: ../fuse/guestmount.pod:200
32454 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32459 #: ../fuse/guestmount.pod:202
32460 msgid "B<-o kernel_cache>"
32465 #: ../fuse/guestmount.pod:204
32467 "Allow the kernel to cache files (reduces the number of reads that have to go "
32468 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32469 "afford the extra memory usage."
32474 #: ../fuse/guestmount.pod:208
32475 msgid "B<-o uid=N> B<-o gid=N>"
32480 #: ../fuse/guestmount.pod:210
32482 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32483 "the chosen values."
32488 #: ../fuse/guestmount.pod:215
32489 msgid "B<-r> | B<--ro>"
32494 #: ../fuse/guestmount.pod:217
32496 "Add devices and mount everything read-only. Also disallow writes and make "
32497 "the disk appear read-only to FUSE."
32502 #: ../fuse/guestmount.pod:220
32504 "This is highly recommended if you are not going to edit the guest disk. If "
32505 "the guest is running and this option is I<not> supplied, then there is a "
32506 "strong risk of disk corruption in the guest. We try to prevent this from "
32507 "happening, but it is not always possible."
32512 #: ../fuse/guestmount.pod:225
32513 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32518 #: ../fuse/guestmount.pod:229
32519 msgid "Enable SELinux support for the guest."
32524 #: ../fuse/guestmount.pod:231
32525 msgid "B<-v> | B<--verbose>"
32530 #: ../fuse/guestmount.pod:233
32531 msgid "Enable verbose messages from underlying libguestfs."
32536 #: ../fuse/guestmount.pod:235
32537 msgid "B<-V> | B<--version>"
32542 #: ../fuse/guestmount.pod:237
32543 msgid "Display the program version and exit."
32548 #: ../fuse/guestmount.pod:239
32549 msgid "B<-w> | B<--rw>"
32553 #: ../fuse/guestmount.pod:244 ../fuse/guestmount.pod:265
32554 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32559 #: ../fuse/guestmount.pod:246
32560 msgid "B<-x> | B<--trace>"
32565 #: ../fuse/guestmount.pod:248
32566 msgid "Trace libguestfs calls and entry into each FUSE function."
32571 #: ../fuse/guestmount.pod:250
32572 msgid "This also stops the daemon from forking into the background."
32577 #: ../fuse/guestmount.pod:271
32579 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32580 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32586 #: ../fuse/guestmount.pod:286
32587 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32592 #: ../tools/virt-win-reg.pl:37
32594 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
32599 #: ../tools/virt-win-reg.pl:41
32602 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
32608 #: ../tools/virt-win-reg.pl:43
32611 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
32617 #: ../tools/virt-win-reg.pl:45
32620 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
32626 #: ../tools/virt-win-reg.pl:47
32629 " virt-win-reg --merge domname [input.reg ...]\n"
32635 #: ../tools/virt-win-reg.pl:49
32638 " virt-win-reg [--options] disk.img ... # instead of domname\n"
32643 #: ../tools/virt-win-reg.pl:53
32645 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
32646 "virtual machines. If you do this, you I<will> get irreversible disk "
32647 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
32648 "but doesn't catch all cases."
32652 #: ../tools/virt-win-reg.pl:58
32654 "Modifying the Windows Registry is an inherently risky operation. The format "
32655 "is deliberately obscure and undocumented, and Registry changes can leave the "
32656 "system unbootable. Therefore when using the I<--merge> option, make sure "
32657 "you have a reliable backup first."
32662 #: ../tools/virt-win-reg.pl:65
32664 "This program can export and merge Windows Registry entries from a Windows "
32670 #: ../tools/virt-win-reg.pl:68
32672 "The first parameter is the libvirt guest name or the raw disk image of a "
32677 #: ../tools/virt-win-reg.pl:71
32679 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
32680 "exported (recursively). For example:"
32685 #: ../tools/virt-win-reg.pl:74
32688 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
32694 #: ../tools/virt-win-reg.pl:76
32696 "You can also display single values from within registry keys, for example:"
32701 #: ../tools/virt-win-reg.pl:79
32704 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
32705 " $ virt-win-reg Windows7 $cvkey ProductName\n"
32706 " Windows 7 Enterprise\n"
32711 #: ../tools/virt-win-reg.pl:83
32713 "With I<--merge>, you can merge a textual regedit file into the Windows "
32719 #: ../tools/virt-win-reg.pl:86
32722 " $ virt-win-reg --merge Windows7 changes.reg\n"
32728 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
32734 #: ../tools/virt-win-reg.pl:90
32736 "This program is only meant for simple access to the registry. If you want "
32737 "to do complicated things with the registry, we suggest you download the "
32738 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
32739 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
32740 "L<hivexregedit(1)>."
32745 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
32746 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
32747 #: ../tools/virt-list-partitions.pl:64
32748 msgid "Display brief help."
32753 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
32754 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32755 #: ../tools/virt-list-partitions.pl:72
32756 msgid "Display version number and exit."
32761 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
32767 #: ../tools/virt-win-reg.pl:122
32768 msgid "Enable debugging messages."
32773 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
32774 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
32775 msgid "B<--connect URI> | B<-c URI>"
32780 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
32781 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
32783 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32784 "to the default libvirt hypervisor."
32789 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
32790 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
32792 "If you specify guest block devices directly, then libvirt is not used at all."
32797 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
32798 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32799 msgid "B<--format> raw"
32804 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
32805 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
32807 "Specify the format of disk images given on the command line. If this is "
32808 "omitted then the format is autodetected from the content of the disk image."
32813 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
32814 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
32816 "If disk images are requested from libvirt, then this program asks libvirt "
32817 "for this information. In this case, the value of the format parameter is "
32823 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
32824 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
32826 "If working with untrusted raw-format guest disk images, you should ensure "
32827 "the format is always specified."
32832 #: ../tools/virt-win-reg.pl:157
32838 #: ../tools/virt-win-reg.pl:159
32840 "In merge mode, this merges a textual regedit file into the Windows Registry "
32841 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
32842 "displays or exports Registry entries instead."
32846 #: ../tools/virt-win-reg.pl:163
32848 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
32849 "result in disk corruption. However exporting (without this flag) is always "
32855 #: ../tools/virt-win-reg.pl:171
32856 msgid "B<--encoding> UTF-16LE|ASCII"
32861 #: ../tools/virt-win-reg.pl:173
32863 "When merging (only), you may need to specify the encoding for strings to be "
32864 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
32865 "(3)/ENCODING STRINGS>."
32870 #: ../tools/virt-win-reg.pl:177
32872 "The default is to use UTF-16LE, which should work with recent versions of "
32877 #: ../tools/virt-win-reg.pl:184
32878 msgid "B<--unsafe-printable-strings>"
32882 #: ../tools/virt-win-reg.pl:186
32884 "When exporting (only), assume strings are UTF-16LE and print them as strings "
32885 "instead of hex sequences. Remove the final zero codepoint from strings if "
32890 #: ../tools/virt-win-reg.pl:190
32892 "This is unsafe and does not preserve the fidelity of strings in the original "
32893 "Registry for various reasons:"
32897 #: ../tools/virt-win-reg.pl:197
32899 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
32900 "other encodings will be corrupted by this transformation."
32904 #: ../tools/virt-win-reg.pl:202
32906 "Assumes that everything which has type 1 or 2 is really a string and that "
32907 "everything else is not a string, but the type field in real Registries is "
32912 #: ../tools/virt-win-reg.pl:208
32914 "Loses information about whether a zero codepoint followed the string in the "
32919 #: ../tools/virt-win-reg.pl:213
32921 "This all happens because the Registry itself contains no information about "
32922 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
32926 #: ../tools/virt-win-reg.pl:217
32928 "You should only use this option for quick hacking and debugging of the "
32929 "Registry contents, and I<never> use it if the output is going to be passed "
32930 "into another program or stored in another Registry."
32935 #: ../tools/virt-win-reg.pl:553
32936 msgid "SUPPORTED SYSTEMS"
32941 #: ../tools/virt-win-reg.pl:555
32943 "The program currently supports Windows NT-derived guests starting with "
32944 "Windows XP through to at least Windows 7."
32948 #: ../tools/virt-win-reg.pl:558
32949 msgid "The following Registry keys are supported:"
32953 #: ../tools/virt-win-reg.pl:562
32954 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
32958 #: ../tools/virt-win-reg.pl:564
32959 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
32963 #: ../tools/virt-win-reg.pl:566
32964 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
32968 #: ../tools/virt-win-reg.pl:568
32969 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
32973 #: ../tools/virt-win-reg.pl:570
32974 msgid "C<HKEY_USERS\\.DEFAULT>"
32978 #: ../tools/virt-win-reg.pl:572
32979 msgid "C<HKEY_USERS\\I<SID>>"
32983 #: ../tools/virt-win-reg.pl:574
32984 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
32988 #: ../tools/virt-win-reg.pl:576
32989 msgid "C<HKEY_USERS\\I<username>>"
32993 #: ../tools/virt-win-reg.pl:578
32995 "where I<username> is a local user name (this is a libguestfs extension)."
33000 #: ../tools/virt-win-reg.pl:582
33002 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33007 #: ../tools/virt-win-reg.pl:585
33009 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
33010 "supported (there is no \"current user\")."
33015 #: ../tools/virt-win-reg.pl:588
33021 #: ../tools/virt-win-reg.pl:590
33023 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33024 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33025 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33026 "Windows-style line endings, you may need to reencode the whole file before "
33027 "or after processing."
33031 #: ../tools/virt-win-reg.pl:596
33033 "To reencode a file from Windows format to Linux (before processing it with "
33034 "the I<--merge> option), you would do something like this:"
33039 #: ../tools/virt-win-reg.pl:599
33042 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33048 #: ../tools/virt-win-reg.pl:601
33050 "To go in the opposite direction, after exporting and before sending the file "
33051 "to a Windows user, do something like this:"
33056 #: ../tools/virt-win-reg.pl:604
33059 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33065 #: ../tools/virt-win-reg.pl:606
33066 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33071 #: ../tools/virt-win-reg.pl:608
33073 "If you are unsure about the current encoding, use the L<file(1)> command. "
33074 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33075 "style (CRLF) line endings, like this:"
33080 #: ../tools/virt-win-reg.pl:612
33083 " $ file software.reg\n"
33084 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33085 " with CRLF line terminators\n"
33090 #: ../tools/virt-win-reg.pl:616
33091 msgid "This file would need conversion before you could I<--merge> it."
33096 #: ../tools/virt-win-reg.pl:618
33097 msgid "CurrentControlSet etc."
33102 #: ../tools/virt-win-reg.pl:620
33104 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33105 "Registry at the level of the hive file, and therefore you cannot modify "
33111 #: ../tools/virt-win-reg.pl:624
33113 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33114 "circumstances it might refer to another control set. The way to find out is "
33115 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33120 #: ../tools/virt-win-reg.pl:628
33123 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33124 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33125 " \"Current\"=dword:00000001\n"
33126 " \"Default\"=dword:00000001\n"
33127 " \"Failed\"=dword:00000000\n"
33128 " \"LastKnownGood\"=dword:00000002\n"
33134 #: ../tools/virt-win-reg.pl:635
33135 msgid "\"Current\" is the one which Windows will choose when it boots."
33140 #: ../tools/virt-win-reg.pl:637
33142 "Similarly, other C<Current...> keys in the path may need to be replaced."
33147 #: ../tools/virt-win-reg.pl:640
33148 msgid "WINDOWS TIPS"
33153 #: ../tools/virt-win-reg.pl:642
33155 "Note that some of these tips modify the guest disk image. The guest I<must> "
33156 "be shut off, else you will get disk corruption."
33161 #: ../tools/virt-win-reg.pl:645
33162 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33167 #: ../tools/virt-win-reg.pl:647
33169 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33170 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33171 "is uploaded into C<C:\\>:"
33176 #: ../tools/virt-win-reg.pl:651
33179 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33185 #: ../tools/virt-win-reg.pl:653
33186 msgid "Prepare a regedit file containing the registry change:"
33191 #: ../tools/virt-win-reg.pl:655
33194 " cat > test.reg <<'EOF'\n"
33195 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33196 " \"Test\"=\"c:\\\\test.bat\"\n"
33203 #: ../tools/virt-win-reg.pl:660
33205 "In this example we use the key C<RunOnce> which means that the script will "
33206 "run precisely once when the first user logs in. If you want it to run every "
33207 "time a user logs in, replace C<RunOnce> with C<Run>."
33212 #: ../tools/virt-win-reg.pl:664
33213 msgid "Now update the registry:"
33218 #: ../tools/virt-win-reg.pl:666
33221 " virt-win-reg --merge WindowsGuest test.reg\n"
33227 #: ../tools/virt-win-reg.pl:668
33228 msgid "INSTALLING A SERVICE"
33233 #: ../tools/virt-win-reg.pl:670
33235 "This section assumes you are familiar with Windows services, and you either "
33236 "have a program which handles the Windows Service Control Protocol directly "
33237 "or you want to run any program using a service wrapper like SrvAny or the "
33243 #: ../tools/virt-win-reg.pl:675
33245 "First upload the program and optionally the service wrapper. In this case "
33246 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33251 #: ../tools/virt-win-reg.pl:679
33254 " guestfish -i -d WindowsGuest <<EOF\n"
33255 " upload rhsrvany.exe /rhsrvany.exe\n"
33256 " upload test.exe /test.exe\n"
33263 #: ../tools/virt-win-reg.pl:684
33265 "Prepare a regedit file containing the registry changes. In this example, "
33266 "the first registry change is needed for the service itself or the service "
33267 "wrapper (if used). The second registry change is only needed because I am "
33268 "using the RHSrvAny service wrapper."
33273 #: ../tools/virt-win-reg.pl:689
33276 " cat > service.reg <<'EOF'\n"
33277 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33278 " \"Type\"=dword:00000010\n"
33279 " \"Start\"=dword:00000002\n"
33280 " \"ErrorControl\"=dword:00000001\n"
33281 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33282 " \"DisplayName\"=\"RHSrvAny\"\n"
33283 " \"ObjectName\"=\"NetworkService\"\n"
33289 #: ../tools/virt-win-reg.pl:698
33292 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33293 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33294 " \"PWD\"=\"c:\\\\Temp\"\n"
33301 #: ../tools/virt-win-reg.pl:709
33303 "For use of C<ControlSet001> see the section above in this manual page. You "
33304 "may need to adjust this according to the control set that is in use by the "
33310 #: ../tools/virt-win-reg.pl:715
33312 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33313 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33314 "privileged account."
33319 #: ../tools/virt-win-reg.pl:721
33321 "For the meaning of the magic numbers, see this Microsoft KB article: "
33322 "L<http://support.microsoft.com/kb/103000>."
33327 #: ../tools/virt-win-reg.pl:726
33328 msgid "Update the registry:"
33333 #: ../tools/virt-win-reg.pl:728
33336 " virt-win-reg --merge WindowsGuest service.reg\n"
33342 #: ../tools/virt-win-reg.pl:730 ../tools/virt-list-filesystems.pl:182
33343 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
33344 #: ../tools/virt-list-partitions.pl:250
33345 msgid "SHELL QUOTING"
33350 #: ../tools/virt-win-reg.pl:732
33352 "Be careful when passing parameters containing C<\\> (backslash) in the "
33353 "shell. Usually you will have to use 'single quotes' or double backslashes "
33354 "(but not both) to protect them from the shell."
33359 #: ../tools/virt-win-reg.pl:736
33360 msgid "Paths and value names are case-insensitive."
33365 #: ../tools/virt-win-reg.pl:738 ../tools/virt-list-filesystems.pl:184
33366 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
33367 #: ../tools/virt-list-partitions.pl:252
33369 "Libvirt guest names can contain arbitrary characters, some of which have "
33370 "meaning to the shell such as C<#> and space. You may need to quote or "
33371 "escape these characters on the command line. See the shell manual page L<sh"
33372 "(1)> for details."
33377 #: ../tools/virt-win-reg.pl:745
33379 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33380 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33381 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33386 #: ../tools/virt-win-reg.pl:760 ../tools/virt-make-fs.pl:555
33388 "When reporting bugs, please enable debugging and capture the I<complete> "
33394 #: ../tools/virt-win-reg.pl:763
33397 " export LIBGUESTFS_DEBUG=1\n"
33398 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33404 #: ../tools/virt-win-reg.pl:766
33406 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33412 #: ../tools/virt-win-reg.pl:769 ../tools/virt-list-filesystems.pl:202
33413 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
33414 #: ../tools/virt-list-partitions.pl:269
33420 #: ../tools/virt-win-reg.pl:771 ../tools/virt-list-filesystems.pl:204
33421 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
33422 #: ../tools/virt-list-partitions.pl:271
33423 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33428 #: ../tools/virt-win-reg.pl:775 ../tools/virt-make-fs.pl:570
33429 msgid "Copyright (C) 2010 Red Hat Inc."
33434 #: ../tools/virt-list-filesystems.pl:32
33436 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33441 #: ../tools/virt-list-filesystems.pl:36
33444 " virt-list-filesystems [--options] domname\n"
33450 #: ../tools/virt-list-filesystems.pl:38
33453 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33459 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33461 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33467 #: ../tools/virt-list-filesystems.pl:45
33469 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33470 "are contained in a virtual machine or disk image."
33475 #: ../tools/virt-list-filesystems.pl:49
33477 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33478 "functionality. For more complex cases you should look at the L<guestfish(1)"
33484 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33485 msgid "B<-l> | B<--long>"
33490 #: ../tools/virt-list-filesystems.pl:108
33492 "With this option, C<virt-list-filesystems> displays the type of each "
33493 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33498 #: ../tools/virt-list-filesystems.pl:115
33499 msgid "B<-a> | B<--all>"
33504 #: ../tools/virt-list-filesystems.pl:117
33506 "Normally we only show mountable filesystems. If this option is given then "
33507 "swap devices are shown too."
33512 #: ../tools/virt-list-filesystems.pl:191
33514 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33515 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33516 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33521 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33522 msgid "Copyright (C) 2009 Red Hat Inc."
33527 #: ../tools/virt-tar.pl:33
33528 msgid "virt-tar - Extract or upload files to a virtual machine"
33533 #: ../tools/virt-tar.pl:37
33536 " virt-tar [--options] -x domname directory tarball\n"
33542 #: ../tools/virt-tar.pl:39
33545 " virt-tar [--options] -u domname tarball directory\n"
33551 #: ../tools/virt-tar.pl:41
33554 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33560 #: ../tools/virt-tar.pl:43
33563 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33568 #: ../tools/virt-tar.pl:47
33570 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33571 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33576 #: ../tools/virt-tar.pl:52
33577 msgid "Download C</home> from the VM into a local tarball:"
33582 #: ../tools/virt-tar.pl:54
33585 " virt-tar -x domname /home home.tar\n"
33591 #: ../tools/virt-tar.pl:56
33594 " virt-tar -zx domname /home home.tar.gz\n"
33600 #: ../tools/virt-tar.pl:58
33601 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33606 #: ../tools/virt-tar.pl:60
33609 " virt-tar -u domname uploadstuff.tar /tmp\n"
33615 #: ../tools/virt-tar.pl:62
33618 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33623 #: ../tools/virt-tar.pl:66
33625 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
33626 "virtual machines. If you do this, you risk disk corruption in the VM. "
33627 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33631 #: ../tools/virt-tar.pl:71
33633 "You can use I<-x> (extract) on live virtual machines, but you might get "
33634 "inconsistent results or errors if there is filesystem activity inside the "
33635 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33636 "work, but the only way to guarantee consistent results is if the virtual "
33637 "machine is shut down."
33642 #: ../tools/virt-tar.pl:79
33644 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33645 "parts of a guest filesystem. There are many possibilities: making backups, "
33646 "uploading data files, snooping on guest activity, fixing or customizing "
33652 #: ../tools/virt-tar.pl:84
33654 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33655 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33656 "should look at the L<guestfish(1)> tool."
33660 #: ../tools/virt-tar.pl:88
33662 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
33663 "its contents (recursively) from the virtual machine into a local tarball. "
33664 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
33665 "virtual machine. You cannot use these two options together."
33669 #: ../tools/virt-tar.pl:94
33671 "In addition, you may need to use the I<-z> (gZip) option to enable "
33672 "compression. When uploading, you have to specify I<-z> if the upload file "
33673 "is compressed because virt-tar won't detect this on its own."
33678 #: ../tools/virt-tar.pl:98
33680 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33681 "example it cannot do PKZip files or bzip2 compression. If you want that "
33682 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33683 "the L<libguestfs(3)> API)."
33688 #: ../tools/virt-tar.pl:156
33689 msgid "B<-x> | B<--extract> | B<--download>"
33694 #: ../tools/virt-tar.pl:158
33695 msgid "B<-u> | B<--upload>"
33699 #: ../tools/virt-tar.pl:160
33701 "Use I<-x> to extract (download) a directory from a virtual machine to a "
33706 #: ../tools/virt-tar.pl:163
33708 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
33709 "Please read the L</WARNING> section above before using this option."
33714 #: ../tools/virt-tar.pl:167
33715 msgid "You must specify exactly one of these options."
33720 #: ../tools/virt-tar.pl:173
33721 msgid "B<-z> | B<--gzip>"
33726 #: ../tools/virt-tar.pl:175
33727 msgid "Specify that the input or output tarball is gzip-compressed."
33731 #: ../tools/virt-tar.pl:288
33733 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
33734 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
33735 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33741 #: ../tools/virt-make-fs.pl:37
33742 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33747 #: ../tools/virt-make-fs.pl:41
33750 " virt-make-fs [--options] input.tar output.img\n"
33756 #: ../tools/virt-make-fs.pl:43
33759 " virt-make-fs [--options] input.tar.gz output.img\n"
33765 #: ../tools/virt-make-fs.pl:45
33768 " virt-make-fs [--options] directory output.img\n"
33774 #: ../tools/virt-make-fs.pl:49
33776 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33777 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33778 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33779 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33780 "you want to attach these filesystems to existing virtual machines (eg. to "
33781 "import large amounts of read-only data to a VM)."
33786 #: ../tools/virt-make-fs.pl:57
33787 msgid "Basic usage is:"
33792 #: ../tools/virt-make-fs.pl:59
33795 " virt-make-fs input output\n"
33801 #: ../tools/virt-make-fs.pl:61
33803 "where C<input> is either a directory containing files that you want to add, "
33804 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
33805 "C<output> is a disk image. The input type is detected automatically. The "
33806 "output disk image defaults to a raw ext2 image unless you specify extra "
33807 "flags (see L</OPTIONS> below)."
33812 #: ../tools/virt-make-fs.pl:67
33813 msgid "EXTRA SPACE"
33817 #: ../tools/virt-make-fs.pl:69
33819 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
33820 "the files that it contains, but might have extra space. Depending on how "
33821 "you are going to use the output, you might think this extra space is wasted "
33822 "and want to minimize it, or you might want to leave space so that more files "
33823 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
33824 "but you can use the I<--size> flag to leave space in the filesystem if you "
33829 #: ../tools/virt-make-fs.pl:77
33831 "An alternative way to leave extra space but not make the output image any "
33832 "bigger is to use an alternative disk image format (instead of the default "
33833 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
33834 "image format (check your hypervisor supports this before using it). This "
33835 "allows you to choose a large I<--size> but the extra space won't actually be "
33836 "allocated in the image until you try to store something in it."
33840 #: ../tools/virt-make-fs.pl:85
33842 "Don't forget that you can also use local commands including L<resize2fs(8)> "
33843 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
33844 "to build another image from scratch."
33849 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
33850 #: ../tools/virt-make-fs.pl:142
33856 #: ../tools/virt-make-fs.pl:91
33859 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
33865 #: ../tools/virt-make-fs.pl:93
33866 msgid "FILESYSTEM TYPE"
33871 #: ../tools/virt-make-fs.pl:95
33873 "The default filesystem type is C<ext2>. Just about any filesystem type that "
33874 "libguestfs supports can be used (but I<not> read-only formats like "
33875 "ISO9660). Here are some of the more common choices:"
33880 #: ../tools/virt-make-fs.pl:101
33886 #: ../tools/virt-make-fs.pl:103
33888 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
33889 "you are not going to use the filesystem in a way that requires the journal, "
33890 "then this is just wasted overhead."
33895 #: ../tools/virt-make-fs.pl:107
33896 msgid "I<ntfs> or I<vfat>"
33901 #: ../tools/virt-make-fs.pl:109
33902 msgid "Useful if exporting data to a Windows guest."
33907 #: ../tools/virt-make-fs.pl:111
33909 "I<Note for vfat>: The tar archive or local directory must only contain files "
33910 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
33911 "program running within libguestfs is unable to change the ownership of non-"
33912 "root files, since vfat itself does not support this."
33917 #: ../tools/virt-make-fs.pl:116
33923 #: ../tools/virt-make-fs.pl:118
33925 "Lower overhead than C<ext2>, but certain limitations on filename length and "
33926 "total filesystem size."
33931 #: ../tools/virt-make-fs.pl:125
33934 " virt-make-fs --type=minix input minixfs.img\n"
33940 #: ../tools/virt-make-fs.pl:127
33941 msgid "TO PARTITION OR NOT TO PARTITION"
33946 #: ../tools/virt-make-fs.pl:129
33947 msgid "Optionally virt-make-fs can add a partition table to the output disk."
33952 #: ../tools/virt-make-fs.pl:131
33954 "Adding a partition can make the disk image more compatible with certain "
33955 "virtualized operating systems which don't expect to see a filesystem "
33956 "directly located on a block device (Linux doesn't care and will happily "
33957 "handle both types)."
33962 #: ../tools/virt-make-fs.pl:136
33964 "On the other hand, if you have a partition table then the output image is no "
33965 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
33966 "directly on a partitioned disk image. (However libguestfs tools such as "
33967 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
33972 #: ../tools/virt-make-fs.pl:144
33973 msgid "Add an MBR partition:"
33978 #: ../tools/virt-make-fs.pl:146
33981 " virt-make-fs --partition -- input disk.img\n"
33987 #: ../tools/virt-make-fs.pl:148
33989 "If the output disk image could be terabyte-sized or larger, it's better to "
33990 "use an EFI/GPT-compatible partition table:"
33995 #: ../tools/virt-make-fs.pl:151
33998 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34004 #: ../tools/virt-make-fs.pl:179
34005 msgid "Enable debugging information."
34010 #: ../tools/virt-make-fs.pl:185
34011 msgid "B<--size=E<lt>NE<gt>>"
34016 #: ../tools/virt-make-fs.pl:187
34017 msgid "B<--size=+E<lt>NE<gt>>"
34022 #: ../tools/virt-make-fs.pl:189
34023 msgid "B<-s E<lt>NE<gt>>"
34028 #: ../tools/virt-make-fs.pl:191
34029 msgid "B<-s +E<lt>NE<gt>>"
34033 #: ../tools/virt-make-fs.pl:193
34035 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34040 #: ../tools/virt-make-fs.pl:196
34042 "If this option is I<not> given, then the output image will be just large "
34043 "enough to contain all the files, with not much wasted space."
34048 #: ../tools/virt-make-fs.pl:199
34050 "To choose a fixed size output disk, specify an absolute number followed by b/"
34051 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34052 "Petabytes or Exabytes. This must be large enough to contain all the input "
34053 "files, else you will get an error."
34057 #: ../tools/virt-make-fs.pl:204
34059 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34060 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34061 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34062 "the input files, and (approximately) an extra 200 MB free space."
34067 #: ../tools/virt-make-fs.pl:210
34069 "Note that virt-make-fs estimates free space, and therefore will not produce "
34070 "filesystems containing precisely the free space requested. (It is much more "
34071 "expensive and time-consuming to produce a filesystem which has precisely the "
34072 "desired free space)."
34077 #: ../tools/virt-make-fs.pl:219
34078 msgid "B<--format=E<lt>fmtE<gt>>"
34083 #: ../tools/virt-make-fs.pl:221
34084 msgid "B<-F E<lt>fmtE<gt>>"
34089 #: ../tools/virt-make-fs.pl:223
34090 msgid "Choose the output disk image format."
34095 #: ../tools/virt-make-fs.pl:225
34096 msgid "The default is C<raw> (raw disk image)."
34101 #: ../tools/virt-make-fs.pl:227
34103 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34104 "that would really make sense here is C<qcow2>."
34109 #: ../tools/virt-make-fs.pl:234
34110 msgid "B<--type=E<lt>fsE<gt>>"
34115 #: ../tools/virt-make-fs.pl:236
34116 msgid "B<-t E<lt>fsE<gt>>"
34121 #: ../tools/virt-make-fs.pl:238
34122 msgid "Choose the output filesystem type."
34127 #: ../tools/virt-make-fs.pl:240
34128 msgid "The default is C<ext2>."
34133 #: ../tools/virt-make-fs.pl:242
34135 "Any filesystem which is supported read-write by libguestfs can be used here."
34140 #: ../tools/virt-make-fs.pl:249
34141 msgid "B<--partition>"
34146 #: ../tools/virt-make-fs.pl:251
34147 msgid "B<--partition=E<lt>parttypeE<gt>>"
34152 #: ../tools/virt-make-fs.pl:253
34154 "If specified, this flag adds an MBR partition table to the output disk image."
34158 #: ../tools/virt-make-fs.pl:256
34160 "You can change the partition table type, eg. I<--partition=gpt> for large "
34165 #: ../tools/virt-make-fs.pl:259
34167 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34168 "might consider the next parameter to be the partition type. For example:"
34173 #: ../tools/virt-make-fs.pl:263
34176 " virt-make-fs --partition input.tar ...\n"
34181 #: ../tools/virt-make-fs.pl:265
34183 "would cause virt-make-fs to think you wanted to use a partition type of "
34184 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34185 "dash) between options and the input file argument:"
34190 #: ../tools/virt-make-fs.pl:269
34193 " virt-make-fs --partition -- input.tar ...\n"
34198 #: ../tools/virt-make-fs.pl:541
34200 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34201 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34202 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34207 #: ../tools/virt-make-fs.pl:558
34210 " export LIBGUESTFS_DEBUG=1\n"
34211 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34217 #: ../tools/virt-make-fs.pl:561
34219 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34225 #: ../tools/virt-list-partitions.pl:32
34227 "virt-list-partitions - List partitions in a virtual machine or disk image"
34232 #: ../tools/virt-list-partitions.pl:36
34235 " virt-list-partitions [--options] domname\n"
34241 #: ../tools/virt-list-partitions.pl:38
34244 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34250 #: ../tools/virt-list-partitions.pl:45
34252 "C<virt-list-partitions> is a command line tool to list the partitions that "
34253 "are contained in a virtual machine or disk image. It is mainly useful as a "
34254 "first step to using L<virt-resize(1)>."
34259 #: ../tools/virt-list-partitions.pl:50
34261 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34262 "functionality. For more complex cases you should look at the L<guestfish(1)"
34268 #: ../tools/virt-list-partitions.pl:107
34269 msgid "B<-h> | B<--human-readable>"
34274 #: ../tools/virt-list-partitions.pl:109
34275 msgid "Show sizes in human-readable form (eg. \"1G\")."
34280 #: ../tools/virt-list-partitions.pl:117
34282 "With this option, C<virt-list-partitions> displays the type and size of each "
34283 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34288 #: ../tools/virt-list-partitions.pl:124
34289 msgid "B<-t> | B<--total>"
34294 #: ../tools/virt-list-partitions.pl:126
34296 "Display the total size of each block device (as a separate row or rows)."
34301 #: ../tools/virt-list-partitions.pl:259
34303 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34304 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34305 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34310 #: ../tools/virt-list-partitions.pl:275
34311 msgid "Copyright (C) 2009-2010 Red Hat Inc."