1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-06-30 15:51+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
24 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
25 #: ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
37 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
38 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
39 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
40 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
41 #: ../tools/virt-list-partitions.pl:34
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
56 #: ../src/guestfs.pod:11
59 " guestfs_h *g = guestfs_create ();\n"
60 " guestfs_add_drive (g, \"guest.img\");\n"
61 " guestfs_launch (g);\n"
62 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
63 " guestfs_touch (g, \"/hello\");\n"
64 " guestfs_umount (g, \"/\");\n"
65 " guestfs_close (g);\n"
71 #: ../src/guestfs.pod:19
74 " cc prog.c -o prog -lguestfs\n"
76 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
82 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
83 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
84 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
85 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
86 #: ../tools/virt-list-partitions.pl:40
92 #: ../src/guestfs.pod:25
94 "Libguestfs is a library for accessing and modifying guest disk images. "
95 "Amongst the things this is good for: making batch configuration changes to "
96 "guests, getting disk used/free statistics (see also: virt-df), migrating "
97 "between virtualization systems (see also: virt-p2v), performing partial "
98 "backups, performing partial guest clones, cloning guests and changing "
99 "registry/UUID/hostname info, and much else besides."
104 #: ../src/guestfs.pod:33
106 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
107 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
108 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
114 #: ../src/guestfs.pod:38
116 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
117 "what filesystem is in each LV, etc.). It can also run commands in the "
118 "context of the guest. Also you can access filesystems over FUSE."
123 #: ../src/guestfs.pod:43
125 "Libguestfs is a library that can be linked with C and C++ management "
126 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
127 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
133 #: ../src/guestfs.pod:48
135 "You don't need to be root to use libguestfs, although obviously you do need "
136 "enough permissions to access the disk images."
141 #: ../src/guestfs.pod:51
143 "Libguestfs is a large API because it can do many things. For a gentle "
144 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:54
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
157 #: ../src/guestfs.pod:57
163 #: ../src/guestfs.pod:59
165 "This section provides a gentler overview of the libguestfs API. We also try "
166 "to group API calls together, where that may not be obvious from reading "
167 "about the individual calls in the main section of this manual."
172 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
189 #: ../src/guestfs.pod:73
190 msgid "The general structure of all libguestfs-using programs looks like this:"
195 #: ../src/guestfs.pod:76
198 " guestfs_h *g = guestfs_create ();\n"
204 #: ../src/guestfs.pod:78
207 " /* Call guestfs_add_drive additional times if there are\n"
208 " * multiple disk images.\n"
210 " guestfs_add_drive (g, \"guest.img\");\n"
216 #: ../src/guestfs.pod:83
219 " /* Most manipulation calls won't work until you've launched\n"
220 " * the handle 'g'. You have to do this _after_ adding drives\n"
221 " * and _before_ other commands.\n"
223 " guestfs_launch (g);\n"
229 #: ../src/guestfs.pod:89
232 " /* Now you can examine what partitions, LVs etc are available.\n"
234 " char **partitions = guestfs_list_partitions (g);\n"
235 " char **logvols = guestfs_lvs (g);\n"
241 #: ../src/guestfs.pod:94
244 " /* To access a filesystem in the image, you must mount it.\n"
246 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 " /* Now you can perform filesystem actions on the guest\n"
257 " guestfs_touch (g, \"/hello\");\n"
263 #: ../src/guestfs.pod:103
266 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
267 " * it is done automatically when you close the handle. See\n"
268 " * discussion of autosync in this page.\n"
270 " guestfs_sync (g);\n"
276 #: ../src/guestfs.pod:109
279 " /* Close the handle 'g'. */\n"
280 " guestfs_close (g);\n"
286 #: ../src/guestfs.pod:112
288 "The code above doesn't include any error checking. In real code you should "
289 "check return values carefully for errors. In general all functions that "
290 "return integers return C<-1> on error, and all functions that return "
291 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
292 "how to handle errors, and consult the documentation for each function call "
293 "below to see precisely how they return error indications. See L<guestfs-"
294 "examples(3)> for fully worked examples."
299 #: ../src/guestfs.pod:121
305 #: ../src/guestfs.pod:123
307 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
308 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
309 "actual block device, or simply an empty file of zeroes that you have created "
310 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
316 #: ../src/guestfs.pod:129
318 "The call you should use in modern code for adding drives is L</"
319 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
320 "specifying that the format is raw, do:"
325 #: ../src/guestfs.pod:133
328 " guestfs_add_drive_opts (g, filename,\n"
329 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
336 #: ../src/guestfs.pod:137
337 msgid "You can add a disk read-only using:"
342 #: ../src/guestfs.pod:139
345 " guestfs_add_drive_opts (g, filename,\n"
346 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
347 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
354 #: ../src/guestfs.pod:144
356 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
357 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
371 #: ../src/guestfs.pod:151
373 "You must add at least one disk image, and you may add multiple disk images. "
374 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
375 "first one you added), C</dev/sdb> (for the second one you added), etc."
380 #: ../src/guestfs.pod:156
382 "Once L</guestfs_launch> has been called you cannot add any more images. You "
383 "can call L</guestfs_list_devices> to get a list of the device names, in the "
384 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
389 #: ../src/guestfs.pod:161
394 #: ../src/guestfs.pod:163
396 "Before you can read or write files, create directories and so on in a disk "
397 "image that contains filesystems, you have to mount those filesystems using "
398 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
399 "a disk image contains (for example) one partition with a filesystem on that "
400 "partition, then you can mount it directly:"
404 #: ../src/guestfs.pod:170
407 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
412 #: ../src/guestfs.pod:172
414 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
415 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
416 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
417 "that these are libguestfs virtual devices, and are nothing to do with host "
422 #: ../src/guestfs.pod:178
424 "If you are given a disk image and you don't know what it contains then you "
425 "have to find out. Libguestfs can do that too: use L</"
426 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
427 "LVs, and either try mounting each to see what is mountable, or else examine "
428 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
429 "filesystems, use L</guestfs_list_filesystems>."
433 #: ../src/guestfs.pod:186
435 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
436 "L</INSPECTION> below). But you might find it easier to look at higher level "
437 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
441 #: ../src/guestfs.pod:191
443 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
444 "several other variations of the C<guestfs_mount_*> call."
449 #: ../src/guestfs.pod:194
450 msgid "FILESYSTEM ACCESS AND MODIFICATION"
455 #: ../src/guestfs.pod:196
457 "The majority of the libguestfs API consists of fairly low-level calls for "
458 "accessing and modifying the files, directories, symlinks etc on mounted "
459 "filesystems. There are over a hundred such calls which you can find listed "
460 "in detail below in this man page, and we don't even pretend to cover them "
461 "all in this overview."
466 #: ../src/guestfs.pod:202
468 "Specify filenames as full paths, starting with C<\"/\"> and including the "
474 #: ../src/guestfs.pod:205
476 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
477 "the file called C<\"etc/passwd\"> then you could do:"
482 #: ../src/guestfs.pod:208
485 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
491 #: ../src/guestfs.pod:210
493 "This would return C<data> as a newly allocated buffer containing the full "
494 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
495 "or C<NULL> if there was an error."
500 #: ../src/guestfs.pod:214
502 "As another example, to create a top-level directory on that filesystem "
503 "called C<\"var\"> you would do:"
508 #: ../src/guestfs.pod:217
511 " guestfs_mkdir (g, \"/var\");\n"
517 #: ../src/guestfs.pod:219
518 msgid "To create a symlink you could do:"
523 #: ../src/guestfs.pod:221
526 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
527 " \"/etc/rc3.d/S30portmap\");\n"
533 #: ../src/guestfs.pod:224
535 "Libguestfs will reject attempts to use relative paths and there is no "
536 "concept of a current working directory."
541 #: ../src/guestfs.pod:227
543 "Libguestfs can return errors in many situations: for example if the "
544 "filesystem isn't writable, or if a file or directory that you requested "
545 "doesn't exist. If you are using the C API (documented here) you have to "
546 "check for those error conditions after each call. (Other language bindings "
547 "turn these errors into exceptions)."
552 #: ../src/guestfs.pod:233
554 "File writes are affected by the per-handle umask, set by calling L</"
555 "guestfs_umask> and defaulting to 022. See L</UMASK>."
560 #: ../src/guestfs.pod:236
566 #: ../src/guestfs.pod:238
568 "Libguestfs contains API calls to read, create and modify partition tables on "
574 #: ../src/guestfs.pod:241
576 "In the common case where you want to create a single partition covering the "
577 "whole disk, you should use the L</guestfs_part_disk> call:"
582 #: ../src/guestfs.pod:245
585 " const char *parttype = \"mbr\";\n"
586 " if (disk_is_larger_than_2TB)\n"
587 " parttype = \"gpt\";\n"
588 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
594 #: ../src/guestfs.pod:250
596 "Obviously this effectively wipes anything that was on that disk image before."
601 #: ../src/guestfs.pod:253
607 #: ../src/guestfs.pod:255
609 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
610 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
611 "you familiarize yourself with the concepts of physical volumes, volume "
612 "groups and logical volumes."
617 #: ../src/guestfs.pod:260
619 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
620 "tldp.org/HOWTO/LVM-HOWTO/>."
625 #: ../src/guestfs.pod:263
630 #: ../src/guestfs.pod:265
632 "Use L</guestfs_cat> to download small, text only files. This call is "
633 "limited to files which are less than 2 MB and which cannot contain any ASCII "
634 "NUL (C<\\0>) characters. However the API is very simple to use."
639 #: ../src/guestfs.pod:269
641 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
642 "bit data, since it returns a (pointer, size) pair. However it is still "
643 "limited to \"small\" files, less than 2 MB."
648 #: ../src/guestfs.pod:273
650 "L</guestfs_download> can be used to download any file, with no limits on "
651 "content or size (even files larger than 4 GB)."
656 #: ../src/guestfs.pod:276
658 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
663 #: ../src/guestfs.pod:279
669 #: ../src/guestfs.pod:281
671 "It's often the case that you want to write a file or files to the disk image."
676 #: ../src/guestfs.pod:284
678 "To write a small file with fixed content, use L</guestfs_write>. To create "
679 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
680 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
681 "of other functions for creating test files, for example L</guestfs_fill> and "
682 "L</guestfs_fill_pattern>."
687 #: ../src/guestfs.pod:290
689 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
690 "file content or size (even files larger than 4 GB)."
695 #: ../src/guestfs.pod:293
697 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
702 #: ../src/guestfs.pod:295
704 "However the fastest way to upload I<large numbers of arbitrary files> is to "
705 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
706 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
707 "in a predictable way (eg. adding it last after all other drives) then you "
708 "can get the device name from L</guestfs_list_devices> and mount it directly "
709 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
710 "portable between kernel versions, and they don't support labels or UUIDs. "
711 "If you want to pre-build an image or you need to mount it using a label or "
712 "UUID, use an ISO image instead."
717 #: ../src/guestfs.pod:306
723 #: ../src/guestfs.pod:308
725 "There are various different commands for copying between files and devices "
726 "and in and out of the guest filesystem. These are summarised in the table "
732 #: ../src/guestfs.pod:314
733 msgid "B<file> to B<file>"
738 #: ../src/guestfs.pod:316
740 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
741 "directories recursively."
746 #: ../src/guestfs.pod:319
747 msgid "B<file or device> to B<file or device>"
752 #: ../src/guestfs.pod:321
754 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
755 "devices in the guest."
760 #: ../src/guestfs.pod:324
761 msgid "Example: duplicate the contents of an LV:"
766 #: ../src/guestfs.pod:326
769 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
775 #: ../src/guestfs.pod:328
777 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
778 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
779 "guestfs_copy_size>."
784 #: ../src/guestfs.pod:332
785 msgid "B<file on the host> to B<file or device>"
790 #: ../src/guestfs.pod:334
791 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
796 #: ../src/guestfs.pod:336
797 msgid "B<file or device> to B<file on the host>"
802 #: ../src/guestfs.pod:338
803 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
808 #: ../src/guestfs.pod:342
809 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
814 #: ../src/guestfs.pod:344
816 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
817 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
818 "appears you can only upload and download to files. However many Un*x-like "
819 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
820 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
821 "and arbitrary file descriptor N."
826 #: ../src/guestfs.pod:352
827 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
831 #: ../src/guestfs.pod:355
834 " guestfs_download (g, filename, \"/dev/stdout\");\n"
839 #: ../src/guestfs.pod:357
840 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
844 #: ../src/guestfs.pod:359
848 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
849 " guestfs_tar_out (g, \"/\", devfd);\n"
855 #: ../src/guestfs.pod:363
856 msgid "LISTING FILES"
861 #: ../src/guestfs.pod:365
863 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
864 "L<guestfish(1)>-equivalent command C<ll>)."
869 #: ../src/guestfs.pod:368
871 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
872 "programs, as a flat list of strings."
877 #: ../src/guestfs.pod:371
879 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
880 "directory, plus additional information about each one. It is more "
881 "equivalent to using the L<readdir(3)> call on a local filesystem."
886 #: ../src/guestfs.pod:375
888 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
893 #: ../src/guestfs.pod:378
894 msgid "RUNNING COMMANDS"
899 #: ../src/guestfs.pod:380
901 "Although libguestfs is primarily an API for manipulating files inside guest "
902 "images, we also provide some limited facilities for running commands inside "
908 #: ../src/guestfs.pod:384
909 msgid "There are many limitations to this:"
914 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
915 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
916 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
917 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
918 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
919 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
920 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
921 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
922 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
923 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
924 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
925 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
926 #: ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980
927 #: ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
929 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
930 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603
931 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
932 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623
933 #: ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631
934 #: ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645
935 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787
936 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796
937 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862
938 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871
939 #: ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2795
940 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2810
941 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish.pod:445
942 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
943 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
944 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
945 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
946 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074
947 #: ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082
948 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094
949 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102
950 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
951 #: ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210
952 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
953 #: ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266
954 #: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275
955 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908
956 #: ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923
957 #: ../fish/guestfish-actions.pod:1930 ../tools/virt-win-reg.pl:195
958 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
959 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
960 #: ../tools/virt-win-reg.pl:720
966 #: ../src/guestfs.pod:390
968 "The kernel version that the command runs under will be different from what "
974 #: ../src/guestfs.pod:395
976 "If the command needs to communicate with daemons, then most likely they "
982 #: ../src/guestfs.pod:400
983 msgid "The command will be running in limited memory."
988 #: ../src/guestfs.pod:404
990 "The network may not be available unless you enable it (see L</"
991 "guestfs_set_network>)."
996 #: ../src/guestfs.pod:409
997 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1002 #: ../src/guestfs.pod:413
1004 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1009 #: ../src/guestfs.pod:418
1011 "For SELinux guests, you may need to enable SELinux and load policy first. "
1012 "See L</SELINUX> in this manpage."
1017 #: ../src/guestfs.pod:423
1019 "I<Security:> It is not safe to run commands from untrusted, possibly "
1020 "malicious guests. These commands may attempt to exploit your program by "
1021 "sending unexpected output. They could also try to exploit the Linux kernel "
1022 "or qemu provided by the libguestfs appliance. They could use the network "
1023 "provided by the libguestfs appliance to bypass ordinary network partitions "
1024 "and firewalls. They could use the elevated privileges or different SELinux "
1025 "context of your program to their advantage."
1030 #: ../src/guestfs.pod:432
1032 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1033 "(a script which runs when the guest next boots normally), and to have this "
1034 "script run the commands you want in the normal context of the running guest, "
1035 "network security and so on. For information about other security issues, "
1041 #: ../src/guestfs.pod:440
1043 "The two main API calls to run commands are L</guestfs_command> and L</"
1044 "guestfs_sh> (there are also variations)."
1049 #: ../src/guestfs.pod:443
1051 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1052 "shell globs, redirections, etc will work."
1057 #: ../src/guestfs.pod:446
1058 msgid "CONFIGURATION FILES"
1063 #: ../src/guestfs.pod:448
1065 "To read and write configuration files in Linux guest filesystems, we "
1066 "strongly recommend using Augeas. For example, Augeas understands how to "
1067 "read and write, say, a Linux shadow password file or X.org configuration "
1068 "file, and so avoids you having to write that code."
1073 #: ../src/guestfs.pod:453
1075 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1076 "document Augeas itself here because there is excellent documentation on the "
1077 "L<http://augeas.net/> website."
1082 #: ../src/guestfs.pod:457
1084 "If you don't want to use Augeas (you fool!) then try calling L</"
1085 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1091 #: ../src/guestfs.pod:461
1097 #: ../src/guestfs.pod:463
1099 "We support SELinux guests. To ensure that labeling happens correctly in "
1100 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1105 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1106 #: ../src/guestfs.pod:2426
1112 #: ../src/guestfs.pod:471
1113 msgid "Before launching, do:"
1118 #: ../src/guestfs.pod:473
1121 " guestfs_set_selinux (g, 1);\n"
1127 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1128 #: ../src/guestfs.pod:2451
1134 #: ../src/guestfs.pod:477
1136 "After mounting the guest's filesystem(s), load the policy. This is best "
1137 "done by running the L<load_policy(8)> command in the guest itself:"
1142 #: ../src/guestfs.pod:481
1145 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1151 #: ../src/guestfs.pod:483
1153 "(Older versions of C<load_policy> require you to specify the name of the "
1159 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1165 #: ../src/guestfs.pod:488
1167 "Optionally, set the security context for the API. The correct security "
1168 "context to use can only be known by inspecting the guest. As an example:"
1173 #: ../src/guestfs.pod:492
1176 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1182 #: ../src/guestfs.pod:496
1183 msgid "This will work for running commands and editing existing files."
1188 #: ../src/guestfs.pod:498
1190 "When new files are created, you may need to label them explicitly, for "
1191 "example by running the external command C<restorecon pathname>."
1196 #: ../src/guestfs.pod:502
1202 #: ../src/guestfs.pod:504
1204 "Certain calls are affected by the current file mode creation mask (the "
1205 "\"umask\"). In particular ones which create files or directories, such as "
1206 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1207 "either the default mode that the file is created with or modifies the mode "
1213 #: ../src/guestfs.pod:510
1215 "The default umask is C<022>, so files are created with modes such as C<0644> "
1216 "and directories with C<0755>."
1221 #: ../src/guestfs.pod:513
1223 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1224 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1225 "guestfs_chmod> after creating each file or directory."
1230 #: ../src/guestfs.pod:517
1231 msgid "For more information about umask, see L<umask(2)>."
1236 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1237 msgid "ENCRYPTED DISKS"
1242 #: ../src/guestfs.pod:521
1244 "Libguestfs allows you to access Linux guests which have been encrypted using "
1245 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1246 "standard. This includes nearly all whole disk encryption systems used by "
1247 "modern Linux guests."
1252 #: ../src/guestfs.pod:527
1254 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1255 "returns the string C<crypto_LUKS>)."
1260 #: ../src/guestfs.pod:530
1262 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1263 "will require the passphrase!"
1268 #: ../src/guestfs.pod:533
1270 "Opening a LUKS device creates a new device mapper device called C</dev/"
1271 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1272 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1273 "from and encrypted to the underlying block device respectively."
1278 #: ../src/guestfs.pod:539
1280 "LVM volume groups on the device can be made visible by calling L</"
1281 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1282 "(s) can now be mounted in the usual way."
1287 #: ../src/guestfs.pod:543
1289 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1290 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1291 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1292 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1293 "underlying encrypted block device)."
1298 #: ../src/guestfs.pod:550
1303 #: ../src/guestfs.pod:552
1305 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1306 "contains operating systems, an install CD or a live CD. (These APIs used to "
1307 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1308 "version 1.5.3 the most frequently used part of this library has been "
1309 "rewritten in C and moved into the core code)."
1314 #: ../src/guestfs.pod:559
1316 "Add all disks belonging to the unknown virtual machine and call L</"
1317 "guestfs_launch> in the usual way."
1322 #: ../src/guestfs.pod:562
1324 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1325 "and certain heuristics, and returns a list of operating systems that were "
1326 "found. An empty list means none were found. A single element is the root "
1327 "filesystem of the operating system. For dual- or multi-boot guests, "
1328 "multiple roots can be returned, each one corresponding to a separate "
1329 "operating system. (Multi-boot virtual machines are extremely rare in the "
1330 "world of virtualization, but since this scenario can happen, we have built "
1331 "libguestfs to deal with it.)"
1336 #: ../src/guestfs.pod:571
1338 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1339 "to get additional details about that operating system. For example, call L</"
1340 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1341 "Windows and Linux-based operating systems respectively."
1346 #: ../src/guestfs.pod:577
1348 "Un*x-like and Linux-based operating systems usually consist of several "
1349 "filesystems which are mounted at boot time (for example, a separate boot "
1350 "partition mounted on C</boot>). The inspection rules are able to detect how "
1351 "filesystems correspond to mount points. Call "
1352 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1353 "hash table like this example:"
1358 #: ../src/guestfs.pod:584
1361 " /boot => /dev/sda1\n"
1362 " / => /dev/vg_guest/lv_root\n"
1363 " /usr => /dev/vg_guest/lv_usr\n"
1369 #: ../src/guestfs.pod:588
1371 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1372 "filesystems as suggested."
1377 #: ../src/guestfs.pod:591
1379 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1380 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1385 #: ../src/guestfs.pod:595
1387 "Inspection currently only works for some common operating systems. "
1388 "Contributors are welcome to send patches for other operating systems that we "
1389 "currently cannot detect."
1394 #: ../src/guestfs.pod:599
1396 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1397 "for more details. The L</guestfs_inspect_os> function just ignores any "
1398 "encrypted devices."
1403 #: ../src/guestfs.pod:603
1405 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1406 "inspection and caches the results in the guest handle. Subsequent calls to "
1407 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1408 "read the disks. If you change the content of the guest disks, you can redo "
1409 "inspection by calling L</guestfs_inspect_os> again. (L</"
1410 "guestfs_inspect_list_applications> works a little differently from the other "
1411 "calls and does read the disks. See documentation for that function for "
1416 #: ../src/guestfs.pod:612
1417 msgid "INSPECTING INSTALL DISKS"
1421 #: ../src/guestfs.pod:614
1423 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1428 #: ../src/guestfs.pod:617
1430 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1431 "system, which currently can be C<installed> (a regular operating system) or "
1432 "C<installer> (some sort of install disk)."
1436 #: ../src/guestfs.pod:621
1438 "Further information is available about the operating system that can be "
1439 "installed using the regular inspection APIs like L</"
1440 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1444 #: ../src/guestfs.pod:626
1446 "Some additional information specific to installer disks is also available "
1447 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1448 "guestfs_inspect_is_multipart> calls."
1453 #: ../src/guestfs.pod:631
1454 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1459 #: ../src/guestfs.pod:633
1461 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1462 "ntfs-3g.org/> driver."
1467 #: ../src/guestfs.pod:636
1468 msgid "DRIVE LETTERS AND PATHS"
1473 #: ../src/guestfs.pod:638
1475 "DOS and Windows still use drive letters, and the filesystems are always "
1476 "treated as case insensitive by Windows itself, and therefore you might find "
1477 "a Windows configuration file referring to a path like C<c:\\windows"
1478 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1479 "might be referred to as C</WINDOWS/System32>."
1483 #: ../src/guestfs.pod:644
1485 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1486 "L</guestfs_inspect_get_drive_mappings>)"
1490 #: ../src/guestfs.pod:647
1492 "Dealing with separator characters (backslash vs forward slash) is outside "
1493 "the scope of libguestfs, but usually a simple character replacement will "
1498 #: ../src/guestfs.pod:651
1500 "To resolve the case insensitivity of paths, call L</"
1501 "guestfs_case_sensitive_path>."
1506 #: ../src/guestfs.pod:654
1507 msgid "ACCESSING THE WINDOWS REGISTRY"
1512 #: ../src/guestfs.pod:656
1514 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1515 "files, through the library C<hivex> which is part of the libguestfs project "
1516 "although ships as a separate tarball. You have to locate and download the "
1517 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1518 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1519 "reg(1)> for more help on this issue."
1524 #: ../src/guestfs.pod:664
1525 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1530 #: ../src/guestfs.pod:666
1532 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1533 "provide something which looks like a Linux symlink. The way it tries to do "
1534 "the rewriting is described here:"
1539 #: ../src/guestfs.pod:670
1541 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1547 #: ../src/guestfs.pod:672
1549 "The essential problem is that ntfs-3g simply does not have enough "
1550 "information to do a correct job. NTFS links can contain drive letters and "
1551 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1552 "It is almost certainly the case that libguestfs callers should ignore what "
1553 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1558 #: ../src/guestfs.pod:679
1560 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1561 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1562 "attribute, and read the raw reparse data from that (you can find the format "
1563 "documented in various places around the web)."
1568 #: ../src/guestfs.pod:684
1569 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1574 #: ../src/guestfs.pod:686
1576 "There are other useful extended attributes that can be read from ntfs-3g "
1577 "filesystems (using L</guestfs_getxattr>). See:"
1582 #: ../src/guestfs.pod:689
1584 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1589 #: ../src/guestfs.pod:691
1590 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1595 #: ../src/guestfs.pod:693
1597 "Although we don't want to discourage you from using the C API, we will "
1598 "mention here that the same API is also available in other languages."
1602 #: ../src/guestfs.pod:696
1604 "The API is broadly identical in all supported languages. This means that "
1605 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1606 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1607 "OCaml. In other words, a straightforward, predictable isomorphism between "
1613 #: ../src/guestfs.pod:702
1615 "Error messages are automatically transformed into exceptions if the language "
1621 #: ../src/guestfs.pod:705
1623 "We don't try to \"object orientify\" parts of the API in OO languages, "
1624 "although contributors are welcome to write higher level APIs above what we "
1625 "provide in their favourite languages if they wish."
1630 #: ../src/guestfs.pod:711
1636 #: ../src/guestfs.pod:713
1638 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1639 "identical to the C API. C++ classes and exceptions are not used."
1644 #: ../src/guestfs.pod:717
1650 #: ../src/guestfs.pod:719
1652 "The C# bindings are highly experimental. Please read the warnings at the "
1653 "top of C<csharp/Libguestfs.cs>."
1658 #: ../src/guestfs.pod:722
1664 #: ../src/guestfs.pod:724
1666 "This is the only language binding that is working but incomplete. Only "
1667 "calls which return simple integers have been bound in Haskell, and we are "
1668 "looking for help to complete this binding."
1673 #: ../src/guestfs.pod:728
1679 #: ../src/guestfs.pod:730
1681 "Full documentation is contained in the Javadoc which is distributed with "
1687 #: ../src/guestfs.pod:733
1692 #: ../src/guestfs.pod:735
1693 msgid "See L<guestfs-ocaml(3)>."
1698 #: ../src/guestfs.pod:737
1703 #: ../src/guestfs.pod:739
1704 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1709 #: ../src/guestfs.pod:741
1715 #: ../src/guestfs.pod:743
1717 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1718 "the php-libguestfs package for your distribution."
1723 #: ../src/guestfs.pod:746
1724 msgid "The PHP binding only works correctly on 64 bit machines."
1729 #: ../src/guestfs.pod:748
1734 #: ../src/guestfs.pod:750
1735 msgid "See L<guestfs-python(3)>."
1740 #: ../src/guestfs.pod:752
1745 #: ../src/guestfs.pod:754
1746 msgid "See L<guestfs-ruby(3)>."
1751 #: ../src/guestfs.pod:756
1752 msgid "B<shell scripts>"
1756 #: ../src/guestfs.pod:758
1757 msgid "See L<guestfish(1)>."
1762 #: ../src/guestfs.pod:762
1763 msgid "LIBGUESTFS GOTCHAS"
1768 #: ../src/guestfs.pod:764
1770 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1771 "system [...] that works in the way it is documented but is counterintuitive "
1772 "and almost invites mistakes.\""
1777 #: ../src/guestfs.pod:768
1779 "Since we developed libguestfs and the associated tools, there are several "
1780 "things we would have designed differently, but are now stuck with for "
1781 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1782 "release, you can expect these to change. Beware of them."
1787 #: ../src/guestfs.pod:776
1788 msgid "Autosync / forgetting to sync."
1792 #: ../src/guestfs.pod:778
1794 "I<Update:> Autosync is enabled by default for all API users starting from "
1795 "libguestfs 1.5.24. This section only applies to older versions."
1800 #: ../src/guestfs.pod:781
1802 "When modifying a filesystem from C or another language, you B<must> unmount "
1803 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1804 "libguestfs handle. You can also call:"
1809 #: ../src/guestfs.pod:785
1812 " guestfs_set_autosync (g, 1);\n"
1818 #: ../src/guestfs.pod:787
1820 "to have the unmount/sync done automatically for you when the handle 'g' is "
1821 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1826 #: ../src/guestfs.pod:791
1828 "If you forget to do this, then it is entirely possible that your changes "
1829 "won't be written out, or will be partially written, or (very rarely) that "
1830 "you'll get disk corruption."
1835 #: ../src/guestfs.pod:795
1837 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1838 "guestfish scripts that forget to sync will work just fine, which can make "
1839 "this very puzzling if you are trying to debug a problem."
1844 #: ../src/guestfs.pod:799
1845 msgid "Mount option C<-o sync> should not be the default."
1850 #: ../src/guestfs.pod:801
1852 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1853 "However C<-o sync> does not add any reliability benefit, but does have a "
1854 "very large performance impact."
1859 #: ../src/guestfs.pod:805
1861 "The work around is to use L</guestfs_mount_options> and set the mount "
1862 "options that you actually want to use."
1867 #: ../src/guestfs.pod:808
1868 msgid "Read-only should be the default."
1873 #: ../src/guestfs.pod:810
1875 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1876 "specify I<--rw> if you want to make changes to the image."
1881 #: ../src/guestfs.pod:813
1882 msgid "This would reduce the potential to corrupt live VM images."
1887 #: ../src/guestfs.pod:815
1889 "Note that many filesystems change the disk when you just mount and unmount, "
1890 "even if you didn't perform any writes. You need to use L</"
1891 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1896 #: ../src/guestfs.pod:819
1897 msgid "guestfish command line is hard to use."
1902 #: ../src/guestfs.pod:821
1904 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1905 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1906 "exist, so it fails. In earlier versions of guestfish the error message was "
1907 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1908 "we should have used C<guestfish -c command> to run commands."
1913 #: ../src/guestfs.pod:828
1914 msgid "guestfish megabyte modifiers don't work right on all commands"
1919 #: ../src/guestfs.pod:830
1921 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1922 "other modifiers). What guestfish actually does is to multiply the number "
1923 "part by the modifier part and pass the result to the C API. However this "
1924 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1925 "expecting some other unit (eg. megabytes)."
1930 #: ../src/guestfs.pod:837
1931 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1936 #: ../src/guestfs.pod:839
1939 " lvcreate LV VG 100M\n"
1945 #: ../src/guestfs.pod:841
1947 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1948 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1949 "megabytes * megabytes) logical volume. The error message you get from this "
1950 "is also a little obscure."
1955 #: ../src/guestfs.pod:846
1957 "This could be fixed in the generator by specially marking parameters and "
1958 "return values which take bytes or other units."
1963 #: ../src/guestfs.pod:849
1964 msgid "Ambiguity between devices and paths"
1969 #: ../src/guestfs.pod:851
1971 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1972 "sdb2>) and a similar pathname. A file might just happen to be called "
1973 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1978 #: ../src/guestfs.pod:856
1980 "In the current API we usually resolve this ambiguity by having two separate "
1981 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1982 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1983 "detecting if the path supplied begins with C</dev/>."
1988 #: ../src/guestfs.pod:862
1990 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1991 "make paths/devices into structured names. One way to do this would be to "
1992 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1993 "aspect of grub. Another way would be to use a structured type, equivalent "
1994 "to this OCaml type:"
1999 #: ../src/guestfs.pod:868
2002 " type path = Path of string | Device of int | Partition of int * int\n"
2008 #: ../src/guestfs.pod:870
2009 msgid "which would allow you to pass arguments like:"
2014 #: ../src/guestfs.pod:872
2017 " Path \"/foo/bar\"\n"
2018 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2019 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2020 " Path \"/dev/sdb2\" (* not a device *)\n"
2026 #: ../src/guestfs.pod:877
2028 "As you can see there are still problems to resolve even with this "
2029 "representation. Also consider how it might work in guestfish."
2034 #: ../src/guestfs.pod:882
2035 msgid "KEYS AND PASSPHRASES"
2040 #: ../src/guestfs.pod:884
2042 "Certain libguestfs calls take a parameter that contains sensitive key "
2043 "material, passed in as a C string."
2048 #: ../src/guestfs.pod:887
2050 "In the future we would hope to change the libguestfs implementation so that "
2051 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2052 "swap. However this is I<not> done at the moment, because of the complexity "
2053 "of such an implementation."
2058 #: ../src/guestfs.pod:892
2060 "Therefore you should be aware that any key parameter you pass to libguestfs "
2061 "might end up being written out to the swap partition. If this is a concern, "
2062 "scrub the swap partition or don't use libguestfs on encrypted devices."
2067 #: ../src/guestfs.pod:897
2068 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2073 #: ../src/guestfs.pod:899
2075 "All high-level libguestfs actions are synchronous. If you want to use "
2076 "libguestfs asynchronously then you must create a thread."
2081 #: ../src/guestfs.pod:902
2083 "Only use the handle from a single thread. Either use the handle exclusively "
2084 "from one thread, or provide your own mutex so that two threads cannot issue "
2085 "calls on the same handle at the same time."
2090 #: ../src/guestfs.pod:906
2092 "See the graphical program guestfs-browser for one possible architecture for "
2093 "multithreaded programs using libvirt and libguestfs."
2098 #: ../src/guestfs.pod:909
2103 #: ../src/guestfs.pod:911
2105 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2111 #: ../src/guestfs.pod:914
2113 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2114 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2119 #: ../src/guestfs.pod:917
2121 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2122 "to change the directories that libguestfs will search in. The value is a "
2123 "colon-separated list of paths. The current directory is I<not> searched "
2124 "unless the path contains an empty element or C<.>. For example "
2125 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2126 "then C</usr/lib/guestfs>."
2131 #: ../src/guestfs.pod:924
2132 msgid "QEMU WRAPPERS"
2137 #: ../src/guestfs.pod:926
2139 "If you want to compile your own qemu, run qemu from a non-standard location, "
2140 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2146 #: ../src/guestfs.pod:930
2148 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2149 "last command in the shell script (so that qemu replaces the shell and "
2150 "becomes the direct child of the libguestfs-using program). If you don't do "
2151 "this, then the qemu process won't be cleaned up correctly."
2156 #: ../src/guestfs.pod:935
2158 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2164 #: ../src/guestfs.pod:938
2168 " qemudir=/home/rjones/d/qemu\n"
2169 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2175 #: ../src/guestfs.pod:942
2177 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2178 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2184 #: ../src/guestfs.pod:946
2187 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2193 #: ../src/guestfs.pod:948
2195 "Note that libguestfs also calls qemu with the -help and -version options in "
2196 "order to determine features."
2200 #: ../src/guestfs.pod:951
2201 msgid "ATTACHING TO RUNNING DAEMONS"
2205 #: ../src/guestfs.pod:953
2207 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2208 "babies. Use with caution."
2212 #: ../src/guestfs.pod:956
2214 "I<Note (2):> This section explains how to attach to a running daemon from a "
2215 "low level perspective. For most users, simply using virt tools such as "
2216 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2220 #: ../src/guestfs.pod:960
2221 msgid "Using guestfs_set_attach_method"
2225 #: ../src/guestfs.pod:962
2227 "By calling L</guestfs_set_attach_method> you can change how the library "
2228 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2229 "ARCHITECTURE> for some background)."
2233 #: ../src/guestfs.pod:966
2235 "The normal attach method is C<appliance>, where a small appliance is created "
2236 "containing the daemon, and then the library connects to this."
2240 #: ../src/guestfs.pod:969
2242 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2243 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2244 "daemon over the Unix domain socket."
2248 #: ../src/guestfs.pod:973
2250 "The normal use for this is to connect to a running virtual machine that "
2251 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2252 "files inside the live virtual machine."
2256 #: ../src/guestfs.pod:977
2257 msgid "Using guestfs_add_domain with live flag"
2261 #: ../src/guestfs.pod:979
2263 "L</guestfs_add_domain> provides some help for getting the correct attach "
2264 "method. If you pass the C<live> option to this function, then (if the "
2265 "virtual machine is running) it will examine the libvirt XML looking for a "
2266 "virtio-serial channel to connect to:"
2270 #: ../src/guestfs.pod:985
2277 " <channel type='unix'>\n"
2278 " <source mode='bind' path='/path/to/socket'/>\n"
2279 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2288 #: ../src/guestfs.pod:997
2290 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2291 "method to C<unix:/path/to/socket>."
2295 #: ../src/guestfs.pod:1000
2297 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2298 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2299 "to attach to and modify live virtual machines."
2303 #: ../src/guestfs.pod:1004
2305 "The virtual machine needs to have been set up beforehand so that it has the "
2306 "virtio-serial channel and so that guestfsd is running inside it."
2311 #: ../src/guestfs.pod:1008
2312 msgid "ABI GUARANTEE"
2317 #: ../src/guestfs.pod:1010
2319 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2320 "actions as outlined in this section. Although we will deprecate some "
2321 "actions, for example if they get replaced by newer calls, we will keep the "
2322 "old actions forever. This allows you the developer to program in confidence "
2323 "against the libguestfs API."
2328 #: ../src/guestfs.pod:1016
2329 msgid "BLOCK DEVICE NAMING"
2334 #: ../src/guestfs.pod:1018
2336 "In the kernel there is now quite a profusion of schemata for naming block "
2337 "devices (in this context, by I<block device> I mean a physical or virtual "
2338 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2339 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2340 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2341 "for the old IDE driver (particularly for SATA devices) those devices also "
2342 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2343 "paravirtualized drivers. This has created several different naming systems, "
2344 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2349 #: ../src/guestfs.pod:1030
2351 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2352 "Linux kernel to access block devices. We can run a variety of appliances "
2353 "based on a variety of Linux kernels."
2358 #: ../src/guestfs.pod:1034
2360 "This causes a problem for libguestfs because many API calls use device or "
2361 "partition names. Working scripts and the recipe (example) scripts that we "
2362 "make available over the internet could fail if the naming scheme changes."
2367 #: ../src/guestfs.pod:1039
2369 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2370 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2371 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2372 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2377 #: ../src/guestfs.pod:1045
2379 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2380 "L</guestfs_list_partitions> and similar calls return the true names of the "
2381 "devices and partitions as known to the appliance."
2386 #: ../src/guestfs.pod:1050
2387 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2392 #: ../src/guestfs.pod:1052
2394 "Usually this translation is transparent. However in some (very rare) cases "
2395 "you may need to know the exact algorithm. Such cases include where you use "
2396 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2397 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2402 #: ../src/guestfs.pod:1058
2404 "The algorithm is applied only to I<parameters> which are known to be either "
2405 "device or partition names. Return values from functions such as L</"
2406 "guestfs_list_devices> are never changed."
2411 #: ../src/guestfs.pod:1066
2412 msgid "Is the string a parameter which is a device or partition name?"
2417 #: ../src/guestfs.pod:1070
2418 msgid "Does the string begin with C</dev/sd>?"
2423 #: ../src/guestfs.pod:1074
2425 "Does the named device exist? If so, we use that device. However if I<not> "
2426 "then we continue with this algorithm."
2431 #: ../src/guestfs.pod:1079
2432 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2437 #: ../src/guestfs.pod:1081
2438 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2443 #: ../src/guestfs.pod:1083
2444 msgid "If that named device exists, use it. If not, continue."
2449 #: ../src/guestfs.pod:1087
2450 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2455 #: ../src/guestfs.pod:1089
2456 msgid "If that named device exists, use it. If not, return an error."
2461 #: ../src/guestfs.pod:1093
2462 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2467 #: ../src/guestfs.pod:1095
2469 "Although the standard naming scheme and automatic translation is useful for "
2470 "simple programs and guestfish scripts, for larger programs it is best not to "
2471 "rely on this mechanism."
2476 #: ../src/guestfs.pod:1099
2478 "Where possible for maximum future portability programs using libguestfs "
2479 "should use these future-proof techniques:"
2484 #: ../src/guestfs.pod:1106
2486 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2487 "device names, and then use those names directly."
2492 #: ../src/guestfs.pod:1109
2494 "Since those device names exist by definition, they will never be translated."
2499 #: ../src/guestfs.pod:1114
2501 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2502 "filesystem labels."
2507 #: ../src/guestfs.pod:1119
2513 #: ../src/guestfs.pod:1121
2515 "This section discusses security implications of using libguestfs, "
2516 "particularly with untrusted or malicious guests or disk images."
2521 #: ../src/guestfs.pod:1124
2522 msgid "GENERAL SECURITY CONSIDERATIONS"
2527 #: ../src/guestfs.pod:1126
2529 "Be careful with any files or data that you download from a guest (by "
2530 "\"download\" we mean not just the L</guestfs_download> command but any "
2531 "command that reads files, filenames, directories or anything else from a "
2532 "disk image). An attacker could manipulate the data to fool your program "
2533 "into doing the wrong thing. Consider cases such as:"
2538 #: ../src/guestfs.pod:1136
2539 msgid "the data (file etc) not being present"
2544 #: ../src/guestfs.pod:1140
2545 msgid "being present but empty"
2550 #: ../src/guestfs.pod:1144
2551 msgid "being much larger than normal"
2556 #: ../src/guestfs.pod:1148
2557 msgid "containing arbitrary 8 bit data"
2562 #: ../src/guestfs.pod:1152
2563 msgid "being in an unexpected character encoding"
2568 #: ../src/guestfs.pod:1156
2569 msgid "containing homoglyphs."
2574 #: ../src/guestfs.pod:1160
2575 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2580 #: ../src/guestfs.pod:1162
2582 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2583 "(VFS) module can sometimes be escalated into exploits by deliberately "
2584 "creating a malicious, malformed filesystem. These exploits are very severe "
2585 "for two reasons. Firstly there are very many filesystem drivers in the "
2586 "kernel, and many of them are infrequently used and not much developer "
2587 "attention has been paid to the code. Linux userspace helps potential "
2588 "crackers by detecting the filesystem type and automatically choosing the "
2589 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2590 "the administrator. Secondly, a kernel-level exploit is like a local root "
2591 "exploit (worse in some ways), giving immediate and total access to the "
2592 "system right down to the hardware level."
2597 #: ../src/guestfs.pod:1175
2599 "That explains why you should never mount a filesystem from an untrusted "
2600 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2601 "inside a qemu virtual machine, usually running as a non-root user. The "
2602 "attacker would need to write a filesystem which first exploited the kernel, "
2603 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2604 "the libguestfs protocol, and finally to be as serious as the host kernel "
2605 "exploit it would need to escalate its privileges to root. This multi-step "
2606 "escalation, performed by a static piece of data, is thought to be extremely "
2607 "hard to do, although we never say 'never' about security issues."
2612 #: ../src/guestfs.pod:1186
2614 "In any case callers can reduce the attack surface by forcing the filesystem "
2615 "type when mounting (use L</guestfs_mount_vfs>)."
2620 #: ../src/guestfs.pod:1189
2621 msgid "PROTOCOL SECURITY"
2626 #: ../src/guestfs.pod:1191
2628 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2629 "defined upper message size. However a program that uses libguestfs must "
2630 "also take care - for example you can write a program that downloads a binary "
2631 "from a disk image and executes it locally, and no amount of protocol "
2632 "security will save you from the consequences."
2637 #: ../src/guestfs.pod:1197
2638 msgid "INSPECTION SECURITY"
2643 #: ../src/guestfs.pod:1199
2645 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2646 "directly from the guest, and these could contain any 8 bit data. Callers "
2647 "should be careful to escape these before printing them to a structured file "
2648 "(for example, use HTML escaping if creating a web page)."
2653 #: ../src/guestfs.pod:1205
2655 "Guest configuration may be altered in unusual ways by the administrator of "
2656 "the virtual machine, and may not reflect reality (particularly for untrusted "
2657 "or actively malicious guests). For example we parse the hostname from "
2658 "configuration files like C</etc/sysconfig/network> that we find in the "
2659 "guest, but the guest administrator can easily manipulate these files to "
2660 "provide the wrong hostname."
2665 #: ../src/guestfs.pod:1213
2667 "The inspection API parses guest configuration using two external libraries: "
2668 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2669 "designed to be robust in the face of malicious data, although denial of "
2670 "service attacks are still possible, for example with oversized configuration "
2676 #: ../src/guestfs.pod:1219
2677 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2682 #: ../src/guestfs.pod:1221
2684 "Be very cautious about running commands from the guest. By running a "
2685 "command in the guest, you are giving CPU time to a binary that you do not "
2686 "control, under the same user account as the library, albeit wrapped in qemu "
2687 "virtualization. More information and alternatives can be found in the "
2688 "section L</RUNNING COMMANDS>."
2693 #: ../src/guestfs.pod:1227
2694 msgid "CVE-2010-3851"
2699 #: ../src/guestfs.pod:1229
2700 msgid "https://bugzilla.redhat.com/642934"
2705 #: ../src/guestfs.pod:1231
2707 "This security bug concerns the automatic disk format detection that qemu "
2708 "does on disk images."
2713 #: ../src/guestfs.pod:1234
2715 "A raw disk image is just the raw bytes, there is no header. Other disk "
2716 "images like qcow2 contain a special header. Qemu deals with this by looking "
2717 "for one of the known headers, and if none is found then assuming the disk "
2718 "image must be raw."
2723 #: ../src/guestfs.pod:1239
2725 "This allows a guest which has been given a raw disk image to write some "
2726 "other header. At next boot (or when the disk image is accessed by "
2727 "libguestfs) qemu would do autodetection and think the disk image format was, "
2728 "say, qcow2 based on the header written by the guest."
2733 #: ../src/guestfs.pod:1244
2735 "This in itself would not be a problem, but qcow2 offers many features, one "
2736 "of which is to allow a disk image to refer to another image (called the "
2737 "\"backing disk\"). It does this by placing the path to the backing disk "
2738 "into the qcow2 header. This path is not validated and could point to any "
2739 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2740 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2741 "control of the attacker."
2746 #: ../src/guestfs.pod:1252
2748 "In libguestfs this is rather hard to exploit except under two circumstances:"
2753 #: ../src/guestfs.pod:1259
2754 msgid "You have enabled the network or have opened the disk in write mode."
2759 #: ../src/guestfs.pod:1263
2761 "You are also running untrusted code from the guest (see L</RUNNING "
2767 #: ../src/guestfs.pod:1268
2769 "The way to avoid this is to specify the expected disk format when adding "
2770 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2771 "should always do this if the disk is raw format, and it's a good idea for "
2777 #: ../src/guestfs.pod:1273
2779 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2780 "format is fetched from libvirt and passed through."
2785 #: ../src/guestfs.pod:1276
2787 "For libguestfs tools, use the I<--format> command line parameter as "
2793 #: ../src/guestfs.pod:1279
2794 msgid "CONNECTION MANAGEMENT"
2799 #: ../src/guestfs.pod:1281
2805 #: ../src/guestfs.pod:1283
2807 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2808 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2809 "handle and release all resources used."
2813 #: ../src/guestfs.pod:1287
2815 "For information on using multiple handles and threads, see the section L</"
2816 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2821 #: ../src/guestfs.pod:1290
2822 msgid "guestfs_create"
2827 #: ../src/guestfs.pod:1292
2830 " guestfs_h *guestfs_create (void);\n"
2836 #: ../src/guestfs.pod:1294
2837 msgid "Create a connection handle."
2841 #: ../src/guestfs.pod:1296
2843 "On success this returns a non-NULL pointer to a handle. On error it returns "
2848 #: ../src/guestfs.pod:1299
2850 "You have to \"configure\" the handle after creating it. This includes "
2851 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2852 "handle at least once."
2857 #: ../src/guestfs.pod:1303
2858 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2862 #: ../src/guestfs.pod:1305
2864 "You may also want to configure error handling for the handle. See the L</"
2865 "ERROR HANDLING> section below."
2870 #: ../src/guestfs.pod:1308
2871 msgid "guestfs_close"
2876 #: ../src/guestfs.pod:1310
2879 " void guestfs_close (guestfs_h *g);\n"
2885 #: ../src/guestfs.pod:1312
2886 msgid "This closes the connection handle and frees up all resources used."
2890 #: ../src/guestfs.pod:1314
2892 "If autosync was set on the handle and the handle was launched, then this "
2893 "implicitly calls various functions to unmount filesystems and sync the "
2894 "disk. See L</guestfs_set_autosync> for more details."
2898 #: ../src/guestfs.pod:1318
2899 msgid "If a close callback was set on the handle, then it is called."
2904 #: ../src/guestfs.pod:1320
2905 msgid "ERROR HANDLING"
2910 #: ../src/guestfs.pod:1322
2912 "API functions can return errors. For example, almost all functions that "
2913 "return C<int> will return C<-1> to indicate an error."
2918 #: ../src/guestfs.pod:1325
2920 "Additional information is available for errors: an error message string and "
2921 "optionally an error number (errno) if the thing that failed was a system "
2927 #: ../src/guestfs.pod:1329
2929 "You can get at the additional information about the last error on the handle "
2930 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2931 "up an error handler with L</guestfs_set_error_handler>."
2936 #: ../src/guestfs.pod:1334
2938 "When the handle is created, a default error handler is installed which "
2939 "prints the error message string to C<stderr>. For small short-running "
2940 "command line programs it is sufficient to do:"
2945 #: ../src/guestfs.pod:1338
2948 " if (guestfs_launch (g) == -1)\n"
2949 " exit (EXIT_FAILURE);\n"
2955 #: ../src/guestfs.pod:1341
2957 "since the default error handler will ensure that an error message has been "
2958 "printed to C<stderr> before the program exits."
2963 #: ../src/guestfs.pod:1344
2965 "For other programs the caller will almost certainly want to install an "
2966 "alternate error handler or do error handling in-line like this:"
2971 #: ../src/guestfs.pod:1347
2974 " g = guestfs_create ();\n"
2980 #: ../src/guestfs.pod:1349
2983 " /* This disables the default behaviour of printing errors\n"
2985 " guestfs_set_error_handler (g, NULL, NULL);\n"
2991 #: ../src/guestfs.pod:1353
2994 " if (guestfs_launch (g) == -1) {\n"
2995 " /* Examine the error message and print it etc. */\n"
2996 " char *msg = guestfs_last_error (g);\n"
2997 " int errnum = guestfs_last_errno (g);\n"
2998 " fprintf (stderr, \"%s\\n\", msg);\n"
3006 #: ../src/guestfs.pod:1361
3008 "Out of memory errors are handled differently. The default action is to call "
3009 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3010 "guestfs_set_out_of_memory_handler>."
3015 #: ../src/guestfs.pod:1365
3017 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3018 "because there is no handle if this happens there is no way to get additional "
3019 "error information. However L</guestfs_create> is supposed to be a "
3020 "lightweight operation which can only fail because of insufficient memory (it "
3021 "returns NULL in this case)."
3026 #: ../src/guestfs.pod:1371
3027 msgid "guestfs_last_error"
3032 #: ../src/guestfs.pod:1373
3035 " const char *guestfs_last_error (guestfs_h *g);\n"
3041 #: ../src/guestfs.pod:1375
3043 "This returns the last error message that happened on C<g>. If there has not "
3044 "been an error since the handle was created, then this returns C<NULL>."
3049 #: ../src/guestfs.pod:1379
3051 "The lifetime of the returned string is until the next error occurs, or L</"
3052 "guestfs_close> is called."
3057 #: ../src/guestfs.pod:1382
3058 msgid "guestfs_last_errno"
3063 #: ../src/guestfs.pod:1384
3066 " int guestfs_last_errno (guestfs_h *g);\n"
3072 #: ../src/guestfs.pod:1386
3073 msgid "This returns the last error number (errno) that happened on C<g>."
3078 #: ../src/guestfs.pod:1388
3079 msgid "If successful, an errno integer not equal to zero is returned."
3084 #: ../src/guestfs.pod:1390
3086 "If no error, this returns 0. This call can return 0 in three situations:"
3091 #: ../src/guestfs.pod:1397
3092 msgid "There has not been any error on the handle."
3097 #: ../src/guestfs.pod:1401
3099 "There has been an error but the errno was meaningless. This corresponds to "
3100 "the case where the error did not come from a failed system call, but for "
3101 "some other reason."
3106 #: ../src/guestfs.pod:1407
3108 "There was an error from a failed system call, but for some reason the errno "
3109 "was not captured and returned. This usually indicates a bug in libguestfs."
3114 #: ../src/guestfs.pod:1413
3116 "Libguestfs tries to convert the errno from inside the applicance into a "
3117 "corresponding errno for the caller (not entirely trivial: the appliance "
3118 "might be running a completely different operating system from the library "
3119 "and error numbers are not standardized across Un*xen). If this could not be "
3120 "done, then the error is translated to C<EINVAL>. In practice this should "
3121 "only happen in very rare circumstances."
3126 #: ../src/guestfs.pod:1421
3127 msgid "guestfs_set_error_handler"
3132 #: ../src/guestfs.pod:1423
3135 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3137 " const char *msg);\n"
3138 " void guestfs_set_error_handler (guestfs_h *g,\n"
3139 " guestfs_error_handler_cb cb,\n"
3146 #: ../src/guestfs.pod:1430
3148 "The callback C<cb> will be called if there is an error. The parameters "
3149 "passed to the callback are an opaque data pointer and the error message "
3155 #: ../src/guestfs.pod:1434
3157 "C<errno> is not passed to the callback. To get that the callback must call "
3158 "L</guestfs_last_errno>."
3163 #: ../src/guestfs.pod:1437
3165 "Note that the message string C<msg> is freed as soon as the callback "
3166 "function returns, so if you want to stash it somewhere you must make your "
3172 #: ../src/guestfs.pod:1441
3173 msgid "The default handler prints messages on C<stderr>."
3178 #: ../src/guestfs.pod:1443
3179 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3184 #: ../src/guestfs.pod:1445
3185 msgid "guestfs_get_error_handler"
3190 #: ../src/guestfs.pod:1447
3193 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3194 " void **opaque_rtn);\n"
3200 #: ../src/guestfs.pod:1450
3201 msgid "Returns the current error handler callback."
3206 #: ../src/guestfs.pod:1452
3207 msgid "guestfs_set_out_of_memory_handler"
3212 #: ../src/guestfs.pod:1454
3215 " typedef void (*guestfs_abort_cb) (void);\n"
3216 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3217 " guestfs_abort_cb);\n"
3223 #: ../src/guestfs.pod:1458
3225 "The callback C<cb> will be called if there is an out of memory situation. "
3226 "I<Note this callback must not return>."
3231 #: ../src/guestfs.pod:1461
3232 msgid "The default is to call L<abort(3)>."
3237 #: ../src/guestfs.pod:1463
3239 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3244 #: ../src/guestfs.pod:1466
3245 msgid "guestfs_get_out_of_memory_handler"
3250 #: ../src/guestfs.pod:1468
3253 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3259 #: ../src/guestfs.pod:1470
3260 msgid "This returns the current out of memory handler."
3265 #: ../src/guestfs.pod:1472
3271 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
3277 #: ../src/guestfs.pod:1476
3283 #: ../src/guestfs.pod:1478
3289 #: ../src/guestfs.pod:1480
3290 msgid "AVAILABILITY"
3295 #: ../src/guestfs.pod:1482
3296 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3301 #: ../src/guestfs.pod:1484
3303 "Using L</guestfs_available> you can test availability of the following "
3304 "groups of functions. This test queries the appliance to see if the "
3305 "appliance you are currently using supports the functionality."
3310 #: ../src/guestfs.pod:1489
3311 msgid "@AVAILABILITY@"
3316 #: ../src/guestfs.pod:1491
3317 msgid "GUESTFISH supported COMMAND"
3322 #: ../src/guestfs.pod:1493
3324 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3325 "prints out the available groups and whether they are supported by this build "
3326 "of libguestfs. Note however that you have to do C<run> first."
3331 #: ../src/guestfs.pod:1498
3332 msgid "SINGLE CALLS AT COMPILE TIME"
3337 #: ../src/guestfs.pod:1500
3339 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3340 "function, such as:"
3345 #: ../src/guestfs.pod:1503
3348 " #define LIBGUESTFS_HAVE_DD 1\n"
3354 #: ../src/guestfs.pod:1505
3355 msgid "if L</guestfs_dd> is available."
3360 #: ../src/guestfs.pod:1507
3362 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3363 "function is available at compile time, we recommended using build tools such "
3364 "as autoconf or cmake. For example in autotools you could use:"
3369 #: ../src/guestfs.pod:1512
3372 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3373 " AC_CHECK_FUNCS([guestfs_dd])\n"
3379 #: ../src/guestfs.pod:1515
3381 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3387 #: ../src/guestfs.pod:1518
3388 msgid "SINGLE CALLS AT RUN TIME"
3393 #: ../src/guestfs.pod:1520
3395 "Testing at compile time doesn't guarantee that a function really exists in "
3396 "the library. The reason is that you might be dynamically linked against a "
3397 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3398 "This situation unfortunately results in a segmentation fault, which is a "
3399 "shortcoming of the C dynamic linking system itself."
3404 #: ../src/guestfs.pod:1527
3406 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3407 "in this example program (note that you still need the compile time check as "
3413 #: ../src/guestfs.pod:1531
3416 " #include <stdio.h>\n"
3417 " #include <stdlib.h>\n"
3418 " #include <unistd.h>\n"
3419 " #include <dlfcn.h>\n"
3420 " #include <guestfs.h>\n"
3426 #: ../src/guestfs.pod:1537
3431 " #ifdef LIBGUESTFS_HAVE_DD\n"
3433 " int has_function;\n"
3439 #: ../src/guestfs.pod:1543
3442 " /* Test if the function guestfs_dd is really available. */\n"
3443 " dl = dlopen (NULL, RTLD_LAZY);\n"
3445 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3446 " exit (EXIT_FAILURE);\n"
3448 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3455 #: ../src/guestfs.pod:1552
3458 " if (!has_function)\n"
3459 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3461 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3462 " /* Now it's safe to call\n"
3463 " guestfs_dd (g, \"foo\", \"bar\");\n"
3467 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3475 #: ../src/guestfs.pod:1565
3477 "You may think the above is an awful lot of hassle, and it is. There are "
3478 "other ways outside of the C linking system to ensure that this kind of "
3479 "incompatibility never arises, such as using package versioning:"
3484 #: ../src/guestfs.pod:1570
3487 " Requires: libguestfs >= 1.0.80\n"
3493 #: ../src/guestfs.pod:1572
3494 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3499 #: ../src/guestfs.pod:1574
3501 "A recent feature of the API is the introduction of calls which take optional "
3502 "arguments. In C these are declared 3 ways. The main way is as a call which "
3503 "takes variable arguments (ie. C<...>), as in this example:"
3508 #: ../src/guestfs.pod:1579
3511 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3517 #: ../src/guestfs.pod:1581
3519 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3520 "call with no optional arguments specified:"
3525 #: ../src/guestfs.pod:1584
3528 " guestfs_add_drive_opts (g, filename, -1);\n"
3534 #: ../src/guestfs.pod:1586
3535 msgid "With a single optional argument:"
3540 #: ../src/guestfs.pod:1588
3543 " guestfs_add_drive_opts (g, filename,\n"
3544 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3551 #: ../src/guestfs.pod:1592
3557 #: ../src/guestfs.pod:1594
3560 " guestfs_add_drive_opts (g, filename,\n"
3561 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3562 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3569 #: ../src/guestfs.pod:1599
3571 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3577 #: ../src/guestfs.pod:1602
3578 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3583 #: ../src/guestfs.pod:1604
3585 "The second variant has the same name with the suffix C<_va>, which works the "
3586 "same way but takes a C<va_list>. See the C manual for details. For the "
3587 "example function, this is declared:"
3592 #: ../src/guestfs.pod:1608
3595 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3602 #: ../src/guestfs.pod:1611
3603 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3608 #: ../src/guestfs.pod:1613
3610 "The third variant is useful where you need to construct these calls. You "
3611 "pass in a structure where you fill in the optional fields. The structure "
3612 "has a bitmask as the first element which you must set to indicate which "
3613 "fields you have filled in. For our example function the structure and call "
3619 #: ../src/guestfs.pod:1619
3622 " struct guestfs_add_drive_opts_argv {\n"
3623 " uint64_t bitmask;\n"
3625 " const char *format;\n"
3628 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3629 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3635 #: ../src/guestfs.pod:1628
3636 msgid "You could call it like this:"
3641 #: ../src/guestfs.pod:1630
3644 " struct guestfs_add_drive_opts_argv optargs = {\n"
3645 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3646 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3648 " .format = \"qcow2\"\n"
3655 #: ../src/guestfs.pod:1637
3658 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3664 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3665 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:2785
3666 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262
3667 #: ../fish/guestfish-actions.pod:1898 ../tools/virt-win-reg.pl:704
3673 #: ../src/guestfs.pod:1645
3674 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3679 #: ../src/guestfs.pod:1650
3680 msgid "You do not need to fill in all fields of the structure."
3685 #: ../src/guestfs.pod:1654
3687 "There must be a one-to-one correspondence between fields of the structure "
3688 "that are filled in, and bits set in the bitmask."
3693 #: ../src/guestfs.pod:1659
3694 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3699 #: ../src/guestfs.pod:1661
3701 "In other languages, optional arguments are expressed in the way that is "
3702 "natural for that language. We refer you to the language-specific "
3703 "documentation for more details on that."
3708 #: ../src/guestfs.pod:1665
3709 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3714 #: ../src/guestfs.pod:1667
3715 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3719 #: ../src/guestfs.pod:1669
3721 "B<Note:> This section documents the generic event mechanism introduced in "
3722 "libguestfs 1.10, which you should use in new code if possible. The old "
3723 "functions C<guestfs_set_log_message_callback>, "
3724 "C<guestfs_set_subprocess_quit_callback>, "
3725 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3726 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3727 "page. Because of the ABI guarantee, the old functions continue to work."
3731 #: ../src/guestfs.pod:1678
3733 "Handles generate events when certain things happen, such as log messages "
3734 "being generated, progress messages during long-running operations, or the "
3735 "handle being closed. The API calls described below let you register a "
3736 "callback to be called when events happen. You can register multiple "
3737 "callbacks (for the same, different or overlapping sets of events), and "
3738 "individually remove callbacks. If callbacks are not removed, then they "
3739 "remain in force until the handle is closed."
3743 #: ../src/guestfs.pod:1686
3745 "In the current implementation, events are only generated synchronously: that "
3746 "means that events (and hence callbacks) can only happen while you are in the "
3747 "middle of making another libguestfs call. The callback is called in the "
3752 #: ../src/guestfs.pod:1691
3754 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3755 "unsigned integers, or a message buffer. Payloads are discussed later on."
3759 #: ../src/guestfs.pod:1695
3760 msgid "CLASSES OF EVENTS"
3764 #: ../src/guestfs.pod:1699
3765 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3769 #: ../src/guestfs.pod:1702
3771 "The callback function will be called while the handle is being closed "
3772 "(synchronously from L</guestfs_close>)."
3777 #: ../src/guestfs.pod:1705
3779 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3780 "handles that are open when the program exits. This means that this callback "
3781 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3782 "problems in higher-level languages (eg. if your HLL interpreter has already "
3783 "been cleaned up by the time this is called, and if your callback then jumps "
3784 "into some HLL function)."
3788 #: ../src/guestfs.pod:1712
3790 "If no callback is registered: the handle is closed without any callback "
3795 #: ../src/guestfs.pod:1715
3796 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3800 #: ../src/guestfs.pod:1718
3802 "The callback function will be called when the child process quits, either "
3803 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3804 "corresponds to a transition from any state to the CONFIG state)."
3808 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3809 msgid "If no callback is registered: the event is ignored."
3813 #: ../src/guestfs.pod:1724
3814 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3818 #: ../src/guestfs.pod:1727
3820 "The callback function will be called when the child process becomes ready "
3821 "first time after it has been launched. (This corresponds to a transition "
3822 "from LAUNCHING to the READY state)."
3826 #: ../src/guestfs.pod:1733
3827 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3832 #: ../src/guestfs.pod:1736
3834 "Some long-running operations can generate progress messages. If this "
3835 "callback is registered, then it will be called each time a progress message "
3836 "is generated (usually two seconds after the operation started, and three "
3837 "times per second thereafter until it completes, although the frequency may "
3838 "change in future versions)."
3842 #: ../src/guestfs.pod:1742
3844 "The callback receives in the payload four unsigned 64 bit numbers which are "
3845 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3849 #: ../src/guestfs.pod:1745
3851 "The units of C<total> are not defined, although for some operations C<total> "
3852 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3853 "or megabytes), and C<position> may be the portion which has been transferred."
3858 #: ../src/guestfs.pod:1750
3859 msgid "The only defined and stable parts of the API are:"
3864 #: ../src/guestfs.pod:1756
3866 "The callback can display to the user some type of progress bar or indicator "
3867 "which shows the ratio of C<position>:C<total>."
3872 #: ../src/guestfs.pod:1761
3873 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3877 #: ../src/guestfs.pod:1765
3879 "If any progress notification is sent during a call, then a final progress "
3880 "notification is always sent when C<position> = C<total> (I<unless> the call "
3881 "fails with an error)."
3886 #: ../src/guestfs.pod:1769
3888 "This is to simplify caller code, so callers can easily set the progress "
3889 "indicator to \"100%\" at the end of the operation, without requiring special "
3890 "code to detect this case."
3894 #: ../src/guestfs.pod:1775
3896 "For some calls we are unable to estimate the progress of the call, but we "
3897 "can still generate progress messages to indicate activity. This is known as "
3898 "\"pulse mode\", and is directly supported by certain progress bar "
3899 "implementations (eg. GtkProgressBar)."
3903 #: ../src/guestfs.pod:1780
3905 "For these calls, zero or more progress messages are generated with "
3906 "C<position = 0> and C<total = 1>, followed by a final message with "
3907 "C<position = total = 1>."
3911 #: ../src/guestfs.pod:1784
3913 "As noted above, if the call fails with an error then the final message may "
3918 #: ../src/guestfs.pod:1789
3920 "The callback also receives the procedure number (C<proc_nr>) and serial "
3921 "number (C<serial>) of the call. These are only useful for debugging "
3922 "protocol issues, and the callback can normally ignore them. The callback "
3923 "may want to print these numbers in error messages or debugging messages."
3927 #: ../src/guestfs.pod:1795
3928 msgid "If no callback is registered: progress messages are discarded."
3932 #: ../src/guestfs.pod:1797
3933 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3937 #: ../src/guestfs.pod:1800
3939 "The callback function is called whenever a log message is generated by qemu, "
3940 "the appliance kernel, guestfsd (daemon), or utility programs."
3944 #: ../src/guestfs.pod:1803
3946 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3947 "guestfs_launch>) then additional debug messages are generated."
3951 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3953 "If no callback is registered: the messages are discarded unless the verbose "
3954 "flag is set in which case they are sent to stderr. You can override the "
3955 "printing of verbose messages to stderr by setting up a callback."
3959 #: ../src/guestfs.pod:1811
3960 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3964 #: ../src/guestfs.pod:1814
3966 "The callback function is called whenever a log message is generated by the "
3967 "library part of libguestfs."
3971 #: ../src/guestfs.pod:1817
3973 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3974 "messages are generated."
3978 #: ../src/guestfs.pod:1825
3979 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3983 #: ../src/guestfs.pod:1828
3985 "The callback function is called whenever a trace message is generated. This "
3986 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3990 #: ../src/guestfs.pod:1831
3992 "If no callback is registered: the messages are sent to stderr. You can "
3993 "override the printing of trace messages to stderr by setting up a callback."
3997 #: ../src/guestfs.pod:1837
3998 msgid "guestfs_set_event_callback"
4002 #: ../src/guestfs.pod:1839
4005 " int guestfs_set_event_callback (guestfs_h *g,\n"
4006 " guestfs_event_callback cb,\n"
4007 " uint64_t event_bitmask,\n"
4014 #: ../src/guestfs.pod:1845
4016 "This function registers a callback (C<cb>) for all event classes in the "
4021 #: ../src/guestfs.pod:1848
4023 "For example, to register for all log message events, you could call this "
4024 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4025 "To register a single callback for all possible classes of events, use "
4026 "C<GUESTFS_EVENT_ALL>."
4030 #: ../src/guestfs.pod:1854
4031 msgid "C<flags> should always be passed as 0."
4035 #: ../src/guestfs.pod:1856
4037 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4038 "it for any purpose."
4042 #: ../src/guestfs.pod:1859
4044 "The return value is the event handle (an integer) which you can use to "
4045 "delete the callback (see below)."
4049 #: ../src/guestfs.pod:1862
4051 "If there is an error, this function returns C<-1>, and sets the error in the "
4052 "handle in the usual way (see L</guestfs_last_error> etc.)"
4056 #: ../src/guestfs.pod:1865
4058 "Callbacks remain in effect until they are deleted, or until the handle is "
4063 #: ../src/guestfs.pod:1868
4065 "In the case where multiple callbacks are registered for a particular event "
4066 "class, all of the callbacks are called. The order in which multiple "
4067 "callbacks are called is not defined."
4071 #: ../src/guestfs.pod:1872
4072 msgid "guestfs_delete_event_callback"
4076 #: ../src/guestfs.pod:1874
4079 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4084 #: ../src/guestfs.pod:1876
4086 "Delete a callback that was previously registered. C<event_handle> should be "
4087 "the integer that was returned by a previous call to "
4088 "C<guestfs_set_event_callback> on the same handle."
4092 #: ../src/guestfs.pod:1880
4093 msgid "guestfs_event_callback"
4097 #: ../src/guestfs.pod:1882
4100 " typedef void (*guestfs_event_callback) (\n"
4103 " uint64_t event,\n"
4104 " int event_handle,\n"
4106 " const char *buf, size_t buf_len,\n"
4107 " const uint64_t *array, size_t array_len);\n"
4112 #: ../src/guestfs.pod:1891
4114 "This is the type of the event callback function that you have to provide."
4118 #: ../src/guestfs.pod:1894
4120 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4121 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4122 "handle, and C<flags> which in the current API you should ignore."
4126 #: ../src/guestfs.pod:1898
4128 "The remaining parameters contain the event payload (if any). Each event may "
4129 "contain a payload, which usually relates to the event class, but for future "
4130 "proofing your code should be written to handle any payload for any event "
4135 #: ../src/guestfs.pod:1903
4137 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4138 "there is no message buffer). Note that this message buffer can contain "
4139 "arbitrary 8 bit data, including NUL bytes."
4143 #: ../src/guestfs.pod:1907
4145 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4146 "moment this is only used for progress messages."
4150 #: ../src/guestfs.pod:1910
4151 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4155 #: ../src/guestfs.pod:1912
4157 "One motivation for the generic event API was to allow GUI programs to "
4158 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4159 "unconditionally to C<stderr>."
4163 #: ../src/guestfs.pod:1916
4165 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4166 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4167 "messages are not events; you must capture error messages separately)."
4171 #: ../src/guestfs.pod:1921
4173 "Programs have to set up a callback to capture the classes of events of "
4178 #: ../src/guestfs.pod:1924
4182 " guestfs_set_event_callback\n"
4183 " (g, message_callback,\n"
4184 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4185 " GUESTFS_EVENT_TRACE,\n"
4186 " 0, NULL) == -1)\n"
4187 " if (eh == -1) {\n"
4188 " // handle error in the usual way\n"
4194 #: ../src/guestfs.pod:1934
4196 "The callback can then direct messages to the appropriate place. In this "
4197 "example, messages are directed to syslog:"
4201 #: ../src/guestfs.pod:1937
4205 " message_callback (\n"
4208 " uint64_t event,\n"
4209 " int event_handle,\n"
4211 " const char *buf, size_t buf_len,\n"
4212 " const uint64_t *array, size_t array_len)\n"
4214 " const int priority = LOG_USER|LOG_INFO;\n"
4215 " if (buf_len > 0)\n"
4216 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4223 #: ../src/guestfs.pod:1952
4224 msgid "PRIVATE DATA AREA"
4228 #: ../src/guestfs.pod:1954
4230 "You can attach named pieces of private data to the libguestfs handle, fetch "
4231 "them by name, and walk over them, for the lifetime of the handle. This is "
4232 "called the private data area and is only available from the C API."
4237 #: ../src/guestfs.pod:1959
4238 msgid "To attach a named piece of data, use the following call:"
4243 #: ../src/guestfs.pod:1961
4246 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4251 #: ../src/guestfs.pod:1963
4253 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4254 "pointer (which can be C<NULL>). Any previous item with the same key is "
4259 #: ../src/guestfs.pod:1967
4261 "You can use any C<key> you want, but your key should I<not> start with an "
4262 "underscore character. Keys beginning with an underscore character are "
4263 "reserved for internal libguestfs purposes (eg. for implementing language "
4264 "bindings). It is recommended that you prefix the key with some unique "
4265 "string to avoid collisions with other users."
4270 #: ../src/guestfs.pod:1973
4271 msgid "To retrieve the pointer, use:"
4276 #: ../src/guestfs.pod:1975
4279 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4285 #: ../src/guestfs.pod:1977
4287 "This function returns C<NULL> if either no data is found associated with "
4288 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4293 #: ../src/guestfs.pod:1981
4295 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4296 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4297 "all. In particular, libguestfs does I<not> try to free the data when the "
4298 "handle is closed. If the data must be freed, then the caller must either "
4299 "free it before calling L</guestfs_close> or must set up a close callback to "
4300 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4304 #: ../src/guestfs.pod:1988
4305 msgid "To walk over all entries, use these two functions:"
4309 #: ../src/guestfs.pod:1990
4312 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4317 #: ../src/guestfs.pod:1992
4320 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4325 #: ../src/guestfs.pod:1994
4327 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4328 "not have any particular meaning -- keys are not returned in any defined "
4329 "order). A pointer to the key is returned in C<*key_rtn> and the "
4330 "corresponding data pointer is returned from the function. C<NULL> is "
4331 "returned if there are no keys stored in the handle."
4335 #: ../src/guestfs.pod:2000
4337 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4338 "value of this function is also C<NULL> is there are no further entries to "
4343 #: ../src/guestfs.pod:2004
4344 msgid "Notes about walking over entries:"
4348 #: ../src/guestfs.pod:2010
4350 "You must not call C<guestfs_set_private> while walking over the entries."
4354 #: ../src/guestfs.pod:2015
4356 "The handle maintains an internal iterator which is reset when you call "
4357 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4358 "call C<guestfs_set_private>."
4362 #: ../src/guestfs.pod:2021
4363 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4367 #: ../src/guestfs.pod:2023
4370 " guestfs_set_private (g, key, NULL);\n"
4375 #: ../src/guestfs.pod:2025
4376 msgid "then that C<key> is not returned when walking."
4380 #: ../src/guestfs.pod:2029
4382 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4383 "C<guestfs_next_private> or C<guestfs_set_private>."
4387 #: ../src/guestfs.pod:2035
4389 "The following example code shows how to print all keys and data pointers "
4390 "that are associated with the handle C<g>:"
4394 #: ../src/guestfs.pod:2038
4397 " const char *key;\n"
4398 " void *data = guestfs_first_private (g, &key);\n"
4399 " while (data != NULL)\n"
4401 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4402 " data = guestfs_next_private (g, &key);\n"
4408 #: ../src/guestfs.pod:2046
4410 "More commonly you are only interested in keys that begin with an application-"
4411 "specific prefix C<foo_>. Modify the loop like so:"
4415 #: ../src/guestfs.pod:2049
4418 " const char *key;\n"
4419 " void *data = guestfs_first_private (g, &key);\n"
4420 " while (data != NULL)\n"
4422 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4423 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4424 " data = guestfs_next_private (g, &key);\n"
4430 #: ../src/guestfs.pod:2058
4432 "If you need to modify keys while walking, then you have to jump back to the "
4433 "beginning of the loop. For example, to delete all keys prefixed with "
4438 #: ../src/guestfs.pod:2062
4441 " const char *key;\n"
4444 " data = guestfs_first_private (g, &key);\n"
4445 " while (data != NULL)\n"
4447 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4449 " guestfs_set_private (g, key, NULL);\n"
4450 " /* note that 'key' pointer is now invalid, and so is\n"
4451 " the internal iterator */\n"
4454 " data = guestfs_next_private (g, &key);\n"
4460 #: ../src/guestfs.pod:2078
4462 "Note that the above loop is guaranteed to terminate because the keys are "
4463 "being deleted, but other manipulations of keys within the loop might not "
4464 "terminate unless you also maintain an indication of which keys have been "
4470 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4476 #: ../src/guestfs.pod:2085
4478 "<!-- old anchor for the next section --> <a name="
4479 "\"state_machine_and_low_level_event_api\"/>"
4484 #: ../src/guestfs.pod:2090
4485 msgid "ARCHITECTURE"
4490 #: ../src/guestfs.pod:2092
4492 "Internally, libguestfs is implemented by running an appliance (a special "
4493 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4494 "process of the main program."
4499 #: ../src/guestfs.pod:2096
4502 " ___________________\n"
4504 " | main program |\n"
4506 " | | child process / appliance\n"
4507 " | | __________________________\n"
4509 " +-------------------+ RPC | +-----------------+ |\n"
4510 " | libguestfs <--------------------> guestfsd | |\n"
4511 " | | | +-----------------+ |\n"
4512 " \\___________________/ | | Linux kernel | |\n"
4513 " | +--^--------------+ |\n"
4514 " \\_________|________________/\n"
4520 " \\______________/\n"
4526 #: ../src/guestfs.pod:2116
4528 "The library, linked to the main program, creates the child process and hence "
4529 "the appliance in the L</guestfs_launch> function."
4534 #: ../src/guestfs.pod:2119
4536 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4537 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4538 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4539 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4540 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4541 "attached to the qemu process which translates device access by the "
4542 "appliance's Linux kernel into accesses to the image."
4547 #: ../src/guestfs.pod:2128
4549 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4550 "Although the disk image you are attached to might also be used by some "
4551 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4552 "care if both libguestfs's qemu process and your virtual machine are trying "
4553 "to update the disk image at the same time, since these usually results in "
4554 "massive disk corruption)."
4559 #: ../src/guestfs.pod:2135
4560 msgid "STATE MACHINE"
4565 #: ../src/guestfs.pod:2137
4566 msgid "libguestfs uses a state machine to model the child process:"
4571 #: ../src/guestfs.pod:2139
4583 " / | \\ \\ guestfs_launch\n"
4584 " / | _\\__V______\n"
4586 " / | | LAUNCHING |\n"
4587 " / | \\___________/\n"
4589 " / | guestfs_launch\n"
4591 " ______ / __|____V\n"
4592 " / \\ ------> / \\\n"
4593 " | BUSY | | READY |\n"
4594 " \\______/ <------ \\________/\n"
4600 #: ../src/guestfs.pod:2161
4602 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4603 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4604 "(3) alternating between READY and BUSY as commands are issued to, and "
4605 "carried out by, the child process."
4610 #: ../src/guestfs.pod:2166
4612 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4613 "asynchronously at any time (eg. due to some internal error), and that causes "
4614 "the state to transition back to CONFIG."
4619 #: ../src/guestfs.pod:2170
4621 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4622 "issued when in the CONFIG state."
4627 #: ../src/guestfs.pod:2173
4629 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4630 "L</guestfs_launch> blocks until the child process is READY to accept "
4631 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4632 "moves the state from CONFIG to LAUNCHING while it is running."
4637 #: ../src/guestfs.pod:2179
4639 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4640 "state. These API calls block waiting for the command to be carried out (ie. "
4641 "the state to transition to BUSY and then back to READY). There are no non-"
4642 "blocking versions, and no way to issue more than one command per handle at "
4648 #: ../src/guestfs.pod:2185
4650 "Finally, the child process sends asynchronous messages back to the main "
4651 "program, such as kernel log messages. You can register a callback to "
4652 "receive these messages."
4657 #: ../src/guestfs.pod:2189
4663 #: ../src/guestfs.pod:2191
4664 msgid "COMMUNICATION PROTOCOL"
4669 #: ../src/guestfs.pod:2193
4671 "Don't rely on using this protocol directly. This section documents how it "
4672 "currently works, but it may change at any time."
4677 #: ../src/guestfs.pod:2196
4679 "The protocol used to talk between the library and the daemon running inside "
4680 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4681 "1014, RFC 1832, RFC 4506)."
4686 #: ../src/guestfs.pod:2200
4688 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4689 "this file is automatically generated)."
4694 #: ../src/guestfs.pod:2203
4696 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4697 "and C<FileOut> parameters, which are handled with very simple request/reply "
4698 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4699 "parameters, which use the same request and reply messages, but they may also "
4700 "be followed by files sent using a chunked encoding."
4705 #: ../src/guestfs.pod:2210
4706 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4711 #: ../src/guestfs.pod:2212
4712 msgid "For ordinary functions, the request message is:"
4717 #: ../src/guestfs.pod:2214
4720 " total length (header + arguments,\n"
4721 " but not including the length word itself)\n"
4722 " struct guestfs_message_header (encoded as XDR)\n"
4723 " struct guestfs_<foo>_args (encoded as XDR)\n"
4729 #: ../src/guestfs.pod:2219
4731 "The total length field allows the daemon to allocate a fixed size buffer "
4732 "into which it slurps the rest of the message. As a result, the total length "
4733 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4734 "effective size of any request is limited to somewhere under this size."
4739 #: ../src/guestfs.pod:2225
4741 "Note also that many functions don't take any arguments, in which case the "
4742 "C<guestfs_I<foo>_args> is completely omitted."
4747 #: ../src/guestfs.pod:2228
4749 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4750 "receiver knows what type of args structure to expect, or none at all."
4755 #: ../src/guestfs.pod:2232
4757 "For functions that take optional arguments, the optional arguments are "
4758 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4759 "arguments. A bitmask in the header indicates which optional arguments are "
4760 "meaningful. The bitmask is also checked to see if it contains bits set "
4761 "which the daemon does not know about (eg. if more optional arguments were "
4762 "added in a later version of the library), and this causes the call to be "
4768 #: ../src/guestfs.pod:2240
4769 msgid "The reply message for ordinary functions is:"
4774 #: ../src/guestfs.pod:2242
4777 " total length (header + ret,\n"
4778 " but not including the length word itself)\n"
4779 " struct guestfs_message_header (encoded as XDR)\n"
4780 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4786 #: ../src/guestfs.pod:2247
4788 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4789 "functions that return no formal return values."
4794 #: ../src/guestfs.pod:2250
4796 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4801 #: ../src/guestfs.pod:2253
4803 "In the case of an error, a flag is set in the header, and the reply message "
4804 "is slightly changed:"
4809 #: ../src/guestfs.pod:2256
4812 " total length (header + error,\n"
4813 " but not including the length word itself)\n"
4814 " struct guestfs_message_header (encoded as XDR)\n"
4815 " struct guestfs_message_error (encoded as XDR)\n"
4821 #: ../src/guestfs.pod:2261
4823 "The C<guestfs_message_error> structure contains the error message as a "
4829 #: ../src/guestfs.pod:2264
4830 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4835 #: ../src/guestfs.pod:2266
4837 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4838 "The normal request message is sent (see above). However this is followed by "
4839 "a sequence of file chunks."
4844 #: ../src/guestfs.pod:2270
4847 " total length (header + arguments,\n"
4848 " but not including the length word itself,\n"
4849 " and not including the chunks)\n"
4850 " struct guestfs_message_header (encoded as XDR)\n"
4851 " struct guestfs_<foo>_args (encoded as XDR)\n"
4852 " sequence of chunks for FileIn param #0\n"
4853 " sequence of chunks for FileIn param #1 etc.\n"
4859 #: ../src/guestfs.pod:2278
4860 msgid "The \"sequence of chunks\" is:"
4865 #: ../src/guestfs.pod:2280
4868 " length of chunk (not including length word itself)\n"
4869 " struct guestfs_chunk (encoded as XDR)\n"
4870 " length of chunk\n"
4871 " struct guestfs_chunk (encoded as XDR)\n"
4873 " length of chunk\n"
4874 " struct guestfs_chunk (with data.data_len == 0)\n"
4880 #: ../src/guestfs.pod:2288
4882 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4883 "is set in the final chunk to indicate either successful completion or early "
4889 #: ../src/guestfs.pod:2292
4891 "At time of writing there are no functions that have more than one FileIn "
4892 "parameter. However this is (theoretically) supported, by sending the "
4893 "sequence of chunks for each FileIn parameter one after another (from left to "
4899 #: ../src/guestfs.pod:2297
4901 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4902 "transfer. The library does this by sending a chunk with a special flag set "
4903 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4904 "RPC, does I<not> send any reply, and goes back to reading the next request."
4909 #: ../src/guestfs.pod:2303
4911 "The daemon may also cancel. It does this by writing a special word "
4912 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4913 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4914 "cancel chunk). The special word is chosen so that even if cancellation "
4915 "happens right at the end of the transfer (after the library has finished "
4916 "writing and has started listening for the reply), the \"spurious\" cancel "
4917 "flag will not be confused with the reply message."
4922 #: ../src/guestfs.pod:2312
4924 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4925 "limit), and also files where the size is not known in advance (eg. from "
4926 "pipes or sockets). However the chunks are rather small "
4927 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4928 "to keep much in memory."
4933 #: ../src/guestfs.pod:2318
4934 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4939 #: ../src/guestfs.pod:2320
4941 "The protocol for FileOut parameters is exactly the same as for FileIn "
4942 "parameters, but with the roles of daemon and library reversed."
4947 #: ../src/guestfs.pod:2323
4950 " total length (header + ret,\n"
4951 " but not including the length word itself,\n"
4952 " and not including the chunks)\n"
4953 " struct guestfs_message_header (encoded as XDR)\n"
4954 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4955 " sequence of chunks for FileOut param #0\n"
4956 " sequence of chunks for FileOut param #1 etc.\n"
4962 #: ../src/guestfs.pod:2331
4963 msgid "INITIAL MESSAGE"
4968 #: ../src/guestfs.pod:2333
4970 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4971 "which indicates that the guest and daemon is alive. This is what L</"
4972 "guestfs_launch> waits for."
4977 #: ../src/guestfs.pod:2337
4978 msgid "PROGRESS NOTIFICATION MESSAGES"
4983 #: ../src/guestfs.pod:2339
4985 "The daemon may send progress notification messages at any time. These are "
4986 "distinguished by the normal length word being replaced by "
4987 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4991 #: ../src/guestfs.pod:2343
4993 "The library turns them into progress callbacks (see L</"
4994 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5000 #: ../src/guestfs.pod:2347
5002 "The daemon self-limits the frequency of progress messages it sends (see "
5003 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5009 #: ../src/guestfs.pod:2351
5010 msgid "LIBGUESTFS VERSION NUMBERS"
5015 #: ../src/guestfs.pod:2353
5017 "Since April 2010, libguestfs has started to make separate development and "
5018 "stable releases, along with corresponding branches in our git repository. "
5019 "These separate releases can be identified by version number:"
5024 #: ../src/guestfs.pod:2358
5027 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5028 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5034 " | `-------- sub-version\n"
5036 " `------ always '1' because we don't change the ABI\n"
5042 #: ../src/guestfs.pod:2369
5043 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5048 #: ../src/guestfs.pod:2371
5050 "As time passes we cherry pick fixes from the development branch and backport "
5051 "those into the stable branch, the effect being that the stable branch should "
5052 "get more stable and less buggy over time. So the stable releases are ideal "
5053 "for people who don't need new features but would just like the software to "
5059 #: ../src/guestfs.pod:2377
5060 msgid "Our criteria for backporting changes are:"
5065 #: ../src/guestfs.pod:2383
5067 "Documentation changes which don't affect any code are backported unless the "
5068 "documentation refers to a future feature which is not in stable."
5073 #: ../src/guestfs.pod:2389
5075 "Bug fixes which are not controversial, fix obvious problems, and have been "
5076 "well tested are backported."
5081 #: ../src/guestfs.pod:2394
5083 "Simple rearrangements of code which shouldn't affect how it works get "
5084 "backported. This is so that the code in the two branches doesn't get too "
5085 "far out of step, allowing us to backport future fixes more easily."
5090 #: ../src/guestfs.pod:2400
5092 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5093 "exceptional case: the new feature is required in order to implement an "
5094 "important bug fix."
5099 #: ../src/guestfs.pod:2406
5101 "A new stable branch starts when we think the new features in development are "
5102 "substantial and compelling enough over the current stable branch to warrant "
5103 "it. When that happens we create new stable and development versions 1.N.0 "
5104 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5105 "stable at this point, but by backporting fixes from development, that branch "
5106 "will stabilize over time."
5110 #: ../src/guestfs.pod:2414
5111 msgid "EXTENDING LIBGUESTFS"
5115 #: ../src/guestfs.pod:2416
5116 msgid "ADDING A NEW API ACTION"
5120 #: ../src/guestfs.pod:2418
5122 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5123 "documentation) are generated, and this makes it easy to extend the "
5128 #: ../src/guestfs.pod:2422
5129 msgid "To add a new API action there are two changes:"
5133 #: ../src/guestfs.pod:2428
5135 "You need to add a description of the call (name, parameters, return type, "
5136 "tests, documentation) to C<generator/generator_actions.ml>."
5140 #: ../src/guestfs.pod:2431
5142 "There are two sorts of API action, depending on whether the call goes "
5143 "through to the daemon in the appliance, or is serviced entirely by the "
5144 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5145 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5146 "an example of the latter, since a trace flag is maintained in the handle and "
5147 "all tracing is done on the library side."
5151 #: ../src/guestfs.pod:2439
5153 "Most new actions are of the first type, and get added to the "
5154 "C<daemon_functions> list. Each function has a unique procedure number used "
5155 "in the RPC protocol which is assigned to that action when we publish "
5156 "libguestfs and cannot be reused. Take the latest procedure number and "
5161 #: ../src/guestfs.pod:2445
5163 "For library-only actions of the second type, add to the "
5164 "C<non_daemon_functions> list. Since these functions are serviced by the "
5165 "library and do not travel over the RPC mechanism to the daemon, these "
5166 "functions do not need a procedure number, and so the procedure number is set "
5171 #: ../src/guestfs.pod:2453
5172 msgid "Implement the action (in C):"
5176 #: ../src/guestfs.pod:2455
5178 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5179 "C<daemon/> directory."
5183 #: ../src/guestfs.pod:2458
5185 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5186 "(note: double underscore) in the C<src/> directory."
5190 #: ../src/guestfs.pod:2461
5191 msgid "In either case, use another function as an example of what to do."
5195 #: ../src/guestfs.pod:2465
5196 msgid "After making these changes, use C<make> to compile."
5200 #: ../src/guestfs.pod:2467
5202 "Note that you don't need to implement the RPC, language bindings, manual "
5203 "pages or anything else. It's all automatically generated from the OCaml "
5208 #: ../src/guestfs.pod:2471
5209 msgid "ADDING TESTS FOR AN API ACTION"
5213 #: ../src/guestfs.pod:2473
5215 "You can supply zero or as many tests as you want per API call. The tests "
5216 "can either be added as part of the API description (C<generator/"
5217 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5218 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5219 "slower, so if possible use the first method."
5223 #: ../src/guestfs.pod:2479
5225 "The following describes the test environment used when you add an API test "
5226 "in C<generator_actions.ml>."
5230 #: ../src/guestfs.pod:2482
5231 msgid "The test environment has 4 block devices:"
5235 #: ../src/guestfs.pod:2486
5236 msgid "C</dev/sda> 500MB"
5240 #: ../src/guestfs.pod:2488
5241 msgid "General block device for testing."
5245 #: ../src/guestfs.pod:2490
5246 msgid "C</dev/sdb> 50MB"
5250 #: ../src/guestfs.pod:2492
5252 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5257 #: ../src/guestfs.pod:2495
5258 msgid "C</dev/sdc> 10MB"
5262 #: ../src/guestfs.pod:2497
5263 msgid "Used in a few tests where two block devices are needed."
5267 #: ../src/guestfs.pod:2499
5272 #: ../src/guestfs.pod:2501
5273 msgid "ISO with fixed content (see C<images/test.iso>)."
5277 #: ../src/guestfs.pod:2505
5279 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5280 "appliance and block devices are reused between tests. So don't try testing "
5281 "L</guestfs_kill_subprocess> :-x"
5285 #: ../src/guestfs.pod:2509
5287 "Each test starts with an initial scenario, selected using one of the "
5288 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5289 "initialize the disks mentioned above in a particular way as documented in "
5290 "C<generator_types.ml>. You should not assume anything about the previous "
5291 "contents of other disks that are not initialized."
5295 #: ../src/guestfs.pod:2515
5297 "You can add a prerequisite clause to any individual test. This is a run-"
5298 "time check, which, if it fails, causes the test to be skipped. Useful if "
5299 "testing a command which might not work on all variations of libguestfs "
5300 "builds. A test that has prerequisite of C<Always> means to run "
5305 #: ../src/guestfs.pod:2521
5307 "In addition, packagers can skip individual tests by setting environment "
5308 "variables before running C<make check>."
5312 #: ../src/guestfs.pod:2524
5315 " SKIP_TEST_<CMD>_<NUM>=1\n"
5320 #: ../src/guestfs.pod:2526
5321 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5325 #: ../src/guestfs.pod:2528
5330 #: ../src/guestfs.pod:2530
5333 " SKIP_TEST_<CMD>=1\n"
5338 #: ../src/guestfs.pod:2532
5339 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5343 #: ../src/guestfs.pod:2534
5344 msgid "Packagers can run only certain tests by setting for example:"
5348 #: ../src/guestfs.pod:2536
5351 " TEST_ONLY=\"vfs_type zerofree\"\n"
5356 #: ../src/guestfs.pod:2538
5358 "See C<capitests/tests.c> for more details of how these environment variables "
5363 #: ../src/guestfs.pod:2541
5364 msgid "DEBUGGING NEW API ACTIONS"
5368 #: ../src/guestfs.pod:2543
5369 msgid "Test new actions work before submitting them."
5373 #: ../src/guestfs.pod:2545
5374 msgid "You can use guestfish to try out new commands."
5378 #: ../src/guestfs.pod:2547
5380 "Debugging the daemon is a problem because it runs inside a minimal "
5381 "environment. However you can fprintf messages in the daemon to stderr, and "
5382 "they will show up if you use C<guestfish -v>."
5386 #: ../src/guestfs.pod:2551
5387 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5391 #: ../src/guestfs.pod:2553
5393 "Our C source code generally adheres to some basic code-formatting "
5394 "conventions. The existing code base is not totally consistent on this "
5395 "front, but we do prefer that contributed code be formatted similarly. In "
5396 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5397 "indentation level, and other than that, follow the K&R style."
5401 #: ../src/guestfs.pod:2559
5403 "If you use Emacs, add the following to one of one of your start-up files (e."
5404 "g., ~/.emacs), to help ensure that you get indentation right:"
5408 #: ../src/guestfs.pod:2562
5411 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5412 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5413 " (add-hook 'find-file-hook\n"
5414 " '(lambda () (if (and buffer-file-name\n"
5415 " (string-match \"/libguestfs\\\\>\"\n"
5416 " (buffer-file-name))\n"
5417 " (not (string-equal mode-name \"Change Log\"))\n"
5418 " (not (string-equal mode-name \"Makefile\")))\n"
5419 " (setq indent-tabs-mode nil))))\n"
5424 #: ../src/guestfs.pod:2572
5427 " ;;; When editing C sources in libguestfs, use this style.\n"
5428 " (defun libguestfs-c-mode ()\n"
5429 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5431 " (c-set-style \"K&R\")\n"
5432 " (setq c-indent-level 2)\n"
5433 " (setq c-basic-offset 2))\n"
5434 " (add-hook 'c-mode-hook\n"
5435 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5436 " (buffer-file-name))\n"
5437 " (libguestfs-c-mode))))\n"
5442 #: ../src/guestfs.pod:2584
5443 msgid "Enable warnings when compiling (and fix any problems this finds):"
5447 #: ../src/guestfs.pod:2587
5450 " ./configure --enable-gcc-warnings\n"
5455 #: ../src/guestfs.pod:2589
5456 msgid "Useful targets are:"
5460 #: ../src/guestfs.pod:2591
5463 " make syntax-check # checks the syntax of the C code\n"
5464 " make check # runs the test suite\n"
5469 #: ../src/guestfs.pod:2594
5470 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5474 #: ../src/guestfs.pod:2596
5476 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5477 "which are used to do shell quoting."
5481 #: ../src/guestfs.pod:2601
5486 #: ../src/guestfs.pod:2603
5488 "Simple shell quoted string. Any spaces or other shell characters are "
5493 #: ../src/guestfs.pod:2606
5498 #: ../src/guestfs.pod:2608
5500 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5506 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5507 msgid "For example:"
5511 #: ../src/guestfs.pod:2615
5514 " asprintf (&cmd, \"cat %R\", path);\n"
5519 #: ../src/guestfs.pod:2617
5520 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5524 #: ../src/guestfs.pod:2619
5526 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5527 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5528 "they are not passed via the shell (instead, straight to exec). You probably "
5529 "want to use the C<sysroot_path()> function however."
5533 #: ../src/guestfs.pod:2625
5534 msgid "SUBMITTING YOUR NEW API ACTIONS"
5538 #: ../src/guestfs.pod:2627
5540 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5541 "libguestfs> and CC to L<rjones@redhat.com>."
5545 #: ../src/guestfs.pod:2631
5546 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5550 #: ../src/guestfs.pod:2633
5551 msgid "We support i18n (gettext anyhow) in the library."
5555 #: ../src/guestfs.pod:2635
5557 "However many messages come from the daemon, and we don't translate those at "
5558 "the moment. One reason is that the appliance generally has all locale files "
5559 "removed from it, because they take up a lot of space. So we'd have to readd "
5560 "some of those, as well as copying our PO files into the appliance."
5564 #: ../src/guestfs.pod:2641
5566 "Debugging messages are never translated, since they are intended for the "
5571 #: ../src/guestfs.pod:2644
5572 msgid "SOURCE CODE SUBDIRECTORIES"
5576 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5979
5577 #: ../fish/guestfish-actions.pod:3958
5578 msgid "C<appliance>"
5582 #: ../src/guestfs.pod:2650
5583 msgid "The libguestfs appliance, build scripts and so on."
5587 #: ../src/guestfs.pod:2652
5588 msgid "C<capitests>"
5592 #: ../src/guestfs.pod:2654
5593 msgid "Automated tests of the C API."
5597 #: ../src/guestfs.pod:2656
5602 #: ../src/guestfs.pod:2658
5604 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5609 #: ../src/guestfs.pod:2661
5614 #: ../src/guestfs.pod:2663
5616 "Safety and liveness tests of components that libguestfs depends upon (not of "
5617 "libguestfs itself). Mainly this is for qemu and the kernel."
5621 #: ../src/guestfs.pod:2666
5626 #: ../src/guestfs.pod:2668
5627 msgid "Outside contributions, experimental parts."
5631 #: ../src/guestfs.pod:2670
5636 #: ../src/guestfs.pod:2672
5638 "The daemon that runs inside the libguestfs appliance and carries out actions."
5642 #: ../src/guestfs.pod:2675
5647 #: ../src/guestfs.pod:2677
5648 msgid "L<virt-df(1)> command and documentation."
5652 #: ../src/guestfs.pod:2679
5657 #: ../src/guestfs.pod:2681
5658 msgid "L<virt-edit(1)> command and documentation."
5662 #: ../src/guestfs.pod:2683
5667 #: ../src/guestfs.pod:2685
5668 msgid "C API example code."
5672 #: ../src/guestfs.pod:2687
5677 #: ../src/guestfs.pod:2689
5679 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5680 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5681 "L<virt-tar-out(1)>."
5685 #: ../src/guestfs.pod:2693
5690 #: ../src/guestfs.pod:2695
5692 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5696 #: ../src/guestfs.pod:2697
5697 msgid "C<generator>"
5701 #: ../src/guestfs.pod:2699
5703 "The crucially important generator, used to automatically generate large "
5704 "amounts of boilerplate C code for things like RPC and bindings."
5708 #: ../src/guestfs.pod:2702
5713 #: ../src/guestfs.pod:2704
5714 msgid "Files used by the test suite."
5718 #: ../src/guestfs.pod:2706
5719 msgid "Some \"phony\" guest images which we test against."
5723 #: ../src/guestfs.pod:2708
5724 msgid "C<inspector>"
5728 #: ../src/guestfs.pod:2710
5729 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5733 #: ../src/guestfs.pod:2712
5738 #: ../src/guestfs.pod:2714
5739 msgid "Logo used on the website. The fish is called Arthur by the way."
5743 #: ../src/guestfs.pod:2716
5748 #: ../src/guestfs.pod:2718
5749 msgid "M4 macros used by autoconf."
5753 #: ../src/guestfs.pod:2720
5758 #: ../src/guestfs.pod:2722
5759 msgid "Translations of simple gettext strings."
5763 #: ../src/guestfs.pod:2724
5768 #: ../src/guestfs.pod:2726
5770 "The build infrastructure and PO files for translations of manpages and POD "
5771 "files. Eventually this will be combined with the C<po> directory, but that "
5772 "is rather complicated."
5776 #: ../src/guestfs.pod:2730
5777 msgid "C<regressions>"
5781 #: ../src/guestfs.pod:2732
5782 msgid "Regression tests."
5786 #: ../src/guestfs.pod:2734
5791 #: ../src/guestfs.pod:2736
5792 msgid "L<virt-rescue(1)> command and documentation."
5796 #: ../src/guestfs.pod:2738
5801 #: ../src/guestfs.pod:2740
5802 msgid "Source code to the C library."
5806 #: ../src/guestfs.pod:2742
5811 #: ../src/guestfs.pod:2744
5812 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5816 #: ../src/guestfs.pod:2746
5817 msgid "C<test-tool>"
5821 #: ../src/guestfs.pod:2748
5823 "Test tool for end users to test if their qemu/kernel combination will work "
5828 #: ../src/guestfs.pod:2751
5833 #: ../src/guestfs.pod:2753
5838 #: ../src/guestfs.pod:2755
5843 #: ../src/guestfs.pod:2757
5848 #: ../src/guestfs.pod:2759
5853 #: ../src/guestfs.pod:2761
5858 #: ../src/guestfs.pod:2763
5863 #: ../src/guestfs.pod:2765
5868 #: ../src/guestfs.pod:2767
5869 msgid "Language bindings."
5873 #: ../src/guestfs.pod:2771
5879 #: ../src/guestfs.pod:2773
5880 msgid "PROTOCOL LIMITS"
5885 #: ../src/guestfs.pod:2775
5887 "Internally libguestfs uses a message-based protocol to pass API calls and "
5888 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5889 "plenty more detail about this). The maximum message size used by the "
5890 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5891 "aware of this limit. The API calls which may be affected are individually "
5892 "documented, with a link back to this section of the documentation."
5897 #: ../src/guestfs.pod:2783
5899 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5900 "a simple string. Because this string is at some point internally encoded as "
5901 "a message, the maximum size that it can return is slightly under 4 MB. If "
5902 "the requested file is larger than this then you will get an error."
5907 #: ../src/guestfs.pod:2789
5909 "In order to transfer large files into and out of the guest filesystem, you "
5910 "need to use particular calls that support this. The sections L</UPLOADING> "
5911 "and L</DOWNLOADING> document how to do this."
5916 #: ../src/guestfs.pod:2793
5918 "You might also consider mounting the disk image using our FUSE filesystem "
5919 "support (L<guestmount(1)>)."
5923 #: ../src/guestfs.pod:2796
5924 msgid "MAXIMUM NUMBER OF DISKS"
5928 #: ../src/guestfs.pod:2798
5929 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5933 #: ../src/guestfs.pod:2801
5935 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5936 "slots. However febootstrap only understands disks with names C</dev/vda> "
5937 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5942 #: ../src/guestfs.pod:2806
5944 "We are working to substantially raise this limit in future versions but it "
5945 "requires complex changes to qemu."
5949 #: ../src/guestfs.pod:2809
5951 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5952 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5953 "requires changes to qemu."
5957 #: ../src/guestfs.pod:2813
5958 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5962 #: ../src/guestfs.pod:2815
5963 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5967 #: ../src/guestfs.pod:2817
5969 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5970 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5974 #: ../src/guestfs.pod:2820
5976 "If you attach a disk with more than 15 partitions, the extra partitions are "
5977 "ignored by libguestfs."
5981 #: ../src/guestfs.pod:2823
5982 msgid "MAXIMUM SIZE OF A DISK"
5986 #: ../src/guestfs.pod:2825
5987 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5991 #: ../src/guestfs.pod:2827
5993 "We have tested block devices up to 1 exabyte (2**60 or "
5994 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5999 #: ../src/guestfs.pod:2831
6001 "Although libguestfs probably does not impose any limit, the underlying host "
6002 "storage will. If you store disk images on a host ext4 filesystem, then the "
6003 "maximum size will be limited by the maximum ext4 file size (currently 16 "
6004 "TB). If you store disk images as host logical volumes then you are limited "
6005 "by the maximum size of an LV."
6009 #: ../src/guestfs.pod:2837
6011 "For the hugest disk image files, we recommend using XFS on the host for "
6016 #: ../src/guestfs.pod:2840
6017 msgid "MAXIMUM SIZE OF A PARTITION"
6021 #: ../src/guestfs.pod:2842
6023 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6024 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6025 "address a partition located beyond 2 TB on the disk."
6029 #: ../src/guestfs.pod:2846
6031 "It is recommended that you use GPT partitions on disks which are larger than "
6032 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6033 "which are theoretically larger than the largest disk we could support."
6037 #: ../src/guestfs.pod:2851
6038 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6042 #: ../src/guestfs.pod:2853
6044 "This depends on the filesystem type. libguestfs itself does not impose any "
6045 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6046 "what these limits are."
6050 #: ../src/guestfs.pod:2857
6051 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6055 #: ../src/guestfs.pod:2859
6057 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6058 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6059 "uploads and downloads."
6063 #: ../src/guestfs.pod:2863
6064 msgid "INSPECTION LIMITS"
6068 #: ../src/guestfs.pod:2865
6070 "The inspection code has several arbitrary limits on things like the size of "
6071 "Windows Registry hive it will read, and the length of product name. These "
6072 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6073 "memory and disk space on the host, and should not be reached in practice. "
6074 "See the source code for more information."
6079 #: ../src/guestfs.pod:2871 ../fish/guestfish.pod:1017
6080 #: ../test-tool/libguestfs-test-tool.pod:82
6081 msgid "ENVIRONMENT VARIABLES"
6086 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1048
6087 msgid "LIBGUESTFS_APPEND"
6092 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1050
6093 msgid "Pass additional options to the guest kernel."
6098 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
6099 msgid "LIBGUESTFS_DEBUG"
6104 #: ../src/guestfs.pod:2881
6106 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6107 "effect as calling C<guestfs_set_verbose (g, 1)>."
6112 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
6113 msgid "LIBGUESTFS_MEMSIZE"
6118 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
6120 "Set the memory allocated to the qemu process, in megabytes. For example:"
6125 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1062
6128 " LIBGUESTFS_MEMSIZE=700\n"
6134 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
6135 msgid "LIBGUESTFS_PATH"
6139 #: ../src/guestfs.pod:2893
6141 "Set the path that libguestfs uses to search for a supermin appliance. See "
6142 "the discussion of paths in section L</PATH> above."
6147 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1069
6148 msgid "LIBGUESTFS_QEMU"
6153 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1071
6155 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6156 "which was found at compile time by the configure script is used."
6161 #: ../src/guestfs.pod:2902
6162 msgid "See also L</QEMU WRAPPERS> above."
6167 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1075
6168 msgid "LIBGUESTFS_TRACE"
6173 #: ../src/guestfs.pod:2906
6175 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6176 "effect as calling C<guestfs_set_trace (g, 1)>."
6181 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
6186 #: ../src/guestfs.pod:2911 ../fish/guestfish.pod:1086
6188 "Location of temporary directory, defaults to C</tmp> except for the cached "
6189 "supermin appliance which defaults to C</var/tmp>."
6193 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1089
6195 "If libguestfs was compiled to use the supermin appliance then the real "
6196 "appliance is cached in this directory, shared between all handles belonging "
6197 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6198 "use in case C</var/tmp> is not large enough."
6203 #: ../src/guestfs.pod:2922 ../fish/guestfish.pod:1156
6204 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
6205 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
6206 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6207 #: ../tools/virt-list-partitions.pl:257
6212 #: ../src/guestfs.pod:2924
6214 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6215 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6216 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6217 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6218 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6219 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6220 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6225 #: ../src/guestfs.pod:2951
6227 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6228 "(8)>, L<disktype(1)>."
6233 #: ../src/guestfs.pod:2958 ../tools/virt-win-reg.pl:759
6234 #: ../tools/virt-make-fs.pl:553
6240 #: ../src/guestfs.pod:2960
6241 msgid "To get a list of bugs against libguestfs use this link:"
6246 #: ../src/guestfs.pod:2962
6248 "L<https://bugzilla.redhat.com/buglist.cgi?"
6249 "component=libguestfs&product=Virtualization+Tools>"
6254 #: ../src/guestfs.pod:2964
6255 msgid "To report a new bug against libguestfs use this link:"
6260 #: ../src/guestfs.pod:2966
6262 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6263 "component=libguestfs&product=Virtualization+Tools>"
6268 #: ../src/guestfs.pod:2968
6269 msgid "When reporting a bug, please check:"
6274 #: ../src/guestfs.pod:2974
6275 msgid "That the bug hasn't been reported already."
6280 #: ../src/guestfs.pod:2978
6281 msgid "That you are testing a recent version."
6286 #: ../src/guestfs.pod:2982
6287 msgid "Describe the bug accurately, and give a way to reproduce it."
6292 #: ../src/guestfs.pod:2986
6294 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6300 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1180
6301 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
6307 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1182
6308 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
6309 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6314 #: ../src/guestfs.pod:2995 ../fish/guestfish.pod:1184
6315 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
6316 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
6317 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6318 #: ../tools/virt-list-partitions.pl:273
6323 #: ../src/guestfs.pod:2997 ../fish/guestfish.pod:1186
6324 #: ../test-tool/libguestfs-test-tool.pod:99
6325 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6330 #: ../src/guestfs.pod:3000
6332 "This library is free software; you can redistribute it and/or modify it "
6333 "under the terms of the GNU Lesser General Public License as published by the "
6334 "Free Software Foundation; either version 2 of the License, or (at your "
6335 "option) any later version."
6340 #: ../src/guestfs.pod:3005
6342 "This library is distributed in the hope that it will be useful, but WITHOUT "
6343 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6344 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6350 #: ../src/guestfs.pod:3010
6352 "You should have received a copy of the GNU Lesser General Public License "
6353 "along with this library; if not, write to the Free Software Foundation, "
6354 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6359 #: ../src/guestfs-actions.pod:1
6360 msgid "guestfs_add_cdrom"
6365 #: ../src/guestfs-actions.pod:3
6369 " guestfs_add_cdrom (guestfs_h *g,\n"
6370 " const char *filename);\n"
6376 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6377 msgid "This function adds a virtual CD-ROM disk image to the guest."
6381 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6382 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6387 #: ../src/guestfs-actions.pod:17
6389 "This call checks for the existence of C<filename>. This stops you from "
6390 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6391 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6397 #: ../src/guestfs-actions.pod:24
6399 "If you just want to add an ISO file (often you use this as an efficient way "
6400 "to transfer large files into the guest), then you should probably use "
6401 "C<guestfs_add_drive_ro> instead."
6406 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6407 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6408 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6409 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6410 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6411 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6412 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6413 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6414 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6415 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6416 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6417 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
6418 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
6419 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
6420 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
6421 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
6422 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
6423 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
6424 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720
6425 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2271
6426 #: ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2476
6427 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3551
6428 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3591
6429 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:3774
6430 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3801
6431 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3852
6432 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3944
6433 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3984
6434 #: ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4039
6435 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4077
6436 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4124
6437 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176
6438 #: ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4204
6439 #: ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4314
6440 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4347
6441 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4416
6442 #: ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:4450
6443 #: ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4478
6444 #: ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4510
6445 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4588
6446 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4692
6447 #: ../src/guestfs-actions.pod:4711 ../src/guestfs-actions.pod:4730
6448 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:4759
6449 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4787
6450 #: ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4837
6451 #: ../src/guestfs-actions.pod:4870 ../src/guestfs-actions.pod:4909
6452 #: ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4943
6453 #: ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:5009
6454 #: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5060
6455 #: ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5105
6456 #: ../src/guestfs-actions.pod:5123 ../src/guestfs-actions.pod:5257
6457 #: ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5336
6458 #: ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5386
6459 #: ../src/guestfs-actions.pod:5452 ../src/guestfs-actions.pod:5469
6460 #: ../src/guestfs-actions.pod:5482 ../src/guestfs-actions.pod:5496
6461 #: ../src/guestfs-actions.pod:5785 ../src/guestfs-actions.pod:5804
6462 #: ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5837
6463 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5863
6464 #: ../src/guestfs-actions.pod:5875 ../src/guestfs-actions.pod:5889
6465 #: ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5926
6466 #: ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964
6467 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6012
6468 #: ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6053
6469 #: ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6093
6470 #: ../src/guestfs-actions.pod:6112 ../src/guestfs-actions.pod:6129
6471 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6181
6472 #: ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6224
6473 #: ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6258
6474 #: ../src/guestfs-actions.pod:6277 ../src/guestfs-actions.pod:6314
6475 #: ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6377
6476 #: ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6620
6477 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6645
6478 #: ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6680
6479 #: ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6706
6480 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6734
6481 #: ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6810
6482 #: ../src/guestfs-actions.pod:6826 ../src/guestfs-actions.pod:6842
6483 #: ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872
6484 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6928
6485 #: ../src/guestfs-actions.pod:6942 ../src/guestfs-actions.pod:6983
6486 #: ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7014
6487 #: ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7084
6488 #: ../src/guestfs-actions.pod:7203 ../src/guestfs-actions.pod:7221
6489 #: ../src/guestfs-actions.pod:7235 ../src/guestfs-actions.pod:7290
6490 #: ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7348
6491 #: ../src/guestfs-actions.pod:7381 ../src/guestfs-actions.pod:7442
6492 #: ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7535
6493 #: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7583
6494 msgid "This function returns 0 on success or -1 on error."
6499 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6500 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6501 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6503 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6509 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6510 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6511 #: ../src/guestfs-actions.pod:1949 ../src/guestfs-actions.pod:1970
6512 #: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4842
6513 #: ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6352
6514 #: ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6444
6515 #: ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7476
6516 #: ../src/guestfs-actions.pod:7646 ../fish/guestfish-actions.pod:31
6517 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6518 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6519 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038
6520 #: ../fish/guestfish-actions.pod:3235 ../fish/guestfish-actions.pod:4220
6521 #: ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4265
6522 #: ../fish/guestfish-actions.pod:4303 ../fish/guestfish-actions.pod:4944
6523 #: ../fish/guestfish-actions.pod:5042
6525 "Deprecated functions will not be removed from the API, but the fact that "
6526 "they are deprecated indicates that there are problems with correct use of "
6532 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6533 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1921
6534 #: ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2122
6535 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3573
6536 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:6014
6537 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6245
6538 #: ../src/guestfs-actions.pod:6736 ../src/guestfs-actions.pod:6861
6539 #: ../src/guestfs-actions.pod:7390
6540 msgid "(Added in 0.3)"
6545 #: ../src/guestfs-actions.pod:41
6546 msgid "guestfs_add_domain"
6551 #: ../src/guestfs-actions.pod:43
6555 " guestfs_add_domain (guestfs_h *g,\n"
6556 " const char *dom,\n"
6563 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6564 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:4549
6565 #: ../src/guestfs-actions.pod:4856
6567 "You may supply a list of optional arguments to this call. Use zero or more "
6568 "of the following pairs of parameters, and terminate the list with C<-1> on "
6569 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6573 #: ../src/guestfs-actions.pod:53
6576 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6577 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6578 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6579 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6580 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6586 #: ../src/guestfs-actions.pod:59
6588 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6589 "It works by connecting to libvirt, requesting the domain and domain XML from "
6590 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6596 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6598 "The number of disks added is returned. This operation is atomic: if an "
6599 "error is returned, then no disks are added."
6604 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6606 "This function does some minimal checks to make sure the libvirt domain is "
6607 "not running (unless C<readonly> is true). In a future version we will try "
6608 "to acquire the libvirt lock on each disk."
6613 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6615 "Disks must be accessible locally. This often means that adding disks from a "
6616 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6617 "unless those disks are accessible via the same device path locally too."
6621 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6623 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6624 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6625 "libvirt URI (or one set through an environment variable, see the libvirt "
6626 "documentation for full details)."
6630 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6632 "The optional C<live> flag controls whether this call will try to connect to "
6633 "a running virtual machine C<guestfsd> process if it sees a suitable "
6634 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6635 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6636 "DAEMONS> for more information."
6640 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6642 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6643 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6644 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6650 #: ../src/guestfs-actions.pod:94
6652 "The other optional parameters are passed directly through to "
6653 "C<guestfs_add_drive_opts>."
6658 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6659 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6660 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6661 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6662 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6663 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2031
6664 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:2109
6665 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2874
6666 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:5032
6667 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5566
6668 #: ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:6969
6669 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7414
6670 #: ../src/guestfs-actions.pod:7427
6671 msgid "On error this function returns -1."
6676 #: ../src/guestfs-actions.pod:99
6677 msgid "(Added in 1.7.4)"
6682 #: ../src/guestfs-actions.pod:101
6683 msgid "guestfs_add_domain_va"
6688 #: ../src/guestfs-actions.pod:103
6692 " guestfs_add_domain_va (guestfs_h *g,\n"
6693 " const char *dom,\n"
6700 #: ../src/guestfs-actions.pod:108
6701 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6706 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6707 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6708 #: ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2852
6709 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4614
6710 #: ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:4896
6711 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6716 #: ../src/guestfs-actions.pod:112
6717 msgid "guestfs_add_domain_argv"
6722 #: ../src/guestfs-actions.pod:114
6726 " guestfs_add_domain_argv (guestfs_h *g,\n"
6727 " const char *dom,\n"
6728 " const struct guestfs_add_domain_argv *optargs);\n"
6734 #: ../src/guestfs-actions.pod:119
6735 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6740 #: ../src/guestfs-actions.pod:123
6741 msgid "guestfs_add_drive"
6746 #: ../src/guestfs-actions.pod:125
6750 " guestfs_add_drive (guestfs_h *g,\n"
6751 " const char *filename);\n"
6757 #: ../src/guestfs-actions.pod:129
6759 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6760 "optional parameters, so the disk is added writable, with the format being "
6761 "detected automatically."
6766 #: ../src/guestfs-actions.pod:133
6768 "Automatic detection of the format opens you up to a potential security hole "
6769 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6770 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6771 "you should think about replacing calls to this function with calls to "
6772 "C<guestfs_add_drive_opts>, and specifying the format."
6777 #: ../src/guestfs-actions.pod:144
6778 msgid "guestfs_add_drive_opts"
6783 #: ../src/guestfs-actions.pod:146
6787 " guestfs_add_drive_opts (guestfs_h *g,\n"
6788 " const char *filename,\n"
6795 #: ../src/guestfs-actions.pod:156
6798 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6799 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6800 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6806 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6808 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6809 "The first time you call this function, the disk appears as C</dev/sda>, the "
6810 "second time as C</dev/sdb>, and so on."
6815 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6817 "You don't necessarily need to be root when using libguestfs. However you "
6818 "obviously do need sufficient permissions to access the filename for whatever "
6819 "operations you want to perform (ie. read access if you just want to read the "
6820 "image or write access if you want to modify the image)."
6825 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6826 msgid "This call checks that C<filename> exists."
6831 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4560
6832 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6833 msgid "The optional arguments are:"
6838 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6844 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6846 "If true then the image is treated as read-only. Writes are still allowed, "
6847 "but they are stored in a temporary snapshot overlay which is discarded at "
6848 "the end. The disk that you add is not modified."
6853 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6859 #: ../src/guestfs-actions.pod:185
6861 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6862 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6863 "Possible formats include C<raw> and C<qcow2>."
6868 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6870 "Automatic detection of the format opens you up to a potential security hole "
6871 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6872 "RHBZ#642934. Specifying the format closes this security hole."
6877 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6883 #: ../src/guestfs-actions.pod:196
6885 "This rarely-used option lets you emulate the behaviour of the deprecated "
6886 "C<guestfs_add_drive_with_if> call (q.v.)"
6891 #: ../src/guestfs-actions.pod:203
6892 msgid "(Added in 1.5.23)"
6897 #: ../src/guestfs-actions.pod:205
6898 msgid "guestfs_add_drive_opts_va"
6903 #: ../src/guestfs-actions.pod:207
6907 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6908 " const char *filename,\n"
6915 #: ../src/guestfs-actions.pod:212
6916 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6921 #: ../src/guestfs-actions.pod:216
6922 msgid "guestfs_add_drive_opts_argv"
6927 #: ../src/guestfs-actions.pod:218
6931 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6932 " const char *filename,\n"
6933 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6939 #: ../src/guestfs-actions.pod:223
6940 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6945 #: ../src/guestfs-actions.pod:227
6946 msgid "guestfs_add_drive_ro"
6951 #: ../src/guestfs-actions.pod:229
6955 " guestfs_add_drive_ro (guestfs_h *g,\n"
6956 " const char *filename);\n"
6962 #: ../src/guestfs-actions.pod:233
6964 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6965 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6966 "disk is added read-only, with the format being detected automatically."
6971 #: ../src/guestfs-actions.pod:240
6972 msgid "(Added in 1.0.38)"
6977 #: ../src/guestfs-actions.pod:242
6978 msgid "guestfs_add_drive_ro_with_if"
6983 #: ../src/guestfs-actions.pod:244
6987 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6988 " const char *filename,\n"
6989 " const char *iface);\n"
6995 #: ../src/guestfs-actions.pod:249
6997 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6998 "QEMU interface emulation to use at run time."
7003 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
7004 #: ../src/guestfs-actions.pod:2361
7005 msgid "(Added in 1.0.84)"
7010 #: ../src/guestfs-actions.pod:263
7011 msgid "guestfs_add_drive_with_if"
7016 #: ../src/guestfs-actions.pod:265
7020 " guestfs_add_drive_with_if (guestfs_h *g,\n"
7021 " const char *filename,\n"
7022 " const char *iface);\n"
7028 #: ../src/guestfs-actions.pod:270
7030 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7031 "QEMU interface emulation to use at run time."
7036 #: ../src/guestfs-actions.pod:284
7037 msgid "guestfs_aug_clear"
7042 #: ../src/guestfs-actions.pod:286
7046 " guestfs_aug_clear (guestfs_h *g,\n"
7047 " const char *augpath);\n"
7053 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7055 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7056 "L<augtool(1)> C<clear> command."
7061 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2111
7062 msgid "(Added in 1.3.4)"
7067 #: ../src/guestfs-actions.pod:297
7068 msgid "guestfs_aug_close"
7073 #: ../src/guestfs-actions.pod:299
7077 " guestfs_aug_close (guestfs_h *g);\n"
7083 #: ../src/guestfs-actions.pod:302
7085 "Close the current Augeas handle and free up any resources used by it. After "
7086 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7087 "any other Augeas functions."
7092 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7093 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7094 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7095 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7096 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7097 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7098 #: ../src/guestfs-actions.pod:5643
7099 msgid "(Added in 0.7)"
7104 #: ../src/guestfs-actions.pod:311
7105 msgid "guestfs_aug_defnode"
7110 #: ../src/guestfs-actions.pod:313
7113 " struct guestfs_int_bool *\n"
7114 " guestfs_aug_defnode (guestfs_h *g,\n"
7115 " const char *name,\n"
7116 " const char *expr,\n"
7117 " const char *val);\n"
7123 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7125 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7130 #: ../src/guestfs-actions.pod:322
7132 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7133 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7134 "containing that single node."
7139 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7141 "On success this returns a pair containing the number of nodes in the "
7142 "nodeset, and a boolean flag if a node was created."
7147 #: ../src/guestfs-actions.pod:330
7149 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7150 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7155 #: ../src/guestfs-actions.pod:336
7156 msgid "guestfs_aug_defvar"
7161 #: ../src/guestfs-actions.pod:338
7165 " guestfs_aug_defvar (guestfs_h *g,\n"
7166 " const char *name,\n"
7167 " const char *expr);\n"
7173 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7175 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7176 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7181 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7183 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7184 "evaluates to something which is not a nodeset."
7189 #: ../src/guestfs-actions.pod:354
7190 msgid "guestfs_aug_get"
7195 #: ../src/guestfs-actions.pod:356
7199 " guestfs_aug_get (guestfs_h *g,\n"
7200 " const char *augpath);\n"
7206 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7208 "Look up the value associated with C<path>. If C<path> matches exactly one "
7209 "node, the C<value> is returned."
7214 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
7215 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
7216 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
7217 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
7218 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
7219 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
7220 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
7221 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1943
7222 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2134
7223 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2530
7224 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2724
7225 #: ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2957
7226 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3006
7227 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3099
7228 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3139
7229 #: ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:4096
7230 #: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4376
7231 #: ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5371
7232 #: ../src/guestfs-actions.pod:5541 ../src/guestfs-actions.pod:5719
7233 #: ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:6405
7234 #: ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:6438
7235 #: ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:7143
7236 #: ../src/guestfs-actions.pod:7162 ../src/guestfs-actions.pod:7180
7237 #: ../src/guestfs-actions.pod:7360 ../src/guestfs-actions.pod:7640
7239 "This function returns a string, or NULL on error. I<The caller must free "
7240 "the returned string after use>."
7245 #: ../src/guestfs-actions.pod:368
7246 msgid "guestfs_aug_init"
7251 #: ../src/guestfs-actions.pod:370
7255 " guestfs_aug_init (guestfs_h *g,\n"
7256 " const char *root,\n"
7263 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7265 "Create a new Augeas handle for editing configuration files. If there was "
7266 "any previous Augeas handle associated with this guestfs session, then it is "
7272 #: ../src/guestfs-actions.pod:379
7273 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7278 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7280 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7285 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7287 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7288 "logical I<or> of the following integers:"
7293 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7294 msgid "C<AUG_SAVE_BACKUP> = 1"
7299 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7300 msgid "Keep the original file with a C<.augsave> extension."
7305 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7306 msgid "C<AUG_SAVE_NEWFILE> = 2"
7311 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7313 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7314 "original. Overrides C<AUG_SAVE_BACKUP>."
7319 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7320 msgid "C<AUG_TYPE_CHECK> = 4"
7325 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7326 msgid "Typecheck lenses (can be expensive)."
7331 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7332 msgid "C<AUG_NO_STDINC> = 8"
7337 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7338 msgid "Do not use standard load path for modules."
7343 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7344 msgid "C<AUG_SAVE_NOOP> = 16"
7349 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7350 msgid "Make save a no-op, just record what would have been changed."
7355 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7356 msgid "C<AUG_NO_LOAD> = 32"
7361 #: ../src/guestfs-actions.pod:414
7362 msgid "Do not load the tree in C<guestfs_aug_init>."
7367 #: ../src/guestfs-actions.pod:418
7368 msgid "To close the handle, you can call C<guestfs_aug_close>."
7373 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7374 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7379 #: ../src/guestfs-actions.pod:426
7380 msgid "guestfs_aug_insert"
7385 #: ../src/guestfs-actions.pod:428
7389 " guestfs_aug_insert (guestfs_h *g,\n"
7390 " const char *augpath,\n"
7391 " const char *label,\n"
7398 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7400 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7401 "or after C<path> (depending on the boolean flag C<before>)."
7406 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7408 "C<path> must match exactly one existing node in the tree, and C<label> must "
7409 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7414 #: ../src/guestfs-actions.pod:446
7415 msgid "guestfs_aug_load"
7420 #: ../src/guestfs-actions.pod:448
7424 " guestfs_aug_load (guestfs_h *g);\n"
7430 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7431 msgid "Load files into the tree."
7436 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7437 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7442 #: ../src/guestfs-actions.pod:460
7443 msgid "guestfs_aug_ls"
7448 #: ../src/guestfs-actions.pod:462
7452 " guestfs_aug_ls (guestfs_h *g,\n"
7453 " const char *augpath);\n"
7459 #: ../src/guestfs-actions.pod:466
7461 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7462 "sorting the resulting nodes into alphabetical order."
7467 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7468 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
7469 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
7470 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
7471 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2206
7472 #: ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2241
7473 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308
7474 #: ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:2428
7475 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:3059
7476 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3649
7477 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3728
7478 #: ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:4238
7479 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5513
7480 #: ../src/guestfs-actions.pod:5639 ../src/guestfs-actions.pod:5753
7481 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6546
7482 #: ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6747
7483 #: ../src/guestfs-actions.pod:6771 ../src/guestfs-actions.pod:7253
7484 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7320
7485 #: ../src/guestfs-actions.pod:7492 ../src/guestfs-actions.pod:7511
7486 #: ../src/guestfs-actions.pod:7597 ../src/guestfs-actions.pod:7616
7487 #: ../src/guestfs-actions.pod:7662 ../src/guestfs-actions.pod:7681
7489 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7490 ">), or NULL if there was an error. I<The caller must free the strings and "
7491 "the array after use>."
7496 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
7497 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
7498 #: ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3444
7499 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4129
7500 #: ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4349
7501 #: ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4997
7502 #: ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5851
7503 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5877
7504 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6985
7505 #: ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7237
7506 #: ../src/guestfs-actions.pod:7480
7507 msgid "(Added in 0.8)"
7512 #: ../src/guestfs-actions.pod:475
7513 msgid "guestfs_aug_match"
7518 #: ../src/guestfs-actions.pod:477
7522 " guestfs_aug_match (guestfs_h *g,\n"
7523 " const char *augpath);\n"
7529 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7531 "Returns a list of paths which match the path expression C<path>. The "
7532 "returned paths are sufficiently qualified so that they match exactly one "
7533 "node in the current tree."
7538 #: ../src/guestfs-actions.pod:491
7539 msgid "guestfs_aug_mv"
7544 #: ../src/guestfs-actions.pod:493
7548 " guestfs_aug_mv (guestfs_h *g,\n"
7549 " const char *src,\n"
7550 " const char *dest);\n"
7556 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7558 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7559 "C<dest> is overwritten if it exists."
7564 #: ../src/guestfs-actions.pod:505
7565 msgid "guestfs_aug_rm"
7570 #: ../src/guestfs-actions.pod:507
7574 " guestfs_aug_rm (guestfs_h *g,\n"
7575 " const char *augpath);\n"
7581 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7582 msgid "Remove C<path> and all of its children."
7587 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7588 msgid "On success this returns the number of entries which were removed."
7593 #: ../src/guestfs-actions.pod:519
7594 msgid "guestfs_aug_save"
7599 #: ../src/guestfs-actions.pod:521
7603 " guestfs_aug_save (guestfs_h *g);\n"
7609 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7610 msgid "This writes all pending changes to disk."
7615 #: ../src/guestfs-actions.pod:526
7617 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7623 #: ../src/guestfs-actions.pod:533
7624 msgid "guestfs_aug_set"
7629 #: ../src/guestfs-actions.pod:535
7633 " guestfs_aug_set (guestfs_h *g,\n"
7634 " const char *augpath,\n"
7635 " const char *val);\n"
7641 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7642 msgid "Set the value associated with C<path> to C<val>."
7647 #: ../src/guestfs-actions.pod:542
7649 "In the Augeas API, it is possible to clear a node by setting the value to "
7650 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7651 "this call. Instead you must use the C<guestfs_aug_clear> call."
7656 #: ../src/guestfs-actions.pod:551
7657 msgid "guestfs_available"
7662 #: ../src/guestfs-actions.pod:553
7666 " guestfs_available (guestfs_h *g,\n"
7667 " char *const *groups);\n"
7673 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7675 "This command is used to check the availability of some groups of "
7676 "functionality in the appliance, which not all builds of the libguestfs "
7677 "appliance will be able to provide."
7682 #: ../src/guestfs-actions.pod:561
7684 "The libguestfs groups, and the functions that those groups correspond to, "
7685 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7686 "runtime by calling C<guestfs_available_all_groups>."
7691 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7693 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7694 "\"]> would check for the availability of the Linux inotify functions and "
7695 "Augeas (configuration file editing) functions."
7700 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7701 msgid "The command returns no error if I<all> requested groups are available."
7706 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7708 "It fails with an error if one or more of the requested groups is unavailable "
7714 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7716 "If an unknown group name is included in the list of groups then an error is "
7722 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7728 #: ../src/guestfs-actions.pod:585
7729 msgid "You must call C<guestfs_launch> before calling this function."
7734 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7736 "The reason is because we don't know what groups are supported by the "
7737 "appliance/daemon until it is running and can be queried."
7742 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7744 "If a group of functions is available, this does not necessarily mean that "
7745 "they will work. You still have to check for errors when calling individual "
7746 "API functions even if they are available."
7751 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7753 "It is usually the job of distro packagers to build complete functionality "
7754 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7755 "with all requirements satisfied, will support everything."
7760 #: ../src/guestfs-actions.pod:607
7762 "This call was added in version C<1.0.80>. In previous versions of "
7763 "libguestfs all you could do would be to speculatively execute a command to "
7764 "find out if the daemon implemented it. See also C<guestfs_version>."
7769 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7770 msgid "(Added in 1.0.80)"
7775 #: ../src/guestfs-actions.pod:618
7776 msgid "guestfs_available_all_groups"
7781 #: ../src/guestfs-actions.pod:620
7785 " guestfs_available_all_groups (guestfs_h *g);\n"
7791 #: ../src/guestfs-actions.pod:623
7793 "This command returns a list of all optional groups that this daemon knows "
7794 "about. Note this returns both supported and unsupported groups. To find "
7795 "out which ones the daemon can actually support you have to call "
7796 "C<guestfs_available> on each member of the returned list."
7801 #: ../src/guestfs-actions.pod:629
7802 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7807 #: ../src/guestfs-actions.pod:635
7808 msgid "(Added in 1.3.15)"
7813 #: ../src/guestfs-actions.pod:637
7814 msgid "guestfs_base64_in"
7819 #: ../src/guestfs-actions.pod:639
7823 " guestfs_base64_in (guestfs_h *g,\n"
7824 " const char *base64file,\n"
7825 " const char *filename);\n"
7831 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7833 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7838 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7839 msgid "(Added in 1.3.5)"
7844 #: ../src/guestfs-actions.pod:651
7845 msgid "guestfs_base64_out"
7850 #: ../src/guestfs-actions.pod:653
7854 " guestfs_base64_out (guestfs_h *g,\n"
7855 " const char *filename,\n"
7856 " const char *base64file);\n"
7862 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7864 "This command downloads the contents of C<filename>, writing it out to local "
7865 "file C<base64file> encoded as base64."
7870 #: ../src/guestfs-actions.pod:665
7871 msgid "guestfs_blockdev_flushbufs"
7876 #: ../src/guestfs-actions.pod:667
7880 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7881 " const char *device);\n"
7887 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7889 "This tells the kernel to flush internal buffers associated with C<device>."
7894 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7895 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7896 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7897 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7898 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7899 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7900 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7901 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7902 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7903 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7904 msgid "This uses the L<blockdev(8)> command."
7909 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7910 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7911 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7912 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7913 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7914 msgid "(Added in 0.9.3)"
7919 #: ../src/guestfs-actions.pod:680
7920 msgid "guestfs_blockdev_getbsz"
7925 #: ../src/guestfs-actions.pod:682
7929 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7930 " const char *device);\n"
7936 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7937 msgid "This returns the block size of a device."
7942 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7943 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7945 "(Note this is different from both I<size in blocks> and I<filesystem block "
7951 #: ../src/guestfs-actions.pod:697
7952 msgid "guestfs_blockdev_getro"
7957 #: ../src/guestfs-actions.pod:699
7961 " guestfs_blockdev_getro (guestfs_h *g,\n"
7962 " const char *device);\n"
7968 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7970 "Returns a boolean indicating if the block device is read-only (true if read-"
7971 "only, false if not)."
7976 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7977 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1919
7978 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2002
7979 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:2072
7980 #: ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:2120
7981 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172
7982 #: ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3352
7983 #: ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3381
7984 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3411
7985 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3442
7986 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469
7987 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3498
7988 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7989 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:5142
7990 msgid "This function returns a C truth value on success or -1 on error."
7995 #: ../src/guestfs-actions.pod:712
7996 msgid "guestfs_blockdev_getsize64"
8001 #: ../src/guestfs-actions.pod:714
8005 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
8006 " const char *device);\n"
8012 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
8013 msgid "This returns the size of the device in bytes."
8018 #: ../src/guestfs-actions.pod:720
8019 msgid "See also C<guestfs_blockdev_getsz>."
8024 #: ../src/guestfs-actions.pod:728
8025 msgid "guestfs_blockdev_getss"
8030 #: ../src/guestfs-actions.pod:730
8034 " guestfs_blockdev_getss (guestfs_h *g,\n"
8035 " const char *device);\n"
8041 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8043 "This returns the size of sectors on a block device. Usually 512, but can be "
8044 "larger for modern devices."
8049 #: ../src/guestfs-actions.pod:737
8051 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8057 #: ../src/guestfs-actions.pod:746
8058 msgid "guestfs_blockdev_getsz"
8063 #: ../src/guestfs-actions.pod:748
8067 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8068 " const char *device);\n"
8074 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8076 "This returns the size of the device in units of 512-byte sectors (even if "
8077 "the sectorsize isn't 512 bytes ... weird)."
8082 #: ../src/guestfs-actions.pod:755
8084 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8085 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8090 #: ../src/guestfs-actions.pod:765
8091 msgid "guestfs_blockdev_rereadpt"
8096 #: ../src/guestfs-actions.pod:767
8100 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8101 " const char *device);\n"
8107 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8108 msgid "Reread the partition table on C<device>."
8113 #: ../src/guestfs-actions.pod:779
8114 msgid "guestfs_blockdev_setbsz"
8119 #: ../src/guestfs-actions.pod:781
8123 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8124 " const char *device,\n"
8125 " int blocksize);\n"
8131 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8132 msgid "This sets the block size of a device."
8137 #: ../src/guestfs-actions.pod:797
8138 msgid "guestfs_blockdev_setro"
8143 #: ../src/guestfs-actions.pod:799
8147 " guestfs_blockdev_setro (guestfs_h *g,\n"
8148 " const char *device);\n"
8154 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8155 msgid "Sets the block device named C<device> to read-only."
8160 #: ../src/guestfs-actions.pod:811
8161 msgid "guestfs_blockdev_setrw"
8166 #: ../src/guestfs-actions.pod:813
8170 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8171 " const char *device);\n"
8177 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8178 msgid "Sets the block device named C<device> to read-write."
8183 #: ../src/guestfs-actions.pod:825
8184 msgid "guestfs_case_sensitive_path"
8189 #: ../src/guestfs-actions.pod:827
8193 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8194 " const char *path);\n"
8200 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
8202 "This can be used to resolve case insensitive paths on a filesystem which is "
8203 "case sensitive. The use case is to resolve paths which you have read from "
8204 "Windows configuration files or the Windows Registry, to the true path."
8209 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
8211 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8212 "(and probably others), which is that although the underlying filesystem is "
8213 "case-insensitive, the driver exports the filesystem to Linux as case-"
8219 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
8221 "One consequence of this is that special directories such as C<c:\\windows> "
8222 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8223 "precise details of how they were created. In Windows itself this would not "
8229 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
8231 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8237 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
8239 "This function resolves the true case of each element in the path and returns "
8240 "the case-sensitive path."
8245 #: ../src/guestfs-actions.pod:853
8247 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8248 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8249 "how the directories were originally created under Windows)."
8254 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
8255 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8260 #: ../src/guestfs-actions.pod:861
8261 msgid "See also C<guestfs_realpath>."
8266 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7165
8267 msgid "(Added in 1.0.75)"
8272 #: ../src/guestfs-actions.pod:868
8278 #: ../src/guestfs-actions.pod:870
8282 " guestfs_cat (guestfs_h *g,\n"
8283 " const char *path);\n"
8289 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5629
8290 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3717
8291 msgid "Return the contents of the file named C<path>."
8296 #: ../src/guestfs-actions.pod:876
8298 "Note that this function cannot correctly handle binary files (specifically, "
8299 "files containing C<\\0> character which is treated as end of string). For "
8300 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8301 "functions which have a more complex interface."
8306 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
8307 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
8308 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
8309 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
8310 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2245
8311 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312
8312 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2358
8313 #: ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5437
8314 #: ../src/guestfs-actions.pod:5568 ../src/guestfs-actions.pod:5594
8315 #: ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6550
8316 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6751
8317 #: ../src/guestfs-actions.pod:6775 ../src/guestfs-actions.pod:7444
8318 #: ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7496
8319 #: ../src/guestfs-actions.pod:7515 ../src/guestfs-actions.pod:7601
8320 #: ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7666
8321 #: ../src/guestfs-actions.pod:7685 ../fish/guestfish-actions.pod:592
8322 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8323 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8324 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8325 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
8326 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
8327 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
8328 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3587
8329 #: ../fish/guestfish-actions.pod:3602 ../fish/guestfish-actions.pod:3678
8330 #: ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:3710
8331 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4410
8332 #: ../fish/guestfish-actions.pod:4495 ../fish/guestfish-actions.pod:4510
8333 #: ../fish/guestfish-actions.pod:4920 ../fish/guestfish-actions.pod:4938
8334 #: ../fish/guestfish-actions.pod:4955 ../fish/guestfish-actions.pod:4965
8335 #: ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024
8336 #: ../fish/guestfish-actions.pod:5053 ../fish/guestfish-actions.pod:5063
8338 "Because of the message protocol, there is a transfer limit of somewhere "
8339 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8344 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3670
8345 #: ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3749
8346 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:4242
8347 #: ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:5517
8348 #: ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:7324
8349 #: ../src/guestfs-actions.pod:7338
8350 msgid "(Added in 0.4)"
8355 #: ../src/guestfs-actions.pod:889
8356 msgid "guestfs_checksum"
8361 #: ../src/guestfs-actions.pod:891
8365 " guestfs_checksum (guestfs_h *g,\n"
8366 " const char *csumtype,\n"
8367 " const char *path);\n"
8373 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
8375 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8380 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
8382 "The type of checksum to compute is given by the C<csumtype> parameter which "
8383 "must have one of the following values:"
8388 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
8394 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
8396 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8402 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
8408 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
8409 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8414 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
8420 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
8421 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8426 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
8432 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
8433 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8438 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
8444 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
8445 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8450 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
8456 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
8457 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8462 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
8468 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
8469 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8474 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
8475 msgid "The checksum is returned as a printable string."
8480 #: ../src/guestfs-actions.pod:937
8481 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8486 #: ../src/guestfs-actions.pod:939
8487 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8492 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
8493 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:3368
8494 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3458
8495 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:7021
8496 msgid "(Added in 1.0.2)"
8501 #: ../src/guestfs-actions.pod:946
8502 msgid "guestfs_checksum_device"
8507 #: ../src/guestfs-actions.pod:948
8511 " guestfs_checksum_device (guestfs_h *g,\n"
8512 " const char *csumtype,\n"
8513 " const char *device);\n"
8519 #: ../src/guestfs-actions.pod:953
8521 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8522 "device named C<device>. For the types of checksums supported see the "
8523 "C<guestfs_checksum> command."
8528 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5048
8529 #: ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5144
8530 #: ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5338
8531 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6944
8532 #: ../src/guestfs-actions.pod:7350
8533 msgid "(Added in 1.3.2)"
8538 #: ../src/guestfs-actions.pod:962
8539 msgid "guestfs_checksums_out"
8544 #: ../src/guestfs-actions.pod:964
8548 " guestfs_checksums_out (guestfs_h *g,\n"
8549 " const char *csumtype,\n"
8550 " const char *directory,\n"
8551 " const char *sumsfile);\n"
8557 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
8559 "This command computes the checksums of all regular files in C<directory> and "
8560 "then emits a list of those checksums to the local output file C<sumsfile>."
8565 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
8567 "This can be used for verifying the integrity of a virtual machine. However "
8568 "to be properly secure you should pay attention to the output of the checksum "
8569 "command (it uses the ones from GNU coreutils). In particular when the "
8570 "filename is not printable, coreutils uses a special backslash syntax. For "
8571 "more information, see the GNU coreutils info file."
8576 #: ../src/guestfs-actions.pod:984
8577 msgid "(Added in 1.3.7)"
8582 #: ../src/guestfs-actions.pod:986
8583 msgid "guestfs_chmod"
8588 #: ../src/guestfs-actions.pod:988
8592 " guestfs_chmod (guestfs_h *g,\n"
8594 " const char *path);\n"
8600 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
8602 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8608 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
8610 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8611 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8617 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4493
8618 #: ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4709
8619 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:681
8620 #: ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3142
8621 #: ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3162
8622 msgid "The mode actually set is affected by the umask."
8627 #: ../src/guestfs-actions.pod:1006
8628 msgid "guestfs_chown"
8633 #: ../src/guestfs-actions.pod:1008
8637 " guestfs_chown (guestfs_h *g,\n"
8640 " const char *path);\n"
8646 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
8647 msgid "Change the file owner to C<owner> and group to C<group>."
8652 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3587
8653 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
8655 "Only numeric uid and gid are supported. If you want to use names, you will "
8656 "need to locate and parse the password file yourself (Augeas support makes "
8657 "this relatively easy)."
8662 #: ../src/guestfs-actions.pod:1024
8663 msgid "guestfs_command"
8668 #: ../src/guestfs-actions.pod:1026
8672 " guestfs_command (guestfs_h *g,\n"
8673 " char *const *arguments);\n"
8679 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
8681 "This call runs a command from the guest filesystem. The filesystem must be "
8682 "mounted, and must contain a compatible operating system (ie. something "
8683 "Linux, with the same or compatible processor architecture)."
8688 #: ../src/guestfs-actions.pod:1035
8690 "The single parameter is an argv-style list of arguments. The first element "
8691 "is the name of the program to run. Subsequent elements are parameters. The "
8692 "list must be non-empty (ie. must contain a program name). Note that the "
8693 "command runs directly, and is I<not> invoked via the shell (see "
8699 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
8700 msgid "The return value is anything printed to I<stdout> by the command."
8705 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
8707 "If the command returns a non-zero exit status, then this function returns an "
8708 "error message. The error message string is the content of I<stderr> from "
8714 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
8716 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8717 "bin>. If you require a program from another location, you should provide "
8718 "the full path in the first parameter."
8723 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8725 "Shared libraries and data files required by the program must be available on "
8726 "filesystems which are mounted in the correct places. It is the caller's "
8727 "responsibility to ensure all filesystems that are needed are mounted at the "
8733 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8734 #: ../src/guestfs-actions.pod:1551
8735 msgid "(Added in 0.9.1)"
8740 #: ../src/guestfs-actions.pod:1068
8741 msgid "guestfs_command_lines"
8746 #: ../src/guestfs-actions.pod:1070
8750 " guestfs_command_lines (guestfs_h *g,\n"
8751 " char *const *arguments);\n"
8757 #: ../src/guestfs-actions.pod:1074
8759 "This is the same as C<guestfs_command>, but splits the result into a list of "
8765 #: ../src/guestfs-actions.pod:1077
8766 msgid "See also: C<guestfs_sh_lines>"
8771 #: ../src/guestfs-actions.pod:1088
8772 msgid "guestfs_config"
8777 #: ../src/guestfs-actions.pod:1090
8781 " guestfs_config (guestfs_h *g,\n"
8782 " const char *qemuparam,\n"
8783 " const char *qemuvalue);\n"
8788 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8790 "This can be used to add arbitrary qemu command line parameters of the form "
8791 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8792 "setting some parameters which would interfere with parameters that we use."
8797 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8798 msgid "The first character of C<param> string must be a C<-> (dash)."
8803 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8804 msgid "C<value> can be NULL."
8809 #: ../src/guestfs-actions.pod:1108
8810 msgid "guestfs_copy_size"
8815 #: ../src/guestfs-actions.pod:1110
8819 " guestfs_copy_size (guestfs_h *g,\n"
8820 " const char *src,\n"
8821 " const char *dest,\n"
8828 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8830 "This command copies exactly C<size> bytes from one source device or file "
8831 "C<src> to another destination device or file C<dest>."
8836 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8838 "Note this will fail if the source is too short or if the destination is not "
8843 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8844 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8845 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8846 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:7016
8847 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7537
8848 #: ../src/guestfs-actions.pod:7556
8850 "This long-running command can generate progress notification messages so "
8851 "that the caller can display a progress bar or indicator. To receive these "
8852 "messages, the caller must register a progress event callback. See L<guestfs"
8853 "(3)/GUESTFS_EVENT_PROGRESS>."
8858 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4269
8859 #: ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:7257
8860 #: ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7363
8861 msgid "(Added in 1.0.87)"
8866 #: ../src/guestfs-actions.pod:1131
8872 #: ../src/guestfs-actions.pod:1133
8876 " guestfs_cp (guestfs_h *g,\n"
8877 " const char *src,\n"
8878 " const char *dest);\n"
8884 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8886 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8887 "destination filename or destination directory."
8892 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8893 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8894 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:5011
8895 #: ../src/guestfs-actions.pod:5388
8896 msgid "(Added in 1.0.18)"
8901 #: ../src/guestfs-actions.pod:1145
8902 msgid "guestfs_cp_a"
8907 #: ../src/guestfs-actions.pod:1147
8911 " guestfs_cp_a (guestfs_h *g,\n"
8912 " const char *src,\n"
8913 " const char *dest);\n"
8919 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8921 "This copies a file or directory from C<src> to C<dest> recursively using the "
8927 #: ../src/guestfs-actions.pod:1159
8933 #: ../src/guestfs-actions.pod:1161
8937 " guestfs_dd (guestfs_h *g,\n"
8938 " const char *src,\n"
8939 " const char *dest);\n"
8945 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8947 "This command copies from one source device or file C<src> to another "
8948 "destination device or file C<dest>. Normally you would use this to copy to "
8949 "or from a device or partition, for example to duplicate a filesystem."
8954 #: ../src/guestfs-actions.pod:1171
8956 "If the destination is a device, it must be as large or larger than the "
8957 "source file or device, otherwise the copy will fail. This command cannot do "
8958 "partial copies (see C<guestfs_copy_size>)."
8963 #: ../src/guestfs-actions.pod:1179
8969 #: ../src/guestfs-actions.pod:1181
8973 " guestfs_df (guestfs_h *g);\n"
8979 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8980 msgid "This command runs the C<df> command to report disk space used."
8985 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8987 "This command is mostly useful for interactive sessions. It is I<not> "
8988 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8994 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8995 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2291
8996 #: ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2383
8997 #: ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4911
8998 #: ../src/guestfs-actions.pod:6754 ../src/guestfs-actions.pod:6778
8999 #: ../src/guestfs-actions.pod:7403 ../src/guestfs-actions.pod:7416
9000 #: ../src/guestfs-actions.pod:7429
9001 msgid "(Added in 1.0.54)"
9006 #: ../src/guestfs-actions.pod:1195
9007 msgid "guestfs_df_h"
9012 #: ../src/guestfs-actions.pod:1197
9016 " guestfs_df_h (guestfs_h *g);\n"
9022 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
9024 "This command runs the C<df -h> command to report disk space used in human-"
9030 #: ../src/guestfs-actions.pod:1212
9031 msgid "guestfs_dmesg"
9036 #: ../src/guestfs-actions.pod:1214
9040 " guestfs_dmesg (guestfs_h *g);\n"
9046 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
9048 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9049 "This is sometimes useful for extended debugging of problems."
9054 #: ../src/guestfs-actions.pod:1221
9056 "Another way to get the same information is to enable verbose messages with "
9057 "C<guestfs_set_verbose> or by setting the environment variable "
9058 "C<LIBGUESTFS_DEBUG=1> before running the program."
9063 #: ../src/guestfs-actions.pod:1231
9064 msgid "guestfs_download"
9069 #: ../src/guestfs-actions.pod:1233
9073 " guestfs_download (guestfs_h *g,\n"
9074 " const char *remotefilename,\n"
9075 " const char *filename);\n"
9081 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
9082 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9084 "Download file C<remotefilename> and save it as C<filename> on the local "
9090 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:7010
9091 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4668
9092 msgid "C<filename> can also be a named pipe."
9097 #: ../src/guestfs-actions.pod:1243
9098 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9103 #: ../src/guestfs-actions.pod:1254
9104 msgid "guestfs_download_offset"
9109 #: ../src/guestfs-actions.pod:1256
9113 " guestfs_download_offset (guestfs_h *g,\n"
9114 " const char *remotefilename,\n"
9115 " const char *filename,\n"
9116 " int64_t offset,\n"
9123 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
9125 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9126 "region must be within the file or device)."
9131 #: ../src/guestfs-actions.pod:1269
9133 "Note that there is no limit on the amount of data that can be downloaded "
9134 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9135 "full amount unless an error occurs."
9140 #: ../src/guestfs-actions.pod:1274
9141 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9146 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7055
9147 msgid "(Added in 1.5.17)"
9152 #: ../src/guestfs-actions.pod:1285
9153 msgid "guestfs_drop_caches"
9158 #: ../src/guestfs-actions.pod:1287
9162 " guestfs_drop_caches (guestfs_h *g,\n"
9163 " int whattodrop);\n"
9169 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
9171 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9172 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9173 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9178 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
9179 msgid "Setting C<whattodrop> to 3 should drop everything."
9184 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
9186 "This automatically calls L<sync(2)> before the operation, so that the "
9187 "maximum guest memory is freed."
9192 #: ../src/guestfs-actions.pod:1305
9198 #: ../src/guestfs-actions.pod:1307
9202 " guestfs_du (guestfs_h *g,\n"
9203 " const char *path);\n"
9209 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
9211 "This command runs the C<du -s> command to estimate file space usage for "
9217 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
9219 "C<path> can be a file or a directory. If C<path> is a directory then the "
9220 "estimate includes the contents of the directory and all subdirectories "
9226 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
9228 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9233 #: ../src/guestfs-actions.pod:1330
9234 msgid "guestfs_e2fsck_f"
9239 #: ../src/guestfs-actions.pod:1332
9243 " guestfs_e2fsck_f (guestfs_h *g,\n"
9244 " const char *device);\n"
9249 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
9251 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9252 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9258 #: ../src/guestfs-actions.pod:1340
9260 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9261 "Normally you should use C<guestfs_fsck>."
9266 #: ../src/guestfs-actions.pod:1345
9267 msgid "(Added in 1.0.29)"
9272 #: ../src/guestfs-actions.pod:1347
9273 msgid "guestfs_echo_daemon"
9278 #: ../src/guestfs-actions.pod:1349
9282 " guestfs_echo_daemon (guestfs_h *g,\n"
9283 " char *const *words);\n"
9289 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
9291 "This command concatenates the list of C<words> passed with single spaces "
9292 "between them and returns the resulting string."
9297 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
9298 msgid "You can use this command to test the connection through to the daemon."
9303 #: ../src/guestfs-actions.pod:1358
9304 msgid "See also C<guestfs_ping_daemon>."
9309 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2099
9310 #: ../src/guestfs-actions.pod:6226
9311 msgid "(Added in 1.0.69)"
9316 #: ../src/guestfs-actions.pod:1365
9317 msgid "guestfs_egrep"
9322 #: ../src/guestfs-actions.pod:1367
9326 " guestfs_egrep (guestfs_h *g,\n"
9327 " const char *regex,\n"
9328 " const char *path);\n"
9334 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
9336 "This calls the external C<egrep> program and returns the matching lines."
9341 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
9342 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
9343 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2229
9344 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2404
9345 #: ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2432
9346 #: ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2500
9347 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:3762
9348 #: ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3789
9349 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:4789
9350 #: ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:5771
9351 #: ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:6634
9352 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6660
9353 #: ../src/guestfs-actions.pod:6682 ../src/guestfs-actions.pod:6695
9354 #: ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6721
9355 #: ../src/guestfs-actions.pod:7499 ../src/guestfs-actions.pod:7518
9356 #: ../src/guestfs-actions.pod:7604 ../src/guestfs-actions.pod:7623
9357 #: ../src/guestfs-actions.pod:7669 ../src/guestfs-actions.pod:7688
9358 msgid "(Added in 1.0.66)"
9363 #: ../src/guestfs-actions.pod:1384
9364 msgid "guestfs_egrepi"
9369 #: ../src/guestfs-actions.pod:1386
9373 " guestfs_egrepi (guestfs_h *g,\n"
9374 " const char *regex,\n"
9375 " const char *path);\n"
9381 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
9383 "This calls the external C<egrep -i> program and returns the matching lines."
9388 #: ../src/guestfs-actions.pod:1403
9389 msgid "guestfs_equal"
9394 #: ../src/guestfs-actions.pod:1405
9398 " guestfs_equal (guestfs_h *g,\n"
9399 " const char *file1,\n"
9400 " const char *file2);\n"
9406 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
9408 "This compares the two files C<file1> and C<file2> and returns true if their "
9409 "content is exactly equal, or false otherwise."
9414 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
9415 msgid "The external L<cmp(1)> program is used for the comparison."
9420 #: ../src/guestfs-actions.pod:1419
9421 msgid "guestfs_exists"
9426 #: ../src/guestfs-actions.pod:1421
9430 " guestfs_exists (guestfs_h *g,\n"
9431 " const char *path);\n"
9437 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
9439 "This returns C<true> if and only if there is a file, directory (or anything) "
9440 "with the given C<path> name."
9445 #: ../src/guestfs-actions.pod:1428
9446 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9451 #: ../src/guestfs-actions.pod:1434
9452 msgid "guestfs_fallocate"
9457 #: ../src/guestfs-actions.pod:1436
9461 " guestfs_fallocate (guestfs_h *g,\n"
9462 " const char *path,\n"
9469 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
9470 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9472 "This command preallocates a file (containing zero bytes) named C<path> of "
9473 "size C<len> bytes. If the file exists already, it is overwritten."
9478 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
9480 "Do not confuse this with the guestfish-specific C<alloc> command which "
9481 "allocates a file in the host and attaches it as a device."
9486 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
9488 "This function is deprecated. In new code, use the C<fallocate64> call "
9494 #: ../src/guestfs-actions.pod:1460
9495 msgid "guestfs_fallocate64"
9500 #: ../src/guestfs-actions.pod:1462
9504 " guestfs_fallocate64 (guestfs_h *g,\n"
9505 " const char *path,\n"
9512 #: ../src/guestfs-actions.pod:1471
9514 "Note that this call allocates disk blocks for the file. To create a sparse "
9515 "file use C<guestfs_truncate_size> instead."
9520 #: ../src/guestfs-actions.pod:1474
9522 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9523 "oversight it only allowed 30 bit lengths to be specified, effectively "
9524 "limiting the maximum size of files created through that call to 1GB."
9529 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
9531 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9532 "commands which create a file in the host and attach it as a device."
9537 #: ../src/guestfs-actions.pod:1485
9538 msgid "(Added in 1.3.17)"
9543 #: ../src/guestfs-actions.pod:1487
9544 msgid "guestfs_fgrep"
9549 #: ../src/guestfs-actions.pod:1489
9553 " guestfs_fgrep (guestfs_h *g,\n"
9554 " const char *pattern,\n"
9555 " const char *path);\n"
9561 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
9563 "This calls the external C<fgrep> program and returns the matching lines."
9568 #: ../src/guestfs-actions.pod:1506
9569 msgid "guestfs_fgrepi"
9574 #: ../src/guestfs-actions.pod:1508
9578 " guestfs_fgrepi (guestfs_h *g,\n"
9579 " const char *pattern,\n"
9580 " const char *path);\n"
9586 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
9588 "This calls the external C<fgrep -i> program and returns the matching lines."
9593 #: ../src/guestfs-actions.pod:1525
9594 msgid "guestfs_file"
9599 #: ../src/guestfs-actions.pod:1527
9603 " guestfs_file (guestfs_h *g,\n"
9604 " const char *path);\n"
9610 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
9612 "This call uses the standard L<file(1)> command to determine the type or "
9613 "contents of the file."
9618 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
9620 "This call will also transparently look inside various types of compressed "
9625 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
9627 "The exact command which runs is C<file -zb path>. Note in particular that "
9628 "the filename is not prepended to the output (the I<-b> option)."
9632 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
9634 "The output depends on the output of the underlying L<file(1)> command and it "
9635 "can change in future in ways beyond our control. In other words, the output "
9636 "is not guaranteed by the ABI."
9640 #: ../src/guestfs-actions.pod:1545
9642 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9643 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
9648 #: ../src/guestfs-actions.pod:1553
9649 msgid "guestfs_file_architecture"
9654 #: ../src/guestfs-actions.pod:1555
9658 " guestfs_file_architecture (guestfs_h *g,\n"
9659 " const char *filename);\n"
9665 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
9667 "This detects the architecture of the binary C<filename>, and returns it if "
9673 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
9674 msgid "Currently defined architectures are:"
9679 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
9685 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
9687 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9688 "irrespective of the precise processor requirements of the binary."
9693 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
9699 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
9700 msgid "64 bit x86-64."
9705 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
9711 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
9712 msgid "32 bit SPARC."
9717 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
9723 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
9724 msgid "64 bit SPARC V9 and above."
9729 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
9735 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
9736 msgid "Intel Itanium."
9741 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
9747 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
9748 msgid "32 bit Power PC."
9753 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
9759 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
9760 msgid "64 bit Power PC."
9765 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
9766 msgid "Libguestfs may return other architecture strings in future."
9771 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
9772 msgid "The function works on at least the following types of files:"
9777 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
9778 msgid "many types of Un*x and Linux binary"
9783 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
9784 msgid "many types of Un*x and Linux shared library"
9789 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
9790 msgid "Windows Win32 and Win64 binaries"
9795 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
9796 msgid "Windows Win32 and Win64 DLLs"
9801 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
9802 msgid "Win32 binaries and DLLs return C<i386>."
9807 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
9808 msgid "Win64 binaries and DLLs return C<x86_64>."
9813 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
9814 msgid "Linux kernel modules"
9819 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
9820 msgid "Linux new-style initrd images"
9825 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
9826 msgid "some non-x86 Linux vmlinuz kernels"
9831 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
9832 msgid "What it can't do currently:"
9837 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
9838 msgid "static libraries (libfoo.a)"
9843 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
9844 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9849 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
9850 msgid "x86 Linux vmlinuz kernels"
9855 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
9857 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9858 "compressed code, and are horribly hard to unpack. If you want to find the "
9859 "architecture of a kernel, use the architecture of the associated initrd or "
9860 "kernel module(s) instead."
9865 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
9866 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2533
9867 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2689
9868 #: ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2894
9869 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:3009
9870 #: ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3339
9871 #: ../src/guestfs-actions.pod:3471
9872 msgid "(Added in 1.5.3)"
9877 #: ../src/guestfs-actions.pod:1665
9878 msgid "guestfs_filesize"
9883 #: ../src/guestfs-actions.pod:1667
9887 " guestfs_filesize (guestfs_h *g,\n"
9888 " const char *file);\n"
9894 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9895 msgid "This command returns the size of C<file> in bytes."
9900 #: ../src/guestfs-actions.pod:1673
9902 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9903 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9904 "devices, use C<guestfs_blockdev_getsize64>."
9909 #: ../src/guestfs-actions.pod:1679
9910 msgid "(Added in 1.0.82)"
9915 #: ../src/guestfs-actions.pod:1681
9916 msgid "guestfs_fill"
9921 #: ../src/guestfs-actions.pod:1683
9925 " guestfs_fill (guestfs_h *g,\n"
9928 " const char *path);\n"
9934 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9936 "This command creates a new file called C<path>. The initial content of the "
9937 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9943 #: ../src/guestfs-actions.pod:1693
9945 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9946 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9947 "bytes use C<guestfs_fill_pattern>."
9952 #: ../src/guestfs-actions.pod:1705
9953 msgid "(Added in 1.0.79)"
9958 #: ../src/guestfs-actions.pod:1707
9959 msgid "guestfs_fill_pattern"
9964 #: ../src/guestfs-actions.pod:1709
9968 " guestfs_fill_pattern (guestfs_h *g,\n"
9969 " const char *pattern,\n"
9971 " const char *path);\n"
9977 #: ../src/guestfs-actions.pod:1715
9979 "This function is like C<guestfs_fill> except that it creates a new file of "
9980 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9981 "pattern is truncated if necessary to ensure the length of the file is "
9982 "exactly C<len> bytes."
9987 #: ../src/guestfs-actions.pod:1727
9988 msgid "(Added in 1.3.12)"
9993 #: ../src/guestfs-actions.pod:1729
9994 msgid "guestfs_find"
9999 #: ../src/guestfs-actions.pod:1731
10003 " guestfs_find (guestfs_h *g,\n"
10004 " const char *directory);\n"
10010 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
10012 "This command lists out all files and directories, recursively, starting at "
10013 "C<directory>. It is essentially equivalent to running the shell command "
10014 "C<find directory -print> but some post-processing happens on the output, "
10020 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
10022 "This returns a list of strings I<without any prefix>. Thus if the directory "
10028 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
10039 #: ../src/guestfs-actions.pod:1747
10041 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10046 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
10058 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
10059 msgid "If C<directory> is not a directory, then this command returns an error."
10064 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
10065 msgid "The returned list is sorted."
10070 #: ../src/guestfs-actions.pod:1760
10071 msgid "See also C<guestfs_find0>."
10076 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4206
10077 #: ../src/guestfs-actions.pod:5806
10078 msgid "(Added in 1.0.27)"
10083 #: ../src/guestfs-actions.pod:1771
10084 msgid "guestfs_find0"
10089 #: ../src/guestfs-actions.pod:1773
10093 " guestfs_find0 (guestfs_h *g,\n"
10094 " const char *directory,\n"
10095 " const char *files);\n"
10101 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
10103 "This command lists out all files and directories, recursively, starting at "
10104 "C<directory>, placing the resulting list in the external file called "
10110 #: ../src/guestfs-actions.pod:1782
10112 "This command works the same way as C<guestfs_find> with the following "
10118 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
10119 msgid "The resulting list is written to an external file."
10124 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
10126 "Items (filenames) in the result are separated by C<\\0> characters. See "
10127 "L<find(1)> option I<-print0>."
10132 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
10133 msgid "This command is not limited in the number of names that it can return."
10138 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
10139 msgid "The result list is not sorted."
10144 #: ../src/guestfs-actions.pod:1809
10145 msgid "(Added in 1.0.74)"
10150 #: ../src/guestfs-actions.pod:1811
10151 msgid "guestfs_findfs_label"
10156 #: ../src/guestfs-actions.pod:1813
10160 " guestfs_findfs_label (guestfs_h *g,\n"
10161 " const char *label);\n"
10167 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
10169 "This command searches the filesystems and returns the one which has the "
10170 "given label. An error is returned if no such filesystem can be found."
10175 #: ../src/guestfs-actions.pod:1821
10176 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10181 #: ../src/guestfs-actions.pod:1828
10182 msgid "guestfs_findfs_uuid"
10187 #: ../src/guestfs-actions.pod:1830
10191 " guestfs_findfs_uuid (guestfs_h *g,\n"
10192 " const char *uuid);\n"
10198 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
10200 "This command searches the filesystems and returns the one which has the "
10201 "given UUID. An error is returned if no such filesystem can be found."
10206 #: ../src/guestfs-actions.pod:1838
10207 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10212 #: ../src/guestfs-actions.pod:1845
10213 msgid "guestfs_fsck"
10218 #: ../src/guestfs-actions.pod:1847
10222 " guestfs_fsck (guestfs_h *g,\n"
10223 " const char *fstype,\n"
10224 " const char *device);\n"
10230 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
10232 "This runs the filesystem checker (fsck) on C<device> which should have "
10233 "filesystem type C<fstype>."
10238 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
10240 "The returned integer is the status. See L<fsck(8)> for the list of status "
10241 "codes from C<fsck>."
10246 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
10247 msgid "Multiple status codes can be summed together."
10252 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
10254 "A non-zero return code can mean \"success\", for example if errors have been "
10255 "corrected on the filesystem."
10260 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
10261 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10266 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
10268 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10273 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7542
10274 msgid "(Added in 1.0.16)"
10279 #: ../src/guestfs-actions.pod:1884
10280 msgid "guestfs_get_append"
10285 #: ../src/guestfs-actions.pod:1886
10289 " guestfs_get_append (guestfs_h *g);\n"
10295 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
10297 "Return the additional kernel options which are added to the guest kernel "
10303 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
10304 msgid "If C<NULL> then no options are added."
10309 #: ../src/guestfs-actions.pod:1894
10311 "This function returns a string which may be NULL. There is no way to return "
10312 "an error from this function. The string is owned by the guest handle and "
10313 "must I<not> be freed."
10318 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5484
10319 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:6389
10320 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6424
10321 #: ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:7205
10322 #: ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7585
10323 msgid "(Added in 1.0.26)"
10327 #: ../src/guestfs-actions.pod:1900
10328 msgid "guestfs_get_attach_method"
10332 #: ../src/guestfs-actions.pod:1902
10336 " guestfs_get_attach_method (guestfs_h *g);\n"
10341 #: ../src/guestfs-actions.pod:1905
10342 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10346 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:5996
10347 msgid "(Added in 1.9.8)"
10352 #: ../src/guestfs-actions.pod:1912
10353 msgid "guestfs_get_autosync"
10358 #: ../src/guestfs-actions.pod:1914
10362 " guestfs_get_autosync (guestfs_h *g);\n"
10368 #: ../src/guestfs-actions.pod:1917 ../fish/guestfish-actions.pod:1303
10369 msgid "Get the autosync flag."
10374 #: ../src/guestfs-actions.pod:1923
10375 msgid "guestfs_get_direct"
10380 #: ../src/guestfs-actions.pod:1925
10384 " guestfs_get_direct (guestfs_h *g);\n"
10390 #: ../src/guestfs-actions.pod:1928 ../fish/guestfish-actions.pod:1309
10391 msgid "Return the direct appliance mode flag."
10396 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:6037
10397 msgid "(Added in 1.0.72)"
10402 #: ../src/guestfs-actions.pod:1934
10403 msgid "guestfs_get_e2label"
10408 #: ../src/guestfs-actions.pod:1936
10412 " guestfs_get_e2label (guestfs_h *g,\n"
10413 " const char *device);\n"
10419 #: ../src/guestfs-actions.pod:1940 ../fish/guestfish-actions.pod:1315
10421 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10426 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1318
10428 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10433 #: ../src/guestfs-actions.pod:1953 ../src/guestfs-actions.pod:1974
10434 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6074
10435 msgid "(Added in 1.0.15)"
10440 #: ../src/guestfs-actions.pod:1955
10441 msgid "guestfs_get_e2uuid"
10446 #: ../src/guestfs-actions.pod:1957
10450 " guestfs_get_e2uuid (guestfs_h *g,\n"
10451 " const char *device);\n"
10457 #: ../src/guestfs-actions.pod:1961 ../fish/guestfish-actions.pod:1329
10459 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10464 #: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1332
10466 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10471 #: ../src/guestfs-actions.pod:1976
10472 msgid "guestfs_get_memsize"
10477 #: ../src/guestfs-actions.pod:1978
10481 " guestfs_get_memsize (guestfs_h *g);\n"
10487 #: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1343
10489 "This gets the memory size in megabytes allocated to the qemu subprocess."
10494 #: ../src/guestfs-actions.pod:1984
10496 "If C<guestfs_set_memsize> was not called on this handle, and if "
10497 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10498 "value for memsize."
10503 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2069
10504 #: ../src/guestfs-actions.pod:6090 ../src/guestfs-actions.pod:6197
10505 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
10506 #: ../fish/guestfish-actions.pod:4043 ../fish/guestfish-actions.pod:4130
10508 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10513 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:4497
10514 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4713
10515 #: ../src/guestfs-actions.pod:4732 ../src/guestfs-actions.pod:4744
10516 #: ../src/guestfs-actions.pod:4761 ../src/guestfs-actions.pod:4774
10517 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6095
10518 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6971
10519 msgid "(Added in 1.0.55)"
10524 #: ../src/guestfs-actions.pod:1995
10525 msgid "guestfs_get_network"
10530 #: ../src/guestfs-actions.pod:1997
10534 " guestfs_get_network (guestfs_h *g);\n"
10540 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1357
10541 msgid "This returns the enable network flag."
10546 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:6114
10547 msgid "(Added in 1.5.4)"
10552 #: ../src/guestfs-actions.pod:2006
10553 msgid "guestfs_get_path"
10558 #: ../src/guestfs-actions.pod:2008
10562 " guestfs_get_path (guestfs_h *g);\n"
10568 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1363
10569 msgid "Return the current search path."
10574 #: ../src/guestfs-actions.pod:2013 ../fish/guestfish-actions.pod:1365
10576 "This is always non-NULL. If it wasn't set already, then this will return "
10577 "the default path."
10582 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2045
10584 "This function returns a string, or NULL on error. The string is owned by "
10585 "the guest handle and must I<not> be freed."
10590 #: ../src/guestfs-actions.pod:2021
10591 msgid "guestfs_get_pid"
10596 #: ../src/guestfs-actions.pod:2023
10600 " guestfs_get_pid (guestfs_h *g);\n"
10606 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1374
10608 "Return the process ID of the qemu subprocess. If there is no qemu "
10609 "subprocess, then this will return an error."
10614 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1377
10615 msgid "This is an internal call used for debugging and testing."
10620 #: ../src/guestfs-actions.pod:2033
10621 msgid "(Added in 1.0.56)"
10626 #: ../src/guestfs-actions.pod:2035
10627 msgid "guestfs_get_qemu"
10632 #: ../src/guestfs-actions.pod:2037
10636 " guestfs_get_qemu (guestfs_h *g);\n"
10642 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1383
10643 msgid "Return the current qemu binary."
10648 #: ../src/guestfs-actions.pod:2042 ../fish/guestfish-actions.pod:1385
10650 "This is always non-NULL. If it wasn't set already, then this will return "
10651 "the default qemu binary name."
10656 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:6159
10657 msgid "(Added in 1.0.6)"
10662 #: ../src/guestfs-actions.pod:2050
10663 msgid "guestfs_get_recovery_proc"
10668 #: ../src/guestfs-actions.pod:2052
10672 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10678 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1392
10679 msgid "Return the recovery process enabled flag."
10684 #: ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:3593
10685 #: ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:4304
10686 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5414
10687 #: ../src/guestfs-actions.pod:5757 ../src/guestfs-actions.pod:6183
10688 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6894
10689 #: ../src/guestfs-actions.pod:7086
10690 msgid "(Added in 1.0.77)"
10695 #: ../src/guestfs-actions.pod:2061
10696 msgid "guestfs_get_selinux"
10701 #: ../src/guestfs-actions.pod:2063
10705 " guestfs_get_selinux (guestfs_h *g);\n"
10711 #: ../src/guestfs-actions.pod:2066
10713 "This returns the current setting of the selinux flag which is passed to the "
10714 "appliance at boot time. See C<guestfs_set_selinux>."
10719 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:2137
10720 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6260
10721 msgid "(Added in 1.0.67)"
10726 #: ../src/guestfs-actions.pod:2076
10727 msgid "guestfs_get_state"
10732 #: ../src/guestfs-actions.pod:2078
10736 " guestfs_get_state (guestfs_h *g);\n"
10742 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1408
10744 "This returns the current state as an opaque integer. This is only useful "
10745 "for printing debug and internal error messages."
10750 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:3364
10751 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3454
10752 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:1411
10753 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
10754 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
10755 msgid "For more information on states, see L<guestfs(3)>."
10760 #: ../src/guestfs-actions.pod:2090
10761 msgid "guestfs_get_trace"
10766 #: ../src/guestfs-actions.pod:2092
10770 " guestfs_get_trace (guestfs_h *g);\n"
10776 #: ../src/guestfs-actions.pod:2095 ../fish/guestfish-actions.pod:1417
10777 msgid "Return the command trace flag."
10782 #: ../src/guestfs-actions.pod:2101
10783 msgid "guestfs_get_umask"
10788 #: ../src/guestfs-actions.pod:2103
10792 " guestfs_get_umask (guestfs_h *g);\n"
10798 #: ../src/guestfs-actions.pod:2106
10800 "Return the current umask. By default the umask is C<022> unless it has been "
10801 "set by calling C<guestfs_umask>."
10806 #: ../src/guestfs-actions.pod:2113
10807 msgid "guestfs_get_verbose"
10812 #: ../src/guestfs-actions.pod:2115
10816 " guestfs_get_verbose (guestfs_h *g);\n"
10822 #: ../src/guestfs-actions.pod:2118 ../fish/guestfish-actions.pod:1430
10823 msgid "This returns the verbose messages flag."
10828 #: ../src/guestfs-actions.pod:2124
10829 msgid "guestfs_getcon"
10834 #: ../src/guestfs-actions.pod:2126
10838 " guestfs_getcon (guestfs_h *g);\n"
10844 #: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1436
10845 msgid "This gets the SELinux security context of the daemon."
10850 #: ../src/guestfs-actions.pod:2131
10852 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10857 #: ../src/guestfs-actions.pod:2139
10858 msgid "guestfs_getxattr"
10863 #: ../src/guestfs-actions.pod:2141
10867 " guestfs_getxattr (guestfs_h *g,\n"
10868 " const char *path,\n"
10869 " const char *name,\n"
10870 " size_t *size_r);\n"
10876 #: ../src/guestfs-actions.pod:2147
10878 "Get a single extended attribute from file C<path> named C<name>. This call "
10879 "follows symlinks. If you want to lookup an extended attribute for the "
10880 "symlink itself, use C<guestfs_lgetxattr>."
10885 #: ../src/guestfs-actions.pod:2151 ../src/guestfs-actions.pod:3607
10887 "Normally it is better to get all extended attributes from a file in one go "
10888 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10889 "implementations are buggy and do not provide a way to list out attributes. "
10890 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10891 "extended attributes you want in advance and call this function."
10896 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3614
10897 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
10899 "Extended attribute values are blobs of binary data. If there is no extended "
10900 "attribute named C<name>, this returns an error."
10905 #: ../src/guestfs-actions.pod:2161
10906 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10911 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2354
10912 #: ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3619
10913 #: ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5433
10914 #: ../src/guestfs-actions.pod:5614
10916 "This function returns a buffer, or NULL on error. The size of the returned "
10917 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10922 #: ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:3623
10923 msgid "(Added in 1.7.24)"
10928 #: ../src/guestfs-actions.pod:2169
10929 msgid "guestfs_getxattrs"
10934 #: ../src/guestfs-actions.pod:2171
10937 " struct guestfs_xattr_list *\n"
10938 " guestfs_getxattrs (guestfs_h *g,\n"
10939 " const char *path);\n"
10945 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1465
10947 "This call lists the extended attributes of the file or directory C<path>."
10952 #: ../src/guestfs-actions.pod:2178 ../fish/guestfish-actions.pod:1468
10954 "At the system call level, this is a combination of the L<listxattr(2)> and "
10955 "L<getxattr(2)> calls."
10960 #: ../src/guestfs-actions.pod:2181
10961 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10966 #: ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:3635
10967 #: ../src/guestfs-actions.pod:4300
10969 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10970 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10975 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:3639
10976 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3854
10977 #: ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:6279
10978 #: ../src/guestfs-actions.pod:7650
10979 msgid "(Added in 1.0.59)"
10984 #: ../src/guestfs-actions.pod:2189
10985 msgid "guestfs_glob_expand"
10990 #: ../src/guestfs-actions.pod:2191
10994 " guestfs_glob_expand (guestfs_h *g,\n"
10995 " const char *pattern);\n"
11001 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1477
11003 "This command searches for all the pathnames matching C<pattern> according to "
11004 "the wildcard expansion rules used by the shell."
11009 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1481
11011 "If no paths match, then this returns an empty list (note: not an error)."
11016 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1484
11018 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
11019 "GLOB_BRACE>. See that manual page for more details."
11024 #: ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:6472
11025 #: ../src/guestfs-actions.pod:6489
11026 msgid "(Added in 1.0.50)"
11031 #: ../src/guestfs-actions.pod:2212
11032 msgid "guestfs_grep"
11037 #: ../src/guestfs-actions.pod:2214
11041 " guestfs_grep (guestfs_h *g,\n"
11042 " const char *regex,\n"
11043 " const char *path);\n"
11049 #: ../src/guestfs-actions.pod:2219 ../fish/guestfish-actions.pod:1492
11050 msgid "This calls the external C<grep> program and returns the matching lines."
11055 #: ../src/guestfs-actions.pod:2231
11056 msgid "guestfs_grepi"
11061 #: ../src/guestfs-actions.pod:2233
11065 " guestfs_grepi (guestfs_h *g,\n"
11066 " const char *regex,\n"
11067 " const char *path);\n"
11073 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1502
11075 "This calls the external C<grep -i> program and returns the matching lines."
11080 #: ../src/guestfs-actions.pod:2250
11081 msgid "guestfs_grub_install"
11086 #: ../src/guestfs-actions.pod:2252
11090 " guestfs_grub_install (guestfs_h *g,\n"
11091 " const char *root,\n"
11092 " const char *device);\n"
11098 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1512
11100 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11101 "the root directory being C<root>."
11106 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1515
11108 "Note: If grub-install reports the error \"No suitable drive was found in the "
11109 "generated device map.\" it may be that you need to create a C</boot/grub/"
11110 "device.map> file first that contains the mapping between grub device names "
11111 "and Linux device names. It is usually sufficient to create a file "
11117 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
11120 " (hd0) /dev/vda\n"
11126 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1524
11127 msgid "replacing C</dev/vda> with the name of the installation device."
11132 #: ../src/guestfs-actions.pod:2273
11133 msgid "(Added in 1.0.17)"
11138 #: ../src/guestfs-actions.pod:2275
11139 msgid "guestfs_head"
11144 #: ../src/guestfs-actions.pod:2277
11148 " guestfs_head (guestfs_h *g,\n"
11149 " const char *path);\n"
11155 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1530
11157 "This command returns up to the first 10 lines of a file as a list of strings."
11162 #: ../src/guestfs-actions.pod:2293
11163 msgid "guestfs_head_n"
11168 #: ../src/guestfs-actions.pod:2295
11172 " guestfs_head_n (guestfs_h *g,\n"
11174 " const char *path);\n"
11180 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1540
11182 "If the parameter C<nrlines> is a positive number, this returns the first "
11183 "C<nrlines> lines of the file C<path>."
11188 #: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1543
11190 "If the parameter C<nrlines> is a negative number, this returns lines from "
11191 "the file C<path>, excluding the last C<nrlines> lines."
11196 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6769
11197 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4508
11198 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11203 #: ../src/guestfs-actions.pod:2317
11204 msgid "guestfs_hexdump"
11209 #: ../src/guestfs-actions.pod:2319
11213 " guestfs_hexdump (guestfs_h *g,\n"
11214 " const char *path);\n"
11220 #: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1555
11222 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11223 "readable, canonical hex dump of the file."
11228 #: ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:6553
11229 #: ../src/guestfs-actions.pod:6608
11230 msgid "(Added in 1.0.22)"
11235 #: ../src/guestfs-actions.pod:2334
11236 msgid "guestfs_initrd_cat"
11241 #: ../src/guestfs-actions.pod:2336
11245 " guestfs_initrd_cat (guestfs_h *g,\n"
11246 " const char *initrdpath,\n"
11247 " const char *filename,\n"
11248 " size_t *size_r);\n"
11254 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1565
11256 "This command unpacks the file C<filename> from the initrd file called "
11257 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11263 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1569
11265 "For example, in guestfish you could use the following command to examine the "
11266 "boot script (usually called C</init>) contained in a Linux initrd or "
11272 #: ../src/guestfs-actions.pod:2350 ../fish/guestfish-actions.pod:1573
11275 " initrd-cat /boot/initrd-<version>.img init\n"
11281 #: ../src/guestfs-actions.pod:2352
11282 msgid "See also C<guestfs_initrd_list>."
11287 #: ../src/guestfs-actions.pod:2363
11288 msgid "guestfs_initrd_list"
11293 #: ../src/guestfs-actions.pod:2365
11297 " guestfs_initrd_list (guestfs_h *g,\n"
11298 " const char *path);\n"
11304 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1584
11305 msgid "This command lists out files contained in an initrd."
11310 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1586
11312 "The files are listed without any initial C</> character. The files are "
11313 "listed in the order they appear (not necessarily alphabetical). Directory "
11314 "names are listed as separate items."
11319 #: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1590
11321 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11322 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11328 #: ../src/guestfs-actions.pod:2385
11329 msgid "guestfs_inotify_add_watch"
11334 #: ../src/guestfs-actions.pod:2387
11338 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11339 " const char *path,\n"
11346 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1598
11347 msgid "Watch C<path> for the events listed in C<mask>."
11352 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1600
11354 "Note that if C<path> is a directory then events within that directory are "
11355 "watched, but this does I<not> happen recursively (in subdirectories)."
11360 #: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1604
11362 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11363 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11368 #: ../src/guestfs-actions.pod:2406
11369 msgid "guestfs_inotify_close"
11374 #: ../src/guestfs-actions.pod:2408
11378 " guestfs_inotify_close (guestfs_h *g);\n"
11384 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1612
11386 "This closes the inotify handle which was previously opened by inotify_init. "
11387 "It removes all watches, throws away any pending events, and deallocates all "
11393 #: ../src/guestfs-actions.pod:2419
11394 msgid "guestfs_inotify_files"
11399 #: ../src/guestfs-actions.pod:2421
11403 " guestfs_inotify_files (guestfs_h *g);\n"
11409 #: ../src/guestfs-actions.pod:2424
11411 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11412 "returns a list of pathnames of objects that were touched. The returned "
11413 "pathnames are sorted and deduplicated."
11418 #: ../src/guestfs-actions.pod:2434
11419 msgid "guestfs_inotify_init"
11424 #: ../src/guestfs-actions.pod:2436
11428 " guestfs_inotify_init (guestfs_h *g,\n"
11429 " int maxevents);\n"
11435 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1628
11437 "This command creates a new inotify handle. The inotify subsystem can be "
11438 "used to notify events which happen to objects in the guest filesystem."
11443 #: ../src/guestfs-actions.pod:2444
11445 "C<maxevents> is the maximum number of events which will be queued up between "
11446 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11447 "passed as C<0>, then the kernel (or previously set) default is used. For "
11448 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11449 "throws away events, but records the fact that it threw them away by setting "
11450 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11451 "C<guestfs_inotify_read>)."
11456 #: ../src/guestfs-actions.pod:2454
11458 "Before any events are generated, you have to add some watches to the "
11459 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11460 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11465 #: ../src/guestfs-actions.pod:2460
11467 "Queued up events should be read periodically by calling "
11468 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11469 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11470 "often enough then you risk the internal queue overflowing."
11475 #: ../src/guestfs-actions.pod:2467
11477 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11478 "This also removes any watches automatically."
11483 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1659
11485 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11486 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11487 "that there is one global inotify handle per libguestfs instance."
11492 #: ../src/guestfs-actions.pod:2480
11493 msgid "guestfs_inotify_read"
11498 #: ../src/guestfs-actions.pod:2482
11501 " struct guestfs_inotify_event_list *\n"
11502 " guestfs_inotify_read (guestfs_h *g);\n"
11508 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1668
11510 "Return the complete queue of events that have happened since the previous "
11516 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1671
11517 msgid "If no events have happened, this returns an empty list."
11522 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1673
11524 "I<Note>: In order to make sure that all events have been read, you must call "
11525 "this function repeatedly until it returns an empty list. The reason is that "
11526 "the call will read events up to the maximum appliance-to-host message size "
11527 "and leave remaining events in the queue."
11532 #: ../src/guestfs-actions.pod:2496
11534 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11535 "there was an error. I<The caller must call "
11536 "C<guestfs_free_inotify_event_list> after use>."
11541 #: ../src/guestfs-actions.pod:2502
11542 msgid "guestfs_inotify_rm_watch"
11547 #: ../src/guestfs-actions.pod:2504
11551 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11558 #: ../src/guestfs-actions.pod:2508
11560 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11565 #: ../src/guestfs-actions.pod:2515
11566 msgid "guestfs_inspect_get_arch"
11571 #: ../src/guestfs-actions.pod:2517
11575 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11576 " const char *root);\n"
11582 #: ../src/guestfs-actions.pod:2521
11584 "This returns the architecture of the inspected operating system. The "
11585 "possible return values are listed under C<guestfs_file_architecture>."
11590 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1694
11592 "If the architecture could not be determined, then the string C<unknown> is "
11598 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618
11599 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2741
11600 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2955
11601 #: ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3004
11602 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3097
11603 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3137
11604 #: ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3170
11605 #: ../src/guestfs-actions.pod:3188 ../src/guestfs-actions.pod:3290
11606 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:1697
11607 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
11608 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
11609 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
11610 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
11611 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
11612 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
11613 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
11614 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
11615 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11620 #: ../src/guestfs-actions.pod:2535
11621 msgid "guestfs_inspect_get_distro"
11626 #: ../src/guestfs-actions.pod:2537
11630 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11631 " const char *root);\n"
11637 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1703
11639 "This returns the distro (distribution) of the inspected operating system."
11644 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1706
11645 msgid "Currently defined distros are:"
11650 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1710
11651 msgid "\"archlinux\""
11656 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1712
11657 msgid "Arch Linux."
11661 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1714
11666 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1716
11672 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1718
11678 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1720
11684 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1722
11690 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1724
11696 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1726
11702 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1728
11708 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1730
11709 msgid "\"linuxmint\""
11714 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1732
11715 msgid "Linux Mint."
11720 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1734
11721 msgid "\"mandriva\""
11726 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1736
11732 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1738
11738 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1740
11744 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1742
11750 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1744
11756 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1746
11757 msgid "\"redhat-based\""
11762 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1748
11763 msgid "Some Red Hat-derived distro."
11768 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1750
11773 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1752
11774 msgid "Red Hat Enterprise Linux."
11778 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1754
11779 msgid "\"scientificlinux\""
11783 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1756
11784 msgid "Scientific Linux."
11788 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1758
11789 msgid "\"slackware\""
11793 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1760
11799 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1762
11805 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1764
11811 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2713
11812 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:1766
11813 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
11814 msgid "\"unknown\""
11819 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1768
11820 msgid "The distro could not be determined."
11825 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3080
11826 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
11827 msgid "\"windows\""
11832 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1772
11834 "Windows does not have distributions. This string is returned if the OS type "
11840 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2719
11841 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:1777
11842 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
11844 "Future versions of libguestfs may return other strings here. The caller "
11845 "should be prepared to handle any string."
11849 #: ../src/guestfs-actions.pod:2625
11850 msgid "guestfs_inspect_get_drive_mappings"
11854 #: ../src/guestfs-actions.pod:2627
11858 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11859 " const char *root);\n"
11864 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1786
11866 "This call is useful for Windows which uses a primitive system of assigning "
11867 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11868 "Windows Registry to find out how disks/partitions are mapped to drive "
11869 "letters, and returns a hash table as in the example below:"
11873 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1792
11876 " C => /dev/vda2\n"
11877 " E => /dev/vdb1\n"
11878 " F => /dev/vdc1\n"
11883 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1796
11885 "Note that keys are drive letters. For Windows, the key is case insensitive "
11886 "and just contains the drive letter, without the customary colon separator "
11891 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1800
11893 "In future we may support other operating systems that also used drive "
11894 "letters, but the keys for those might not be case insensitive and might be "
11895 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11900 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1805
11902 "For Windows guests, currently only hard drive mappings are returned. "
11903 "Removable disks (eg. DVD-ROMs) are ignored."
11907 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
11909 "For guests that do not use drive mappings, or if the drive mappings could "
11910 "not be determined, this returns an empty hash table."
11914 #: ../src/guestfs-actions.pod:2656
11916 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11917 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11922 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2928
11923 #: ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:4973
11924 #: ../src/guestfs-actions.pod:6910
11926 "This function returns a NULL-terminated array of strings, or NULL if there "
11927 "was an error. The array of strings will always have length C<2n+1>, where "
11928 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11929 "caller must free the strings and the array after use>."
11933 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:3122
11934 msgid "(Added in 1.9.17)"
11939 #: ../src/guestfs-actions.pod:2668
11940 msgid "guestfs_inspect_get_filesystems"
11945 #: ../src/guestfs-actions.pod:2670
11949 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11950 " const char *root);\n"
11956 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1819
11958 "This returns a list of all the filesystems that we think are associated with "
11959 "this operating system. This includes the root filesystem, other ordinary "
11960 "filesystems, and non-mounted devices like swap partitions."
11965 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1824
11967 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11968 "to be shared between operating systems."
11973 #: ../src/guestfs-actions.pod:2682
11975 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11976 "C<guestfs_inspect_get_mountpoints>."
11980 #: ../src/guestfs-actions.pod:2691
11981 msgid "guestfs_inspect_get_format"
11985 #: ../src/guestfs-actions.pod:2693
11989 " guestfs_inspect_get_format (guestfs_h *g,\n"
11990 " const char *root);\n"
11995 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1834
11997 "This returns the format of the inspected operating system. You can use it "
11998 "to detect install images, live CDs and similar."
12002 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1837
12003 msgid "Currently defined formats are:"
12007 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1841
12008 msgid "\"installed\""
12012 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1843
12013 msgid "This is an installed operating system."
12017 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1845
12018 msgid "\"installer\""
12022 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1847
12024 "The disk image being inspected is not an installed operating system, but a "
12025 "I<bootable> install disk, live CD, or similar."
12029 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1852
12030 msgid "The format of this disk image is not known."
12034 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3158
12035 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3192
12036 #: ../src/guestfs-actions.pod:5825
12037 msgid "(Added in 1.9.4)"
12042 #: ../src/guestfs-actions.pod:2729
12043 msgid "guestfs_inspect_get_hostname"
12048 #: ../src/guestfs-actions.pod:2731
12052 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12053 " const char *root);\n"
12059 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1865
12061 "This function returns the hostname of the operating system as found by "
12062 "inspection of the guest's configuration files."
12067 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1868
12069 "If the hostname could not be determined, then the string C<unknown> is "
12075 #: ../src/guestfs-actions.pod:2746
12076 msgid "(Added in 1.7.9)"
12080 #: ../src/guestfs-actions.pod:2748
12081 msgid "guestfs_inspect_get_icon"
12085 #: ../src/guestfs-actions.pod:2750
12089 " guestfs_inspect_get_icon (guestfs_h *g,\n"
12090 " const char *root,\n"
12091 " size_t *size_r,\n"
12097 #: ../src/guestfs-actions.pod:2761
12100 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
12101 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
12106 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1877
12108 "This function returns an icon corresponding to the inspected operating "
12109 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
12110 "to PNG if necessary)."
12114 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1881
12116 "If it was not possible to get an icon this function returns a zero-length "
12117 "(non-NULL) buffer. I<Callers must check for this case>."
12121 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1884
12123 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
12124 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
12125 "this file will be returned. You can disable favicons by passing the "
12126 "optional C<favicon> boolean as false (default is true)."
12130 #: ../src/guestfs-actions.pod:2777 ../fish/guestfish-actions.pod:1890
12132 "If finding the favicon fails, then we look in other places in the guest for "
12137 #: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1893
12139 "If the optional C<highquality> boolean is true then only high quality icons "
12140 "are returned, which means only icons of high resolution with an alpha "
12141 "channel. The default (false) is to return any icon we can, even if it is of "
12142 "substandard quality."
12146 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1904
12148 "Unlike most other inspection API calls, the guest's disks must be mounted up "
12149 "before you call this, since it needs to read information from the guest "
12150 "filesystem during the call."
12154 #: ../src/guestfs-actions.pod:2797 ../fish/guestfish-actions.pod:1910
12156 "B<Security:> The icon data comes from the untrusted guest, and should be "
12157 "treated with caution. PNG files have been known to contain exploits. "
12158 "Ensure that libpng (or other relevant libraries) are fully up to date before "
12159 "trying to process or display the icon."
12163 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
12165 "The PNG image returned can be any size. It might not be square. Libguestfs "
12166 "tries to return the largest, highest quality icon available. The "
12167 "application must scale the icon to the required size."
12171 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
12173 "Extracting icons from Windows guests requires the external C<wrestool> "
12174 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
12175 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
12176 "installed separately."
12180 #: ../src/guestfs-actions.pod:2819 ../fish/guestfish-actions.pod:1932
12182 "Operating system icons are usually trademarks. Seek legal advice before "
12183 "using trademarks in applications."
12187 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3653
12188 #: ../src/guestfs-actions.pod:4872
12189 msgid "(Added in 1.11.12)"
12193 #: ../src/guestfs-actions.pod:2830
12194 msgid "guestfs_inspect_get_icon_va"
12198 #: ../src/guestfs-actions.pod:2832
12202 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
12203 " const char *root,\n"
12204 " size_t *size_r,\n"
12205 " va_list args);\n"
12210 #: ../src/guestfs-actions.pod:2838
12211 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
12215 #: ../src/guestfs-actions.pod:2842
12216 msgid "guestfs_inspect_get_icon_argv"
12220 #: ../src/guestfs-actions.pod:2844
12224 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
12225 " const char *root,\n"
12226 " size_t *size_r,\n"
12227 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
12232 #: ../src/guestfs-actions.pod:2850
12233 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
12238 #: ../src/guestfs-actions.pod:2854
12239 msgid "guestfs_inspect_get_major_version"
12244 #: ../src/guestfs-actions.pod:2856
12248 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12249 " const char *root);\n"
12255 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1943
12257 "This returns the major version number of the inspected operating system."
12262 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1946
12264 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12265 "popular public names used by the operating system. Notably the operating "
12266 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12267 "1). You can find out the real versions corresponding to releases of Windows "
12268 "by consulting Wikipedia or MSDN."
12273 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2887
12274 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
12275 msgid "If the version could not be determined, then C<0> is returned."
12280 #: ../src/guestfs-actions.pod:2878
12281 msgid "guestfs_inspect_get_minor_version"
12286 #: ../src/guestfs-actions.pod:2880
12290 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12291 " const char *root);\n"
12297 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1961
12299 "This returns the minor version number of the inspected operating system."
12304 #: ../src/guestfs-actions.pod:2889
12306 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12307 "C<guestfs_inspect_get_major_version>."
12312 #: ../src/guestfs-actions.pod:2896
12313 msgid "guestfs_inspect_get_mountpoints"
12318 #: ../src/guestfs-actions.pod:2898
12322 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12323 " const char *root);\n"
12328 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1973
12330 "This returns a hash of where we think the filesystems associated with this "
12331 "operating system should be mounted. Callers should note that this is at "
12332 "best an educated guess made by reading configuration files such as C</etc/"
12333 "fstab>. I<In particular note> that this may return filesystems which are "
12334 "non-existent or not mountable and callers should be prepared to handle or "
12335 "ignore failures if they try to mount them."
12340 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1982
12342 "Each element in the returned hashtable has a key which is the path of the "
12343 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12344 "mounted there (eg. C</dev/sda1>)."
12349 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1987
12351 "Non-mounted devices such as swap devices are I<not> returned in this list."
12355 #: ../src/guestfs-actions.pod:2919
12357 "For operating systems like Windows which still use drive letters, this call "
12358 "will only return an entry for the first drive \"mounted on\" C</>. For "
12359 "information about the mapping of drive letters to partitions, see "
12360 "C<guestfs_inspect_get_drive_mappings>."
12365 #: ../src/guestfs-actions.pod:2925
12367 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12368 "C<guestfs_inspect_get_filesystems>."
12373 #: ../src/guestfs-actions.pod:2936
12374 msgid "guestfs_inspect_get_package_format"
12379 #: ../src/guestfs-actions.pod:2938
12383 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12384 " const char *root);\n"
12390 #: ../src/guestfs-actions.pod:2942
12392 "This function and C<guestfs_inspect_get_package_management> return the "
12393 "package format and package management tool used by the inspected operating "
12394 "system. For example for Fedora these functions would return C<rpm> (package "
12395 "format) and C<yum> (package management)."
12400 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2009
12402 "This returns the string C<unknown> if we could not determine the package "
12403 "format I<or> if the operating system does not have a real packaging system "
12409 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2013
12411 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12412 "Future versions of libguestfs may return other strings."
12417 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:2988
12418 msgid "(Added in 1.7.5)"
12423 #: ../src/guestfs-actions.pod:2962
12424 msgid "guestfs_inspect_get_package_management"
12429 #: ../src/guestfs-actions.pod:2964
12433 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12434 " const char *root);\n"
12440 #: ../src/guestfs-actions.pod:2968
12442 "C<guestfs_inspect_get_package_format> and this function return the package "
12443 "format and package management tool used by the inspected operating system. "
12444 "For example for Fedora these functions would return C<rpm> (package format) "
12445 "and C<yum> (package management)."
12450 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2028
12452 "This returns the string C<unknown> if we could not determine the package "
12453 "management tool I<or> if the operating system does not have a real packaging "
12454 "system (eg. Windows)."
12459 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2032
12461 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12462 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12463 "libguestfs may return other strings."
12468 #: ../src/guestfs-actions.pod:2990
12469 msgid "guestfs_inspect_get_product_name"
12474 #: ../src/guestfs-actions.pod:2992
12478 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12479 " const char *root);\n"
12485 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2043
12487 "This returns the product name of the inspected operating system. The "
12488 "product name is generally some freeform string which can be displayed to the "
12489 "user, but should not be parsed by programs."
12494 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
12496 "If the product name could not be determined, then the string C<unknown> is "
12501 #: ../src/guestfs-actions.pod:3011
12502 msgid "guestfs_inspect_get_product_variant"
12506 #: ../src/guestfs-actions.pod:3013
12510 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12511 " const char *root);\n"
12516 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2057
12517 msgid "This returns the product variant of the inspected operating system."
12521 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2060
12523 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12524 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12525 "is usually a string such as C<Client> or C<Server> (other values are "
12526 "possible). This can be used to distinguish consumer and enterprise versions "
12527 "of Windows that have the same version number (for example, Windows 7 and "
12528 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12529 "the latter is C<Server>)."
12533 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2069
12535 "For enterprise Linux guests, in future we intend this to return the product "
12536 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12537 "implemented at present."
12541 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2073
12543 "If the product variant could not be determined, then the string C<unknown> "
12548 #: ../src/guestfs-actions.pod:3036
12550 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12551 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12555 #: ../src/guestfs-actions.pod:3043
12556 msgid "(Added in 1.9.13)"
12561 #: ../src/guestfs-actions.pod:3045
12562 msgid "guestfs_inspect_get_roots"
12567 #: ../src/guestfs-actions.pod:3047
12571 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12577 #: ../src/guestfs-actions.pod:3050
12579 "This function is a convenient way to get the list of root devices, as "
12580 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12581 "the whole inspection process."
12586 #: ../src/guestfs-actions.pod:3054
12588 "This returns an empty list if either no root devices were found or the "
12589 "caller has not called C<guestfs_inspect_os>."
12594 #: ../src/guestfs-actions.pod:3063
12595 msgid "(Added in 1.7.3)"
12600 #: ../src/guestfs-actions.pod:3065
12601 msgid "guestfs_inspect_get_type"
12606 #: ../src/guestfs-actions.pod:3067
12610 " guestfs_inspect_get_type (guestfs_h *g,\n"
12611 " const char *root);\n"
12617 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2097
12619 "This returns the type of the inspected operating system. Currently defined "
12625 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2102
12631 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2104
12632 msgid "Any Linux-based operating system."
12637 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2108
12638 msgid "Any Microsoft Windows operating system."
12643 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2110
12644 msgid "\"freebsd\""
12649 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2112
12655 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2116
12656 msgid "The operating system type could not be determined."
12660 #: ../src/guestfs-actions.pod:3104
12661 msgid "guestfs_inspect_get_windows_current_control_set"
12665 #: ../src/guestfs-actions.pod:3106
12669 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12670 " const char *root);\n"
12675 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2129
12677 "This returns the Windows CurrentControlSet of the inspected guest. The "
12678 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12682 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2132
12684 "This call assumes that the guest is Windows and that the Registry could be "
12685 "examined by inspection. If this is not the case then an error is returned."
12690 #: ../src/guestfs-actions.pod:3124
12691 msgid "guestfs_inspect_get_windows_systemroot"
12696 #: ../src/guestfs-actions.pod:3126
12700 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12701 " const char *root);\n"
12707 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2142
12709 "This returns the Windows systemroot of the inspected guest. The systemroot "
12710 "is a directory path such as C</WINDOWS>."
12715 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2145
12717 "This call assumes that the guest is Windows and that the systemroot could be "
12718 "determined by inspection. If this is not the case then an error is returned."
12723 #: ../src/guestfs-actions.pod:3142
12724 msgid "(Added in 1.5.25)"
12728 #: ../src/guestfs-actions.pod:3144
12729 msgid "guestfs_inspect_is_live"
12733 #: ../src/guestfs-actions.pod:3146
12737 " guestfs_inspect_is_live (guestfs_h *g,\n"
12738 " const char *root);\n"
12743 #: ../src/guestfs-actions.pod:3150
12745 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12746 "disk), then this returns true if a live image was detected on the disk."
12750 #: ../src/guestfs-actions.pod:3160
12751 msgid "guestfs_inspect_is_multipart"
12755 #: ../src/guestfs-actions.pod:3162
12759 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12760 " const char *root);\n"
12765 #: ../src/guestfs-actions.pod:3166
12767 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12768 "disk), then this returns true if the disk is part of a set."
12772 #: ../src/guestfs-actions.pod:3176
12773 msgid "guestfs_inspect_is_netinst"
12777 #: ../src/guestfs-actions.pod:3178
12781 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12782 " const char *root);\n"
12787 #: ../src/guestfs-actions.pod:3182
12789 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12790 "disk), then this returns true if the disk is a network installer, ie. not a "
12791 "self-contained install CD but one which is likely to require network access "
12792 "to complete the install."
12797 #: ../src/guestfs-actions.pod:3194
12798 msgid "guestfs_inspect_list_applications"
12803 #: ../src/guestfs-actions.pod:3196
12806 " struct guestfs_application_list *\n"
12807 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12808 " const char *root);\n"
12814 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2187
12815 msgid "Return the list of applications installed in the operating system."
12820 #: ../src/guestfs-actions.pod:3202
12822 "I<Note:> This call works differently from other parts of the inspection "
12823 "API. You have to call C<guestfs_inspect_os>, then "
12824 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12825 "this. Listing applications is a significantly more difficult operation "
12826 "which requires access to the full filesystem. Also note that unlike the "
12827 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12828 "the libguestfs handle, this call actually reads parts of the mounted "
12829 "filesystems during the call."
12834 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2199
12836 "This returns an empty list if the inspection code was not able to determine "
12837 "the list of applications."
12842 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2202
12843 msgid "The application structure contains the following fields:"
12848 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2206
12849 msgid "C<app_name>"
12854 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2208
12856 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12857 "guests, this is the package name."
12862 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2211
12863 msgid "C<app_display_name>"
12868 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2213
12870 "The display name of the application, sometimes localized to the install "
12871 "language of the guest operating system."
12876 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2216
12878 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12879 "to display something can use C<app_name> instead."
12884 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2219
12885 msgid "C<app_epoch>"
12890 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2221
12892 "For package managers which use epochs, this contains the epoch of the "
12893 "package (an integer). If unavailable, this is returned as C<0>."
12898 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2224
12899 msgid "C<app_version>"
12904 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2226
12906 "The version string of the application or package. If unavailable this is "
12907 "returned as an empty string C<\"\">."
12912 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2229
12913 msgid "C<app_release>"
12918 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2231
12920 "The release string of the application or package, for package managers that "
12921 "use this. If unavailable this is returned as an empty string C<\"\">."
12926 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2235
12927 msgid "C<app_install_path>"
12932 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2237
12934 "The installation path of the application (on operating systems such as "
12935 "Windows which use installation paths). This path is in the format used by "
12936 "the guest operating system, it is not a libguestfs path."
12941 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2242
12942 msgid "If unavailable this is returned as an empty string C<\"\">."
12947 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2244
12948 msgid "C<app_trans_path>"
12953 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2246
12955 "The install path translated into a libguestfs path. If unavailable this is "
12956 "returned as an empty string C<\"\">."
12961 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2249
12962 msgid "C<app_publisher>"
12967 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2251
12969 "The name of the publisher of the application, for package managers that use "
12970 "this. If unavailable this is returned as an empty string C<\"\">."
12975 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2255
12981 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2257
12983 "The URL (eg. upstream URL) of the application. If unavailable this is "
12984 "returned as an empty string C<\"\">."
12989 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2260
12990 msgid "C<app_source_package>"
12995 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2262
12997 "For packaging systems which support this, the name of the source package. "
12998 "If unavailable this is returned as an empty string C<\"\">."
13003 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2265
13004 msgid "C<app_summary>"
13009 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2267
13011 "A short (usually one line) description of the application or package. If "
13012 "unavailable this is returned as an empty string C<\"\">."
13017 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2270
13018 msgid "C<app_description>"
13023 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2272
13025 "A longer description of the application or package. If unavailable this is "
13026 "returned as an empty string C<\"\">."
13031 #: ../src/guestfs-actions.pod:3292
13033 "This function returns a C<struct guestfs_application_list *>, or NULL if "
13034 "there was an error. I<The caller must call C<guestfs_free_application_list> "
13040 #: ../src/guestfs-actions.pod:3296
13041 msgid "(Added in 1.7.8)"
13046 #: ../src/guestfs-actions.pod:3298
13047 msgid "guestfs_inspect_os"
13052 #: ../src/guestfs-actions.pod:3300
13056 " guestfs_inspect_os (guestfs_h *g);\n"
13062 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2283
13064 "This function uses other libguestfs functions and certain heuristics to "
13065 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
13066 "for operating systems."
13071 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2287
13072 msgid "The list returned is empty if no operating systems were found."
13077 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2289
13079 "If one operating system was found, then this returns a list with a single "
13080 "element, which is the name of the root filesystem of this operating system. "
13081 "It is also possible for this function to return a list containing more than "
13082 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
13083 "element being the root filesystem of one of the operating systems."
13088 #: ../src/guestfs-actions.pod:3316
13090 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
13091 "functions in order to query further information about each operating system, "
13092 "such as the name and version."
13097 #: ../src/guestfs-actions.pod:3321
13099 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
13100 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
13101 "the contents. This should be called with no disks currently mounted. The "
13102 "function may also use Augeas, so any existing Augeas handle will be closed."
13107 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2307
13109 "This function cannot decrypt encrypted disks. The caller must do that first "
13110 "(supplying the necessary keys) if the disk is encrypted."
13115 #: ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3664
13116 #: ../src/guestfs-actions.pod:3726
13117 msgid "See also C<guestfs_list_filesystems>."
13122 #: ../src/guestfs-actions.pod:3341
13123 msgid "guestfs_is_blockdev"
13128 #: ../src/guestfs-actions.pod:3343
13132 " guestfs_is_blockdev (guestfs_h *g,\n"
13133 " const char *path);\n"
13139 #: ../src/guestfs-actions.pod:3347 ../fish/guestfish-actions.pod:2319
13141 "This returns C<true> if and only if there is a block device with the given "
13147 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379
13148 #: ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3424
13149 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3496
13150 #: ../src/guestfs-actions.pod:3511
13151 msgid "See also C<guestfs_stat>."
13156 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3383
13157 #: ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3500
13158 #: ../src/guestfs-actions.pod:3515
13159 msgid "(Added in 1.5.10)"
13164 #: ../src/guestfs-actions.pod:3356
13165 msgid "guestfs_is_busy"
13170 #: ../src/guestfs-actions.pod:3358
13174 " guestfs_is_busy (guestfs_h *g);\n"
13180 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2328
13182 "This returns true iff this handle is busy processing a command (in the "
13188 #: ../src/guestfs-actions.pod:3370
13189 msgid "guestfs_is_chardev"
13194 #: ../src/guestfs-actions.pod:3372
13198 " guestfs_is_chardev (guestfs_h *g,\n"
13199 " const char *path);\n"
13205 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2337
13207 "This returns C<true> if and only if there is a character device with the "
13208 "given C<path> name."
13213 #: ../src/guestfs-actions.pod:3385
13214 msgid "guestfs_is_config"
13219 #: ../src/guestfs-actions.pod:3387
13223 " guestfs_is_config (guestfs_h *g);\n"
13229 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2346
13231 "This returns true iff this handle is being configured (in the C<CONFIG> "
13237 #: ../src/guestfs-actions.pod:3399
13238 msgid "guestfs_is_dir"
13243 #: ../src/guestfs-actions.pod:3401
13247 " guestfs_is_dir (guestfs_h *g,\n"
13248 " const char *path);\n"
13254 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2355
13256 "This returns C<true> if and only if there is a directory with the given "
13257 "C<path> name. Note that it returns false for other objects like files."
13262 #: ../src/guestfs-actions.pod:3415
13263 msgid "guestfs_is_fifo"
13268 #: ../src/guestfs-actions.pod:3417
13272 " guestfs_is_fifo (guestfs_h *g,\n"
13273 " const char *path);\n"
13279 #: ../src/guestfs-actions.pod:3421 ../fish/guestfish-actions.pod:2365
13281 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13282 "given C<path> name."
13287 #: ../src/guestfs-actions.pod:3430
13288 msgid "guestfs_is_file"
13293 #: ../src/guestfs-actions.pod:3432
13297 " guestfs_is_file (guestfs_h *g,\n"
13298 " const char *path);\n"
13304 #: ../src/guestfs-actions.pod:3436 ../fish/guestfish-actions.pod:2374
13306 "This returns C<true> if and only if there is a regular file with the given "
13307 "C<path> name. Note that it returns false for other objects like directories."
13312 #: ../src/guestfs-actions.pod:3446
13313 msgid "guestfs_is_launching"
13318 #: ../src/guestfs-actions.pod:3448
13322 " guestfs_is_launching (guestfs_h *g);\n"
13328 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2384
13330 "This returns true iff this handle is launching the subprocess (in the "
13331 "C<LAUNCHING> state)."
13336 #: ../src/guestfs-actions.pod:3460
13337 msgid "guestfs_is_lv"
13342 #: ../src/guestfs-actions.pod:3462
13346 " guestfs_is_lv (guestfs_h *g,\n"
13347 " const char *device);\n"
13353 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2393
13355 "This command tests whether C<device> is a logical volume, and returns true "
13356 "iff this is the case."
13361 #: ../src/guestfs-actions.pod:3473
13362 msgid "guestfs_is_ready"
13367 #: ../src/guestfs-actions.pod:3475
13371 " guestfs_is_ready (guestfs_h *g);\n"
13377 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2400
13379 "This returns true iff this handle is ready to accept commands (in the "
13385 #: ../src/guestfs-actions.pod:3487
13386 msgid "guestfs_is_socket"
13391 #: ../src/guestfs-actions.pod:3489
13395 " guestfs_is_socket (guestfs_h *g,\n"
13396 " const char *path);\n"
13402 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2409
13404 "This returns C<true> if and only if there is a Unix domain socket with the "
13405 "given C<path> name."
13410 #: ../src/guestfs-actions.pod:3502
13411 msgid "guestfs_is_symlink"
13416 #: ../src/guestfs-actions.pod:3504
13420 " guestfs_is_symlink (guestfs_h *g,\n"
13421 " const char *path);\n"
13427 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2418
13429 "This returns C<true> if and only if there is a symbolic link with the given "
13434 #: ../src/guestfs-actions.pod:3517
13435 msgid "guestfs_is_zero"
13439 #: ../src/guestfs-actions.pod:3519
13443 " guestfs_is_zero (guestfs_h *g,\n"
13444 " const char *path);\n"
13449 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2427
13451 "This returns true iff the file exists and the file is empty or it contains "
13456 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542
13457 msgid "(Added in 1.11.8)"
13461 #: ../src/guestfs-actions.pod:3530
13462 msgid "guestfs_is_zero_device"
13466 #: ../src/guestfs-actions.pod:3532
13470 " guestfs_is_zero_device (guestfs_h *g,\n"
13471 " const char *device);\n"
13476 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2434
13477 msgid "This returns true iff the device exists and contains all zero bytes."
13481 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2436
13482 msgid "Note that for large devices this can take a long time to run."
13487 #: ../src/guestfs-actions.pod:3544
13488 msgid "guestfs_kill_subprocess"
13493 #: ../src/guestfs-actions.pod:3546
13497 " guestfs_kill_subprocess (guestfs_h *g);\n"
13503 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:2442
13504 msgid "This kills the qemu subprocess. You should never need to call this."
13509 #: ../src/guestfs-actions.pod:3555
13510 msgid "guestfs_launch"
13515 #: ../src/guestfs-actions.pod:3557
13519 " guestfs_launch (guestfs_h *g);\n"
13525 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2450
13527 "Internally libguestfs is implemented by running a virtual machine using "
13533 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2453
13535 "You should call this after configuring the handle (eg. adding drives) but "
13536 "before performing any actions."
13541 #: ../src/guestfs-actions.pod:3575
13542 msgid "guestfs_lchown"
13547 #: ../src/guestfs-actions.pod:3577
13551 " guestfs_lchown (guestfs_h *g,\n"
13554 " const char *path);\n"
13560 #: ../src/guestfs-actions.pod:3583
13562 "Change the file owner to C<owner> and group to C<group>. This is like "
13563 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13564 "changed, not the target."
13569 #: ../src/guestfs-actions.pod:3595
13570 msgid "guestfs_lgetxattr"
13575 #: ../src/guestfs-actions.pod:3597
13579 " guestfs_lgetxattr (guestfs_h *g,\n"
13580 " const char *path,\n"
13581 " const char *name,\n"
13582 " size_t *size_r);\n"
13588 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2472
13590 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13591 "is a symlink, then this call returns an extended attribute from the symlink."
13596 #: ../src/guestfs-actions.pod:3617
13597 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13602 #: ../src/guestfs-actions.pod:3625
13603 msgid "guestfs_lgetxattrs"
13608 #: ../src/guestfs-actions.pod:3627
13611 " struct guestfs_xattr_list *\n"
13612 " guestfs_lgetxattrs (guestfs_h *g,\n"
13613 " const char *path);\n"
13619 #: ../src/guestfs-actions.pod:3631
13621 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13622 "then it returns the extended attributes of the link itself."
13626 #: ../src/guestfs-actions.pod:3641
13627 msgid "guestfs_list_9p"
13631 #: ../src/guestfs-actions.pod:3643
13635 " guestfs_list_9p (guestfs_h *g);\n"
13640 #: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2500
13642 "List all 9p filesystems attached to the guest. A list of mount tags is "
13648 #: ../src/guestfs-actions.pod:3655
13649 msgid "guestfs_list_devices"
13654 #: ../src/guestfs-actions.pod:3657
13658 " guestfs_list_devices (guestfs_h *g);\n"
13664 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2507
13665 msgid "List all the block devices."
13670 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2509
13671 msgid "The full block device names are returned, eg. C</dev/sda>."
13676 #: ../src/guestfs-actions.pod:3672
13677 msgid "guestfs_list_filesystems"
13682 #: ../src/guestfs-actions.pod:3674
13686 " guestfs_list_filesystems (guestfs_h *g);\n"
13692 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2517
13694 "This inspection command looks for filesystems on partitions, block devices "
13695 "and logical volumes, returning a list of devices containing filesystems and "
13701 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2521
13703 "The return value is a hash, where the keys are the devices containing "
13704 "filesystems, and the values are the filesystem types. For example:"
13709 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2525
13712 " \"/dev/sda1\" => \"ntfs\"\n"
13713 " \"/dev/sda2\" => \"ext2\"\n"
13714 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13715 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13721 #: ../src/guestfs-actions.pod:3690 ../fish/guestfish-actions.pod:2530
13723 "The value can have the special value \"unknown\", meaning the content of the "
13724 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13729 #: ../src/guestfs-actions.pod:3694
13731 "This command runs other libguestfs commands, which might include "
13732 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13733 "soon after launch and only when nothing is mounted."
13738 #: ../src/guestfs-actions.pod:3698
13740 "Not all of the filesystems returned will be mountable. In particular, swap "
13741 "partitions are returned in the list. Also this command does not check that "
13742 "each filesystem found is valid and mountable, and some filesystems might be "
13743 "mountable but require special options. Filesystems may not all belong to a "
13744 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13749 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:5374
13750 msgid "(Added in 1.5.15)"
13755 #: ../src/guestfs-actions.pod:3714
13756 msgid "guestfs_list_partitions"
13761 #: ../src/guestfs-actions.pod:3716
13765 " guestfs_list_partitions (guestfs_h *g);\n"
13771 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2550
13772 msgid "List all the partitions detected on all block devices."
13777 #: ../src/guestfs-actions.pod:3721 ../fish/guestfish-actions.pod:2552
13778 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13783 #: ../src/guestfs-actions.pod:3723
13785 "This does not return logical volumes. For that you will need to call "
13791 #: ../src/guestfs-actions.pod:3734
13797 #: ../src/guestfs-actions.pod:3736
13801 " guestfs_ll (guestfs_h *g,\n"
13802 " const char *directory);\n"
13808 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2563
13810 "List the files in C<directory> (relative to the root directory, there is no "
13811 "cwd) in the format of 'ls -la'."
13816 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2566
13818 "This command is mostly useful for interactive sessions. It is I<not> "
13819 "intended that you try to parse the output string."
13824 #: ../src/guestfs-actions.pod:3751
13830 #: ../src/guestfs-actions.pod:3753
13834 " guestfs_ln (guestfs_h *g,\n"
13835 " const char *target,\n"
13836 " const char *linkname);\n"
13842 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2573
13843 msgid "This command creates a hard link using the C<ln> command."
13848 #: ../src/guestfs-actions.pod:3764
13849 msgid "guestfs_ln_f"
13854 #: ../src/guestfs-actions.pod:3766
13858 " guestfs_ln_f (guestfs_h *g,\n"
13859 " const char *target,\n"
13860 " const char *linkname);\n"
13865 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2579
13867 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13868 "option removes the link (C<linkname>) if it exists already."
13873 #: ../src/guestfs-actions.pod:3778
13874 msgid "guestfs_ln_s"
13879 #: ../src/guestfs-actions.pod:3780
13883 " guestfs_ln_s (guestfs_h *g,\n"
13884 " const char *target,\n"
13885 " const char *linkname);\n"
13891 #: ../src/guestfs-actions.pod:3785 ../fish/guestfish-actions.pod:2586
13892 msgid "This command creates a symbolic link using the C<ln -s> command."
13897 #: ../src/guestfs-actions.pod:3791
13898 msgid "guestfs_ln_sf"
13903 #: ../src/guestfs-actions.pod:3793
13907 " guestfs_ln_sf (guestfs_h *g,\n"
13908 " const char *target,\n"
13909 " const char *linkname);\n"
13914 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2592
13916 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13917 "option removes the link (C<linkname>) if it exists already."
13922 #: ../src/guestfs-actions.pod:3805
13923 msgid "guestfs_lremovexattr"
13928 #: ../src/guestfs-actions.pod:3807
13932 " guestfs_lremovexattr (guestfs_h *g,\n"
13933 " const char *xattr,\n"
13934 " const char *path);\n"
13940 #: ../src/guestfs-actions.pod:3812
13942 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13943 "link, then it removes an extended attribute of the link itself."
13948 #: ../src/guestfs-actions.pod:3820
13954 #: ../src/guestfs-actions.pod:3822
13958 " guestfs_ls (guestfs_h *g,\n"
13959 " const char *directory);\n"
13965 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2607
13967 "List the files in C<directory> (relative to the root directory, there is no "
13968 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13973 #: ../src/guestfs-actions.pod:3830
13975 "This command is mostly useful for interactive sessions. Programs should "
13976 "probably use C<guestfs_readdir> instead."
13981 #: ../src/guestfs-actions.pod:3839
13982 msgid "guestfs_lsetxattr"
13987 #: ../src/guestfs-actions.pod:3841
13991 " guestfs_lsetxattr (guestfs_h *g,\n"
13992 " const char *xattr,\n"
13993 " const char *val,\n"
13995 " const char *path);\n"
14001 #: ../src/guestfs-actions.pod:3848
14003 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
14004 "then it sets an extended attribute of the link itself."
14009 #: ../src/guestfs-actions.pod:3856
14010 msgid "guestfs_lstat"
14015 #: ../src/guestfs-actions.pod:3858
14018 " struct guestfs_stat *\n"
14019 " guestfs_lstat (guestfs_h *g,\n"
14020 " const char *path);\n"
14026 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:6509
14027 #: ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4343
14028 msgid "Returns file information for the given C<path>."
14033 #: ../src/guestfs-actions.pod:3864
14035 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
14036 "link, then the link is stat-ed, not the file it refers to."
14041 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2632
14042 msgid "This is the same as the C<lstat(2)> system call."
14047 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:6513
14049 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
14050 "error. I<The caller must call C<guestfs_free_stat> after use>."
14055 #: ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:6517
14056 #: ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6916
14057 msgid "(Added in 0.9.2)"
14062 #: ../src/guestfs-actions.pod:3876
14063 msgid "guestfs_lstatlist"
14068 #: ../src/guestfs-actions.pod:3878
14071 " struct guestfs_stat_list *\n"
14072 " guestfs_lstatlist (guestfs_h *g,\n"
14073 " const char *path,\n"
14074 " char *const *names);\n"
14080 #: ../src/guestfs-actions.pod:3883
14082 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
14083 "files, where all files are in the directory C<path>. C<names> is the list "
14084 "of files from this directory."
14089 #: ../src/guestfs-actions.pod:3887 ../fish/guestfish-actions.pod:2642
14091 "On return you get a list of stat structs, with a one-to-one correspondence "
14092 "to the C<names> list. If any name did not exist or could not be lstat'd, "
14093 "then the C<ino> field of that structure is set to C<-1>."
14098 #: ../src/guestfs-actions.pod:3892
14100 "This call is intended for programs that want to efficiently list a directory "
14101 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
14102 "for a similarly efficient call for getting extended attributes. Very long "
14103 "directory listings might cause the protocol message size to be exceeded, "
14104 "causing this call to fail. The caller must split up such requests into "
14105 "smaller groups of names."
14110 #: ../src/guestfs-actions.pod:3900
14112 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
14113 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
14118 #: ../src/guestfs-actions.pod:3906
14119 msgid "guestfs_luks_add_key"
14124 #: ../src/guestfs-actions.pod:3908
14128 " guestfs_luks_add_key (guestfs_h *g,\n"
14129 " const char *device,\n"
14130 " const char *key,\n"
14131 " const char *newkey,\n"
14138 #: ../src/guestfs-actions.pod:3915 ../fish/guestfish-actions.pod:2659
14140 "This command adds a new key on LUKS device C<device>. C<key> is any "
14141 "existing key, and is used to access the device. C<newkey> is the new key to "
14142 "add. C<keyslot> is the key slot that will be replaced."
14147 #: ../src/guestfs-actions.pod:3920
14149 "Note that if C<keyslot> already contains a key, then this command will "
14150 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
14155 #: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3966
14156 #: ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:4009
14157 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4060
14159 "This function takes a key or passphrase parameter which could contain "
14160 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
14166 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3970
14167 #: ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4013
14168 msgid "(Added in 1.5.2)"
14173 #: ../src/guestfs-actions.pod:3932
14174 msgid "guestfs_luks_close"
14179 #: ../src/guestfs-actions.pod:3934
14183 " guestfs_luks_close (guestfs_h *g,\n"
14184 " const char *device);\n"
14190 #: ../src/guestfs-actions.pod:3938
14192 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
14193 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
14194 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
14195 "underlying block device."
14200 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:4045
14201 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4114
14202 #: ../src/guestfs-actions.pod:4162
14203 msgid "(Added in 1.5.1)"
14208 #: ../src/guestfs-actions.pod:3948
14209 msgid "guestfs_luks_format"
14214 #: ../src/guestfs-actions.pod:3950
14218 " guestfs_luks_format (guestfs_h *g,\n"
14219 " const char *device,\n"
14220 " const char *key,\n"
14227 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2685
14229 "This command erases existing data on C<device> and formats the device as a "
14230 "LUKS encrypted device. C<key> is the initial key, which is added to key "
14231 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
14236 #: ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3986
14237 #: ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:5125
14238 #: ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:6316
14239 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6379
14240 #: ../src/guestfs-actions.pod:7561 ../fish/guestfish-actions.pod:2693
14241 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2790
14242 #: ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3904
14243 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4237
14244 #: ../fish/guestfish-actions.pod:4259 ../fish/guestfish-actions.pod:4989
14246 "B<This command is dangerous. Without careful use you can easily destroy all "
14252 #: ../src/guestfs-actions.pod:3972
14253 msgid "guestfs_luks_format_cipher"
14258 #: ../src/guestfs-actions.pod:3974
14262 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14263 " const char *device,\n"
14264 " const char *key,\n"
14266 " const char *cipher);\n"
14272 #: ../src/guestfs-actions.pod:3981
14274 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14275 "set the C<cipher> used."
14280 #: ../src/guestfs-actions.pod:3995
14281 msgid "guestfs_luks_kill_slot"
14286 #: ../src/guestfs-actions.pod:3997
14290 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14291 " const char *device,\n"
14292 " const char *key,\n"
14299 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2713
14301 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14302 "device C<device>. C<key> must be one of the I<other> keys."
14307 #: ../src/guestfs-actions.pod:4015
14308 msgid "guestfs_luks_open"
14313 #: ../src/guestfs-actions.pod:4017
14317 " guestfs_luks_open (guestfs_h *g,\n"
14318 " const char *device,\n"
14319 " const char *key,\n"
14320 " const char *mapname);\n"
14326 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2724
14328 "This command opens a block device which has been encrypted according to the "
14329 "Linux Unified Key Setup (LUKS) standard."
14334 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2727
14335 msgid "C<device> is the encrypted block device or partition."
14340 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2729
14342 "The caller must supply one of the keys associated with the LUKS block "
14343 "device, in the C<key> parameter."
14348 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2732
14350 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14351 "writes to this block device are decrypted from and encrypted to the "
14352 "underlying C<device> respectively."
14357 #: ../src/guestfs-actions.pod:4035
14359 "If this block device contains LVM volume groups, then calling "
14360 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14366 #: ../src/guestfs-actions.pod:4047
14367 msgid "guestfs_luks_open_ro"
14372 #: ../src/guestfs-actions.pod:4049
14376 " guestfs_luks_open_ro (guestfs_h *g,\n"
14377 " const char *device,\n"
14378 " const char *key,\n"
14379 " const char *mapname);\n"
14385 #: ../src/guestfs-actions.pod:4055
14387 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14393 #: ../src/guestfs-actions.pod:4066
14394 msgid "guestfs_lvcreate"
14399 #: ../src/guestfs-actions.pod:4068
14403 " guestfs_lvcreate (guestfs_h *g,\n"
14404 " const char *logvol,\n"
14405 " const char *volgroup,\n"
14412 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2757
14414 "This creates an LVM logical volume called C<logvol> on the volume group "
14415 "C<volgroup>, with C<size> megabytes."
14420 #: ../src/guestfs-actions.pod:4081
14421 msgid "guestfs_lvm_canonical_lv_name"
14426 #: ../src/guestfs-actions.pod:4083
14430 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14431 " const char *lvname);\n"
14437 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2764
14439 "This converts alternative naming schemes for LVs that you might find to the "
14440 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14446 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2768
14448 "This command returns an error if the C<lvname> parameter does not refer to a "
14454 #: ../src/guestfs-actions.pod:4094
14455 msgid "See also C<guestfs_is_lv>."
14460 #: ../src/guestfs-actions.pod:4099
14461 msgid "(Added in 1.5.24)"
14466 #: ../src/guestfs-actions.pod:4101
14467 msgid "guestfs_lvm_clear_filter"
14472 #: ../src/guestfs-actions.pod:4103
14476 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14482 #: ../src/guestfs-actions.pod:4106
14484 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14485 "see every block device."
14490 #: ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4151
14491 #: ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
14493 "This command also clears the LVM cache and performs a volume group scan."
14498 #: ../src/guestfs-actions.pod:4116
14499 msgid "guestfs_lvm_remove_all"
14504 #: ../src/guestfs-actions.pod:4118
14508 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14514 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2787
14516 "This command removes all LVM logical volumes, volume groups and physical "
14522 #: ../src/guestfs-actions.pod:4131
14523 msgid "guestfs_lvm_set_filter"
14528 #: ../src/guestfs-actions.pod:4133
14532 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14533 " char *const *devices);\n"
14539 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2797
14541 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14542 "block devices in the list C<devices>, and will ignore all other attached "
14548 #: ../src/guestfs-actions.pod:4141 ../fish/guestfish-actions.pod:2801
14550 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14551 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14552 "there are two types of duplication possible: either cloned PVs/VGs which "
14553 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14554 "same name. In normal operation you cannot create this situation, but you "
14555 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14556 "inside the LVM metadata."
14561 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2814
14562 msgid "You can filter whole block devices or individual partitions."
14567 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2816
14569 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14570 "filesystem), even if you are not filtering out that VG."
14575 #: ../src/guestfs-actions.pod:4164
14576 msgid "guestfs_lvremove"
14581 #: ../src/guestfs-actions.pod:4166
14585 " guestfs_lvremove (guestfs_h *g,\n"
14586 " const char *device);\n"
14592 #: ../src/guestfs-actions.pod:4170 ../fish/guestfish-actions.pod:2824
14594 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14595 "LV, such as C</dev/VG/LV>."
14600 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2827
14602 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14608 #: ../src/guestfs-actions.pod:4178 ../src/guestfs-actions.pod:5471
14609 #: ../src/guestfs-actions.pod:7292
14610 msgid "(Added in 1.0.13)"
14615 #: ../src/guestfs-actions.pod:4180
14616 msgid "guestfs_lvrename"
14621 #: ../src/guestfs-actions.pod:4182
14625 " guestfs_lvrename (guestfs_h *g,\n"
14626 " const char *logvol,\n"
14627 " const char *newlogvol);\n"
14633 #: ../src/guestfs-actions.pod:4187 ../fish/guestfish-actions.pod:2834
14634 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14639 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:7305
14640 msgid "(Added in 1.0.83)"
14645 #: ../src/guestfs-actions.pod:4193
14646 msgid "guestfs_lvresize"
14651 #: ../src/guestfs-actions.pod:4195
14655 " guestfs_lvresize (guestfs_h *g,\n"
14656 " const char *device,\n"
14663 #: ../src/guestfs-actions.pod:4200 ../fish/guestfish-actions.pod:2840
14665 "This resizes (expands or shrinks) an existing LVM logical volume to "
14666 "C<mbytes>. When reducing, data in the reduced part is lost."
14671 #: ../src/guestfs-actions.pod:4208
14672 msgid "guestfs_lvresize_free"
14677 #: ../src/guestfs-actions.pod:4210
14681 " guestfs_lvresize_free (guestfs_h *g,\n"
14682 " const char *lv,\n"
14689 #: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2848
14691 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14692 "remaining free space in the volume group. Commonly you would call this with "
14693 "pc = 100 which expands the logical volume as much as possible, using all "
14694 "remaining free space in the volume group."
14699 #: ../src/guestfs-actions.pod:4223
14700 msgid "(Added in 1.3.3)"
14705 #: ../src/guestfs-actions.pod:4225
14706 msgid "guestfs_lvs"
14711 #: ../src/guestfs-actions.pod:4227
14715 " guestfs_lvs (guestfs_h *g);\n"
14721 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2858
14723 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14729 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2861
14731 "This returns a list of the logical volume device names (eg. C</dev/"
14732 "VolGroup00/LogVol00>)."
14737 #: ../src/guestfs-actions.pod:4236
14738 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14743 #: ../src/guestfs-actions.pod:4244
14744 msgid "guestfs_lvs_full"
14749 #: ../src/guestfs-actions.pod:4246
14752 " struct guestfs_lvm_lv_list *\n"
14753 " guestfs_lvs_full (guestfs_h *g);\n"
14759 #: ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2870
14761 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14762 "(8)> command. The \"full\" version includes all fields."
14767 #: ../src/guestfs-actions.pod:4252
14769 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14770 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14775 #: ../src/guestfs-actions.pod:4258
14776 msgid "guestfs_lvuuid"
14781 #: ../src/guestfs-actions.pod:4260
14785 " guestfs_lvuuid (guestfs_h *g,\n"
14786 " const char *device);\n"
14792 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2877
14793 msgid "This command returns the UUID of the LVM LV C<device>."
14798 #: ../src/guestfs-actions.pod:4271
14799 msgid "guestfs_lxattrlist"
14804 #: ../src/guestfs-actions.pod:4273
14807 " struct guestfs_xattr_list *\n"
14808 " guestfs_lxattrlist (guestfs_h *g,\n"
14809 " const char *path,\n"
14810 " char *const *names);\n"
14816 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2883
14818 "This call allows you to get the extended attributes of multiple files, where "
14819 "all files are in the directory C<path>. C<names> is the list of files from "
14825 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2887
14827 "On return you get a flat list of xattr structs which must be interpreted "
14828 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14829 "C<attrval> in this struct is zero-length to indicate there was an error "
14830 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14831 "number (the number of following attributes for this file, which could be C<"
14832 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14833 "for the first named file. This repeats for the second and subsequent files."
14838 #: ../src/guestfs-actions.pod:4292
14840 "This call is intended for programs that want to efficiently list a directory "
14841 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14842 "a similarly efficient call for getting standard stats. Very long directory "
14843 "listings might cause the protocol message size to be exceeded, causing this "
14844 "call to fail. The caller must split up such requests into smaller groups of "
14850 #: ../src/guestfs-actions.pod:4306
14851 msgid "guestfs_mkdir"
14856 #: ../src/guestfs-actions.pod:4308
14860 " guestfs_mkdir (guestfs_h *g,\n"
14861 " const char *path);\n"
14867 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2909
14868 msgid "Create a directory named C<path>."
14873 #: ../src/guestfs-actions.pod:4318
14874 msgid "guestfs_mkdir_mode"
14879 #: ../src/guestfs-actions.pod:4320
14883 " guestfs_mkdir_mode (guestfs_h *g,\n"
14884 " const char *path,\n"
14891 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2915
14893 "This command creates a directory, setting the initial permissions of the "
14894 "directory to C<mode>."
14899 #: ../src/guestfs-actions.pod:4328 ../fish/guestfish-actions.pod:2918
14901 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14902 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14908 #: ../src/guestfs-actions.pod:4332
14909 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14914 #: ../src/guestfs-actions.pod:4338
14915 msgid "guestfs_mkdir_p"
14920 #: ../src/guestfs-actions.pod:4340
14924 " guestfs_mkdir_p (guestfs_h *g,\n"
14925 " const char *path);\n"
14931 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2928
14933 "Create a directory named C<path>, creating any parent directories as "
14934 "necessary. This is like the C<mkdir -p> shell command."
14939 #: ../src/guestfs-actions.pod:4351
14940 msgid "guestfs_mkdtemp"
14945 #: ../src/guestfs-actions.pod:4353
14949 " guestfs_mkdtemp (guestfs_h *g,\n"
14950 " const char *template);\n"
14956 #: ../src/guestfs-actions.pod:4357 ../fish/guestfish-actions.pod:2935
14958 "This command creates a temporary directory. The C<template> parameter "
14959 "should be a full pathname for the temporary directory name with the final "
14960 "six characters being \"XXXXXX\"."
14965 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2940
14967 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14968 "being suitable for Windows filesystems."
14973 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2943
14974 msgid "The name of the temporary directory that was created is returned."
14979 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2946
14980 msgid "The temporary directory is created with mode 0700 and is owned by root."
14985 #: ../src/guestfs-actions.pod:4371 ../fish/guestfish-actions.pod:2949
14987 "The caller is responsible for deleting the temporary directory and its "
14988 "contents after use."
14993 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2952
14994 msgid "See also: L<mkdtemp(3)>"
14999 #: ../src/guestfs-actions.pod:4381
15000 msgid "guestfs_mke2fs_J"
15005 #: ../src/guestfs-actions.pod:4383
15009 " guestfs_mke2fs_J (guestfs_h *g,\n"
15010 " const char *fstype,\n"
15011 " int blocksize,\n"
15012 " const char *device,\n"
15013 " const char *journal);\n"
15019 #: ../src/guestfs-actions.pod:4390 ../fish/guestfish-actions.pod:2958
15021 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15022 "C<journal>. It is equivalent to the command:"
15027 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2962
15030 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
15036 #: ../src/guestfs-actions.pod:4396
15037 msgid "See also C<guestfs_mke2journal>."
15042 #: ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4418
15043 #: ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4452
15044 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4480
15045 #: ../src/guestfs-actions.pod:4539 ../src/guestfs-actions.pod:4804
15046 msgid "(Added in 1.0.68)"
15051 #: ../src/guestfs-actions.pod:4402
15052 msgid "guestfs_mke2fs_JL"
15057 #: ../src/guestfs-actions.pod:4404
15061 " guestfs_mke2fs_JL (guestfs_h *g,\n"
15062 " const char *fstype,\n"
15063 " int blocksize,\n"
15064 " const char *device,\n"
15065 " const char *label);\n"
15071 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2970
15073 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15074 "the journal labeled C<label>."
15079 #: ../src/guestfs-actions.pod:4414
15080 msgid "See also C<guestfs_mke2journal_L>."
15085 #: ../src/guestfs-actions.pod:4420
15086 msgid "guestfs_mke2fs_JU"
15091 #: ../src/guestfs-actions.pod:4422
15095 " guestfs_mke2fs_JU (guestfs_h *g,\n"
15096 " const char *fstype,\n"
15097 " int blocksize,\n"
15098 " const char *device,\n"
15099 " const char *uuid);\n"
15105 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2979
15107 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15108 "the journal with UUID C<uuid>."
15113 #: ../src/guestfs-actions.pod:4432
15114 msgid "See also C<guestfs_mke2journal_U>."
15119 #: ../src/guestfs-actions.pod:4438
15120 msgid "guestfs_mke2journal"
15125 #: ../src/guestfs-actions.pod:4440
15129 " guestfs_mke2journal (guestfs_h *g,\n"
15130 " int blocksize,\n"
15131 " const char *device);\n"
15137 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2988
15139 "This creates an ext2 external journal on C<device>. It is equivalent to the "
15145 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2991
15148 " mke2fs -O journal_dev -b blocksize device\n"
15154 #: ../src/guestfs-actions.pod:4454
15155 msgid "guestfs_mke2journal_L"
15160 #: ../src/guestfs-actions.pod:4456
15164 " guestfs_mke2journal_L (guestfs_h *g,\n"
15165 " int blocksize,\n"
15166 " const char *label,\n"
15167 " const char *device);\n"
15173 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2997
15174 msgid "This creates an ext2 external journal on C<device> with label C<label>."
15179 #: ../src/guestfs-actions.pod:4468
15180 msgid "guestfs_mke2journal_U"
15185 #: ../src/guestfs-actions.pod:4470
15189 " guestfs_mke2journal_U (guestfs_h *g,\n"
15190 " int blocksize,\n"
15191 " const char *uuid,\n"
15192 " const char *device);\n"
15198 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:3003
15199 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
15204 #: ../src/guestfs-actions.pod:4482
15205 msgid "guestfs_mkfifo"
15210 #: ../src/guestfs-actions.pod:4484
15214 " guestfs_mkfifo (guestfs_h *g,\n"
15216 " const char *path);\n"
15222 #: ../src/guestfs-actions.pod:4489
15224 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
15225 "is just a convenient wrapper around C<guestfs_mknod>."
15230 #: ../src/guestfs-actions.pod:4499
15231 msgid "guestfs_mkfs"
15236 #: ../src/guestfs-actions.pod:4501
15240 " guestfs_mkfs (guestfs_h *g,\n"
15241 " const char *fstype,\n"
15242 " const char *device);\n"
15248 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3019
15250 "This creates a filesystem on C<device> (usually a partition or LVM logical "
15251 "volume). The filesystem type is C<fstype>, for example C<ext3>."
15256 #: ../src/guestfs-actions.pod:4514
15257 msgid "guestfs_mkfs_b"
15262 #: ../src/guestfs-actions.pod:4516
15266 " guestfs_mkfs_b (guestfs_h *g,\n"
15267 " const char *fstype,\n"
15268 " int blocksize,\n"
15269 " const char *device);\n"
15275 #: ../src/guestfs-actions.pod:4522
15277 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15278 "block size of the resulting filesystem. Supported block sizes depend on the "
15279 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15284 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4570
15285 #: ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
15287 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15293 #: ../src/guestfs-actions.pod:4532 ../fish/guestfish-actions.pod:3035
15295 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15300 #: ../src/guestfs-actions.pod:4541
15301 msgid "guestfs_mkfs_opts"
15306 #: ../src/guestfs-actions.pod:4543
15310 " guestfs_mkfs_opts (guestfs_h *g,\n"
15311 " const char *fstype,\n"
15312 " const char *device,\n"
15318 #: ../src/guestfs-actions.pod:4554
15321 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15322 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15328 #: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3046
15330 "This function creates a filesystem on C<device>. The filesystem type is "
15331 "C<fstype>, for example C<ext3>."
15336 #: ../src/guestfs-actions.pod:4564 ../fish/guestfish-actions.pod:3053
15337 msgid "C<blocksize>"
15342 #: ../src/guestfs-actions.pod:4566 ../fish/guestfish-actions.pod:3055
15344 "The filesystem block size. Supported block sizes depend on the filesystem "
15345 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15350 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3062
15351 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15355 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3064
15356 msgid "C<features>"
15360 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3066
15361 msgid "This passes the I<-O> parameter to the external mkfs program."
15365 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3068
15367 "For certain filesystem types, this allows extra filesystem features to be "
15368 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15372 #: ../src/guestfs-actions.pod:4583 ../fish/guestfish-actions.pod:3072
15374 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15379 #: ../src/guestfs-actions.pod:4590
15380 msgid "(Added in 1.7.19)"
15385 #: ../src/guestfs-actions.pod:4592
15386 msgid "guestfs_mkfs_opts_va"
15391 #: ../src/guestfs-actions.pod:4594
15395 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15396 " const char *fstype,\n"
15397 " const char *device,\n"
15398 " va_list args);\n"
15404 #: ../src/guestfs-actions.pod:4600
15405 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15410 #: ../src/guestfs-actions.pod:4604
15411 msgid "guestfs_mkfs_opts_argv"
15416 #: ../src/guestfs-actions.pod:4606
15420 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15421 " const char *fstype,\n"
15422 " const char *device,\n"
15423 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15429 #: ../src/guestfs-actions.pod:4612
15430 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15435 #: ../src/guestfs-actions.pod:4616
15436 msgid "guestfs_mkmountpoint"
15441 #: ../src/guestfs-actions.pod:4618
15445 " guestfs_mkmountpoint (guestfs_h *g,\n"
15446 " const char *exemptpath);\n"
15452 #: ../src/guestfs-actions.pod:4622
15454 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15455 "that can be used to create extra mountpoints before mounting the first "
15461 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3087
15463 "These calls are I<only> necessary in some very limited circumstances, mainly "
15464 "the case where you want to mount a mix of unrelated and/or read-only "
15465 "filesystems together."
15470 #: ../src/guestfs-actions.pod:4630 ../fish/guestfish-actions.pod:3091
15472 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15473 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15474 "inside that. You can unpack this as follows in guestfish:"
15479 #: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3096
15482 " add-ro Fedora-11-i686-Live.iso\n"
15484 " mkmountpoint /cd\n"
15485 " mkmountpoint /sqsh\n"
15486 " mkmountpoint /ext3fs\n"
15487 " mount /dev/sda /cd\n"
15488 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15489 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15495 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3105
15496 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15501 #: ../src/guestfs-actions.pod:4646
15503 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15504 "may get unexpected errors if you try to mix these calls. It is safest to "
15505 "manually unmount filesystems and remove mountpoints after use."
15510 #: ../src/guestfs-actions.pod:4650
15512 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15513 "first, so for this to work for manual mountpoints, you must ensure that the "
15514 "innermost mountpoints have the longest pathnames, as in the example code "
15520 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3116
15522 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15526 #: ../src/guestfs-actions.pod:4657
15528 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15529 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15530 "can also trigger these issues."
15535 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4979
15536 #: ../src/guestfs-actions.pod:5891
15537 msgid "(Added in 1.0.62)"
15542 #: ../src/guestfs-actions.pod:4665
15543 msgid "guestfs_mknod"
15548 #: ../src/guestfs-actions.pod:4667
15552 " guestfs_mknod (guestfs_h *g,\n"
15556 " const char *path);\n"
15562 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3126
15564 "This call creates block or character special devices, or named pipes (FIFOs)."
15569 #: ../src/guestfs-actions.pod:4677 ../fish/guestfish-actions.pod:3129
15571 "The C<mode> parameter should be the mode, using the standard constants. "
15572 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15573 "used when creating block and character special devices."
15578 #: ../src/guestfs-actions.pod:4682
15580 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15581 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15582 "regular file). These constants are available in the standard Linux header "
15583 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15584 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15585 "the appropriate constant for you."
15590 #: ../src/guestfs-actions.pod:4696
15591 msgid "guestfs_mknod_b"
15596 #: ../src/guestfs-actions.pod:4698
15600 " guestfs_mknod_b (guestfs_h *g,\n"
15604 " const char *path);\n"
15610 #: ../src/guestfs-actions.pod:4705
15612 "This call creates a block device node called C<path> with mode C<mode> and "
15613 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15614 "wrapper around C<guestfs_mknod>."
15619 #: ../src/guestfs-actions.pod:4715
15620 msgid "guestfs_mknod_c"
15625 #: ../src/guestfs-actions.pod:4717
15629 " guestfs_mknod_c (guestfs_h *g,\n"
15633 " const char *path);\n"
15639 #: ../src/guestfs-actions.pod:4724
15641 "This call creates a char device node called C<path> with mode C<mode> and "
15642 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15643 "wrapper around C<guestfs_mknod>."
15648 #: ../src/guestfs-actions.pod:4734
15649 msgid "guestfs_mkswap"
15654 #: ../src/guestfs-actions.pod:4736
15658 " guestfs_mkswap (guestfs_h *g,\n"
15659 " const char *device);\n"
15665 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3168
15666 msgid "Create a swap partition on C<device>."
15671 #: ../src/guestfs-actions.pod:4746
15672 msgid "guestfs_mkswap_L"
15677 #: ../src/guestfs-actions.pod:4748
15681 " guestfs_mkswap_L (guestfs_h *g,\n"
15682 " const char *label,\n"
15683 " const char *device);\n"
15689 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3174
15690 msgid "Create a swap partition on C<device> with label C<label>."
15695 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3176
15697 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15698 "sda>), just to a partition. This appears to be a limitation of the kernel "
15704 #: ../src/guestfs-actions.pod:4763
15705 msgid "guestfs_mkswap_U"
15710 #: ../src/guestfs-actions.pod:4765
15714 " guestfs_mkswap_U (guestfs_h *g,\n"
15715 " const char *uuid,\n"
15716 " const char *device);\n"
15722 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3184
15723 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15728 #: ../src/guestfs-actions.pod:4776
15729 msgid "guestfs_mkswap_file"
15734 #: ../src/guestfs-actions.pod:4778
15738 " guestfs_mkswap_file (guestfs_h *g,\n"
15739 " const char *path);\n"
15745 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3190
15746 msgid "Create a swap file."
15751 #: ../src/guestfs-actions.pod:4784
15753 "This command just writes a swap file signature to an existing file. To "
15754 "create the file itself, use something like C<guestfs_fallocate>."
15759 #: ../src/guestfs-actions.pod:4791
15760 msgid "guestfs_modprobe"
15765 #: ../src/guestfs-actions.pod:4793
15769 " guestfs_modprobe (guestfs_h *g,\n"
15770 " const char *modulename);\n"
15776 #: ../src/guestfs-actions.pod:4797 ../fish/guestfish-actions.pod:3199
15777 msgid "This loads a kernel module in the appliance."
15782 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3201
15784 "The kernel module must have been whitelisted when libguestfs was built (see "
15785 "C<appliance/kmod.whitelist.in> in the source)."
15790 #: ../src/guestfs-actions.pod:4806
15791 msgid "guestfs_mount"
15796 #: ../src/guestfs-actions.pod:4808
15800 " guestfs_mount (guestfs_h *g,\n"
15801 " const char *device,\n"
15802 " const char *mountpoint);\n"
15808 #: ../src/guestfs-actions.pod:4813 ../fish/guestfish-actions.pod:3208
15810 "Mount a guest disk at a position in the filesystem. Block devices are named "
15811 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15812 "those block devices contain partitions, they will have the usual names (eg. "
15813 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15818 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3214
15820 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15821 "mounted on C</> before others can be mounted. Other filesystems can only be "
15822 "mounted on directories which already exist."
15827 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3219
15829 "The mounted filesystem is writable, if we have sufficient permissions on the "
15830 "underlying device."
15835 #: ../src/guestfs-actions.pod:4827
15837 "B<Important note:> When you use this call, the filesystem options C<sync> "
15838 "and C<noatime> are set implicitly. This was originally done because we "
15839 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15840 "very large negative performance impact and negligible effect on "
15841 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15842 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15843 "(use an empty string for the first parameter if you don't want any options)."
15847 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3232
15849 "This function is deprecated. In new code, use the C<mount_options> call "
15854 #: ../src/guestfs-actions.pod:4848
15855 msgid "guestfs_mount_9p"
15859 #: ../src/guestfs-actions.pod:4850
15863 " guestfs_mount_9p (guestfs_h *g,\n"
15864 " const char *mounttag,\n"
15865 " const char *mountpoint,\n"
15871 #: ../src/guestfs-actions.pod:4861
15874 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
15879 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3243
15881 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
15886 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3246
15888 "If required, C<trans=virtio> will be automatically added to the options. "
15889 "Any other options required can be passed in the optional C<options> "
15894 #: ../src/guestfs-actions.pod:4874
15895 msgid "guestfs_mount_9p_va"
15899 #: ../src/guestfs-actions.pod:4876
15903 " guestfs_mount_9p_va (guestfs_h *g,\n"
15904 " const char *mounttag,\n"
15905 " const char *mountpoint,\n"
15906 " va_list args);\n"
15911 #: ../src/guestfs-actions.pod:4882
15912 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
15916 #: ../src/guestfs-actions.pod:4886
15917 msgid "guestfs_mount_9p_argv"
15921 #: ../src/guestfs-actions.pod:4888
15925 " guestfs_mount_9p_argv (guestfs_h *g,\n"
15926 " const char *mounttag,\n"
15927 " const char *mountpoint,\n"
15928 " const struct guestfs_mount_9p_argv *optargs);\n"
15933 #: ../src/guestfs-actions.pod:4894
15934 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
15939 #: ../src/guestfs-actions.pod:4898
15940 msgid "guestfs_mount_loop"
15945 #: ../src/guestfs-actions.pod:4900
15949 " guestfs_mount_loop (guestfs_h *g,\n"
15950 " const char *file,\n"
15951 " const char *mountpoint);\n"
15957 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3256
15959 "This command lets you mount C<file> (a filesystem image in a file) on a "
15960 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15966 #: ../src/guestfs-actions.pod:4913
15967 msgid "guestfs_mount_options"
15972 #: ../src/guestfs-actions.pod:4915
15976 " guestfs_mount_options (guestfs_h *g,\n"
15977 " const char *options,\n"
15978 " const char *device,\n"
15979 " const char *mountpoint);\n"
15985 #: ../src/guestfs-actions.pod:4921
15987 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15988 "the mount options as for the L<mount(8)> I<-o> flag."
15993 #: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3268
15995 "If the C<options> parameter is an empty string, then no options are passed "
15996 "(all options default to whatever the filesystem uses)."
16001 #: ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4945
16002 #: ../src/guestfs-actions.pod:4962
16003 msgid "(Added in 1.0.10)"
16008 #: ../src/guestfs-actions.pod:4933
16009 msgid "guestfs_mount_ro"
16014 #: ../src/guestfs-actions.pod:4935
16018 " guestfs_mount_ro (guestfs_h *g,\n"
16019 " const char *device,\n"
16020 " const char *mountpoint);\n"
16026 #: ../src/guestfs-actions.pod:4940
16028 "This is the same as the C<guestfs_mount> command, but it mounts the "
16029 "filesystem with the read-only (I<-o ro>) flag."
16034 #: ../src/guestfs-actions.pod:4947
16035 msgid "guestfs_mount_vfs"
16040 #: ../src/guestfs-actions.pod:4949
16044 " guestfs_mount_vfs (guestfs_h *g,\n"
16045 " const char *options,\n"
16046 " const char *vfstype,\n"
16047 " const char *device,\n"
16048 " const char *mountpoint);\n"
16054 #: ../src/guestfs-actions.pod:4956
16056 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16057 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
16063 #: ../src/guestfs-actions.pod:4964
16064 msgid "guestfs_mountpoints"
16069 #: ../src/guestfs-actions.pod:4966
16073 " guestfs_mountpoints (guestfs_h *g);\n"
16079 #: ../src/guestfs-actions.pod:4969
16081 "This call is similar to C<guestfs_mounts>. That call returns a list of "
16082 "devices. This one returns a hash table (map) of device name to directory "
16083 "where the device is mounted."
16088 #: ../src/guestfs-actions.pod:4981
16089 msgid "guestfs_mounts"
16094 #: ../src/guestfs-actions.pod:4983
16098 " guestfs_mounts (guestfs_h *g);\n"
16104 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3299
16106 "This returns the list of currently mounted filesystems. It returns the list "
16107 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
16112 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3302
16113 msgid "Some internal mounts are not shown."
16118 #: ../src/guestfs-actions.pod:4991
16119 msgid "See also: C<guestfs_mountpoints>"
16124 #: ../src/guestfs-actions.pod:4999
16130 #: ../src/guestfs-actions.pod:5001
16134 " guestfs_mv (guestfs_h *g,\n"
16135 " const char *src,\n"
16136 " const char *dest);\n"
16142 #: ../src/guestfs-actions.pod:5006 ../fish/guestfish-actions.pod:3310
16144 "This moves a file from C<src> to C<dest> where C<dest> is either a "
16145 "destination filename or destination directory."
16150 #: ../src/guestfs-actions.pod:5013
16151 msgid "guestfs_ntfs_3g_probe"
16156 #: ../src/guestfs-actions.pod:5015
16160 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
16162 " const char *device);\n"
16168 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3317
16170 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
16171 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
16172 "write, and some cannot be mounted at all)."
16177 #: ../src/guestfs-actions.pod:5024 ../fish/guestfish-actions.pod:3321
16179 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
16180 "can be mounted read-write. Set it to false if you want to test if the "
16181 "volume can be mounted read-only."
16186 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
16188 "The return value is an integer which C<0> if the operation would succeed, or "
16189 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
16194 #: ../src/guestfs-actions.pod:5034
16195 msgid "(Added in 1.0.43)"
16200 #: ../src/guestfs-actions.pod:5036
16201 msgid "guestfs_ntfsresize"
16206 #: ../src/guestfs-actions.pod:5038
16210 " guestfs_ntfsresize (guestfs_h *g,\n"
16211 " const char *device);\n"
16217 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3333
16219 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
16220 "size of the underlying device. See also L<ntfsresize(8)>."
16225 #: ../src/guestfs-actions.pod:5050
16226 msgid "guestfs_ntfsresize_size"
16231 #: ../src/guestfs-actions.pod:5052
16235 " guestfs_ntfsresize_size (guestfs_h *g,\n"
16236 " const char *device,\n"
16237 " int64_t size);\n"
16243 #: ../src/guestfs-actions.pod:5057
16245 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
16246 "to specify the new size (in bytes) explicitly."
16251 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5498
16252 #: ../src/guestfs-actions.pod:5571 ../src/guestfs-actions.pod:5839
16253 #: ../src/guestfs-actions.pod:7447
16254 msgid "(Added in 1.3.14)"
16259 #: ../src/guestfs-actions.pod:5064
16260 msgid "guestfs_part_add"
16265 #: ../src/guestfs-actions.pod:5066
16269 " guestfs_part_add (guestfs_h *g,\n"
16270 " const char *device,\n"
16271 " const char *prlogex,\n"
16272 " int64_t startsect,\n"
16273 " int64_t endsect);\n"
16279 #: ../src/guestfs-actions.pod:5073
16281 "This command adds a partition to C<device>. If there is no partition table "
16282 "on the device, call C<guestfs_part_init> first."
16287 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3351
16289 "The C<prlogex> parameter is the type of partition. Normally you should pass "
16290 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
16291 "C<logical>) and C<e> (or C<extended>) partition types."
16296 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3356
16298 "C<startsect> and C<endsect> are the start and end of the partition in "
16299 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
16300 "from the end of the disk (C<-1> is the last sector)."
16305 #: ../src/guestfs-actions.pod:5085
16307 "Creating a partition which covers the whole disk is not so easy. Use "
16308 "C<guestfs_part_disk> to do that."
16313 #: ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5128
16314 #: ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5259
16315 #: ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5316
16316 #: ../src/guestfs-actions.pod:5356
16317 msgid "(Added in 1.0.78)"
16322 #: ../src/guestfs-actions.pod:5092
16323 msgid "guestfs_part_del"
16328 #: ../src/guestfs-actions.pod:5094
16332 " guestfs_part_del (guestfs_h *g,\n"
16333 " const char *device,\n"
16340 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3367
16341 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16346 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3369
16348 "Note that in the case of MBR partitioning, deleting an extended partition "
16349 "also deletes any logical partitions it contains."
16354 #: ../src/guestfs-actions.pod:5109
16355 msgid "guestfs_part_disk"
16360 #: ../src/guestfs-actions.pod:5111
16364 " guestfs_part_disk (guestfs_h *g,\n"
16365 " const char *device,\n"
16366 " const char *parttype);\n"
16372 #: ../src/guestfs-actions.pod:5116
16374 "This command is simply a combination of C<guestfs_part_init> followed by "
16375 "C<guestfs_part_add> to create a single primary partition covering the whole "
16381 #: ../src/guestfs-actions.pod:5120
16383 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16384 "possible values are described in C<guestfs_part_init>."
16389 #: ../src/guestfs-actions.pod:5130
16390 msgid "guestfs_part_get_bootable"
16395 #: ../src/guestfs-actions.pod:5132
16399 " guestfs_part_get_bootable (guestfs_h *g,\n"
16400 " const char *device,\n"
16407 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3391
16409 "This command returns true if the partition C<partnum> on C<device> has the "
16410 "bootable flag set."
16415 #: ../src/guestfs-actions.pod:5140
16416 msgid "See also C<guestfs_part_set_bootable>."
16421 #: ../src/guestfs-actions.pod:5146
16422 msgid "guestfs_part_get_mbr_id"
16427 #: ../src/guestfs-actions.pod:5148
16431 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16432 " const char *device,\n"
16439 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3400
16441 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16442 "partition C<partnum>."
16447 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5332
16449 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16450 "undefined results for other partition table types (see "
16451 "C<guestfs_part_get_parttype>)."
16456 #: ../src/guestfs-actions.pod:5164
16457 msgid "guestfs_part_get_parttype"
16462 #: ../src/guestfs-actions.pod:5166
16466 " guestfs_part_get_parttype (guestfs_h *g,\n"
16467 " const char *device);\n"
16473 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3411
16475 "This command examines the partition table on C<device> and returns the "
16476 "partition table type (format) being used."
16481 #: ../src/guestfs-actions.pod:5173
16483 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16484 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16485 "possible, although unusual. See C<guestfs_part_init> for a full list."
16490 #: ../src/guestfs-actions.pod:5183
16491 msgid "guestfs_part_init"
16496 #: ../src/guestfs-actions.pod:5185
16500 " guestfs_part_init (guestfs_h *g,\n"
16501 " const char *device,\n"
16502 " const char *parttype);\n"
16508 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3423
16510 "This creates an empty partition table on C<device> of one of the partition "
16511 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16512 "(for large disks)."
16517 #: ../src/guestfs-actions.pod:5194
16519 "Initially there are no partitions. Following this, you should call "
16520 "C<guestfs_part_add> for each partition required."
16525 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3430
16526 msgid "Possible values for C<parttype> are:"
16531 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3434
16532 msgid "B<efi> | B<gpt>"
16537 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3436
16538 msgid "Intel EFI / GPT partition table."
16543 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3438
16545 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16546 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16547 "the C<mbr> format."
16552 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3442
16553 msgid "B<mbr> | B<msdos>"
16558 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3444
16560 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16561 "Windows. This partition type will B<only> work for device sizes up to 2 "
16562 "TB. For large disks we recommend using C<gpt>."
16567 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3451
16569 "Other partition table types that may work but are not supported include:"
16574 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3456
16580 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3458
16581 msgid "AIX disk labels."
16586 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3460
16587 msgid "B<amiga> | B<rdb>"
16592 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3462
16593 msgid "Amiga \"Rigid Disk Block\" format."
16598 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3464
16604 #: ../src/guestfs-actions.pod:5233 ../fish/guestfish-actions.pod:3466
16605 msgid "BSD disk labels."
16610 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3468
16616 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3470
16617 msgid "DASD, used on IBM mainframes."
16622 #: ../src/guestfs-actions.pod:5239 ../fish/guestfish-actions.pod:3472
16628 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3474
16629 msgid "MIPS/SGI volumes."
16634 #: ../src/guestfs-actions.pod:5243 ../fish/guestfish-actions.pod:3476
16640 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3478
16641 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16646 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3480
16652 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3482
16653 msgid "NEC PC-98 format, common in Japan apparently."
16658 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3484
16664 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3486
16665 msgid "Sun disk labels."
16670 #: ../src/guestfs-actions.pod:5261
16671 msgid "guestfs_part_list"
16676 #: ../src/guestfs-actions.pod:5263
16679 " struct guestfs_partition_list *\n"
16680 " guestfs_part_list (guestfs_h *g,\n"
16681 " const char *device);\n"
16687 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3494
16689 "This command parses the partition table on C<device> and returns the list of "
16690 "partitions found."
16695 #: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3497
16696 msgid "The fields in the returned structure are:"
16701 #: ../src/guestfs-actions.pod:5274 ../fish/guestfish-actions.pod:3501
16702 msgid "B<part_num>"
16707 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3503
16708 msgid "Partition number, counting from 1."
16713 #: ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3505
16714 msgid "B<part_start>"
16719 #: ../src/guestfs-actions.pod:5280
16721 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16722 "the device's sector size, see C<guestfs_blockdev_getss>."
16727 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3510
16728 msgid "B<part_end>"
16733 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3512
16734 msgid "End of the partition in bytes."
16739 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3514
16740 msgid "B<part_size>"
16745 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3516
16746 msgid "Size of the partition in bytes."
16751 #: ../src/guestfs-actions.pod:5293
16753 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16754 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16760 #: ../src/guestfs-actions.pod:5299
16761 msgid "guestfs_part_set_bootable"
16766 #: ../src/guestfs-actions.pod:5301
16770 " guestfs_part_set_bootable (guestfs_h *g,\n"
16771 " const char *device,\n"
16773 " int bootable);\n"
16779 #: ../src/guestfs-actions.pod:5307 ../fish/guestfish-actions.pod:3524
16781 "This sets the bootable flag on partition numbered C<partnum> on device "
16782 "C<device>. Note that partitions are numbered from 1."
16787 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3527
16789 "The bootable flag is used by some operating systems (notably Windows) to "
16790 "determine which partition to boot from. It is by no means universally "
16796 #: ../src/guestfs-actions.pod:5318
16797 msgid "guestfs_part_set_mbr_id"
16802 #: ../src/guestfs-actions.pod:5320
16806 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16807 " const char *device,\n"
16815 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3535
16817 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16818 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16819 "documentation are in fact hexadecimal numbers, but usually documented "
16820 "without any leading \"0x\" which might be confusing."
16825 #: ../src/guestfs-actions.pod:5340
16826 msgid "guestfs_part_set_name"
16831 #: ../src/guestfs-actions.pod:5342
16835 " guestfs_part_set_name (guestfs_h *g,\n"
16836 " const char *device,\n"
16838 " const char *name);\n"
16844 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3549
16846 "This sets the partition name on partition numbered C<partnum> on device "
16847 "C<device>. Note that partitions are numbered from 1."
16852 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3552
16854 "The partition name can only be set on certain types of partition table. "
16855 "This works on C<gpt> but not on C<mbr> partitions."
16860 #: ../src/guestfs-actions.pod:5358
16861 msgid "guestfs_part_to_dev"
16866 #: ../src/guestfs-actions.pod:5360
16870 " guestfs_part_to_dev (guestfs_h *g,\n"
16871 " const char *partition);\n"
16877 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3559
16879 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16880 "partition number, returning the device name (eg. \"/dev/sdb\")."
16885 #: ../src/guestfs-actions.pod:5368
16887 "The named partition must exist, for example as a string returned from "
16888 "C<guestfs_list_partitions>."
16893 #: ../src/guestfs-actions.pod:5376
16894 msgid "guestfs_ping_daemon"
16899 #: ../src/guestfs-actions.pod:5378
16903 " guestfs_ping_daemon (guestfs_h *g);\n"
16909 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3570
16911 "This is a test probe into the guestfs daemon running inside the qemu "
16912 "subprocess. Calling this function checks that the daemon responds to the "
16913 "ping message, without affecting the daemon or attached block device(s) in "
16919 #: ../src/guestfs-actions.pod:5390
16920 msgid "guestfs_pread"
16925 #: ../src/guestfs-actions.pod:5392
16929 " guestfs_pread (guestfs_h *g,\n"
16930 " const char *path,\n"
16932 " int64_t offset,\n"
16933 " size_t *size_r);\n"
16939 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3579
16941 "This command lets you read part of a file. It reads C<count> bytes of the "
16942 "file, starting at C<offset>, from file C<path>."
16947 #: ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5428
16948 #: ../fish/guestfish-actions.pod:3582 ../fish/guestfish-actions.pod:3597
16950 "This may read fewer bytes than requested. For further details see the "
16951 "L<pread(2)> system call."
16956 #: ../src/guestfs-actions.pod:5405
16957 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16962 #: ../src/guestfs-actions.pod:5416
16963 msgid "guestfs_pread_device"
16968 #: ../src/guestfs-actions.pod:5418
16972 " guestfs_pread_device (guestfs_h *g,\n"
16973 " const char *device,\n"
16975 " int64_t offset,\n"
16976 " size_t *size_r);\n"
16982 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3594
16984 "This command lets you read part of a file. It reads C<count> bytes of "
16985 "C<device>, starting at C<offset>."
16990 #: ../src/guestfs-actions.pod:5431
16991 msgid "See also C<guestfs_pread>."
16996 #: ../src/guestfs-actions.pod:5440
16997 msgid "(Added in 1.5.21)"
17002 #: ../src/guestfs-actions.pod:5442
17003 msgid "guestfs_pvcreate"
17008 #: ../src/guestfs-actions.pod:5444
17012 " guestfs_pvcreate (guestfs_h *g,\n"
17013 " const char *device);\n"
17019 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3609
17021 "This creates an LVM physical volume on the named C<device>, where C<device> "
17022 "should usually be a partition name such as C</dev/sda1>."
17027 #: ../src/guestfs-actions.pod:5456
17028 msgid "guestfs_pvremove"
17033 #: ../src/guestfs-actions.pod:5458
17037 " guestfs_pvremove (guestfs_h *g,\n"
17038 " const char *device);\n"
17044 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3617
17046 "This wipes a physical volume C<device> so that LVM will no longer recognise "
17052 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3620
17054 "The implementation uses the C<pvremove> command which refuses to wipe "
17055 "physical volumes that contain any volume groups, so you have to remove those "
17061 #: ../src/guestfs-actions.pod:5473
17062 msgid "guestfs_pvresize"
17067 #: ../src/guestfs-actions.pod:5475
17071 " guestfs_pvresize (guestfs_h *g,\n"
17072 " const char *device);\n"
17078 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3628
17080 "This resizes (expands or shrinks) an existing LVM physical volume to match "
17081 "the new size of the underlying device."
17086 #: ../src/guestfs-actions.pod:5486
17087 msgid "guestfs_pvresize_size"
17092 #: ../src/guestfs-actions.pod:5488
17096 " guestfs_pvresize_size (guestfs_h *g,\n"
17097 " const char *device,\n"
17098 " int64_t size);\n"
17104 #: ../src/guestfs-actions.pod:5493
17106 "This command is the same as C<guestfs_pvresize> except that it allows you to "
17107 "specify the new size (in bytes) explicitly."
17112 #: ../src/guestfs-actions.pod:5500
17113 msgid "guestfs_pvs"
17118 #: ../src/guestfs-actions.pod:5502
17122 " guestfs_pvs (guestfs_h *g);\n"
17128 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3642
17130 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17136 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3645
17138 "This returns a list of just the device names that contain PVs (eg. C</dev/"
17144 #: ../src/guestfs-actions.pod:5511
17145 msgid "See also C<guestfs_pvs_full>."
17150 #: ../src/guestfs-actions.pod:5519
17151 msgid "guestfs_pvs_full"
17156 #: ../src/guestfs-actions.pod:5521
17159 " struct guestfs_lvm_pv_list *\n"
17160 " guestfs_pvs_full (guestfs_h *g);\n"
17166 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3654
17168 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17169 "(8)> command. The \"full\" version includes all fields."
17174 #: ../src/guestfs-actions.pod:5527
17176 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
17177 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
17182 #: ../src/guestfs-actions.pod:5533
17183 msgid "guestfs_pvuuid"
17188 #: ../src/guestfs-actions.pod:5535
17192 " guestfs_pvuuid (guestfs_h *g,\n"
17193 " const char *device);\n"
17199 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3661
17200 msgid "This command returns the UUID of the LVM PV C<device>."
17205 #: ../src/guestfs-actions.pod:5546
17206 msgid "guestfs_pwrite"
17211 #: ../src/guestfs-actions.pod:5548
17215 " guestfs_pwrite (guestfs_h *g,\n"
17216 " const char *path,\n"
17217 " const char *content,\n"
17218 " size_t content_size,\n"
17219 " int64_t offset);\n"
17225 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3667
17227 "This command writes to part of a file. It writes the data buffer C<content> "
17228 "to the file C<path> starting at offset C<offset>."
17233 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3670
17235 "This command implements the L<pwrite(2)> system call, and like that system "
17236 "call it may not write the full data requested. The return value is the "
17237 "number of bytes that were actually written to the file. This could even be "
17238 "0, although short writes are unlikely for regular files in ordinary "
17244 #: ../src/guestfs-actions.pod:5564
17245 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
17250 #: ../src/guestfs-actions.pod:5573
17251 msgid "guestfs_pwrite_device"
17256 #: ../src/guestfs-actions.pod:5575
17260 " guestfs_pwrite_device (guestfs_h *g,\n"
17261 " const char *device,\n"
17262 " const char *content,\n"
17263 " size_t content_size,\n"
17264 " int64_t offset);\n"
17270 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3685
17272 "This command writes to part of a device. It writes the data buffer "
17273 "C<content> to C<device> starting at offset C<offset>."
17278 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3688
17280 "This command implements the L<pwrite(2)> system call, and like that system "
17281 "call it may not write the full data requested (although short writes to disk "
17282 "devices and partitions are probably impossible with standard Linux kernels)."
17287 #: ../src/guestfs-actions.pod:5590
17288 msgid "See also C<guestfs_pwrite>."
17293 #: ../src/guestfs-actions.pod:5597
17294 msgid "(Added in 1.5.20)"
17299 #: ../src/guestfs-actions.pod:5599
17300 msgid "guestfs_read_file"
17305 #: ../src/guestfs-actions.pod:5601
17309 " guestfs_read_file (guestfs_h *g,\n"
17310 " const char *path,\n"
17311 " size_t *size_r);\n"
17317 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3702
17318 msgid "This calls returns the contents of the file C<path> as a buffer."
17323 #: ../src/guestfs-actions.pod:5609
17325 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
17326 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
17327 "function is limited in the total size of file that can be handled."
17332 #: ../src/guestfs-actions.pod:5621
17333 msgid "(Added in 1.0.63)"
17338 #: ../src/guestfs-actions.pod:5623
17339 msgid "guestfs_read_lines"
17344 #: ../src/guestfs-actions.pod:5625
17348 " guestfs_read_lines (guestfs_h *g,\n"
17349 " const char *path);\n"
17355 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3719
17357 "The file contents are returned as a list of lines. Trailing C<LF> and "
17358 "C<CRLF> character sequences are I<not> returned."
17363 #: ../src/guestfs-actions.pod:5634
17365 "Note that this function cannot correctly handle binary files (specifically, "
17366 "files containing C<\\0> character which is treated as end of line). For "
17367 "those you need to use the C<guestfs_read_file> function which has a more "
17368 "complex interface."
17373 #: ../src/guestfs-actions.pod:5645
17374 msgid "guestfs_readdir"
17379 #: ../src/guestfs-actions.pod:5647
17382 " struct guestfs_dirent_list *\n"
17383 " guestfs_readdir (guestfs_h *g,\n"
17384 " const char *dir);\n"
17390 #: ../src/guestfs-actions.pod:5651 ../fish/guestfish-actions.pod:3731
17391 msgid "This returns the list of directory entries in directory C<dir>."
17396 #: ../src/guestfs-actions.pod:5653 ../fish/guestfish-actions.pod:3733
17398 "All entries in the directory are returned, including C<.> and C<..>. The "
17399 "entries are I<not> sorted, but returned in the same order as the underlying "
17405 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3737
17407 "Also this call returns basic file type information about each file. The "
17408 "C<ftyp> field will contain one of the following characters:"
17413 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3742
17419 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3744
17420 msgid "Block special"
17425 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3746
17431 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3748
17432 msgid "Char special"
17437 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:3750
17443 #: ../src/guestfs-actions.pod:5672 ../fish/guestfish-actions.pod:3752
17449 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3754
17455 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3756
17456 msgid "FIFO (named pipe)"
17461 #: ../src/guestfs-actions.pod:5678 ../fish/guestfish-actions.pod:3758
17467 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:3760
17468 msgid "Symbolic link"
17473 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3762
17479 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3764
17480 msgid "Regular file"
17485 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3766
17491 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3768
17497 #: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3770
17503 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3772
17504 msgid "Unknown file type"
17509 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3774
17515 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3776
17517 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17522 #: ../src/guestfs-actions.pod:5701
17524 "This function is primarily intended for use by programs. To get a simple "
17525 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17526 "consumption, use C<guestfs_ll>."
17531 #: ../src/guestfs-actions.pod:5705
17533 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17534 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17539 #: ../src/guestfs-actions.pod:5711
17540 msgid "guestfs_readlink"
17545 #: ../src/guestfs-actions.pod:5713
17549 " guestfs_readlink (guestfs_h *g,\n"
17550 " const char *path);\n"
17556 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:3789
17557 msgid "This command reads the target of a symbolic link."
17562 #: ../src/guestfs-actions.pod:5724
17563 msgid "guestfs_readlinklist"
17568 #: ../src/guestfs-actions.pod:5726
17572 " guestfs_readlinklist (guestfs_h *g,\n"
17573 " const char *path,\n"
17574 " char *const *names);\n"
17580 #: ../src/guestfs-actions.pod:5731 ../fish/guestfish-actions.pod:3795
17582 "This call allows you to do a C<readlink> operation on multiple files, where "
17583 "all files are in the directory C<path>. C<names> is the list of files from "
17589 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3799
17591 "On return you get a list of strings, with a one-to-one correspondence to the "
17592 "C<names> list. Each string is the value of the symbolic link."
17597 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3803
17599 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17600 "result string is the empty string C<\"\">. However the whole operation is "
17601 "completed even if there were C<readlink(2)> errors, and so you can call this "
17602 "function with names where you don't know if they are symbolic links already "
17603 "(albeit slightly less efficient)."
17608 #: ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:3810
17610 "This call is intended for programs that want to efficiently list a directory "
17611 "contents without making many round-trips. Very long directory listings "
17612 "might cause the protocol message size to be exceeded, causing this call to "
17613 "fail. The caller must split up such requests into smaller groups of names."
17618 #: ../src/guestfs-actions.pod:5759
17619 msgid "guestfs_realpath"
17624 #: ../src/guestfs-actions.pod:5761
17628 " guestfs_realpath (guestfs_h *g,\n"
17629 " const char *path);\n"
17635 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3821
17637 "Return the canonicalized absolute pathname of C<path>. The returned path "
17638 "has no C<.>, C<..> or symbolic link path elements."
17643 #: ../src/guestfs-actions.pod:5773
17644 msgid "guestfs_removexattr"
17649 #: ../src/guestfs-actions.pod:5775
17653 " guestfs_removexattr (guestfs_h *g,\n"
17654 " const char *xattr,\n"
17655 " const char *path);\n"
17661 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3828
17663 "This call removes the extended attribute named C<xattr> of the file C<path>."
17668 #: ../src/guestfs-actions.pod:5783
17669 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17674 #: ../src/guestfs-actions.pod:5789
17675 msgid "guestfs_resize2fs"
17680 #: ../src/guestfs-actions.pod:5791
17684 " guestfs_resize2fs (guestfs_h *g,\n"
17685 " const char *device);\n"
17691 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3837
17693 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17694 "underlying device."
17699 #: ../src/guestfs-actions.pod:5798
17701 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17702 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17703 "sometimes gives an error about this and sometimes not. In any case, it is "
17704 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17708 #: ../src/guestfs-actions.pod:5808
17709 msgid "guestfs_resize2fs_M"
17713 #: ../src/guestfs-actions.pod:5810
17717 " guestfs_resize2fs_M (guestfs_h *g,\n"
17718 " const char *device);\n"
17723 #: ../src/guestfs-actions.pod:5814
17725 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17726 "resized to its minimum size. This works like the I<-M> option to the "
17727 "C<resize2fs> command."
17731 #: ../src/guestfs-actions.pod:5818
17733 "To get the resulting size of the filesystem you should call "
17734 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17735 "These two numbers, multiplied together, give the resulting size of the "
17736 "minimal filesystem in bytes."
17741 #: ../src/guestfs-actions.pod:5827
17742 msgid "guestfs_resize2fs_size"
17747 #: ../src/guestfs-actions.pod:5829
17751 " guestfs_resize2fs_size (guestfs_h *g,\n"
17752 " const char *device,\n"
17753 " int64_t size);\n"
17759 #: ../src/guestfs-actions.pod:5834
17761 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17762 "to specify the new size (in bytes) explicitly."
17767 #: ../src/guestfs-actions.pod:5841
17773 #: ../src/guestfs-actions.pod:5843
17777 " guestfs_rm (guestfs_h *g,\n"
17778 " const char *path);\n"
17784 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3870
17785 msgid "Remove the single file C<path>."
17790 #: ../src/guestfs-actions.pod:5853
17791 msgid "guestfs_rm_rf"
17796 #: ../src/guestfs-actions.pod:5855
17800 " guestfs_rm_rf (guestfs_h *g,\n"
17801 " const char *path);\n"
17807 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3876
17809 "Remove the file or directory C<path>, recursively removing the contents if "
17810 "its a directory. This is like the C<rm -rf> shell command."
17815 #: ../src/guestfs-actions.pod:5867
17816 msgid "guestfs_rmdir"
17821 #: ../src/guestfs-actions.pod:5869
17825 " guestfs_rmdir (guestfs_h *g,\n"
17826 " const char *path);\n"
17832 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3884
17833 msgid "Remove the single directory C<path>."
17838 #: ../src/guestfs-actions.pod:5879
17839 msgid "guestfs_rmmountpoint"
17844 #: ../src/guestfs-actions.pod:5881
17848 " guestfs_rmmountpoint (guestfs_h *g,\n"
17849 " const char *exemptpath);\n"
17855 #: ../src/guestfs-actions.pod:5885
17857 "This calls removes a mountpoint that was previously created with "
17858 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17863 #: ../src/guestfs-actions.pod:5893
17864 msgid "guestfs_scrub_device"
17869 #: ../src/guestfs-actions.pod:5895
17873 " guestfs_scrub_device (guestfs_h *g,\n"
17874 " const char *device);\n"
17880 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3898
17882 "This command writes patterns over C<device> to make data retrieval more "
17888 #: ../src/guestfs-actions.pod:5902 ../src/guestfs-actions.pod:5923
17889 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:3901
17890 #: ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3929
17892 "It is an interface to the L<scrub(1)> program. See that manual page for "
17898 #: ../src/guestfs-actions.pod:5910 ../src/guestfs-actions.pod:5928
17899 #: ../src/guestfs-actions.pod:5947
17900 msgid "(Added in 1.0.52)"
17905 #: ../src/guestfs-actions.pod:5912
17906 msgid "guestfs_scrub_file"
17911 #: ../src/guestfs-actions.pod:5914
17915 " guestfs_scrub_file (guestfs_h *g,\n"
17916 " const char *file);\n"
17922 #: ../src/guestfs-actions.pod:5918 ../fish/guestfish-actions.pod:3911
17924 "This command writes patterns over a file to make data retrieval more "
17930 #: ../src/guestfs-actions.pod:5921 ../fish/guestfish-actions.pod:3914
17931 msgid "The file is I<removed> after scrubbing."
17936 #: ../src/guestfs-actions.pod:5930
17937 msgid "guestfs_scrub_freespace"
17942 #: ../src/guestfs-actions.pod:5932
17946 " guestfs_scrub_freespace (guestfs_h *g,\n"
17947 " const char *dir);\n"
17953 #: ../src/guestfs-actions.pod:5936
17955 "This command creates the directory C<dir> and then fills it with files until "
17956 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17957 "and deletes them. The intention is to scrub any free space on the partition "
17958 "containing C<dir>."
17963 #: ../src/guestfs-actions.pod:5949
17964 msgid "guestfs_set_append"
17969 #: ../src/guestfs-actions.pod:5951
17973 " guestfs_set_append (guestfs_h *g,\n"
17974 " const char *append);\n"
17980 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:3938
17982 "This function is used to add additional options to the guest kernel command "
17988 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3941
17990 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17991 "environment variable."
17996 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:3944
17998 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17999 "(libguestfs always adds a few of its own)."
18003 #: ../src/guestfs-actions.pod:5968
18004 msgid "guestfs_set_attach_method"
18008 #: ../src/guestfs-actions.pod:5970
18012 " guestfs_set_attach_method (guestfs_h *g,\n"
18013 " const char *attachmethod);\n"
18018 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3953
18020 "Set the method that libguestfs uses to connect to the back end guestfsd "
18021 "daemon. Possible methods are:"
18025 #: ../src/guestfs-actions.pod:5981 ../fish/guestfish-actions.pod:3960
18027 "Launch an appliance and connect to it. This is the ordinary method and the "
18032 #: ../src/guestfs-actions.pod:5984 ../fish/guestfish-actions.pod:3963
18033 msgid "C<unix:I<path>>"
18037 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3965
18038 msgid "Connect to the Unix domain socket I<path>."
18042 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:3967
18044 "This method lets you connect to an existing daemon or (using virtio-serial) "
18045 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
18046 "RUNNING DAEMONS>."
18051 #: ../src/guestfs-actions.pod:5998
18052 msgid "guestfs_set_autosync"
18057 #: ../src/guestfs-actions.pod:6000
18061 " guestfs_set_autosync (guestfs_h *g,\n"
18062 " int autosync);\n"
18067 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:3979
18069 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
18070 "effort attempt to make filesystems consistent and synchronized when the "
18071 "handle is closed (also if the program exits without closing handles)."
18076 #: ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:3984
18078 "This is enabled by default (since libguestfs 1.5.24, previously it was "
18079 "disabled by default)."
18084 #: ../src/guestfs-actions.pod:6016
18085 msgid "guestfs_set_direct"
18090 #: ../src/guestfs-actions.pod:6018
18094 " guestfs_set_direct (guestfs_h *g,\n"
18101 #: ../src/guestfs-actions.pod:6022 ../fish/guestfish-actions.pod:3993
18103 "If the direct appliance mode flag is enabled, then stdin and stdout are "
18104 "passed directly through to the appliance once it is launched."
18109 #: ../src/guestfs-actions.pod:6026
18111 "One consequence of this is that log messages aren't caught by the library "
18112 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
18118 #: ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:4001
18119 msgid "You probably don't want to use this unless you know what you are doing."
18124 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4004
18125 msgid "The default is disabled."
18130 #: ../src/guestfs-actions.pod:6039
18131 msgid "guestfs_set_e2label"
18136 #: ../src/guestfs-actions.pod:6041
18140 " guestfs_set_e2label (guestfs_h *g,\n"
18141 " const char *device,\n"
18142 " const char *label);\n"
18148 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4010
18150 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
18151 "C<label>. Filesystem labels are limited to 16 characters."
18156 #: ../src/guestfs-actions.pod:6050
18158 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
18159 "the existing label on a filesystem."
18164 #: ../src/guestfs-actions.pod:6057
18165 msgid "guestfs_set_e2uuid"
18170 #: ../src/guestfs-actions.pod:6059
18174 " guestfs_set_e2uuid (guestfs_h *g,\n"
18175 " const char *device,\n"
18176 " const char *uuid);\n"
18182 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4021
18184 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
18185 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
18186 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
18191 #: ../src/guestfs-actions.pod:6069
18193 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
18194 "the existing UUID of a filesystem."
18199 #: ../src/guestfs-actions.pod:6076
18200 msgid "guestfs_set_memsize"
18205 #: ../src/guestfs-actions.pod:6078
18209 " guestfs_set_memsize (guestfs_h *g,\n"
18216 #: ../src/guestfs-actions.pod:6082
18218 "This sets the memory size in megabytes allocated to the qemu subprocess. "
18219 "This only has any effect if called before C<guestfs_launch>."
18224 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4039
18226 "You can also change this by setting the environment variable "
18227 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
18232 #: ../src/guestfs-actions.pod:6097
18233 msgid "guestfs_set_network"
18238 #: ../src/guestfs-actions.pod:6099
18242 " guestfs_set_network (guestfs_h *g,\n"
18249 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4052
18251 "If C<network> is true, then the network is enabled in the libguestfs "
18252 "appliance. The default is false."
18257 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4055
18259 "This affects whether commands are able to access the network (see L<guestfs"
18260 "(3)/RUNNING COMMANDS>)."
18265 #: ../src/guestfs-actions.pod:6109
18267 "You must call this before calling C<guestfs_launch>, otherwise it has no "
18273 #: ../src/guestfs-actions.pod:6116
18274 msgid "guestfs_set_path"
18279 #: ../src/guestfs-actions.pod:6118
18283 " guestfs_set_path (guestfs_h *g,\n"
18284 " const char *searchpath);\n"
18290 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4067
18291 msgid "Set the path that libguestfs searches for kernel and initrd.img."
18296 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4069
18298 "The default is C<$libdir/guestfs> unless overridden by setting "
18299 "C<LIBGUESTFS_PATH> environment variable."
18304 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4072
18305 msgid "Setting C<path> to C<NULL> restores the default path."
18310 #: ../src/guestfs-actions.pod:6133
18311 msgid "guestfs_set_qemu"
18316 #: ../src/guestfs-actions.pod:6135
18320 " guestfs_set_qemu (guestfs_h *g,\n"
18321 " const char *qemu);\n"
18327 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4080
18328 msgid "Set the qemu binary that we will use."
18333 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4082
18335 "The default is chosen when the library was compiled by the configure script."
18340 #: ../src/guestfs-actions.pod:6144 ../fish/guestfish-actions.pod:4085
18342 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18348 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4088
18349 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18354 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4090
18356 "Note that you should call this function as early as possible after creating "
18357 "the handle. This is because some pre-launch operations depend on testing "
18358 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18359 "don't retest features, and so you might see inconsistent results. Using the "
18360 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18361 "the qemu binary at the same time as the handle is created."
18366 #: ../src/guestfs-actions.pod:6161
18367 msgid "guestfs_set_recovery_proc"
18372 #: ../src/guestfs-actions.pod:6163
18376 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18377 " int recoveryproc);\n"
18383 #: ../src/guestfs-actions.pod:6167
18385 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18386 "not create a recovery process. The purpose of the recovery process is to "
18387 "stop runaway qemu processes in the case where the main program aborts "
18393 #: ../src/guestfs-actions.pod:6172
18395 "This only has any effect if called before C<guestfs_launch>, and the default "
18401 #: ../src/guestfs-actions.pod:6175 ../fish/guestfish-actions.pod:4112
18403 "About the only time when you would want to disable this is if the main "
18404 "process will fork itself into the background (\"daemonize\" itself). In "
18405 "this case the recovery process thinks that the main program has disappeared "
18406 "and so kills qemu, which is not very helpful."
18411 #: ../src/guestfs-actions.pod:6185
18412 msgid "guestfs_set_selinux"
18417 #: ../src/guestfs-actions.pod:6187
18421 " guestfs_set_selinux (guestfs_h *g,\n"
18428 #: ../src/guestfs-actions.pod:6191 ../fish/guestfish-actions.pod:4124
18430 "This sets the selinux flag that is passed to the appliance at boot time. "
18431 "The default is C<selinux=0> (disabled)."
18436 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4127
18438 "Note that if SELinux is enabled, it is always in Permissive mode "
18439 "(C<enforcing=0>)."
18444 #: ../src/guestfs-actions.pod:6204
18445 msgid "guestfs_set_trace"
18450 #: ../src/guestfs-actions.pod:6206
18454 " guestfs_set_trace (guestfs_h *g,\n"
18460 #: ../src/guestfs-actions.pod:6210 ../fish/guestfish-actions.pod:4139
18462 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18463 "return values are traced."
18468 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4142
18470 "If you want to trace C API calls into libguestfs (and other libraries) then "
18471 "possibly a better way is to use the external ltrace(1) command."
18476 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4146
18478 "Command traces are disabled unless the environment variable "
18479 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18483 #: ../src/guestfs-actions.pod:6220
18485 "Trace messages are normally sent to C<stderr>, unless you register a "
18486 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18491 #: ../src/guestfs-actions.pod:6228
18492 msgid "guestfs_set_verbose"
18497 #: ../src/guestfs-actions.pod:6230
18501 " guestfs_set_verbose (guestfs_h *g,\n"
18507 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4159
18508 msgid "If C<verbose> is true, this turns on verbose messages."
18513 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4161
18515 "Verbose messages are disabled unless the environment variable "
18516 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18520 #: ../src/guestfs-actions.pod:6239
18522 "Verbose messages are normally sent to C<stderr>, unless you register a "
18523 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18528 #: ../src/guestfs-actions.pod:6247
18529 msgid "guestfs_setcon"
18534 #: ../src/guestfs-actions.pod:6249
18538 " guestfs_setcon (guestfs_h *g,\n"
18539 " const char *context);\n"
18545 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4172
18547 "This sets the SELinux security context of the daemon to the string "
18553 #: ../src/guestfs-actions.pod:6256 ../fish/guestfish-actions.pod:4175
18554 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18559 #: ../src/guestfs-actions.pod:6262
18560 msgid "guestfs_setxattr"
18565 #: ../src/guestfs-actions.pod:6264
18569 " guestfs_setxattr (guestfs_h *g,\n"
18570 " const char *xattr,\n"
18571 " const char *val,\n"
18573 " const char *path);\n"
18579 #: ../src/guestfs-actions.pod:6271 ../fish/guestfish-actions.pod:4181
18581 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18582 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18587 #: ../src/guestfs-actions.pod:6275
18588 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18593 #: ../src/guestfs-actions.pod:6281
18594 msgid "guestfs_sfdisk"
18599 #: ../src/guestfs-actions.pod:6283
18603 " guestfs_sfdisk (guestfs_h *g,\n"
18604 " const char *device,\n"
18608 " char *const *lines);\n"
18614 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4191
18616 "This is a direct interface to the L<sfdisk(8)> program for creating "
18617 "partitions on block devices."
18622 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4194
18623 msgid "C<device> should be a block device, for example C</dev/sda>."
18628 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4196
18630 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18631 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18632 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18633 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18634 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18635 "the kernel) cannot work out the right geometry and you will need to tell it."
18640 #: ../src/guestfs-actions.pod:6304 ../fish/guestfish-actions.pod:4204
18642 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18643 "refer to the L<sfdisk(8)> manpage."
18648 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4207
18650 "To create a single partition occupying the whole disk, you would pass "
18651 "C<lines> as a single element list, when the single element being the string "
18657 #: ../src/guestfs-actions.pod:6311
18659 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18663 #: ../src/guestfs-actions.pod:6319 ../src/guestfs-actions.pod:6349
18664 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4217
18665 #: ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4262
18667 "This function is deprecated. In new code, use the C<part_add> call instead."
18672 #: ../src/guestfs-actions.pod:6328
18673 msgid "guestfs_sfdiskM"
18678 #: ../src/guestfs-actions.pod:6330
18682 " guestfs_sfdiskM (guestfs_h *g,\n"
18683 " const char *device,\n"
18684 " char *const *lines);\n"
18690 #: ../src/guestfs-actions.pod:6335
18692 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18693 "partition sizes are specified in megabytes only (rounded to the nearest "
18694 "cylinder) and you don't need to specify the cyls, heads and sectors "
18695 "parameters which were rarely if ever used anyway."
18700 #: ../src/guestfs-actions.pod:6341
18702 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18703 "C<guestfs_part_disk>"
18708 #: ../src/guestfs-actions.pod:6358
18709 msgid "guestfs_sfdisk_N"
18714 #: ../src/guestfs-actions.pod:6360
18718 " guestfs_sfdisk_N (guestfs_h *g,\n"
18719 " const char *device,\n"
18724 " const char *line);\n"
18730 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4251
18732 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18733 "(note: C<n> counts from 1)."
18738 #: ../src/guestfs-actions.pod:6372
18740 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18741 "for the cyls/heads/sectors parameters."
18746 #: ../src/guestfs-actions.pod:6375
18747 msgid "See also: C<guestfs_part_add>"
18752 #: ../src/guestfs-actions.pod:6391
18753 msgid "guestfs_sfdisk_disk_geometry"
18758 #: ../src/guestfs-actions.pod:6393
18762 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18763 " const char *device);\n"
18769 #: ../src/guestfs-actions.pod:6397
18771 "This displays the disk geometry of C<device> read from the partition table. "
18772 "Especially in the case where the underlying block device has been resized, "
18773 "this can be different from the kernel's idea of the geometry (see "
18774 "C<guestfs_sfdisk_kernel_geometry>)."
18779 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6418
18780 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4287
18781 msgid "The result is in human-readable format, and not designed to be parsed."
18786 #: ../src/guestfs-actions.pod:6410
18787 msgid "guestfs_sfdisk_kernel_geometry"
18792 #: ../src/guestfs-actions.pod:6412
18796 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18797 " const char *device);\n"
18803 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4285
18804 msgid "This displays the kernel's idea of the geometry of C<device>."
18809 #: ../src/guestfs-actions.pod:6426
18810 msgid "guestfs_sfdisk_l"
18815 #: ../src/guestfs-actions.pod:6428
18819 " guestfs_sfdisk_l (guestfs_h *g,\n"
18820 " const char *device);\n"
18826 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4294
18828 "This displays the partition table on C<device>, in the human-readable output "
18829 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18834 #: ../src/guestfs-actions.pod:6436
18835 msgid "See also: C<guestfs_part_list>"
18839 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4300
18841 "This function is deprecated. In new code, use the C<part_list> call instead."
18846 #: ../src/guestfs-actions.pod:6450
18852 #: ../src/guestfs-actions.pod:6452
18856 " guestfs_sh (guestfs_h *g,\n"
18857 " const char *command);\n"
18863 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4311
18865 "This call runs a command from the guest filesystem via the guest's C</bin/"
18871 #: ../src/guestfs-actions.pod:6459
18872 msgid "This is like C<guestfs_command>, but passes the command to:"
18877 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4316
18880 " /bin/sh -c \"command\"\n"
18886 #: ../src/guestfs-actions.pod:6463 ../fish/guestfish-actions.pod:4318
18888 "Depending on the guest's shell, this usually results in wildcards being "
18889 "expanded, shell expressions being interpolated and so on."
18894 #: ../src/guestfs-actions.pod:6467
18895 msgid "All the provisos about C<guestfs_command> apply to this call."
18900 #: ../src/guestfs-actions.pod:6474
18901 msgid "guestfs_sh_lines"
18906 #: ../src/guestfs-actions.pod:6476
18910 " guestfs_sh_lines (guestfs_h *g,\n"
18911 " const char *command);\n"
18917 #: ../src/guestfs-actions.pod:6480
18919 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18925 #: ../src/guestfs-actions.pod:6483
18926 msgid "See also: C<guestfs_command_lines>"
18931 #: ../src/guestfs-actions.pod:6491
18932 msgid "guestfs_sleep"
18937 #: ../src/guestfs-actions.pod:6493
18941 " guestfs_sleep (guestfs_h *g,\n"
18948 #: ../src/guestfs-actions.pod:6497 ../fish/guestfish-actions.pod:4337
18949 msgid "Sleep for C<secs> seconds."
18954 #: ../src/guestfs-actions.pod:6501
18955 msgid "(Added in 1.0.41)"
18960 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-structs.pod:109
18961 msgid "guestfs_stat"
18966 #: ../src/guestfs-actions.pod:6505
18969 " struct guestfs_stat *\n"
18970 " guestfs_stat (guestfs_h *g,\n"
18971 " const char *path);\n"
18977 #: ../src/guestfs-actions.pod:6511 ../fish/guestfish-actions.pod:4345
18978 msgid "This is the same as the C<stat(2)> system call."
18983 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-structs.pod:135
18984 msgid "guestfs_statvfs"
18989 #: ../src/guestfs-actions.pod:6521
18992 " struct guestfs_statvfs *\n"
18993 " guestfs_statvfs (guestfs_h *g,\n"
18994 " const char *path);\n"
19000 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4351
19002 "Returns file system statistics for any mounted file system. C<path> should "
19003 "be a file or directory in the mounted file system (typically it is the mount "
19004 "point itself, but it doesn't need to be)."
19009 #: ../src/guestfs-actions.pod:6529 ../fish/guestfish-actions.pod:4355
19010 msgid "This is the same as the C<statvfs(2)> system call."
19015 #: ../src/guestfs-actions.pod:6531
19017 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
19018 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
19023 #: ../src/guestfs-actions.pod:6537
19024 msgid "guestfs_strings"
19029 #: ../src/guestfs-actions.pod:6539
19033 " guestfs_strings (guestfs_h *g,\n"
19034 " const char *path);\n"
19040 #: ../src/guestfs-actions.pod:6543 ../fish/guestfish-actions.pod:4361
19042 "This runs the L<strings(1)> command on a file and returns the list of "
19043 "printable strings found."
19048 #: ../src/guestfs-actions.pod:6555
19049 msgid "guestfs_strings_e"
19054 #: ../src/guestfs-actions.pod:6557
19058 " guestfs_strings_e (guestfs_h *g,\n"
19059 " const char *encoding,\n"
19060 " const char *path);\n"
19066 #: ../src/guestfs-actions.pod:6562
19068 "This is like the C<guestfs_strings> command, but allows you to specify the "
19069 "encoding of strings that are looked for in the source file C<path>."
19074 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4375
19075 msgid "Allowed encodings are:"
19080 #: ../src/guestfs-actions.pod:6570 ../fish/guestfish-actions.pod:4379
19086 #: ../src/guestfs-actions.pod:6572
19088 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
19089 "ISO-8859-X (this is what C<guestfs_strings> uses)."
19094 #: ../src/guestfs-actions.pod:6575 ../fish/guestfish-actions.pod:4384
19100 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4386
19101 msgid "Single 8-bit-byte characters."
19106 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4388
19112 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4390
19113 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
19118 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4393
19119 msgid "l (lower case letter L)"
19124 #: ../src/guestfs-actions.pod:6586 ../fish/guestfish-actions.pod:4395
19126 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
19127 "examining binaries in Windows guests."
19132 #: ../src/guestfs-actions.pod:6589 ../fish/guestfish-actions.pod:4398
19138 #: ../src/guestfs-actions.pod:6591 ../fish/guestfish-actions.pod:4400
19139 msgid "32-bit big endian such as UCS-4BE."
19144 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4402
19150 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4404
19151 msgid "32-bit little endian such as UCS-4LE."
19156 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4408
19157 msgid "The returned strings are transcoded to UTF-8."
19162 #: ../src/guestfs-actions.pod:6610
19163 msgid "guestfs_swapoff_device"
19168 #: ../src/guestfs-actions.pod:6612
19172 " guestfs_swapoff_device (guestfs_h *g,\n"
19173 " const char *device);\n"
19179 #: ../src/guestfs-actions.pod:6616
19181 "This command disables the libguestfs appliance swap device or partition "
19182 "named C<device>. See C<guestfs_swapon_device>."
19187 #: ../src/guestfs-actions.pod:6624
19188 msgid "guestfs_swapoff_file"
19193 #: ../src/guestfs-actions.pod:6626
19197 " guestfs_swapoff_file (guestfs_h *g,\n"
19198 " const char *file);\n"
19204 #: ../src/guestfs-actions.pod:6630 ../fish/guestfish-actions.pod:4425
19205 msgid "This command disables the libguestfs appliance swap on file."
19210 #: ../src/guestfs-actions.pod:6636
19211 msgid "guestfs_swapoff_label"
19216 #: ../src/guestfs-actions.pod:6638
19220 " guestfs_swapoff_label (guestfs_h *g,\n"
19221 " const char *label);\n"
19227 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4431
19229 "This command disables the libguestfs appliance swap on labeled swap "
19235 #: ../src/guestfs-actions.pod:6649
19236 msgid "guestfs_swapoff_uuid"
19241 #: ../src/guestfs-actions.pod:6651
19245 " guestfs_swapoff_uuid (guestfs_h *g,\n"
19246 " const char *uuid);\n"
19252 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4438
19254 "This command disables the libguestfs appliance swap partition with the given "
19260 #: ../src/guestfs-actions.pod:6662
19261 msgid "guestfs_swapon_device"
19266 #: ../src/guestfs-actions.pod:6664
19270 " guestfs_swapon_device (guestfs_h *g,\n"
19271 " const char *device);\n"
19277 #: ../src/guestfs-actions.pod:6668
19279 "This command enables the libguestfs appliance to use the swap device or "
19280 "partition named C<device>. The increased memory is made available for all "
19281 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
19286 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4450
19288 "Note that you should not swap to existing guest swap partitions unless you "
19289 "know what you are doing. They may contain hibernation information, or other "
19290 "information that the guest doesn't want you to trash. You also risk leaking "
19291 "information about the host to the guest this way. Instead, attach a new "
19292 "host device to the guest and swap on that."
19297 #: ../src/guestfs-actions.pod:6684
19298 msgid "guestfs_swapon_file"
19303 #: ../src/guestfs-actions.pod:6686
19307 " guestfs_swapon_file (guestfs_h *g,\n"
19308 " const char *file);\n"
19314 #: ../src/guestfs-actions.pod:6690
19316 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
19322 #: ../src/guestfs-actions.pod:6697
19323 msgid "guestfs_swapon_label"
19328 #: ../src/guestfs-actions.pod:6699
19332 " guestfs_swapon_label (guestfs_h *g,\n"
19333 " const char *label);\n"
19339 #: ../src/guestfs-actions.pod:6703
19341 "This command enables swap to a labeled swap partition. See "
19342 "C<guestfs_swapon_device> for other notes."
19347 #: ../src/guestfs-actions.pod:6710
19348 msgid "guestfs_swapon_uuid"
19353 #: ../src/guestfs-actions.pod:6712
19357 " guestfs_swapon_uuid (guestfs_h *g,\n"
19358 " const char *uuid);\n"
19364 #: ../src/guestfs-actions.pod:6716
19366 "This command enables swap to a swap partition with the given UUID. See "
19367 "C<guestfs_swapon_device> for other notes."
19372 #: ../src/guestfs-actions.pod:6723
19373 msgid "guestfs_sync"
19378 #: ../src/guestfs-actions.pod:6725
19382 " guestfs_sync (guestfs_h *g);\n"
19388 #: ../src/guestfs-actions.pod:6728 ../fish/guestfish-actions.pod:4482
19390 "This syncs the disk, so that any writes are flushed through to the "
19391 "underlying disk image."
19396 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4485
19398 "You should always call this if you have modified a disk image, before "
19399 "closing the handle."
19404 #: ../src/guestfs-actions.pod:6738
19405 msgid "guestfs_tail"
19410 #: ../src/guestfs-actions.pod:6740
19414 " guestfs_tail (guestfs_h *g,\n"
19415 " const char *path);\n"
19421 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4492
19423 "This command returns up to the last 10 lines of a file as a list of strings."
19428 #: ../src/guestfs-actions.pod:6756
19429 msgid "guestfs_tail_n"
19434 #: ../src/guestfs-actions.pod:6758
19438 " guestfs_tail_n (guestfs_h *g,\n"
19440 " const char *path);\n"
19446 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4502
19448 "If the parameter C<nrlines> is a positive number, this returns the last "
19449 "C<nrlines> lines of the file C<path>."
19454 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4505
19456 "If the parameter C<nrlines> is a negative number, this returns lines from "
19457 "the file C<path>, starting with the C<-nrlines>th line."
19462 #: ../src/guestfs-actions.pod:6780
19463 msgid "guestfs_tar_in"
19468 #: ../src/guestfs-actions.pod:6782
19472 " guestfs_tar_in (guestfs_h *g,\n"
19473 " const char *tarfile,\n"
19474 " const char *directory);\n"
19480 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4517
19482 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19483 "tar file) into C<directory>."
19488 #: ../src/guestfs-actions.pod:6790
19490 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19495 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:6812
19496 #: ../src/guestfs-actions.pod:6828 ../src/guestfs-actions.pod:6844
19497 msgid "(Added in 1.0.3)"
19502 #: ../src/guestfs-actions.pod:6797
19503 msgid "guestfs_tar_out"
19508 #: ../src/guestfs-actions.pod:6799
19512 " guestfs_tar_out (guestfs_h *g,\n"
19513 " const char *directory,\n"
19514 " const char *tarfile);\n"
19520 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4529
19522 "This command packs the contents of C<directory> and downloads it to local "
19528 #: ../src/guestfs-actions.pod:6807
19530 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19531 "C<guestfs_txz_out>."
19536 #: ../src/guestfs-actions.pod:6814
19537 msgid "guestfs_tgz_in"
19542 #: ../src/guestfs-actions.pod:6816
19546 " guestfs_tgz_in (guestfs_h *g,\n"
19547 " const char *tarball,\n"
19548 " const char *directory);\n"
19554 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4541
19556 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19557 "tar file) into C<directory>."
19562 #: ../src/guestfs-actions.pod:6824
19563 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19568 #: ../src/guestfs-actions.pod:6830
19569 msgid "guestfs_tgz_out"
19574 #: ../src/guestfs-actions.pod:6832
19578 " guestfs_tgz_out (guestfs_h *g,\n"
19579 " const char *directory,\n"
19580 " const char *tarball);\n"
19586 #: ../src/guestfs-actions.pod:6837 ../fish/guestfish-actions.pod:4552
19588 "This command packs the contents of C<directory> and downloads it to local "
19594 #: ../src/guestfs-actions.pod:6840
19595 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19600 #: ../src/guestfs-actions.pod:6846
19601 msgid "guestfs_touch"
19606 #: ../src/guestfs-actions.pod:6848
19610 " guestfs_touch (guestfs_h *g,\n"
19611 " const char *path);\n"
19617 #: ../src/guestfs-actions.pod:6852 ../fish/guestfish-actions.pod:4563
19619 "Touch acts like the L<touch(1)> command. It can be used to update the "
19620 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19626 #: ../src/guestfs-actions.pod:6856 ../fish/guestfish-actions.pod:4567
19628 "This command only works on regular files, and will fail on other file types "
19629 "such as directories, symbolic links, block special etc."
19634 #: ../src/guestfs-actions.pod:6863
19635 msgid "guestfs_truncate"
19640 #: ../src/guestfs-actions.pod:6865
19644 " guestfs_truncate (guestfs_h *g,\n"
19645 " const char *path);\n"
19651 #: ../src/guestfs-actions.pod:6869 ../fish/guestfish-actions.pod:4574
19653 "This command truncates C<path> to a zero-length file. The file must exist "
19659 #: ../src/guestfs-actions.pod:6876
19660 msgid "guestfs_truncate_size"
19665 #: ../src/guestfs-actions.pod:6878
19669 " guestfs_truncate_size (guestfs_h *g,\n"
19670 " const char *path,\n"
19671 " int64_t size);\n"
19677 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4581
19679 "This command truncates C<path> to size C<size> bytes. The file must exist "
19685 #: ../src/guestfs-actions.pod:6886
19687 "If the current file size is less than C<size> then the file is extended to "
19688 "the required size with zero bytes. This creates a sparse file (ie. disk "
19689 "blocks are not allocated for the file until you write to it). To create a "
19690 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19695 #: ../src/guestfs-actions.pod:6896
19696 msgid "guestfs_tune2fs_l"
19701 #: ../src/guestfs-actions.pod:6898
19705 " guestfs_tune2fs_l (guestfs_h *g,\n"
19706 " const char *device);\n"
19712 #: ../src/guestfs-actions.pod:6902 ../fish/guestfish-actions.pod:4594
19714 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19720 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:4597
19722 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19723 "for more details. The list of fields returned isn't clearly defined, and "
19724 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19725 "and the filesystem itself."
19730 #: ../src/guestfs-actions.pod:6918
19731 msgid "guestfs_txz_in"
19736 #: ../src/guestfs-actions.pod:6920
19740 " guestfs_txz_in (guestfs_h *g,\n"
19741 " const char *tarball,\n"
19742 " const char *directory);\n"
19748 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4606
19750 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19751 "tar file) into C<directory>."
19756 #: ../src/guestfs-actions.pod:6932
19757 msgid "guestfs_txz_out"
19762 #: ../src/guestfs-actions.pod:6934
19766 " guestfs_txz_out (guestfs_h *g,\n"
19767 " const char *directory,\n"
19768 " const char *tarball);\n"
19774 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4615
19776 "This command packs the contents of C<directory> and downloads it to local "
19777 "file C<tarball> (as an xz compressed tar archive)."
19782 #: ../src/guestfs-actions.pod:6946
19783 msgid "guestfs_umask"
19788 #: ../src/guestfs-actions.pod:6948
19792 " guestfs_umask (guestfs_h *g,\n"
19799 #: ../src/guestfs-actions.pod:6952 ../fish/guestfish-actions.pod:4624
19801 "This function sets the mask used for creating new files and device nodes to "
19807 #: ../src/guestfs-actions.pod:6955 ../fish/guestfish-actions.pod:4627
19809 "Typical umask values would be C<022> which creates new files with "
19810 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19811 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19816 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4632
19818 "The default umask is C<022>. This is important because it means that "
19819 "directories and device nodes will be created with C<0644> or C<0755> mode "
19820 "even if you specify C<0777>."
19825 #: ../src/guestfs-actions.pod:6964
19827 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19828 "C<guestfs_mkdir>."
19833 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4639
19834 msgid "This call returns the previous umask."
19839 #: ../src/guestfs-actions.pod:6973
19840 msgid "guestfs_umount"
19845 #: ../src/guestfs-actions.pod:6975
19849 " guestfs_umount (guestfs_h *g,\n"
19850 " const char *pathordevice);\n"
19856 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4647
19858 "This unmounts the given filesystem. The filesystem may be specified either "
19859 "by its mountpoint (path) or the device which contains the filesystem."
19864 #: ../src/guestfs-actions.pod:6987
19865 msgid "guestfs_umount_all"
19870 #: ../src/guestfs-actions.pod:6989
19874 " guestfs_umount_all (guestfs_h *g);\n"
19880 #: ../src/guestfs-actions.pod:6992 ../fish/guestfish-actions.pod:4657
19881 msgid "This unmounts all mounted filesystems."
19886 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4659
19887 msgid "Some internal mounts are not unmounted by this call."
19892 #: ../src/guestfs-actions.pod:7000
19893 msgid "guestfs_upload"
19898 #: ../src/guestfs-actions.pod:7002
19902 " guestfs_upload (guestfs_h *g,\n"
19903 " const char *filename,\n"
19904 " const char *remotefilename);\n"
19910 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7031
19911 #: ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4678
19912 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19917 #: ../src/guestfs-actions.pod:7012
19918 msgid "See also C<guestfs_download>."
19923 #: ../src/guestfs-actions.pod:7023
19924 msgid "guestfs_upload_offset"
19929 #: ../src/guestfs-actions.pod:7025
19933 " guestfs_upload_offset (guestfs_h *g,\n"
19934 " const char *filename,\n"
19935 " const char *remotefilename,\n"
19936 " int64_t offset);\n"
19942 #: ../src/guestfs-actions.pod:7034 ../fish/guestfish-actions.pod:4681
19944 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19945 "The intention is to overwrite parts of existing files or devices, although "
19946 "if a non-existant file is specified then it is created with a \"hole\" "
19947 "before C<offset>. The size of the data written is implicit in the size of "
19948 "the source C<filename>."
19953 #: ../src/guestfs-actions.pod:7041
19955 "Note that there is no limit on the amount of data that can be uploaded with "
19956 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19957 "full amount unless an error occurs."
19962 #: ../src/guestfs-actions.pod:7046
19963 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19968 #: ../src/guestfs-actions.pod:7057
19969 msgid "guestfs_utimens"
19974 #: ../src/guestfs-actions.pod:7059
19978 " guestfs_utimens (guestfs_h *g,\n"
19979 " const char *path,\n"
19980 " int64_t atsecs,\n"
19981 " int64_t atnsecs,\n"
19982 " int64_t mtsecs,\n"
19983 " int64_t mtnsecs);\n"
19989 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4701
19990 msgid "This command sets the timestamps of a file with nanosecond precision."
19995 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4704
19997 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
20003 #: ../src/guestfs-actions.pod:7073 ../fish/guestfish-actions.pod:4707
20005 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
20006 "nanoseconds from the epoch."
20011 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4710
20013 "If the C<*nsecs> field contains the special value C<-1> then the "
20014 "corresponding timestamp is set to the current time. (The C<*secs> field is "
20015 "ignored in this case)."
20020 #: ../src/guestfs-actions.pod:7080 ../fish/guestfish-actions.pod:4714
20022 "If the C<*nsecs> field contains the special value C<-2> then the "
20023 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
20029 #: ../src/guestfs-actions.pod:7088 ../src/guestfs-structs.pod:175
20030 msgid "guestfs_version"
20035 #: ../src/guestfs-actions.pod:7090
20038 " struct guestfs_version *\n"
20039 " guestfs_version (guestfs_h *g);\n"
20045 #: ../src/guestfs-actions.pod:7093 ../fish/guestfish-actions.pod:4722
20047 "Return the libguestfs version number that the program is linked against."
20052 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4725
20054 "Note that because of dynamic linking this is not necessarily the version of "
20055 "libguestfs that you compiled against. You can compile the program, and then "
20056 "at runtime dynamically link against a completely different C<libguestfs.so> "
20062 #: ../src/guestfs-actions.pod:7101 ../fish/guestfish-actions.pod:4730
20064 "This call was added in version C<1.0.58>. In previous versions of "
20065 "libguestfs there was no way to get the version number. From C code you can "
20066 "use dynamic linker functions to find out if this symbol exists (if it "
20067 "doesn't, then it's an earlier version)."
20072 #: ../src/guestfs-actions.pod:7107 ../fish/guestfish-actions.pod:4736
20074 "The call returns a structure with four elements. The first three (C<major>, "
20075 "C<minor> and C<release>) are numbers and correspond to the usual version "
20076 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
20077 "but may be used for distro-specific information."
20082 #: ../src/guestfs-actions.pod:7113 ../fish/guestfish-actions.pod:4742
20084 "To construct the original version string: C<$major.$minor.$release$extra>"
20089 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4745
20090 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
20095 #: ../src/guestfs-actions.pod:7118
20097 "I<Note:> Don't use this call to test for availability of features. In "
20098 "enterprise distributions we backport features from later versions into "
20099 "earlier versions, making this an unreliable way to test for features. Use "
20100 "C<guestfs_available> instead."
20105 #: ../src/guestfs-actions.pod:7124
20107 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
20108 "error. I<The caller must call C<guestfs_free_version> after use>."
20113 #: ../src/guestfs-actions.pod:7128
20114 msgid "(Added in 1.0.58)"
20119 #: ../src/guestfs-actions.pod:7130
20120 msgid "guestfs_vfs_label"
20125 #: ../src/guestfs-actions.pod:7132
20129 " guestfs_vfs_label (guestfs_h *g,\n"
20130 " const char *device);\n"
20136 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4757
20137 msgid "This returns the filesystem label of the filesystem on C<device>."
20142 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4760
20143 msgid "If the filesystem is unlabeled, this returns the empty string."
20148 #: ../src/guestfs-actions.pod:7141
20149 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
20154 #: ../src/guestfs-actions.pod:7146 ../src/guestfs-actions.pod:7183
20155 msgid "(Added in 1.3.18)"
20160 #: ../src/guestfs-actions.pod:7148
20161 msgid "guestfs_vfs_type"
20166 #: ../src/guestfs-actions.pod:7150
20170 " guestfs_vfs_type (guestfs_h *g,\n"
20171 " const char *device);\n"
20177 #: ../src/guestfs-actions.pod:7154 ../fish/guestfish-actions.pod:4768
20179 "This command gets the filesystem type corresponding to the filesystem on "
20185 #: ../src/guestfs-actions.pod:7157 ../fish/guestfish-actions.pod:4771
20187 "For most filesystems, the result is the name of the Linux VFS module which "
20188 "would be used to mount this filesystem if you mounted it without specifying "
20189 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
20194 #: ../src/guestfs-actions.pod:7167
20195 msgid "guestfs_vfs_uuid"
20200 #: ../src/guestfs-actions.pod:7169
20204 " guestfs_vfs_uuid (guestfs_h *g,\n"
20205 " const char *device);\n"
20211 #: ../src/guestfs-actions.pod:7173 ../fish/guestfish-actions.pod:4780
20212 msgid "This returns the filesystem UUID of the filesystem on C<device>."
20217 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4783
20218 msgid "If the filesystem does not have a UUID, this returns the empty string."
20223 #: ../src/guestfs-actions.pod:7178
20224 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
20229 #: ../src/guestfs-actions.pod:7185
20230 msgid "guestfs_vg_activate"
20235 #: ../src/guestfs-actions.pod:7187
20239 " guestfs_vg_activate (guestfs_h *g,\n"
20241 " char *const *volgroups);\n"
20247 #: ../src/guestfs-actions.pod:7192 ../fish/guestfish-actions.pod:4791
20249 "This command activates or (if C<activate> is false) deactivates all logical "
20250 "volumes in the listed volume groups C<volgroups>. If activated, then they "
20251 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
20252 "deactivated, then those devices disappear."
20257 #: ../src/guestfs-actions.pod:7198 ../fish/guestfish-actions.pod:4797
20258 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
20263 #: ../src/guestfs-actions.pod:7200 ../fish/guestfish-actions.pod:4799
20265 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
20266 "activated or deactivated."
20271 #: ../src/guestfs-actions.pod:7207
20272 msgid "guestfs_vg_activate_all"
20277 #: ../src/guestfs-actions.pod:7209
20281 " guestfs_vg_activate_all (guestfs_h *g,\n"
20282 " int activate);\n"
20288 #: ../src/guestfs-actions.pod:7213 ../fish/guestfish-actions.pod:4806
20290 "This command activates or (if C<activate> is false) deactivates all logical "
20291 "volumes in all volume groups. If activated, then they are made known to the "
20292 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
20293 "those devices disappear."
20298 #: ../src/guestfs-actions.pod:7219 ../fish/guestfish-actions.pod:4812
20299 msgid "This command is the same as running C<vgchange -a y|n>"
20304 #: ../src/guestfs-actions.pod:7225
20305 msgid "guestfs_vgcreate"
20310 #: ../src/guestfs-actions.pod:7227
20314 " guestfs_vgcreate (guestfs_h *g,\n"
20315 " const char *volgroup,\n"
20316 " char *const *physvols);\n"
20322 #: ../src/guestfs-actions.pod:7232 ../fish/guestfish-actions.pod:4818
20324 "This creates an LVM volume group called C<volgroup> from the non-empty list "
20325 "of physical volumes C<physvols>."
20330 #: ../src/guestfs-actions.pod:7239
20331 msgid "guestfs_vglvuuids"
20336 #: ../src/guestfs-actions.pod:7241
20340 " guestfs_vglvuuids (guestfs_h *g,\n"
20341 " const char *vgname);\n"
20347 #: ../src/guestfs-actions.pod:7245 ../fish/guestfish-actions.pod:4825
20349 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20350 "volumes created in this volume group."
20355 #: ../src/guestfs-actions.pod:7248
20357 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20358 "associate logical volumes and volume groups."
20363 #: ../src/guestfs-actions.pod:7251
20364 msgid "See also C<guestfs_vgpvuuids>."
20369 #: ../src/guestfs-actions.pod:7259
20370 msgid "guestfs_vgpvuuids"
20375 #: ../src/guestfs-actions.pod:7261
20379 " guestfs_vgpvuuids (guestfs_h *g,\n"
20380 " const char *vgname);\n"
20386 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:4837
20388 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20389 "volumes that this volume group resides on."
20394 #: ../src/guestfs-actions.pod:7268
20396 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20397 "associate physical volumes and volume groups."
20402 #: ../src/guestfs-actions.pod:7271
20403 msgid "See also C<guestfs_vglvuuids>."
20408 #: ../src/guestfs-actions.pod:7279
20409 msgid "guestfs_vgremove"
20414 #: ../src/guestfs-actions.pod:7281
20418 " guestfs_vgremove (guestfs_h *g,\n"
20419 " const char *vgname);\n"
20425 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4849
20426 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20431 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4851
20433 "This also forcibly removes all logical volumes in the volume group (if any)."
20438 #: ../src/guestfs-actions.pod:7294
20439 msgid "guestfs_vgrename"
20444 #: ../src/guestfs-actions.pod:7296
20448 " guestfs_vgrename (guestfs_h *g,\n"
20449 " const char *volgroup,\n"
20450 " const char *newvolgroup);\n"
20456 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4858
20457 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20462 #: ../src/guestfs-actions.pod:7307
20463 msgid "guestfs_vgs"
20468 #: ../src/guestfs-actions.pod:7309
20472 " guestfs_vgs (guestfs_h *g);\n"
20478 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4864
20480 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20486 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:4867
20488 "This returns a list of just the volume group names that were detected (eg. "
20494 #: ../src/guestfs-actions.pod:7318
20495 msgid "See also C<guestfs_vgs_full>."
20500 #: ../src/guestfs-actions.pod:7326
20501 msgid "guestfs_vgs_full"
20506 #: ../src/guestfs-actions.pod:7328
20509 " struct guestfs_lvm_vg_list *\n"
20510 " guestfs_vgs_full (guestfs_h *g);\n"
20516 #: ../src/guestfs-actions.pod:7331 ../fish/guestfish-actions.pod:4876
20518 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20519 "> command. The \"full\" version includes all fields."
20524 #: ../src/guestfs-actions.pod:7334
20526 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20527 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20532 #: ../src/guestfs-actions.pod:7340
20533 msgid "guestfs_vgscan"
20538 #: ../src/guestfs-actions.pod:7342
20542 " guestfs_vgscan (guestfs_h *g);\n"
20548 #: ../src/guestfs-actions.pod:7345 ../fish/guestfish-actions.pod:4883
20550 "This rescans all block devices and rebuilds the list of LVM physical "
20551 "volumes, volume groups and logical volumes."
20556 #: ../src/guestfs-actions.pod:7352
20557 msgid "guestfs_vguuid"
20562 #: ../src/guestfs-actions.pod:7354
20566 " guestfs_vguuid (guestfs_h *g,\n"
20567 " const char *vgname);\n"
20573 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:4890
20574 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20579 #: ../src/guestfs-actions.pod:7365
20580 msgid "guestfs_wait_ready"
20585 #: ../src/guestfs-actions.pod:7367
20589 " guestfs_wait_ready (guestfs_h *g);\n"
20595 #: ../src/guestfs-actions.pod:7370
20596 msgid "This function is a no op."
20601 #: ../src/guestfs-actions.pod:7372
20603 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20604 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20605 "is no longer necessary because C<guestfs_launch> now does the waiting."
20610 #: ../src/guestfs-actions.pod:7377
20612 "If you see any calls to this function in code then you can just remove them, "
20613 "unless you want to retain compatibility with older versions of the API."
20617 #: ../src/guestfs-actions.pod:7383
20619 "This function is deprecated. In new code, use the C<launch> call instead."
20624 #: ../src/guestfs-actions.pod:7392
20625 msgid "guestfs_wc_c"
20630 #: ../src/guestfs-actions.pod:7394
20634 " guestfs_wc_c (guestfs_h *g,\n"
20635 " const char *path);\n"
20641 #: ../src/guestfs-actions.pod:7398 ../fish/guestfish-actions.pod:4896
20643 "This command counts the characters in a file, using the C<wc -c> external "
20649 #: ../src/guestfs-actions.pod:7405
20650 msgid "guestfs_wc_l"
20655 #: ../src/guestfs-actions.pod:7407
20659 " guestfs_wc_l (guestfs_h *g,\n"
20660 " const char *path);\n"
20666 #: ../src/guestfs-actions.pod:7411 ../fish/guestfish-actions.pod:4903
20668 "This command counts the lines in a file, using the C<wc -l> external command."
20673 #: ../src/guestfs-actions.pod:7418
20674 msgid "guestfs_wc_w"
20679 #: ../src/guestfs-actions.pod:7420
20683 " guestfs_wc_w (guestfs_h *g,\n"
20684 " const char *path);\n"
20690 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4910
20692 "This command counts the words in a file, using the C<wc -w> external command."
20697 #: ../src/guestfs-actions.pod:7431
20698 msgid "guestfs_write"
20703 #: ../src/guestfs-actions.pod:7433
20707 " guestfs_write (guestfs_h *g,\n"
20708 " const char *path,\n"
20709 " const char *content,\n"
20710 " size_t content_size);\n"
20716 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4917
20718 "This call creates a file called C<path>. The content of the file is the "
20719 "string C<content> (which can contain any 8 bit data)."
20724 #: ../src/guestfs-actions.pod:7449
20725 msgid "guestfs_write_file"
20730 #: ../src/guestfs-actions.pod:7451
20734 " guestfs_write_file (guestfs_h *g,\n"
20735 " const char *path,\n"
20736 " const char *content,\n"
20743 #: ../src/guestfs-actions.pod:7457 ../fish/guestfish-actions.pod:4927
20745 "This call creates a file called C<path>. The contents of the file is the "
20746 "string C<content> (which can contain any 8 bit data), with length C<size>."
20751 #: ../src/guestfs-actions.pod:7461 ../fish/guestfish-actions.pod:4931
20753 "As a special case, if C<size> is C<0> then the length is calculated using "
20754 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20759 #: ../src/guestfs-actions.pod:7465 ../fish/guestfish-actions.pod:4935
20761 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20762 "I<not> work, even if the length is specified."
20767 #: ../src/guestfs-actions.pod:7473 ../fish/guestfish-actions.pod:4941
20769 "This function is deprecated. In new code, use the C<write> call instead."
20774 #: ../src/guestfs-actions.pod:7482
20775 msgid "guestfs_zegrep"
20780 #: ../src/guestfs-actions.pod:7484
20784 " guestfs_zegrep (guestfs_h *g,\n"
20785 " const char *regex,\n"
20786 " const char *path);\n"
20792 #: ../src/guestfs-actions.pod:7489 ../fish/guestfish-actions.pod:4952
20794 "This calls the external C<zegrep> program and returns the matching lines."
20799 #: ../src/guestfs-actions.pod:7501
20800 msgid "guestfs_zegrepi"
20805 #: ../src/guestfs-actions.pod:7503
20809 " guestfs_zegrepi (guestfs_h *g,\n"
20810 " const char *regex,\n"
20811 " const char *path);\n"
20817 #: ../src/guestfs-actions.pod:7508 ../fish/guestfish-actions.pod:4962
20819 "This calls the external C<zegrep -i> program and returns the matching lines."
20824 #: ../src/guestfs-actions.pod:7520
20825 msgid "guestfs_zero"
20830 #: ../src/guestfs-actions.pod:7522
20834 " guestfs_zero (guestfs_h *g,\n"
20835 " const char *device);\n"
20841 #: ../src/guestfs-actions.pod:7526 ../fish/guestfish-actions.pod:4972
20842 msgid "This command writes zeroes over the first few blocks of C<device>."
20847 #: ../src/guestfs-actions.pod:7528 ../fish/guestfish-actions.pod:4974
20849 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20850 "securely wipe the device). It should be sufficient to remove any partition "
20851 "tables, filesystem superblocks and so on."
20855 #: ../src/guestfs-actions.pod:7532
20857 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
20858 "C<guestfs_is_zero_device>"
20863 #: ../src/guestfs-actions.pod:7544
20864 msgid "guestfs_zero_device"
20869 #: ../src/guestfs-actions.pod:7546
20873 " guestfs_zero_device (guestfs_h *g,\n"
20874 " const char *device);\n"
20880 #: ../src/guestfs-actions.pod:7550
20882 "This command writes zeroes over the entire C<device>. Compare with "
20883 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20888 #: ../src/guestfs-actions.pod:7564
20889 msgid "(Added in 1.3.1)"
20894 #: ../src/guestfs-actions.pod:7566
20895 msgid "guestfs_zerofree"
20900 #: ../src/guestfs-actions.pod:7568
20904 " guestfs_zerofree (guestfs_h *g,\n"
20905 " const char *device);\n"
20911 #: ../src/guestfs-actions.pod:7572 ../fish/guestfish-actions.pod:4996
20913 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20914 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20915 "possible to compress the filesystem more effectively."
20920 #: ../src/guestfs-actions.pod:7577 ../fish/guestfish-actions.pod:5001
20921 msgid "You should B<not> run this program if the filesystem is mounted."
20926 #: ../src/guestfs-actions.pod:7580 ../fish/guestfish-actions.pod:5004
20928 "It is possible that using this program can damage the filesystem or data on "
20934 #: ../src/guestfs-actions.pod:7587
20935 msgid "guestfs_zfgrep"
20940 #: ../src/guestfs-actions.pod:7589
20944 " guestfs_zfgrep (guestfs_h *g,\n"
20945 " const char *pattern,\n"
20946 " const char *path);\n"
20952 #: ../src/guestfs-actions.pod:7594 ../fish/guestfish-actions.pod:5011
20954 "This calls the external C<zfgrep> program and returns the matching lines."
20959 #: ../src/guestfs-actions.pod:7606
20960 msgid "guestfs_zfgrepi"
20965 #: ../src/guestfs-actions.pod:7608
20969 " guestfs_zfgrepi (guestfs_h *g,\n"
20970 " const char *pattern,\n"
20971 " const char *path);\n"
20977 #: ../src/guestfs-actions.pod:7613 ../fish/guestfish-actions.pod:5021
20979 "This calls the external C<zfgrep -i> program and returns the matching lines."
20984 #: ../src/guestfs-actions.pod:7625
20985 msgid "guestfs_zfile"
20990 #: ../src/guestfs-actions.pod:7627
20994 " guestfs_zfile (guestfs_h *g,\n"
20995 " const char *meth,\n"
20996 " const char *path);\n"
21002 #: ../src/guestfs-actions.pod:7632 ../fish/guestfish-actions.pod:5031
21004 "This command runs C<file> after first decompressing C<path> using C<method>."
21009 #: ../src/guestfs-actions.pod:7635 ../fish/guestfish-actions.pod:5034
21010 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
21015 #: ../src/guestfs-actions.pod:7637
21017 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
21023 #: ../src/guestfs-actions.pod:7643 ../fish/guestfish-actions.pod:5039
21025 "This function is deprecated. In new code, use the C<file> call instead."
21030 #: ../src/guestfs-actions.pod:7652
21031 msgid "guestfs_zgrep"
21036 #: ../src/guestfs-actions.pod:7654
21040 " guestfs_zgrep (guestfs_h *g,\n"
21041 " const char *regex,\n"
21042 " const char *path);\n"
21048 #: ../src/guestfs-actions.pod:7659 ../fish/guestfish-actions.pod:5050
21050 "This calls the external C<zgrep> program and returns the matching lines."
21055 #: ../src/guestfs-actions.pod:7671
21056 msgid "guestfs_zgrepi"
21061 #: ../src/guestfs-actions.pod:7673
21065 " guestfs_zgrepi (guestfs_h *g,\n"
21066 " const char *regex,\n"
21067 " const char *path);\n"
21073 #: ../src/guestfs-actions.pod:7678 ../fish/guestfish-actions.pod:5060
21075 "This calls the external C<zgrep -i> program and returns the matching lines."
21080 #: ../src/guestfs-availability.pod:3
21086 #: ../src/guestfs-availability.pod:5
21088 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
21089 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
21090 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
21091 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
21092 "L</guestfs_aug_save> L</guestfs_aug_set>"
21097 #: ../src/guestfs-availability.pod:21
21103 #: ../src/guestfs-availability.pod:23
21105 "The following functions: L</guestfs_inotify_add_watch> L</"
21106 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
21107 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
21112 #: ../src/guestfs-availability.pod:31
21113 msgid "B<linuxfsuuid>"
21118 #: ../src/guestfs-availability.pod:33
21120 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
21121 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
21126 #: ../src/guestfs-availability.pod:40
21127 msgid "B<linuxmodules>"
21132 #: ../src/guestfs-availability.pod:42
21133 msgid "The following functions: L</guestfs_modprobe>"
21138 #: ../src/guestfs-availability.pod:45
21139 msgid "B<linuxxattrs>"
21144 #: ../src/guestfs-availability.pod:47
21146 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
21147 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
21148 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
21149 "guestfs_setxattr>"
21154 #: ../src/guestfs-availability.pod:58
21160 #: ../src/guestfs-availability.pod:60
21162 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
21163 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
21164 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
21169 #: ../src/guestfs-availability.pod:69
21175 #: ../src/guestfs-availability.pod:71
21177 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
21178 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
21179 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
21180 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
21181 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
21182 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
21183 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
21188 #: ../src/guestfs-availability.pod:94
21194 #: ../src/guestfs-availability.pod:96
21196 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
21197 "guestfs_mknod_b> L</guestfs_mknod_c>"
21202 #: ../src/guestfs-availability.pod:102
21208 #: ../src/guestfs-availability.pod:104
21209 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
21214 #: ../src/guestfs-availability.pod:107
21215 msgid "B<ntfsprogs>"
21220 #: ../src/guestfs-availability.pod:109
21222 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
21227 #: ../src/guestfs-availability.pod:113
21228 msgid "B<realpath>"
21233 #: ../src/guestfs-availability.pod:115
21234 msgid "The following functions: L</guestfs_realpath>"
21239 #: ../src/guestfs-availability.pod:118
21245 #: ../src/guestfs-availability.pod:120
21247 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
21248 "guestfs_scrub_freespace>"
21253 #: ../src/guestfs-availability.pod:125
21259 #: ../src/guestfs-availability.pod:127
21260 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
21265 #: ../src/guestfs-availability.pod:131
21271 #: ../src/guestfs-availability.pod:133
21272 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
21277 #: ../src/guestfs-availability.pod:137
21278 msgid "B<zerofree>"
21283 #: ../src/guestfs-availability.pod:139
21284 msgid "The following functions: L</guestfs_zerofree>"
21289 #: ../src/guestfs-structs.pod:1
21290 msgid "guestfs_int_bool"
21295 #: ../src/guestfs-structs.pod:3
21298 " struct guestfs_int_bool {\n"
21307 #: ../src/guestfs-structs.pod:8
21310 " struct guestfs_int_bool_list {\n"
21311 " uint32_t len; /* Number of elements in list. */\n"
21312 " struct guestfs_int_bool *val; /* Elements. */\n"
21319 #: ../src/guestfs-structs.pod:13
21322 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
21323 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
21329 #: ../src/guestfs-structs.pod:16
21330 msgid "guestfs_lvm_pv"
21335 #: ../src/guestfs-structs.pod:18
21338 " struct guestfs_lvm_pv {\n"
21339 " char *pv_name;\n"
21340 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21341 " char pv_uuid[32];\n"
21343 " uint64_t pv_size;\n"
21344 " uint64_t dev_size;\n"
21345 " uint64_t pv_free;\n"
21346 " uint64_t pv_used;\n"
21347 " char *pv_attr;\n"
21348 " int64_t pv_pe_count;\n"
21349 " int64_t pv_pe_alloc_count;\n"
21350 " char *pv_tags;\n"
21351 " uint64_t pe_start;\n"
21352 " int64_t pv_mda_count;\n"
21353 " uint64_t pv_mda_free;\n"
21360 #: ../src/guestfs-structs.pod:36
21363 " struct guestfs_lvm_pv_list {\n"
21364 " uint32_t len; /* Number of elements in list. */\n"
21365 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21372 #: ../src/guestfs-structs.pod:41
21375 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21376 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21382 #: ../src/guestfs-structs.pod:44
21383 msgid "guestfs_lvm_vg"
21388 #: ../src/guestfs-structs.pod:46
21391 " struct guestfs_lvm_vg {\n"
21392 " char *vg_name;\n"
21393 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21394 " char vg_uuid[32];\n"
21396 " char *vg_attr;\n"
21397 " uint64_t vg_size;\n"
21398 " uint64_t vg_free;\n"
21399 " char *vg_sysid;\n"
21400 " uint64_t vg_extent_size;\n"
21401 " int64_t vg_extent_count;\n"
21402 " int64_t vg_free_count;\n"
21403 " int64_t max_lv;\n"
21404 " int64_t max_pv;\n"
21405 " int64_t pv_count;\n"
21406 " int64_t lv_count;\n"
21407 " int64_t snap_count;\n"
21408 " int64_t vg_seqno;\n"
21409 " char *vg_tags;\n"
21410 " int64_t vg_mda_count;\n"
21411 " uint64_t vg_mda_free;\n"
21418 #: ../src/guestfs-structs.pod:69
21421 " struct guestfs_lvm_vg_list {\n"
21422 " uint32_t len; /* Number of elements in list. */\n"
21423 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21430 #: ../src/guestfs-structs.pod:74
21433 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21434 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21440 #: ../src/guestfs-structs.pod:77
21441 msgid "guestfs_lvm_lv"
21446 #: ../src/guestfs-structs.pod:79
21449 " struct guestfs_lvm_lv {\n"
21450 " char *lv_name;\n"
21451 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21452 " char lv_uuid[32];\n"
21453 " char *lv_attr;\n"
21454 " int64_t lv_major;\n"
21455 " int64_t lv_minor;\n"
21456 " int64_t lv_kernel_major;\n"
21457 " int64_t lv_kernel_minor;\n"
21458 " uint64_t lv_size;\n"
21459 " int64_t seg_count;\n"
21461 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21462 " float snap_percent;\n"
21463 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21464 " float copy_percent;\n"
21465 " char *move_pv;\n"
21466 " char *lv_tags;\n"
21467 " char *mirror_log;\n"
21468 " char *modules;\n"
21475 #: ../src/guestfs-structs.pod:101
21478 " struct guestfs_lvm_lv_list {\n"
21479 " uint32_t len; /* Number of elements in list. */\n"
21480 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21487 #: ../src/guestfs-structs.pod:106
21490 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21491 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21497 #: ../src/guestfs-structs.pod:111
21500 " struct guestfs_stat {\n"
21504 " int64_t nlink;\n"
21509 " int64_t blksize;\n"
21510 " int64_t blocks;\n"
21511 " int64_t atime;\n"
21512 " int64_t mtime;\n"
21513 " int64_t ctime;\n"
21520 #: ../src/guestfs-structs.pod:127
21523 " struct guestfs_stat_list {\n"
21524 " uint32_t len; /* Number of elements in list. */\n"
21525 " struct guestfs_stat *val; /* Elements. */\n"
21532 #: ../src/guestfs-structs.pod:132
21535 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21536 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21542 #: ../src/guestfs-structs.pod:137
21545 " struct guestfs_statvfs {\n"
21546 " int64_t bsize;\n"
21547 " int64_t frsize;\n"
21548 " int64_t blocks;\n"
21549 " int64_t bfree;\n"
21550 " int64_t bavail;\n"
21551 " int64_t files;\n"
21552 " int64_t ffree;\n"
21553 " int64_t favail;\n"
21556 " int64_t namemax;\n"
21563 #: ../src/guestfs-structs.pod:151
21566 " struct guestfs_statvfs_list {\n"
21567 " uint32_t len; /* Number of elements in list. */\n"
21568 " struct guestfs_statvfs *val; /* Elements. */\n"
21575 #: ../src/guestfs-structs.pod:156
21578 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21579 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21585 #: ../src/guestfs-structs.pod:159
21586 msgid "guestfs_dirent"
21591 #: ../src/guestfs-structs.pod:161
21594 " struct guestfs_dirent {\n"
21604 #: ../src/guestfs-structs.pod:167
21607 " struct guestfs_dirent_list {\n"
21608 " uint32_t len; /* Number of elements in list. */\n"
21609 " struct guestfs_dirent *val; /* Elements. */\n"
21616 #: ../src/guestfs-structs.pod:172
21619 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21620 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21626 #: ../src/guestfs-structs.pod:177
21629 " struct guestfs_version {\n"
21630 " int64_t major;\n"
21631 " int64_t minor;\n"
21632 " int64_t release;\n"
21640 #: ../src/guestfs-structs.pod:184
21643 " struct guestfs_version_list {\n"
21644 " uint32_t len; /* Number of elements in list. */\n"
21645 " struct guestfs_version *val; /* Elements. */\n"
21652 #: ../src/guestfs-structs.pod:189
21655 " void guestfs_free_version (struct guestfs_free_version *);\n"
21656 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21662 #: ../src/guestfs-structs.pod:192
21663 msgid "guestfs_xattr"
21668 #: ../src/guestfs-structs.pod:194
21671 " struct guestfs_xattr {\n"
21672 " char *attrname;\n"
21673 " /* The next two fields describe a byte array. */\n"
21674 " uint32_t attrval_len;\n"
21675 " char *attrval;\n"
21682 #: ../src/guestfs-structs.pod:201
21685 " struct guestfs_xattr_list {\n"
21686 " uint32_t len; /* Number of elements in list. */\n"
21687 " struct guestfs_xattr *val; /* Elements. */\n"
21694 #: ../src/guestfs-structs.pod:206
21697 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21698 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21704 #: ../src/guestfs-structs.pod:209
21705 msgid "guestfs_inotify_event"
21710 #: ../src/guestfs-structs.pod:211
21713 " struct guestfs_inotify_event {\n"
21714 " int64_t in_wd;\n"
21715 " uint32_t in_mask;\n"
21716 " uint32_t in_cookie;\n"
21717 " char *in_name;\n"
21724 #: ../src/guestfs-structs.pod:218
21727 " struct guestfs_inotify_event_list {\n"
21728 " uint32_t len; /* Number of elements in list. */\n"
21729 " struct guestfs_inotify_event *val; /* Elements. */\n"
21736 #: ../src/guestfs-structs.pod:223
21739 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21740 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21746 #: ../src/guestfs-structs.pod:226
21747 msgid "guestfs_partition"
21752 #: ../src/guestfs-structs.pod:228
21755 " struct guestfs_partition {\n"
21756 " int32_t part_num;\n"
21757 " uint64_t part_start;\n"
21758 " uint64_t part_end;\n"
21759 " uint64_t part_size;\n"
21766 #: ../src/guestfs-structs.pod:235
21769 " struct guestfs_partition_list {\n"
21770 " uint32_t len; /* Number of elements in list. */\n"
21771 " struct guestfs_partition *val; /* Elements. */\n"
21778 #: ../src/guestfs-structs.pod:240
21781 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21782 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21788 #: ../src/guestfs-structs.pod:243
21789 msgid "guestfs_application"
21794 #: ../src/guestfs-structs.pod:245
21797 " struct guestfs_application {\n"
21798 " char *app_name;\n"
21799 " char *app_display_name;\n"
21800 " int32_t app_epoch;\n"
21801 " char *app_version;\n"
21802 " char *app_release;\n"
21803 " char *app_install_path;\n"
21804 " char *app_trans_path;\n"
21805 " char *app_publisher;\n"
21806 " char *app_url;\n"
21807 " char *app_source_package;\n"
21808 " char *app_summary;\n"
21809 " char *app_description;\n"
21816 #: ../src/guestfs-structs.pod:260
21819 " struct guestfs_application_list {\n"
21820 " uint32_t len; /* Number of elements in list. */\n"
21821 " struct guestfs_application *val; /* Elements. */\n"
21828 #: ../src/guestfs-structs.pod:265
21831 " void guestfs_free_application (struct guestfs_free_application *);\n"
21832 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21838 #: ../fish/guestfish.pod:5
21839 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21844 #: ../fish/guestfish.pod:9
21847 " guestfish [--options] [commands]\n"
21853 #: ../fish/guestfish.pod:11
21862 #: ../fish/guestfish.pod:13
21865 " guestfish [--ro|--rw] -a disk.img\n"
21871 #: ../fish/guestfish.pod:15
21874 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21880 #: ../fish/guestfish.pod:17
21883 " guestfish -d libvirt-domain\n"
21889 #: ../fish/guestfish.pod:19
21892 " guestfish [--ro|--rw] -a disk.img -i\n"
21898 #: ../fish/guestfish.pod:21
21901 " guestfish -d libvirt-domain -i\n"
21907 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
21908 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21914 #: ../fish/guestfish.pod:25
21916 "Using guestfish in read/write mode on live virtual machines can be "
21917 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21918 "option to use guestfish safely if the disk image or virtual machine might be "
21924 #: ../fish/guestfish.pod:32
21926 "Guestfish is a shell and command-line tool for examining and modifying "
21927 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21928 "functionality of the guestfs API, see L<guestfs(3)>."
21933 #: ../fish/guestfish.pod:36
21935 "Guestfish gives you structured access to the libguestfs API, from shell "
21936 "scripts or the command line or interactively. If you want to rescue a "
21937 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21943 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
21944 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
21950 #: ../fish/guestfish.pod:43
21951 msgid "As an interactive shell"
21956 #: ../fish/guestfish.pod:45
21965 #: ../fish/guestfish.pod:47
21968 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21969 " editing virtual machine filesystems.\n"
21975 #: ../fish/guestfish.pod:50
21978 " Type: 'help' for a list of commands\n"
21979 " 'man' to read the manual\n"
21980 " 'quit' to quit the shell\n"
21986 #: ../fish/guestfish.pod:54
21989 " ><fs> add-ro disk.img\n"
21991 " ><fs> list-filesystems\n"
21992 " /dev/sda1: ext4\n"
21993 " /dev/vg_guest/lv_root: ext4\n"
21994 " /dev/vg_guest/lv_swap: swap\n"
21995 " ><fs> mount /dev/vg_guest/lv_root /\n"
21996 " ><fs> cat /etc/fstab\n"
21998 " # Created by anaconda\n"
22006 #: ../fish/guestfish.pod:67
22007 msgid "From shell scripts"
22012 #: ../fish/guestfish.pod:69
22013 msgid "Create a new C</etc/motd> file in a guest or disk image:"
22018 #: ../fish/guestfish.pod:71
22021 " guestfish <<_EOF_\n"
22024 " mount /dev/vg_guest/lv_root /\n"
22025 " write /etc/motd \"Welcome, new users\"\n"
22032 #: ../fish/guestfish.pod:78
22033 msgid "List the LVM logical volumes in a disk image:"
22038 #: ../fish/guestfish.pod:80
22041 " guestfish -a disk.img --ro <<_EOF_\n"
22050 #: ../fish/guestfish.pod:85
22051 msgid "List all the filesystems in a disk image:"
22056 #: ../fish/guestfish.pod:87
22059 " guestfish -a disk.img --ro <<_EOF_\n"
22061 " list-filesystems\n"
22068 #: ../fish/guestfish.pod:92
22069 msgid "On one command line"
22074 #: ../fish/guestfish.pod:94
22075 msgid "Update C</etc/resolv.conf> in a guest:"
22080 #: ../fish/guestfish.pod:96
22084 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
22085 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
22091 #: ../fish/guestfish.pod:100
22092 msgid "Edit C</boot/grub/grub.conf> interactively:"
22097 #: ../fish/guestfish.pod:102
22100 " guestfish --rw --add disk.img \\\n"
22101 " --mount /dev/vg_guest/lv_root \\\n"
22102 " --mount /dev/sda1:/boot \\\n"
22103 " edit /boot/grub/grub.conf\n"
22109 #: ../fish/guestfish.pod:107
22110 msgid "Mount disks automatically"
22115 #: ../fish/guestfish.pod:109
22117 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
22122 #: ../fish/guestfish.pod:112
22125 " guestfish --ro -a disk.img -i cat /etc/group\n"
22131 #: ../fish/guestfish.pod:114
22134 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
22140 #: ../fish/guestfish.pod:116
22141 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
22146 #: ../fish/guestfish.pod:118
22149 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
22155 #: ../fish/guestfish.pod:120
22156 msgid "As a script interpreter"
22161 #: ../fish/guestfish.pod:122
22162 msgid "Create a 100MB disk containing an ext2-formatted partition:"
22167 #: ../fish/guestfish.pod:124
22170 " #!/usr/bin/guestfish -f\n"
22171 " sparse test1.img 100M\n"
22173 " part-disk /dev/sda mbr\n"
22174 " mkfs ext2 /dev/sda1\n"
22180 #: ../fish/guestfish.pod:130
22181 msgid "Start with a prepared disk"
22186 #: ../fish/guestfish.pod:132
22188 "An alternate way to create a 100MB disk called C<test1.img> containing a "
22189 "single ext2-formatted partition:"
22194 #: ../fish/guestfish.pod:135
22197 " guestfish -N fs\n"
22203 #: ../fish/guestfish.pod:137
22204 msgid "To list what is available do:"
22209 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
22212 " guestfish -N help | less\n"
22218 #: ../fish/guestfish.pod:141
22219 msgid "Remote control"
22224 #: ../fish/guestfish.pod:143
22227 " eval \"`guestfish --listen`\"\n"
22228 " guestfish --remote add-ro disk.img\n"
22229 " guestfish --remote run\n"
22230 " guestfish --remote lvs\n"
22236 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
22237 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
22238 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
22239 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
22245 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
22246 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
22247 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
22248 #: ../tools/virt-list-partitions.pl:62
22254 #: ../fish/guestfish.pod:154
22255 msgid "Displays general help on options."
22260 #: ../fish/guestfish.pod:156
22266 #: ../fish/guestfish.pod:158
22267 msgid "B<--cmd-help>"
22272 #: ../fish/guestfish.pod:160
22273 msgid "Lists all available guestfish commands."
22278 #: ../fish/guestfish.pod:162
22284 #: ../fish/guestfish.pod:164
22285 msgid "B<--cmd-help cmd>"
22290 #: ../fish/guestfish.pod:166
22291 msgid "Displays detailed help on a single command C<cmd>."
22296 #: ../fish/guestfish.pod:168
22297 msgid "B<-a image>"
22302 #: ../fish/guestfish.pod:170
22303 msgid "B<--add image>"
22308 #: ../fish/guestfish.pod:172
22309 msgid "Add a block device or virtual machine image to the shell."
22314 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
22316 "The format of the disk image is auto-detected. To override this and force a "
22317 "particular format use the I<--format=..> option."
22321 #: ../fish/guestfish.pod:177
22323 "Using this flag is mostly equivalent to using the C<add> command, with "
22324 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
22325 "the I<--format=...> flag was given."
22330 #: ../fish/guestfish.pod:181
22336 #: ../fish/guestfish.pod:183
22337 msgid "B<--connect URI>"
22342 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22344 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22345 "URI to use. The default is to use the default libvirt connection."
22350 #: ../fish/guestfish.pod:189
22356 #: ../fish/guestfish.pod:191
22358 "If using the I<--listen> option and a csh-like shell, use this option. See "
22359 "section L</REMOTE CONTROL AND CSH> below."
22364 #: ../fish/guestfish.pod:194
22365 msgid "B<-d libvirt-domain>"
22370 #: ../fish/guestfish.pod:196
22371 msgid "B<--domain libvirt-domain>"
22376 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22378 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22379 "used, then any libvirt domain can be used. However in write mode, only "
22380 "libvirt domains which are shut down can be named here."
22384 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
22385 msgid "Domain UUIDs can be used instead of names."
22390 #: ../fish/guestfish.pod:204
22392 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22393 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22394 "if the I<--format:...> flag was given."
22399 #: ../fish/guestfish.pod:208
22405 #: ../fish/guestfish.pod:210
22406 msgid "B<--no-dest-paths>"
22411 #: ../fish/guestfish.pod:212
22413 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22414 "to hit the tab key to complete paths on the guest filesystem, but this "
22415 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22416 "allow this feature to be disabled."
22421 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22422 msgid "B<--echo-keys>"
22427 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
22429 "When prompting for keys and passphrases, guestfish normally turns echoing "
22430 "off so you cannot see what you are typing. If you are not worried about "
22431 "Tempest attacks and there is no one else in the room you can specify this "
22432 "flag to see what you are typing."
22437 #: ../fish/guestfish.pod:224
22443 #: ../fish/guestfish.pod:226
22444 msgid "B<--file file>"
22449 #: ../fish/guestfish.pod:228
22450 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22455 #: ../fish/guestfish.pod:231
22458 " #!/usr/bin/guestfish -f\n"
22464 #: ../fish/guestfish.pod:233
22465 msgid "B<--format=raw|qcow2|..>"
22470 #: ../fish/guestfish.pod:235
22471 msgid "B<--format>"
22476 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
22478 "The default for the I<-a> option is to auto-detect the format of the disk "
22479 "image. Using this forces the disk format for I<-a> options which follow on "
22480 "the command line. Using I<--format> with no argument switches back to auto-"
22481 "detection for subsequent I<-a> options."
22486 #: ../fish/guestfish.pod:244
22489 " guestfish --format=raw -a disk.img\n"
22495 #: ../fish/guestfish.pod:246
22496 msgid "forces raw format (no auto-detection) for C<disk.img>."
22501 #: ../fish/guestfish.pod:248
22504 " guestfish --format=raw -a disk.img --format -a another.img\n"
22510 #: ../fish/guestfish.pod:250
22512 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22513 "detection for C<another.img>."
22518 #: ../fish/guestfish.pod:253
22520 "If you have untrusted raw-format guest disk images, you should use this "
22521 "option to specify the disk format. This avoids a possible security problem "
22522 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22527 #: ../fish/guestfish.pod:258
22533 #: ../fish/guestfish.pod:260
22534 msgid "B<--inspector>"
22539 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
22541 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22542 "system and mount filesystems as they would be mounted on the real virtual "
22548 #: ../fish/guestfish.pod:266
22549 msgid "Typical usage is either:"
22554 #: ../fish/guestfish.pod:268
22557 " guestfish -d myguest -i\n"
22563 #: ../fish/guestfish.pod:270
22564 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22569 #: ../fish/guestfish.pod:272
22572 " guestfish --ro -d myguest -i\n"
22578 #: ../fish/guestfish.pod:274
22579 msgid "(for active domains, readonly), or specify the block device directly:"
22584 #: ../fish/guestfish.pod:276
22587 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22593 #: ../fish/guestfish.pod:278
22595 "Note that the command line syntax changed slightly over older versions of "
22596 "guestfish. You can still use the old syntax:"
22601 #: ../fish/guestfish.pod:281
22604 " guestfish [--ro] -i disk.img\n"
22610 #: ../fish/guestfish.pod:283
22613 " guestfish [--ro] -i libvirt-domain\n"
22619 #: ../fish/guestfish.pod:285
22621 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22622 "then using other commands to mount the filesystems that were found."
22627 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22628 msgid "B<--keys-from-stdin>"
22633 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
22635 "Read key or passphrase parameters from stdin. The default is to try to read "
22636 "passphrases from the user by opening C</dev/tty>."
22641 #: ../fish/guestfish.pod:294
22642 msgid "B<--listen>"
22647 #: ../fish/guestfish.pod:296
22649 "Fork into the background and listen for remote commands. See section L</"
22650 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22654 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22659 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
22661 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22662 "ATTACHING TO RUNNING DAEMONS>)."
22666 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22667 msgid "B<-m dev[:mountpoint[:options]]>"
22671 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
22672 msgid "B<--mount dev[:mountpoint[:options]]>"
22677 #: ../fish/guestfish.pod:308
22678 msgid "Mount the named partition or logical volume on the given mountpoint."
22683 #: ../fish/guestfish.pod:310
22684 msgid "If the mountpoint is omitted, it defaults to C</>."
22689 #: ../fish/guestfish.pod:312
22690 msgid "You have to mount something on C</> before most commands will work."
22695 #: ../fish/guestfish.pod:314
22697 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22703 #: ../fish/guestfish.pod:317
22705 "If you don't know what filesystems a disk image contains, you can either run "
22706 "guestfish without this option, then list the partitions, filesystems and LVs "
22707 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22708 "commands), or you can use the L<virt-filesystems(1)> program."
22712 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
22714 "The third (and rarely used) part of the mount parameter is the list of mount "
22715 "options used to mount the underlying filesystem. If this is not given, then "
22716 "the mount options are either the empty string or C<ro> (the latter if the "
22717 "I<--ro> flag is used). By specifying the mount options, you override this "
22718 "default choice. Probably the only time you would use this is to enable ACLs "
22719 "and/or extended attributes if the filesystem can support them:"
22723 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
22726 " -m /dev/sda1:/:acl,user_xattr\n"
22731 #: ../fish/guestfish.pod:333
22732 msgid "Using this flag is equivalent to using the C<mount-options> command."
22737 #: ../fish/guestfish.pod:335
22743 #: ../fish/guestfish.pod:337
22744 msgid "B<--no-sync>"
22749 #: ../fish/guestfish.pod:339
22751 "Disable autosync. This is enabled by default. See the discussion of "
22752 "autosync in the L<guestfs(3)> manpage."
22757 #: ../fish/guestfish.pod:342
22763 #: ../fish/guestfish.pod:344
22764 msgid "B<--new type>"
22769 #: ../fish/guestfish.pod:346
22775 #: ../fish/guestfish.pod:348
22777 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22778 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22779 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22785 #: ../fish/guestfish.pod:353
22786 msgid "B<--progress-bars>"
22791 #: ../fish/guestfish.pod:355
22792 msgid "Enable progress bars, even when guestfish is used non-interactively."
22797 #: ../fish/guestfish.pod:357
22799 "Progress bars are enabled by default when guestfish is used as an "
22800 "interactive shell."
22805 #: ../fish/guestfish.pod:360
22806 msgid "B<--no-progress-bars>"
22811 #: ../fish/guestfish.pod:362
22812 msgid "Disable progress bars."
22817 #: ../fish/guestfish.pod:364
22818 msgid "B<--remote[=pid]>"
22823 #: ../fish/guestfish.pod:366
22825 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22826 "CONTROL GUESTFISH OVER A SOCKET> below."
22831 #: ../fish/guestfish.pod:369
22837 #: ../fish/guestfish.pod:371
22843 #: ../fish/guestfish.pod:373
22845 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22846 "mounts are done read-only."
22851 #: ../fish/guestfish.pod:376
22853 "The option must always be used if the disk image or virtual machine might be "
22854 "running, and is generally recommended in cases where you don't need write "
22855 "access to the disk."
22860 #: ../fish/guestfish.pod:380
22862 "Note that prepared disk images created with I<-N> are not affected by this "
22863 "option. Also commands like C<add> are not affected - you have to specify "
22864 "the C<readonly:true> option explicitly if you need it."
22869 #: ../fish/guestfish.pod:384
22870 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22875 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
22876 msgid "B<--selinux>"
22881 #: ../fish/guestfish.pod:388
22882 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22887 #: ../fish/guestfish.pod:390
22893 #: ../fish/guestfish.pod:392
22894 msgid "B<--verbose>"
22899 #: ../fish/guestfish.pod:394
22901 "Enable very verbose messages. This is particularly useful if you find a bug."
22906 #: ../fish/guestfish.pod:397
22912 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
22913 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22914 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22915 msgid "B<--version>"
22920 #: ../fish/guestfish.pod:401
22921 msgid "Display the guestfish / libguestfs version number and exit."
22926 #: ../fish/guestfish.pod:403
22932 #: ../fish/guestfish.pod:405
22937 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
22939 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22940 "mounts are done read-write."
22944 #: ../fish/guestfish.pod:410
22945 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22950 #: ../fish/guestfish.pod:412
22956 #: ../fish/guestfish.pod:414
22957 msgid "Echo each command before executing it."
22962 #: ../fish/guestfish.pod:418
22963 msgid "COMMANDS ON COMMAND LINE"
22968 #: ../fish/guestfish.pod:420
22970 "Any additional (non-option) arguments are treated as commands to execute."
22975 #: ../fish/guestfish.pod:423
22977 "Commands to execute should be separated by a colon (C<:>), where the colon "
22978 "is a separate parameter. Thus:"
22983 #: ../fish/guestfish.pod:426
22986 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22992 #: ../fish/guestfish.pod:428
22994 "If there are no additional arguments, then we enter a shell, either an "
22995 "interactive shell with a prompt (if the input is a terminal) or a non-"
22996 "interactive shell."
23001 #: ../fish/guestfish.pod:432
23003 "In either command line mode or non-interactive shell, the first command that "
23004 "gives an error causes the whole shell to exit. In interactive mode (with a "
23005 "prompt) if a command fails, you can continue to enter commands."
23010 #: ../fish/guestfish.pod:437
23011 msgid "USING launch (OR run)"
23016 #: ../fish/guestfish.pod:439
23018 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
23019 "then launch it, then mount any disks you need, and finally issue actions/"
23020 "commands. So the general order of the day is:"
23025 #: ../fish/guestfish.pod:447
23026 msgid "add or -a/--add"
23031 #: ../fish/guestfish.pod:451
23032 msgid "launch (aka run)"
23037 #: ../fish/guestfish.pod:455
23038 msgid "mount or -m/--mount"
23043 #: ../fish/guestfish.pod:459
23044 msgid "any other commands"
23049 #: ../fish/guestfish.pod:463
23051 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
23052 "guest before mounting or performing any other commands."
23057 #: ../fish/guestfish.pod:466
23059 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
23060 "I<--new> options were given then C<run> is done automatically, simply "
23061 "because guestfish can't perform the action you asked for without doing this."
23066 #: ../fish/guestfish.pod:471
23067 msgid "OPENING DISKS FOR READ AND WRITE"
23071 #: ../fish/guestfish.pod:473
23073 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
23074 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
23075 "I<-i> and I<-m> open disk images read-only or for writing."
23079 #: ../fish/guestfish.pod:478
23081 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
23082 "opening disk images supplied on the command line for write. To open a disk "
23083 "image read-only you have to do I<-a image --ro>."
23088 #: ../fish/guestfish.pod:482
23090 "This matters: If you accidentally open a live VM disk image writable then "
23091 "you will cause irreversible disk corruption."
23095 #: ../fish/guestfish.pod:485
23097 "By libguestfs 1.12 we intend to change the default the other way. Disk "
23098 "images will be opened read-only. You will have to either specify "
23099 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
23100 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
23101 "access for disk images specified by those other command line options."
23105 #: ../fish/guestfish.pod:492
23107 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
23108 "which does nothing (it is already the default). However it is highly "
23109 "recommended that you use this option to indicate that you need write access, "
23110 "and prepare your scripts for the day when this option will be required for "
23116 #: ../fish/guestfish.pod:498
23118 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
23119 "other libguestfs program apart from guestfish and guestmount."
23124 #: ../fish/guestfish.pod:501
23130 #: ../fish/guestfish.pod:503
23132 "You can quote ordinary parameters using either single or double quotes. For "
23138 #: ../fish/guestfish.pod:506
23141 " add \"file with a space.img\"\n"
23147 #: ../fish/guestfish.pod:508
23150 " rm '/file name'\n"
23156 #: ../fish/guestfish.pod:510
23165 #: ../fish/guestfish.pod:512
23167 "A few commands require a list of strings to be passed. For these, use a "
23168 "whitespace-separated list, enclosed in quotes. Strings containing "
23169 "whitespace to be passed through must be enclosed in single quotes. A "
23170 "literal single quote must be escaped with a backslash."
23175 #: ../fish/guestfish.pod:517
23178 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
23179 " command \"/bin/echo 'foo bar'\"\n"
23180 " command \"/bin/echo \\'foo\\'\"\n"
23186 #: ../fish/guestfish.pod:521
23187 msgid "OPTIONAL ARGUMENTS"
23192 #: ../fish/guestfish.pod:523
23194 "Some commands take optional arguments. These arguments appear in this "
23195 "documentation as C<[argname:..]>. You can use them as in these examples:"
23200 #: ../fish/guestfish.pod:527
23203 " add-drive-opts filename\n"
23209 #: ../fish/guestfish.pod:529
23212 " add-drive-opts filename readonly:true\n"
23218 #: ../fish/guestfish.pod:531
23221 " add-drive-opts filename format:qcow2 readonly:false\n"
23227 #: ../fish/guestfish.pod:533
23229 "Each optional argument can appear at most once. All optional arguments must "
23230 "appear after the required ones."
23235 #: ../fish/guestfish.pod:536
23241 #: ../fish/guestfish.pod:538
23243 "This section applies to all commands which can take integers as parameters."
23248 #: ../fish/guestfish.pod:541
23249 msgid "SIZE SUFFIX"
23254 #: ../fish/guestfish.pod:543
23256 "When the command takes a parameter measured in bytes, you can use one of the "
23257 "following suffixes to specify kilobytes, megabytes and larger sizes:"
23262 #: ../fish/guestfish.pod:549
23263 msgid "B<k> or B<K> or B<KiB>"
23268 #: ../fish/guestfish.pod:551
23269 msgid "The size in kilobytes (multiplied by 1024)."
23274 #: ../fish/guestfish.pod:553
23280 #: ../fish/guestfish.pod:555
23281 msgid "The size in SI 1000 byte units."
23286 #: ../fish/guestfish.pod:557
23287 msgid "B<M> or B<MiB>"
23292 #: ../fish/guestfish.pod:559
23293 msgid "The size in megabytes (multiplied by 1048576)."
23298 #: ../fish/guestfish.pod:561
23304 #: ../fish/guestfish.pod:563
23305 msgid "The size in SI 1000000 byte units."
23310 #: ../fish/guestfish.pod:565
23311 msgid "B<G> or B<GiB>"
23316 #: ../fish/guestfish.pod:567
23317 msgid "The size in gigabytes (multiplied by 2**30)."
23322 #: ../fish/guestfish.pod:569
23328 #: ../fish/guestfish.pod:571
23329 msgid "The size in SI 10**9 byte units."
23334 #: ../fish/guestfish.pod:573
23335 msgid "B<T> or B<TiB>"
23340 #: ../fish/guestfish.pod:575
23341 msgid "The size in terabytes (multiplied by 2**40)."
23346 #: ../fish/guestfish.pod:577
23352 #: ../fish/guestfish.pod:579
23353 msgid "The size in SI 10**12 byte units."
23358 #: ../fish/guestfish.pod:581
23359 msgid "B<P> or B<PiB>"
23364 #: ../fish/guestfish.pod:583
23365 msgid "The size in petabytes (multiplied by 2**50)."
23370 #: ../fish/guestfish.pod:585
23376 #: ../fish/guestfish.pod:587
23377 msgid "The size in SI 10**15 byte units."
23382 #: ../fish/guestfish.pod:589
23383 msgid "B<E> or B<EiB>"
23388 #: ../fish/guestfish.pod:591
23389 msgid "The size in exabytes (multiplied by 2**60)."
23394 #: ../fish/guestfish.pod:593
23400 #: ../fish/guestfish.pod:595
23401 msgid "The size in SI 10**18 byte units."
23406 #: ../fish/guestfish.pod:597
23407 msgid "B<Z> or B<ZiB>"
23412 #: ../fish/guestfish.pod:599
23413 msgid "The size in zettabytes (multiplied by 2**70)."
23418 #: ../fish/guestfish.pod:601
23424 #: ../fish/guestfish.pod:603
23425 msgid "The size in SI 10**21 byte units."
23430 #: ../fish/guestfish.pod:605
23431 msgid "B<Y> or B<YiB>"
23436 #: ../fish/guestfish.pod:607
23437 msgid "The size in yottabytes (multiplied by 2**80)."
23442 #: ../fish/guestfish.pod:609
23448 #: ../fish/guestfish.pod:611
23449 msgid "The size in SI 10**24 byte units."
23454 #: ../fish/guestfish.pod:617
23457 " truncate-size /file 1G\n"
23463 #: ../fish/guestfish.pod:619
23464 msgid "would truncate the file to 1 gigabyte."
23469 #: ../fish/guestfish.pod:621
23471 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23472 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23473 "suffix will probably not do what you expect."
23478 #: ../fish/guestfish.pod:625
23479 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23484 #: ../fish/guestfish.pod:627
23486 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23487 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23492 #: ../fish/guestfish.pod:630
23495 " 1234 decimal number 1234\n"
23496 " 02322 octal number, equivalent to decimal 1234\n"
23497 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23503 #: ../fish/guestfish.pod:634
23505 "When using the C<chmod> command, you almost always want to specify an octal "
23506 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23507 "L<chmod(1)> program):"
23512 #: ../fish/guestfish.pod:638
23515 " chmod 0777 /public # OK\n"
23516 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23522 #: ../fish/guestfish.pod:641
23524 "Commands that return numbers usually print them in decimal, but some "
23525 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23526 "octal, preceeded by C<0>)."
23531 #: ../fish/guestfish.pod:645
23532 msgid "WILDCARDS AND GLOBBING"
23537 #: ../fish/guestfish.pod:647
23539 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23540 "(globbing) by default. So for example the following will not do what you "
23546 #: ../fish/guestfish.pod:651
23555 #: ../fish/guestfish.pod:653
23557 "Assuming you don't have a directory called literally C</home/*> then the "
23558 "above command will return an error."
23563 #: ../fish/guestfish.pod:656
23564 msgid "To perform wildcard expansion, use the C<glob> command."
23569 #: ../fish/guestfish.pod:658
23572 " glob rm-rf /home/*\n"
23578 #: ../fish/guestfish.pod:660
23580 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23581 "many times), equivalent to:"
23586 #: ../fish/guestfish.pod:663
23589 " rm-rf /home/jim\n"
23590 " rm-rf /home/joe\n"
23591 " rm-rf /home/mary\n"
23597 #: ../fish/guestfish.pod:667
23598 msgid "C<glob> only works on simple guest paths and not on device names."
23603 #: ../fish/guestfish.pod:669
23605 "If you have several parameters, each containing a wildcard, then glob will "
23606 "perform a Cartesian product."
23611 #: ../fish/guestfish.pod:672
23617 #: ../fish/guestfish.pod:674
23619 "Any line which starts with a I<#> character is treated as a comment and "
23620 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23621 "a command. For example:"
23626 #: ../fish/guestfish.pod:678
23629 " # this is a comment\n"
23630 " # this is a comment\n"
23631 " foo # NOT a comment\n"
23637 #: ../fish/guestfish.pod:682
23638 msgid "Blank lines are also ignored."
23643 #: ../fish/guestfish.pod:684
23644 msgid "RUNNING COMMANDS LOCALLY"
23649 #: ../fish/guestfish.pod:686
23651 "Any line which starts with a I<!> character is treated as a command sent to "
23652 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23657 #: ../fish/guestfish.pod:690
23661 " tgz-out /remote local/remote-data.tar.gz\n"
23667 #: ../fish/guestfish.pod:693
23669 "will create a directory C<local> on the host, and then export the contents "
23670 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23671 "(See C<tgz-out>)."
23676 #: ../fish/guestfish.pod:697
23678 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23679 "effect, due to the way that subprocesses work in Unix."
23683 #: ../fish/guestfish.pod:700
23684 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23688 #: ../fish/guestfish.pod:702
23690 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23691 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23692 "and executed as guestfish commands."
23696 #: ../fish/guestfish.pod:706
23698 "Thus you can use shell script to construct arbitrary guestfish commands "
23699 "which are then parsed by guestfish."
23703 #: ../fish/guestfish.pod:709
23705 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23706 "through C</foo.100>) using guestfish commands alone. However this is simple "
23707 "if we use a shell script to create the guestfish commands for us:"
23711 #: ../fish/guestfish.pod:714
23714 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23719 #: ../fish/guestfish.pod:716
23720 msgid "or with names like C</foo.001>:"
23724 #: ../fish/guestfish.pod:718
23727 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23732 #: ../fish/guestfish.pod:720
23734 "When using guestfish interactively it can be helpful to just run the shell "
23735 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23736 "ordinary I<!> local command), see what guestfish commands it would run, and "
23737 "when you are happy with those prepend the C<E<lt>> character to run the "
23738 "guestfish commands for real."
23743 #: ../fish/guestfish.pod:726
23749 #: ../fish/guestfish.pod:728
23751 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23752 "command (a guestfish command) to the second command (any host command). For "
23758 #: ../fish/guestfish.pod:732
23761 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23767 #: ../fish/guestfish.pod:734
23769 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23770 "program). The above command would list all accounts in the guest filesystem "
23771 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23776 #: ../fish/guestfish.pod:739
23779 " hexdump /bin/ls | head\n"
23780 " list-devices | tail -1\n"
23781 " tgz-out / - | tar ztf -\n"
23787 #: ../fish/guestfish.pod:743
23789 "The space before the pipe symbol is required, any space after the pipe "
23790 "symbol is optional. Everything after the pipe symbol is just passed "
23791 "straight to the host shell, so it can contain redirections, globs and "
23792 "anything else that makes sense on the host side."
23797 #: ../fish/guestfish.pod:748
23799 "To use a literal argument which begins with a pipe symbol, you have to quote "
23805 #: ../fish/guestfish.pod:751
23814 #: ../fish/guestfish.pod:753
23815 msgid "HOME DIRECTORIES"
23820 #: ../fish/guestfish.pod:755
23822 "If a parameter starts with the character C<~> then the tilde may be expanded "
23823 "as a home directory path (either C<~> for the current user's home directory, "
23824 "or C<~user> for another user)."
23829 #: ../fish/guestfish.pod:759
23831 "Note that home directory expansion happens for users known I<on the host>, "
23832 "not in the guest filesystem."
23837 #: ../fish/guestfish.pod:762
23839 "To use a literal argument which begins with a tilde, you have to quote it, "
23845 #: ../fish/guestfish.pod:765
23854 #: ../fish/guestfish.pod:769
23856 "Libguestfs has some support for Linux guests encrypted according to the "
23857 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23858 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23859 "LUKS is supported."
23864 #: ../fish/guestfish.pod:774
23865 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23870 #: ../fish/guestfish.pod:776
23873 " ><fs> vfs-type /dev/sda2\n"
23880 #: ../fish/guestfish.pod:779
23882 "Then open those devices using L</luks-open>. This creates a device-mapper "
23883 "device called C</dev/mapper/luksdev>."
23888 #: ../fish/guestfish.pod:782
23891 " ><fs> luks-open /dev/sda2 luksdev\n"
23892 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23898 #: ../fish/guestfish.pod:785
23900 "Finally you have to tell LVM to scan for volume groups on the newly created "
23906 #: ../fish/guestfish.pod:788
23910 " vg-activate-all true\n"
23916 #: ../fish/guestfish.pod:791
23917 msgid "The logical volume(s) can now be mounted in the usual way."
23922 #: ../fish/guestfish.pod:793
23924 "Before closing a LUKS device you must unmount any logical volumes on it and "
23925 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23926 "one. Then you can close the mapper device:"
23931 #: ../fish/guestfish.pod:797
23934 " vg-activate false /dev/VG\n"
23935 " luks-close /dev/mapper/luksdev\n"
23941 #: ../fish/guestfish.pod:800
23942 msgid "WINDOWS PATHS"
23946 #: ../fish/guestfish.pod:802
23948 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23949 "letters and paths (with some limitations). The following commands are "
23955 #: ../fish/guestfish.pod:806
23958 " file /WINDOWS/system32/config/system.LOG\n"
23964 #: ../fish/guestfish.pod:808
23967 " file win:\\windows\\system32\\config\\system.log\n"
23972 #: ../fish/guestfish.pod:810
23975 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23980 #: ../fish/guestfish.pod:812
23982 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23983 "where the drive is mounted, prepending that to the path, changing all "
23984 "backslash characters to forward slash, then resolving the result using L</"
23985 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23986 "the parameter might be rewritten like this:"
23990 #: ../fish/guestfish.pod:818
23993 " win:e:\\foo\\bar => /e/FOO/bar\n"
23998 #: ../fish/guestfish.pod:820
23999 msgid "This only works in argument positions that expect a path."
24004 #: ../fish/guestfish.pod:822
24005 msgid "UPLOADING AND DOWNLOADING FILES"
24010 #: ../fish/guestfish.pod:824
24012 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
24013 "others which upload from or download to a local file, you can use the "
24014 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
24019 #: ../fish/guestfish.pod:828
24028 #: ../fish/guestfish.pod:830
24030 "reads stdin and creates from that a file C</foo> in the disk image, and:"
24035 #: ../fish/guestfish.pod:833
24038 " tar-out /etc - | tar tf -\n"
24044 #: ../fish/guestfish.pod:835
24046 "writes the tarball to stdout and then pipes that into the external \"tar\" "
24047 "command (see L</PIPES>)."
24052 #: ../fish/guestfish.pod:838
24054 "When using C<-> to read from stdin, the input is read up to the end of "
24055 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
24056 "some arbitrary end marker:"
24061 #: ../fish/guestfish.pod:842
24064 " upload -<<END /foo\n"
24074 #: ../fish/guestfish.pod:848
24076 "Any string of characters can be used instead of C<END>. The end marker must "
24077 "appear on a line of its own, without any preceeding or following characters "
24078 "(not even spaces)."
24083 #: ../fish/guestfish.pod:852
24085 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
24086 "upload local files (so-called \"FileIn\" parameters in the generator)."
24091 #: ../fish/guestfish.pod:855
24092 msgid "EXIT ON ERROR BEHAVIOUR"
24097 #: ../fish/guestfish.pod:857
24099 "By default, guestfish will ignore any errors when in interactive mode (ie. "
24100 "taking commands from a human over a tty), and will exit on the first error "
24101 "in non-interactive mode (scripts, commands given on the command line)."
24106 #: ../fish/guestfish.pod:862
24108 "If you prefix a command with a I<-> character, then that command will not "
24109 "cause guestfish to exit, even if that (one) command returns an error."
24114 #: ../fish/guestfish.pod:866
24115 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
24120 #: ../fish/guestfish.pod:868
24122 "Guestfish can be remote-controlled over a socket. This is useful "
24123 "particularly in shell scripts where you want to make several different "
24124 "changes to a filesystem, but you don't want the overhead of starting up a "
24125 "guestfish process each time."
24130 #: ../fish/guestfish.pod:873
24131 msgid "Start a guestfish server process using:"
24136 #: ../fish/guestfish.pod:875
24139 " eval \"`guestfish --listen`\"\n"
24145 #: ../fish/guestfish.pod:877
24146 msgid "and then send it commands by doing:"
24151 #: ../fish/guestfish.pod:879
24154 " guestfish --remote cmd [...]\n"
24160 #: ../fish/guestfish.pod:881
24161 msgid "To cause the server to exit, send it the exit command:"
24166 #: ../fish/guestfish.pod:883
24169 " guestfish --remote exit\n"
24175 #: ../fish/guestfish.pod:885
24177 "Note that the server will normally exit if there is an error in a command. "
24178 "You can change this in the usual way. See section L</EXIT ON ERROR "
24184 #: ../fish/guestfish.pod:889
24185 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
24190 #: ../fish/guestfish.pod:891
24192 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
24193 "is how the I<--remote> option knows where to send the commands. You can "
24194 "have several guestfish listener processes running using:"
24199 #: ../fish/guestfish.pod:895
24202 " eval \"`guestfish --listen`\"\n"
24203 " pid1=$GUESTFISH_PID\n"
24204 " eval \"`guestfish --listen`\"\n"
24205 " pid2=$GUESTFISH_PID\n"
24207 " guestfish --remote=$pid1 cmd\n"
24208 " guestfish --remote=$pid2 cmd\n"
24214 #: ../fish/guestfish.pod:903
24215 msgid "REMOTE CONTROL AND CSH"
24220 #: ../fish/guestfish.pod:905
24222 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
24228 #: ../fish/guestfish.pod:908
24231 " eval \"`guestfish --listen --csh`\"\n"
24237 #: ../fish/guestfish.pod:910
24238 msgid "REMOTE CONTROL DETAILS"
24243 #: ../fish/guestfish.pod:912
24245 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
24246 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
24247 "and C<$PID> is the process ID of the server."
24252 #: ../fish/guestfish.pod:916
24253 msgid "Guestfish client and server versions must match exactly."
24258 #: ../fish/guestfish.pod:918
24259 msgid "PREPARED DISK IMAGES"
24264 #: ../fish/guestfish.pod:920
24266 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
24267 "preformatted disk images that guestfish can make for you to save typing. "
24268 "This is particularly useful for testing purposes. This option is used "
24269 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
24270 "can be mixed with I<-a>)."
24275 #: ../fish/guestfish.pod:926
24277 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
24278 "the second and so on. Existing files in the current directory are "
24284 #: ../fish/guestfish.pod:930
24286 "The type briefly describes how the disk should be sized, partitioned, how "
24287 "filesystem(s) should be created, and how content should be added. "
24288 "Optionally the type can be followed by extra parameters, separated by C<:> "
24289 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
24290 "allocated disk, containing a single partition, with the partition formatted "
24291 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
24297 #: ../fish/guestfish.pod:938
24298 msgid "To list the available types and any extra parameters they take, run:"
24303 #: ../fish/guestfish.pod:942
24305 "Note that the prepared filesystem is not mounted. You would usually have to "
24306 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
24311 #: ../fish/guestfish.pod:946
24313 "If any I<-N> or I<--new> options are given, the guest is automatically "
24319 #: ../fish/guestfish.pod:951
24320 msgid "Create a 100MB disk with an ext4-formatted partition:"
24325 #: ../fish/guestfish.pod:953
24328 " guestfish -N fs:ext4\n"
24334 #: ../fish/guestfish.pod:955
24335 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24340 #: ../fish/guestfish.pod:957
24343 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24349 #: ../fish/guestfish.pod:959
24350 msgid "Create a blank 200MB disk:"
24355 #: ../fish/guestfish.pod:961
24358 " guestfish -N disk:200M\n"
24364 #: ../fish/guestfish.pod:963
24365 msgid "PROGRESS BARS"
24370 #: ../fish/guestfish.pod:965
24372 "Some (not all) long-running commands send progress notification messages as "
24373 "they are running. Guestfish turns these messages into progress bars."
24378 #: ../fish/guestfish.pod:969
24380 "When a command that supports progress bars takes longer than two seconds to "
24381 "run, and if progress bars are enabled, then you will see one appearing below "
24387 #: ../fish/guestfish.pod:973
24390 " ><fs> copy-size /large-file /another-file 2048M\n"
24391 " / 10% [#####-----------------------------------------] 00:30\n"
24397 #: ../fish/guestfish.pod:976
24399 "The spinner on the left hand side moves round once for every progress "
24400 "notification received from the backend. This is a (reasonably) golden "
24401 "assurance that the command is \"doing something\" even if the progress bar "
24402 "is not moving, because the command is able to send the progress "
24403 "notifications. When the bar reaches 100% and the command finishes, the "
24404 "spinner disappears."
24409 #: ../fish/guestfish.pod:983
24411 "Progress bars are enabled by default when guestfish is used interactively. "
24412 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24413 "and you can disable them completely using I<--no-progress-bars>."
24418 #: ../fish/guestfish.pod:988
24419 msgid "GUESTFISH COMMANDS"
24424 #: ../fish/guestfish.pod:990
24426 "The commands in this section are guestfish convenience commands, in other "
24427 "words, they are not part of the L<guestfs(3)> API."
24432 #: ../fish/guestfish.pod:993
24438 #: ../fish/guestfish.pod:995
24448 #: ../fish/guestfish.pod:998
24449 msgid "Without any parameter, this provides general help."
24454 #: ../fish/guestfish.pod:1000
24455 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24460 #: ../fish/guestfish.pod:1002
24461 msgid "quit | exit"
24466 #: ../fish/guestfish.pod:1004
24467 msgid "This exits guestfish. You can also use C<^D> key."
24472 #: ../fish/guestfish.pod:1006
24473 msgid "@FISH_COMMANDS@"
24478 #: ../fish/guestfish.pod:1008
24484 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24490 #: ../fish/guestfish.pod:1014
24492 "guestfish returns 0 if the commands completed without error, or 1 if there "
24498 #: ../fish/guestfish.pod:1021
24504 #: ../fish/guestfish.pod:1023
24506 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24511 #: ../fish/guestfish.pod:1026
24512 msgid "GUESTFISH_DISPLAY_IMAGE"
24516 #: ../fish/guestfish.pod:1028
24518 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
24519 "If not set, it uses L<display(1)>."
24524 #: ../fish/guestfish.pod:1031
24525 msgid "GUESTFISH_PID"
24530 #: ../fish/guestfish.pod:1033
24532 "Used with the I<--remote> option to specify the remote guestfish process to "
24533 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24538 #: ../fish/guestfish.pod:1037
24544 #: ../fish/guestfish.pod:1039
24546 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24547 "not specified, the external L<hexedit(1)> program is used."
24552 #: ../fish/guestfish.pod:1043
24558 #: ../fish/guestfish.pod:1045
24560 "If compiled with GNU readline support, various files in the home directory "
24561 "can be used. See L</FILES>."
24566 #: ../fish/guestfish.pod:1054
24568 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24569 "effect as using the B<-v> option."
24574 #: ../fish/guestfish.pod:1066
24576 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24577 "the discussion of paths in L<guestfs(3)>."
24582 #: ../fish/guestfish.pod:1077
24583 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24588 #: ../fish/guestfish.pod:1079
24594 #: ../fish/guestfish.pod:1081
24596 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24602 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
24607 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
24608 msgid "$HOME/.libguestfs-tools.rc"
24612 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
24613 msgid "/etc/libguestfs-tools.conf"
24617 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
24619 "This configuration file controls the default read-only or read-write mode "
24620 "(I<--ro> or I<--rw>)."
24624 #: ../fish/guestfish.pod:1108
24625 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24630 #: ../fish/guestfish.pod:1110
24631 msgid "$HOME/.guestfish"
24636 #: ../fish/guestfish.pod:1112
24638 "If compiled with GNU readline support, then the command history is saved in "
24644 #: ../fish/guestfish.pod:1115
24645 msgid "$HOME/.inputrc"
24650 #: ../fish/guestfish.pod:1117
24651 msgid "/etc/inputrc"
24656 #: ../fish/guestfish.pod:1119
24658 "If compiled with GNU readline support, then these files can be used to "
24659 "configure readline. For further information, please see L<readline(3)/"
24660 "INITIALIZATION FILE>."
24665 #: ../fish/guestfish.pod:1123
24666 msgid "To write rules which only apply to guestfish, use:"
24671 #: ../fish/guestfish.pod:1125
24682 #: ../fish/guestfish.pod:1129
24684 "Variables that you can set in inputrc that change the behaviour of guestfish "
24685 "in useful ways include:"
24690 #: ../fish/guestfish.pod:1134
24691 msgid "completion-ignore-case (default: on)"
24696 #: ../fish/guestfish.pod:1136
24698 "By default, guestfish will ignore case when tab-completing paths on the "
24704 #: ../fish/guestfish.pod:1139
24707 " set completion-ignore-case off\n"
24713 #: ../fish/guestfish.pod:1141
24714 msgid "to make guestfish case sensitive."
24719 #: ../fish/guestfish.pod:1145
24725 #: ../fish/guestfish.pod:1147
24726 msgid "test2.img (etc)"
24730 #: ../fish/guestfish.pod:1149
24732 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24733 "will be created in the file C<test1.img> in the current directory. The "
24734 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24735 "the same name will be overwritten."
24739 #: ../fish/guestfish.pod:1158
24741 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24742 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24743 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24744 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24745 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24746 ">, L<display(1)>, L<hexedit(1)>."
24751 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
24752 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
24753 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24754 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24756 "This program is free software; you can redistribute it and/or modify it "
24757 "under the terms of the GNU General Public License as published by the Free "
24758 "Software Foundation; either version 2 of the License, or (at your option) "
24759 "any later version."
24764 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
24765 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
24766 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24767 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24769 "This program is distributed in the hope that it will be useful, but WITHOUT "
24770 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24771 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24777 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
24778 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
24779 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24780 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24782 "You should have received a copy of the GNU General Public License along with "
24783 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24784 "Ave, Cambridge, MA 02139, USA."
24789 #: ../fish/guestfish-actions.pod:1
24795 #: ../fish/guestfish-actions.pod:3
24798 " add-cdrom filename\n"
24804 #: ../fish/guestfish-actions.pod:15
24806 "This call checks for the existence of C<filename>. This stops you from "
24807 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24808 "and C<http:> URLs. To specify those, use the general L</config> call "
24814 #: ../fish/guestfish-actions.pod:22
24816 "If you just want to add an ISO file (often you use this as an efficient way "
24817 "to transfer large files into the guest), then you should probably use L</add-"
24818 "drive-ro> instead."
24823 #: ../fish/guestfish-actions.pod:35
24829 #: ../fish/guestfish-actions.pod:37
24834 #: ../fish/guestfish-actions.pod:39
24837 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
24843 #: ../fish/guestfish-actions.pod:41
24845 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24846 "It works by connecting to libvirt, requesting the domain and domain XML from "
24847 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24852 #: ../fish/guestfish-actions.pod:76
24854 "The other optional parameters are passed directly through to L</add-drive-"
24860 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
24861 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3077
24862 #: ../fish/guestfish-actions.pod:3250
24864 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24869 #: ../fish/guestfish-actions.pod:81
24875 #: ../fish/guestfish-actions.pod:83
24878 " add-drive filename\n"
24884 #: ../fish/guestfish-actions.pod:85
24886 "This function is the equivalent of calling L</add-drive-opts> with no "
24887 "optional parameters, so the disk is added writable, with the format being "
24888 "detected automatically."
24893 #: ../fish/guestfish-actions.pod:89
24895 "Automatic detection of the format opens you up to a potential security hole "
24896 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24897 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24898 "you should think about replacing calls to this function with calls to L</add-"
24899 "drive-opts>, and specifying the format."
24904 #: ../fish/guestfish-actions.pod:96
24905 msgid "add-drive-opts"
24910 #: ../fish/guestfish-actions.pod:98
24916 #: ../fish/guestfish-actions.pod:100
24919 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24925 #: ../fish/guestfish-actions.pod:127
24927 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24928 "add-drive-ro>) then the format is automatically detected. Possible formats "
24929 "include C<raw> and C<qcow2>."
24934 #: ../fish/guestfish-actions.pod:138
24936 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24937 "add-drive-with-if> call (q.v.)"
24942 #: ../fish/guestfish-actions.pod:145
24943 msgid "add-drive-ro"
24948 #: ../fish/guestfish-actions.pod:147
24954 #: ../fish/guestfish-actions.pod:149
24957 " add-drive-ro filename\n"
24963 #: ../fish/guestfish-actions.pod:151
24965 "This function is the equivalent of calling L</add-drive-opts> with the "
24966 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24967 "is added read-only, with the format being detected automatically."
24972 #: ../fish/guestfish-actions.pod:156
24973 msgid "add-drive-ro-with-if"
24978 #: ../fish/guestfish-actions.pod:158
24981 " add-drive-ro-with-if filename iface\n"
24987 #: ../fish/guestfish-actions.pod:160
24989 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24990 "interface emulation to use at run time."
24995 #: ../fish/guestfish-actions.pod:170
24996 msgid "add-drive-with-if"
25001 #: ../fish/guestfish-actions.pod:172
25004 " add-drive-with-if filename iface\n"
25010 #: ../fish/guestfish-actions.pod:174
25012 "This is the same as L</add-drive> but it allows you to specify the QEMU "
25013 "interface emulation to use at run time."
25018 #: ../fish/guestfish-actions.pod:184
25024 #: ../fish/guestfish-actions.pod:186
25027 " aug-clear augpath\n"
25033 #: ../fish/guestfish-actions.pod:191
25039 #: ../fish/guestfish-actions.pod:193
25048 #: ../fish/guestfish-actions.pod:195
25050 "Close the current Augeas handle and free up any resources used by it. After "
25051 "calling this, you have to call L</aug-init> again before you can use any "
25052 "other Augeas functions."
25057 #: ../fish/guestfish-actions.pod:200
25058 msgid "aug-defnode"
25063 #: ../fish/guestfish-actions.pod:202
25066 " aug-defnode name expr val\n"
25072 #: ../fish/guestfish-actions.pod:207
25074 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
25075 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
25076 "containing that single node."
25081 #: ../fish/guestfish-actions.pod:215
25087 #: ../fish/guestfish-actions.pod:217
25090 " aug-defvar name expr\n"
25096 #: ../fish/guestfish-actions.pod:226
25102 #: ../fish/guestfish-actions.pod:228
25105 " aug-get augpath\n"
25111 #: ../fish/guestfish-actions.pod:233
25117 #: ../fish/guestfish-actions.pod:235
25120 " aug-init root flags\n"
25126 #: ../fish/guestfish-actions.pod:241
25127 msgid "You must call this before using any other L</aug-*> commands."
25132 #: ../fish/guestfish-actions.pod:276
25133 msgid "Do not load the tree in L</aug-init>."
25138 #: ../fish/guestfish-actions.pod:280
25139 msgid "To close the handle, you can call L</aug-close>."
25144 #: ../fish/guestfish-actions.pod:284
25150 #: ../fish/guestfish-actions.pod:286
25153 " aug-insert augpath label true|false\n"
25159 #: ../fish/guestfish-actions.pod:296
25165 #: ../fish/guestfish-actions.pod:298
25174 #: ../fish/guestfish-actions.pod:305
25180 #: ../fish/guestfish-actions.pod:307
25183 " aug-ls augpath\n"
25189 #: ../fish/guestfish-actions.pod:309
25191 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
25192 "resulting nodes into alphabetical order."
25197 #: ../fish/guestfish-actions.pod:312
25203 #: ../fish/guestfish-actions.pod:314
25206 " aug-match augpath\n"
25212 #: ../fish/guestfish-actions.pod:320
25218 #: ../fish/guestfish-actions.pod:322
25221 " aug-mv src dest\n"
25227 #: ../fish/guestfish-actions.pod:327
25233 #: ../fish/guestfish-actions.pod:329
25236 " aug-rm augpath\n"
25242 #: ../fish/guestfish-actions.pod:335
25248 #: ../fish/guestfish-actions.pod:337
25257 #: ../fish/guestfish-actions.pod:341
25259 "The flags which were passed to L</aug-init> affect exactly how files are "
25265 #: ../fish/guestfish-actions.pod:344
25271 #: ../fish/guestfish-actions.pod:346
25274 " aug-set augpath val\n"
25280 #: ../fish/guestfish-actions.pod:350
25282 "In the Augeas API, it is possible to clear a node by setting the value to "
25283 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
25284 "this call. Instead you must use the L</aug-clear> call."
25289 #: ../fish/guestfish-actions.pod:355
25295 #: ../fish/guestfish-actions.pod:357
25298 " available 'groups ...'\n"
25304 #: ../fish/guestfish-actions.pod:363
25306 "The libguestfs groups, and the functions that those groups correspond to, "
25307 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
25308 "runtime by calling L</available-all-groups>."
25313 #: ../fish/guestfish-actions.pod:387
25314 msgid "You must call L</launch> before calling this function."
25319 #: ../fish/guestfish-actions.pod:409
25321 "This call was added in version C<1.0.80>. In previous versions of "
25322 "libguestfs all you could do would be to speculatively execute a command to "
25323 "find out if the daemon implemented it. See also L</version>."
25328 #: ../fish/guestfish-actions.pod:416
25329 msgid "available-all-groups"
25334 #: ../fish/guestfish-actions.pod:418
25337 " available-all-groups\n"
25343 #: ../fish/guestfish-actions.pod:420
25345 "This command returns a list of all optional groups that this daemon knows "
25346 "about. Note this returns both supported and unsupported groups. To find "
25347 "out which ones the daemon can actually support you have to call L</"
25348 "available> on each member of the returned list."
25353 #: ../fish/guestfish-actions.pod:426
25354 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25359 #: ../fish/guestfish-actions.pod:428
25365 #: ../fish/guestfish-actions.pod:430
25368 " base64-in (base64file|-) filename\n"
25374 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25375 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
25376 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
25377 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4535
25378 #: ../fish/guestfish-actions.pod:4546 ../fish/guestfish-actions.pod:4557
25379 #: ../fish/guestfish-actions.pod:4609 ../fish/guestfish-actions.pod:4618
25380 #: ../fish/guestfish-actions.pod:4672 ../fish/guestfish-actions.pod:4695
25381 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25386 #: ../fish/guestfish-actions.pod:437
25392 #: ../fish/guestfish-actions.pod:439
25395 " base64-out filename (base64file|-)\n"
25401 #: ../fish/guestfish-actions.pod:446
25402 msgid "blockdev-flushbufs"
25407 #: ../fish/guestfish-actions.pod:448
25410 " blockdev-flushbufs device\n"
25416 #: ../fish/guestfish-actions.pod:455
25417 msgid "blockdev-getbsz"
25422 #: ../fish/guestfish-actions.pod:457
25425 " blockdev-getbsz device\n"
25431 #: ../fish/guestfish-actions.pod:466
25432 msgid "blockdev-getro"
25437 #: ../fish/guestfish-actions.pod:468
25440 " blockdev-getro device\n"
25446 #: ../fish/guestfish-actions.pod:475
25447 msgid "blockdev-getsize64"
25452 #: ../fish/guestfish-actions.pod:477
25455 " blockdev-getsize64 device\n"
25461 #: ../fish/guestfish-actions.pod:481
25462 msgid "See also L</blockdev-getsz>."
25467 #: ../fish/guestfish-actions.pod:485
25468 msgid "blockdev-getss"
25473 #: ../fish/guestfish-actions.pod:487
25476 " blockdev-getss device\n"
25482 #: ../fish/guestfish-actions.pod:492
25484 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25489 #: ../fish/guestfish-actions.pod:497
25490 msgid "blockdev-getsz"
25495 #: ../fish/guestfish-actions.pod:499
25498 " blockdev-getsz device\n"
25504 #: ../fish/guestfish-actions.pod:504
25506 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25507 "blockdev-getsize64> for the more useful I<size in bytes>."
25512 #: ../fish/guestfish-actions.pod:510
25513 msgid "blockdev-rereadpt"
25518 #: ../fish/guestfish-actions.pod:512
25521 " blockdev-rereadpt device\n"
25527 #: ../fish/guestfish-actions.pod:518
25528 msgid "blockdev-setbsz"
25533 #: ../fish/guestfish-actions.pod:520
25536 " blockdev-setbsz device blocksize\n"
25542 #: ../fish/guestfish-actions.pod:529
25543 msgid "blockdev-setro"
25548 #: ../fish/guestfish-actions.pod:531
25551 " blockdev-setro device\n"
25557 #: ../fish/guestfish-actions.pod:537
25558 msgid "blockdev-setrw"
25563 #: ../fish/guestfish-actions.pod:539
25566 " blockdev-setrw device\n"
25572 #: ../fish/guestfish-actions.pod:545
25573 msgid "case-sensitive-path"
25578 #: ../fish/guestfish-actions.pod:547
25581 " case-sensitive-path path\n"
25587 #: ../fish/guestfish-actions.pod:571
25589 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25590 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25591 "the directories were originally created under Windows)."
25596 #: ../fish/guestfish-actions.pod:579
25597 msgid "See also L</realpath>."
25602 #: ../fish/guestfish-actions.pod:581
25608 #: ../fish/guestfish-actions.pod:583
25617 #: ../fish/guestfish-actions.pod:587
25619 "Note that this function cannot correctly handle binary files (specifically, "
25620 "files containing C<\\0> character which is treated as end of string). For "
25621 "those you need to use the L</read-file> or L</download> functions which have "
25622 "a more complex interface."
25627 #: ../fish/guestfish-actions.pod:595
25633 #: ../fish/guestfish-actions.pod:597
25636 " checksum csumtype path\n"
25642 #: ../fish/guestfish-actions.pod:640
25643 msgid "To get the checksum for a device, use L</checksum-device>."
25648 #: ../fish/guestfish-actions.pod:642
25649 msgid "To get the checksums for many files, use L</checksums-out>."
25654 #: ../fish/guestfish-actions.pod:644
25655 msgid "checksum-device"
25660 #: ../fish/guestfish-actions.pod:646
25663 " checksum-device csumtype device\n"
25669 #: ../fish/guestfish-actions.pod:648
25671 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25672 "device named C<device>. For the types of checksums supported see the L</"
25673 "checksum> command."
25678 #: ../fish/guestfish-actions.pod:652
25679 msgid "checksums-out"
25684 #: ../fish/guestfish-actions.pod:654
25687 " checksums-out csumtype directory (sumsfile|-)\n"
25693 #: ../fish/guestfish-actions.pod:670
25699 #: ../fish/guestfish-actions.pod:672
25702 " chmod mode path\n"
25708 #: ../fish/guestfish-actions.pod:683
25714 #: ../fish/guestfish-actions.pod:685
25717 " chown owner group path\n"
25723 #: ../fish/guestfish-actions.pod:693
25729 #: ../fish/guestfish-actions.pod:695
25732 " command 'arguments ...'\n"
25738 #: ../fish/guestfish-actions.pod:702
25740 "The single parameter is an argv-style list of arguments. The first element "
25741 "is the name of the program to run. Subsequent elements are parameters. The "
25742 "list must be non-empty (ie. must contain a program name). Note that the "
25743 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25748 #: ../fish/guestfish-actions.pod:730
25749 msgid "command-lines"
25754 #: ../fish/guestfish-actions.pod:732
25757 " command-lines 'arguments ...'\n"
25763 #: ../fish/guestfish-actions.pod:734
25765 "This is the same as L</command>, but splits the result into a list of lines."
25770 #: ../fish/guestfish-actions.pod:737
25771 msgid "See also: L</sh-lines>"
25776 #: ../fish/guestfish-actions.pod:742
25782 #: ../fish/guestfish-actions.pod:744
25785 " config qemuparam qemuvalue\n"
25791 #: ../fish/guestfish-actions.pod:755
25797 #: ../fish/guestfish-actions.pod:757
25800 " copy-size src dest size\n"
25806 #: ../fish/guestfish-actions.pod:765
25812 #: ../fish/guestfish-actions.pod:767
25821 #: ../fish/guestfish-actions.pod:772
25827 #: ../fish/guestfish-actions.pod:774
25836 #: ../fish/guestfish-actions.pod:779
25842 #: ../fish/guestfish-actions.pod:781
25851 #: ../fish/guestfish-actions.pod:788
25853 "If the destination is a device, it must be as large or larger than the "
25854 "source file or device, otherwise the copy will fail. This command cannot do "
25855 "partial copies (see L</copy-size>)."
25860 #: ../fish/guestfish-actions.pod:792
25866 #: ../fish/guestfish-actions.pod:794
25875 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
25877 "This command is mostly useful for interactive sessions. It is I<not> "
25878 "intended that you try to parse the output string. Use L</statvfs> from "
25884 #: ../fish/guestfish-actions.pod:802
25890 #: ../fish/guestfish-actions.pod:804
25899 #: ../fish/guestfish-actions.pod:813
25905 #: ../fish/guestfish-actions.pod:815
25914 #: ../fish/guestfish-actions.pod:821
25916 "Another way to get the same information is to enable verbose messages with "
25917 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25918 "before running the program."
25923 #: ../fish/guestfish-actions.pod:826
25929 #: ../fish/guestfish-actions.pod:828
25932 " download remotefilename (filename|-)\n"
25938 #: ../fish/guestfish-actions.pod:835
25939 msgid "See also L</upload>, L</cat>."
25944 #: ../fish/guestfish-actions.pod:839
25945 msgid "download-offset"
25950 #: ../fish/guestfish-actions.pod:841
25953 " download-offset remotefilename (filename|-) offset size\n"
25959 #: ../fish/guestfish-actions.pod:849
25961 "Note that there is no limit on the amount of data that can be downloaded "
25962 "with this call, unlike with L</pread>, and this call always reads the full "
25963 "amount unless an error occurs."
25968 #: ../fish/guestfish-actions.pod:854
25969 msgid "See also L</download>, L</pread>."
25974 #: ../fish/guestfish-actions.pod:858
25975 msgid "drop-caches"
25980 #: ../fish/guestfish-actions.pod:860
25983 " drop-caches whattodrop\n"
25989 #: ../fish/guestfish-actions.pod:872
25995 #: ../fish/guestfish-actions.pod:874
26004 #: ../fish/guestfish-actions.pod:886
26010 #: ../fish/guestfish-actions.pod:888
26013 " e2fsck-f device\n"
26019 #: ../fish/guestfish-actions.pod:894
26021 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
26022 "should use L</fsck>."
26027 #: ../fish/guestfish-actions.pod:897
26028 msgid "echo-daemon"
26033 #: ../fish/guestfish-actions.pod:899
26036 " echo-daemon 'words ...'\n"
26042 #: ../fish/guestfish-actions.pod:906
26043 msgid "See also L</ping-daemon>."
26048 #: ../fish/guestfish-actions.pod:908
26054 #: ../fish/guestfish-actions.pod:910
26057 " egrep regex path\n"
26063 #: ../fish/guestfish-actions.pod:918
26069 #: ../fish/guestfish-actions.pod:920
26072 " egrepi regex path\n"
26078 #: ../fish/guestfish-actions.pod:928
26084 #: ../fish/guestfish-actions.pod:930
26087 " equal file1 file2\n"
26093 #: ../fish/guestfish-actions.pod:937
26099 #: ../fish/guestfish-actions.pod:939
26108 #: ../fish/guestfish-actions.pod:944
26109 msgid "See also L</is-file>, L</is-dir>, L</stat>."
26114 #: ../fish/guestfish-actions.pod:946
26120 #: ../fish/guestfish-actions.pod:948
26123 " fallocate path len\n"
26129 #: ../fish/guestfish-actions.pod:965
26130 msgid "fallocate64"
26135 #: ../fish/guestfish-actions.pod:967
26138 " fallocate64 path len\n"
26144 #: ../fish/guestfish-actions.pod:973
26146 "Note that this call allocates disk blocks for the file. To create a sparse "
26147 "file use L</truncate-size> instead."
26152 #: ../fish/guestfish-actions.pod:976
26154 "The deprecated call L</fallocate> does the same, but owing to an oversight "
26155 "it only allowed 30 bit lengths to be specified, effectively limiting the "
26156 "maximum size of files created through that call to 1GB."
26161 #: ../fish/guestfish-actions.pod:985
26167 #: ../fish/guestfish-actions.pod:987
26170 " fgrep pattern path\n"
26176 #: ../fish/guestfish-actions.pod:995
26182 #: ../fish/guestfish-actions.pod:997
26185 " fgrepi pattern path\n"
26191 #: ../fish/guestfish-actions.pod:1005
26197 #: ../fish/guestfish-actions.pod:1007
26205 #: ../fish/guestfish-actions.pod:1023
26207 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
26208 "(etc), L</is-zero>."
26213 #: ../fish/guestfish-actions.pod:1026
26214 msgid "file-architecture"
26219 #: ../fish/guestfish-actions.pod:1028
26222 " file-architecture filename\n"
26228 #: ../fish/guestfish-actions.pod:1131
26234 #: ../fish/guestfish-actions.pod:1133
26243 #: ../fish/guestfish-actions.pod:1137
26245 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
26246 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
26251 #: ../fish/guestfish-actions.pod:1141
26257 #: ../fish/guestfish-actions.pod:1143
26260 " fill c len path\n"
26266 #: ../fish/guestfish-actions.pod:1149
26268 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26269 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
26270 "L</fill-pattern>."
26275 #: ../fish/guestfish-actions.pod:1154
26276 msgid "fill-pattern"
26281 #: ../fish/guestfish-actions.pod:1156
26284 " fill-pattern pattern len path\n"
26290 #: ../fish/guestfish-actions.pod:1158
26292 "This function is like L</fill> except that it creates a new file of length "
26293 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
26294 "is truncated if necessary to ensure the length of the file is exactly C<len> "
26300 #: ../fish/guestfish-actions.pod:1163
26306 #: ../fish/guestfish-actions.pod:1165
26309 " find directory\n"
26315 #: ../fish/guestfish-actions.pod:1179
26316 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
26321 #: ../fish/guestfish-actions.pod:1192
26322 msgid "See also L</find0>."
26327 #: ../fish/guestfish-actions.pod:1197
26333 #: ../fish/guestfish-actions.pod:1199
26336 " find0 directory (files|-)\n"
26342 #: ../fish/guestfish-actions.pod:1205
26344 "This command works the same way as L</find> with the following exceptions:"
26349 #: ../fish/guestfish-actions.pod:1232
26350 msgid "findfs-label"
26355 #: ../fish/guestfish-actions.pod:1234
26358 " findfs-label label\n"
26364 #: ../fish/guestfish-actions.pod:1240
26365 msgid "To find the label of a filesystem, use L</vfs-label>."
26370 #: ../fish/guestfish-actions.pod:1242
26371 msgid "findfs-uuid"
26376 #: ../fish/guestfish-actions.pod:1244
26379 " findfs-uuid uuid\n"
26385 #: ../fish/guestfish-actions.pod:1250
26386 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26391 #: ../fish/guestfish-actions.pod:1252
26397 #: ../fish/guestfish-actions.pod:1254
26400 " fsck fstype device\n"
26406 #: ../fish/guestfish-actions.pod:1284
26412 #: ../fish/guestfish-actions.pod:1286
26420 #: ../fish/guestfish-actions.pod:1293
26421 msgid "get-attach-method"
26425 #: ../fish/guestfish-actions.pod:1295
26428 " get-attach-method\n"
26433 #: ../fish/guestfish-actions.pod:1297
26434 msgid "Return the current attach method. See L</set-attach-method>."
26439 #: ../fish/guestfish-actions.pod:1299
26440 msgid "get-autosync"
26445 #: ../fish/guestfish-actions.pod:1301
26454 #: ../fish/guestfish-actions.pod:1305
26460 #: ../fish/guestfish-actions.pod:1307
26469 #: ../fish/guestfish-actions.pod:1311
26470 msgid "get-e2label"
26475 #: ../fish/guestfish-actions.pod:1313
26478 " get-e2label device\n"
26484 #: ../fish/guestfish-actions.pod:1325
26490 #: ../fish/guestfish-actions.pod:1327
26493 " get-e2uuid device\n"
26499 #: ../fish/guestfish-actions.pod:1339
26500 msgid "get-memsize"
26505 #: ../fish/guestfish-actions.pod:1341
26514 #: ../fish/guestfish-actions.pod:1346
26516 "If L</set-memsize> was not called on this handle, and if "
26517 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26518 "value for memsize."
26523 #: ../fish/guestfish-actions.pod:1353
26524 msgid "get-network"
26529 #: ../fish/guestfish-actions.pod:1355
26538 #: ../fish/guestfish-actions.pod:1359
26544 #: ../fish/guestfish-actions.pod:1361
26553 #: ../fish/guestfish-actions.pod:1368
26559 #: ../fish/guestfish-actions.pod:1370
26565 #: ../fish/guestfish-actions.pod:1372
26574 #: ../fish/guestfish-actions.pod:1379
26580 #: ../fish/guestfish-actions.pod:1381
26589 #: ../fish/guestfish-actions.pod:1388
26590 msgid "get-recovery-proc"
26595 #: ../fish/guestfish-actions.pod:1390
26598 " get-recovery-proc\n"
26604 #: ../fish/guestfish-actions.pod:1394
26605 msgid "get-selinux"
26610 #: ../fish/guestfish-actions.pod:1396
26619 #: ../fish/guestfish-actions.pod:1398
26621 "This returns the current setting of the selinux flag which is passed to the "
26622 "appliance at boot time. See L</set-selinux>."
26627 #: ../fish/guestfish-actions.pod:1404
26633 #: ../fish/guestfish-actions.pod:1406
26642 #: ../fish/guestfish-actions.pod:1413
26648 #: ../fish/guestfish-actions.pod:1415
26657 #: ../fish/guestfish-actions.pod:1419
26663 #: ../fish/guestfish-actions.pod:1421
26672 #: ../fish/guestfish-actions.pod:1423
26674 "Return the current umask. By default the umask is C<022> unless it has been "
26675 "set by calling L</umask>."
26680 #: ../fish/guestfish-actions.pod:1426
26681 msgid "get-verbose"
26686 #: ../fish/guestfish-actions.pod:1428
26695 #: ../fish/guestfish-actions.pod:1432
26701 #: ../fish/guestfish-actions.pod:1434
26710 #: ../fish/guestfish-actions.pod:1438
26711 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26716 #: ../fish/guestfish-actions.pod:1441
26722 #: ../fish/guestfish-actions.pod:1443
26725 " getxattr path name\n"
26731 #: ../fish/guestfish-actions.pod:1445
26733 "Get a single extended attribute from file C<path> named C<name>. This call "
26734 "follows symlinks. If you want to lookup an extended attribute for the "
26735 "symlink itself, use L</lgetxattr>."
26740 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
26742 "Normally it is better to get all extended attributes from a file in one go "
26743 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26744 "buggy and do not provide a way to list out attributes. For these "
26745 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26746 "attributes you want in advance and call this function."
26751 #: ../fish/guestfish-actions.pod:1459
26752 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26757 #: ../fish/guestfish-actions.pod:1461
26763 #: ../fish/guestfish-actions.pod:1463
26766 " getxattrs path\n"
26772 #: ../fish/guestfish-actions.pod:1471
26773 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26778 #: ../fish/guestfish-actions.pod:1473
26779 msgid "glob-expand"
26784 #: ../fish/guestfish-actions.pod:1475
26787 " glob-expand pattern\n"
26793 #: ../fish/guestfish-actions.pod:1488
26799 #: ../fish/guestfish-actions.pod:1490
26802 " grep regex path\n"
26808 #: ../fish/guestfish-actions.pod:1498
26814 #: ../fish/guestfish-actions.pod:1500
26817 " grepi regex path\n"
26823 #: ../fish/guestfish-actions.pod:1508
26824 msgid "grub-install"
26829 #: ../fish/guestfish-actions.pod:1510
26832 " grub-install root device\n"
26838 #: ../fish/guestfish-actions.pod:1526
26844 #: ../fish/guestfish-actions.pod:1528
26853 #: ../fish/guestfish-actions.pod:1536
26859 #: ../fish/guestfish-actions.pod:1538
26862 " head-n nrlines path\n"
26868 #: ../fish/guestfish-actions.pod:1551
26874 #: ../fish/guestfish-actions.pod:1553
26883 #: ../fish/guestfish-actions.pod:1561
26889 #: ../fish/guestfish-actions.pod:1563
26892 " initrd-cat initrdpath filename\n"
26898 #: ../fish/guestfish-actions.pod:1575
26899 msgid "See also L</initrd-list>."
26904 #: ../fish/guestfish-actions.pod:1580
26905 msgid "initrd-list"
26910 #: ../fish/guestfish-actions.pod:1582
26913 " initrd-list path\n"
26919 #: ../fish/guestfish-actions.pod:1594
26920 msgid "inotify-add-watch"
26925 #: ../fish/guestfish-actions.pod:1596
26928 " inotify-add-watch path mask\n"
26934 #: ../fish/guestfish-actions.pod:1608
26935 msgid "inotify-close"
26940 #: ../fish/guestfish-actions.pod:1610
26949 #: ../fish/guestfish-actions.pod:1616
26950 msgid "inotify-files"
26955 #: ../fish/guestfish-actions.pod:1618
26964 #: ../fish/guestfish-actions.pod:1620
26966 "This function is a helpful wrapper around L</inotify-read> which just "
26967 "returns a list of pathnames of objects that were touched. The returned "
26968 "pathnames are sorted and deduplicated."
26973 #: ../fish/guestfish-actions.pod:1624
26974 msgid "inotify-init"
26979 #: ../fish/guestfish-actions.pod:1626
26982 " inotify-init maxevents\n"
26988 #: ../fish/guestfish-actions.pod:1632
26990 "C<maxevents> is the maximum number of events which will be queued up between "
26991 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26992 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26993 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26994 "but records the fact that it threw them away by setting a flag "
26995 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
27000 #: ../fish/guestfish-actions.pod:1642
27002 "Before any events are generated, you have to add some watches to the "
27003 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
27004 "L</inotify-watch-all>."
27009 #: ../fish/guestfish-actions.pod:1648
27011 "Queued up events should be read periodically by calling L</inotify-read> (or "
27012 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
27013 "If you don't read the events out often enough then you risk the internal "
27014 "queue overflowing."
27019 #: ../fish/guestfish-actions.pod:1655
27021 "The handle should be closed after use by calling L</inotify-close>. This "
27022 "also removes any watches automatically."
27027 #: ../fish/guestfish-actions.pod:1664
27028 msgid "inotify-read"
27033 #: ../fish/guestfish-actions.pod:1666
27042 #: ../fish/guestfish-actions.pod:1679
27043 msgid "inotify-rm-watch"
27048 #: ../fish/guestfish-actions.pod:1681
27051 " inotify-rm-watch wd\n"
27057 #: ../fish/guestfish-actions.pod:1683
27058 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
27063 #: ../fish/guestfish-actions.pod:1686
27064 msgid "inspect-get-arch"
27069 #: ../fish/guestfish-actions.pod:1688
27072 " inspect-get-arch root\n"
27078 #: ../fish/guestfish-actions.pod:1690
27080 "This returns the architecture of the inspected operating system. The "
27081 "possible return values are listed under L</file-architecture>."
27086 #: ../fish/guestfish-actions.pod:1699
27087 msgid "inspect-get-distro"
27092 #: ../fish/guestfish-actions.pod:1701
27095 " inspect-get-distro root\n"
27100 #: ../fish/guestfish-actions.pod:1782
27101 msgid "inspect-get-drive-mappings"
27105 #: ../fish/guestfish-actions.pod:1784
27108 " inspect-get-drive-mappings root\n"
27113 #: ../fish/guestfish-actions.pod:1811
27115 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27116 "get-mountpoints>, L</inspect-get-filesystems>."
27121 #: ../fish/guestfish-actions.pod:1815
27122 msgid "inspect-get-filesystems"
27127 #: ../fish/guestfish-actions.pod:1817
27130 " inspect-get-filesystems root\n"
27136 #: ../fish/guestfish-actions.pod:1827
27138 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27139 "get-mountpoints>."
27143 #: ../fish/guestfish-actions.pod:1830
27144 msgid "inspect-get-format"
27148 #: ../fish/guestfish-actions.pod:1832
27151 " inspect-get-format root\n"
27157 #: ../fish/guestfish-actions.pod:1861
27158 msgid "inspect-get-hostname"
27163 #: ../fish/guestfish-actions.pod:1863
27166 " inspect-get-hostname root\n"
27171 #: ../fish/guestfish-actions.pod:1873
27172 msgid "inspect-get-icon"
27176 #: ../fish/guestfish-actions.pod:1875
27179 " inspect-get-icon root [favicon:..] [highquality:..]\n"
27185 #: ../fish/guestfish-actions.pod:1939
27186 msgid "inspect-get-major-version"
27191 #: ../fish/guestfish-actions.pod:1941
27194 " inspect-get-major-version root\n"
27200 #: ../fish/guestfish-actions.pod:1957
27201 msgid "inspect-get-minor-version"
27206 #: ../fish/guestfish-actions.pod:1959
27209 " inspect-get-minor-version root\n"
27215 #: ../fish/guestfish-actions.pod:1966
27217 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27218 "get-major-version>."
27223 #: ../fish/guestfish-actions.pod:1969
27224 msgid "inspect-get-mountpoints"
27229 #: ../fish/guestfish-actions.pod:1971
27232 " inspect-get-mountpoints root\n"
27237 #: ../fish/guestfish-actions.pod:1990
27239 "For operating systems like Windows which still use drive letters, this call "
27240 "will only return an entry for the first drive \"mounted on\" C</>. For "
27241 "information about the mapping of drive letters to partitions, see L</inspect-"
27242 "get-drive-mappings>."
27247 #: ../fish/guestfish-actions.pod:1996
27249 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27250 "get-filesystems>."
27255 #: ../fish/guestfish-actions.pod:1999
27256 msgid "inspect-get-package-format"
27261 #: ../fish/guestfish-actions.pod:2001
27264 " inspect-get-package-format root\n"
27270 #: ../fish/guestfish-actions.pod:2003
27272 "This function and L</inspect-get-package-management> return the package "
27273 "format and package management tool used by the inspected operating system. "
27274 "For example for Fedora these functions would return C<rpm> (package format) "
27275 "and C<yum> (package management)."
27280 #: ../fish/guestfish-actions.pod:2018
27281 msgid "inspect-get-package-management"
27286 #: ../fish/guestfish-actions.pod:2020
27289 " inspect-get-package-management root\n"
27295 #: ../fish/guestfish-actions.pod:2022
27297 "L</inspect-get-package-format> and this function return the package format "
27298 "and package management tool used by the inspected operating system. For "
27299 "example for Fedora these functions would return C<rpm> (package format) and "
27300 "C<yum> (package management)."
27305 #: ../fish/guestfish-actions.pod:2039
27306 msgid "inspect-get-product-name"
27311 #: ../fish/guestfish-actions.pod:2041
27314 " inspect-get-product-name root\n"
27319 #: ../fish/guestfish-actions.pod:2053
27320 msgid "inspect-get-product-variant"
27324 #: ../fish/guestfish-actions.pod:2055
27327 " inspect-get-product-variant root\n"
27332 #: ../fish/guestfish-actions.pod:2076
27334 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27335 "get-product-name>, L</inspect-get-major-version>."
27340 #: ../fish/guestfish-actions.pod:2080
27341 msgid "inspect-get-roots"
27346 #: ../fish/guestfish-actions.pod:2082
27349 " inspect-get-roots\n"
27355 #: ../fish/guestfish-actions.pod:2084
27357 "This function is a convenient way to get the list of root devices, as "
27358 "returned from a previous call to L</inspect-os>, but without redoing the "
27359 "whole inspection process."
27364 #: ../fish/guestfish-actions.pod:2088
27366 "This returns an empty list if either no root devices were found or the "
27367 "caller has not called L</inspect-os>."
27372 #: ../fish/guestfish-actions.pod:2093
27373 msgid "inspect-get-type"
27378 #: ../fish/guestfish-actions.pod:2095
27381 " inspect-get-type root\n"
27386 #: ../fish/guestfish-actions.pod:2125
27387 msgid "inspect-get-windows-current-control-set"
27391 #: ../fish/guestfish-actions.pod:2127
27394 " inspect-get-windows-current-control-set root\n"
27400 #: ../fish/guestfish-actions.pod:2138
27401 msgid "inspect-get-windows-systemroot"
27406 #: ../fish/guestfish-actions.pod:2140
27409 " inspect-get-windows-systemroot root\n"
27414 #: ../fish/guestfish-actions.pod:2151
27415 msgid "inspect-is-live"
27419 #: ../fish/guestfish-actions.pod:2153
27422 " inspect-is-live root\n"
27427 #: ../fish/guestfish-actions.pod:2155
27429 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27430 "then this returns true if a live image was detected on the disk."
27434 #: ../fish/guestfish-actions.pod:2161
27435 msgid "inspect-is-multipart"
27439 #: ../fish/guestfish-actions.pod:2163
27442 " inspect-is-multipart root\n"
27447 #: ../fish/guestfish-actions.pod:2165
27449 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27450 "then this returns true if the disk is part of a set."
27454 #: ../fish/guestfish-actions.pod:2171
27455 msgid "inspect-is-netinst"
27459 #: ../fish/guestfish-actions.pod:2173
27462 " inspect-is-netinst root\n"
27467 #: ../fish/guestfish-actions.pod:2175
27469 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27470 "then this returns true if the disk is a network installer, ie. not a self-"
27471 "contained install CD but one which is likely to require network access to "
27472 "complete the install."
27477 #: ../fish/guestfish-actions.pod:2183
27478 msgid "inspect-list-applications"
27483 #: ../fish/guestfish-actions.pod:2185
27486 " inspect-list-applications root\n"
27492 #: ../fish/guestfish-actions.pod:2189
27494 "I<Note:> This call works differently from other parts of the inspection "
27495 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27496 "then mount up the disks, before calling this. Listing applications is a "
27497 "significantly more difficult operation which requires access to the full "
27498 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27499 "are just returning data cached in the libguestfs handle, this call actually "
27500 "reads parts of the mounted filesystems during the call."
27505 #: ../fish/guestfish-actions.pod:2279
27511 #: ../fish/guestfish-actions.pod:2281
27520 #: ../fish/guestfish-actions.pod:2296
27522 "You can pass the root string(s) returned to other L</inspect-get-*> "
27523 "functions in order to query further information about each operating system, "
27524 "such as the name and version."
27529 #: ../fish/guestfish-actions.pod:2301
27531 "This function uses other libguestfs features such as L</mount-ro> and L</"
27532 "umount-all> in order to mount and unmount filesystems and look at the "
27533 "contents. This should be called with no disks currently mounted. The "
27534 "function may also use Augeas, so any existing Augeas handle will be closed."
27539 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
27540 #: ../fish/guestfish-actions.pod:2557
27541 msgid "See also L</list-filesystems>."
27546 #: ../fish/guestfish-actions.pod:2315
27547 msgid "is-blockdev"
27552 #: ../fish/guestfish-actions.pod:2317
27555 " is-blockdev path\n"
27561 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
27562 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
27563 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
27564 #: ../fish/guestfish-actions.pod:2421
27565 msgid "See also L</stat>."
27570 #: ../fish/guestfish-actions.pod:2324
27576 #: ../fish/guestfish-actions.pod:2326
27585 #: ../fish/guestfish-actions.pod:2333
27591 #: ../fish/guestfish-actions.pod:2335
27594 " is-chardev path\n"
27600 #: ../fish/guestfish-actions.pod:2342
27606 #: ../fish/guestfish-actions.pod:2344
27615 #: ../fish/guestfish-actions.pod:2351
27621 #: ../fish/guestfish-actions.pod:2353
27630 #: ../fish/guestfish-actions.pod:2361
27636 #: ../fish/guestfish-actions.pod:2363
27645 #: ../fish/guestfish-actions.pod:2370
27651 #: ../fish/guestfish-actions.pod:2372
27660 #: ../fish/guestfish-actions.pod:2380
27661 msgid "is-launching"
27666 #: ../fish/guestfish-actions.pod:2382
27675 #: ../fish/guestfish-actions.pod:2389
27681 #: ../fish/guestfish-actions.pod:2391
27690 #: ../fish/guestfish-actions.pod:2396
27696 #: ../fish/guestfish-actions.pod:2398
27705 #: ../fish/guestfish-actions.pod:2405
27711 #: ../fish/guestfish-actions.pod:2407
27714 " is-socket path\n"
27720 #: ../fish/guestfish-actions.pod:2414
27726 #: ../fish/guestfish-actions.pod:2416
27729 " is-symlink path\n"
27734 #: ../fish/guestfish-actions.pod:2423
27739 #: ../fish/guestfish-actions.pod:2425
27747 #: ../fish/guestfish-actions.pod:2430
27748 msgid "is-zero-device"
27752 #: ../fish/guestfish-actions.pod:2432
27755 " is-zero-device device\n"
27761 #: ../fish/guestfish-actions.pod:2438
27762 msgid "kill-subprocess"
27767 #: ../fish/guestfish-actions.pod:2440
27770 " kill-subprocess\n"
27776 #: ../fish/guestfish-actions.pod:2444
27782 #: ../fish/guestfish-actions.pod:2446
27788 #: ../fish/guestfish-actions.pod:2448
27797 #: ../fish/guestfish-actions.pod:2456
27803 #: ../fish/guestfish-actions.pod:2458
27806 " lchown owner group path\n"
27812 #: ../fish/guestfish-actions.pod:2460
27814 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27815 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27821 #: ../fish/guestfish-actions.pod:2468
27827 #: ../fish/guestfish-actions.pod:2470
27830 " lgetxattr path name\n"
27836 #: ../fish/guestfish-actions.pod:2486
27837 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27842 #: ../fish/guestfish-actions.pod:2488
27848 #: ../fish/guestfish-actions.pod:2490
27851 " lgetxattrs path\n"
27857 #: ../fish/guestfish-actions.pod:2492
27859 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27860 "it returns the extended attributes of the link itself."
27864 #: ../fish/guestfish-actions.pod:2496
27869 #: ../fish/guestfish-actions.pod:2498
27878 #: ../fish/guestfish-actions.pod:2503
27879 msgid "list-devices"
27884 #: ../fish/guestfish-actions.pod:2505
27893 #: ../fish/guestfish-actions.pod:2513
27894 msgid "list-filesystems"
27899 #: ../fish/guestfish-actions.pod:2515
27902 " list-filesystems\n"
27908 #: ../fish/guestfish-actions.pod:2534
27910 "This command runs other libguestfs commands, which might include L</mount> "
27911 "and L</umount>, and therefore you should use this soon after launch and only "
27912 "when nothing is mounted."
27917 #: ../fish/guestfish-actions.pod:2538
27919 "Not all of the filesystems returned will be mountable. In particular, swap "
27920 "partitions are returned in the list. Also this command does not check that "
27921 "each filesystem found is valid and mountable, and some filesystems might be "
27922 "mountable but require special options. Filesystems may not all belong to a "
27923 "single logical operating system (use L</inspect-os> to look for OSes)."
27928 #: ../fish/guestfish-actions.pod:2546
27929 msgid "list-partitions"
27934 #: ../fish/guestfish-actions.pod:2548
27937 " list-partitions\n"
27943 #: ../fish/guestfish-actions.pod:2554
27945 "This does not return logical volumes. For that you will need to call L</"
27951 #: ../fish/guestfish-actions.pod:2559
27957 #: ../fish/guestfish-actions.pod:2561
27966 #: ../fish/guestfish-actions.pod:2569
27972 #: ../fish/guestfish-actions.pod:2571
27975 " ln target linkname\n"
27981 #: ../fish/guestfish-actions.pod:2575
27987 #: ../fish/guestfish-actions.pod:2577
27990 " ln-f target linkname\n"
27996 #: ../fish/guestfish-actions.pod:2582
28002 #: ../fish/guestfish-actions.pod:2584
28005 " ln-s target linkname\n"
28011 #: ../fish/guestfish-actions.pod:2588
28017 #: ../fish/guestfish-actions.pod:2590
28020 " ln-sf target linkname\n"
28026 #: ../fish/guestfish-actions.pod:2595
28027 msgid "lremovexattr"
28032 #: ../fish/guestfish-actions.pod:2597
28035 " lremovexattr xattr path\n"
28041 #: ../fish/guestfish-actions.pod:2599
28043 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
28044 "it removes an extended attribute of the link itself."
28049 #: ../fish/guestfish-actions.pod:2603
28055 #: ../fish/guestfish-actions.pod:2605
28064 #: ../fish/guestfish-actions.pod:2611
28066 "This command is mostly useful for interactive sessions. Programs should "
28067 "probably use L</readdir> instead."
28072 #: ../fish/guestfish-actions.pod:2614
28078 #: ../fish/guestfish-actions.pod:2616
28081 " lsetxattr xattr val vallen path\n"
28087 #: ../fish/guestfish-actions.pod:2618
28089 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
28090 "sets an extended attribute of the link itself."
28095 #: ../fish/guestfish-actions.pod:2622
28101 #: ../fish/guestfish-actions.pod:2624
28110 #: ../fish/guestfish-actions.pod:2628
28112 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
28113 "the link is stat-ed, not the file it refers to."
28118 #: ../fish/guestfish-actions.pod:2634
28124 #: ../fish/guestfish-actions.pod:2636
28127 " lstatlist path 'names ...'\n"
28133 #: ../fish/guestfish-actions.pod:2638
28135 "This call allows you to perform the L</lstat> operation on multiple files, "
28136 "where all files are in the directory C<path>. C<names> is the list of files "
28137 "from this directory."
28142 #: ../fish/guestfish-actions.pod:2647
28144 "This call is intended for programs that want to efficiently list a directory "
28145 "contents without making many round-trips. See also L</lxattrlist> for a "
28146 "similarly efficient call for getting extended attributes. Very long "
28147 "directory listings might cause the protocol message size to be exceeded, "
28148 "causing this call to fail. The caller must split up such requests into "
28149 "smaller groups of names."
28154 #: ../fish/guestfish-actions.pod:2655
28155 msgid "luks-add-key"
28160 #: ../fish/guestfish-actions.pod:2657
28163 " luks-add-key device keyslot\n"
28169 #: ../fish/guestfish-actions.pod:2664
28171 "Note that if C<keyslot> already contains a key, then this command will "
28172 "fail. You have to use L</luks-kill-slot> first to remove that key."
28177 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2690
28178 #: ../fish/guestfish-actions.pod:2703 ../fish/guestfish-actions.pod:2717
28179 #: ../fish/guestfish-actions.pod:2740 ../fish/guestfish-actions.pod:2750
28181 "This command has one or more key or passphrase parameters. Guestfish will "
28182 "prompt for these separately."
28187 #: ../fish/guestfish-actions.pod:2671
28193 #: ../fish/guestfish-actions.pod:2673
28196 " luks-close device\n"
28202 #: ../fish/guestfish-actions.pod:2675
28204 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
28205 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
28206 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
28212 #: ../fish/guestfish-actions.pod:2681
28213 msgid "luks-format"
28218 #: ../fish/guestfish-actions.pod:2683
28221 " luks-format device keyslot\n"
28227 #: ../fish/guestfish-actions.pod:2696
28228 msgid "luks-format-cipher"
28233 #: ../fish/guestfish-actions.pod:2698
28236 " luks-format-cipher device keyslot cipher\n"
28242 #: ../fish/guestfish-actions.pod:2700
28244 "This command is the same as L</luks-format> but it also allows you to set "
28245 "the C<cipher> used."
28250 #: ../fish/guestfish-actions.pod:2709
28251 msgid "luks-kill-slot"
28256 #: ../fish/guestfish-actions.pod:2711
28259 " luks-kill-slot device keyslot\n"
28265 #: ../fish/guestfish-actions.pod:2720
28271 #: ../fish/guestfish-actions.pod:2722
28274 " luks-open device mapname\n"
28280 #: ../fish/guestfish-actions.pod:2736
28282 "If this block device contains LVM volume groups, then calling L</vgscan> "
28283 "followed by L</vg-activate-all> will make them visible."
28288 #: ../fish/guestfish-actions.pod:2743
28289 msgid "luks-open-ro"
28294 #: ../fish/guestfish-actions.pod:2745
28297 " luks-open-ro device mapname\n"
28303 #: ../fish/guestfish-actions.pod:2747
28305 "This is the same as L</luks-open> except that a read-only mapping is created."
28310 #: ../fish/guestfish-actions.pod:2753
28316 #: ../fish/guestfish-actions.pod:2755
28319 " lvcreate logvol volgroup mbytes\n"
28325 #: ../fish/guestfish-actions.pod:2760
28326 msgid "lvm-canonical-lv-name"
28331 #: ../fish/guestfish-actions.pod:2762
28334 " lvm-canonical-lv-name lvname\n"
28340 #: ../fish/guestfish-actions.pod:2771
28341 msgid "See also L</is-lv>."
28346 #: ../fish/guestfish-actions.pod:2773
28347 msgid "lvm-clear-filter"
28352 #: ../fish/guestfish-actions.pod:2775
28355 " lvm-clear-filter\n"
28361 #: ../fish/guestfish-actions.pod:2777
28363 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
28369 #: ../fish/guestfish-actions.pod:2783
28370 msgid "lvm-remove-all"
28375 #: ../fish/guestfish-actions.pod:2785
28378 " lvm-remove-all\n"
28384 #: ../fish/guestfish-actions.pod:2793
28385 msgid "lvm-set-filter"
28390 #: ../fish/guestfish-actions.pod:2795
28393 " lvm-set-filter 'devices ...'\n"
28399 #: ../fish/guestfish-actions.pod:2820
28405 #: ../fish/guestfish-actions.pod:2822
28408 " lvremove device\n"
28414 #: ../fish/guestfish-actions.pod:2830
28420 #: ../fish/guestfish-actions.pod:2832
28423 " lvrename logvol newlogvol\n"
28429 #: ../fish/guestfish-actions.pod:2836
28435 #: ../fish/guestfish-actions.pod:2838
28438 " lvresize device mbytes\n"
28444 #: ../fish/guestfish-actions.pod:2844
28445 msgid "lvresize-free"
28450 #: ../fish/guestfish-actions.pod:2846
28453 " lvresize-free lv percent\n"
28459 #: ../fish/guestfish-actions.pod:2854
28465 #: ../fish/guestfish-actions.pod:2856
28474 #: ../fish/guestfish-actions.pod:2864
28475 msgid "See also L</lvs-full>, L</list-filesystems>."
28480 #: ../fish/guestfish-actions.pod:2866
28486 #: ../fish/guestfish-actions.pod:2868
28495 #: ../fish/guestfish-actions.pod:2873
28501 #: ../fish/guestfish-actions.pod:2875
28510 #: ../fish/guestfish-actions.pod:2879
28516 #: ../fish/guestfish-actions.pod:2881
28519 " lxattrlist path 'names ...'\n"
28525 #: ../fish/guestfish-actions.pod:2897
28527 "This call is intended for programs that want to efficiently list a directory "
28528 "contents without making many round-trips. See also L</lstatlist> for a "
28529 "similarly efficient call for getting standard stats. Very long directory "
28530 "listings might cause the protocol message size to be exceeded, causing this "
28531 "call to fail. The caller must split up such requests into smaller groups of "
28537 #: ../fish/guestfish-actions.pod:2905
28543 #: ../fish/guestfish-actions.pod:2907
28552 #: ../fish/guestfish-actions.pod:2911
28558 #: ../fish/guestfish-actions.pod:2913
28561 " mkdir-mode path mode\n"
28567 #: ../fish/guestfish-actions.pod:2922
28568 msgid "See also L</mkdir>, L</umask>"
28573 #: ../fish/guestfish-actions.pod:2924
28579 #: ../fish/guestfish-actions.pod:2926
28588 #: ../fish/guestfish-actions.pod:2931
28594 #: ../fish/guestfish-actions.pod:2933
28597 " mkdtemp template\n"
28603 #: ../fish/guestfish-actions.pod:2954
28609 #: ../fish/guestfish-actions.pod:2956
28612 " mke2fs-J fstype blocksize device journal\n"
28618 #: ../fish/guestfish-actions.pod:2964
28619 msgid "See also L</mke2journal>."
28624 #: ../fish/guestfish-actions.pod:2966
28630 #: ../fish/guestfish-actions.pod:2968
28633 " mke2fs-JL fstype blocksize device label\n"
28639 #: ../fish/guestfish-actions.pod:2973
28640 msgid "See also L</mke2journal-L>."
28645 #: ../fish/guestfish-actions.pod:2975
28651 #: ../fish/guestfish-actions.pod:2977
28654 " mke2fs-JU fstype blocksize device uuid\n"
28660 #: ../fish/guestfish-actions.pod:2982
28661 msgid "See also L</mke2journal-U>."
28666 #: ../fish/guestfish-actions.pod:2984
28667 msgid "mke2journal"
28672 #: ../fish/guestfish-actions.pod:2986
28675 " mke2journal blocksize device\n"
28681 #: ../fish/guestfish-actions.pod:2993
28682 msgid "mke2journal-L"
28687 #: ../fish/guestfish-actions.pod:2995
28690 " mke2journal-L blocksize label device\n"
28696 #: ../fish/guestfish-actions.pod:2999
28697 msgid "mke2journal-U"
28702 #: ../fish/guestfish-actions.pod:3001
28705 " mke2journal-U blocksize uuid device\n"
28711 #: ../fish/guestfish-actions.pod:3005
28717 #: ../fish/guestfish-actions.pod:3007
28720 " mkfifo mode path\n"
28726 #: ../fish/guestfish-actions.pod:3009
28728 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28729 "is just a convenient wrapper around L</mknod>."
28734 #: ../fish/guestfish-actions.pod:3015
28740 #: ../fish/guestfish-actions.pod:3017
28743 " mkfs fstype device\n"
28749 #: ../fish/guestfish-actions.pod:3023
28755 #: ../fish/guestfish-actions.pod:3025
28758 " mkfs-b fstype blocksize device\n"
28764 #: ../fish/guestfish-actions.pod:3027
28766 "This call is similar to L</mkfs>, but it allows you to control the block "
28767 "size of the resulting filesystem. Supported block sizes depend on the "
28768 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28773 #: ../fish/guestfish-actions.pod:3042
28778 #: ../fish/guestfish-actions.pod:3044
28781 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28787 #: ../fish/guestfish-actions.pod:3079
28788 msgid "mkmountpoint"
28793 #: ../fish/guestfish-actions.pod:3081
28796 " mkmountpoint exemptpath\n"
28802 #: ../fish/guestfish-actions.pod:3083
28804 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28805 "to create extra mountpoints before mounting the first filesystem."
28810 #: ../fish/guestfish-actions.pod:3107
28812 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28813 "unexpected errors if you try to mix these calls. It is safest to manually "
28814 "unmount filesystems and remove mountpoints after use."
28819 #: ../fish/guestfish-actions.pod:3111
28821 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28822 "for this to work for manual mountpoints, you must ensure that the innermost "
28823 "mountpoints have the longest pathnames, as in the example code above."
28827 #: ../fish/guestfish-actions.pod:3118
28829 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28830 "L</umount-all> to be called when the handle is closed which can also trigger "
28836 #: ../fish/guestfish-actions.pod:3122
28842 #: ../fish/guestfish-actions.pod:3124
28845 " mknod mode devmajor devminor path\n"
28851 #: ../fish/guestfish-actions.pod:3134
28853 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28854 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28855 "regular file). These constants are available in the standard Linux header "
28856 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28857 "wrappers around this command which bitwise OR in the appropriate constant "
28863 #: ../fish/guestfish-actions.pod:3144
28869 #: ../fish/guestfish-actions.pod:3146
28872 " mknod-b mode devmajor devminor path\n"
28878 #: ../fish/guestfish-actions.pod:3148
28880 "This call creates a block device node called C<path> with mode C<mode> and "
28881 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28882 "wrapper around L</mknod>."
28887 #: ../fish/guestfish-actions.pod:3154
28893 #: ../fish/guestfish-actions.pod:3156
28896 " mknod-c mode devmajor devminor path\n"
28902 #: ../fish/guestfish-actions.pod:3158
28904 "This call creates a char device node called C<path> with mode C<mode> and "
28905 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28906 "wrapper around L</mknod>."
28911 #: ../fish/guestfish-actions.pod:3164
28917 #: ../fish/guestfish-actions.pod:3166
28926 #: ../fish/guestfish-actions.pod:3170
28932 #: ../fish/guestfish-actions.pod:3172
28935 " mkswap-L label device\n"
28941 #: ../fish/guestfish-actions.pod:3180
28947 #: ../fish/guestfish-actions.pod:3182
28950 " mkswap-U uuid device\n"
28956 #: ../fish/guestfish-actions.pod:3186
28957 msgid "mkswap-file"
28962 #: ../fish/guestfish-actions.pod:3188
28965 " mkswap-file path\n"
28971 #: ../fish/guestfish-actions.pod:3192
28973 "This command just writes a swap file signature to an existing file. To "
28974 "create the file itself, use something like L</fallocate>."
28979 #: ../fish/guestfish-actions.pod:3195
28985 #: ../fish/guestfish-actions.pod:3197
28988 " modprobe modulename\n"
28994 #: ../fish/guestfish-actions.pod:3204
29000 #: ../fish/guestfish-actions.pod:3206
29003 " mount device mountpoint\n"
29009 #: ../fish/guestfish-actions.pod:3222
29011 "B<Important note:> When you use this call, the filesystem options C<sync> "
29012 "and C<noatime> are set implicitly. This was originally done because we "
29013 "thought it would improve reliability, but it turns out that I<-o sync> has a "
29014 "very large negative performance impact and negligible effect on "
29015 "reliability. Therefore we recommend that you avoid using L</mount> in any "
29016 "code that needs performance, and instead use L</mount-options> (use an empty "
29017 "string for the first parameter if you don't want any options)."
29021 #: ../fish/guestfish-actions.pod:3239
29026 #: ../fish/guestfish-actions.pod:3241
29029 " mount-9p mounttag mountpoint [options:..]\n"
29035 #: ../fish/guestfish-actions.pod:3252
29041 #: ../fish/guestfish-actions.pod:3254
29044 " mount-loop file mountpoint\n"
29050 #: ../fish/guestfish-actions.pod:3260
29051 msgid "mount-options"
29056 #: ../fish/guestfish-actions.pod:3262
29059 " mount-options options device mountpoint\n"
29065 #: ../fish/guestfish-actions.pod:3264
29067 "This is the same as the L</mount> command, but it allows you to set the "
29068 "mount options as for the L<mount(8)> I<-o> flag."
29073 #: ../fish/guestfish-actions.pod:3272
29079 #: ../fish/guestfish-actions.pod:3274
29082 " mount-ro device mountpoint\n"
29088 #: ../fish/guestfish-actions.pod:3276
29090 "This is the same as the L</mount> command, but it mounts the filesystem with "
29091 "the read-only (I<-o ro>) flag."
29096 #: ../fish/guestfish-actions.pod:3279
29102 #: ../fish/guestfish-actions.pod:3281
29105 " mount-vfs options vfstype device mountpoint\n"
29111 #: ../fish/guestfish-actions.pod:3283
29113 "This is the same as the L</mount> command, but it allows you to set both the "
29114 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
29119 #: ../fish/guestfish-actions.pod:3287
29120 msgid "mountpoints"
29125 #: ../fish/guestfish-actions.pod:3289
29134 #: ../fish/guestfish-actions.pod:3291
29136 "This call is similar to L</mounts>. That call returns a list of devices. "
29137 "This one returns a hash table (map) of device name to directory where the "
29138 "device is mounted."
29143 #: ../fish/guestfish-actions.pod:3295
29149 #: ../fish/guestfish-actions.pod:3297
29158 #: ../fish/guestfish-actions.pod:3304
29159 msgid "See also: L</mountpoints>"
29164 #: ../fish/guestfish-actions.pod:3306
29170 #: ../fish/guestfish-actions.pod:3308
29179 #: ../fish/guestfish-actions.pod:3313
29180 msgid "ntfs-3g-probe"
29185 #: ../fish/guestfish-actions.pod:3315
29188 " ntfs-3g-probe true|false device\n"
29194 #: ../fish/guestfish-actions.pod:3329
29200 #: ../fish/guestfish-actions.pod:3331
29203 " ntfsresize device\n"
29209 #: ../fish/guestfish-actions.pod:3337
29210 msgid "ntfsresize-size"
29215 #: ../fish/guestfish-actions.pod:3339
29218 " ntfsresize-size device size\n"
29224 #: ../fish/guestfish-actions.pod:3341
29226 "This command is the same as L</ntfsresize> except that it allows you to "
29227 "specify the new size (in bytes) explicitly."
29232 #: ../fish/guestfish-actions.pod:3344
29238 #: ../fish/guestfish-actions.pod:3346
29241 " part-add device prlogex startsect endsect\n"
29247 #: ../fish/guestfish-actions.pod:3348
29249 "This command adds a partition to C<device>. If there is no partition table "
29250 "on the device, call L</part-init> first."
29255 #: ../fish/guestfish-actions.pod:3360
29257 "Creating a partition which covers the whole disk is not so easy. Use L</"
29258 "part-disk> to do that."
29263 #: ../fish/guestfish-actions.pod:3363
29269 #: ../fish/guestfish-actions.pod:3365
29272 " part-del device partnum\n"
29278 #: ../fish/guestfish-actions.pod:3373
29284 #: ../fish/guestfish-actions.pod:3375
29287 " part-disk device parttype\n"
29293 #: ../fish/guestfish-actions.pod:3377
29295 "This command is simply a combination of L</part-init> followed by L</part-"
29296 "add> to create a single primary partition covering the whole disk."
29301 #: ../fish/guestfish-actions.pod:3381
29303 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29304 "possible values are described in L</part-init>."
29309 #: ../fish/guestfish-actions.pod:3387
29310 msgid "part-get-bootable"
29315 #: ../fish/guestfish-actions.pod:3389
29318 " part-get-bootable device partnum\n"
29324 #: ../fish/guestfish-actions.pod:3394
29325 msgid "See also L</part-set-bootable>."
29330 #: ../fish/guestfish-actions.pod:3396
29331 msgid "part-get-mbr-id"
29336 #: ../fish/guestfish-actions.pod:3398
29339 " part-get-mbr-id device partnum\n"
29345 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3541
29347 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29348 "undefined results for other partition table types (see L</part-get-"
29354 #: ../fish/guestfish-actions.pod:3407
29355 msgid "part-get-parttype"
29360 #: ../fish/guestfish-actions.pod:3409
29363 " part-get-parttype device\n"
29369 #: ../fish/guestfish-actions.pod:3414
29371 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29372 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29373 "possible, although unusual. See L</part-init> for a full list."
29378 #: ../fish/guestfish-actions.pod:3419
29384 #: ../fish/guestfish-actions.pod:3421
29387 " part-init device parttype\n"
29393 #: ../fish/guestfish-actions.pod:3427
29395 "Initially there are no partitions. Following this, you should call L</part-"
29396 "add> for each partition required."
29401 #: ../fish/guestfish-actions.pod:3490
29407 #: ../fish/guestfish-actions.pod:3492
29410 " part-list device\n"
29416 #: ../fish/guestfish-actions.pod:3507
29418 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29419 "the device's sector size, see L</blockdev-getss>."
29424 #: ../fish/guestfish-actions.pod:3520
29425 msgid "part-set-bootable"
29430 #: ../fish/guestfish-actions.pod:3522
29433 " part-set-bootable device partnum true|false\n"
29439 #: ../fish/guestfish-actions.pod:3531
29440 msgid "part-set-mbr-id"
29445 #: ../fish/guestfish-actions.pod:3533
29448 " part-set-mbr-id device partnum idbyte\n"
29454 #: ../fish/guestfish-actions.pod:3545
29455 msgid "part-set-name"
29460 #: ../fish/guestfish-actions.pod:3547
29463 " part-set-name device partnum name\n"
29469 #: ../fish/guestfish-actions.pod:3555
29470 msgid "part-to-dev"
29475 #: ../fish/guestfish-actions.pod:3557
29478 " part-to-dev partition\n"
29484 #: ../fish/guestfish-actions.pod:3563
29486 "The named partition must exist, for example as a string returned from L</"
29487 "list-partitions>."
29492 #: ../fish/guestfish-actions.pod:3566
29493 msgid "ping-daemon"
29498 #: ../fish/guestfish-actions.pod:3568
29507 #: ../fish/guestfish-actions.pod:3575
29513 #: ../fish/guestfish-actions.pod:3577
29516 " pread path count offset\n"
29522 #: ../fish/guestfish-actions.pod:3585
29523 msgid "See also L</pwrite>, L</pread-device>."
29528 #: ../fish/guestfish-actions.pod:3590
29529 msgid "pread-device"
29534 #: ../fish/guestfish-actions.pod:3592
29537 " pread-device device count offset\n"
29543 #: ../fish/guestfish-actions.pod:3600
29544 msgid "See also L</pread>."
29549 #: ../fish/guestfish-actions.pod:3605
29555 #: ../fish/guestfish-actions.pod:3607
29558 " pvcreate device\n"
29564 #: ../fish/guestfish-actions.pod:3613
29570 #: ../fish/guestfish-actions.pod:3615
29573 " pvremove device\n"
29579 #: ../fish/guestfish-actions.pod:3624
29585 #: ../fish/guestfish-actions.pod:3626
29588 " pvresize device\n"
29594 #: ../fish/guestfish-actions.pod:3631
29595 msgid "pvresize-size"
29600 #: ../fish/guestfish-actions.pod:3633
29603 " pvresize-size device size\n"
29609 #: ../fish/guestfish-actions.pod:3635
29611 "This command is the same as L</pvresize> except that it allows you to "
29612 "specify the new size (in bytes) explicitly."
29617 #: ../fish/guestfish-actions.pod:3638
29623 #: ../fish/guestfish-actions.pod:3640
29632 #: ../fish/guestfish-actions.pod:3648
29633 msgid "See also L</pvs-full>."
29638 #: ../fish/guestfish-actions.pod:3650
29644 #: ../fish/guestfish-actions.pod:3652
29653 #: ../fish/guestfish-actions.pod:3657
29659 #: ../fish/guestfish-actions.pod:3659
29668 #: ../fish/guestfish-actions.pod:3663
29674 #: ../fish/guestfish-actions.pod:3665
29677 " pwrite path content offset\n"
29683 #: ../fish/guestfish-actions.pod:3676
29684 msgid "See also L</pread>, L</pwrite-device>."
29689 #: ../fish/guestfish-actions.pod:3681
29690 msgid "pwrite-device"
29695 #: ../fish/guestfish-actions.pod:3683
29698 " pwrite-device device content offset\n"
29704 #: ../fish/guestfish-actions.pod:3693
29705 msgid "See also L</pwrite>."
29710 #: ../fish/guestfish-actions.pod:3698
29716 #: ../fish/guestfish-actions.pod:3700
29719 " read-file path\n"
29725 #: ../fish/guestfish-actions.pod:3705
29727 "Unlike L</cat>, this function can correctly handle files that contain "
29728 "embedded ASCII NUL characters. However unlike L</download>, this function "
29729 "is limited in the total size of file that can be handled."
29734 #: ../fish/guestfish-actions.pod:3713
29740 #: ../fish/guestfish-actions.pod:3715
29743 " read-lines path\n"
29749 #: ../fish/guestfish-actions.pod:3722
29751 "Note that this function cannot correctly handle binary files (specifically, "
29752 "files containing C<\\0> character which is treated as end of line). For "
29753 "those you need to use the L</read-file> function which has a more complex "
29759 #: ../fish/guestfish-actions.pod:3727
29765 #: ../fish/guestfish-actions.pod:3729
29774 #: ../fish/guestfish-actions.pod:3781
29776 "This function is primarily intended for use by programs. To get a simple "
29777 "list of names, use L</ls>. To get a printable directory for human "
29778 "consumption, use L</ll>."
29783 #: ../fish/guestfish-actions.pod:3785
29789 #: ../fish/guestfish-actions.pod:3787
29798 #: ../fish/guestfish-actions.pod:3791
29799 msgid "readlinklist"
29804 #: ../fish/guestfish-actions.pod:3793
29807 " readlinklist path 'names ...'\n"
29813 #: ../fish/guestfish-actions.pod:3817
29819 #: ../fish/guestfish-actions.pod:3819
29828 #: ../fish/guestfish-actions.pod:3824
29829 msgid "removexattr"
29834 #: ../fish/guestfish-actions.pod:3826
29837 " removexattr xattr path\n"
29843 #: ../fish/guestfish-actions.pod:3831
29844 msgid "See also: L</lremovexattr>, L<attr(5)>."
29849 #: ../fish/guestfish-actions.pod:3833
29855 #: ../fish/guestfish-actions.pod:3835
29858 " resize2fs device\n"
29864 #: ../fish/guestfish-actions.pod:3840
29866 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29867 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29868 "gives an error about this and sometimes not. In any case, it is always safe "
29869 "to call L</e2fsck-f> before calling this function."
29873 #: ../fish/guestfish-actions.pod:3846
29874 msgid "resize2fs-M"
29878 #: ../fish/guestfish-actions.pod:3848
29881 " resize2fs-M device\n"
29886 #: ../fish/guestfish-actions.pod:3850
29888 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29889 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29894 #: ../fish/guestfish-actions.pod:3854
29896 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29897 "and read the C<Block size> and C<Block count> values. These two numbers, "
29898 "multiplied together, give the resulting size of the minimal filesystem in "
29904 #: ../fish/guestfish-actions.pod:3859
29905 msgid "resize2fs-size"
29910 #: ../fish/guestfish-actions.pod:3861
29913 " resize2fs-size device size\n"
29919 #: ../fish/guestfish-actions.pod:3863
29921 "This command is the same as L</resize2fs> except that it allows you to "
29922 "specify the new size (in bytes) explicitly."
29927 #: ../fish/guestfish-actions.pod:3866
29933 #: ../fish/guestfish-actions.pod:3868
29942 #: ../fish/guestfish-actions.pod:3872
29948 #: ../fish/guestfish-actions.pod:3874
29957 #: ../fish/guestfish-actions.pod:3880
29963 #: ../fish/guestfish-actions.pod:3882
29972 #: ../fish/guestfish-actions.pod:3886
29973 msgid "rmmountpoint"
29978 #: ../fish/guestfish-actions.pod:3888
29981 " rmmountpoint exemptpath\n"
29987 #: ../fish/guestfish-actions.pod:3890
29989 "This calls removes a mountpoint that was previously created with L</"
29990 "mkmountpoint>. See L</mkmountpoint> for full details."
29995 #: ../fish/guestfish-actions.pod:3894
29996 msgid "scrub-device"
30001 #: ../fish/guestfish-actions.pod:3896
30004 " scrub-device device\n"
30010 #: ../fish/guestfish-actions.pod:3907
30016 #: ../fish/guestfish-actions.pod:3909
30019 " scrub-file file\n"
30025 #: ../fish/guestfish-actions.pod:3919
30026 msgid "scrub-freespace"
30031 #: ../fish/guestfish-actions.pod:3921
30034 " scrub-freespace dir\n"
30040 #: ../fish/guestfish-actions.pod:3923
30042 "This command creates the directory C<dir> and then fills it with files until "
30043 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
30044 "deletes them. The intention is to scrub any free space on the partition "
30045 "containing C<dir>."
30050 #: ../fish/guestfish-actions.pod:3932
30056 #: ../fish/guestfish-actions.pod:3934
30062 #: ../fish/guestfish-actions.pod:3936
30065 " set-append append\n"
30070 #: ../fish/guestfish-actions.pod:3947
30071 msgid "set-attach-method"
30075 #: ../fish/guestfish-actions.pod:3949
30076 msgid "attach-method"
30080 #: ../fish/guestfish-actions.pod:3951
30083 " set-attach-method attachmethod\n"
30089 #: ../fish/guestfish-actions.pod:3973
30090 msgid "set-autosync"
30095 #: ../fish/guestfish-actions.pod:3975
30101 #: ../fish/guestfish-actions.pod:3977
30104 " set-autosync true|false\n"
30110 #: ../fish/guestfish-actions.pod:3987
30116 #: ../fish/guestfish-actions.pod:3989
30122 #: ../fish/guestfish-actions.pod:3991
30125 " set-direct true|false\n"
30131 #: ../fish/guestfish-actions.pod:3997
30133 "One consequence of this is that log messages aren't caught by the library "
30134 "and handled by L</set-log-message-callback>, but go straight to stdout."
30139 #: ../fish/guestfish-actions.pod:4006
30140 msgid "set-e2label"
30145 #: ../fish/guestfish-actions.pod:4008
30148 " set-e2label device label\n"
30154 #: ../fish/guestfish-actions.pod:4014
30156 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
30157 "label on a filesystem."
30162 #: ../fish/guestfish-actions.pod:4017
30168 #: ../fish/guestfish-actions.pod:4019
30171 " set-e2uuid device uuid\n"
30177 #: ../fish/guestfish-actions.pod:4026
30179 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
30180 "UUID of a filesystem."
30185 #: ../fish/guestfish-actions.pod:4029
30186 msgid "set-memsize"
30191 #: ../fish/guestfish-actions.pod:4031
30197 #: ../fish/guestfish-actions.pod:4033
30200 " set-memsize memsize\n"
30206 #: ../fish/guestfish-actions.pod:4035
30208 "This sets the memory size in megabytes allocated to the qemu subprocess. "
30209 "This only has any effect if called before L</launch>."
30214 #: ../fish/guestfish-actions.pod:4046
30215 msgid "set-network"
30220 #: ../fish/guestfish-actions.pod:4048
30226 #: ../fish/guestfish-actions.pod:4050
30229 " set-network true|false\n"
30235 #: ../fish/guestfish-actions.pod:4058
30237 "You must call this before calling L</launch>, otherwise it has no effect."
30242 #: ../fish/guestfish-actions.pod:4061
30248 #: ../fish/guestfish-actions.pod:4063
30254 #: ../fish/guestfish-actions.pod:4065
30257 " set-path searchpath\n"
30263 #: ../fish/guestfish-actions.pod:4074
30269 #: ../fish/guestfish-actions.pod:4076
30275 #: ../fish/guestfish-actions.pod:4078
30284 #: ../fish/guestfish-actions.pod:4098
30285 msgid "set-recovery-proc"
30290 #: ../fish/guestfish-actions.pod:4100
30291 msgid "recovery-proc"
30296 #: ../fish/guestfish-actions.pod:4102
30299 " set-recovery-proc true|false\n"
30305 #: ../fish/guestfish-actions.pod:4104
30307 "If this is called with the parameter C<false> then L</launch> does not "
30308 "create a recovery process. The purpose of the recovery process is to stop "
30309 "runaway qemu processes in the case where the main program aborts abruptly."
30314 #: ../fish/guestfish-actions.pod:4109
30316 "This only has any effect if called before L</launch>, and the default is "
30322 #: ../fish/guestfish-actions.pod:4118
30323 msgid "set-selinux"
30328 #: ../fish/guestfish-actions.pod:4120
30334 #: ../fish/guestfish-actions.pod:4122
30337 " set-selinux true|false\n"
30343 #: ../fish/guestfish-actions.pod:4133
30349 #: ../fish/guestfish-actions.pod:4135
30355 #: ../fish/guestfish-actions.pod:4137
30358 " set-trace true|false\n"
30363 #: ../fish/guestfish-actions.pod:4149
30365 "Trace messages are normally sent to C<stderr>, unless you register a "
30366 "callback to send them somewhere else (see L</set-event-callback>)."
30371 #: ../fish/guestfish-actions.pod:4153
30372 msgid "set-verbose"
30377 #: ../fish/guestfish-actions.pod:4155
30383 #: ../fish/guestfish-actions.pod:4157
30386 " set-verbose true|false\n"
30391 #: ../fish/guestfish-actions.pod:4164
30393 "Verbose messages are normally sent to C<stderr>, unless you register a "
30394 "callback to send them somewhere else (see L</set-event-callback>)."
30399 #: ../fish/guestfish-actions.pod:4168
30405 #: ../fish/guestfish-actions.pod:4170
30408 " setcon context\n"
30414 #: ../fish/guestfish-actions.pod:4177
30420 #: ../fish/guestfish-actions.pod:4179
30423 " setxattr xattr val vallen path\n"
30429 #: ../fish/guestfish-actions.pod:4185
30430 msgid "See also: L</lsetxattr>, L<attr(5)>."
30435 #: ../fish/guestfish-actions.pod:4187
30441 #: ../fish/guestfish-actions.pod:4189
30444 " sfdisk device cyls heads sectors 'lines ...'\n"
30450 #: ../fish/guestfish-actions.pod:4211
30451 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30456 #: ../fish/guestfish-actions.pod:4224
30462 #: ../fish/guestfish-actions.pod:4226
30465 " sfdiskM device 'lines ...'\n"
30471 #: ../fish/guestfish-actions.pod:4228
30473 "This is a simplified interface to the L</sfdisk> command, where partition "
30474 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30475 "you don't need to specify the cyls, heads and sectors parameters which were "
30476 "rarely if ever used anyway."
30481 #: ../fish/guestfish-actions.pod:4234
30482 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30487 #: ../fish/guestfish-actions.pod:4247
30493 #: ../fish/guestfish-actions.pod:4249
30496 " sfdisk-N device partnum cyls heads sectors line\n"
30502 #: ../fish/guestfish-actions.pod:4254
30504 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30505 "cyls/heads/sectors parameters."
30510 #: ../fish/guestfish-actions.pod:4257
30511 msgid "See also: L</part-add>"
30516 #: ../fish/guestfish-actions.pod:4269
30517 msgid "sfdisk-disk-geometry"
30522 #: ../fish/guestfish-actions.pod:4271
30525 " sfdisk-disk-geometry device\n"
30531 #: ../fish/guestfish-actions.pod:4273
30533 "This displays the disk geometry of C<device> read from the partition table. "
30534 "Especially in the case where the underlying block device has been resized, "
30535 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30536 "kernel-geometry>)."
30541 #: ../fish/guestfish-actions.pod:4281
30542 msgid "sfdisk-kernel-geometry"
30547 #: ../fish/guestfish-actions.pod:4283
30550 " sfdisk-kernel-geometry device\n"
30556 #: ../fish/guestfish-actions.pod:4290
30562 #: ../fish/guestfish-actions.pod:4292
30565 " sfdisk-l device\n"
30571 #: ../fish/guestfish-actions.pod:4298
30572 msgid "See also: L</part-list>"
30577 #: ../fish/guestfish-actions.pod:4307
30583 #: ../fish/guestfish-actions.pod:4309
30592 #: ../fish/guestfish-actions.pod:4314
30593 msgid "This is like L</command>, but passes the command to:"
30598 #: ../fish/guestfish-actions.pod:4322
30599 msgid "All the provisos about L</command> apply to this call."
30604 #: ../fish/guestfish-actions.pod:4324
30610 #: ../fish/guestfish-actions.pod:4326
30613 " sh-lines command\n"
30619 #: ../fish/guestfish-actions.pod:4328
30620 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30625 #: ../fish/guestfish-actions.pod:4331
30626 msgid "See also: L</command-lines>"
30631 #: ../fish/guestfish-actions.pod:4333
30637 #: ../fish/guestfish-actions.pod:4335
30646 #: ../fish/guestfish-actions.pod:4339
30652 #: ../fish/guestfish-actions.pod:4341
30661 #: ../fish/guestfish-actions.pod:4347
30667 #: ../fish/guestfish-actions.pod:4349
30676 #: ../fish/guestfish-actions.pod:4357
30682 #: ../fish/guestfish-actions.pod:4359
30691 #: ../fish/guestfish-actions.pod:4367
30697 #: ../fish/guestfish-actions.pod:4369
30700 " strings-e encoding path\n"
30706 #: ../fish/guestfish-actions.pod:4371
30708 "This is like the L</strings> command, but allows you to specify the encoding "
30709 "of strings that are looked for in the source file C<path>."
30714 #: ../fish/guestfish-actions.pod:4381
30716 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30717 "ISO-8859-X (this is what L</strings> uses)."
30722 #: ../fish/guestfish-actions.pod:4413
30723 msgid "swapoff-device"
30728 #: ../fish/guestfish-actions.pod:4415
30731 " swapoff-device device\n"
30737 #: ../fish/guestfish-actions.pod:4417
30739 "This command disables the libguestfs appliance swap device or partition "
30740 "named C<device>. See L</swapon-device>."
30745 #: ../fish/guestfish-actions.pod:4421
30746 msgid "swapoff-file"
30751 #: ../fish/guestfish-actions.pod:4423
30754 " swapoff-file file\n"
30760 #: ../fish/guestfish-actions.pod:4427
30761 msgid "swapoff-label"
30766 #: ../fish/guestfish-actions.pod:4429
30769 " swapoff-label label\n"
30775 #: ../fish/guestfish-actions.pod:4434
30776 msgid "swapoff-uuid"
30781 #: ../fish/guestfish-actions.pod:4436
30784 " swapoff-uuid uuid\n"
30790 #: ../fish/guestfish-actions.pod:4441
30791 msgid "swapon-device"
30796 #: ../fish/guestfish-actions.pod:4443
30799 " swapon-device device\n"
30805 #: ../fish/guestfish-actions.pod:4445
30807 "This command enables the libguestfs appliance to use the swap device or "
30808 "partition named C<device>. The increased memory is made available for all "
30809 "commands, for example those run using L</command> or L</sh>."
30814 #: ../fish/guestfish-actions.pod:4457
30815 msgid "swapon-file"
30820 #: ../fish/guestfish-actions.pod:4459
30823 " swapon-file file\n"
30829 #: ../fish/guestfish-actions.pod:4461
30831 "This command enables swap to a file. See L</swapon-device> for other notes."
30836 #: ../fish/guestfish-actions.pod:4464
30837 msgid "swapon-label"
30842 #: ../fish/guestfish-actions.pod:4466
30845 " swapon-label label\n"
30851 #: ../fish/guestfish-actions.pod:4468
30853 "This command enables swap to a labeled swap partition. See L</swapon-"
30854 "device> for other notes."
30859 #: ../fish/guestfish-actions.pod:4471
30860 msgid "swapon-uuid"
30865 #: ../fish/guestfish-actions.pod:4473
30868 " swapon-uuid uuid\n"
30874 #: ../fish/guestfish-actions.pod:4475
30876 "This command enables swap to a swap partition with the given UUID. See L</"
30877 "swapon-device> for other notes."
30882 #: ../fish/guestfish-actions.pod:4478
30888 #: ../fish/guestfish-actions.pod:4480
30897 #: ../fish/guestfish-actions.pod:4488
30903 #: ../fish/guestfish-actions.pod:4490
30912 #: ../fish/guestfish-actions.pod:4498
30918 #: ../fish/guestfish-actions.pod:4500
30921 " tail-n nrlines path\n"
30927 #: ../fish/guestfish-actions.pod:4513
30933 #: ../fish/guestfish-actions.pod:4515
30936 " tar-in (tarfile|-) directory\n"
30942 #: ../fish/guestfish-actions.pod:4520
30943 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30948 #: ../fish/guestfish-actions.pod:4525
30954 #: ../fish/guestfish-actions.pod:4527
30957 " tar-out directory (tarfile|-)\n"
30963 #: ../fish/guestfish-actions.pod:4532
30964 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30969 #: ../fish/guestfish-actions.pod:4537
30975 #: ../fish/guestfish-actions.pod:4539
30978 " tgz-in (tarball|-) directory\n"
30984 #: ../fish/guestfish-actions.pod:4544
30985 msgid "To upload an uncompressed tarball, use L</tar-in>."
30990 #: ../fish/guestfish-actions.pod:4548
30996 #: ../fish/guestfish-actions.pod:4550
30999 " tgz-out directory (tarball|-)\n"
31005 #: ../fish/guestfish-actions.pod:4555
31006 msgid "To download an uncompressed tarball, use L</tar-out>."
31011 #: ../fish/guestfish-actions.pod:4559
31017 #: ../fish/guestfish-actions.pod:4561
31026 #: ../fish/guestfish-actions.pod:4570
31032 #: ../fish/guestfish-actions.pod:4572
31041 #: ../fish/guestfish-actions.pod:4577
31042 msgid "truncate-size"
31047 #: ../fish/guestfish-actions.pod:4579
31050 " truncate-size path size\n"
31056 #: ../fish/guestfish-actions.pod:4584
31058 "If the current file size is less than C<size> then the file is extended to "
31059 "the required size with zero bytes. This creates a sparse file (ie. disk "
31060 "blocks are not allocated for the file until you write to it). To create a "
31061 "non-sparse file of zeroes, use L</fallocate64> instead."
31066 #: ../fish/guestfish-actions.pod:4590
31072 #: ../fish/guestfish-actions.pod:4592
31075 " tune2fs-l device\n"
31081 #: ../fish/guestfish-actions.pod:4602
31087 #: ../fish/guestfish-actions.pod:4604
31090 " txz-in (tarball|-) directory\n"
31096 #: ../fish/guestfish-actions.pod:4611
31102 #: ../fish/guestfish-actions.pod:4613
31105 " txz-out directory (tarball|-)\n"
31111 #: ../fish/guestfish-actions.pod:4620
31117 #: ../fish/guestfish-actions.pod:4622
31126 #: ../fish/guestfish-actions.pod:4636
31127 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
31132 #: ../fish/guestfish-actions.pod:4641
31138 #: ../fish/guestfish-actions.pod:4643
31144 #: ../fish/guestfish-actions.pod:4645
31147 " umount pathordevice\n"
31153 #: ../fish/guestfish-actions.pod:4651
31159 #: ../fish/guestfish-actions.pod:4653
31160 msgid "unmount-all"
31165 #: ../fish/guestfish-actions.pod:4655
31174 #: ../fish/guestfish-actions.pod:4661
31180 #: ../fish/guestfish-actions.pod:4663
31183 " upload (filename|-) remotefilename\n"
31189 #: ../fish/guestfish-actions.pod:4670
31190 msgid "See also L</download>."
31195 #: ../fish/guestfish-actions.pod:4674
31196 msgid "upload-offset"
31201 #: ../fish/guestfish-actions.pod:4676
31204 " upload-offset (filename|-) remotefilename offset\n"
31210 #: ../fish/guestfish-actions.pod:4688
31212 "Note that there is no limit on the amount of data that can be uploaded with "
31213 "this call, unlike with L</pwrite>, and this call always writes the full "
31214 "amount unless an error occurs."
31219 #: ../fish/guestfish-actions.pod:4693
31220 msgid "See also L</upload>, L</pwrite>."
31225 #: ../fish/guestfish-actions.pod:4697
31231 #: ../fish/guestfish-actions.pod:4699
31234 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
31240 #: ../fish/guestfish-actions.pod:4718
31246 #: ../fish/guestfish-actions.pod:4720
31255 #: ../fish/guestfish-actions.pod:4747
31257 "I<Note:> Don't use this call to test for availability of features. In "
31258 "enterprise distributions we backport features from later versions into "
31259 "earlier versions, making this an unreliable way to test for features. Use "
31260 "L</available> instead."
31265 #: ../fish/guestfish-actions.pod:4753
31271 #: ../fish/guestfish-actions.pod:4755
31274 " vfs-label device\n"
31280 #: ../fish/guestfish-actions.pod:4762
31281 msgid "To find a filesystem from the label, use L</findfs-label>."
31286 #: ../fish/guestfish-actions.pod:4764
31292 #: ../fish/guestfish-actions.pod:4766
31295 " vfs-type device\n"
31301 #: ../fish/guestfish-actions.pod:4776
31307 #: ../fish/guestfish-actions.pod:4778
31310 " vfs-uuid device\n"
31316 #: ../fish/guestfish-actions.pod:4785
31317 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
31322 #: ../fish/guestfish-actions.pod:4787
31323 msgid "vg-activate"
31328 #: ../fish/guestfish-actions.pod:4789
31331 " vg-activate true|false 'volgroups ...'\n"
31337 #: ../fish/guestfish-actions.pod:4802
31338 msgid "vg-activate-all"
31343 #: ../fish/guestfish-actions.pod:4804
31346 " vg-activate-all true|false\n"
31352 #: ../fish/guestfish-actions.pod:4814
31358 #: ../fish/guestfish-actions.pod:4816
31361 " vgcreate volgroup 'physvols ...'\n"
31367 #: ../fish/guestfish-actions.pod:4821
31373 #: ../fish/guestfish-actions.pod:4823
31376 " vglvuuids vgname\n"
31382 #: ../fish/guestfish-actions.pod:4828
31384 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
31385 "logical volumes and volume groups."
31390 #: ../fish/guestfish-actions.pod:4831
31391 msgid "See also L</vgpvuuids>."
31396 #: ../fish/guestfish-actions.pod:4833
31402 #: ../fish/guestfish-actions.pod:4835
31405 " vgpvuuids vgname\n"
31411 #: ../fish/guestfish-actions.pod:4840
31413 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31414 "physical volumes and volume groups."
31419 #: ../fish/guestfish-actions.pod:4843
31420 msgid "See also L</vglvuuids>."
31425 #: ../fish/guestfish-actions.pod:4845
31431 #: ../fish/guestfish-actions.pod:4847
31434 " vgremove vgname\n"
31440 #: ../fish/guestfish-actions.pod:4854
31446 #: ../fish/guestfish-actions.pod:4856
31449 " vgrename volgroup newvolgroup\n"
31455 #: ../fish/guestfish-actions.pod:4860
31461 #: ../fish/guestfish-actions.pod:4862
31470 #: ../fish/guestfish-actions.pod:4870
31471 msgid "See also L</vgs-full>."
31476 #: ../fish/guestfish-actions.pod:4872
31482 #: ../fish/guestfish-actions.pod:4874
31491 #: ../fish/guestfish-actions.pod:4879
31497 #: ../fish/guestfish-actions.pod:4881
31506 #: ../fish/guestfish-actions.pod:4886
31512 #: ../fish/guestfish-actions.pod:4888
31521 #: ../fish/guestfish-actions.pod:4892
31527 #: ../fish/guestfish-actions.pod:4894
31536 #: ../fish/guestfish-actions.pod:4899
31542 #: ../fish/guestfish-actions.pod:4901
31551 #: ../fish/guestfish-actions.pod:4906
31557 #: ../fish/guestfish-actions.pod:4908
31566 #: ../fish/guestfish-actions.pod:4913
31572 #: ../fish/guestfish-actions.pod:4915
31575 " write path content\n"
31581 #: ../fish/guestfish-actions.pod:4923
31587 #: ../fish/guestfish-actions.pod:4925
31590 " write-file path content size\n"
31596 #: ../fish/guestfish-actions.pod:4948
31602 #: ../fish/guestfish-actions.pod:4950
31605 " zegrep regex path\n"
31611 #: ../fish/guestfish-actions.pod:4958
31617 #: ../fish/guestfish-actions.pod:4960
31620 " zegrepi regex path\n"
31626 #: ../fish/guestfish-actions.pod:4968
31632 #: ../fish/guestfish-actions.pod:4970
31640 #: ../fish/guestfish-actions.pod:4978
31641 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
31646 #: ../fish/guestfish-actions.pod:4981
31647 msgid "zero-device"
31652 #: ../fish/guestfish-actions.pod:4983
31655 " zero-device device\n"
31661 #: ../fish/guestfish-actions.pod:4985
31663 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31664 "which just zeroes the first few blocks of a device."
31669 #: ../fish/guestfish-actions.pod:4992
31675 #: ../fish/guestfish-actions.pod:4994
31678 " zerofree device\n"
31684 #: ../fish/guestfish-actions.pod:5007
31690 #: ../fish/guestfish-actions.pod:5009
31693 " zfgrep pattern path\n"
31699 #: ../fish/guestfish-actions.pod:5017
31705 #: ../fish/guestfish-actions.pod:5019
31708 " zfgrepi pattern path\n"
31714 #: ../fish/guestfish-actions.pod:5027
31720 #: ../fish/guestfish-actions.pod:5029
31723 " zfile meth path\n"
31729 #: ../fish/guestfish-actions.pod:5036
31731 "Since 1.0.63, use L</file> instead which can now process compressed files."
31736 #: ../fish/guestfish-actions.pod:5046
31742 #: ../fish/guestfish-actions.pod:5048
31745 " zgrep regex path\n"
31751 #: ../fish/guestfish-actions.pod:5056
31757 #: ../fish/guestfish-actions.pod:5058
31760 " zgrepi regex path\n"
31766 #: ../fish/guestfish-commands.pod:1
31772 #: ../fish/guestfish-commands.pod:3
31778 #: ../fish/guestfish-commands.pod:5
31781 " alloc filename size\n"
31787 #: ../fish/guestfish-commands.pod:7
31789 "This creates an empty (zeroed) file of the given size, and then adds so it "
31790 "can be further examined."
31795 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
31796 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31801 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
31802 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31807 #: ../fish/guestfish-commands.pod:14
31809 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31810 "image, see L</PREPARED DISK IMAGES>."
31815 #: ../fish/guestfish-commands.pod:17
31821 #: ../fish/guestfish-commands.pod:19
31824 " copy-in local [local ...] /remotedir\n"
31830 #: ../fish/guestfish-commands.pod:21
31832 "C<copy-in> copies local files or directories recursively into the disk "
31833 "image, placing them in the directory called C</remotedir> (which must "
31834 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31835 "other commands as necessary."
31840 #: ../fish/guestfish-commands.pod:26
31842 "Multiple local files and directories can be specified, but the last "
31843 "parameter must always be a remote directory. Wildcards cannot be used."
31848 #: ../fish/guestfish-commands.pod:30
31854 #: ../fish/guestfish-commands.pod:32
31857 " copy-out remote [remote ...] localdir\n"
31863 #: ../fish/guestfish-commands.pod:34
31865 "C<copy-out> copies remote files or directories recursively out of the disk "
31866 "image, placing them on the host disk in a local directory called C<localdir> "
31867 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31868 "download>, L</tar-out> and other commands as necessary."
31873 #: ../fish/guestfish-commands.pod:40
31875 "Multiple remote files and directories can be specified, but the last "
31876 "parameter must always be a local directory. To download to the current "
31877 "directory, use C<.> as in:"
31882 #: ../fish/guestfish-commands.pod:44
31885 " copy-out /home .\n"
31891 #: ../fish/guestfish-commands.pod:46
31893 "Wildcards cannot be used in the ordinary command, but you can use them with "
31894 "the help of L</glob> like this:"
31899 #: ../fish/guestfish-commands.pod:49
31902 " glob copy-out /home/* .\n"
31907 #: ../fish/guestfish-commands.pod:51
31912 #: ../fish/guestfish-commands.pod:53
31915 " display filename\n"
31920 #: ../fish/guestfish-commands.pod:55
31922 "Use C<display> (a graphical display program) to display an image file. It "
31923 "downloads the file, and runs C<display> on it."
31927 #: ../fish/guestfish-commands.pod:58
31929 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
31930 "environment variable. For example to use the GNOME display program:"
31934 #: ../fish/guestfish-commands.pod:61
31937 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
31942 #: ../fish/guestfish-commands.pod:63
31943 msgid "See also L<display(1)>."
31948 #: ../fish/guestfish-commands.pod:65
31954 #: ../fish/guestfish-commands.pod:67
31957 " echo [params ...]\n"
31963 #: ../fish/guestfish-commands.pod:69
31964 msgid "This echos the parameters to the terminal."
31969 #: ../fish/guestfish-commands.pod:71
31975 #: ../fish/guestfish-commands.pod:73
31981 #: ../fish/guestfish-commands.pod:75
31987 #: ../fish/guestfish-commands.pod:77
31996 #: ../fish/guestfish-commands.pod:79
31998 "This is used to edit a file. It downloads the file, edits it locally using "
31999 "your editor, then uploads the result."
32004 #: ../fish/guestfish-commands.pod:82
32006 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
32007 "or C<emacs> you will get those corresponding editors."
32012 #: ../fish/guestfish-commands.pod:86
32018 #: ../fish/guestfish-commands.pod:88
32021 " glob command args...\n"
32027 #: ../fish/guestfish-commands.pod:90
32029 "Expand wildcards in any paths in the args list, and run C<command> "
32030 "repeatedly on each matching path."
32035 #: ../fish/guestfish-commands.pod:93
32036 msgid "See L</WILDCARDS AND GLOBBING>."
32041 #: ../fish/guestfish-commands.pod:95
32047 #: ../fish/guestfish-commands.pod:97
32050 " hexedit <filename|device>\n"
32051 " hexedit <filename|device> <max>\n"
32052 " hexedit <filename|device> <start> <max>\n"
32058 #: ../fish/guestfish-commands.pod:101
32060 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
32066 #: ../fish/guestfish-commands.pod:104
32068 "This command works by downloading potentially the whole file or device, "
32069 "editing it locally, then uploading it. If the file or device is large, you "
32070 "have to specify which part you wish to edit by using C<max> and/or C<start> "
32071 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
32072 "usual modifiers allowed such as C<1M> (1 megabyte)."
32077 #: ../fish/guestfish-commands.pod:111
32078 msgid "For example to edit the first few sectors of a disk you might do:"
32083 #: ../fish/guestfish-commands.pod:114
32086 " hexedit /dev/sda 1M\n"
32092 #: ../fish/guestfish-commands.pod:116
32094 "which would allow you to edit anywhere within the first megabyte of the disk."
32099 #: ../fish/guestfish-commands.pod:119
32100 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
32105 #: ../fish/guestfish-commands.pod:121
32108 " hexedit /dev/sda1 0x400 0x400\n"
32114 #: ../fish/guestfish-commands.pod:123
32115 msgid "(assuming the superblock is in the standard location)."
32120 #: ../fish/guestfish-commands.pod:125
32122 "This command requires the external L<hexedit(1)> program. You can specify "
32123 "another program to use by setting the C<HEXEDITOR> environment variable."
32128 #: ../fish/guestfish-commands.pod:129
32129 msgid "See also L</hexdump>."
32134 #: ../fish/guestfish-commands.pod:131
32140 #: ../fish/guestfish-commands.pod:133
32149 #: ../fish/guestfish-commands.pod:135
32151 "Change the local directory, ie. the current directory of guestfish itself."
32156 #: ../fish/guestfish-commands.pod:138
32157 msgid "Note that C<!cd> won't do what you might expect."
32162 #: ../fish/guestfish-commands.pod:140
32168 #: ../fish/guestfish-commands.pod:142
32174 #: ../fish/guestfish-commands.pod:144
32183 #: ../fish/guestfish-commands.pod:146
32184 msgid "Opens the manual page for guestfish."
32189 #: ../fish/guestfish-commands.pod:148
32195 #: ../fish/guestfish-commands.pod:150
32201 #: ../fish/guestfish-commands.pod:152
32210 #: ../fish/guestfish-commands.pod:154
32219 #: ../fish/guestfish-commands.pod:156
32220 msgid "This is used to view a file."
32225 #: ../fish/guestfish-commands.pod:158
32227 "The default viewer is C<$PAGER>. However if you use the alternate command "
32228 "C<less> you will get the C<less> command specifically."
32233 #: ../fish/guestfish-commands.pod:161
32239 #: ../fish/guestfish-commands.pod:163
32248 #: ../fish/guestfish-commands.pod:165
32250 "Close and reopen the libguestfs handle. It is not necessary to use this "
32251 "normally, because the handle is closed properly when guestfish exits. "
32252 "However this is occasionally useful for testing."
32257 #: ../fish/guestfish-commands.pod:169
32263 #: ../fish/guestfish-commands.pod:171
32266 " sparse filename size\n"
32272 #: ../fish/guestfish-commands.pod:173
32274 "This creates an empty sparse file of the given size, and then adds so it can "
32275 "be further examined."
32280 #: ../fish/guestfish-commands.pod:176
32282 "In all respects it works the same as the L</alloc> command, except that the "
32283 "image file is allocated sparsely, which means that disk blocks are not "
32284 "assigned to the file until they are needed. Sparse disk files only use "
32285 "space when written to, but they are slower and there is a danger you could "
32286 "run out of real disk space during a write operation."
32291 #: ../fish/guestfish-commands.pod:186
32297 #: ../fish/guestfish-commands.pod:188
32306 #: ../fish/guestfish-commands.pod:190
32308 "This command returns a list of the optional groups known to the daemon, and "
32309 "indicates which ones are supported by this build of the libguestfs appliance."
32314 #: ../fish/guestfish-commands.pod:194
32315 msgid "See also L<guestfs(3)/AVAILABILITY>."
32320 #: ../fish/guestfish-commands.pod:196
32326 #: ../fish/guestfish-commands.pod:198
32329 " time command args...\n"
32335 #: ../fish/guestfish-commands.pod:200
32337 "Run the command as usual, but print the elapsed time afterwards. This can "
32338 "be useful for benchmarking operations."
32343 #: ../test-tool/libguestfs-test-tool.pod:5
32344 msgid "libguestfs-test-tool - End user tests for libguestfs"
32349 #: ../test-tool/libguestfs-test-tool.pod:9
32352 " libguestfs-test-tool [--options]\n"
32358 #: ../test-tool/libguestfs-test-tool.pod:13
32360 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
32361 "and developers, to allow them to check basic libguestfs functionality is "
32362 "working. This is needed because libguestfs occasionally breaks for reasons "
32363 "beyond our control: usually because of changes in the underlying qemu or "
32364 "kernel packages, or the host environment."
32369 #: ../test-tool/libguestfs-test-tool.pod:20
32370 msgid "If you suspect a problem in libguestfs, then just run:"
32375 #: ../test-tool/libguestfs-test-tool.pod:22
32378 " libguestfs-test-tool\n"
32384 #: ../test-tool/libguestfs-test-tool.pod:24
32385 msgid "It will print lots of diagnostic messages."
32390 #: ../test-tool/libguestfs-test-tool.pod:26
32391 msgid "If it runs to completion successfully, you will see this near the end:"
32396 #: ../test-tool/libguestfs-test-tool.pod:28
32399 " ===== TEST FINISHED OK =====\n"
32405 #: ../test-tool/libguestfs-test-tool.pod:30
32406 msgid "and the test tool will exit with code 0."
32411 #: ../test-tool/libguestfs-test-tool.pod:32
32413 "If it fails (and/or exits with non-zero error code), please paste the "
32414 "B<complete, unedited> output of the test tool into a bug report. More "
32415 "information about reporting bugs can be found on the L<http://libguestfs.org/"
32421 #: ../test-tool/libguestfs-test-tool.pod:41
32427 #: ../test-tool/libguestfs-test-tool.pod:43
32428 msgid "Display short usage information and exit."
32433 #: ../test-tool/libguestfs-test-tool.pod:45
32434 msgid "I<--qemu qemu_binary>"
32439 #: ../test-tool/libguestfs-test-tool.pod:47
32441 "If you have downloaded another qemu binary, point this option at the full "
32442 "path of the binary to try it."
32447 #: ../test-tool/libguestfs-test-tool.pod:50
32448 msgid "I<--qemudir qemu_source_dir>"
32453 #: ../test-tool/libguestfs-test-tool.pod:52
32455 "If you have compiled qemu from source, point this option at the source "
32456 "directory to try it."
32461 #: ../test-tool/libguestfs-test-tool.pod:55
32462 msgid "I<--timeout N>"
32467 #: ../test-tool/libguestfs-test-tool.pod:57
32469 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32470 "does not usually need to be adjusted unless your machine is very slow."
32475 #: ../test-tool/libguestfs-test-tool.pod:63
32476 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32481 #: ../test-tool/libguestfs-test-tool.pod:65
32483 "If you have compiled another version of qemu from source and would like to "
32484 "try that, then you can use the I<--qemudir> option to point to the qemu "
32485 "source directory."
32490 #: ../test-tool/libguestfs-test-tool.pod:69
32492 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32493 "option to point to the binary."
32498 #: ../test-tool/libguestfs-test-tool.pod:72
32500 "When using an alternate qemu with libguestfs, usually you would need to "
32501 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32502 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32503 "use either of the I<--qemudir> or I<--qemu> options."
32508 #: ../test-tool/libguestfs-test-tool.pod:79
32510 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32511 "I<1> if there was an error."
32516 #: ../test-tool/libguestfs-test-tool.pod:84
32518 "For the full list of environment variables which may affect libguestfs, "
32519 "please see the L<guestfs(3)> manual page."
32524 #: ../test-tool/libguestfs-test-tool.pod:89
32525 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32530 #: ../fuse/guestmount.pod:5
32532 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32537 #: ../fuse/guestmount.pod:9
32540 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32546 #: ../fuse/guestmount.pod:11
32549 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32555 #: ../fuse/guestmount.pod:13
32558 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32564 #: ../fuse/guestmount.pod:17
32566 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32567 "machines. If you do this, you risk disk corruption in the VM."
32572 #: ../fuse/guestmount.pod:22
32574 "The guestmount program can be used to mount virtual machine filesystems and "
32575 "other disk images on the host. It uses libguestfs for access to the guest "
32576 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32577 "a mountable device."
32582 #: ../fuse/guestmount.pod:27
32584 "Along with other options, you have to give at least one device (I<-a> "
32585 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32586 "option) or use the I<-i> inspection option. How this works is better "
32587 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32593 #: ../fuse/guestmount.pod:33
32595 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32596 "by you, and the filesystem will not be visible to any other users unless you "
32597 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32598 "the filesystem, use the C<fusermount -u> command."
32603 #: ../fuse/guestmount.pod:41
32605 "For a typical Windows guest which has its main filesystem on the first "
32611 #: ../fuse/guestmount.pod:44
32614 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32620 #: ../fuse/guestmount.pod:46
32622 "For a typical Linux guest which has a /boot filesystem on the first "
32623 "partition, and the root filesystem on a logical volume:"
32628 #: ../fuse/guestmount.pod:49
32631 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32637 #: ../fuse/guestmount.pod:51
32638 msgid "To get libguestfs to detect guest mountpoints for you:"
32643 #: ../fuse/guestmount.pod:53
32646 " guestmount -a guest.img -i --ro /mnt\n"
32652 #: ../fuse/guestmount.pod:55
32653 msgid "For a libvirt guest called \"Guest\" you could do:"
32658 #: ../fuse/guestmount.pod:57
32661 " guestmount -d Guest -i --ro /mnt\n"
32667 #: ../fuse/guestmount.pod:59
32669 "If you don't know what filesystems are contained in a guest or disk image, "
32670 "use L<virt-filesystems(1)> first:"
32675 #: ../fuse/guestmount.pod:62
32678 " virt-filesystems MyGuest\n"
32684 #: ../fuse/guestmount.pod:64
32686 "If you want to trace the libguestfs calls but without excessive debugging "
32687 "information, we recommend:"
32692 #: ../fuse/guestmount.pod:67
32695 " guestmount [...] --trace /mnt\n"
32701 #: ../fuse/guestmount.pod:69
32702 msgid "If you want to debug the program, we recommend:"
32707 #: ../fuse/guestmount.pod:71
32710 " guestmount [...] --trace --verbose /mnt\n"
32715 #: ../fuse/guestmount.pod:73
32720 #: ../fuse/guestmount.pod:75
32721 msgid "Other users cannot see the filesystem by default"
32725 #: ../fuse/guestmount.pod:77
32727 "If you mount a filesystem as one user (eg. root), then other users will not "
32728 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32729 "option when mounting:"
32733 #: ../fuse/guestmount.pod:81
32736 " sudo guestmount [...] -o allow_other /mnt\n"
32742 #: ../fuse/guestmount.pod:87
32743 msgid "B<-a image> | B<--add image>"
32748 #: ../fuse/guestmount.pod:89
32749 msgid "Add a block device or virtual machine image."
32754 #: ../fuse/guestmount.pod:94
32755 msgid "B<-c URI> | B<--connect URI>"
32760 #: ../fuse/guestmount.pod:100
32761 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32766 #: ../fuse/guestmount.pod:108
32767 msgid "B<--dir-cache-timeout N>"
32772 #: ../fuse/guestmount.pod:110
32774 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32775 "seconds. The readdir cache [actually, there are several semi-independent "
32776 "caches] is populated after a readdir(2) call with the stat and extended "
32777 "attributes of the files in the directory, in anticipation that they will be "
32778 "requested soon after."
32783 #: ../fuse/guestmount.pod:116
32785 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32786 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32787 "requests, only cache existing ones."
32792 #: ../fuse/guestmount.pod:127
32793 msgid "B<--format=raw|qcow2|..> | B<--format>"
32798 #: ../fuse/guestmount.pod:134
32800 "If you have untrusted raw-format guest disk images, you should use this "
32801 "option to specify the disk format. This avoids a possible security problem "
32802 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32803 "guestfs_add_drive_opts>."
32808 #: ../fuse/guestmount.pod:139
32809 msgid "B<--fuse-help>"
32814 #: ../fuse/guestmount.pod:141
32815 msgid "Display help on special FUSE options (see I<-o> below)."
32820 #: ../fuse/guestmount.pod:145
32821 msgid "Display brief help and exit."
32826 #: ../fuse/guestmount.pod:147
32827 msgid "B<-i> | B<--inspector>"
32832 #: ../fuse/guestmount.pod:167
32834 "Mount the named partition or logical volume on the given mountpoint B<in the "
32835 "guest> (this has nothing to do with mountpoints in the host)."
32840 #: ../fuse/guestmount.pod:170
32842 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32843 "something on C</>."
32848 #: ../fuse/guestmount.pod:183
32849 msgid "B<-n> | B<--no-sync>"
32854 #: ../fuse/guestmount.pod:185
32856 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32857 "unmounted. If you specify this option, then we don't attempt to sync the "
32858 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32863 #: ../fuse/guestmount.pod:190
32864 msgid "B<-o option> | B<--option option>"
32869 #: ../fuse/guestmount.pod:192
32870 msgid "Pass extra options to FUSE."
32875 #: ../fuse/guestmount.pod:194
32877 "To get a list of all the extra options supported by FUSE, use the command "
32878 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32879 "of them are a good idea."
32884 #: ../fuse/guestmount.pod:198
32887 " guestmount --fuse-help\n"
32893 #: ../fuse/guestmount.pod:200
32894 msgid "Some potentially useful FUSE options:"
32899 #: ../fuse/guestmount.pod:204
32900 msgid "B<-o allow_other>"
32905 #: ../fuse/guestmount.pod:206
32906 msgid "Allow other users to see the filesystem."
32911 #: ../fuse/guestmount.pod:208
32912 msgid "B<-o attr_timeout=N>"
32917 #: ../fuse/guestmount.pod:210
32918 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32923 #: ../fuse/guestmount.pod:212
32924 msgid "B<-o kernel_cache>"
32929 #: ../fuse/guestmount.pod:214
32931 "Allow the kernel to cache files (reduces the number of reads that have to go "
32932 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32933 "afford the extra memory usage."
32938 #: ../fuse/guestmount.pod:218
32939 msgid "B<-o uid=N> B<-o gid=N>"
32944 #: ../fuse/guestmount.pod:220
32946 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32947 "the chosen values."
32952 #: ../fuse/guestmount.pod:225
32953 msgid "B<-r> | B<--ro>"
32958 #: ../fuse/guestmount.pod:227
32960 "Add devices and mount everything read-only. Also disallow writes and make "
32961 "the disk appear read-only to FUSE."
32966 #: ../fuse/guestmount.pod:230
32968 "This is highly recommended if you are not going to edit the guest disk. If "
32969 "the guest is running and this option is I<not> supplied, then there is a "
32970 "strong risk of disk corruption in the guest. We try to prevent this from "
32971 "happening, but it is not always possible."
32976 #: ../fuse/guestmount.pod:235
32977 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32982 #: ../fuse/guestmount.pod:239
32983 msgid "Enable SELinux support for the guest."
32988 #: ../fuse/guestmount.pod:241
32989 msgid "B<-v> | B<--verbose>"
32994 #: ../fuse/guestmount.pod:243
32995 msgid "Enable verbose messages from underlying libguestfs."
33000 #: ../fuse/guestmount.pod:245
33001 msgid "B<-V> | B<--version>"
33006 #: ../fuse/guestmount.pod:247
33007 msgid "Display the program version and exit."
33012 #: ../fuse/guestmount.pod:249
33013 msgid "B<-w> | B<--rw>"
33017 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
33018 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
33023 #: ../fuse/guestmount.pod:256
33024 msgid "B<-x> | B<--trace>"
33029 #: ../fuse/guestmount.pod:258
33030 msgid "Trace libguestfs calls and entry into each FUSE function."
33035 #: ../fuse/guestmount.pod:260
33036 msgid "This also stops the daemon from forking into the background."
33041 #: ../fuse/guestmount.pod:281
33043 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
33044 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
33050 #: ../fuse/guestmount.pod:296
33051 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
33056 #: ../tools/virt-win-reg.pl:37
33058 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33063 #: ../tools/virt-win-reg.pl:41
33066 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33072 #: ../tools/virt-win-reg.pl:43
33075 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33081 #: ../tools/virt-win-reg.pl:45
33084 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33090 #: ../tools/virt-win-reg.pl:47
33093 " virt-win-reg --merge domname [input.reg ...]\n"
33099 #: ../tools/virt-win-reg.pl:49
33102 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33107 #: ../tools/virt-win-reg.pl:53
33109 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33110 "virtual machines. If you do this, you I<will> get irreversible disk "
33111 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33112 "but doesn't catch all cases."
33116 #: ../tools/virt-win-reg.pl:58
33118 "Modifying the Windows Registry is an inherently risky operation. The format "
33119 "is deliberately obscure and undocumented, and Registry changes can leave the "
33120 "system unbootable. Therefore when using the I<--merge> option, make sure "
33121 "you have a reliable backup first."
33126 #: ../tools/virt-win-reg.pl:65
33128 "This program can export and merge Windows Registry entries from a Windows "
33134 #: ../tools/virt-win-reg.pl:68
33136 "The first parameter is the libvirt guest name or the raw disk image of a "
33141 #: ../tools/virt-win-reg.pl:71
33143 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33144 "exported (recursively). For example:"
33149 #: ../tools/virt-win-reg.pl:74
33152 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33158 #: ../tools/virt-win-reg.pl:76
33160 "You can also display single values from within registry keys, for example:"
33165 #: ../tools/virt-win-reg.pl:79
33168 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33169 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33170 " Windows 7 Enterprise\n"
33175 #: ../tools/virt-win-reg.pl:83
33177 "With I<--merge>, you can merge a textual regedit file into the Windows "
33183 #: ../tools/virt-win-reg.pl:86
33186 " $ virt-win-reg --merge Windows7 changes.reg\n"
33192 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33198 #: ../tools/virt-win-reg.pl:90
33200 "This program is only meant for simple access to the registry. If you want "
33201 "to do complicated things with the registry, we suggest you download the "
33202 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33203 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33204 "L<hivexregedit(1)>."
33209 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
33210 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
33211 #: ../tools/virt-list-partitions.pl:64
33212 msgid "Display brief help."
33217 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
33218 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
33219 #: ../tools/virt-list-partitions.pl:72
33220 msgid "Display version number and exit."
33225 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33231 #: ../tools/virt-win-reg.pl:122
33232 msgid "Enable debugging messages."
33237 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
33238 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
33239 msgid "B<--connect URI> | B<-c URI>"
33244 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
33245 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
33247 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
33248 "to the default libvirt hypervisor."
33253 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
33254 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
33256 "If you specify guest block devices directly, then libvirt is not used at all."
33261 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
33262 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
33263 msgid "B<--format> raw"
33268 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
33269 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
33271 "Specify the format of disk images given on the command line. If this is "
33272 "omitted then the format is autodetected from the content of the disk image."
33277 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
33278 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
33280 "If disk images are requested from libvirt, then this program asks libvirt "
33281 "for this information. In this case, the value of the format parameter is "
33287 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
33288 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
33290 "If working with untrusted raw-format guest disk images, you should ensure "
33291 "the format is always specified."
33296 #: ../tools/virt-win-reg.pl:157
33302 #: ../tools/virt-win-reg.pl:159
33304 "In merge mode, this merges a textual regedit file into the Windows Registry "
33305 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33306 "displays or exports Registry entries instead."
33310 #: ../tools/virt-win-reg.pl:163
33312 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33313 "result in disk corruption. However exporting (without this flag) is always "
33319 #: ../tools/virt-win-reg.pl:171
33320 msgid "B<--encoding> UTF-16LE|ASCII"
33325 #: ../tools/virt-win-reg.pl:173
33327 "When merging (only), you may need to specify the encoding for strings to be "
33328 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33329 "(3)/ENCODING STRINGS>."
33334 #: ../tools/virt-win-reg.pl:177
33336 "The default is to use UTF-16LE, which should work with recent versions of "
33341 #: ../tools/virt-win-reg.pl:184
33342 msgid "B<--unsafe-printable-strings>"
33346 #: ../tools/virt-win-reg.pl:186
33348 "When exporting (only), assume strings are UTF-16LE and print them as strings "
33349 "instead of hex sequences. Remove the final zero codepoint from strings if "
33354 #: ../tools/virt-win-reg.pl:190
33356 "This is unsafe and does not preserve the fidelity of strings in the original "
33357 "Registry for various reasons:"
33361 #: ../tools/virt-win-reg.pl:197
33363 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
33364 "other encodings will be corrupted by this transformation."
33368 #: ../tools/virt-win-reg.pl:202
33370 "Assumes that everything which has type 1 or 2 is really a string and that "
33371 "everything else is not a string, but the type field in real Registries is "
33376 #: ../tools/virt-win-reg.pl:208
33378 "Loses information about whether a zero codepoint followed the string in the "
33383 #: ../tools/virt-win-reg.pl:213
33385 "This all happens because the Registry itself contains no information about "
33386 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
33390 #: ../tools/virt-win-reg.pl:217
33392 "You should only use this option for quick hacking and debugging of the "
33393 "Registry contents, and I<never> use it if the output is going to be passed "
33394 "into another program or stored in another Registry."
33399 #: ../tools/virt-win-reg.pl:554
33400 msgid "SUPPORTED SYSTEMS"
33405 #: ../tools/virt-win-reg.pl:556
33407 "The program currently supports Windows NT-derived guests starting with "
33408 "Windows XP through to at least Windows 7."
33412 #: ../tools/virt-win-reg.pl:559
33413 msgid "The following Registry keys are supported:"
33417 #: ../tools/virt-win-reg.pl:563
33418 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
33422 #: ../tools/virt-win-reg.pl:565
33423 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
33427 #: ../tools/virt-win-reg.pl:567
33428 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
33432 #: ../tools/virt-win-reg.pl:569
33433 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
33437 #: ../tools/virt-win-reg.pl:571
33438 msgid "C<HKEY_USERS\\.DEFAULT>"
33442 #: ../tools/virt-win-reg.pl:573
33443 msgid "C<HKEY_USERS\\I<SID>>"
33447 #: ../tools/virt-win-reg.pl:575
33448 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
33452 #: ../tools/virt-win-reg.pl:577
33453 msgid "C<HKEY_USERS\\I<username>>"
33457 #: ../tools/virt-win-reg.pl:579
33459 "where I<username> is a local user name (this is a libguestfs extension)."
33464 #: ../tools/virt-win-reg.pl:583
33466 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33471 #: ../tools/virt-win-reg.pl:586
33473 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
33474 "supported (there is no \"current user\")."
33479 #: ../tools/virt-win-reg.pl:589
33485 #: ../tools/virt-win-reg.pl:591
33487 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33488 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33489 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33490 "Windows-style line endings, you may need to reencode the whole file before "
33491 "or after processing."
33495 #: ../tools/virt-win-reg.pl:597
33497 "To reencode a file from Windows format to Linux (before processing it with "
33498 "the I<--merge> option), you would do something like this:"
33503 #: ../tools/virt-win-reg.pl:600
33506 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33512 #: ../tools/virt-win-reg.pl:602
33514 "To go in the opposite direction, after exporting and before sending the file "
33515 "to a Windows user, do something like this:"
33520 #: ../tools/virt-win-reg.pl:605
33523 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33529 #: ../tools/virt-win-reg.pl:607
33530 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33535 #: ../tools/virt-win-reg.pl:609
33537 "If you are unsure about the current encoding, use the L<file(1)> command. "
33538 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33539 "style (CRLF) line endings, like this:"
33544 #: ../tools/virt-win-reg.pl:613
33547 " $ file software.reg\n"
33548 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33549 " with CRLF line terminators\n"
33554 #: ../tools/virt-win-reg.pl:617
33555 msgid "This file would need conversion before you could I<--merge> it."
33560 #: ../tools/virt-win-reg.pl:619
33561 msgid "CurrentControlSet etc."
33566 #: ../tools/virt-win-reg.pl:621
33568 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33569 "Registry at the level of the hive file, and therefore you cannot modify "
33575 #: ../tools/virt-win-reg.pl:625
33577 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33578 "circumstances it might refer to another control set. The way to find out is "
33579 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33584 #: ../tools/virt-win-reg.pl:629
33587 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33588 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33589 " \"Current\"=dword:00000001\n"
33590 " \"Default\"=dword:00000001\n"
33591 " \"Failed\"=dword:00000000\n"
33592 " \"LastKnownGood\"=dword:00000002\n"
33598 #: ../tools/virt-win-reg.pl:636
33599 msgid "\"Current\" is the one which Windows will choose when it boots."
33604 #: ../tools/virt-win-reg.pl:638
33606 "Similarly, other C<Current...> keys in the path may need to be replaced."
33611 #: ../tools/virt-win-reg.pl:641
33612 msgid "WINDOWS TIPS"
33617 #: ../tools/virt-win-reg.pl:643
33619 "Note that some of these tips modify the guest disk image. The guest I<must> "
33620 "be shut off, else you will get disk corruption."
33625 #: ../tools/virt-win-reg.pl:646
33626 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33631 #: ../tools/virt-win-reg.pl:648
33633 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33634 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33635 "is uploaded into C<C:\\>:"
33640 #: ../tools/virt-win-reg.pl:652
33643 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33649 #: ../tools/virt-win-reg.pl:654
33650 msgid "Prepare a regedit file containing the registry change:"
33655 #: ../tools/virt-win-reg.pl:656
33658 " cat > test.reg <<'EOF'\n"
33659 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33660 " \"Test\"=\"c:\\\\test.bat\"\n"
33667 #: ../tools/virt-win-reg.pl:661
33669 "In this example we use the key C<RunOnce> which means that the script will "
33670 "run precisely once when the first user logs in. If you want it to run every "
33671 "time a user logs in, replace C<RunOnce> with C<Run>."
33676 #: ../tools/virt-win-reg.pl:665
33677 msgid "Now update the registry:"
33682 #: ../tools/virt-win-reg.pl:667
33685 " virt-win-reg --merge WindowsGuest test.reg\n"
33691 #: ../tools/virt-win-reg.pl:669
33692 msgid "INSTALLING A SERVICE"
33697 #: ../tools/virt-win-reg.pl:671
33699 "This section assumes you are familiar with Windows services, and you either "
33700 "have a program which handles the Windows Service Control Protocol directly "
33701 "or you want to run any program using a service wrapper like SrvAny or the "
33707 #: ../tools/virt-win-reg.pl:676
33709 "First upload the program and optionally the service wrapper. In this case "
33710 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33715 #: ../tools/virt-win-reg.pl:680
33718 " guestfish -i -d WindowsGuest <<EOF\n"
33719 " upload rhsrvany.exe /rhsrvany.exe\n"
33720 " upload test.exe /test.exe\n"
33727 #: ../tools/virt-win-reg.pl:685
33729 "Prepare a regedit file containing the registry changes. In this example, "
33730 "the first registry change is needed for the service itself or the service "
33731 "wrapper (if used). The second registry change is only needed because I am "
33732 "using the RHSrvAny service wrapper."
33737 #: ../tools/virt-win-reg.pl:690
33740 " cat > service.reg <<'EOF'\n"
33741 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33742 " \"Type\"=dword:00000010\n"
33743 " \"Start\"=dword:00000002\n"
33744 " \"ErrorControl\"=dword:00000001\n"
33745 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33746 " \"DisplayName\"=\"RHSrvAny\"\n"
33747 " \"ObjectName\"=\"NetworkService\"\n"
33753 #: ../tools/virt-win-reg.pl:699
33756 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33757 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33758 " \"PWD\"=\"c:\\\\Temp\"\n"
33765 #: ../tools/virt-win-reg.pl:710
33767 "For use of C<ControlSet001> see the section above in this manual page. You "
33768 "may need to adjust this according to the control set that is in use by the "
33774 #: ../tools/virt-win-reg.pl:716
33776 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33777 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33778 "privileged account."
33783 #: ../tools/virt-win-reg.pl:722
33785 "For the meaning of the magic numbers, see this Microsoft KB article: "
33786 "L<http://support.microsoft.com/kb/103000>."
33791 #: ../tools/virt-win-reg.pl:727
33792 msgid "Update the registry:"
33797 #: ../tools/virt-win-reg.pl:729
33800 " virt-win-reg --merge WindowsGuest service.reg\n"
33806 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
33807 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
33808 #: ../tools/virt-list-partitions.pl:250
33809 msgid "SHELL QUOTING"
33814 #: ../tools/virt-win-reg.pl:733
33816 "Be careful when passing parameters containing C<\\> (backslash) in the "
33817 "shell. Usually you will have to use 'single quotes' or double backslashes "
33818 "(but not both) to protect them from the shell."
33823 #: ../tools/virt-win-reg.pl:737
33824 msgid "Paths and value names are case-insensitive."
33829 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
33830 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
33831 #: ../tools/virt-list-partitions.pl:252
33833 "Libvirt guest names can contain arbitrary characters, some of which have "
33834 "meaning to the shell such as C<#> and space. You may need to quote or "
33835 "escape these characters on the command line. See the shell manual page L<sh"
33836 "(1)> for details."
33841 #: ../tools/virt-win-reg.pl:746
33843 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33844 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33845 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33850 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
33852 "When reporting bugs, please enable debugging and capture the I<complete> "
33858 #: ../tools/virt-win-reg.pl:764
33861 " export LIBGUESTFS_DEBUG=1\n"
33862 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33868 #: ../tools/virt-win-reg.pl:767
33870 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33876 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
33877 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
33878 #: ../tools/virt-list-partitions.pl:269
33884 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
33885 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
33886 #: ../tools/virt-list-partitions.pl:271
33887 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33892 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
33893 msgid "Copyright (C) 2010 Red Hat Inc."
33898 #: ../tools/virt-list-filesystems.pl:32
33900 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33905 #: ../tools/virt-list-filesystems.pl:36
33908 " virt-list-filesystems [--options] domname\n"
33914 #: ../tools/virt-list-filesystems.pl:38
33917 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33923 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33925 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33931 #: ../tools/virt-list-filesystems.pl:45
33933 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33934 "are contained in a virtual machine or disk image."
33939 #: ../tools/virt-list-filesystems.pl:49
33941 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33942 "functionality. For more complex cases you should look at the L<guestfish(1)"
33948 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33949 msgid "B<-l> | B<--long>"
33954 #: ../tools/virt-list-filesystems.pl:108
33956 "With this option, C<virt-list-filesystems> displays the type of each "
33957 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33962 #: ../tools/virt-list-filesystems.pl:115
33963 msgid "B<-a> | B<--all>"
33968 #: ../tools/virt-list-filesystems.pl:117
33970 "Normally we only show mountable filesystems. If this option is given then "
33971 "swap devices are shown too."
33976 #: ../tools/virt-list-filesystems.pl:191
33978 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33979 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33980 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33985 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33986 msgid "Copyright (C) 2009 Red Hat Inc."
33991 #: ../tools/virt-tar.pl:33
33992 msgid "virt-tar - Extract or upload files to a virtual machine"
33997 #: ../tools/virt-tar.pl:37
34000 " virt-tar [--options] -x domname directory tarball\n"
34006 #: ../tools/virt-tar.pl:39
34009 " virt-tar [--options] -u domname tarball directory\n"
34015 #: ../tools/virt-tar.pl:41
34018 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34024 #: ../tools/virt-tar.pl:43
34027 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34032 #: ../tools/virt-tar.pl:47
34034 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34035 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34040 #: ../tools/virt-tar.pl:52
34041 msgid "Download C</home> from the VM into a local tarball:"
34046 #: ../tools/virt-tar.pl:54
34049 " virt-tar -x domname /home home.tar\n"
34055 #: ../tools/virt-tar.pl:56
34058 " virt-tar -zx domname /home home.tar.gz\n"
34064 #: ../tools/virt-tar.pl:58
34065 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34070 #: ../tools/virt-tar.pl:60
34073 " virt-tar -u domname uploadstuff.tar /tmp\n"
34079 #: ../tools/virt-tar.pl:62
34082 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34087 #: ../tools/virt-tar.pl:66
34089 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34090 "virtual machines. If you do this, you risk disk corruption in the VM. "
34091 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34095 #: ../tools/virt-tar.pl:71
34097 "You can use I<-x> (extract) on live virtual machines, but you might get "
34098 "inconsistent results or errors if there is filesystem activity inside the "
34099 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34100 "work, but the only way to guarantee consistent results is if the virtual "
34101 "machine is shut down."
34106 #: ../tools/virt-tar.pl:79
34108 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34109 "parts of a guest filesystem. There are many possibilities: making backups, "
34110 "uploading data files, snooping on guest activity, fixing or customizing "
34116 #: ../tools/virt-tar.pl:84
34118 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34119 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34120 "should look at the L<guestfish(1)> tool."
34124 #: ../tools/virt-tar.pl:88
34126 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34127 "its contents (recursively) from the virtual machine into a local tarball. "
34128 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34129 "virtual machine. You cannot use these two options together."
34133 #: ../tools/virt-tar.pl:94
34135 "In addition, you may need to use the I<-z> (gZip) option to enable "
34136 "compression. When uploading, you have to specify I<-z> if the upload file "
34137 "is compressed because virt-tar won't detect this on its own."
34142 #: ../tools/virt-tar.pl:98
34144 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34145 "example it cannot do PKZip files or bzip2 compression. If you want that "
34146 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34147 "the L<libguestfs(3)> API)."
34152 #: ../tools/virt-tar.pl:156
34153 msgid "B<-x> | B<--extract> | B<--download>"
34158 #: ../tools/virt-tar.pl:158
34159 msgid "B<-u> | B<--upload>"
34163 #: ../tools/virt-tar.pl:160
34165 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34170 #: ../tools/virt-tar.pl:163
34172 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34173 "Please read the L</WARNING> section above before using this option."
34178 #: ../tools/virt-tar.pl:167
34179 msgid "You must specify exactly one of these options."
34184 #: ../tools/virt-tar.pl:173
34185 msgid "B<-z> | B<--gzip>"
34190 #: ../tools/virt-tar.pl:175
34191 msgid "Specify that the input or output tarball is gzip-compressed."
34195 #: ../tools/virt-tar.pl:288
34197 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34198 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34199 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34205 #: ../tools/virt-make-fs.pl:37
34206 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34211 #: ../tools/virt-make-fs.pl:41
34214 " virt-make-fs [--options] input.tar output.img\n"
34220 #: ../tools/virt-make-fs.pl:43
34223 " virt-make-fs [--options] input.tar.gz output.img\n"
34229 #: ../tools/virt-make-fs.pl:45
34232 " virt-make-fs [--options] directory output.img\n"
34238 #: ../tools/virt-make-fs.pl:49
34240 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34241 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34242 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34243 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34244 "you want to attach these filesystems to existing virtual machines (eg. to "
34245 "import large amounts of read-only data to a VM)."
34250 #: ../tools/virt-make-fs.pl:57
34251 msgid "Basic usage is:"
34256 #: ../tools/virt-make-fs.pl:59
34259 " virt-make-fs input output\n"
34265 #: ../tools/virt-make-fs.pl:61
34267 "where C<input> is either a directory containing files that you want to add, "
34268 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34269 "C<output> is a disk image. The input type is detected automatically. The "
34270 "output disk image defaults to a raw ext2 image unless you specify extra "
34271 "flags (see L</OPTIONS> below)."
34276 #: ../tools/virt-make-fs.pl:67
34277 msgid "EXTRA SPACE"
34281 #: ../tools/virt-make-fs.pl:69
34283 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34284 "the files that it contains, but might have extra space. Depending on how "
34285 "you are going to use the output, you might think this extra space is wasted "
34286 "and want to minimize it, or you might want to leave space so that more files "
34287 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34288 "but you can use the I<--size> flag to leave space in the filesystem if you "
34293 #: ../tools/virt-make-fs.pl:77
34295 "An alternative way to leave extra space but not make the output image any "
34296 "bigger is to use an alternative disk image format (instead of the default "
34297 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34298 "image format (check your hypervisor supports this before using it). This "
34299 "allows you to choose a large I<--size> but the extra space won't actually be "
34300 "allocated in the image until you try to store something in it."
34304 #: ../tools/virt-make-fs.pl:85
34306 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34307 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34308 "to build another image from scratch."
34313 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34314 #: ../tools/virt-make-fs.pl:142
34320 #: ../tools/virt-make-fs.pl:91
34323 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34329 #: ../tools/virt-make-fs.pl:93
34330 msgid "FILESYSTEM TYPE"
34335 #: ../tools/virt-make-fs.pl:95
34337 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34338 "libguestfs supports can be used (but I<not> read-only formats like "
34339 "ISO9660). Here are some of the more common choices:"
34344 #: ../tools/virt-make-fs.pl:101
34350 #: ../tools/virt-make-fs.pl:103
34352 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34353 "you are not going to use the filesystem in a way that requires the journal, "
34354 "then this is just wasted overhead."
34359 #: ../tools/virt-make-fs.pl:107
34360 msgid "I<ntfs> or I<vfat>"
34365 #: ../tools/virt-make-fs.pl:109
34366 msgid "Useful if exporting data to a Windows guest."
34371 #: ../tools/virt-make-fs.pl:111
34373 "I<Note for vfat>: The tar archive or local directory must only contain files "
34374 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34375 "program running within libguestfs is unable to change the ownership of non-"
34376 "root files, since vfat itself does not support this."
34381 #: ../tools/virt-make-fs.pl:116
34387 #: ../tools/virt-make-fs.pl:118
34389 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34390 "total filesystem size."
34395 #: ../tools/virt-make-fs.pl:125
34398 " virt-make-fs --type=minix input minixfs.img\n"
34404 #: ../tools/virt-make-fs.pl:127
34405 msgid "TO PARTITION OR NOT TO PARTITION"
34410 #: ../tools/virt-make-fs.pl:129
34411 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34416 #: ../tools/virt-make-fs.pl:131
34418 "Adding a partition can make the disk image more compatible with certain "
34419 "virtualized operating systems which don't expect to see a filesystem "
34420 "directly located on a block device (Linux doesn't care and will happily "
34421 "handle both types)."
34426 #: ../tools/virt-make-fs.pl:136
34428 "On the other hand, if you have a partition table then the output image is no "
34429 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34430 "directly on a partitioned disk image. (However libguestfs tools such as "
34431 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34436 #: ../tools/virt-make-fs.pl:144
34437 msgid "Add an MBR partition:"
34442 #: ../tools/virt-make-fs.pl:146
34445 " virt-make-fs --partition -- input disk.img\n"
34451 #: ../tools/virt-make-fs.pl:148
34453 "If the output disk image could be terabyte-sized or larger, it's better to "
34454 "use an EFI/GPT-compatible partition table:"
34459 #: ../tools/virt-make-fs.pl:151
34462 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34468 #: ../tools/virt-make-fs.pl:179
34469 msgid "Enable debugging information."
34474 #: ../tools/virt-make-fs.pl:185
34475 msgid "B<--size=E<lt>NE<gt>>"
34480 #: ../tools/virt-make-fs.pl:187
34481 msgid "B<--size=+E<lt>NE<gt>>"
34486 #: ../tools/virt-make-fs.pl:189
34487 msgid "B<-s E<lt>NE<gt>>"
34492 #: ../tools/virt-make-fs.pl:191
34493 msgid "B<-s +E<lt>NE<gt>>"
34497 #: ../tools/virt-make-fs.pl:193
34499 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34504 #: ../tools/virt-make-fs.pl:196
34506 "If this option is I<not> given, then the output image will be just large "
34507 "enough to contain all the files, with not much wasted space."
34512 #: ../tools/virt-make-fs.pl:199
34514 "To choose a fixed size output disk, specify an absolute number followed by b/"
34515 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34516 "Petabytes or Exabytes. This must be large enough to contain all the input "
34517 "files, else you will get an error."
34521 #: ../tools/virt-make-fs.pl:204
34523 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34524 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34525 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34526 "the input files, and (approximately) an extra 200 MB free space."
34531 #: ../tools/virt-make-fs.pl:210
34533 "Note that virt-make-fs estimates free space, and therefore will not produce "
34534 "filesystems containing precisely the free space requested. (It is much more "
34535 "expensive and time-consuming to produce a filesystem which has precisely the "
34536 "desired free space)."
34541 #: ../tools/virt-make-fs.pl:219
34542 msgid "B<--format=E<lt>fmtE<gt>>"
34547 #: ../tools/virt-make-fs.pl:221
34548 msgid "B<-F E<lt>fmtE<gt>>"
34553 #: ../tools/virt-make-fs.pl:223
34554 msgid "Choose the output disk image format."
34559 #: ../tools/virt-make-fs.pl:225
34560 msgid "The default is C<raw> (raw disk image)."
34565 #: ../tools/virt-make-fs.pl:227
34567 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34568 "that would really make sense here is C<qcow2>."
34573 #: ../tools/virt-make-fs.pl:234
34574 msgid "B<--type=E<lt>fsE<gt>>"
34579 #: ../tools/virt-make-fs.pl:236
34580 msgid "B<-t E<lt>fsE<gt>>"
34585 #: ../tools/virt-make-fs.pl:238
34586 msgid "Choose the output filesystem type."
34591 #: ../tools/virt-make-fs.pl:240
34592 msgid "The default is C<ext2>."
34597 #: ../tools/virt-make-fs.pl:242
34599 "Any filesystem which is supported read-write by libguestfs can be used here."
34604 #: ../tools/virt-make-fs.pl:249
34605 msgid "B<--partition>"
34610 #: ../tools/virt-make-fs.pl:251
34611 msgid "B<--partition=E<lt>parttypeE<gt>>"
34616 #: ../tools/virt-make-fs.pl:253
34618 "If specified, this flag adds an MBR partition table to the output disk image."
34622 #: ../tools/virt-make-fs.pl:256
34624 "You can change the partition table type, eg. I<--partition=gpt> for large "
34629 #: ../tools/virt-make-fs.pl:259
34631 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34632 "might consider the next parameter to be the partition type. For example:"
34637 #: ../tools/virt-make-fs.pl:263
34640 " virt-make-fs --partition input.tar ...\n"
34645 #: ../tools/virt-make-fs.pl:265
34647 "would cause virt-make-fs to think you wanted to use a partition type of "
34648 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34649 "dash) between options and the input file argument:"
34654 #: ../tools/virt-make-fs.pl:269
34657 " virt-make-fs --partition -- input.tar ...\n"
34662 #: ../tools/virt-make-fs.pl:541
34664 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34665 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34666 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34671 #: ../tools/virt-make-fs.pl:558
34674 " export LIBGUESTFS_DEBUG=1\n"
34675 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34681 #: ../tools/virt-make-fs.pl:561
34683 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34689 #: ../tools/virt-list-partitions.pl:32
34691 "virt-list-partitions - List partitions in a virtual machine or disk image"
34696 #: ../tools/virt-list-partitions.pl:36
34699 " virt-list-partitions [--options] domname\n"
34705 #: ../tools/virt-list-partitions.pl:38
34708 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34714 #: ../tools/virt-list-partitions.pl:45
34716 "C<virt-list-partitions> is a command line tool to list the partitions that "
34717 "are contained in a virtual machine or disk image. It is mainly useful as a "
34718 "first step to using L<virt-resize(1)>."
34723 #: ../tools/virt-list-partitions.pl:50
34725 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34726 "functionality. For more complex cases you should look at the L<guestfish(1)"
34732 #: ../tools/virt-list-partitions.pl:107
34733 msgid "B<-h> | B<--human-readable>"
34738 #: ../tools/virt-list-partitions.pl:109
34739 msgid "Show sizes in human-readable form (eg. \"1G\")."
34744 #: ../tools/virt-list-partitions.pl:117
34746 "With this option, C<virt-list-partitions> displays the type and size of each "
34747 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34752 #: ../tools/virt-list-partitions.pl:124
34753 msgid "B<-t> | B<--total>"
34758 #: ../tools/virt-list-partitions.pl:126
34760 "Display the total size of each block device (as a separate row or rows)."
34765 #: ../tools/virt-list-partitions.pl:259
34767 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34768 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34769 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34774 #: ../tools/virt-list-partitions.pl:275
34775 msgid "Copyright (C) 2009-2010 Red Hat Inc."
git.annexia.org / libguestfs.git / blob