1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-07-13 15:55+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:6106
5577 #: ../fish/guestfish-actions.pod:4041
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:3780 ../src/guestfs-actions.pod:3794
6430 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:3821
6431 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:3872
6432 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3964
6433 #: ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4004
6434 #: ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4062
6435 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4100
6436 #: ../src/guestfs-actions.pod:4135 ../src/guestfs-actions.pod:4147
6437 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4199
6438 #: ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4227
6439 #: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4337
6440 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4370
6441 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4439
6442 #: ../src/guestfs-actions.pod:4457 ../src/guestfs-actions.pod:4473
6443 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4501
6444 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4533
6445 #: ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4623
6446 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4727
6447 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4765
6448 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4794
6449 #: ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:4822
6450 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4872
6451 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4944
6452 #: ../src/guestfs-actions.pod:4964 ../src/guestfs-actions.pod:4978
6453 #: ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5044
6454 #: ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5144
6455 #: ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:5215
6456 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5250
6457 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5441
6458 #: ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5481
6459 #: ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5579
6460 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5609
6461 #: ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:5912
6462 #: ../src/guestfs-actions.pod:5931 ../src/guestfs-actions.pod:5950
6463 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5976
6464 #: ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6002
6465 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6032
6466 #: ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6072
6467 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6121
6468 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
6469 #: ../src/guestfs-actions.pod:6180 ../src/guestfs-actions.pod:6199
6470 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6239
6471 #: ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6284
6472 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-actions.pod:6327
6473 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6370
6474 #: ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6404
6475 #: ../src/guestfs-actions.pod:6441 ../src/guestfs-actions.pod:6471
6476 #: ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6626
6477 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6759
6478 #: ../src/guestfs-actions.pod:6772 ../src/guestfs-actions.pod:6785
6479 #: ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6820
6480 #: ../src/guestfs-actions.pod:6833 ../src/guestfs-actions.pod:6846
6481 #: ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:6920
6482 #: ../src/guestfs-actions.pod:6937 ../src/guestfs-actions.pod:6953
6483 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6986
6484 #: ../src/guestfs-actions.pod:6999 ../src/guestfs-actions.pod:7019
6485 #: ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7069
6486 #: ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7123
6487 #: ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7175
6488 #: ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7327
6489 #: ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7356
6490 #: ../src/guestfs-actions.pod:7411 ../src/guestfs-actions.pod:7424
6491 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7502
6492 #: ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7589
6493 #: ../src/guestfs-actions.pod:7656 ../src/guestfs-actions.pod:7675
6494 #: ../src/guestfs-actions.pod:7704
6495 msgid "This function returns 0 on success or -1 on error."
6500 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6501 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6502 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6504 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6510 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6511 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6512 #: ../src/guestfs-actions.pod:1949 ../src/guestfs-actions.pod:1970
6513 #: ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4877
6514 #: ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5185
6515 #: ../src/guestfs-actions.pod:6449 ../src/guestfs-actions.pod:6479
6516 #: ../src/guestfs-actions.pod:6512 ../src/guestfs-actions.pod:6571
6517 #: ../src/guestfs-actions.pod:7507 ../src/guestfs-actions.pod:7597
6518 #: ../src/guestfs-actions.pod:7767 ../fish/guestfish-actions.pod:31
6519 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6520 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6521 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3054
6522 #: ../fish/guestfish-actions.pod:3261 ../fish/guestfish-actions.pod:3375
6523 #: ../fish/guestfish-actions.pod:3423 ../fish/guestfish-actions.pod:4303
6524 #: ../fish/guestfish-actions.pod:4326 ../fish/guestfish-actions.pod:4348
6525 #: ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:5021
6526 #: ../fish/guestfish-actions.pod:5119
6528 "Deprecated functions will not be removed from the API, but the fact that "
6529 "they are deprecated indicates that there are problems with correct use of "
6535 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6536 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1921
6537 #: ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2122
6538 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3573
6539 #: ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:6141
6540 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6372
6541 #: ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:6988
6542 #: ../src/guestfs-actions.pod:7511
6543 msgid "(Added in 0.3)"
6548 #: ../src/guestfs-actions.pod:41
6549 msgid "guestfs_add_domain"
6554 #: ../src/guestfs-actions.pod:43
6558 " guestfs_add_domain (guestfs_h *g,\n"
6559 " const char *dom,\n"
6566 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6567 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:4572
6568 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5108
6570 "You may supply a list of optional arguments to this call. Use zero or more "
6571 "of the following pairs of parameters, and terminate the list with C<-1> on "
6572 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6576 #: ../src/guestfs-actions.pod:53
6579 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6580 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6581 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6582 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6583 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6589 #: ../src/guestfs-actions.pod:59
6591 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6592 "It works by connecting to libvirt, requesting the domain and domain XML from "
6593 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6599 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6601 "The number of disks added is returned. This operation is atomic: if an "
6602 "error is returned, then no disks are added."
6607 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6609 "This function does some minimal checks to make sure the libvirt domain is "
6610 "not running (unless C<readonly> is true). In a future version we will try "
6611 "to acquire the libvirt lock on each disk."
6616 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6618 "Disks must be accessible locally. This often means that adding disks from a "
6619 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6620 "unless those disks are accessible via the same device path locally too."
6624 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6626 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6627 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6628 "libvirt URI (or one set through an environment variable, see the libvirt "
6629 "documentation for full details)."
6633 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6635 "The optional C<live> flag controls whether this call will try to connect to "
6636 "a running virtual machine C<guestfsd> process if it sees a suitable "
6637 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6638 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6639 "DAEMONS> for more information."
6643 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6645 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6646 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6647 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6653 #: ../src/guestfs-actions.pod:94
6655 "The other optional parameters are passed directly through to "
6656 "C<guestfs_add_drive_opts>."
6661 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6662 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6663 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6664 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6665 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6666 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2031
6667 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:2109
6668 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2874
6669 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:5067
6670 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5693
6671 #: ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:7096
6672 #: ../src/guestfs-actions.pod:7522 ../src/guestfs-actions.pod:7535
6673 #: ../src/guestfs-actions.pod:7548
6674 msgid "On error this function returns -1."
6679 #: ../src/guestfs-actions.pod:99
6680 msgid "(Added in 1.7.4)"
6685 #: ../src/guestfs-actions.pod:101
6686 msgid "guestfs_add_domain_va"
6691 #: ../src/guestfs-actions.pod:103
6695 " guestfs_add_domain_va (guestfs_h *g,\n"
6696 " const char *dom,\n"
6703 #: ../src/guestfs-actions.pod:108
6704 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6709 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6710 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6711 #: ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2852
6712 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4649
6713 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4931
6714 #: ../src/guestfs-actions.pod:5157 ../src/guestfs-actions.pod:5168
6715 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6720 #: ../src/guestfs-actions.pod:112
6721 msgid "guestfs_add_domain_argv"
6726 #: ../src/guestfs-actions.pod:114
6730 " guestfs_add_domain_argv (guestfs_h *g,\n"
6731 " const char *dom,\n"
6732 " const struct guestfs_add_domain_argv *optargs);\n"
6738 #: ../src/guestfs-actions.pod:119
6739 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6744 #: ../src/guestfs-actions.pod:123
6745 msgid "guestfs_add_drive"
6750 #: ../src/guestfs-actions.pod:125
6754 " guestfs_add_drive (guestfs_h *g,\n"
6755 " const char *filename);\n"
6761 #: ../src/guestfs-actions.pod:129
6763 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6764 "optional parameters, so the disk is added writable, with the format being "
6765 "detected automatically."
6770 #: ../src/guestfs-actions.pod:133
6772 "Automatic detection of the format opens you up to a potential security hole "
6773 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6774 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6775 "you should think about replacing calls to this function with calls to "
6776 "C<guestfs_add_drive_opts>, and specifying the format."
6781 #: ../src/guestfs-actions.pod:144
6782 msgid "guestfs_add_drive_opts"
6787 #: ../src/guestfs-actions.pod:146
6791 " guestfs_add_drive_opts (guestfs_h *g,\n"
6792 " const char *filename,\n"
6799 #: ../src/guestfs-actions.pod:156
6802 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6803 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6804 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6810 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6812 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6813 "The first time you call this function, the disk appears as C</dev/sda>, the "
6814 "second time as C</dev/sdb>, and so on."
6819 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6821 "You don't necessarily need to be root when using libguestfs. However you "
6822 "obviously do need sufficient permissions to access the filename for whatever "
6823 "operations you want to perform (ie. read access if you just want to read the "
6824 "image or write access if you want to modify the image)."
6829 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6830 msgid "This call checks that C<filename> exists."
6835 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4585
6836 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3065
6837 msgid "The optional arguments are:"
6842 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6848 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6850 "If true then the image is treated as read-only. Writes are still allowed, "
6851 "but they are stored in a temporary snapshot overlay which is discarded at "
6852 "the end. The disk that you add is not modified."
6857 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6863 #: ../src/guestfs-actions.pod:185
6865 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6866 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6867 "Possible formats include C<raw> and C<qcow2>."
6872 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6874 "Automatic detection of the format opens you up to a potential security hole "
6875 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6876 "RHBZ#642934. Specifying the format closes this security hole."
6881 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6887 #: ../src/guestfs-actions.pod:196
6889 "This rarely-used option lets you emulate the behaviour of the deprecated "
6890 "C<guestfs_add_drive_with_if> call (q.v.)"
6895 #: ../src/guestfs-actions.pod:203
6896 msgid "(Added in 1.5.23)"
6901 #: ../src/guestfs-actions.pod:205
6902 msgid "guestfs_add_drive_opts_va"
6907 #: ../src/guestfs-actions.pod:207
6911 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6912 " const char *filename,\n"
6919 #: ../src/guestfs-actions.pod:212
6920 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6925 #: ../src/guestfs-actions.pod:216
6926 msgid "guestfs_add_drive_opts_argv"
6931 #: ../src/guestfs-actions.pod:218
6935 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6936 " const char *filename,\n"
6937 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6943 #: ../src/guestfs-actions.pod:223
6944 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6949 #: ../src/guestfs-actions.pod:227
6950 msgid "guestfs_add_drive_ro"
6955 #: ../src/guestfs-actions.pod:229
6959 " guestfs_add_drive_ro (guestfs_h *g,\n"
6960 " const char *filename);\n"
6966 #: ../src/guestfs-actions.pod:233
6968 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6969 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6970 "disk is added read-only, with the format being detected automatically."
6975 #: ../src/guestfs-actions.pod:240
6976 msgid "(Added in 1.0.38)"
6981 #: ../src/guestfs-actions.pod:242
6982 msgid "guestfs_add_drive_ro_with_if"
6987 #: ../src/guestfs-actions.pod:244
6991 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6992 " const char *filename,\n"
6993 " const char *iface);\n"
6999 #: ../src/guestfs-actions.pod:249
7001 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
7002 "QEMU interface emulation to use at run time."
7007 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
7008 #: ../src/guestfs-actions.pod:2361
7009 msgid "(Added in 1.0.84)"
7014 #: ../src/guestfs-actions.pod:263
7015 msgid "guestfs_add_drive_with_if"
7020 #: ../src/guestfs-actions.pod:265
7024 " guestfs_add_drive_with_if (guestfs_h *g,\n"
7025 " const char *filename,\n"
7026 " const char *iface);\n"
7032 #: ../src/guestfs-actions.pod:270
7034 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7035 "QEMU interface emulation to use at run time."
7040 #: ../src/guestfs-actions.pod:284
7041 msgid "guestfs_aug_clear"
7046 #: ../src/guestfs-actions.pod:286
7050 " guestfs_aug_clear (guestfs_h *g,\n"
7051 " const char *augpath);\n"
7057 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7059 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7060 "L<augtool(1)> C<clear> command."
7065 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2111
7066 msgid "(Added in 1.3.4)"
7071 #: ../src/guestfs-actions.pod:297
7072 msgid "guestfs_aug_close"
7077 #: ../src/guestfs-actions.pod:299
7081 " guestfs_aug_close (guestfs_h *g);\n"
7087 #: ../src/guestfs-actions.pod:302
7089 "Close the current Augeas handle and free up any resources used by it. After "
7090 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7091 "any other Augeas functions."
7096 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7097 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7098 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7099 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7100 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7101 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7102 #: ../src/guestfs-actions.pod:5770
7103 msgid "(Added in 0.7)"
7108 #: ../src/guestfs-actions.pod:311
7109 msgid "guestfs_aug_defnode"
7114 #: ../src/guestfs-actions.pod:313
7117 " struct guestfs_int_bool *\n"
7118 " guestfs_aug_defnode (guestfs_h *g,\n"
7119 " const char *name,\n"
7120 " const char *expr,\n"
7121 " const char *val);\n"
7127 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7129 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7134 #: ../src/guestfs-actions.pod:322
7136 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7137 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7138 "containing that single node."
7143 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7145 "On success this returns a pair containing the number of nodes in the "
7146 "nodeset, and a boolean flag if a node was created."
7151 #: ../src/guestfs-actions.pod:330
7153 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7154 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7159 #: ../src/guestfs-actions.pod:336
7160 msgid "guestfs_aug_defvar"
7165 #: ../src/guestfs-actions.pod:338
7169 " guestfs_aug_defvar (guestfs_h *g,\n"
7170 " const char *name,\n"
7171 " const char *expr);\n"
7177 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7179 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7180 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7185 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7187 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7188 "evaluates to something which is not a nodeset."
7193 #: ../src/guestfs-actions.pod:354
7194 msgid "guestfs_aug_get"
7199 #: ../src/guestfs-actions.pod:356
7203 " guestfs_aug_get (guestfs_h *g,\n"
7204 " const char *augpath);\n"
7210 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7212 "Look up the value associated with C<path>. If C<path> matches exactly one "
7213 "node, the C<value> is returned."
7218 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
7219 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
7220 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
7221 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
7222 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
7223 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
7224 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
7225 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1943
7226 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2134
7227 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2530
7228 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2724
7229 #: ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2957
7230 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3006
7231 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3099
7232 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3139
7233 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:4119
7234 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4399
7235 #: ../src/guestfs-actions.pod:5305 ../src/guestfs-actions.pod:5498
7236 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5846
7237 #: ../src/guestfs-actions.pod:5895 ../src/guestfs-actions.pod:6532
7238 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6565
7239 #: ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:7270
7240 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7307
7241 #: ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7761
7243 "This function returns a string, or NULL on error. I<The caller must free "
7244 "the returned string after use>."
7249 #: ../src/guestfs-actions.pod:368
7250 msgid "guestfs_aug_init"
7255 #: ../src/guestfs-actions.pod:370
7259 " guestfs_aug_init (guestfs_h *g,\n"
7260 " const char *root,\n"
7267 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7269 "Create a new Augeas handle for editing configuration files. If there was "
7270 "any previous Augeas handle associated with this guestfs session, then it is "
7276 #: ../src/guestfs-actions.pod:379
7277 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7282 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7284 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7289 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7291 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7292 "logical I<or> of the following integers:"
7297 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7298 msgid "C<AUG_SAVE_BACKUP> = 1"
7303 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7304 msgid "Keep the original file with a C<.augsave> extension."
7309 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7310 msgid "C<AUG_SAVE_NEWFILE> = 2"
7315 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7317 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7318 "original. Overrides C<AUG_SAVE_BACKUP>."
7323 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7324 msgid "C<AUG_TYPE_CHECK> = 4"
7329 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7330 msgid "Typecheck lenses (can be expensive)."
7335 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7336 msgid "C<AUG_NO_STDINC> = 8"
7341 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7342 msgid "Do not use standard load path for modules."
7347 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7348 msgid "C<AUG_SAVE_NOOP> = 16"
7353 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7354 msgid "Make save a no-op, just record what would have been changed."
7359 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7360 msgid "C<AUG_NO_LOAD> = 32"
7365 #: ../src/guestfs-actions.pod:414
7366 msgid "Do not load the tree in C<guestfs_aug_init>."
7371 #: ../src/guestfs-actions.pod:418
7372 msgid "To close the handle, you can call C<guestfs_aug_close>."
7377 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7378 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7383 #: ../src/guestfs-actions.pod:426
7384 msgid "guestfs_aug_insert"
7389 #: ../src/guestfs-actions.pod:428
7393 " guestfs_aug_insert (guestfs_h *g,\n"
7394 " const char *augpath,\n"
7395 " const char *label,\n"
7402 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7404 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7405 "or after C<path> (depending on the boolean flag C<before>)."
7410 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7412 "C<path> must match exactly one existing node in the tree, and C<label> must "
7413 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7418 #: ../src/guestfs-actions.pod:446
7419 msgid "guestfs_aug_load"
7424 #: ../src/guestfs-actions.pod:448
7428 " guestfs_aug_load (guestfs_h *g);\n"
7434 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7435 msgid "Load files into the tree."
7440 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7441 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7446 #: ../src/guestfs-actions.pod:460
7447 msgid "guestfs_aug_ls"
7452 #: ../src/guestfs-actions.pod:462
7456 " guestfs_aug_ls (guestfs_h *g,\n"
7457 " const char *augpath);\n"
7463 #: ../src/guestfs-actions.pod:466
7465 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7466 "sorting the resulting nodes into alphabetical order."
7471 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7472 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
7473 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
7474 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
7475 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2206
7476 #: ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2241
7477 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308
7478 #: ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:2428
7479 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:3059
7480 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3649
7481 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3686
7482 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:3853
7483 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:5028
7484 #: ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5766
7485 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:6612
7486 #: ../src/guestfs-actions.pod:6673 ../src/guestfs-actions.pod:6728
7487 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6898
7488 #: ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7394
7489 #: ../src/guestfs-actions.pod:7441 ../src/guestfs-actions.pod:7613
7490 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7718
7491 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7783
7492 #: ../src/guestfs-actions.pod:7802
7494 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7495 ">), or NULL if there was an error. I<The caller must free the strings and "
7496 "the array after use>."
7501 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
7502 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
7503 #: ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3444
7504 #: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4152
7505 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:4372
7506 #: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:5032
7507 #: ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5978
7508 #: ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6004
7509 #: ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:7112
7510 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7358
7511 #: ../src/guestfs-actions.pod:7601
7512 msgid "(Added in 0.8)"
7517 #: ../src/guestfs-actions.pod:475
7518 msgid "guestfs_aug_match"
7523 #: ../src/guestfs-actions.pod:477
7527 " guestfs_aug_match (guestfs_h *g,\n"
7528 " const char *augpath);\n"
7534 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7536 "Returns a list of paths which match the path expression C<path>. The "
7537 "returned paths are sufficiently qualified so that they match exactly one "
7538 "node in the current tree."
7543 #: ../src/guestfs-actions.pod:491
7544 msgid "guestfs_aug_mv"
7549 #: ../src/guestfs-actions.pod:493
7553 " guestfs_aug_mv (guestfs_h *g,\n"
7554 " const char *src,\n"
7555 " const char *dest);\n"
7561 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7563 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7564 "C<dest> is overwritten if it exists."
7569 #: ../src/guestfs-actions.pod:505
7570 msgid "guestfs_aug_rm"
7575 #: ../src/guestfs-actions.pod:507
7579 " guestfs_aug_rm (guestfs_h *g,\n"
7580 " const char *augpath);\n"
7586 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7587 msgid "Remove C<path> and all of its children."
7592 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7593 msgid "On success this returns the number of entries which were removed."
7598 #: ../src/guestfs-actions.pod:519
7599 msgid "guestfs_aug_save"
7604 #: ../src/guestfs-actions.pod:521
7608 " guestfs_aug_save (guestfs_h *g);\n"
7614 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7615 msgid "This writes all pending changes to disk."
7620 #: ../src/guestfs-actions.pod:526
7622 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7628 #: ../src/guestfs-actions.pod:533
7629 msgid "guestfs_aug_set"
7634 #: ../src/guestfs-actions.pod:535
7638 " guestfs_aug_set (guestfs_h *g,\n"
7639 " const char *augpath,\n"
7640 " const char *val);\n"
7646 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7647 msgid "Set the value associated with C<path> to C<val>."
7652 #: ../src/guestfs-actions.pod:542
7654 "In the Augeas API, it is possible to clear a node by setting the value to "
7655 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7656 "this call. Instead you must use the C<guestfs_aug_clear> call."
7661 #: ../src/guestfs-actions.pod:551
7662 msgid "guestfs_available"
7667 #: ../src/guestfs-actions.pod:553
7671 " guestfs_available (guestfs_h *g,\n"
7672 " char *const *groups);\n"
7678 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7680 "This command is used to check the availability of some groups of "
7681 "functionality in the appliance, which not all builds of the libguestfs "
7682 "appliance will be able to provide."
7687 #: ../src/guestfs-actions.pod:561
7689 "The libguestfs groups, and the functions that those groups correspond to, "
7690 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7691 "runtime by calling C<guestfs_available_all_groups>."
7696 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7698 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7699 "\"]> would check for the availability of the Linux inotify functions and "
7700 "Augeas (configuration file editing) functions."
7705 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7706 msgid "The command returns no error if I<all> requested groups are available."
7711 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7713 "It fails with an error if one or more of the requested groups is unavailable "
7719 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7721 "If an unknown group name is included in the list of groups then an error is "
7727 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7733 #: ../src/guestfs-actions.pod:585
7734 msgid "You must call C<guestfs_launch> before calling this function."
7739 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7741 "The reason is because we don't know what groups are supported by the "
7742 "appliance/daemon until it is running and can be queried."
7747 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7749 "If a group of functions is available, this does not necessarily mean that "
7750 "they will work. You still have to check for errors when calling individual "
7751 "API functions even if they are available."
7756 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7758 "It is usually the job of distro packagers to build complete functionality "
7759 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7760 "with all requirements satisfied, will support everything."
7765 #: ../src/guestfs-actions.pod:607
7767 "This call was added in version C<1.0.80>. In previous versions of "
7768 "libguestfs all you could do would be to speculatively execute a command to "
7769 "find out if the daemon implemented it. See also C<guestfs_version>."
7774 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7775 msgid "(Added in 1.0.80)"
7780 #: ../src/guestfs-actions.pod:618
7781 msgid "guestfs_available_all_groups"
7786 #: ../src/guestfs-actions.pod:620
7790 " guestfs_available_all_groups (guestfs_h *g);\n"
7796 #: ../src/guestfs-actions.pod:623
7798 "This command returns a list of all optional groups that this daemon knows "
7799 "about. Note this returns both supported and unsupported groups. To find "
7800 "out which ones the daemon can actually support you have to call "
7801 "C<guestfs_available> on each member of the returned list."
7806 #: ../src/guestfs-actions.pod:629
7807 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7812 #: ../src/guestfs-actions.pod:635
7813 msgid "(Added in 1.3.15)"
7818 #: ../src/guestfs-actions.pod:637
7819 msgid "guestfs_base64_in"
7824 #: ../src/guestfs-actions.pod:639
7828 " guestfs_base64_in (guestfs_h *g,\n"
7829 " const char *base64file,\n"
7830 " const char *filename);\n"
7836 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7838 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7843 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7844 msgid "(Added in 1.3.5)"
7849 #: ../src/guestfs-actions.pod:651
7850 msgid "guestfs_base64_out"
7855 #: ../src/guestfs-actions.pod:653
7859 " guestfs_base64_out (guestfs_h *g,\n"
7860 " const char *filename,\n"
7861 " const char *base64file);\n"
7867 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7869 "This command downloads the contents of C<filename>, writing it out to local "
7870 "file C<base64file> encoded as base64."
7875 #: ../src/guestfs-actions.pod:665
7876 msgid "guestfs_blockdev_flushbufs"
7881 #: ../src/guestfs-actions.pod:667
7885 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7886 " const char *device);\n"
7892 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7894 "This tells the kernel to flush internal buffers associated with C<device>."
7899 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7900 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7901 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7902 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7903 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7904 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7905 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7906 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7907 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7908 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7909 msgid "This uses the L<blockdev(8)> command."
7914 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7915 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7916 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7917 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7918 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7919 msgid "(Added in 0.9.3)"
7924 #: ../src/guestfs-actions.pod:680
7925 msgid "guestfs_blockdev_getbsz"
7930 #: ../src/guestfs-actions.pod:682
7934 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7935 " const char *device);\n"
7941 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7942 msgid "This returns the block size of a device."
7947 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7948 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7950 "(Note this is different from both I<size in blocks> and I<filesystem block "
7956 #: ../src/guestfs-actions.pod:697
7957 msgid "guestfs_blockdev_getro"
7962 #: ../src/guestfs-actions.pod:699
7966 " guestfs_blockdev_getro (guestfs_h *g,\n"
7967 " const char *device);\n"
7973 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7975 "Returns a boolean indicating if the block device is read-only (true if read-"
7976 "only, false if not)."
7981 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7982 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1919
7983 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2002
7984 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:2072
7985 #: ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:2120
7986 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172
7987 #: ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3352
7988 #: ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3381
7989 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3411
7990 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3442
7991 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469
7992 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3498
7993 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7994 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:5269
7995 msgid "This function returns a C truth value on success or -1 on error."
8000 #: ../src/guestfs-actions.pod:712
8001 msgid "guestfs_blockdev_getsize64"
8006 #: ../src/guestfs-actions.pod:714
8010 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
8011 " const char *device);\n"
8017 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
8018 msgid "This returns the size of the device in bytes."
8023 #: ../src/guestfs-actions.pod:720
8024 msgid "See also C<guestfs_blockdev_getsz>."
8029 #: ../src/guestfs-actions.pod:728
8030 msgid "guestfs_blockdev_getss"
8035 #: ../src/guestfs-actions.pod:730
8039 " guestfs_blockdev_getss (guestfs_h *g,\n"
8040 " const char *device);\n"
8046 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8048 "This returns the size of sectors on a block device. Usually 512, but can be "
8049 "larger for modern devices."
8054 #: ../src/guestfs-actions.pod:737
8056 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8062 #: ../src/guestfs-actions.pod:746
8063 msgid "guestfs_blockdev_getsz"
8068 #: ../src/guestfs-actions.pod:748
8072 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8073 " const char *device);\n"
8079 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8081 "This returns the size of the device in units of 512-byte sectors (even if "
8082 "the sectorsize isn't 512 bytes ... weird)."
8087 #: ../src/guestfs-actions.pod:755
8089 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8090 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8095 #: ../src/guestfs-actions.pod:765
8096 msgid "guestfs_blockdev_rereadpt"
8101 #: ../src/guestfs-actions.pod:767
8105 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8106 " const char *device);\n"
8112 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8113 msgid "Reread the partition table on C<device>."
8118 #: ../src/guestfs-actions.pod:779
8119 msgid "guestfs_blockdev_setbsz"
8124 #: ../src/guestfs-actions.pod:781
8128 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8129 " const char *device,\n"
8130 " int blocksize);\n"
8136 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8137 msgid "This sets the block size of a device."
8142 #: ../src/guestfs-actions.pod:797
8143 msgid "guestfs_blockdev_setro"
8148 #: ../src/guestfs-actions.pod:799
8152 " guestfs_blockdev_setro (guestfs_h *g,\n"
8153 " const char *device);\n"
8159 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8160 msgid "Sets the block device named C<device> to read-only."
8165 #: ../src/guestfs-actions.pod:811
8166 msgid "guestfs_blockdev_setrw"
8171 #: ../src/guestfs-actions.pod:813
8175 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8176 " const char *device);\n"
8182 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8183 msgid "Sets the block device named C<device> to read-write."
8188 #: ../src/guestfs-actions.pod:825
8189 msgid "guestfs_case_sensitive_path"
8194 #: ../src/guestfs-actions.pod:827
8198 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8199 " const char *path);\n"
8205 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
8207 "This can be used to resolve case insensitive paths on a filesystem which is "
8208 "case sensitive. The use case is to resolve paths which you have read from "
8209 "Windows configuration files or the Windows Registry, to the true path."
8214 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
8216 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8217 "(and probably others), which is that although the underlying filesystem is "
8218 "case-insensitive, the driver exports the filesystem to Linux as case-"
8224 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
8226 "One consequence of this is that special directories such as C<c:\\windows> "
8227 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8228 "precise details of how they were created. In Windows itself this would not "
8234 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
8236 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8242 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
8244 "This function resolves the true case of each element in the path and returns "
8245 "the case-sensitive path."
8250 #: ../src/guestfs-actions.pod:853
8252 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8253 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8254 "how the directories were originally created under Windows)."
8259 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
8260 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8265 #: ../src/guestfs-actions.pod:861
8266 msgid "See also C<guestfs_realpath>."
8271 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7292
8272 msgid "(Added in 1.0.75)"
8277 #: ../src/guestfs-actions.pod:868
8283 #: ../src/guestfs-actions.pod:870
8287 " guestfs_cat (guestfs_h *g,\n"
8288 " const char *path);\n"
8294 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5756
8295 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3800
8296 msgid "Return the contents of the file named C<path>."
8301 #: ../src/guestfs-actions.pod:876
8303 "Note that this function cannot correctly handle binary files (specifically, "
8304 "files containing C<\\0> character which is treated as end of string). For "
8305 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8306 "functions which have a more complex interface."
8311 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
8312 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
8313 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
8314 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
8315 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2245
8316 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312
8317 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2358
8318 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5564
8319 #: ../src/guestfs-actions.pod:5695 ../src/guestfs-actions.pod:5721
8320 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:6677
8321 #: ../src/guestfs-actions.pod:6732 ../src/guestfs-actions.pod:6878
8322 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:7565
8323 #: ../src/guestfs-actions.pod:7591 ../src/guestfs-actions.pod:7617
8324 #: ../src/guestfs-actions.pod:7636 ../src/guestfs-actions.pod:7722
8325 #: ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:7787
8326 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:592
8327 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8328 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8329 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8330 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
8331 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
8332 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
8333 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3670
8334 #: ../fish/guestfish-actions.pod:3685 ../fish/guestfish-actions.pod:3761
8335 #: ../fish/guestfish-actions.pod:3778 ../fish/guestfish-actions.pod:3793
8336 #: ../fish/guestfish-actions.pod:4447 ../fish/guestfish-actions.pod:4493
8337 #: ../fish/guestfish-actions.pod:4578 ../fish/guestfish-actions.pod:4593
8338 #: ../fish/guestfish-actions.pod:4997 ../fish/guestfish-actions.pod:5015
8339 #: ../fish/guestfish-actions.pod:5032 ../fish/guestfish-actions.pod:5042
8340 #: ../fish/guestfish-actions.pod:5091 ../fish/guestfish-actions.pod:5101
8341 #: ../fish/guestfish-actions.pod:5130 ../fish/guestfish-actions.pod:5140
8343 "Because of the message protocol, there is a transfer limit of somewhere "
8344 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8349 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3670
8350 #: ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3769
8351 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:4265
8352 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:5644
8353 #: ../src/guestfs-actions.pod:5658 ../src/guestfs-actions.pod:7445
8354 #: ../src/guestfs-actions.pod:7459
8355 msgid "(Added in 0.4)"
8360 #: ../src/guestfs-actions.pod:889
8361 msgid "guestfs_checksum"
8366 #: ../src/guestfs-actions.pod:891
8370 " guestfs_checksum (guestfs_h *g,\n"
8371 " const char *csumtype,\n"
8372 " const char *path);\n"
8378 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
8380 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8385 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
8387 "The type of checksum to compute is given by the C<csumtype> parameter which "
8388 "must have one of the following values:"
8393 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
8399 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
8401 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8407 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
8413 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
8414 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8419 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
8425 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
8426 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8431 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
8437 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
8438 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8443 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
8449 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
8450 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8455 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
8461 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
8462 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8467 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
8473 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
8474 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8479 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
8480 msgid "The checksum is returned as a printable string."
8485 #: ../src/guestfs-actions.pod:937
8486 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8491 #: ../src/guestfs-actions.pod:939
8492 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8497 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
8498 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:3368
8499 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3458
8500 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:7148
8501 msgid "(Added in 1.0.2)"
8506 #: ../src/guestfs-actions.pod:946
8507 msgid "guestfs_checksum_device"
8512 #: ../src/guestfs-actions.pod:948
8516 " guestfs_checksum_device (guestfs_h *g,\n"
8517 " const char *csumtype,\n"
8518 " const char *device);\n"
8524 #: ../src/guestfs-actions.pod:953
8526 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8527 "device named C<device>. For the types of checksums supported see the "
8528 "C<guestfs_checksum> command."
8533 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5099
8534 #: ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5271
8535 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5465
8536 #: ../src/guestfs-actions.pod:7057 ../src/guestfs-actions.pod:7071
8537 #: ../src/guestfs-actions.pod:7471
8538 msgid "(Added in 1.3.2)"
8543 #: ../src/guestfs-actions.pod:962
8544 msgid "guestfs_checksums_out"
8549 #: ../src/guestfs-actions.pod:964
8553 " guestfs_checksums_out (guestfs_h *g,\n"
8554 " const char *csumtype,\n"
8555 " const char *directory,\n"
8556 " const char *sumsfile);\n"
8562 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
8564 "This command computes the checksums of all regular files in C<directory> and "
8565 "then emits a list of those checksums to the local output file C<sumsfile>."
8570 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
8572 "This can be used for verifying the integrity of a virtual machine. However "
8573 "to be properly secure you should pay attention to the output of the checksum "
8574 "command (it uses the ones from GNU coreutils). In particular when the "
8575 "filename is not printable, coreutils uses a special backslash syntax. For "
8576 "more information, see the GNU coreutils info file."
8581 #: ../src/guestfs-actions.pod:984
8582 msgid "(Added in 1.3.7)"
8587 #: ../src/guestfs-actions.pod:986
8588 msgid "guestfs_chmod"
8593 #: ../src/guestfs-actions.pod:988
8597 " guestfs_chmod (guestfs_h *g,\n"
8599 " const char *path);\n"
8605 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
8607 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8613 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
8615 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8616 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8622 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4516
8623 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:4744
8624 #: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:681
8625 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3168
8626 #: ../fish/guestfish-actions.pod:3178 ../fish/guestfish-actions.pod:3188
8627 msgid "The mode actually set is affected by the umask."
8632 #: ../src/guestfs-actions.pod:1006
8633 msgid "guestfs_chown"
8638 #: ../src/guestfs-actions.pod:1008
8642 " guestfs_chown (guestfs_h *g,\n"
8645 " const char *path);\n"
8651 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
8652 msgid "Change the file owner to C<owner> and group to C<group>."
8657 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3587
8658 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
8660 "Only numeric uid and gid are supported. If you want to use names, you will "
8661 "need to locate and parse the password file yourself (Augeas support makes "
8662 "this relatively easy)."
8667 #: ../src/guestfs-actions.pod:1024
8668 msgid "guestfs_command"
8673 #: ../src/guestfs-actions.pod:1026
8677 " guestfs_command (guestfs_h *g,\n"
8678 " char *const *arguments);\n"
8684 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
8686 "This call runs a command from the guest filesystem. The filesystem must be "
8687 "mounted, and must contain a compatible operating system (ie. something "
8688 "Linux, with the same or compatible processor architecture)."
8693 #: ../src/guestfs-actions.pod:1035
8695 "The single parameter is an argv-style list of arguments. The first element "
8696 "is the name of the program to run. Subsequent elements are parameters. The "
8697 "list must be non-empty (ie. must contain a program name). Note that the "
8698 "command runs directly, and is I<not> invoked via the shell (see "
8704 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
8705 msgid "The return value is anything printed to I<stdout> by the command."
8710 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
8712 "If the command returns a non-zero exit status, then this function returns an "
8713 "error message. The error message string is the content of I<stderr> from "
8719 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
8721 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8722 "bin>. If you require a program from another location, you should provide "
8723 "the full path in the first parameter."
8728 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8730 "Shared libraries and data files required by the program must be available on "
8731 "filesystems which are mounted in the correct places. It is the caller's "
8732 "responsibility to ensure all filesystems that are needed are mounted at the "
8738 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8739 #: ../src/guestfs-actions.pod:1551
8740 msgid "(Added in 0.9.1)"
8745 #: ../src/guestfs-actions.pod:1068
8746 msgid "guestfs_command_lines"
8751 #: ../src/guestfs-actions.pod:1070
8755 " guestfs_command_lines (guestfs_h *g,\n"
8756 " char *const *arguments);\n"
8762 #: ../src/guestfs-actions.pod:1074
8764 "This is the same as C<guestfs_command>, but splits the result into a list of "
8770 #: ../src/guestfs-actions.pod:1077
8771 msgid "See also: C<guestfs_sh_lines>"
8776 #: ../src/guestfs-actions.pod:1088
8777 msgid "guestfs_config"
8782 #: ../src/guestfs-actions.pod:1090
8786 " guestfs_config (guestfs_h *g,\n"
8787 " const char *qemuparam,\n"
8788 " const char *qemuvalue);\n"
8793 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8795 "This can be used to add arbitrary qemu command line parameters of the form "
8796 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8797 "setting some parameters which would interfere with parameters that we use."
8802 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8803 msgid "The first character of C<param> string must be a C<-> (dash)."
8808 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8809 msgid "C<value> can be NULL."
8814 #: ../src/guestfs-actions.pod:1108
8815 msgid "guestfs_copy_size"
8820 #: ../src/guestfs-actions.pod:1110
8824 " guestfs_copy_size (guestfs_h *g,\n"
8825 " const char *src,\n"
8826 " const char *dest,\n"
8833 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8835 "This command copies exactly C<size> bytes from one source device or file "
8836 "C<src> to another destination device or file C<dest>."
8841 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8843 "Note this will fail if the source is too short or if the destination is not "
8848 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8849 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8850 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8851 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:7143
8852 #: ../src/guestfs-actions.pod:7177 ../src/guestfs-actions.pod:7658
8853 #: ../src/guestfs-actions.pod:7677
8855 "This long-running command can generate progress notification messages so "
8856 "that the caller can display a progress bar or indicator. To receive these "
8857 "messages, the caller must register a progress event callback. See L<guestfs"
8858 "(3)/GUESTFS_EVENT_PROGRESS>."
8863 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4292
8864 #: ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:7378
8865 #: ../src/guestfs-actions.pod:7398 ../src/guestfs-actions.pod:7484
8866 msgid "(Added in 1.0.87)"
8871 #: ../src/guestfs-actions.pod:1131
8877 #: ../src/guestfs-actions.pod:1133
8881 " guestfs_cp (guestfs_h *g,\n"
8882 " const char *src,\n"
8883 " const char *dest);\n"
8889 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8891 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8892 "destination filename or destination directory."
8897 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8898 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8899 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:5046
8900 #: ../src/guestfs-actions.pod:5515
8901 msgid "(Added in 1.0.18)"
8906 #: ../src/guestfs-actions.pod:1145
8907 msgid "guestfs_cp_a"
8912 #: ../src/guestfs-actions.pod:1147
8916 " guestfs_cp_a (guestfs_h *g,\n"
8917 " const char *src,\n"
8918 " const char *dest);\n"
8924 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8926 "This copies a file or directory from C<src> to C<dest> recursively using the "
8932 #: ../src/guestfs-actions.pod:1159
8938 #: ../src/guestfs-actions.pod:1161
8942 " guestfs_dd (guestfs_h *g,\n"
8943 " const char *src,\n"
8944 " const char *dest);\n"
8950 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8952 "This command copies from one source device or file C<src> to another "
8953 "destination device or file C<dest>. Normally you would use this to copy to "
8954 "or from a device or partition, for example to duplicate a filesystem."
8959 #: ../src/guestfs-actions.pod:1171
8961 "If the destination is a device, it must be as large or larger than the "
8962 "source file or device, otherwise the copy will fail. This command cannot do "
8963 "partial copies (see C<guestfs_copy_size>)."
8968 #: ../src/guestfs-actions.pod:1179
8974 #: ../src/guestfs-actions.pod:1181
8978 " guestfs_df (guestfs_h *g);\n"
8984 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8985 msgid "This command runs the C<df> command to report disk space used."
8990 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8992 "This command is mostly useful for interactive sessions. It is I<not> "
8993 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8999 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
9000 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2291
9001 #: ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2383
9002 #: ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4946
9003 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6905
9004 #: ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7537
9005 #: ../src/guestfs-actions.pod:7550
9006 msgid "(Added in 1.0.54)"
9011 #: ../src/guestfs-actions.pod:1195
9012 msgid "guestfs_df_h"
9017 #: ../src/guestfs-actions.pod:1197
9021 " guestfs_df_h (guestfs_h *g);\n"
9027 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
9029 "This command runs the C<df -h> command to report disk space used in human-"
9035 #: ../src/guestfs-actions.pod:1212
9036 msgid "guestfs_dmesg"
9041 #: ../src/guestfs-actions.pod:1214
9045 " guestfs_dmesg (guestfs_h *g);\n"
9051 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
9053 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9054 "This is sometimes useful for extended debugging of problems."
9059 #: ../src/guestfs-actions.pod:1221
9061 "Another way to get the same information is to enable verbose messages with "
9062 "C<guestfs_set_verbose> or by setting the environment variable "
9063 "C<LIBGUESTFS_DEBUG=1> before running the program."
9068 #: ../src/guestfs-actions.pod:1231
9069 msgid "guestfs_download"
9074 #: ../src/guestfs-actions.pod:1233
9078 " guestfs_download (guestfs_h *g,\n"
9079 " const char *remotefilename,\n"
9080 " const char *filename);\n"
9086 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
9087 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9089 "Download file C<remotefilename> and save it as C<filename> on the local "
9095 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:7137
9096 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4751
9097 msgid "C<filename> can also be a named pipe."
9102 #: ../src/guestfs-actions.pod:1243
9103 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9108 #: ../src/guestfs-actions.pod:1254
9109 msgid "guestfs_download_offset"
9114 #: ../src/guestfs-actions.pod:1256
9118 " guestfs_download_offset (guestfs_h *g,\n"
9119 " const char *remotefilename,\n"
9120 " const char *filename,\n"
9121 " int64_t offset,\n"
9128 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
9130 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9131 "region must be within the file or device)."
9136 #: ../src/guestfs-actions.pod:1269
9138 "Note that there is no limit on the amount of data that can be downloaded "
9139 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9140 "full amount unless an error occurs."
9145 #: ../src/guestfs-actions.pod:1274
9146 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9151 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7182
9152 msgid "(Added in 1.5.17)"
9157 #: ../src/guestfs-actions.pod:1285
9158 msgid "guestfs_drop_caches"
9163 #: ../src/guestfs-actions.pod:1287
9167 " guestfs_drop_caches (guestfs_h *g,\n"
9168 " int whattodrop);\n"
9174 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
9176 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9177 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9178 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9183 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
9184 msgid "Setting C<whattodrop> to 3 should drop everything."
9189 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
9191 "This automatically calls L<sync(2)> before the operation, so that the "
9192 "maximum guest memory is freed."
9197 #: ../src/guestfs-actions.pod:1305
9203 #: ../src/guestfs-actions.pod:1307
9207 " guestfs_du (guestfs_h *g,\n"
9208 " const char *path);\n"
9214 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
9216 "This command runs the C<du -s> command to estimate file space usage for "
9222 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
9224 "C<path> can be a file or a directory. If C<path> is a directory then the "
9225 "estimate includes the contents of the directory and all subdirectories "
9231 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
9233 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9238 #: ../src/guestfs-actions.pod:1330
9239 msgid "guestfs_e2fsck_f"
9244 #: ../src/guestfs-actions.pod:1332
9248 " guestfs_e2fsck_f (guestfs_h *g,\n"
9249 " const char *device);\n"
9254 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
9256 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9257 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9263 #: ../src/guestfs-actions.pod:1340
9265 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9266 "Normally you should use C<guestfs_fsck>."
9271 #: ../src/guestfs-actions.pod:1345
9272 msgid "(Added in 1.0.29)"
9277 #: ../src/guestfs-actions.pod:1347
9278 msgid "guestfs_echo_daemon"
9283 #: ../src/guestfs-actions.pod:1349
9287 " guestfs_echo_daemon (guestfs_h *g,\n"
9288 " char *const *words);\n"
9294 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
9296 "This command concatenates the list of C<words> passed with single spaces "
9297 "between them and returns the resulting string."
9302 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
9303 msgid "You can use this command to test the connection through to the daemon."
9308 #: ../src/guestfs-actions.pod:1358
9309 msgid "See also C<guestfs_ping_daemon>."
9314 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2099
9315 #: ../src/guestfs-actions.pod:6353
9316 msgid "(Added in 1.0.69)"
9321 #: ../src/guestfs-actions.pod:1365
9322 msgid "guestfs_egrep"
9327 #: ../src/guestfs-actions.pod:1367
9331 " guestfs_egrep (guestfs_h *g,\n"
9332 " const char *regex,\n"
9333 " const char *path);\n"
9339 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
9341 "This calls the external C<egrep> program and returns the matching lines."
9346 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
9347 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
9348 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2229
9349 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2404
9350 #: ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2432
9351 #: ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2500
9352 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:3782
9353 #: ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:3809
9354 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:4824
9355 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5898
9356 #: ../src/guestfs-actions.pod:6749 ../src/guestfs-actions.pod:6761
9357 #: ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6787
9358 #: ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:6822
9359 #: ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:6848
9360 #: ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7639
9361 #: ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744
9362 #: ../src/guestfs-actions.pod:7790 ../src/guestfs-actions.pod:7809
9363 msgid "(Added in 1.0.66)"
9368 #: ../src/guestfs-actions.pod:1384
9369 msgid "guestfs_egrepi"
9374 #: ../src/guestfs-actions.pod:1386
9378 " guestfs_egrepi (guestfs_h *g,\n"
9379 " const char *regex,\n"
9380 " const char *path);\n"
9386 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
9388 "This calls the external C<egrep -i> program and returns the matching lines."
9393 #: ../src/guestfs-actions.pod:1403
9394 msgid "guestfs_equal"
9399 #: ../src/guestfs-actions.pod:1405
9403 " guestfs_equal (guestfs_h *g,\n"
9404 " const char *file1,\n"
9405 " const char *file2);\n"
9411 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
9413 "This compares the two files C<file1> and C<file2> and returns true if their "
9414 "content is exactly equal, or false otherwise."
9419 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
9420 msgid "The external L<cmp(1)> program is used for the comparison."
9425 #: ../src/guestfs-actions.pod:1419
9426 msgid "guestfs_exists"
9431 #: ../src/guestfs-actions.pod:1421
9435 " guestfs_exists (guestfs_h *g,\n"
9436 " const char *path);\n"
9442 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
9444 "This returns C<true> if and only if there is a file, directory (or anything) "
9445 "with the given C<path> name."
9450 #: ../src/guestfs-actions.pod:1428
9451 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9456 #: ../src/guestfs-actions.pod:1434
9457 msgid "guestfs_fallocate"
9462 #: ../src/guestfs-actions.pod:1436
9466 " guestfs_fallocate (guestfs_h *g,\n"
9467 " const char *path,\n"
9474 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
9475 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9477 "This command preallocates a file (containing zero bytes) named C<path> of "
9478 "size C<len> bytes. If the file exists already, it is overwritten."
9483 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
9485 "Do not confuse this with the guestfish-specific C<alloc> command which "
9486 "allocates a file in the host and attaches it as a device."
9491 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
9493 "This function is deprecated. In new code, use the C<fallocate64> call "
9499 #: ../src/guestfs-actions.pod:1460
9500 msgid "guestfs_fallocate64"
9505 #: ../src/guestfs-actions.pod:1462
9509 " guestfs_fallocate64 (guestfs_h *g,\n"
9510 " const char *path,\n"
9517 #: ../src/guestfs-actions.pod:1471
9519 "Note that this call allocates disk blocks for the file. To create a sparse "
9520 "file use C<guestfs_truncate_size> instead."
9525 #: ../src/guestfs-actions.pod:1474
9527 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9528 "oversight it only allowed 30 bit lengths to be specified, effectively "
9529 "limiting the maximum size of files created through that call to 1GB."
9534 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
9536 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9537 "commands which create a file in the host and attach it as a device."
9542 #: ../src/guestfs-actions.pod:1485
9543 msgid "(Added in 1.3.17)"
9548 #: ../src/guestfs-actions.pod:1487
9549 msgid "guestfs_fgrep"
9554 #: ../src/guestfs-actions.pod:1489
9558 " guestfs_fgrep (guestfs_h *g,\n"
9559 " const char *pattern,\n"
9560 " const char *path);\n"
9566 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
9568 "This calls the external C<fgrep> program and returns the matching lines."
9573 #: ../src/guestfs-actions.pod:1506
9574 msgid "guestfs_fgrepi"
9579 #: ../src/guestfs-actions.pod:1508
9583 " guestfs_fgrepi (guestfs_h *g,\n"
9584 " const char *pattern,\n"
9585 " const char *path);\n"
9591 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
9593 "This calls the external C<fgrep -i> program and returns the matching lines."
9598 #: ../src/guestfs-actions.pod:1525
9599 msgid "guestfs_file"
9604 #: ../src/guestfs-actions.pod:1527
9608 " guestfs_file (guestfs_h *g,\n"
9609 " const char *path);\n"
9615 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
9617 "This call uses the standard L<file(1)> command to determine the type or "
9618 "contents of the file."
9623 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
9625 "This call will also transparently look inside various types of compressed "
9630 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
9632 "The exact command which runs is C<file -zb path>. Note in particular that "
9633 "the filename is not prepended to the output (the I<-b> option)."
9637 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
9639 "The output depends on the output of the underlying L<file(1)> command and it "
9640 "can change in future in ways beyond our control. In other words, the output "
9641 "is not guaranteed by the ABI."
9645 #: ../src/guestfs-actions.pod:1545
9647 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9648 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
9653 #: ../src/guestfs-actions.pod:1553
9654 msgid "guestfs_file_architecture"
9659 #: ../src/guestfs-actions.pod:1555
9663 " guestfs_file_architecture (guestfs_h *g,\n"
9664 " const char *filename);\n"
9670 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
9672 "This detects the architecture of the binary C<filename>, and returns it if "
9678 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
9679 msgid "Currently defined architectures are:"
9684 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
9690 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
9692 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9693 "irrespective of the precise processor requirements of the binary."
9698 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
9704 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
9705 msgid "64 bit x86-64."
9710 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
9716 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
9717 msgid "32 bit SPARC."
9722 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
9728 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
9729 msgid "64 bit SPARC V9 and above."
9734 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
9740 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
9741 msgid "Intel Itanium."
9746 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
9752 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
9753 msgid "32 bit Power PC."
9758 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
9764 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
9765 msgid "64 bit Power PC."
9770 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
9771 msgid "Libguestfs may return other architecture strings in future."
9776 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
9777 msgid "The function works on at least the following types of files:"
9782 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
9783 msgid "many types of Un*x and Linux binary"
9788 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
9789 msgid "many types of Un*x and Linux shared library"
9794 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
9795 msgid "Windows Win32 and Win64 binaries"
9800 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
9801 msgid "Windows Win32 and Win64 DLLs"
9806 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
9807 msgid "Win32 binaries and DLLs return C<i386>."
9812 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
9813 msgid "Win64 binaries and DLLs return C<x86_64>."
9818 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
9819 msgid "Linux kernel modules"
9824 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
9825 msgid "Linux new-style initrd images"
9830 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
9831 msgid "some non-x86 Linux vmlinuz kernels"
9836 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
9837 msgid "What it can't do currently:"
9842 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
9843 msgid "static libraries (libfoo.a)"
9848 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
9849 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9854 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
9855 msgid "x86 Linux vmlinuz kernels"
9860 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
9862 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9863 "compressed code, and are horribly hard to unpack. If you want to find the "
9864 "architecture of a kernel, use the architecture of the associated initrd or "
9865 "kernel module(s) instead."
9870 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
9871 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2533
9872 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2689
9873 #: ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2894
9874 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:3009
9875 #: ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3339
9876 #: ../src/guestfs-actions.pod:3471
9877 msgid "(Added in 1.5.3)"
9882 #: ../src/guestfs-actions.pod:1665
9883 msgid "guestfs_filesize"
9888 #: ../src/guestfs-actions.pod:1667
9892 " guestfs_filesize (guestfs_h *g,\n"
9893 " const char *file);\n"
9899 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9900 msgid "This command returns the size of C<file> in bytes."
9905 #: ../src/guestfs-actions.pod:1673
9907 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9908 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9909 "devices, use C<guestfs_blockdev_getsize64>."
9914 #: ../src/guestfs-actions.pod:1679
9915 msgid "(Added in 1.0.82)"
9920 #: ../src/guestfs-actions.pod:1681
9921 msgid "guestfs_fill"
9926 #: ../src/guestfs-actions.pod:1683
9930 " guestfs_fill (guestfs_h *g,\n"
9933 " const char *path);\n"
9939 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9941 "This command creates a new file called C<path>. The initial content of the "
9942 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9948 #: ../src/guestfs-actions.pod:1693
9950 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9951 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9952 "bytes use C<guestfs_fill_pattern>."
9957 #: ../src/guestfs-actions.pod:1705
9958 msgid "(Added in 1.0.79)"
9963 #: ../src/guestfs-actions.pod:1707
9964 msgid "guestfs_fill_pattern"
9969 #: ../src/guestfs-actions.pod:1709
9973 " guestfs_fill_pattern (guestfs_h *g,\n"
9974 " const char *pattern,\n"
9976 " const char *path);\n"
9982 #: ../src/guestfs-actions.pod:1715
9984 "This function is like C<guestfs_fill> except that it creates a new file of "
9985 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9986 "pattern is truncated if necessary to ensure the length of the file is "
9987 "exactly C<len> bytes."
9992 #: ../src/guestfs-actions.pod:1727
9993 msgid "(Added in 1.3.12)"
9998 #: ../src/guestfs-actions.pod:1729
9999 msgid "guestfs_find"
10004 #: ../src/guestfs-actions.pod:1731
10008 " guestfs_find (guestfs_h *g,\n"
10009 " const char *directory);\n"
10015 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
10017 "This command lists out all files and directories, recursively, starting at "
10018 "C<directory>. It is essentially equivalent to running the shell command "
10019 "C<find directory -print> but some post-processing happens on the output, "
10025 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
10027 "This returns a list of strings I<without any prefix>. Thus if the directory "
10033 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
10044 #: ../src/guestfs-actions.pod:1747
10046 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10051 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
10063 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
10064 msgid "If C<directory> is not a directory, then this command returns an error."
10069 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
10070 msgid "The returned list is sorted."
10075 #: ../src/guestfs-actions.pod:1760
10076 msgid "See also C<guestfs_find0>."
10081 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4229
10082 #: ../src/guestfs-actions.pod:5933
10083 msgid "(Added in 1.0.27)"
10088 #: ../src/guestfs-actions.pod:1771
10089 msgid "guestfs_find0"
10094 #: ../src/guestfs-actions.pod:1773
10098 " guestfs_find0 (guestfs_h *g,\n"
10099 " const char *directory,\n"
10100 " const char *files);\n"
10106 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
10108 "This command lists out all files and directories, recursively, starting at "
10109 "C<directory>, placing the resulting list in the external file called "
10115 #: ../src/guestfs-actions.pod:1782
10117 "This command works the same way as C<guestfs_find> with the following "
10123 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
10124 msgid "The resulting list is written to an external file."
10129 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
10131 "Items (filenames) in the result are separated by C<\\0> characters. See "
10132 "L<find(1)> option I<-print0>."
10137 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
10138 msgid "This command is not limited in the number of names that it can return."
10143 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
10144 msgid "The result list is not sorted."
10149 #: ../src/guestfs-actions.pod:1809
10150 msgid "(Added in 1.0.74)"
10155 #: ../src/guestfs-actions.pod:1811
10156 msgid "guestfs_findfs_label"
10161 #: ../src/guestfs-actions.pod:1813
10165 " guestfs_findfs_label (guestfs_h *g,\n"
10166 " const char *label);\n"
10172 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
10174 "This command searches the filesystems and returns the one which has the "
10175 "given label. An error is returned if no such filesystem can be found."
10180 #: ../src/guestfs-actions.pod:1821
10181 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10186 #: ../src/guestfs-actions.pod:1828
10187 msgid "guestfs_findfs_uuid"
10192 #: ../src/guestfs-actions.pod:1830
10196 " guestfs_findfs_uuid (guestfs_h *g,\n"
10197 " const char *uuid);\n"
10203 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
10205 "This command searches the filesystems and returns the one which has the "
10206 "given UUID. An error is returned if no such filesystem can be found."
10211 #: ../src/guestfs-actions.pod:1838
10212 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10217 #: ../src/guestfs-actions.pod:1845
10218 msgid "guestfs_fsck"
10223 #: ../src/guestfs-actions.pod:1847
10227 " guestfs_fsck (guestfs_h *g,\n"
10228 " const char *fstype,\n"
10229 " const char *device);\n"
10235 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
10237 "This runs the filesystem checker (fsck) on C<device> which should have "
10238 "filesystem type C<fstype>."
10243 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
10245 "The returned integer is the status. See L<fsck(8)> for the list of status "
10246 "codes from C<fsck>."
10251 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
10252 msgid "Multiple status codes can be summed together."
10257 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
10259 "A non-zero return code can mean \"success\", for example if errors have been "
10260 "corrected on the filesystem."
10265 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
10266 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10271 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
10273 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10278 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7663
10279 msgid "(Added in 1.0.16)"
10284 #: ../src/guestfs-actions.pod:1884
10285 msgid "guestfs_get_append"
10290 #: ../src/guestfs-actions.pod:1886
10294 " guestfs_get_append (guestfs_h *g);\n"
10300 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
10302 "Return the additional kernel options which are added to the guest kernel "
10308 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
10309 msgid "If C<NULL> then no options are added."
10314 #: ../src/guestfs-actions.pod:1894
10316 "This function returns a string which may be NULL. There is no way to return "
10317 "an error from this function. The string is owned by the guest handle and "
10318 "must I<not> be freed."
10323 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5611
10324 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6516
10325 #: ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6551
10326 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:7329
10327 #: ../src/guestfs-actions.pod:7344 ../src/guestfs-actions.pod:7706
10328 msgid "(Added in 1.0.26)"
10332 #: ../src/guestfs-actions.pod:1900
10333 msgid "guestfs_get_attach_method"
10337 #: ../src/guestfs-actions.pod:1902
10341 " guestfs_get_attach_method (guestfs_h *g);\n"
10346 #: ../src/guestfs-actions.pod:1905
10347 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10351 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:6123
10352 msgid "(Added in 1.9.8)"
10357 #: ../src/guestfs-actions.pod:1912
10358 msgid "guestfs_get_autosync"
10363 #: ../src/guestfs-actions.pod:1914
10367 " guestfs_get_autosync (guestfs_h *g);\n"
10373 #: ../src/guestfs-actions.pod:1917 ../fish/guestfish-actions.pod:1303
10374 msgid "Get the autosync flag."
10379 #: ../src/guestfs-actions.pod:1923
10380 msgid "guestfs_get_direct"
10385 #: ../src/guestfs-actions.pod:1925
10389 " guestfs_get_direct (guestfs_h *g);\n"
10395 #: ../src/guestfs-actions.pod:1928 ../fish/guestfish-actions.pod:1309
10396 msgid "Return the direct appliance mode flag."
10401 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:6164
10402 msgid "(Added in 1.0.72)"
10407 #: ../src/guestfs-actions.pod:1934
10408 msgid "guestfs_get_e2label"
10413 #: ../src/guestfs-actions.pod:1936
10417 " guestfs_get_e2label (guestfs_h *g,\n"
10418 " const char *device);\n"
10424 #: ../src/guestfs-actions.pod:1940 ../fish/guestfish-actions.pod:1315
10426 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10431 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1318
10433 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10438 #: ../src/guestfs-actions.pod:1953 ../src/guestfs-actions.pod:1974
10439 #: ../src/guestfs-actions.pod:6182 ../src/guestfs-actions.pod:6201
10440 msgid "(Added in 1.0.15)"
10445 #: ../src/guestfs-actions.pod:1955
10446 msgid "guestfs_get_e2uuid"
10451 #: ../src/guestfs-actions.pod:1957
10455 " guestfs_get_e2uuid (guestfs_h *g,\n"
10456 " const char *device);\n"
10462 #: ../src/guestfs-actions.pod:1961 ../fish/guestfish-actions.pod:1329
10464 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10469 #: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1332
10471 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10476 #: ../src/guestfs-actions.pod:1976
10477 msgid "guestfs_get_memsize"
10482 #: ../src/guestfs-actions.pod:1978
10486 " guestfs_get_memsize (guestfs_h *g);\n"
10492 #: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1343
10494 "This gets the memory size in megabytes allocated to the qemu subprocess."
10499 #: ../src/guestfs-actions.pod:1984
10501 "If C<guestfs_set_memsize> was not called on this handle, and if "
10502 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10503 "value for memsize."
10508 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2069
10509 #: ../src/guestfs-actions.pod:6217 ../src/guestfs-actions.pod:6324
10510 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
10511 #: ../fish/guestfish-actions.pod:4126 ../fish/guestfish-actions.pod:4213
10513 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10518 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:4520
10519 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:4748
10520 #: ../src/guestfs-actions.pod:4767 ../src/guestfs-actions.pod:4779
10521 #: ../src/guestfs-actions.pod:4796 ../src/guestfs-actions.pod:4809
10522 #: ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:6222
10523 #: ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:7098
10524 msgid "(Added in 1.0.55)"
10529 #: ../src/guestfs-actions.pod:1995
10530 msgid "guestfs_get_network"
10535 #: ../src/guestfs-actions.pod:1997
10539 " guestfs_get_network (guestfs_h *g);\n"
10545 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1357
10546 msgid "This returns the enable network flag."
10551 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:6241
10552 msgid "(Added in 1.5.4)"
10557 #: ../src/guestfs-actions.pod:2006
10558 msgid "guestfs_get_path"
10563 #: ../src/guestfs-actions.pod:2008
10567 " guestfs_get_path (guestfs_h *g);\n"
10573 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1363
10574 msgid "Return the current search path."
10579 #: ../src/guestfs-actions.pod:2013 ../fish/guestfish-actions.pod:1365
10581 "This is always non-NULL. If it wasn't set already, then this will return "
10582 "the default path."
10587 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2045
10589 "This function returns a string, or NULL on error. The string is owned by "
10590 "the guest handle and must I<not> be freed."
10595 #: ../src/guestfs-actions.pod:2021
10596 msgid "guestfs_get_pid"
10601 #: ../src/guestfs-actions.pod:2023
10605 " guestfs_get_pid (guestfs_h *g);\n"
10611 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1374
10613 "Return the process ID of the qemu subprocess. If there is no qemu "
10614 "subprocess, then this will return an error."
10619 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1377
10620 msgid "This is an internal call used for debugging and testing."
10625 #: ../src/guestfs-actions.pod:2033
10626 msgid "(Added in 1.0.56)"
10631 #: ../src/guestfs-actions.pod:2035
10632 msgid "guestfs_get_qemu"
10637 #: ../src/guestfs-actions.pod:2037
10641 " guestfs_get_qemu (guestfs_h *g);\n"
10647 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1383
10648 msgid "Return the current qemu binary."
10653 #: ../src/guestfs-actions.pod:2042 ../fish/guestfish-actions.pod:1385
10655 "This is always non-NULL. If it wasn't set already, then this will return "
10656 "the default qemu binary name."
10661 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:6286
10662 msgid "(Added in 1.0.6)"
10667 #: ../src/guestfs-actions.pod:2050
10668 msgid "guestfs_get_recovery_proc"
10673 #: ../src/guestfs-actions.pod:2052
10677 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10683 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1392
10684 msgid "Return the recovery process enabled flag."
10689 #: ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:3593
10690 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4327
10691 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:5541
10692 #: ../src/guestfs-actions.pod:5884 ../src/guestfs-actions.pod:6310
10693 #: ../src/guestfs-actions.pod:7001 ../src/guestfs-actions.pod:7021
10694 #: ../src/guestfs-actions.pod:7213
10695 msgid "(Added in 1.0.77)"
10700 #: ../src/guestfs-actions.pod:2061
10701 msgid "guestfs_get_selinux"
10706 #: ../src/guestfs-actions.pod:2063
10710 " guestfs_get_selinux (guestfs_h *g);\n"
10716 #: ../src/guestfs-actions.pod:2066
10718 "This returns the current setting of the selinux flag which is passed to the "
10719 "appliance at boot time. See C<guestfs_set_selinux>."
10724 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:2137
10725 #: ../src/guestfs-actions.pod:6329 ../src/guestfs-actions.pod:6387
10726 msgid "(Added in 1.0.67)"
10731 #: ../src/guestfs-actions.pod:2076
10732 msgid "guestfs_get_state"
10737 #: ../src/guestfs-actions.pod:2078
10741 " guestfs_get_state (guestfs_h *g);\n"
10747 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1408
10749 "This returns the current state as an opaque integer. This is only useful "
10750 "for printing debug and internal error messages."
10755 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:3364
10756 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3454
10757 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:1411
10758 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
10759 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
10760 msgid "For more information on states, see L<guestfs(3)>."
10765 #: ../src/guestfs-actions.pod:2090
10766 msgid "guestfs_get_trace"
10771 #: ../src/guestfs-actions.pod:2092
10775 " guestfs_get_trace (guestfs_h *g);\n"
10781 #: ../src/guestfs-actions.pod:2095 ../fish/guestfish-actions.pod:1417
10782 msgid "Return the command trace flag."
10787 #: ../src/guestfs-actions.pod:2101
10788 msgid "guestfs_get_umask"
10793 #: ../src/guestfs-actions.pod:2103
10797 " guestfs_get_umask (guestfs_h *g);\n"
10803 #: ../src/guestfs-actions.pod:2106
10805 "Return the current umask. By default the umask is C<022> unless it has been "
10806 "set by calling C<guestfs_umask>."
10811 #: ../src/guestfs-actions.pod:2113
10812 msgid "guestfs_get_verbose"
10817 #: ../src/guestfs-actions.pod:2115
10821 " guestfs_get_verbose (guestfs_h *g);\n"
10827 #: ../src/guestfs-actions.pod:2118 ../fish/guestfish-actions.pod:1430
10828 msgid "This returns the verbose messages flag."
10833 #: ../src/guestfs-actions.pod:2124
10834 msgid "guestfs_getcon"
10839 #: ../src/guestfs-actions.pod:2126
10843 " guestfs_getcon (guestfs_h *g);\n"
10849 #: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1436
10850 msgid "This gets the SELinux security context of the daemon."
10855 #: ../src/guestfs-actions.pod:2131
10857 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10862 #: ../src/guestfs-actions.pod:2139
10863 msgid "guestfs_getxattr"
10868 #: ../src/guestfs-actions.pod:2141
10872 " guestfs_getxattr (guestfs_h *g,\n"
10873 " const char *path,\n"
10874 " const char *name,\n"
10875 " size_t *size_r);\n"
10881 #: ../src/guestfs-actions.pod:2147
10883 "Get a single extended attribute from file C<path> named C<name>. This call "
10884 "follows symlinks. If you want to lookup an extended attribute for the "
10885 "symlink itself, use C<guestfs_lgetxattr>."
10890 #: ../src/guestfs-actions.pod:2151 ../src/guestfs-actions.pod:3607
10892 "Normally it is better to get all extended attributes from a file in one go "
10893 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10894 "implementations are buggy and do not provide a way to list out attributes. "
10895 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10896 "extended attributes you want in advance and call this function."
10901 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3614
10902 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
10904 "Extended attribute values are blobs of binary data. If there is no extended "
10905 "attribute named C<name>, this returns an error."
10910 #: ../src/guestfs-actions.pod:2161
10911 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10916 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2354
10917 #: ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3619
10918 #: ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5560
10919 #: ../src/guestfs-actions.pod:5741
10921 "This function returns a buffer, or NULL on error. The size of the returned "
10922 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10927 #: ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:3623
10928 msgid "(Added in 1.7.24)"
10933 #: ../src/guestfs-actions.pod:2169
10934 msgid "guestfs_getxattrs"
10939 #: ../src/guestfs-actions.pod:2171
10942 " struct guestfs_xattr_list *\n"
10943 " guestfs_getxattrs (guestfs_h *g,\n"
10944 " const char *path);\n"
10950 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1465
10952 "This call lists the extended attributes of the file or directory C<path>."
10957 #: ../src/guestfs-actions.pod:2178 ../fish/guestfish-actions.pod:1468
10959 "At the system call level, this is a combination of the L<listxattr(2)> and "
10960 "L<getxattr(2)> calls."
10965 #: ../src/guestfs-actions.pod:2181
10966 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10971 #: ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:3635
10972 #: ../src/guestfs-actions.pod:4323
10974 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10975 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10980 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:3639
10981 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:3874
10982 #: ../src/guestfs-actions.pod:5914 ../src/guestfs-actions.pod:6406
10983 #: ../src/guestfs-actions.pod:7771
10984 msgid "(Added in 1.0.59)"
10989 #: ../src/guestfs-actions.pod:2189
10990 msgid "guestfs_glob_expand"
10995 #: ../src/guestfs-actions.pod:2191
10999 " guestfs_glob_expand (guestfs_h *g,\n"
11000 " const char *pattern);\n"
11006 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1477
11008 "This command searches for all the pathnames matching C<pattern> according to "
11009 "the wildcard expansion rules used by the shell."
11014 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1481
11016 "If no paths match, then this returns an empty list (note: not an error)."
11021 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1484
11023 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
11024 "GLOB_BRACE>. See that manual page for more details."
11029 #: ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:6599
11030 #: ../src/guestfs-actions.pod:6616
11031 msgid "(Added in 1.0.50)"
11036 #: ../src/guestfs-actions.pod:2212
11037 msgid "guestfs_grep"
11042 #: ../src/guestfs-actions.pod:2214
11046 " guestfs_grep (guestfs_h *g,\n"
11047 " const char *regex,\n"
11048 " const char *path);\n"
11054 #: ../src/guestfs-actions.pod:2219 ../fish/guestfish-actions.pod:1492
11055 msgid "This calls the external C<grep> program and returns the matching lines."
11060 #: ../src/guestfs-actions.pod:2231
11061 msgid "guestfs_grepi"
11066 #: ../src/guestfs-actions.pod:2233
11070 " guestfs_grepi (guestfs_h *g,\n"
11071 " const char *regex,\n"
11072 " const char *path);\n"
11078 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1502
11080 "This calls the external C<grep -i> program and returns the matching lines."
11085 #: ../src/guestfs-actions.pod:2250
11086 msgid "guestfs_grub_install"
11091 #: ../src/guestfs-actions.pod:2252
11095 " guestfs_grub_install (guestfs_h *g,\n"
11096 " const char *root,\n"
11097 " const char *device);\n"
11103 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1512
11105 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11106 "the root directory being C<root>."
11111 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1515
11113 "Note: If grub-install reports the error \"No suitable drive was found in the "
11114 "generated device map.\" it may be that you need to create a C</boot/grub/"
11115 "device.map> file first that contains the mapping between grub device names "
11116 "and Linux device names. It is usually sufficient to create a file "
11122 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
11125 " (hd0) /dev/vda\n"
11131 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1524
11132 msgid "replacing C</dev/vda> with the name of the installation device."
11137 #: ../src/guestfs-actions.pod:2273
11138 msgid "(Added in 1.0.17)"
11143 #: ../src/guestfs-actions.pod:2275
11144 msgid "guestfs_head"
11149 #: ../src/guestfs-actions.pod:2277
11153 " guestfs_head (guestfs_h *g,\n"
11154 " const char *path);\n"
11160 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1530
11162 "This command returns up to the first 10 lines of a file as a list of strings."
11167 #: ../src/guestfs-actions.pod:2293
11168 msgid "guestfs_head_n"
11173 #: ../src/guestfs-actions.pod:2295
11177 " guestfs_head_n (guestfs_h *g,\n"
11179 " const char *path);\n"
11185 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1540
11187 "If the parameter C<nrlines> is a positive number, this returns the first "
11188 "C<nrlines> lines of the file C<path>."
11193 #: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1543
11195 "If the parameter C<nrlines> is a negative number, this returns lines from "
11196 "the file C<path>, excluding the last C<nrlines> lines."
11201 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6896
11202 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4591
11203 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11208 #: ../src/guestfs-actions.pod:2317
11209 msgid "guestfs_hexdump"
11214 #: ../src/guestfs-actions.pod:2319
11218 " guestfs_hexdump (guestfs_h *g,\n"
11219 " const char *path);\n"
11225 #: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1555
11227 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11228 "readable, canonical hex dump of the file."
11233 #: ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:6680
11234 #: ../src/guestfs-actions.pod:6735
11235 msgid "(Added in 1.0.22)"
11240 #: ../src/guestfs-actions.pod:2334
11241 msgid "guestfs_initrd_cat"
11246 #: ../src/guestfs-actions.pod:2336
11250 " guestfs_initrd_cat (guestfs_h *g,\n"
11251 " const char *initrdpath,\n"
11252 " const char *filename,\n"
11253 " size_t *size_r);\n"
11259 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1565
11261 "This command unpacks the file C<filename> from the initrd file called "
11262 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11268 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1569
11270 "For example, in guestfish you could use the following command to examine the "
11271 "boot script (usually called C</init>) contained in a Linux initrd or "
11277 #: ../src/guestfs-actions.pod:2350 ../fish/guestfish-actions.pod:1573
11280 " initrd-cat /boot/initrd-<version>.img init\n"
11286 #: ../src/guestfs-actions.pod:2352
11287 msgid "See also C<guestfs_initrd_list>."
11292 #: ../src/guestfs-actions.pod:2363
11293 msgid "guestfs_initrd_list"
11298 #: ../src/guestfs-actions.pod:2365
11302 " guestfs_initrd_list (guestfs_h *g,\n"
11303 " const char *path);\n"
11309 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1584
11310 msgid "This command lists out files contained in an initrd."
11315 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1586
11317 "The files are listed without any initial C</> character. The files are "
11318 "listed in the order they appear (not necessarily alphabetical). Directory "
11319 "names are listed as separate items."
11324 #: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1590
11326 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11327 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11333 #: ../src/guestfs-actions.pod:2385
11334 msgid "guestfs_inotify_add_watch"
11339 #: ../src/guestfs-actions.pod:2387
11343 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11344 " const char *path,\n"
11351 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1598
11352 msgid "Watch C<path> for the events listed in C<mask>."
11357 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1600
11359 "Note that if C<path> is a directory then events within that directory are "
11360 "watched, but this does I<not> happen recursively (in subdirectories)."
11365 #: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1604
11367 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11368 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11373 #: ../src/guestfs-actions.pod:2406
11374 msgid "guestfs_inotify_close"
11379 #: ../src/guestfs-actions.pod:2408
11383 " guestfs_inotify_close (guestfs_h *g);\n"
11389 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1612
11391 "This closes the inotify handle which was previously opened by inotify_init. "
11392 "It removes all watches, throws away any pending events, and deallocates all "
11398 #: ../src/guestfs-actions.pod:2419
11399 msgid "guestfs_inotify_files"
11404 #: ../src/guestfs-actions.pod:2421
11408 " guestfs_inotify_files (guestfs_h *g);\n"
11414 #: ../src/guestfs-actions.pod:2424
11416 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11417 "returns a list of pathnames of objects that were touched. The returned "
11418 "pathnames are sorted and deduplicated."
11423 #: ../src/guestfs-actions.pod:2434
11424 msgid "guestfs_inotify_init"
11429 #: ../src/guestfs-actions.pod:2436
11433 " guestfs_inotify_init (guestfs_h *g,\n"
11434 " int maxevents);\n"
11440 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1628
11442 "This command creates a new inotify handle. The inotify subsystem can be "
11443 "used to notify events which happen to objects in the guest filesystem."
11448 #: ../src/guestfs-actions.pod:2444
11450 "C<maxevents> is the maximum number of events which will be queued up between "
11451 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11452 "passed as C<0>, then the kernel (or previously set) default is used. For "
11453 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11454 "throws away events, but records the fact that it threw them away by setting "
11455 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11456 "C<guestfs_inotify_read>)."
11461 #: ../src/guestfs-actions.pod:2454
11463 "Before any events are generated, you have to add some watches to the "
11464 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11465 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11470 #: ../src/guestfs-actions.pod:2460
11472 "Queued up events should be read periodically by calling "
11473 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11474 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11475 "often enough then you risk the internal queue overflowing."
11480 #: ../src/guestfs-actions.pod:2467
11482 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11483 "This also removes any watches automatically."
11488 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1659
11490 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11491 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11492 "that there is one global inotify handle per libguestfs instance."
11497 #: ../src/guestfs-actions.pod:2480
11498 msgid "guestfs_inotify_read"
11503 #: ../src/guestfs-actions.pod:2482
11506 " struct guestfs_inotify_event_list *\n"
11507 " guestfs_inotify_read (guestfs_h *g);\n"
11513 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1668
11515 "Return the complete queue of events that have happened since the previous "
11521 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1671
11522 msgid "If no events have happened, this returns an empty list."
11527 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1673
11529 "I<Note>: In order to make sure that all events have been read, you must call "
11530 "this function repeatedly until it returns an empty list. The reason is that "
11531 "the call will read events up to the maximum appliance-to-host message size "
11532 "and leave remaining events in the queue."
11537 #: ../src/guestfs-actions.pod:2496
11539 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11540 "there was an error. I<The caller must call "
11541 "C<guestfs_free_inotify_event_list> after use>."
11546 #: ../src/guestfs-actions.pod:2502
11547 msgid "guestfs_inotify_rm_watch"
11552 #: ../src/guestfs-actions.pod:2504
11556 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11563 #: ../src/guestfs-actions.pod:2508
11565 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11570 #: ../src/guestfs-actions.pod:2515
11571 msgid "guestfs_inspect_get_arch"
11576 #: ../src/guestfs-actions.pod:2517
11580 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11581 " const char *root);\n"
11587 #: ../src/guestfs-actions.pod:2521
11589 "This returns the architecture of the inspected operating system. The "
11590 "possible return values are listed under C<guestfs_file_architecture>."
11595 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1694
11597 "If the architecture could not be determined, then the string C<unknown> is "
11603 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618
11604 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2741
11605 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2955
11606 #: ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3004
11607 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3097
11608 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3137
11609 #: ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3170
11610 #: ../src/guestfs-actions.pod:3188 ../src/guestfs-actions.pod:3290
11611 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:1697
11612 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
11613 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
11614 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
11615 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
11616 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
11617 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
11618 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
11619 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
11620 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11625 #: ../src/guestfs-actions.pod:2535
11626 msgid "guestfs_inspect_get_distro"
11631 #: ../src/guestfs-actions.pod:2537
11635 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11636 " const char *root);\n"
11642 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1703
11644 "This returns the distro (distribution) of the inspected operating system."
11649 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1706
11650 msgid "Currently defined distros are:"
11655 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1710
11656 msgid "\"archlinux\""
11661 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1712
11662 msgid "Arch Linux."
11666 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1714
11671 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1716
11677 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1718
11683 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1720
11689 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1722
11695 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1724
11701 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1726
11707 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1728
11713 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1730
11714 msgid "\"linuxmint\""
11719 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1732
11720 msgid "Linux Mint."
11725 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1734
11726 msgid "\"mandriva\""
11731 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1736
11737 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1738
11743 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1740
11749 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1742
11755 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1744
11761 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1746
11762 msgid "\"redhat-based\""
11767 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1748
11768 msgid "Some Red Hat-derived distro."
11773 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1750
11778 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1752
11779 msgid "Red Hat Enterprise Linux."
11783 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1754
11784 msgid "\"scientificlinux\""
11788 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1756
11789 msgid "Scientific Linux."
11793 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1758
11794 msgid "\"slackware\""
11798 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1760
11804 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1762
11810 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1764
11816 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2713
11817 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:1766
11818 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
11819 msgid "\"unknown\""
11824 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1768
11825 msgid "The distro could not be determined."
11830 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3080
11831 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
11832 msgid "\"windows\""
11837 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1772
11839 "Windows does not have distributions. This string is returned if the OS type "
11845 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2719
11846 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:1777
11847 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
11849 "Future versions of libguestfs may return other strings here. The caller "
11850 "should be prepared to handle any string."
11854 #: ../src/guestfs-actions.pod:2625
11855 msgid "guestfs_inspect_get_drive_mappings"
11859 #: ../src/guestfs-actions.pod:2627
11863 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11864 " const char *root);\n"
11869 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1786
11871 "This call is useful for Windows which uses a primitive system of assigning "
11872 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11873 "Windows Registry to find out how disks/partitions are mapped to drive "
11874 "letters, and returns a hash table as in the example below:"
11878 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1792
11881 " C => /dev/vda2\n"
11882 " E => /dev/vdb1\n"
11883 " F => /dev/vdc1\n"
11888 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1796
11890 "Note that keys are drive letters. For Windows, the key is case insensitive "
11891 "and just contains the drive letter, without the customary colon separator "
11896 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1800
11898 "In future we may support other operating systems that also used drive "
11899 "letters, but the keys for those might not be case insensitive and might be "
11900 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11905 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1805
11907 "For Windows guests, currently only hard drive mappings are returned. "
11908 "Removable disks (eg. DVD-ROMs) are ignored."
11912 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
11914 "For guests that do not use drive mappings, or if the drive mappings could "
11915 "not be determined, this returns an empty hash table."
11919 #: ../src/guestfs-actions.pod:2656
11921 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11922 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11927 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2928
11928 #: ../src/guestfs-actions.pod:3726 ../src/guestfs-actions.pod:5008
11929 #: ../src/guestfs-actions.pod:7037
11931 "This function returns a NULL-terminated array of strings, or NULL if there "
11932 "was an error. The array of strings will always have length C<2n+1>, where "
11933 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11934 "caller must free the strings and the array after use>."
11938 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:3122
11939 msgid "(Added in 1.9.17)"
11944 #: ../src/guestfs-actions.pod:2668
11945 msgid "guestfs_inspect_get_filesystems"
11950 #: ../src/guestfs-actions.pod:2670
11954 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11955 " const char *root);\n"
11961 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1819
11963 "This returns a list of all the filesystems that we think are associated with "
11964 "this operating system. This includes the root filesystem, other ordinary "
11965 "filesystems, and non-mounted devices like swap partitions."
11970 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1824
11972 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11973 "to be shared between operating systems."
11978 #: ../src/guestfs-actions.pod:2682
11980 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11981 "C<guestfs_inspect_get_mountpoints>."
11985 #: ../src/guestfs-actions.pod:2691
11986 msgid "guestfs_inspect_get_format"
11990 #: ../src/guestfs-actions.pod:2693
11994 " guestfs_inspect_get_format (guestfs_h *g,\n"
11995 " const char *root);\n"
12000 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1834
12002 "This returns the format of the inspected operating system. You can use it "
12003 "to detect install images, live CDs and similar."
12007 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1837
12008 msgid "Currently defined formats are:"
12012 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1841
12013 msgid "\"installed\""
12017 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1843
12018 msgid "This is an installed operating system."
12022 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1845
12023 msgid "\"installer\""
12027 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1847
12029 "The disk image being inspected is not an installed operating system, but a "
12030 "I<bootable> install disk, live CD, or similar."
12034 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1852
12035 msgid "The format of this disk image is not known."
12039 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3158
12040 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3192
12041 #: ../src/guestfs-actions.pod:5952
12042 msgid "(Added in 1.9.4)"
12047 #: ../src/guestfs-actions.pod:2729
12048 msgid "guestfs_inspect_get_hostname"
12053 #: ../src/guestfs-actions.pod:2731
12057 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12058 " const char *root);\n"
12064 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1865
12066 "This function returns the hostname of the operating system as found by "
12067 "inspection of the guest's configuration files."
12072 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1868
12074 "If the hostname could not be determined, then the string C<unknown> is "
12080 #: ../src/guestfs-actions.pod:2746
12081 msgid "(Added in 1.7.9)"
12085 #: ../src/guestfs-actions.pod:2748
12086 msgid "guestfs_inspect_get_icon"
12090 #: ../src/guestfs-actions.pod:2750
12094 " guestfs_inspect_get_icon (guestfs_h *g,\n"
12095 " const char *root,\n"
12096 " size_t *size_r,\n"
12102 #: ../src/guestfs-actions.pod:2761
12105 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
12106 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
12111 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1877
12113 "This function returns an icon corresponding to the inspected operating "
12114 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
12115 "to PNG if necessary)."
12119 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1881
12121 "If it was not possible to get an icon this function returns a zero-length "
12122 "(non-NULL) buffer. I<Callers must check for this case>."
12126 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1884
12128 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
12129 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
12130 "this file will be returned. You can disable favicons by passing the "
12131 "optional C<favicon> boolean as false (default is true)."
12135 #: ../src/guestfs-actions.pod:2777 ../fish/guestfish-actions.pod:1890
12137 "If finding the favicon fails, then we look in other places in the guest for "
12142 #: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1893
12144 "If the optional C<highquality> boolean is true then only high quality icons "
12145 "are returned, which means only icons of high resolution with an alpha "
12146 "channel. The default (false) is to return any icon we can, even if it is of "
12147 "substandard quality."
12151 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1904
12153 "Unlike most other inspection API calls, the guest's disks must be mounted up "
12154 "before you call this, since it needs to read information from the guest "
12155 "filesystem during the call."
12159 #: ../src/guestfs-actions.pod:2797 ../fish/guestfish-actions.pod:1910
12161 "B<Security:> The icon data comes from the untrusted guest, and should be "
12162 "treated with caution. PNG files have been known to contain exploits. "
12163 "Ensure that libpng (or other relevant libraries) are fully up to date before "
12164 "trying to process or display the icon."
12168 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
12170 "The PNG image returned can be any size. It might not be square. Libguestfs "
12171 "tries to return the largest, highest quality icon available. The "
12172 "application must scale the icon to the required size."
12176 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
12178 "Extracting icons from Windows guests requires the external C<wrestool> "
12179 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
12180 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
12181 "installed separately."
12185 #: ../src/guestfs-actions.pod:2819 ../fish/guestfish-actions.pod:1932
12187 "Operating system icons are usually trademarks. Seek legal advice before "
12188 "using trademarks in applications."
12192 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3653
12193 #: ../src/guestfs-actions.pod:4907
12194 msgid "(Added in 1.11.12)"
12198 #: ../src/guestfs-actions.pod:2830
12199 msgid "guestfs_inspect_get_icon_va"
12203 #: ../src/guestfs-actions.pod:2832
12207 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
12208 " const char *root,\n"
12209 " size_t *size_r,\n"
12210 " va_list args);\n"
12215 #: ../src/guestfs-actions.pod:2838
12216 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
12220 #: ../src/guestfs-actions.pod:2842
12221 msgid "guestfs_inspect_get_icon_argv"
12225 #: ../src/guestfs-actions.pod:2844
12229 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
12230 " const char *root,\n"
12231 " size_t *size_r,\n"
12232 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
12237 #: ../src/guestfs-actions.pod:2850
12238 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
12243 #: ../src/guestfs-actions.pod:2854
12244 msgid "guestfs_inspect_get_major_version"
12249 #: ../src/guestfs-actions.pod:2856
12253 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12254 " const char *root);\n"
12260 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1943
12262 "This returns the major version number of the inspected operating system."
12267 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1946
12269 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12270 "popular public names used by the operating system. Notably the operating "
12271 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12272 "1). You can find out the real versions corresponding to releases of Windows "
12273 "by consulting Wikipedia or MSDN."
12278 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2887
12279 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
12280 msgid "If the version could not be determined, then C<0> is returned."
12285 #: ../src/guestfs-actions.pod:2878
12286 msgid "guestfs_inspect_get_minor_version"
12291 #: ../src/guestfs-actions.pod:2880
12295 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12296 " const char *root);\n"
12302 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1961
12304 "This returns the minor version number of the inspected operating system."
12309 #: ../src/guestfs-actions.pod:2889
12311 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12312 "C<guestfs_inspect_get_major_version>."
12317 #: ../src/guestfs-actions.pod:2896
12318 msgid "guestfs_inspect_get_mountpoints"
12323 #: ../src/guestfs-actions.pod:2898
12327 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12328 " const char *root);\n"
12333 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1973
12335 "This returns a hash of where we think the filesystems associated with this "
12336 "operating system should be mounted. Callers should note that this is at "
12337 "best an educated guess made by reading configuration files such as C</etc/"
12338 "fstab>. I<In particular note> that this may return filesystems which are "
12339 "non-existent or not mountable and callers should be prepared to handle or "
12340 "ignore failures if they try to mount them."
12345 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1982
12347 "Each element in the returned hashtable has a key which is the path of the "
12348 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12349 "mounted there (eg. C</dev/sda1>)."
12354 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1987
12356 "Non-mounted devices such as swap devices are I<not> returned in this list."
12360 #: ../src/guestfs-actions.pod:2919
12362 "For operating systems like Windows which still use drive letters, this call "
12363 "will only return an entry for the first drive \"mounted on\" C</>. For "
12364 "information about the mapping of drive letters to partitions, see "
12365 "C<guestfs_inspect_get_drive_mappings>."
12370 #: ../src/guestfs-actions.pod:2925
12372 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12373 "C<guestfs_inspect_get_filesystems>."
12378 #: ../src/guestfs-actions.pod:2936
12379 msgid "guestfs_inspect_get_package_format"
12384 #: ../src/guestfs-actions.pod:2938
12388 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12389 " const char *root);\n"
12395 #: ../src/guestfs-actions.pod:2942
12397 "This function and C<guestfs_inspect_get_package_management> return the "
12398 "package format and package management tool used by the inspected operating "
12399 "system. For example for Fedora these functions would return C<rpm> (package "
12400 "format) and C<yum> (package management)."
12405 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2009
12407 "This returns the string C<unknown> if we could not determine the package "
12408 "format I<or> if the operating system does not have a real packaging system "
12414 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2013
12416 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12417 "Future versions of libguestfs may return other strings."
12422 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:2988
12423 msgid "(Added in 1.7.5)"
12428 #: ../src/guestfs-actions.pod:2962
12429 msgid "guestfs_inspect_get_package_management"
12434 #: ../src/guestfs-actions.pod:2964
12438 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12439 " const char *root);\n"
12445 #: ../src/guestfs-actions.pod:2968
12447 "C<guestfs_inspect_get_package_format> and this function return the package "
12448 "format and package management tool used by the inspected operating system. "
12449 "For example for Fedora these functions would return C<rpm> (package format) "
12450 "and C<yum> (package management)."
12455 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2028
12457 "This returns the string C<unknown> if we could not determine the package "
12458 "management tool I<or> if the operating system does not have a real packaging "
12459 "system (eg. Windows)."
12464 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2032
12466 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12467 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12468 "libguestfs may return other strings."
12473 #: ../src/guestfs-actions.pod:2990
12474 msgid "guestfs_inspect_get_product_name"
12479 #: ../src/guestfs-actions.pod:2992
12483 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12484 " const char *root);\n"
12490 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2043
12492 "This returns the product name of the inspected operating system. The "
12493 "product name is generally some freeform string which can be displayed to the "
12494 "user, but should not be parsed by programs."
12499 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
12501 "If the product name could not be determined, then the string C<unknown> is "
12506 #: ../src/guestfs-actions.pod:3011
12507 msgid "guestfs_inspect_get_product_variant"
12511 #: ../src/guestfs-actions.pod:3013
12515 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12516 " const char *root);\n"
12521 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2057
12522 msgid "This returns the product variant of the inspected operating system."
12526 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2060
12528 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12529 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12530 "is usually a string such as C<Client> or C<Server> (other values are "
12531 "possible). This can be used to distinguish consumer and enterprise versions "
12532 "of Windows that have the same version number (for example, Windows 7 and "
12533 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12534 "the latter is C<Server>)."
12538 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2069
12540 "For enterprise Linux guests, in future we intend this to return the product "
12541 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12542 "implemented at present."
12546 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2073
12548 "If the product variant could not be determined, then the string C<unknown> "
12553 #: ../src/guestfs-actions.pod:3036
12555 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12556 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12560 #: ../src/guestfs-actions.pod:3043
12561 msgid "(Added in 1.9.13)"
12566 #: ../src/guestfs-actions.pod:3045
12567 msgid "guestfs_inspect_get_roots"
12572 #: ../src/guestfs-actions.pod:3047
12576 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12582 #: ../src/guestfs-actions.pod:3050
12584 "This function is a convenient way to get the list of root devices, as "
12585 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12586 "the whole inspection process."
12591 #: ../src/guestfs-actions.pod:3054
12593 "This returns an empty list if either no root devices were found or the "
12594 "caller has not called C<guestfs_inspect_os>."
12599 #: ../src/guestfs-actions.pod:3063
12600 msgid "(Added in 1.7.3)"
12605 #: ../src/guestfs-actions.pod:3065
12606 msgid "guestfs_inspect_get_type"
12611 #: ../src/guestfs-actions.pod:3067
12615 " guestfs_inspect_get_type (guestfs_h *g,\n"
12616 " const char *root);\n"
12622 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2097
12624 "This returns the type of the inspected operating system. Currently defined "
12630 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2102
12636 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2104
12637 msgid "Any Linux-based operating system."
12642 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2108
12643 msgid "Any Microsoft Windows operating system."
12648 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2110
12649 msgid "\"freebsd\""
12654 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2112
12660 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2116
12661 msgid "The operating system type could not be determined."
12665 #: ../src/guestfs-actions.pod:3104
12666 msgid "guestfs_inspect_get_windows_current_control_set"
12670 #: ../src/guestfs-actions.pod:3106
12674 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12675 " const char *root);\n"
12680 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2129
12682 "This returns the Windows CurrentControlSet of the inspected guest. The "
12683 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12687 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2132
12689 "This call assumes that the guest is Windows and that the Registry could be "
12690 "examined by inspection. If this is not the case then an error is returned."
12695 #: ../src/guestfs-actions.pod:3124
12696 msgid "guestfs_inspect_get_windows_systemroot"
12701 #: ../src/guestfs-actions.pod:3126
12705 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12706 " const char *root);\n"
12712 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2142
12714 "This returns the Windows systemroot of the inspected guest. The systemroot "
12715 "is a directory path such as C</WINDOWS>."
12720 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2145
12722 "This call assumes that the guest is Windows and that the systemroot could be "
12723 "determined by inspection. If this is not the case then an error is returned."
12728 #: ../src/guestfs-actions.pod:3142
12729 msgid "(Added in 1.5.25)"
12733 #: ../src/guestfs-actions.pod:3144
12734 msgid "guestfs_inspect_is_live"
12738 #: ../src/guestfs-actions.pod:3146
12742 " guestfs_inspect_is_live (guestfs_h *g,\n"
12743 " const char *root);\n"
12748 #: ../src/guestfs-actions.pod:3150
12750 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12751 "disk), then this returns true if a live image was detected on the disk."
12755 #: ../src/guestfs-actions.pod:3160
12756 msgid "guestfs_inspect_is_multipart"
12760 #: ../src/guestfs-actions.pod:3162
12764 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12765 " const char *root);\n"
12770 #: ../src/guestfs-actions.pod:3166
12772 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12773 "disk), then this returns true if the disk is part of a set."
12777 #: ../src/guestfs-actions.pod:3176
12778 msgid "guestfs_inspect_is_netinst"
12782 #: ../src/guestfs-actions.pod:3178
12786 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12787 " const char *root);\n"
12792 #: ../src/guestfs-actions.pod:3182
12794 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12795 "disk), then this returns true if the disk is a network installer, ie. not a "
12796 "self-contained install CD but one which is likely to require network access "
12797 "to complete the install."
12802 #: ../src/guestfs-actions.pod:3194
12803 msgid "guestfs_inspect_list_applications"
12808 #: ../src/guestfs-actions.pod:3196
12811 " struct guestfs_application_list *\n"
12812 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12813 " const char *root);\n"
12819 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2187
12820 msgid "Return the list of applications installed in the operating system."
12825 #: ../src/guestfs-actions.pod:3202
12827 "I<Note:> This call works differently from other parts of the inspection "
12828 "API. You have to call C<guestfs_inspect_os>, then "
12829 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12830 "this. Listing applications is a significantly more difficult operation "
12831 "which requires access to the full filesystem. Also note that unlike the "
12832 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12833 "the libguestfs handle, this call actually reads parts of the mounted "
12834 "filesystems during the call."
12839 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2199
12841 "This returns an empty list if the inspection code was not able to determine "
12842 "the list of applications."
12847 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2202
12848 msgid "The application structure contains the following fields:"
12853 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2206
12854 msgid "C<app_name>"
12859 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2208
12861 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12862 "guests, this is the package name."
12867 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2211
12868 msgid "C<app_display_name>"
12873 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2213
12875 "The display name of the application, sometimes localized to the install "
12876 "language of the guest operating system."
12881 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2216
12883 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12884 "to display something can use C<app_name> instead."
12889 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2219
12890 msgid "C<app_epoch>"
12895 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2221
12897 "For package managers which use epochs, this contains the epoch of the "
12898 "package (an integer). If unavailable, this is returned as C<0>."
12903 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2224
12904 msgid "C<app_version>"
12909 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2226
12911 "The version string of the application or package. If unavailable this is "
12912 "returned as an empty string C<\"\">."
12917 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2229
12918 msgid "C<app_release>"
12923 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2231
12925 "The release string of the application or package, for package managers that "
12926 "use this. If unavailable this is returned as an empty string C<\"\">."
12931 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2235
12932 msgid "C<app_install_path>"
12937 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2237
12939 "The installation path of the application (on operating systems such as "
12940 "Windows which use installation paths). This path is in the format used by "
12941 "the guest operating system, it is not a libguestfs path."
12946 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2242
12947 msgid "If unavailable this is returned as an empty string C<\"\">."
12952 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2244
12953 msgid "C<app_trans_path>"
12958 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2246
12960 "The install path translated into a libguestfs path. If unavailable this is "
12961 "returned as an empty string C<\"\">."
12966 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2249
12967 msgid "C<app_publisher>"
12972 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2251
12974 "The name of the publisher of the application, for package managers that use "
12975 "this. If unavailable this is returned as an empty string C<\"\">."
12980 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2255
12986 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2257
12988 "The URL (eg. upstream URL) of the application. If unavailable this is "
12989 "returned as an empty string C<\"\">."
12994 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2260
12995 msgid "C<app_source_package>"
13000 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2262
13002 "For packaging systems which support this, the name of the source package. "
13003 "If unavailable this is returned as an empty string C<\"\">."
13008 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2265
13009 msgid "C<app_summary>"
13014 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2267
13016 "A short (usually one line) description of the application or package. If "
13017 "unavailable this is returned as an empty string C<\"\">."
13022 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2270
13023 msgid "C<app_description>"
13028 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2272
13030 "A longer description of the application or package. If unavailable this is "
13031 "returned as an empty string C<\"\">."
13036 #: ../src/guestfs-actions.pod:3292
13038 "This function returns a C<struct guestfs_application_list *>, or NULL if "
13039 "there was an error. I<The caller must call C<guestfs_free_application_list> "
13045 #: ../src/guestfs-actions.pod:3296
13046 msgid "(Added in 1.7.8)"
13051 #: ../src/guestfs-actions.pod:3298
13052 msgid "guestfs_inspect_os"
13057 #: ../src/guestfs-actions.pod:3300
13061 " guestfs_inspect_os (guestfs_h *g);\n"
13067 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2283
13069 "This function uses other libguestfs functions and certain heuristics to "
13070 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
13071 "for operating systems."
13076 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2287
13077 msgid "The list returned is empty if no operating systems were found."
13082 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2289
13084 "If one operating system was found, then this returns a list with a single "
13085 "element, which is the name of the root filesystem of this operating system. "
13086 "It is also possible for this function to return a list containing more than "
13087 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
13088 "element being the root filesystem of one of the operating systems."
13093 #: ../src/guestfs-actions.pod:3316
13095 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
13096 "functions in order to query further information about each operating system, "
13097 "such as the name and version."
13102 #: ../src/guestfs-actions.pod:3321
13104 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
13105 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
13106 "the contents. This should be called with no disks currently mounted. The "
13107 "function may also use Augeas, so any existing Augeas handle will be closed."
13112 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2307
13114 "This function cannot decrypt encrypted disks. The caller must do that first "
13115 "(supplying the necessary keys) if the disk is encrypted."
13120 #: ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3664
13121 #: ../src/guestfs-actions.pod:3746
13122 msgid "See also C<guestfs_list_filesystems>."
13127 #: ../src/guestfs-actions.pod:3341
13128 msgid "guestfs_is_blockdev"
13133 #: ../src/guestfs-actions.pod:3343
13137 " guestfs_is_blockdev (guestfs_h *g,\n"
13138 " const char *path);\n"
13144 #: ../src/guestfs-actions.pod:3347 ../fish/guestfish-actions.pod:2319
13146 "This returns C<true> if and only if there is a block device with the given "
13152 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379
13153 #: ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3424
13154 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3496
13155 #: ../src/guestfs-actions.pod:3511
13156 msgid "See also C<guestfs_stat>."
13161 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3383
13162 #: ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3500
13163 #: ../src/guestfs-actions.pod:3515
13164 msgid "(Added in 1.5.10)"
13169 #: ../src/guestfs-actions.pod:3356
13170 msgid "guestfs_is_busy"
13175 #: ../src/guestfs-actions.pod:3358
13179 " guestfs_is_busy (guestfs_h *g);\n"
13185 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2328
13187 "This returns true iff this handle is busy processing a command (in the "
13193 #: ../src/guestfs-actions.pod:3370
13194 msgid "guestfs_is_chardev"
13199 #: ../src/guestfs-actions.pod:3372
13203 " guestfs_is_chardev (guestfs_h *g,\n"
13204 " const char *path);\n"
13210 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2337
13212 "This returns C<true> if and only if there is a character device with the "
13213 "given C<path> name."
13218 #: ../src/guestfs-actions.pod:3385
13219 msgid "guestfs_is_config"
13224 #: ../src/guestfs-actions.pod:3387
13228 " guestfs_is_config (guestfs_h *g);\n"
13234 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2346
13236 "This returns true iff this handle is being configured (in the C<CONFIG> "
13242 #: ../src/guestfs-actions.pod:3399
13243 msgid "guestfs_is_dir"
13248 #: ../src/guestfs-actions.pod:3401
13252 " guestfs_is_dir (guestfs_h *g,\n"
13253 " const char *path);\n"
13259 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2355
13261 "This returns C<true> if and only if there is a directory with the given "
13262 "C<path> name. Note that it returns false for other objects like files."
13267 #: ../src/guestfs-actions.pod:3415
13268 msgid "guestfs_is_fifo"
13273 #: ../src/guestfs-actions.pod:3417
13277 " guestfs_is_fifo (guestfs_h *g,\n"
13278 " const char *path);\n"
13284 #: ../src/guestfs-actions.pod:3421 ../fish/guestfish-actions.pod:2365
13286 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13287 "given C<path> name."
13292 #: ../src/guestfs-actions.pod:3430
13293 msgid "guestfs_is_file"
13298 #: ../src/guestfs-actions.pod:3432
13302 " guestfs_is_file (guestfs_h *g,\n"
13303 " const char *path);\n"
13309 #: ../src/guestfs-actions.pod:3436 ../fish/guestfish-actions.pod:2374
13311 "This returns C<true> if and only if there is a regular file with the given "
13312 "C<path> name. Note that it returns false for other objects like directories."
13317 #: ../src/guestfs-actions.pod:3446
13318 msgid "guestfs_is_launching"
13323 #: ../src/guestfs-actions.pod:3448
13327 " guestfs_is_launching (guestfs_h *g);\n"
13333 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2384
13335 "This returns true iff this handle is launching the subprocess (in the "
13336 "C<LAUNCHING> state)."
13341 #: ../src/guestfs-actions.pod:3460
13342 msgid "guestfs_is_lv"
13347 #: ../src/guestfs-actions.pod:3462
13351 " guestfs_is_lv (guestfs_h *g,\n"
13352 " const char *device);\n"
13358 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2393
13360 "This command tests whether C<device> is a logical volume, and returns true "
13361 "iff this is the case."
13366 #: ../src/guestfs-actions.pod:3473
13367 msgid "guestfs_is_ready"
13372 #: ../src/guestfs-actions.pod:3475
13376 " guestfs_is_ready (guestfs_h *g);\n"
13382 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2400
13384 "This returns true iff this handle is ready to accept commands (in the "
13390 #: ../src/guestfs-actions.pod:3487
13391 msgid "guestfs_is_socket"
13396 #: ../src/guestfs-actions.pod:3489
13400 " guestfs_is_socket (guestfs_h *g,\n"
13401 " const char *path);\n"
13407 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2409
13409 "This returns C<true> if and only if there is a Unix domain socket with the "
13410 "given C<path> name."
13415 #: ../src/guestfs-actions.pod:3502
13416 msgid "guestfs_is_symlink"
13421 #: ../src/guestfs-actions.pod:3504
13425 " guestfs_is_symlink (guestfs_h *g,\n"
13426 " const char *path);\n"
13432 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2418
13434 "This returns C<true> if and only if there is a symbolic link with the given "
13439 #: ../src/guestfs-actions.pod:3517
13440 msgid "guestfs_is_zero"
13444 #: ../src/guestfs-actions.pod:3519
13448 " guestfs_is_zero (guestfs_h *g,\n"
13449 " const char *path);\n"
13454 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2427
13456 "This returns true iff the file exists and the file is empty or it contains "
13461 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542
13462 msgid "(Added in 1.11.8)"
13466 #: ../src/guestfs-actions.pod:3530
13467 msgid "guestfs_is_zero_device"
13471 #: ../src/guestfs-actions.pod:3532
13475 " guestfs_is_zero_device (guestfs_h *g,\n"
13476 " const char *device);\n"
13481 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2434
13482 msgid "This returns true iff the device exists and contains all zero bytes."
13486 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2436
13487 msgid "Note that for large devices this can take a long time to run."
13492 #: ../src/guestfs-actions.pod:3544
13493 msgid "guestfs_kill_subprocess"
13498 #: ../src/guestfs-actions.pod:3546
13502 " guestfs_kill_subprocess (guestfs_h *g);\n"
13508 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:2442
13509 msgid "This kills the qemu subprocess. You should never need to call this."
13514 #: ../src/guestfs-actions.pod:3555
13515 msgid "guestfs_launch"
13520 #: ../src/guestfs-actions.pod:3557
13524 " guestfs_launch (guestfs_h *g);\n"
13530 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2450
13532 "Internally libguestfs is implemented by running a virtual machine using "
13538 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2453
13540 "You should call this after configuring the handle (eg. adding drives) but "
13541 "before performing any actions."
13546 #: ../src/guestfs-actions.pod:3575
13547 msgid "guestfs_lchown"
13552 #: ../src/guestfs-actions.pod:3577
13556 " guestfs_lchown (guestfs_h *g,\n"
13559 " const char *path);\n"
13565 #: ../src/guestfs-actions.pod:3583
13567 "Change the file owner to C<owner> and group to C<group>. This is like "
13568 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13569 "changed, not the target."
13574 #: ../src/guestfs-actions.pod:3595
13575 msgid "guestfs_lgetxattr"
13580 #: ../src/guestfs-actions.pod:3597
13584 " guestfs_lgetxattr (guestfs_h *g,\n"
13585 " const char *path,\n"
13586 " const char *name,\n"
13587 " size_t *size_r);\n"
13593 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2472
13595 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13596 "is a symlink, then this call returns an extended attribute from the symlink."
13601 #: ../src/guestfs-actions.pod:3617
13602 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13607 #: ../src/guestfs-actions.pod:3625
13608 msgid "guestfs_lgetxattrs"
13613 #: ../src/guestfs-actions.pod:3627
13616 " struct guestfs_xattr_list *\n"
13617 " guestfs_lgetxattrs (guestfs_h *g,\n"
13618 " const char *path);\n"
13624 #: ../src/guestfs-actions.pod:3631
13626 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13627 "then it returns the extended attributes of the link itself."
13631 #: ../src/guestfs-actions.pod:3641
13632 msgid "guestfs_list_9p"
13636 #: ../src/guestfs-actions.pod:3643
13640 " guestfs_list_9p (guestfs_h *g);\n"
13645 #: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2500
13647 "List all 9p filesystems attached to the guest. A list of mount tags is "
13653 #: ../src/guestfs-actions.pod:3655
13654 msgid "guestfs_list_devices"
13659 #: ../src/guestfs-actions.pod:3657
13663 " guestfs_list_devices (guestfs_h *g);\n"
13669 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2507
13670 msgid "List all the block devices."
13675 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2509
13676 msgid "The full block device names are returned, eg. C</dev/sda>."
13680 #: ../src/guestfs-actions.pod:3672
13681 msgid "guestfs_list_dm_devices"
13685 #: ../src/guestfs-actions.pod:3674
13689 " guestfs_list_dm_devices (guestfs_h *g);\n"
13694 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2517
13695 msgid "List all device mapper devices."
13699 #: ../src/guestfs-actions.pod:3679
13701 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
13702 "previous call to C<guestfs_luks_open>."
13706 #: ../src/guestfs-actions.pod:3682
13708 "Device mapper devices which correspond to logical volumes are I<not> "
13709 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
13714 #: ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:5146
13715 msgid "(Added in 1.11.15)"
13720 #: ../src/guestfs-actions.pod:3692
13721 msgid "guestfs_list_filesystems"
13726 #: ../src/guestfs-actions.pod:3694
13730 " guestfs_list_filesystems (guestfs_h *g);\n"
13736 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2530
13738 "This inspection command looks for filesystems on partitions, block devices "
13739 "and logical volumes, returning a list of devices containing filesystems and "
13745 #: ../src/guestfs-actions.pod:3701 ../fish/guestfish-actions.pod:2534
13747 "The return value is a hash, where the keys are the devices containing "
13748 "filesystems, and the values are the filesystem types. For example:"
13753 #: ../src/guestfs-actions.pod:3705 ../fish/guestfish-actions.pod:2538
13756 " \"/dev/sda1\" => \"ntfs\"\n"
13757 " \"/dev/sda2\" => \"ext2\"\n"
13758 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13759 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13765 #: ../src/guestfs-actions.pod:3710 ../fish/guestfish-actions.pod:2543
13767 "The value can have the special value \"unknown\", meaning the content of the "
13768 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13773 #: ../src/guestfs-actions.pod:3714
13775 "This command runs other libguestfs commands, which might include "
13776 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13777 "soon after launch and only when nothing is mounted."
13782 #: ../src/guestfs-actions.pod:3718
13784 "Not all of the filesystems returned will be mountable. In particular, swap "
13785 "partitions are returned in the list. Also this command does not check that "
13786 "each filesystem found is valid and mountable, and some filesystems might be "
13787 "mountable but require special options. Filesystems may not all belong to a "
13788 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13793 #: ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:5501
13794 msgid "(Added in 1.5.15)"
13799 #: ../src/guestfs-actions.pod:3734
13800 msgid "guestfs_list_partitions"
13805 #: ../src/guestfs-actions.pod:3736
13809 " guestfs_list_partitions (guestfs_h *g);\n"
13815 #: ../src/guestfs-actions.pod:3739 ../fish/guestfish-actions.pod:2563
13816 msgid "List all the partitions detected on all block devices."
13821 #: ../src/guestfs-actions.pod:3741 ../fish/guestfish-actions.pod:2565
13822 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13827 #: ../src/guestfs-actions.pod:3743
13829 "This does not return logical volumes. For that you will need to call "
13835 #: ../src/guestfs-actions.pod:3754
13841 #: ../src/guestfs-actions.pod:3756
13845 " guestfs_ll (guestfs_h *g,\n"
13846 " const char *directory);\n"
13852 #: ../src/guestfs-actions.pod:3760 ../fish/guestfish-actions.pod:2576
13854 "List the files in C<directory> (relative to the root directory, there is no "
13855 "cwd) in the format of 'ls -la'."
13860 #: ../src/guestfs-actions.pod:3763 ../fish/guestfish-actions.pod:2579
13862 "This command is mostly useful for interactive sessions. It is I<not> "
13863 "intended that you try to parse the output string."
13868 #: ../src/guestfs-actions.pod:3771
13874 #: ../src/guestfs-actions.pod:3773
13878 " guestfs_ln (guestfs_h *g,\n"
13879 " const char *target,\n"
13880 " const char *linkname);\n"
13886 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2586
13887 msgid "This command creates a hard link using the C<ln> command."
13892 #: ../src/guestfs-actions.pod:3784
13893 msgid "guestfs_ln_f"
13898 #: ../src/guestfs-actions.pod:3786
13902 " guestfs_ln_f (guestfs_h *g,\n"
13903 " const char *target,\n"
13904 " const char *linkname);\n"
13909 #: ../src/guestfs-actions.pod:3791 ../fish/guestfish-actions.pod:2592
13911 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13912 "option removes the link (C<linkname>) if it exists already."
13917 #: ../src/guestfs-actions.pod:3798
13918 msgid "guestfs_ln_s"
13923 #: ../src/guestfs-actions.pod:3800
13927 " guestfs_ln_s (guestfs_h *g,\n"
13928 " const char *target,\n"
13929 " const char *linkname);\n"
13935 #: ../src/guestfs-actions.pod:3805 ../fish/guestfish-actions.pod:2599
13936 msgid "This command creates a symbolic link using the C<ln -s> command."
13941 #: ../src/guestfs-actions.pod:3811
13942 msgid "guestfs_ln_sf"
13947 #: ../src/guestfs-actions.pod:3813
13951 " guestfs_ln_sf (guestfs_h *g,\n"
13952 " const char *target,\n"
13953 " const char *linkname);\n"
13958 #: ../src/guestfs-actions.pod:3818 ../fish/guestfish-actions.pod:2605
13960 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13961 "option removes the link (C<linkname>) if it exists already."
13966 #: ../src/guestfs-actions.pod:3825
13967 msgid "guestfs_lremovexattr"
13972 #: ../src/guestfs-actions.pod:3827
13976 " guestfs_lremovexattr (guestfs_h *g,\n"
13977 " const char *xattr,\n"
13978 " const char *path);\n"
13984 #: ../src/guestfs-actions.pod:3832
13986 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13987 "link, then it removes an extended attribute of the link itself."
13992 #: ../src/guestfs-actions.pod:3840
13998 #: ../src/guestfs-actions.pod:3842
14002 " guestfs_ls (guestfs_h *g,\n"
14003 " const char *directory);\n"
14009 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2620
14011 "List the files in C<directory> (relative to the root directory, there is no "
14012 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
14017 #: ../src/guestfs-actions.pod:3850
14019 "This command is mostly useful for interactive sessions. Programs should "
14020 "probably use C<guestfs_readdir> instead."
14025 #: ../src/guestfs-actions.pod:3859
14026 msgid "guestfs_lsetxattr"
14031 #: ../src/guestfs-actions.pod:3861
14035 " guestfs_lsetxattr (guestfs_h *g,\n"
14036 " const char *xattr,\n"
14037 " const char *val,\n"
14039 " const char *path);\n"
14045 #: ../src/guestfs-actions.pod:3868
14047 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
14048 "then it sets an extended attribute of the link itself."
14053 #: ../src/guestfs-actions.pod:3876
14054 msgid "guestfs_lstat"
14059 #: ../src/guestfs-actions.pod:3878
14062 " struct guestfs_stat *\n"
14063 " guestfs_lstat (guestfs_h *g,\n"
14064 " const char *path);\n"
14070 #: ../src/guestfs-actions.pod:3882 ../src/guestfs-actions.pod:6636
14071 #: ../fish/guestfish-actions.pod:2639 ../fish/guestfish-actions.pod:4426
14072 msgid "Returns file information for the given C<path>."
14077 #: ../src/guestfs-actions.pod:3884
14079 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
14080 "link, then the link is stat-ed, not the file it refers to."
14085 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2645
14086 msgid "This is the same as the C<lstat(2)> system call."
14091 #: ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:6640
14093 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
14094 "error. I<The caller must call C<guestfs_free_stat> after use>."
14099 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:6644
14100 #: ../src/guestfs-actions.pod:6662 ../src/guestfs-actions.pod:7043
14101 msgid "(Added in 0.9.2)"
14106 #: ../src/guestfs-actions.pod:3896
14107 msgid "guestfs_lstatlist"
14112 #: ../src/guestfs-actions.pod:3898
14115 " struct guestfs_stat_list *\n"
14116 " guestfs_lstatlist (guestfs_h *g,\n"
14117 " const char *path,\n"
14118 " char *const *names);\n"
14124 #: ../src/guestfs-actions.pod:3903
14126 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
14127 "files, where all files are in the directory C<path>. C<names> is the list "
14128 "of files from this directory."
14133 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
14135 "On return you get a list of stat structs, with a one-to-one correspondence "
14136 "to the C<names> list. If any name did not exist or could not be lstat'd, "
14137 "then the C<ino> field of that structure is set to C<-1>."
14142 #: ../src/guestfs-actions.pod:3912
14144 "This call is intended for programs that want to efficiently list a directory "
14145 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
14146 "for a similarly efficient call for getting extended attributes. Very long "
14147 "directory listings might cause the protocol message size to be exceeded, "
14148 "causing this call to fail. The caller must split up such requests into "
14149 "smaller groups of names."
14154 #: ../src/guestfs-actions.pod:3920
14156 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
14157 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
14162 #: ../src/guestfs-actions.pod:3926
14163 msgid "guestfs_luks_add_key"
14168 #: ../src/guestfs-actions.pod:3928
14172 " guestfs_luks_add_key (guestfs_h *g,\n"
14173 " const char *device,\n"
14174 " const char *key,\n"
14175 " const char *newkey,\n"
14182 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2672
14184 "This command adds a new key on LUKS device C<device>. C<key> is any "
14185 "existing key, and is used to access the device. C<newkey> is the new key to "
14186 "add. C<keyslot> is the key slot that will be replaced."
14191 #: ../src/guestfs-actions.pod:3940
14193 "Note that if C<keyslot> already contains a key, then this command will "
14194 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
14199 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3986
14200 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4029
14201 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4083
14203 "This function takes a key or passphrase parameter which could contain "
14204 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
14210 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3990
14211 #: ../src/guestfs-actions.pod:4013 ../src/guestfs-actions.pod:4033
14212 msgid "(Added in 1.5.2)"
14217 #: ../src/guestfs-actions.pod:3952
14218 msgid "guestfs_luks_close"
14223 #: ../src/guestfs-actions.pod:3954
14227 " guestfs_luks_close (guestfs_h *g,\n"
14228 " const char *device);\n"
14234 #: ../src/guestfs-actions.pod:3958
14236 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
14237 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
14238 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
14239 "underlying block device."
14244 #: ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:4068
14245 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4137
14246 #: ../src/guestfs-actions.pod:4185
14247 msgid "(Added in 1.5.1)"
14252 #: ../src/guestfs-actions.pod:3968
14253 msgid "guestfs_luks_format"
14258 #: ../src/guestfs-actions.pod:3970
14262 " guestfs_luks_format (guestfs_h *g,\n"
14263 " const char *device,\n"
14264 " const char *key,\n"
14271 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2698
14273 "This command erases existing data on C<device> and formats the device as a "
14274 "LUKS encrypted device. C<key> is the initial key, which is added to key "
14275 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
14280 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4006
14281 #: ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:5252
14282 #: ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6443
14283 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6506
14284 #: ../src/guestfs-actions.pod:7682 ../fish/guestfish-actions.pod:2706
14285 #: ../fish/guestfish-actions.pod:2719 ../fish/guestfish-actions.pod:2806
14286 #: ../fish/guestfish-actions.pod:3467 ../fish/guestfish-actions.pod:3987
14287 #: ../fish/guestfish-actions.pod:4297 ../fish/guestfish-actions.pod:4320
14288 #: ../fish/guestfish-actions.pod:4342 ../fish/guestfish-actions.pod:5066
14290 "B<This command is dangerous. Without careful use you can easily destroy all "
14296 #: ../src/guestfs-actions.pod:3992
14297 msgid "guestfs_luks_format_cipher"
14302 #: ../src/guestfs-actions.pod:3994
14306 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14307 " const char *device,\n"
14308 " const char *key,\n"
14310 " const char *cipher);\n"
14316 #: ../src/guestfs-actions.pod:4001
14318 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14319 "set the C<cipher> used."
14324 #: ../src/guestfs-actions.pod:4015
14325 msgid "guestfs_luks_kill_slot"
14330 #: ../src/guestfs-actions.pod:4017
14334 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14335 " const char *device,\n"
14336 " const char *key,\n"
14343 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2726
14345 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14346 "device C<device>. C<key> must be one of the I<other> keys."
14351 #: ../src/guestfs-actions.pod:4035
14352 msgid "guestfs_luks_open"
14357 #: ../src/guestfs-actions.pod:4037
14361 " guestfs_luks_open (guestfs_h *g,\n"
14362 " const char *device,\n"
14363 " const char *key,\n"
14364 " const char *mapname);\n"
14370 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:2737
14372 "This command opens a block device which has been encrypted according to the "
14373 "Linux Unified Key Setup (LUKS) standard."
14378 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
14379 msgid "C<device> is the encrypted block device or partition."
14384 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2742
14386 "The caller must supply one of the keys associated with the LUKS block "
14387 "device, in the C<key> parameter."
14392 #: ../src/guestfs-actions.pod:4051 ../fish/guestfish-actions.pod:2745
14394 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14395 "writes to this block device are decrypted from and encrypted to the "
14396 "underlying C<device> respectively."
14401 #: ../src/guestfs-actions.pod:4055
14403 "If this block device contains LVM volume groups, then calling "
14404 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14409 #: ../src/guestfs-actions.pod:4059
14410 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
14415 #: ../src/guestfs-actions.pod:4070
14416 msgid "guestfs_luks_open_ro"
14421 #: ../src/guestfs-actions.pod:4072
14425 " guestfs_luks_open_ro (guestfs_h *g,\n"
14426 " const char *device,\n"
14427 " const char *key,\n"
14428 " const char *mapname);\n"
14434 #: ../src/guestfs-actions.pod:4078
14436 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14442 #: ../src/guestfs-actions.pod:4089
14443 msgid "guestfs_lvcreate"
14448 #: ../src/guestfs-actions.pod:4091
14452 " guestfs_lvcreate (guestfs_h *g,\n"
14453 " const char *logvol,\n"
14454 " const char *volgroup,\n"
14461 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2773
14463 "This creates an LVM logical volume called C<logvol> on the volume group "
14464 "C<volgroup>, with C<size> megabytes."
14469 #: ../src/guestfs-actions.pod:4104
14470 msgid "guestfs_lvm_canonical_lv_name"
14475 #: ../src/guestfs-actions.pod:4106
14479 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14480 " const char *lvname);\n"
14486 #: ../src/guestfs-actions.pod:4110 ../fish/guestfish-actions.pod:2780
14488 "This converts alternative naming schemes for LVs that you might find to the "
14489 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14495 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2784
14497 "This command returns an error if the C<lvname> parameter does not refer to a "
14503 #: ../src/guestfs-actions.pod:4117
14504 msgid "See also C<guestfs_is_lv>."
14509 #: ../src/guestfs-actions.pod:4122
14510 msgid "(Added in 1.5.24)"
14515 #: ../src/guestfs-actions.pod:4124
14516 msgid "guestfs_lvm_clear_filter"
14521 #: ../src/guestfs-actions.pod:4126
14525 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14531 #: ../src/guestfs-actions.pod:4129
14533 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14534 "see every block device."
14539 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4174
14540 #: ../fish/guestfish-actions.pod:2796 ../fish/guestfish-actions.pod:2827
14542 "This command also clears the LVM cache and performs a volume group scan."
14547 #: ../src/guestfs-actions.pod:4139
14548 msgid "guestfs_lvm_remove_all"
14553 #: ../src/guestfs-actions.pod:4141
14557 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14563 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2803
14565 "This command removes all LVM logical volumes, volume groups and physical "
14571 #: ../src/guestfs-actions.pod:4154
14572 msgid "guestfs_lvm_set_filter"
14577 #: ../src/guestfs-actions.pod:4156
14581 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14582 " char *const *devices);\n"
14588 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2813
14590 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14591 "block devices in the list C<devices>, and will ignore all other attached "
14597 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2817
14599 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14600 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14601 "there are two types of duplication possible: either cloned PVs/VGs which "
14602 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14603 "same name. In normal operation you cannot create this situation, but you "
14604 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14605 "inside the LVM metadata."
14610 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2830
14611 msgid "You can filter whole block devices or individual partitions."
14616 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:2832
14618 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14619 "filesystem), even if you are not filtering out that VG."
14624 #: ../src/guestfs-actions.pod:4187
14625 msgid "guestfs_lvremove"
14630 #: ../src/guestfs-actions.pod:4189
14634 " guestfs_lvremove (guestfs_h *g,\n"
14635 " const char *device);\n"
14641 #: ../src/guestfs-actions.pod:4193 ../fish/guestfish-actions.pod:2840
14643 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14644 "LV, such as C</dev/VG/LV>."
14649 #: ../src/guestfs-actions.pod:4196 ../fish/guestfish-actions.pod:2843
14651 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14657 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:5598
14658 #: ../src/guestfs-actions.pod:7413
14659 msgid "(Added in 1.0.13)"
14664 #: ../src/guestfs-actions.pod:4203
14665 msgid "guestfs_lvrename"
14670 #: ../src/guestfs-actions.pod:4205
14674 " guestfs_lvrename (guestfs_h *g,\n"
14675 " const char *logvol,\n"
14676 " const char *newlogvol);\n"
14682 #: ../src/guestfs-actions.pod:4210 ../fish/guestfish-actions.pod:2850
14683 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14688 #: ../src/guestfs-actions.pod:4214 ../src/guestfs-actions.pod:7426
14689 msgid "(Added in 1.0.83)"
14694 #: ../src/guestfs-actions.pod:4216
14695 msgid "guestfs_lvresize"
14700 #: ../src/guestfs-actions.pod:4218
14704 " guestfs_lvresize (guestfs_h *g,\n"
14705 " const char *device,\n"
14712 #: ../src/guestfs-actions.pod:4223 ../fish/guestfish-actions.pod:2856
14714 "This resizes (expands or shrinks) an existing LVM logical volume to "
14715 "C<mbytes>. When reducing, data in the reduced part is lost."
14720 #: ../src/guestfs-actions.pod:4231
14721 msgid "guestfs_lvresize_free"
14726 #: ../src/guestfs-actions.pod:4233
14730 " guestfs_lvresize_free (guestfs_h *g,\n"
14731 " const char *lv,\n"
14738 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2864
14740 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14741 "remaining free space in the volume group. Commonly you would call this with "
14742 "pc = 100 which expands the logical volume as much as possible, using all "
14743 "remaining free space in the volume group."
14748 #: ../src/guestfs-actions.pod:4246
14749 msgid "(Added in 1.3.3)"
14754 #: ../src/guestfs-actions.pod:4248
14755 msgid "guestfs_lvs"
14760 #: ../src/guestfs-actions.pod:4250
14764 " guestfs_lvs (guestfs_h *g);\n"
14770 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2874
14772 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14778 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2877
14780 "This returns a list of the logical volume device names (eg. C</dev/"
14781 "VolGroup00/LogVol00>)."
14786 #: ../src/guestfs-actions.pod:4259
14787 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14792 #: ../src/guestfs-actions.pod:4267
14793 msgid "guestfs_lvs_full"
14798 #: ../src/guestfs-actions.pod:4269
14801 " struct guestfs_lvm_lv_list *\n"
14802 " guestfs_lvs_full (guestfs_h *g);\n"
14808 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2886
14810 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14811 "(8)> command. The \"full\" version includes all fields."
14816 #: ../src/guestfs-actions.pod:4275
14818 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14819 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14824 #: ../src/guestfs-actions.pod:4281
14825 msgid "guestfs_lvuuid"
14830 #: ../src/guestfs-actions.pod:4283
14834 " guestfs_lvuuid (guestfs_h *g,\n"
14835 " const char *device);\n"
14841 #: ../src/guestfs-actions.pod:4287 ../fish/guestfish-actions.pod:2893
14842 msgid "This command returns the UUID of the LVM LV C<device>."
14847 #: ../src/guestfs-actions.pod:4294
14848 msgid "guestfs_lxattrlist"
14853 #: ../src/guestfs-actions.pod:4296
14856 " struct guestfs_xattr_list *\n"
14857 " guestfs_lxattrlist (guestfs_h *g,\n"
14858 " const char *path,\n"
14859 " char *const *names);\n"
14865 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2899
14867 "This call allows you to get the extended attributes of multiple files, where "
14868 "all files are in the directory C<path>. C<names> is the list of files from "
14874 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2903
14876 "On return you get a flat list of xattr structs which must be interpreted "
14877 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14878 "C<attrval> in this struct is zero-length to indicate there was an error "
14879 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14880 "number (the number of following attributes for this file, which could be C<"
14881 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14882 "for the first named file. This repeats for the second and subsequent files."
14887 #: ../src/guestfs-actions.pod:4315
14889 "This call is intended for programs that want to efficiently list a directory "
14890 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14891 "a similarly efficient call for getting standard stats. Very long directory "
14892 "listings might cause the protocol message size to be exceeded, causing this "
14893 "call to fail. The caller must split up such requests into smaller groups of "
14899 #: ../src/guestfs-actions.pod:4329
14900 msgid "guestfs_mkdir"
14905 #: ../src/guestfs-actions.pod:4331
14909 " guestfs_mkdir (guestfs_h *g,\n"
14910 " const char *path);\n"
14916 #: ../src/guestfs-actions.pod:4335 ../fish/guestfish-actions.pod:2925
14917 msgid "Create a directory named C<path>."
14922 #: ../src/guestfs-actions.pod:4341
14923 msgid "guestfs_mkdir_mode"
14928 #: ../src/guestfs-actions.pod:4343
14932 " guestfs_mkdir_mode (guestfs_h *g,\n"
14933 " const char *path,\n"
14940 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2931
14942 "This command creates a directory, setting the initial permissions of the "
14943 "directory to C<mode>."
14948 #: ../src/guestfs-actions.pod:4351 ../fish/guestfish-actions.pod:2934
14950 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14951 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14957 #: ../src/guestfs-actions.pod:4355
14958 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14963 #: ../src/guestfs-actions.pod:4361
14964 msgid "guestfs_mkdir_p"
14969 #: ../src/guestfs-actions.pod:4363
14973 " guestfs_mkdir_p (guestfs_h *g,\n"
14974 " const char *path);\n"
14980 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2944
14982 "Create a directory named C<path>, creating any parent directories as "
14983 "necessary. This is like the C<mkdir -p> shell command."
14988 #: ../src/guestfs-actions.pod:4374
14989 msgid "guestfs_mkdtemp"
14994 #: ../src/guestfs-actions.pod:4376
14998 " guestfs_mkdtemp (guestfs_h *g,\n"
14999 " const char *template);\n"
15005 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2951
15007 "This command creates a temporary directory. The C<template> parameter "
15008 "should be a full pathname for the temporary directory name with the final "
15009 "six characters being \"XXXXXX\"."
15014 #: ../src/guestfs-actions.pod:4385 ../fish/guestfish-actions.pod:2956
15016 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
15017 "being suitable for Windows filesystems."
15022 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:2959
15023 msgid "The name of the temporary directory that was created is returned."
15028 #: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2962
15029 msgid "The temporary directory is created with mode 0700 and is owned by root."
15034 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2965
15036 "The caller is responsible for deleting the temporary directory and its "
15037 "contents after use."
15042 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2968
15043 msgid "See also: L<mkdtemp(3)>"
15048 #: ../src/guestfs-actions.pod:4404
15049 msgid "guestfs_mke2fs_J"
15054 #: ../src/guestfs-actions.pod:4406
15058 " guestfs_mke2fs_J (guestfs_h *g,\n"
15059 " const char *fstype,\n"
15060 " int blocksize,\n"
15061 " const char *device,\n"
15062 " const char *journal);\n"
15068 #: ../src/guestfs-actions.pod:4413 ../fish/guestfish-actions.pod:2974
15070 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15071 "C<journal>. It is equivalent to the command:"
15076 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:2978
15079 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
15085 #: ../src/guestfs-actions.pod:4419
15086 msgid "See also C<guestfs_mke2journal>."
15091 #: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:4441
15092 #: ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:4475
15093 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
15094 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4839
15095 msgid "(Added in 1.0.68)"
15100 #: ../src/guestfs-actions.pod:4425
15101 msgid "guestfs_mke2fs_JL"
15106 #: ../src/guestfs-actions.pod:4427
15110 " guestfs_mke2fs_JL (guestfs_h *g,\n"
15111 " const char *fstype,\n"
15112 " int blocksize,\n"
15113 " const char *device,\n"
15114 " const char *label);\n"
15120 #: ../src/guestfs-actions.pod:4434 ../fish/guestfish-actions.pod:2986
15122 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15123 "the journal labeled C<label>."
15128 #: ../src/guestfs-actions.pod:4437
15129 msgid "See also C<guestfs_mke2journal_L>."
15134 #: ../src/guestfs-actions.pod:4443
15135 msgid "guestfs_mke2fs_JU"
15140 #: ../src/guestfs-actions.pod:4445
15144 " guestfs_mke2fs_JU (guestfs_h *g,\n"
15145 " const char *fstype,\n"
15146 " int blocksize,\n"
15147 " const char *device,\n"
15148 " const char *uuid);\n"
15154 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:2995
15156 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
15157 "the journal with UUID C<uuid>."
15162 #: ../src/guestfs-actions.pod:4455
15163 msgid "See also C<guestfs_mke2journal_U>."
15168 #: ../src/guestfs-actions.pod:4461
15169 msgid "guestfs_mke2journal"
15174 #: ../src/guestfs-actions.pod:4463
15178 " guestfs_mke2journal (guestfs_h *g,\n"
15179 " int blocksize,\n"
15180 " const char *device);\n"
15186 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3004
15188 "This creates an ext2 external journal on C<device>. It is equivalent to the "
15194 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3007
15197 " mke2fs -O journal_dev -b blocksize device\n"
15203 #: ../src/guestfs-actions.pod:4477
15204 msgid "guestfs_mke2journal_L"
15209 #: ../src/guestfs-actions.pod:4479
15213 " guestfs_mke2journal_L (guestfs_h *g,\n"
15214 " int blocksize,\n"
15215 " const char *label,\n"
15216 " const char *device);\n"
15222 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3013
15223 msgid "This creates an ext2 external journal on C<device> with label C<label>."
15228 #: ../src/guestfs-actions.pod:4491
15229 msgid "guestfs_mke2journal_U"
15234 #: ../src/guestfs-actions.pod:4493
15238 " guestfs_mke2journal_U (guestfs_h *g,\n"
15239 " int blocksize,\n"
15240 " const char *uuid,\n"
15241 " const char *device);\n"
15247 #: ../src/guestfs-actions.pod:4499 ../fish/guestfish-actions.pod:3019
15248 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
15253 #: ../src/guestfs-actions.pod:4505
15254 msgid "guestfs_mkfifo"
15259 #: ../src/guestfs-actions.pod:4507
15263 " guestfs_mkfifo (guestfs_h *g,\n"
15265 " const char *path);\n"
15271 #: ../src/guestfs-actions.pod:4512
15273 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
15274 "is just a convenient wrapper around C<guestfs_mknod>."
15279 #: ../src/guestfs-actions.pod:4522
15280 msgid "guestfs_mkfs"
15285 #: ../src/guestfs-actions.pod:4524
15289 " guestfs_mkfs (guestfs_h *g,\n"
15290 " const char *fstype,\n"
15291 " const char *device);\n"
15297 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3035
15299 "This creates a filesystem on C<device> (usually a partition or LVM logical "
15300 "volume). The filesystem type is C<fstype>, for example C<ext3>."
15305 #: ../src/guestfs-actions.pod:4537
15306 msgid "guestfs_mkfs_b"
15311 #: ../src/guestfs-actions.pod:4539
15315 " guestfs_mkfs_b (guestfs_h *g,\n"
15316 " const char *fstype,\n"
15317 " int blocksize,\n"
15318 " const char *device);\n"
15324 #: ../src/guestfs-actions.pod:4545
15326 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15327 "block size of the resulting filesystem. Supported block sizes depend on the "
15328 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15333 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4595
15334 #: ../fish/guestfish-actions.pod:3048 ../fish/guestfish-actions.pod:3075
15336 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15342 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3051
15344 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15349 #: ../src/guestfs-actions.pod:4564
15350 msgid "guestfs_mkfs_opts"
15355 #: ../src/guestfs-actions.pod:4566
15359 " guestfs_mkfs_opts (guestfs_h *g,\n"
15360 " const char *fstype,\n"
15361 " const char *device,\n"
15367 #: ../src/guestfs-actions.pod:4577
15370 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15371 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15372 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
15373 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
15379 #: ../src/guestfs-actions.pod:4582 ../fish/guestfish-actions.pod:3062
15381 "This function creates a filesystem on C<device>. The filesystem type is "
15382 "C<fstype>, for example C<ext3>."
15387 #: ../src/guestfs-actions.pod:4589 ../fish/guestfish-actions.pod:3069
15388 msgid "C<blocksize>"
15393 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3071
15395 "The filesystem block size. Supported block sizes depend on the filesystem "
15396 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15401 #: ../src/guestfs-actions.pod:4598 ../fish/guestfish-actions.pod:3078
15402 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15406 #: ../src/guestfs-actions.pod:4600 ../fish/guestfish-actions.pod:3080
15407 msgid "C<features>"
15411 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3082
15412 msgid "This passes the I<-O> parameter to the external mkfs program."
15416 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3084
15418 "For certain filesystem types, this allows extra filesystem features to be "
15419 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15423 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3088
15425 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15430 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3091
15435 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3093
15437 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
15438 "sets the inode size (only for ext2/3/4 filesystems at present)."
15442 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3096
15443 msgid "C<sectorsize>"
15447 #: ../src/guestfs-actions.pod:4618 ../fish/guestfish-actions.pod:3098
15449 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
15450 "sets sector size for ufs filesystem."
15454 #: ../src/guestfs-actions.pod:4625
15455 msgid "(Added in 1.7.19)"
15460 #: ../src/guestfs-actions.pod:4627
15461 msgid "guestfs_mkfs_opts_va"
15466 #: ../src/guestfs-actions.pod:4629
15470 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15471 " const char *fstype,\n"
15472 " const char *device,\n"
15473 " va_list args);\n"
15479 #: ../src/guestfs-actions.pod:4635
15480 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15485 #: ../src/guestfs-actions.pod:4639
15486 msgid "guestfs_mkfs_opts_argv"
15491 #: ../src/guestfs-actions.pod:4641
15495 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15496 " const char *fstype,\n"
15497 " const char *device,\n"
15498 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15504 #: ../src/guestfs-actions.pod:4647
15505 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15510 #: ../src/guestfs-actions.pod:4651
15511 msgid "guestfs_mkmountpoint"
15516 #: ../src/guestfs-actions.pod:4653
15520 " guestfs_mkmountpoint (guestfs_h *g,\n"
15521 " const char *exemptpath);\n"
15527 #: ../src/guestfs-actions.pod:4657
15529 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15530 "that can be used to create extra mountpoints before mounting the first "
15536 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3113
15538 "These calls are I<only> necessary in some very limited circumstances, mainly "
15539 "the case where you want to mount a mix of unrelated and/or read-only "
15540 "filesystems together."
15545 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3117
15547 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15548 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15549 "inside that. You can unpack this as follows in guestfish:"
15554 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3122
15557 " add-ro Fedora-11-i686-Live.iso\n"
15559 " mkmountpoint /cd\n"
15560 " mkmountpoint /sqsh\n"
15561 " mkmountpoint /ext3fs\n"
15562 " mount /dev/sda /cd\n"
15563 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15564 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15570 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3131
15571 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15576 #: ../src/guestfs-actions.pod:4681
15578 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15579 "may get unexpected errors if you try to mix these calls. It is safest to "
15580 "manually unmount filesystems and remove mountpoints after use."
15585 #: ../src/guestfs-actions.pod:4685
15587 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15588 "first, so for this to work for manual mountpoints, you must ensure that the "
15589 "innermost mountpoints have the longest pathnames, as in the example code "
15595 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3142
15597 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15601 #: ../src/guestfs-actions.pod:4692
15603 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15604 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15605 "can also trigger these issues."
15610 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:5014
15611 #: ../src/guestfs-actions.pod:6018
15612 msgid "(Added in 1.0.62)"
15617 #: ../src/guestfs-actions.pod:4700
15618 msgid "guestfs_mknod"
15623 #: ../src/guestfs-actions.pod:4702
15627 " guestfs_mknod (guestfs_h *g,\n"
15631 " const char *path);\n"
15637 #: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3152
15639 "This call creates block or character special devices, or named pipes (FIFOs)."
15644 #: ../src/guestfs-actions.pod:4712 ../fish/guestfish-actions.pod:3155
15646 "The C<mode> parameter should be the mode, using the standard constants. "
15647 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15648 "used when creating block and character special devices."
15653 #: ../src/guestfs-actions.pod:4717
15655 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15656 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15657 "regular file). These constants are available in the standard Linux header "
15658 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15659 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15660 "the appropriate constant for you."
15665 #: ../src/guestfs-actions.pod:4731
15666 msgid "guestfs_mknod_b"
15671 #: ../src/guestfs-actions.pod:4733
15675 " guestfs_mknod_b (guestfs_h *g,\n"
15679 " const char *path);\n"
15685 #: ../src/guestfs-actions.pod:4740
15687 "This call creates a block device node called C<path> with mode C<mode> and "
15688 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15689 "wrapper around C<guestfs_mknod>."
15694 #: ../src/guestfs-actions.pod:4750
15695 msgid "guestfs_mknod_c"
15700 #: ../src/guestfs-actions.pod:4752
15704 " guestfs_mknod_c (guestfs_h *g,\n"
15708 " const char *path);\n"
15714 #: ../src/guestfs-actions.pod:4759
15716 "This call creates a char device node called C<path> with mode C<mode> and "
15717 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15718 "wrapper around C<guestfs_mknod>."
15723 #: ../src/guestfs-actions.pod:4769
15724 msgid "guestfs_mkswap"
15729 #: ../src/guestfs-actions.pod:4771
15733 " guestfs_mkswap (guestfs_h *g,\n"
15734 " const char *device);\n"
15740 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3194
15741 msgid "Create a swap partition on C<device>."
15746 #: ../src/guestfs-actions.pod:4781
15747 msgid "guestfs_mkswap_L"
15752 #: ../src/guestfs-actions.pod:4783
15756 " guestfs_mkswap_L (guestfs_h *g,\n"
15757 " const char *label,\n"
15758 " const char *device);\n"
15764 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3200
15765 msgid "Create a swap partition on C<device> with label C<label>."
15770 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3202
15772 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15773 "sda>), just to a partition. This appears to be a limitation of the kernel "
15779 #: ../src/guestfs-actions.pod:4798
15780 msgid "guestfs_mkswap_U"
15785 #: ../src/guestfs-actions.pod:4800
15789 " guestfs_mkswap_U (guestfs_h *g,\n"
15790 " const char *uuid,\n"
15791 " const char *device);\n"
15797 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3210
15798 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15803 #: ../src/guestfs-actions.pod:4811
15804 msgid "guestfs_mkswap_file"
15809 #: ../src/guestfs-actions.pod:4813
15813 " guestfs_mkswap_file (guestfs_h *g,\n"
15814 " const char *path);\n"
15820 #: ../src/guestfs-actions.pod:4817 ../fish/guestfish-actions.pod:3216
15821 msgid "Create a swap file."
15826 #: ../src/guestfs-actions.pod:4819
15828 "This command just writes a swap file signature to an existing file. To "
15829 "create the file itself, use something like C<guestfs_fallocate>."
15834 #: ../src/guestfs-actions.pod:4826
15835 msgid "guestfs_modprobe"
15840 #: ../src/guestfs-actions.pod:4828
15844 " guestfs_modprobe (guestfs_h *g,\n"
15845 " const char *modulename);\n"
15851 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3225
15852 msgid "This loads a kernel module in the appliance."
15857 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3227
15859 "The kernel module must have been whitelisted when libguestfs was built (see "
15860 "C<appliance/kmod.whitelist.in> in the source)."
15865 #: ../src/guestfs-actions.pod:4841
15866 msgid "guestfs_mount"
15871 #: ../src/guestfs-actions.pod:4843
15875 " guestfs_mount (guestfs_h *g,\n"
15876 " const char *device,\n"
15877 " const char *mountpoint);\n"
15883 #: ../src/guestfs-actions.pod:4848 ../fish/guestfish-actions.pod:3234
15885 "Mount a guest disk at a position in the filesystem. Block devices are named "
15886 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15887 "those block devices contain partitions, they will have the usual names (eg. "
15888 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15893 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3240
15895 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15896 "mounted on C</> before others can be mounted. Other filesystems can only be "
15897 "mounted on directories which already exist."
15902 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3245
15904 "The mounted filesystem is writable, if we have sufficient permissions on the "
15905 "underlying device."
15910 #: ../src/guestfs-actions.pod:4862
15912 "B<Important note:> When you use this call, the filesystem options C<sync> "
15913 "and C<noatime> are set implicitly. This was originally done because we "
15914 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15915 "very large negative performance impact and negligible effect on "
15916 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15917 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15918 "(use an empty string for the first parameter if you don't want any options)."
15922 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3258
15924 "This function is deprecated. In new code, use the C<mount_options> call "
15929 #: ../src/guestfs-actions.pod:4883
15930 msgid "guestfs_mount_9p"
15934 #: ../src/guestfs-actions.pod:4885
15938 " guestfs_mount_9p (guestfs_h *g,\n"
15939 " const char *mounttag,\n"
15940 " const char *mountpoint,\n"
15946 #: ../src/guestfs-actions.pod:4896
15949 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
15954 #: ../src/guestfs-actions.pod:4898 ../fish/guestfish-actions.pod:3269
15956 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
15961 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3272
15963 "If required, C<trans=virtio> will be automatically added to the options. "
15964 "Any other options required can be passed in the optional C<options> "
15969 #: ../src/guestfs-actions.pod:4909
15970 msgid "guestfs_mount_9p_va"
15974 #: ../src/guestfs-actions.pod:4911
15978 " guestfs_mount_9p_va (guestfs_h *g,\n"
15979 " const char *mounttag,\n"
15980 " const char *mountpoint,\n"
15981 " va_list args);\n"
15986 #: ../src/guestfs-actions.pod:4917
15987 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
15991 #: ../src/guestfs-actions.pod:4921
15992 msgid "guestfs_mount_9p_argv"
15996 #: ../src/guestfs-actions.pod:4923
16000 " guestfs_mount_9p_argv (guestfs_h *g,\n"
16001 " const char *mounttag,\n"
16002 " const char *mountpoint,\n"
16003 " const struct guestfs_mount_9p_argv *optargs);\n"
16008 #: ../src/guestfs-actions.pod:4929
16009 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
16014 #: ../src/guestfs-actions.pod:4933
16015 msgid "guestfs_mount_loop"
16020 #: ../src/guestfs-actions.pod:4935
16024 " guestfs_mount_loop (guestfs_h *g,\n"
16025 " const char *file,\n"
16026 " const char *mountpoint);\n"
16032 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3282
16034 "This command lets you mount C<file> (a filesystem image in a file) on a "
16035 "mount point. It is entirely equivalent to the command C<mount -o loop file "
16041 #: ../src/guestfs-actions.pod:4948
16042 msgid "guestfs_mount_options"
16047 #: ../src/guestfs-actions.pod:4950
16051 " guestfs_mount_options (guestfs_h *g,\n"
16052 " const char *options,\n"
16053 " const char *device,\n"
16054 " const char *mountpoint);\n"
16060 #: ../src/guestfs-actions.pod:4956
16062 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16063 "the mount options as for the L<mount(8)> I<-o> flag."
16068 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3294
16070 "If the C<options> parameter is an empty string, then no options are passed "
16071 "(all options default to whatever the filesystem uses)."
16076 #: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:4980
16077 #: ../src/guestfs-actions.pod:4997
16078 msgid "(Added in 1.0.10)"
16083 #: ../src/guestfs-actions.pod:4968
16084 msgid "guestfs_mount_ro"
16089 #: ../src/guestfs-actions.pod:4970
16093 " guestfs_mount_ro (guestfs_h *g,\n"
16094 " const char *device,\n"
16095 " const char *mountpoint);\n"
16101 #: ../src/guestfs-actions.pod:4975
16103 "This is the same as the C<guestfs_mount> command, but it mounts the "
16104 "filesystem with the read-only (I<-o ro>) flag."
16109 #: ../src/guestfs-actions.pod:4982
16110 msgid "guestfs_mount_vfs"
16115 #: ../src/guestfs-actions.pod:4984
16119 " guestfs_mount_vfs (guestfs_h *g,\n"
16120 " const char *options,\n"
16121 " const char *vfstype,\n"
16122 " const char *device,\n"
16123 " const char *mountpoint);\n"
16129 #: ../src/guestfs-actions.pod:4991
16131 "This is the same as the C<guestfs_mount> command, but it allows you to set "
16132 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
16138 #: ../src/guestfs-actions.pod:4999
16139 msgid "guestfs_mountpoints"
16144 #: ../src/guestfs-actions.pod:5001
16148 " guestfs_mountpoints (guestfs_h *g);\n"
16154 #: ../src/guestfs-actions.pod:5004
16156 "This call is similar to C<guestfs_mounts>. That call returns a list of "
16157 "devices. This one returns a hash table (map) of device name to directory "
16158 "where the device is mounted."
16163 #: ../src/guestfs-actions.pod:5016
16164 msgid "guestfs_mounts"
16169 #: ../src/guestfs-actions.pod:5018
16173 " guestfs_mounts (guestfs_h *g);\n"
16179 #: ../src/guestfs-actions.pod:5021 ../fish/guestfish-actions.pod:3325
16181 "This returns the list of currently mounted filesystems. It returns the list "
16182 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
16187 #: ../src/guestfs-actions.pod:5024 ../fish/guestfish-actions.pod:3328
16188 msgid "Some internal mounts are not shown."
16193 #: ../src/guestfs-actions.pod:5026
16194 msgid "See also: C<guestfs_mountpoints>"
16199 #: ../src/guestfs-actions.pod:5034
16205 #: ../src/guestfs-actions.pod:5036
16209 " guestfs_mv (guestfs_h *g,\n"
16210 " const char *src,\n"
16211 " const char *dest);\n"
16217 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3336
16219 "This moves a file from C<src> to C<dest> where C<dest> is either a "
16220 "destination filename or destination directory."
16225 #: ../src/guestfs-actions.pod:5048
16226 msgid "guestfs_ntfs_3g_probe"
16231 #: ../src/guestfs-actions.pod:5050
16235 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
16237 " const char *device);\n"
16243 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3343
16245 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
16246 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
16247 "write, and some cannot be mounted at all)."
16252 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3347
16254 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
16255 "can be mounted read-write. Set it to false if you want to test if the "
16256 "volume can be mounted read-only."
16261 #: ../src/guestfs-actions.pod:5063 ../fish/guestfish-actions.pod:3351
16263 "The return value is an integer which C<0> if the operation would succeed, or "
16264 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
16269 #: ../src/guestfs-actions.pod:5069
16270 msgid "(Added in 1.0.43)"
16275 #: ../src/guestfs-actions.pod:5071
16276 msgid "guestfs_ntfsresize"
16281 #: ../src/guestfs-actions.pod:5073
16285 " guestfs_ntfsresize (guestfs_h *g,\n"
16286 " const char *device);\n"
16291 #: ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5116
16292 #: ../fish/guestfish-actions.pod:3359 ../fish/guestfish-actions.pod:3383
16294 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
16295 "size of the underlying device."
16299 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3362
16301 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
16302 "consistency check (for safety). You have to boot into Windows to perform "
16303 "this check and clear this condition. Furthermore, ntfsresize refuses to "
16304 "resize filesystems which have been marked in this way. So in effect it is "
16305 "not possible to call ntfsresize multiple times on a single filesystem "
16306 "without booting into Windows between each resize."
16310 #: ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5142
16311 #: ../fish/guestfish-actions.pod:3370 ../fish/guestfish-actions.pod:3409
16312 msgid "See also L<ntfsresize(8)>."
16316 #: ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5182
16317 #: ../fish/guestfish-actions.pod:3372 ../fish/guestfish-actions.pod:3420
16319 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
16324 #: ../src/guestfs-actions.pod:5101
16325 msgid "guestfs_ntfsresize_opts"
16329 #: ../src/guestfs-actions.pod:5103
16333 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
16334 " const char *device,\n"
16340 #: ../src/guestfs-actions.pod:5113
16343 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
16344 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
16349 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3386
16350 msgid "The optional parameters are:"
16354 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3390
16359 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3392
16361 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
16362 "resized to fit the container (eg. partition)."
16366 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3395
16371 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3397
16373 "If this option is true, then force the resize of the filesystem even if the "
16374 "filesystem is marked as requiring a consistency check."
16378 #: ../src/guestfs-actions.pod:5133
16380 "After the resize operation, the filesystem is always marked as requiring a "
16381 "consistency check (for safety). You have to boot into Windows to perform "
16382 "this check and clear this condition. If you I<don't> set the C<force> "
16383 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
16384 "times on a single filesystem without booting into Windows between each "
16389 #: ../src/guestfs-actions.pod:5148
16390 msgid "guestfs_ntfsresize_opts_va"
16394 #: ../src/guestfs-actions.pod:5150
16398 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
16399 " const char *device,\n"
16400 " va_list args);\n"
16405 #: ../src/guestfs-actions.pod:5155
16406 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
16410 #: ../src/guestfs-actions.pod:5159
16411 msgid "guestfs_ntfsresize_opts_argv"
16415 #: ../src/guestfs-actions.pod:5161
16419 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
16420 " const char *device,\n"
16421 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
16426 #: ../src/guestfs-actions.pod:5166
16427 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
16432 #: ../src/guestfs-actions.pod:5170
16433 msgid "guestfs_ntfsresize_size"
16438 #: ../src/guestfs-actions.pod:5172
16442 " guestfs_ntfsresize_size (guestfs_h *g,\n"
16443 " const char *device,\n"
16444 " int64_t size);\n"
16450 #: ../src/guestfs-actions.pod:5177
16452 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
16453 "to specify the new size (in bytes) explicitly."
16458 #: ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5625
16459 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5966
16460 #: ../src/guestfs-actions.pod:7568
16461 msgid "(Added in 1.3.14)"
16466 #: ../src/guestfs-actions.pod:5191
16467 msgid "guestfs_part_add"
16472 #: ../src/guestfs-actions.pod:5193
16476 " guestfs_part_add (guestfs_h *g,\n"
16477 " const char *device,\n"
16478 " const char *prlogex,\n"
16479 " int64_t startsect,\n"
16480 " int64_t endsect);\n"
16486 #: ../src/guestfs-actions.pod:5200
16488 "This command adds a partition to C<device>. If there is no partition table "
16489 "on the device, call C<guestfs_part_init> first."
16494 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3434
16496 "The C<prlogex> parameter is the type of partition. Normally you should pass "
16497 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
16498 "C<logical>) and C<e> (or C<extended>) partition types."
16503 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3439
16505 "C<startsect> and C<endsect> are the start and end of the partition in "
16506 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
16507 "from the end of the disk (C<-1> is the last sector)."
16512 #: ../src/guestfs-actions.pod:5212
16514 "Creating a partition which covers the whole disk is not so easy. Use "
16515 "C<guestfs_part_disk> to do that."
16520 #: ../src/guestfs-actions.pod:5217 ../src/guestfs-actions.pod:5255
16521 #: ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5386
16522 #: ../src/guestfs-actions.pod:5424 ../src/guestfs-actions.pod:5443
16523 #: ../src/guestfs-actions.pod:5483
16524 msgid "(Added in 1.0.78)"
16529 #: ../src/guestfs-actions.pod:5219
16530 msgid "guestfs_part_del"
16535 #: ../src/guestfs-actions.pod:5221
16539 " guestfs_part_del (guestfs_h *g,\n"
16540 " const char *device,\n"
16547 #: ../src/guestfs-actions.pod:5226 ../fish/guestfish-actions.pod:3450
16548 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16553 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3452
16555 "Note that in the case of MBR partitioning, deleting an extended partition "
16556 "also deletes any logical partitions it contains."
16561 #: ../src/guestfs-actions.pod:5236
16562 msgid "guestfs_part_disk"
16567 #: ../src/guestfs-actions.pod:5238
16571 " guestfs_part_disk (guestfs_h *g,\n"
16572 " const char *device,\n"
16573 " const char *parttype);\n"
16579 #: ../src/guestfs-actions.pod:5243
16581 "This command is simply a combination of C<guestfs_part_init> followed by "
16582 "C<guestfs_part_add> to create a single primary partition covering the whole "
16588 #: ../src/guestfs-actions.pod:5247
16590 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16591 "possible values are described in C<guestfs_part_init>."
16596 #: ../src/guestfs-actions.pod:5257
16597 msgid "guestfs_part_get_bootable"
16602 #: ../src/guestfs-actions.pod:5259
16606 " guestfs_part_get_bootable (guestfs_h *g,\n"
16607 " const char *device,\n"
16614 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3474
16616 "This command returns true if the partition C<partnum> on C<device> has the "
16617 "bootable flag set."
16622 #: ../src/guestfs-actions.pod:5267
16623 msgid "See also C<guestfs_part_set_bootable>."
16628 #: ../src/guestfs-actions.pod:5273
16629 msgid "guestfs_part_get_mbr_id"
16634 #: ../src/guestfs-actions.pod:5275
16638 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16639 " const char *device,\n"
16646 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3483
16648 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16649 "partition C<partnum>."
16654 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5459
16656 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16657 "undefined results for other partition table types (see "
16658 "C<guestfs_part_get_parttype>)."
16663 #: ../src/guestfs-actions.pod:5291
16664 msgid "guestfs_part_get_parttype"
16669 #: ../src/guestfs-actions.pod:5293
16673 " guestfs_part_get_parttype (guestfs_h *g,\n"
16674 " const char *device);\n"
16680 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3494
16682 "This command examines the partition table on C<device> and returns the "
16683 "partition table type (format) being used."
16688 #: ../src/guestfs-actions.pod:5300
16690 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16691 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16692 "possible, although unusual. See C<guestfs_part_init> for a full list."
16697 #: ../src/guestfs-actions.pod:5310
16698 msgid "guestfs_part_init"
16703 #: ../src/guestfs-actions.pod:5312
16707 " guestfs_part_init (guestfs_h *g,\n"
16708 " const char *device,\n"
16709 " const char *parttype);\n"
16715 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3506
16717 "This creates an empty partition table on C<device> of one of the partition "
16718 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16719 "(for large disks)."
16724 #: ../src/guestfs-actions.pod:5321
16726 "Initially there are no partitions. Following this, you should call "
16727 "C<guestfs_part_add> for each partition required."
16732 #: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:3513
16733 msgid "Possible values for C<parttype> are:"
16738 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3517
16739 msgid "B<efi> | B<gpt>"
16744 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3519
16745 msgid "Intel EFI / GPT partition table."
16750 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3521
16752 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16753 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16754 "the C<mbr> format."
16759 #: ../src/guestfs-actions.pod:5336 ../fish/guestfish-actions.pod:3525
16760 msgid "B<mbr> | B<msdos>"
16765 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3527
16767 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16768 "Windows. This partition type will B<only> work for device sizes up to 2 "
16769 "TB. For large disks we recommend using C<gpt>."
16774 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3534
16776 "Other partition table types that may work but are not supported include:"
16781 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3539
16787 #: ../src/guestfs-actions.pod:5352 ../fish/guestfish-actions.pod:3541
16788 msgid "AIX disk labels."
16793 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3543
16794 msgid "B<amiga> | B<rdb>"
16799 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3545
16800 msgid "Amiga \"Rigid Disk Block\" format."
16805 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3547
16811 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3549
16812 msgid "BSD disk labels."
16817 #: ../src/guestfs-actions.pod:5362 ../fish/guestfish-actions.pod:3551
16823 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3553
16824 msgid "DASD, used on IBM mainframes."
16829 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3555
16835 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3557
16836 msgid "MIPS/SGI volumes."
16841 #: ../src/guestfs-actions.pod:5370 ../fish/guestfish-actions.pod:3559
16847 #: ../src/guestfs-actions.pod:5372 ../fish/guestfish-actions.pod:3561
16848 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16853 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3563
16859 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3565
16860 msgid "NEC PC-98 format, common in Japan apparently."
16865 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3567
16871 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3569
16872 msgid "Sun disk labels."
16877 #: ../src/guestfs-actions.pod:5388
16878 msgid "guestfs_part_list"
16883 #: ../src/guestfs-actions.pod:5390
16886 " struct guestfs_partition_list *\n"
16887 " guestfs_part_list (guestfs_h *g,\n"
16888 " const char *device);\n"
16894 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3577
16896 "This command parses the partition table on C<device> and returns the list of "
16897 "partitions found."
16902 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3580
16903 msgid "The fields in the returned structure are:"
16908 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3584
16909 msgid "B<part_num>"
16914 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3586
16915 msgid "Partition number, counting from 1."
16920 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3588
16921 msgid "B<part_start>"
16926 #: ../src/guestfs-actions.pod:5407
16928 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16929 "the device's sector size, see C<guestfs_blockdev_getss>."
16934 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3593
16935 msgid "B<part_end>"
16940 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3595
16941 msgid "End of the partition in bytes."
16946 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3597
16947 msgid "B<part_size>"
16952 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3599
16953 msgid "Size of the partition in bytes."
16958 #: ../src/guestfs-actions.pod:5420
16960 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16961 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16967 #: ../src/guestfs-actions.pod:5426
16968 msgid "guestfs_part_set_bootable"
16973 #: ../src/guestfs-actions.pod:5428
16977 " guestfs_part_set_bootable (guestfs_h *g,\n"
16978 " const char *device,\n"
16980 " int bootable);\n"
16986 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3607
16988 "This sets the bootable flag on partition numbered C<partnum> on device "
16989 "C<device>. Note that partitions are numbered from 1."
16994 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3610
16996 "The bootable flag is used by some operating systems (notably Windows) to "
16997 "determine which partition to boot from. It is by no means universally "
17003 #: ../src/guestfs-actions.pod:5445
17004 msgid "guestfs_part_set_mbr_id"
17009 #: ../src/guestfs-actions.pod:5447
17013 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
17014 " const char *device,\n"
17022 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3618
17024 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
17025 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
17026 "documentation are in fact hexadecimal numbers, but usually documented "
17027 "without any leading \"0x\" which might be confusing."
17032 #: ../src/guestfs-actions.pod:5467
17033 msgid "guestfs_part_set_name"
17038 #: ../src/guestfs-actions.pod:5469
17042 " guestfs_part_set_name (guestfs_h *g,\n"
17043 " const char *device,\n"
17045 " const char *name);\n"
17051 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3632
17053 "This sets the partition name on partition numbered C<partnum> on device "
17054 "C<device>. Note that partitions are numbered from 1."
17059 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3635
17061 "The partition name can only be set on certain types of partition table. "
17062 "This works on C<gpt> but not on C<mbr> partitions."
17067 #: ../src/guestfs-actions.pod:5485
17068 msgid "guestfs_part_to_dev"
17073 #: ../src/guestfs-actions.pod:5487
17077 " guestfs_part_to_dev (guestfs_h *g,\n"
17078 " const char *partition);\n"
17084 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3642
17086 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
17087 "partition number, returning the device name (eg. \"/dev/sdb\")."
17092 #: ../src/guestfs-actions.pod:5495
17094 "The named partition must exist, for example as a string returned from "
17095 "C<guestfs_list_partitions>."
17100 #: ../src/guestfs-actions.pod:5503
17101 msgid "guestfs_ping_daemon"
17106 #: ../src/guestfs-actions.pod:5505
17110 " guestfs_ping_daemon (guestfs_h *g);\n"
17116 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3653
17118 "This is a test probe into the guestfs daemon running inside the qemu "
17119 "subprocess. Calling this function checks that the daemon responds to the "
17120 "ping message, without affecting the daemon or attached block device(s) in "
17126 #: ../src/guestfs-actions.pod:5517
17127 msgid "guestfs_pread"
17132 #: ../src/guestfs-actions.pod:5519
17136 " guestfs_pread (guestfs_h *g,\n"
17137 " const char *path,\n"
17139 " int64_t offset,\n"
17140 " size_t *size_r);\n"
17146 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3662
17148 "This command lets you read part of a file. It reads C<count> bytes of the "
17149 "file, starting at C<offset>, from file C<path>."
17154 #: ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5555
17155 #: ../fish/guestfish-actions.pod:3665 ../fish/guestfish-actions.pod:3680
17157 "This may read fewer bytes than requested. For further details see the "
17158 "L<pread(2)> system call."
17163 #: ../src/guestfs-actions.pod:5532
17164 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
17169 #: ../src/guestfs-actions.pod:5543
17170 msgid "guestfs_pread_device"
17175 #: ../src/guestfs-actions.pod:5545
17179 " guestfs_pread_device (guestfs_h *g,\n"
17180 " const char *device,\n"
17182 " int64_t offset,\n"
17183 " size_t *size_r);\n"
17189 #: ../src/guestfs-actions.pod:5552 ../fish/guestfish-actions.pod:3677
17191 "This command lets you read part of a file. It reads C<count> bytes of "
17192 "C<device>, starting at C<offset>."
17197 #: ../src/guestfs-actions.pod:5558
17198 msgid "See also C<guestfs_pread>."
17203 #: ../src/guestfs-actions.pod:5567
17204 msgid "(Added in 1.5.21)"
17209 #: ../src/guestfs-actions.pod:5569
17210 msgid "guestfs_pvcreate"
17215 #: ../src/guestfs-actions.pod:5571
17219 " guestfs_pvcreate (guestfs_h *g,\n"
17220 " const char *device);\n"
17226 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3692
17228 "This creates an LVM physical volume on the named C<device>, where C<device> "
17229 "should usually be a partition name such as C</dev/sda1>."
17234 #: ../src/guestfs-actions.pod:5583
17235 msgid "guestfs_pvremove"
17240 #: ../src/guestfs-actions.pod:5585
17244 " guestfs_pvremove (guestfs_h *g,\n"
17245 " const char *device);\n"
17251 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3700
17253 "This wipes a physical volume C<device> so that LVM will no longer recognise "
17259 #: ../src/guestfs-actions.pod:5592 ../fish/guestfish-actions.pod:3703
17261 "The implementation uses the C<pvremove> command which refuses to wipe "
17262 "physical volumes that contain any volume groups, so you have to remove those "
17268 #: ../src/guestfs-actions.pod:5600
17269 msgid "guestfs_pvresize"
17274 #: ../src/guestfs-actions.pod:5602
17278 " guestfs_pvresize (guestfs_h *g,\n"
17279 " const char *device);\n"
17285 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3711
17287 "This resizes (expands or shrinks) an existing LVM physical volume to match "
17288 "the new size of the underlying device."
17293 #: ../src/guestfs-actions.pod:5613
17294 msgid "guestfs_pvresize_size"
17299 #: ../src/guestfs-actions.pod:5615
17303 " guestfs_pvresize_size (guestfs_h *g,\n"
17304 " const char *device,\n"
17305 " int64_t size);\n"
17311 #: ../src/guestfs-actions.pod:5620
17313 "This command is the same as C<guestfs_pvresize> except that it allows you to "
17314 "specify the new size (in bytes) explicitly."
17319 #: ../src/guestfs-actions.pod:5627
17320 msgid "guestfs_pvs"
17325 #: ../src/guestfs-actions.pod:5629
17329 " guestfs_pvs (guestfs_h *g);\n"
17335 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3725
17337 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17343 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3728
17345 "This returns a list of just the device names that contain PVs (eg. C</dev/"
17351 #: ../src/guestfs-actions.pod:5638
17352 msgid "See also C<guestfs_pvs_full>."
17357 #: ../src/guestfs-actions.pod:5646
17358 msgid "guestfs_pvs_full"
17363 #: ../src/guestfs-actions.pod:5648
17366 " struct guestfs_lvm_pv_list *\n"
17367 " guestfs_pvs_full (guestfs_h *g);\n"
17373 #: ../src/guestfs-actions.pod:5651 ../fish/guestfish-actions.pod:3737
17375 "List all the physical volumes detected. This is the equivalent of the L<pvs"
17376 "(8)> command. The \"full\" version includes all fields."
17381 #: ../src/guestfs-actions.pod:5654
17383 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
17384 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
17389 #: ../src/guestfs-actions.pod:5660
17390 msgid "guestfs_pvuuid"
17395 #: ../src/guestfs-actions.pod:5662
17399 " guestfs_pvuuid (guestfs_h *g,\n"
17400 " const char *device);\n"
17406 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3744
17407 msgid "This command returns the UUID of the LVM PV C<device>."
17412 #: ../src/guestfs-actions.pod:5673
17413 msgid "guestfs_pwrite"
17418 #: ../src/guestfs-actions.pod:5675
17422 " guestfs_pwrite (guestfs_h *g,\n"
17423 " const char *path,\n"
17424 " const char *content,\n"
17425 " size_t content_size,\n"
17426 " int64_t offset);\n"
17432 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3750
17434 "This command writes to part of a file. It writes the data buffer C<content> "
17435 "to the file C<path> starting at offset C<offset>."
17440 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3753
17442 "This command implements the L<pwrite(2)> system call, and like that system "
17443 "call it may not write the full data requested. The return value is the "
17444 "number of bytes that were actually written to the file. This could even be "
17445 "0, although short writes are unlikely for regular files in ordinary "
17451 #: ../src/guestfs-actions.pod:5691
17452 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
17457 #: ../src/guestfs-actions.pod:5700
17458 msgid "guestfs_pwrite_device"
17463 #: ../src/guestfs-actions.pod:5702
17467 " guestfs_pwrite_device (guestfs_h *g,\n"
17468 " const char *device,\n"
17469 " const char *content,\n"
17470 " size_t content_size,\n"
17471 " int64_t offset);\n"
17477 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3768
17479 "This command writes to part of a device. It writes the data buffer "
17480 "C<content> to C<device> starting at offset C<offset>."
17485 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3771
17487 "This command implements the L<pwrite(2)> system call, and like that system "
17488 "call it may not write the full data requested (although short writes to disk "
17489 "devices and partitions are probably impossible with standard Linux kernels)."
17494 #: ../src/guestfs-actions.pod:5717
17495 msgid "See also C<guestfs_pwrite>."
17500 #: ../src/guestfs-actions.pod:5724
17501 msgid "(Added in 1.5.20)"
17506 #: ../src/guestfs-actions.pod:5726
17507 msgid "guestfs_read_file"
17512 #: ../src/guestfs-actions.pod:5728
17516 " guestfs_read_file (guestfs_h *g,\n"
17517 " const char *path,\n"
17518 " size_t *size_r);\n"
17524 #: ../src/guestfs-actions.pod:5733 ../fish/guestfish-actions.pod:3785
17525 msgid "This calls returns the contents of the file C<path> as a buffer."
17530 #: ../src/guestfs-actions.pod:5736
17532 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
17533 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
17534 "function is limited in the total size of file that can be handled."
17539 #: ../src/guestfs-actions.pod:5748
17540 msgid "(Added in 1.0.63)"
17545 #: ../src/guestfs-actions.pod:5750
17546 msgid "guestfs_read_lines"
17551 #: ../src/guestfs-actions.pod:5752
17555 " guestfs_read_lines (guestfs_h *g,\n"
17556 " const char *path);\n"
17562 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3802
17564 "The file contents are returned as a list of lines. Trailing C<LF> and "
17565 "C<CRLF> character sequences are I<not> returned."
17570 #: ../src/guestfs-actions.pod:5761
17572 "Note that this function cannot correctly handle binary files (specifically, "
17573 "files containing C<\\0> character which is treated as end of line). For "
17574 "those you need to use the C<guestfs_read_file> function which has a more "
17575 "complex interface."
17580 #: ../src/guestfs-actions.pod:5772
17581 msgid "guestfs_readdir"
17586 #: ../src/guestfs-actions.pod:5774
17589 " struct guestfs_dirent_list *\n"
17590 " guestfs_readdir (guestfs_h *g,\n"
17591 " const char *dir);\n"
17597 #: ../src/guestfs-actions.pod:5778 ../fish/guestfish-actions.pod:3814
17598 msgid "This returns the list of directory entries in directory C<dir>."
17603 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3816
17605 "All entries in the directory are returned, including C<.> and C<..>. The "
17606 "entries are I<not> sorted, but returned in the same order as the underlying "
17612 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3820
17614 "Also this call returns basic file type information about each file. The "
17615 "C<ftyp> field will contain one of the following characters:"
17620 #: ../src/guestfs-actions.pod:5789 ../fish/guestfish-actions.pod:3825
17626 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3827
17627 msgid "Block special"
17632 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3829
17638 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3831
17639 msgid "Char special"
17644 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3833
17650 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3835
17656 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3837
17662 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3839
17663 msgid "FIFO (named pipe)"
17668 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3841
17674 #: ../src/guestfs-actions.pod:5807 ../fish/guestfish-actions.pod:3843
17675 msgid "Symbolic link"
17680 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3845
17686 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3847
17687 msgid "Regular file"
17692 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3849
17698 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3851
17704 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:3853
17710 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3855
17711 msgid "Unknown file type"
17716 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3857
17722 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3859
17724 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17729 #: ../src/guestfs-actions.pod:5828
17731 "This function is primarily intended for use by programs. To get a simple "
17732 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17733 "consumption, use C<guestfs_ll>."
17738 #: ../src/guestfs-actions.pod:5832
17740 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17741 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17746 #: ../src/guestfs-actions.pod:5838
17747 msgid "guestfs_readlink"
17752 #: ../src/guestfs-actions.pod:5840
17756 " guestfs_readlink (guestfs_h *g,\n"
17757 " const char *path);\n"
17763 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3872
17764 msgid "This command reads the target of a symbolic link."
17769 #: ../src/guestfs-actions.pod:5851
17770 msgid "guestfs_readlinklist"
17775 #: ../src/guestfs-actions.pod:5853
17779 " guestfs_readlinklist (guestfs_h *g,\n"
17780 " const char *path,\n"
17781 " char *const *names);\n"
17787 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3878
17789 "This call allows you to do a C<readlink> operation on multiple files, where "
17790 "all files are in the directory C<path>. C<names> is the list of files from "
17796 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3882
17798 "On return you get a list of strings, with a one-to-one correspondence to the "
17799 "C<names> list. Each string is the value of the symbolic link."
17804 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3886
17806 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17807 "result string is the empty string C<\"\">. However the whole operation is "
17808 "completed even if there were C<readlink(2)> errors, and so you can call this "
17809 "function with names where you don't know if they are symbolic links already "
17810 "(albeit slightly less efficient)."
17815 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3893
17817 "This call is intended for programs that want to efficiently list a directory "
17818 "contents without making many round-trips. Very long directory listings "
17819 "might cause the protocol message size to be exceeded, causing this call to "
17820 "fail. The caller must split up such requests into smaller groups of names."
17825 #: ../src/guestfs-actions.pod:5886
17826 msgid "guestfs_realpath"
17831 #: ../src/guestfs-actions.pod:5888
17835 " guestfs_realpath (guestfs_h *g,\n"
17836 " const char *path);\n"
17842 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3904
17844 "Return the canonicalized absolute pathname of C<path>. The returned path "
17845 "has no C<.>, C<..> or symbolic link path elements."
17850 #: ../src/guestfs-actions.pod:5900
17851 msgid "guestfs_removexattr"
17856 #: ../src/guestfs-actions.pod:5902
17860 " guestfs_removexattr (guestfs_h *g,\n"
17861 " const char *xattr,\n"
17862 " const char *path);\n"
17868 #: ../src/guestfs-actions.pod:5907 ../fish/guestfish-actions.pod:3911
17870 "This call removes the extended attribute named C<xattr> of the file C<path>."
17875 #: ../src/guestfs-actions.pod:5910
17876 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17881 #: ../src/guestfs-actions.pod:5916
17882 msgid "guestfs_resize2fs"
17887 #: ../src/guestfs-actions.pod:5918
17891 " guestfs_resize2fs (guestfs_h *g,\n"
17892 " const char *device);\n"
17898 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:3920
17900 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17901 "underlying device."
17906 #: ../src/guestfs-actions.pod:5925
17908 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17909 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17910 "sometimes gives an error about this and sometimes not. In any case, it is "
17911 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17915 #: ../src/guestfs-actions.pod:5935
17916 msgid "guestfs_resize2fs_M"
17920 #: ../src/guestfs-actions.pod:5937
17924 " guestfs_resize2fs_M (guestfs_h *g,\n"
17925 " const char *device);\n"
17930 #: ../src/guestfs-actions.pod:5941
17932 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17933 "resized to its minimum size. This works like the I<-M> option to the "
17934 "C<resize2fs> command."
17938 #: ../src/guestfs-actions.pod:5945
17940 "To get the resulting size of the filesystem you should call "
17941 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17942 "These two numbers, multiplied together, give the resulting size of the "
17943 "minimal filesystem in bytes."
17948 #: ../src/guestfs-actions.pod:5954
17949 msgid "guestfs_resize2fs_size"
17954 #: ../src/guestfs-actions.pod:5956
17958 " guestfs_resize2fs_size (guestfs_h *g,\n"
17959 " const char *device,\n"
17960 " int64_t size);\n"
17966 #: ../src/guestfs-actions.pod:5961
17968 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17969 "to specify the new size (in bytes) explicitly."
17974 #: ../src/guestfs-actions.pod:5968
17980 #: ../src/guestfs-actions.pod:5970
17984 " guestfs_rm (guestfs_h *g,\n"
17985 " const char *path);\n"
17991 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3953
17992 msgid "Remove the single file C<path>."
17997 #: ../src/guestfs-actions.pod:5980
17998 msgid "guestfs_rm_rf"
18003 #: ../src/guestfs-actions.pod:5982
18007 " guestfs_rm_rf (guestfs_h *g,\n"
18008 " const char *path);\n"
18014 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3959
18016 "Remove the file or directory C<path>, recursively removing the contents if "
18017 "its a directory. This is like the C<rm -rf> shell command."
18022 #: ../src/guestfs-actions.pod:5994
18023 msgid "guestfs_rmdir"
18028 #: ../src/guestfs-actions.pod:5996
18032 " guestfs_rmdir (guestfs_h *g,\n"
18033 " const char *path);\n"
18039 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:3967
18040 msgid "Remove the single directory C<path>."
18045 #: ../src/guestfs-actions.pod:6006
18046 msgid "guestfs_rmmountpoint"
18051 #: ../src/guestfs-actions.pod:6008
18055 " guestfs_rmmountpoint (guestfs_h *g,\n"
18056 " const char *exemptpath);\n"
18062 #: ../src/guestfs-actions.pod:6012
18064 "This calls removes a mountpoint that was previously created with "
18065 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
18070 #: ../src/guestfs-actions.pod:6020
18071 msgid "guestfs_scrub_device"
18076 #: ../src/guestfs-actions.pod:6022
18080 " guestfs_scrub_device (guestfs_h *g,\n"
18081 " const char *device);\n"
18087 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:3981
18089 "This command writes patterns over C<device> to make data retrieval more "
18095 #: ../src/guestfs-actions.pod:6029 ../src/guestfs-actions.pod:6050
18096 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:3984
18097 #: ../fish/guestfish-actions.pod:3999 ../fish/guestfish-actions.pod:4012
18099 "It is an interface to the L<scrub(1)> program. See that manual page for "
18105 #: ../src/guestfs-actions.pod:6037 ../src/guestfs-actions.pod:6055
18106 #: ../src/guestfs-actions.pod:6074
18107 msgid "(Added in 1.0.52)"
18112 #: ../src/guestfs-actions.pod:6039
18113 msgid "guestfs_scrub_file"
18118 #: ../src/guestfs-actions.pod:6041
18122 " guestfs_scrub_file (guestfs_h *g,\n"
18123 " const char *file);\n"
18129 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:3994
18131 "This command writes patterns over a file to make data retrieval more "
18137 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:3997
18138 msgid "The file is I<removed> after scrubbing."
18143 #: ../src/guestfs-actions.pod:6057
18144 msgid "guestfs_scrub_freespace"
18149 #: ../src/guestfs-actions.pod:6059
18153 " guestfs_scrub_freespace (guestfs_h *g,\n"
18154 " const char *dir);\n"
18160 #: ../src/guestfs-actions.pod:6063
18162 "This command creates the directory C<dir> and then fills it with files until "
18163 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
18164 "and deletes them. The intention is to scrub any free space on the partition "
18165 "containing C<dir>."
18170 #: ../src/guestfs-actions.pod:6076
18171 msgid "guestfs_set_append"
18176 #: ../src/guestfs-actions.pod:6078
18180 " guestfs_set_append (guestfs_h *g,\n"
18181 " const char *append);\n"
18187 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4021
18189 "This function is used to add additional options to the guest kernel command "
18195 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4024
18197 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
18198 "environment variable."
18203 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4027
18205 "Setting C<append> to C<NULL> means I<no> additional options are passed "
18206 "(libguestfs always adds a few of its own)."
18210 #: ../src/guestfs-actions.pod:6095
18211 msgid "guestfs_set_attach_method"
18215 #: ../src/guestfs-actions.pod:6097
18219 " guestfs_set_attach_method (guestfs_h *g,\n"
18220 " const char *attachmethod);\n"
18225 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4036
18227 "Set the method that libguestfs uses to connect to the back end guestfsd "
18228 "daemon. Possible methods are:"
18232 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4043
18234 "Launch an appliance and connect to it. This is the ordinary method and the "
18239 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4046
18240 msgid "C<unix:I<path>>"
18244 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4048
18245 msgid "Connect to the Unix domain socket I<path>."
18249 #: ../src/guestfs-actions.pod:6115 ../fish/guestfish-actions.pod:4050
18251 "This method lets you connect to an existing daemon or (using virtio-serial) "
18252 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
18253 "RUNNING DAEMONS>."
18258 #: ../src/guestfs-actions.pod:6125
18259 msgid "guestfs_set_autosync"
18264 #: ../src/guestfs-actions.pod:6127
18268 " guestfs_set_autosync (guestfs_h *g,\n"
18269 " int autosync);\n"
18274 #: ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:4062
18276 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
18277 "effort attempt to make filesystems consistent and synchronized when the "
18278 "handle is closed (also if the program exits without closing handles)."
18283 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4067
18285 "This is enabled by default (since libguestfs 1.5.24, previously it was "
18286 "disabled by default)."
18291 #: ../src/guestfs-actions.pod:6143
18292 msgid "guestfs_set_direct"
18297 #: ../src/guestfs-actions.pod:6145
18301 " guestfs_set_direct (guestfs_h *g,\n"
18308 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4076
18310 "If the direct appliance mode flag is enabled, then stdin and stdout are "
18311 "passed directly through to the appliance once it is launched."
18316 #: ../src/guestfs-actions.pod:6153
18318 "One consequence of this is that log messages aren't caught by the library "
18319 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
18325 #: ../src/guestfs-actions.pod:6157 ../fish/guestfish-actions.pod:4084
18326 msgid "You probably don't want to use this unless you know what you are doing."
18331 #: ../src/guestfs-actions.pod:6160 ../fish/guestfish-actions.pod:4087
18332 msgid "The default is disabled."
18337 #: ../src/guestfs-actions.pod:6166
18338 msgid "guestfs_set_e2label"
18343 #: ../src/guestfs-actions.pod:6168
18347 " guestfs_set_e2label (guestfs_h *g,\n"
18348 " const char *device,\n"
18349 " const char *label);\n"
18355 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4093
18357 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
18358 "C<label>. Filesystem labels are limited to 16 characters."
18363 #: ../src/guestfs-actions.pod:6177
18365 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
18366 "the existing label on a filesystem."
18371 #: ../src/guestfs-actions.pod:6184
18372 msgid "guestfs_set_e2uuid"
18377 #: ../src/guestfs-actions.pod:6186
18381 " guestfs_set_e2uuid (guestfs_h *g,\n"
18382 " const char *device,\n"
18383 " const char *uuid);\n"
18389 #: ../src/guestfs-actions.pod:6191 ../fish/guestfish-actions.pod:4104
18391 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
18392 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
18393 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
18398 #: ../src/guestfs-actions.pod:6196
18400 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
18401 "the existing UUID of a filesystem."
18406 #: ../src/guestfs-actions.pod:6203
18407 msgid "guestfs_set_memsize"
18412 #: ../src/guestfs-actions.pod:6205
18416 " guestfs_set_memsize (guestfs_h *g,\n"
18423 #: ../src/guestfs-actions.pod:6209
18425 "This sets the memory size in megabytes allocated to the qemu subprocess. "
18426 "This only has any effect if called before C<guestfs_launch>."
18431 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4122
18433 "You can also change this by setting the environment variable "
18434 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
18439 #: ../src/guestfs-actions.pod:6224
18440 msgid "guestfs_set_network"
18445 #: ../src/guestfs-actions.pod:6226
18449 " guestfs_set_network (guestfs_h *g,\n"
18456 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4135
18458 "If C<network> is true, then the network is enabled in the libguestfs "
18459 "appliance. The default is false."
18464 #: ../src/guestfs-actions.pod:6233 ../fish/guestfish-actions.pod:4138
18466 "This affects whether commands are able to access the network (see L<guestfs"
18467 "(3)/RUNNING COMMANDS>)."
18472 #: ../src/guestfs-actions.pod:6236
18474 "You must call this before calling C<guestfs_launch>, otherwise it has no "
18480 #: ../src/guestfs-actions.pod:6243
18481 msgid "guestfs_set_path"
18486 #: ../src/guestfs-actions.pod:6245
18490 " guestfs_set_path (guestfs_h *g,\n"
18491 " const char *searchpath);\n"
18497 #: ../src/guestfs-actions.pod:6249 ../fish/guestfish-actions.pod:4150
18498 msgid "Set the path that libguestfs searches for kernel and initrd.img."
18503 #: ../src/guestfs-actions.pod:6251 ../fish/guestfish-actions.pod:4152
18505 "The default is C<$libdir/guestfs> unless overridden by setting "
18506 "C<LIBGUESTFS_PATH> environment variable."
18511 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4155
18512 msgid "Setting C<path> to C<NULL> restores the default path."
18517 #: ../src/guestfs-actions.pod:6260
18518 msgid "guestfs_set_qemu"
18523 #: ../src/guestfs-actions.pod:6262
18527 " guestfs_set_qemu (guestfs_h *g,\n"
18528 " const char *qemu);\n"
18534 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4163
18535 msgid "Set the qemu binary that we will use."
18540 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4165
18542 "The default is chosen when the library was compiled by the configure script."
18547 #: ../src/guestfs-actions.pod:6271 ../fish/guestfish-actions.pod:4168
18549 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18555 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4171
18556 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18561 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4173
18563 "Note that you should call this function as early as possible after creating "
18564 "the handle. This is because some pre-launch operations depend on testing "
18565 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18566 "don't retest features, and so you might see inconsistent results. Using the "
18567 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18568 "the qemu binary at the same time as the handle is created."
18573 #: ../src/guestfs-actions.pod:6288
18574 msgid "guestfs_set_recovery_proc"
18579 #: ../src/guestfs-actions.pod:6290
18583 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18584 " int recoveryproc);\n"
18590 #: ../src/guestfs-actions.pod:6294
18592 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18593 "not create a recovery process. The purpose of the recovery process is to "
18594 "stop runaway qemu processes in the case where the main program aborts "
18600 #: ../src/guestfs-actions.pod:6299
18602 "This only has any effect if called before C<guestfs_launch>, and the default "
18608 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4195
18610 "About the only time when you would want to disable this is if the main "
18611 "process will fork itself into the background (\"daemonize\" itself). In "
18612 "this case the recovery process thinks that the main program has disappeared "
18613 "and so kills qemu, which is not very helpful."
18618 #: ../src/guestfs-actions.pod:6312
18619 msgid "guestfs_set_selinux"
18624 #: ../src/guestfs-actions.pod:6314
18628 " guestfs_set_selinux (guestfs_h *g,\n"
18635 #: ../src/guestfs-actions.pod:6318 ../fish/guestfish-actions.pod:4207
18637 "This sets the selinux flag that is passed to the appliance at boot time. "
18638 "The default is C<selinux=0> (disabled)."
18643 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4210
18645 "Note that if SELinux is enabled, it is always in Permissive mode "
18646 "(C<enforcing=0>)."
18651 #: ../src/guestfs-actions.pod:6331
18652 msgid "guestfs_set_trace"
18657 #: ../src/guestfs-actions.pod:6333
18661 " guestfs_set_trace (guestfs_h *g,\n"
18667 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4222
18669 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18670 "return values are traced."
18675 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4225
18677 "If you want to trace C API calls into libguestfs (and other libraries) then "
18678 "possibly a better way is to use the external ltrace(1) command."
18683 #: ../src/guestfs-actions.pod:6344 ../fish/guestfish-actions.pod:4229
18685 "Command traces are disabled unless the environment variable "
18686 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18690 #: ../src/guestfs-actions.pod:6347
18692 "Trace messages are normally sent to C<stderr>, unless you register a "
18693 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18698 #: ../src/guestfs-actions.pod:6355
18699 msgid "guestfs_set_verbose"
18704 #: ../src/guestfs-actions.pod:6357
18708 " guestfs_set_verbose (guestfs_h *g,\n"
18714 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4242
18715 msgid "If C<verbose> is true, this turns on verbose messages."
18720 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4244
18722 "Verbose messages are disabled unless the environment variable "
18723 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18727 #: ../src/guestfs-actions.pod:6366
18729 "Verbose messages are normally sent to C<stderr>, unless you register a "
18730 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18735 #: ../src/guestfs-actions.pod:6374
18736 msgid "guestfs_setcon"
18741 #: ../src/guestfs-actions.pod:6376
18745 " guestfs_setcon (guestfs_h *g,\n"
18746 " const char *context);\n"
18752 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4255
18754 "This sets the SELinux security context of the daemon to the string "
18760 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4258
18761 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18766 #: ../src/guestfs-actions.pod:6389
18767 msgid "guestfs_setxattr"
18772 #: ../src/guestfs-actions.pod:6391
18776 " guestfs_setxattr (guestfs_h *g,\n"
18777 " const char *xattr,\n"
18778 " const char *val,\n"
18780 " const char *path);\n"
18786 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4264
18788 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18789 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18794 #: ../src/guestfs-actions.pod:6402
18795 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18800 #: ../src/guestfs-actions.pod:6408
18801 msgid "guestfs_sfdisk"
18806 #: ../src/guestfs-actions.pod:6410
18810 " guestfs_sfdisk (guestfs_h *g,\n"
18811 " const char *device,\n"
18815 " char *const *lines);\n"
18821 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4274
18823 "This is a direct interface to the L<sfdisk(8)> program for creating "
18824 "partitions on block devices."
18829 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4277
18830 msgid "C<device> should be a block device, for example C</dev/sda>."
18835 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4279
18837 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18838 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18839 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18840 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18841 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18842 "the kernel) cannot work out the right geometry and you will need to tell it."
18847 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4287
18849 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18850 "refer to the L<sfdisk(8)> manpage."
18855 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4290
18857 "To create a single partition occupying the whole disk, you would pass "
18858 "C<lines> as a single element list, when the single element being the string "
18864 #: ../src/guestfs-actions.pod:6438
18866 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18870 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6476
18871 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4300
18872 #: ../fish/guestfish-actions.pod:4323 ../fish/guestfish-actions.pod:4345
18874 "This function is deprecated. In new code, use the C<part_add> call instead."
18879 #: ../src/guestfs-actions.pod:6455
18880 msgid "guestfs_sfdiskM"
18885 #: ../src/guestfs-actions.pod:6457
18889 " guestfs_sfdiskM (guestfs_h *g,\n"
18890 " const char *device,\n"
18891 " char *const *lines);\n"
18897 #: ../src/guestfs-actions.pod:6462
18899 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18900 "partition sizes are specified in megabytes only (rounded to the nearest "
18901 "cylinder) and you don't need to specify the cyls, heads and sectors "
18902 "parameters which were rarely if ever used anyway."
18907 #: ../src/guestfs-actions.pod:6468
18909 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18910 "C<guestfs_part_disk>"
18915 #: ../src/guestfs-actions.pod:6485
18916 msgid "guestfs_sfdisk_N"
18921 #: ../src/guestfs-actions.pod:6487
18925 " guestfs_sfdisk_N (guestfs_h *g,\n"
18926 " const char *device,\n"
18931 " const char *line);\n"
18937 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4334
18939 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18940 "(note: C<n> counts from 1)."
18945 #: ../src/guestfs-actions.pod:6499
18947 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18948 "for the cyls/heads/sectors parameters."
18953 #: ../src/guestfs-actions.pod:6502
18954 msgid "See also: C<guestfs_part_add>"
18959 #: ../src/guestfs-actions.pod:6518
18960 msgid "guestfs_sfdisk_disk_geometry"
18965 #: ../src/guestfs-actions.pod:6520
18969 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18970 " const char *device);\n"
18976 #: ../src/guestfs-actions.pod:6524
18978 "This displays the disk geometry of C<device> read from the partition table. "
18979 "Especially in the case where the underlying block device has been resized, "
18980 "this can be different from the kernel's idea of the geometry (see "
18981 "C<guestfs_sfdisk_kernel_geometry>)."
18986 #: ../src/guestfs-actions.pod:6529 ../src/guestfs-actions.pod:6545
18987 #: ../fish/guestfish-actions.pod:4361 ../fish/guestfish-actions.pod:4370
18988 msgid "The result is in human-readable format, and not designed to be parsed."
18993 #: ../src/guestfs-actions.pod:6537
18994 msgid "guestfs_sfdisk_kernel_geometry"
18999 #: ../src/guestfs-actions.pod:6539
19003 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
19004 " const char *device);\n"
19010 #: ../src/guestfs-actions.pod:6543 ../fish/guestfish-actions.pod:4368
19011 msgid "This displays the kernel's idea of the geometry of C<device>."
19016 #: ../src/guestfs-actions.pod:6553
19017 msgid "guestfs_sfdisk_l"
19022 #: ../src/guestfs-actions.pod:6555
19026 " guestfs_sfdisk_l (guestfs_h *g,\n"
19027 " const char *device);\n"
19033 #: ../src/guestfs-actions.pod:6559 ../fish/guestfish-actions.pod:4377
19035 "This displays the partition table on C<device>, in the human-readable output "
19036 "of the L<sfdisk(8)> command. It is not intended to be parsed."
19041 #: ../src/guestfs-actions.pod:6563
19042 msgid "See also: C<guestfs_part_list>"
19046 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4383
19048 "This function is deprecated. In new code, use the C<part_list> call instead."
19053 #: ../src/guestfs-actions.pod:6577
19059 #: ../src/guestfs-actions.pod:6579
19063 " guestfs_sh (guestfs_h *g,\n"
19064 " const char *command);\n"
19070 #: ../src/guestfs-actions.pod:6583 ../fish/guestfish-actions.pod:4394
19072 "This call runs a command from the guest filesystem via the guest's C</bin/"
19078 #: ../src/guestfs-actions.pod:6586
19079 msgid "This is like C<guestfs_command>, but passes the command to:"
19084 #: ../src/guestfs-actions.pod:6588 ../fish/guestfish-actions.pod:4399
19087 " /bin/sh -c \"command\"\n"
19093 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4401
19095 "Depending on the guest's shell, this usually results in wildcards being "
19096 "expanded, shell expressions being interpolated and so on."
19101 #: ../src/guestfs-actions.pod:6594
19102 msgid "All the provisos about C<guestfs_command> apply to this call."
19107 #: ../src/guestfs-actions.pod:6601
19108 msgid "guestfs_sh_lines"
19113 #: ../src/guestfs-actions.pod:6603
19117 " guestfs_sh_lines (guestfs_h *g,\n"
19118 " const char *command);\n"
19124 #: ../src/guestfs-actions.pod:6607
19126 "This is the same as C<guestfs_sh>, but splits the result into a list of "
19132 #: ../src/guestfs-actions.pod:6610
19133 msgid "See also: C<guestfs_command_lines>"
19138 #: ../src/guestfs-actions.pod:6618
19139 msgid "guestfs_sleep"
19144 #: ../src/guestfs-actions.pod:6620
19148 " guestfs_sleep (guestfs_h *g,\n"
19155 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4420
19156 msgid "Sleep for C<secs> seconds."
19161 #: ../src/guestfs-actions.pod:6628
19162 msgid "(Added in 1.0.41)"
19167 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-structs.pod:109
19168 msgid "guestfs_stat"
19173 #: ../src/guestfs-actions.pod:6632
19176 " struct guestfs_stat *\n"
19177 " guestfs_stat (guestfs_h *g,\n"
19178 " const char *path);\n"
19184 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4428
19185 msgid "This is the same as the C<stat(2)> system call."
19190 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-structs.pod:135
19191 msgid "guestfs_statvfs"
19196 #: ../src/guestfs-actions.pod:6648
19199 " struct guestfs_statvfs *\n"
19200 " guestfs_statvfs (guestfs_h *g,\n"
19201 " const char *path);\n"
19207 #: ../src/guestfs-actions.pod:6652 ../fish/guestfish-actions.pod:4434
19209 "Returns file system statistics for any mounted file system. C<path> should "
19210 "be a file or directory in the mounted file system (typically it is the mount "
19211 "point itself, but it doesn't need to be)."
19216 #: ../src/guestfs-actions.pod:6656 ../fish/guestfish-actions.pod:4438
19217 msgid "This is the same as the C<statvfs(2)> system call."
19222 #: ../src/guestfs-actions.pod:6658
19224 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
19225 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
19230 #: ../src/guestfs-actions.pod:6664
19231 msgid "guestfs_strings"
19236 #: ../src/guestfs-actions.pod:6666
19240 " guestfs_strings (guestfs_h *g,\n"
19241 " const char *path);\n"
19247 #: ../src/guestfs-actions.pod:6670 ../fish/guestfish-actions.pod:4444
19249 "This runs the L<strings(1)> command on a file and returns the list of "
19250 "printable strings found."
19255 #: ../src/guestfs-actions.pod:6682
19256 msgid "guestfs_strings_e"
19261 #: ../src/guestfs-actions.pod:6684
19265 " guestfs_strings_e (guestfs_h *g,\n"
19266 " const char *encoding,\n"
19267 " const char *path);\n"
19273 #: ../src/guestfs-actions.pod:6689
19275 "This is like the C<guestfs_strings> command, but allows you to specify the "
19276 "encoding of strings that are looked for in the source file C<path>."
19281 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4458
19282 msgid "Allowed encodings are:"
19287 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4462
19293 #: ../src/guestfs-actions.pod:6699
19295 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
19296 "ISO-8859-X (this is what C<guestfs_strings> uses)."
19301 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4467
19307 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4469
19308 msgid "Single 8-bit-byte characters."
19313 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4471
19319 #: ../src/guestfs-actions.pod:6708 ../fish/guestfish-actions.pod:4473
19320 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
19325 #: ../src/guestfs-actions.pod:6711 ../fish/guestfish-actions.pod:4476
19326 msgid "l (lower case letter L)"
19331 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4478
19333 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
19334 "examining binaries in Windows guests."
19339 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4481
19345 #: ../src/guestfs-actions.pod:6718 ../fish/guestfish-actions.pod:4483
19346 msgid "32-bit big endian such as UCS-4BE."
19351 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4485
19357 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4487
19358 msgid "32-bit little endian such as UCS-4LE."
19363 #: ../src/guestfs-actions.pod:6726 ../fish/guestfish-actions.pod:4491
19364 msgid "The returned strings are transcoded to UTF-8."
19369 #: ../src/guestfs-actions.pod:6737
19370 msgid "guestfs_swapoff_device"
19375 #: ../src/guestfs-actions.pod:6739
19379 " guestfs_swapoff_device (guestfs_h *g,\n"
19380 " const char *device);\n"
19386 #: ../src/guestfs-actions.pod:6743
19388 "This command disables the libguestfs appliance swap device or partition "
19389 "named C<device>. See C<guestfs_swapon_device>."
19394 #: ../src/guestfs-actions.pod:6751
19395 msgid "guestfs_swapoff_file"
19400 #: ../src/guestfs-actions.pod:6753
19404 " guestfs_swapoff_file (guestfs_h *g,\n"
19405 " const char *file);\n"
19411 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4508
19412 msgid "This command disables the libguestfs appliance swap on file."
19417 #: ../src/guestfs-actions.pod:6763
19418 msgid "guestfs_swapoff_label"
19423 #: ../src/guestfs-actions.pod:6765
19427 " guestfs_swapoff_label (guestfs_h *g,\n"
19428 " const char *label);\n"
19434 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4514
19436 "This command disables the libguestfs appliance swap on labeled swap "
19442 #: ../src/guestfs-actions.pod:6776
19443 msgid "guestfs_swapoff_uuid"
19448 #: ../src/guestfs-actions.pod:6778
19452 " guestfs_swapoff_uuid (guestfs_h *g,\n"
19453 " const char *uuid);\n"
19459 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4521
19461 "This command disables the libguestfs appliance swap partition with the given "
19467 #: ../src/guestfs-actions.pod:6789
19468 msgid "guestfs_swapon_device"
19473 #: ../src/guestfs-actions.pod:6791
19477 " guestfs_swapon_device (guestfs_h *g,\n"
19478 " const char *device);\n"
19484 #: ../src/guestfs-actions.pod:6795
19486 "This command enables the libguestfs appliance to use the swap device or "
19487 "partition named C<device>. The increased memory is made available for all "
19488 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
19493 #: ../src/guestfs-actions.pod:6800 ../fish/guestfish-actions.pod:4533
19495 "Note that you should not swap to existing guest swap partitions unless you "
19496 "know what you are doing. They may contain hibernation information, or other "
19497 "information that the guest doesn't want you to trash. You also risk leaking "
19498 "information about the host to the guest this way. Instead, attach a new "
19499 "host device to the guest and swap on that."
19504 #: ../src/guestfs-actions.pod:6811
19505 msgid "guestfs_swapon_file"
19510 #: ../src/guestfs-actions.pod:6813
19514 " guestfs_swapon_file (guestfs_h *g,\n"
19515 " const char *file);\n"
19521 #: ../src/guestfs-actions.pod:6817
19523 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
19529 #: ../src/guestfs-actions.pod:6824
19530 msgid "guestfs_swapon_label"
19535 #: ../src/guestfs-actions.pod:6826
19539 " guestfs_swapon_label (guestfs_h *g,\n"
19540 " const char *label);\n"
19546 #: ../src/guestfs-actions.pod:6830
19548 "This command enables swap to a labeled swap partition. See "
19549 "C<guestfs_swapon_device> for other notes."
19554 #: ../src/guestfs-actions.pod:6837
19555 msgid "guestfs_swapon_uuid"
19560 #: ../src/guestfs-actions.pod:6839
19564 " guestfs_swapon_uuid (guestfs_h *g,\n"
19565 " const char *uuid);\n"
19571 #: ../src/guestfs-actions.pod:6843
19573 "This command enables swap to a swap partition with the given UUID. See "
19574 "C<guestfs_swapon_device> for other notes."
19579 #: ../src/guestfs-actions.pod:6850
19580 msgid "guestfs_sync"
19585 #: ../src/guestfs-actions.pod:6852
19589 " guestfs_sync (guestfs_h *g);\n"
19595 #: ../src/guestfs-actions.pod:6855 ../fish/guestfish-actions.pod:4565
19597 "This syncs the disk, so that any writes are flushed through to the "
19598 "underlying disk image."
19603 #: ../src/guestfs-actions.pod:6858 ../fish/guestfish-actions.pod:4568
19605 "You should always call this if you have modified a disk image, before "
19606 "closing the handle."
19611 #: ../src/guestfs-actions.pod:6865
19612 msgid "guestfs_tail"
19617 #: ../src/guestfs-actions.pod:6867
19621 " guestfs_tail (guestfs_h *g,\n"
19622 " const char *path);\n"
19628 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4575
19630 "This command returns up to the last 10 lines of a file as a list of strings."
19635 #: ../src/guestfs-actions.pod:6883
19636 msgid "guestfs_tail_n"
19641 #: ../src/guestfs-actions.pod:6885
19645 " guestfs_tail_n (guestfs_h *g,\n"
19647 " const char *path);\n"
19653 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4585
19655 "If the parameter C<nrlines> is a positive number, this returns the last "
19656 "C<nrlines> lines of the file C<path>."
19661 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4588
19663 "If the parameter C<nrlines> is a negative number, this returns lines from "
19664 "the file C<path>, starting with the C<-nrlines>th line."
19669 #: ../src/guestfs-actions.pod:6907
19670 msgid "guestfs_tar_in"
19675 #: ../src/guestfs-actions.pod:6909
19679 " guestfs_tar_in (guestfs_h *g,\n"
19680 " const char *tarfile,\n"
19681 " const char *directory);\n"
19687 #: ../src/guestfs-actions.pod:6914 ../fish/guestfish-actions.pod:4600
19689 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19690 "tar file) into C<directory>."
19695 #: ../src/guestfs-actions.pod:6917
19697 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19702 #: ../src/guestfs-actions.pod:6922 ../src/guestfs-actions.pod:6939
19703 #: ../src/guestfs-actions.pod:6955 ../src/guestfs-actions.pod:6971
19704 msgid "(Added in 1.0.3)"
19709 #: ../src/guestfs-actions.pod:6924
19710 msgid "guestfs_tar_out"
19715 #: ../src/guestfs-actions.pod:6926
19719 " guestfs_tar_out (guestfs_h *g,\n"
19720 " const char *directory,\n"
19721 " const char *tarfile);\n"
19727 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4612
19729 "This command packs the contents of C<directory> and downloads it to local "
19735 #: ../src/guestfs-actions.pod:6934
19737 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19738 "C<guestfs_txz_out>."
19743 #: ../src/guestfs-actions.pod:6941
19744 msgid "guestfs_tgz_in"
19749 #: ../src/guestfs-actions.pod:6943
19753 " guestfs_tgz_in (guestfs_h *g,\n"
19754 " const char *tarball,\n"
19755 " const char *directory);\n"
19761 #: ../src/guestfs-actions.pod:6948 ../fish/guestfish-actions.pod:4624
19763 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19764 "tar file) into C<directory>."
19769 #: ../src/guestfs-actions.pod:6951
19770 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19775 #: ../src/guestfs-actions.pod:6957
19776 msgid "guestfs_tgz_out"
19781 #: ../src/guestfs-actions.pod:6959
19785 " guestfs_tgz_out (guestfs_h *g,\n"
19786 " const char *directory,\n"
19787 " const char *tarball);\n"
19793 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4635
19795 "This command packs the contents of C<directory> and downloads it to local "
19801 #: ../src/guestfs-actions.pod:6967
19802 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19807 #: ../src/guestfs-actions.pod:6973
19808 msgid "guestfs_touch"
19813 #: ../src/guestfs-actions.pod:6975
19817 " guestfs_touch (guestfs_h *g,\n"
19818 " const char *path);\n"
19824 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4646
19826 "Touch acts like the L<touch(1)> command. It can be used to update the "
19827 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19833 #: ../src/guestfs-actions.pod:6983 ../fish/guestfish-actions.pod:4650
19835 "This command only works on regular files, and will fail on other file types "
19836 "such as directories, symbolic links, block special etc."
19841 #: ../src/guestfs-actions.pod:6990
19842 msgid "guestfs_truncate"
19847 #: ../src/guestfs-actions.pod:6992
19851 " guestfs_truncate (guestfs_h *g,\n"
19852 " const char *path);\n"
19858 #: ../src/guestfs-actions.pod:6996 ../fish/guestfish-actions.pod:4657
19860 "This command truncates C<path> to a zero-length file. The file must exist "
19866 #: ../src/guestfs-actions.pod:7003
19867 msgid "guestfs_truncate_size"
19872 #: ../src/guestfs-actions.pod:7005
19876 " guestfs_truncate_size (guestfs_h *g,\n"
19877 " const char *path,\n"
19878 " int64_t size);\n"
19884 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4664
19886 "This command truncates C<path> to size C<size> bytes. The file must exist "
19892 #: ../src/guestfs-actions.pod:7013
19894 "If the current file size is less than C<size> then the file is extended to "
19895 "the required size with zero bytes. This creates a sparse file (ie. disk "
19896 "blocks are not allocated for the file until you write to it). To create a "
19897 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19902 #: ../src/guestfs-actions.pod:7023
19903 msgid "guestfs_tune2fs_l"
19908 #: ../src/guestfs-actions.pod:7025
19912 " guestfs_tune2fs_l (guestfs_h *g,\n"
19913 " const char *device);\n"
19919 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4677
19921 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19927 #: ../src/guestfs-actions.pod:7032 ../fish/guestfish-actions.pod:4680
19929 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19930 "for more details. The list of fields returned isn't clearly defined, and "
19931 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19932 "and the filesystem itself."
19937 #: ../src/guestfs-actions.pod:7045
19938 msgid "guestfs_txz_in"
19943 #: ../src/guestfs-actions.pod:7047
19947 " guestfs_txz_in (guestfs_h *g,\n"
19948 " const char *tarball,\n"
19949 " const char *directory);\n"
19955 #: ../src/guestfs-actions.pod:7052 ../fish/guestfish-actions.pod:4689
19957 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19958 "tar file) into C<directory>."
19963 #: ../src/guestfs-actions.pod:7059
19964 msgid "guestfs_txz_out"
19969 #: ../src/guestfs-actions.pod:7061
19973 " guestfs_txz_out (guestfs_h *g,\n"
19974 " const char *directory,\n"
19975 " const char *tarball);\n"
19981 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4698
19983 "This command packs the contents of C<directory> and downloads it to local "
19984 "file C<tarball> (as an xz compressed tar archive)."
19989 #: ../src/guestfs-actions.pod:7073
19990 msgid "guestfs_umask"
19995 #: ../src/guestfs-actions.pod:7075
19999 " guestfs_umask (guestfs_h *g,\n"
20006 #: ../src/guestfs-actions.pod:7079 ../fish/guestfish-actions.pod:4707
20008 "This function sets the mask used for creating new files and device nodes to "
20014 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4710
20016 "Typical umask values would be C<022> which creates new files with "
20017 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
20018 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
20023 #: ../src/guestfs-actions.pod:7087 ../fish/guestfish-actions.pod:4715
20025 "The default umask is C<022>. This is important because it means that "
20026 "directories and device nodes will be created with C<0644> or C<0755> mode "
20027 "even if you specify C<0777>."
20032 #: ../src/guestfs-actions.pod:7091
20034 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
20035 "C<guestfs_mkdir>."
20040 #: ../src/guestfs-actions.pod:7094 ../fish/guestfish-actions.pod:4722
20041 msgid "This call returns the previous umask."
20046 #: ../src/guestfs-actions.pod:7100
20047 msgid "guestfs_umount"
20052 #: ../src/guestfs-actions.pod:7102
20056 " guestfs_umount (guestfs_h *g,\n"
20057 " const char *pathordevice);\n"
20063 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4730
20065 "This unmounts the given filesystem. The filesystem may be specified either "
20066 "by its mountpoint (path) or the device which contains the filesystem."
20071 #: ../src/guestfs-actions.pod:7114
20072 msgid "guestfs_umount_all"
20077 #: ../src/guestfs-actions.pod:7116
20081 " guestfs_umount_all (guestfs_h *g);\n"
20087 #: ../src/guestfs-actions.pod:7119 ../fish/guestfish-actions.pod:4740
20088 msgid "This unmounts all mounted filesystems."
20093 #: ../src/guestfs-actions.pod:7121 ../fish/guestfish-actions.pod:4742
20094 msgid "Some internal mounts are not unmounted by this call."
20099 #: ../src/guestfs-actions.pod:7127
20100 msgid "guestfs_upload"
20105 #: ../src/guestfs-actions.pod:7129
20109 " guestfs_upload (guestfs_h *g,\n"
20110 " const char *filename,\n"
20111 " const char *remotefilename);\n"
20117 #: ../src/guestfs-actions.pod:7134 ../src/guestfs-actions.pod:7158
20118 #: ../fish/guestfish-actions.pod:4748 ../fish/guestfish-actions.pod:4761
20119 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
20124 #: ../src/guestfs-actions.pod:7139
20125 msgid "See also C<guestfs_download>."
20130 #: ../src/guestfs-actions.pod:7150
20131 msgid "guestfs_upload_offset"
20136 #: ../src/guestfs-actions.pod:7152
20140 " guestfs_upload_offset (guestfs_h *g,\n"
20141 " const char *filename,\n"
20142 " const char *remotefilename,\n"
20143 " int64_t offset);\n"
20149 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4764
20151 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
20152 "The intention is to overwrite parts of existing files or devices, although "
20153 "if a non-existant file is specified then it is created with a \"hole\" "
20154 "before C<offset>. The size of the data written is implicit in the size of "
20155 "the source C<filename>."
20160 #: ../src/guestfs-actions.pod:7168
20162 "Note that there is no limit on the amount of data that can be uploaded with "
20163 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
20164 "full amount unless an error occurs."
20169 #: ../src/guestfs-actions.pod:7173
20170 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
20175 #: ../src/guestfs-actions.pod:7184
20176 msgid "guestfs_utimens"
20181 #: ../src/guestfs-actions.pod:7186
20185 " guestfs_utimens (guestfs_h *g,\n"
20186 " const char *path,\n"
20187 " int64_t atsecs,\n"
20188 " int64_t atnsecs,\n"
20189 " int64_t mtsecs,\n"
20190 " int64_t mtnsecs);\n"
20196 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:4784
20197 msgid "This command sets the timestamps of a file with nanosecond precision."
20202 #: ../src/guestfs-actions.pod:7197 ../fish/guestfish-actions.pod:4787
20204 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
20210 #: ../src/guestfs-actions.pod:7200 ../fish/guestfish-actions.pod:4790
20212 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
20213 "nanoseconds from the epoch."
20218 #: ../src/guestfs-actions.pod:7203 ../fish/guestfish-actions.pod:4793
20220 "If the C<*nsecs> field contains the special value C<-1> then the "
20221 "corresponding timestamp is set to the current time. (The C<*secs> field is "
20222 "ignored in this case)."
20227 #: ../src/guestfs-actions.pod:7207 ../fish/guestfish-actions.pod:4797
20229 "If the C<*nsecs> field contains the special value C<-2> then the "
20230 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
20236 #: ../src/guestfs-actions.pod:7215 ../src/guestfs-structs.pod:175
20237 msgid "guestfs_version"
20242 #: ../src/guestfs-actions.pod:7217
20245 " struct guestfs_version *\n"
20246 " guestfs_version (guestfs_h *g);\n"
20252 #: ../src/guestfs-actions.pod:7220 ../fish/guestfish-actions.pod:4805
20254 "Return the libguestfs version number that the program is linked against."
20259 #: ../src/guestfs-actions.pod:7223 ../fish/guestfish-actions.pod:4808
20261 "Note that because of dynamic linking this is not necessarily the version of "
20262 "libguestfs that you compiled against. You can compile the program, and then "
20263 "at runtime dynamically link against a completely different C<libguestfs.so> "
20269 #: ../src/guestfs-actions.pod:7228 ../fish/guestfish-actions.pod:4813
20271 "This call was added in version C<1.0.58>. In previous versions of "
20272 "libguestfs there was no way to get the version number. From C code you can "
20273 "use dynamic linker functions to find out if this symbol exists (if it "
20274 "doesn't, then it's an earlier version)."
20279 #: ../src/guestfs-actions.pod:7234 ../fish/guestfish-actions.pod:4819
20281 "The call returns a structure with four elements. The first three (C<major>, "
20282 "C<minor> and C<release>) are numbers and correspond to the usual version "
20283 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
20284 "but may be used for distro-specific information."
20289 #: ../src/guestfs-actions.pod:7240 ../fish/guestfish-actions.pod:4825
20291 "To construct the original version string: C<$major.$minor.$release$extra>"
20296 #: ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4828
20297 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
20302 #: ../src/guestfs-actions.pod:7245
20304 "I<Note:> Don't use this call to test for availability of features. In "
20305 "enterprise distributions we backport features from later versions into "
20306 "earlier versions, making this an unreliable way to test for features. Use "
20307 "C<guestfs_available> instead."
20312 #: ../src/guestfs-actions.pod:7251
20314 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
20315 "error. I<The caller must call C<guestfs_free_version> after use>."
20320 #: ../src/guestfs-actions.pod:7255
20321 msgid "(Added in 1.0.58)"
20326 #: ../src/guestfs-actions.pod:7257
20327 msgid "guestfs_vfs_label"
20332 #: ../src/guestfs-actions.pod:7259
20336 " guestfs_vfs_label (guestfs_h *g,\n"
20337 " const char *device);\n"
20343 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4840
20344 msgid "This returns the filesystem label of the filesystem on C<device>."
20349 #: ../src/guestfs-actions.pod:7266 ../fish/guestfish-actions.pod:4843
20350 msgid "If the filesystem is unlabeled, this returns the empty string."
20355 #: ../src/guestfs-actions.pod:7268
20356 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
20361 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7310
20362 msgid "(Added in 1.3.18)"
20367 #: ../src/guestfs-actions.pod:7275
20368 msgid "guestfs_vfs_type"
20373 #: ../src/guestfs-actions.pod:7277
20377 " guestfs_vfs_type (guestfs_h *g,\n"
20378 " const char *device);\n"
20384 #: ../src/guestfs-actions.pod:7281 ../fish/guestfish-actions.pod:4851
20386 "This command gets the filesystem type corresponding to the filesystem on "
20392 #: ../src/guestfs-actions.pod:7284 ../fish/guestfish-actions.pod:4854
20394 "For most filesystems, the result is the name of the Linux VFS module which "
20395 "would be used to mount this filesystem if you mounted it without specifying "
20396 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
20401 #: ../src/guestfs-actions.pod:7294
20402 msgid "guestfs_vfs_uuid"
20407 #: ../src/guestfs-actions.pod:7296
20411 " guestfs_vfs_uuid (guestfs_h *g,\n"
20412 " const char *device);\n"
20418 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4863
20419 msgid "This returns the filesystem UUID of the filesystem on C<device>."
20424 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4866
20425 msgid "If the filesystem does not have a UUID, this returns the empty string."
20430 #: ../src/guestfs-actions.pod:7305
20431 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
20436 #: ../src/guestfs-actions.pod:7312
20437 msgid "guestfs_vg_activate"
20442 #: ../src/guestfs-actions.pod:7314
20446 " guestfs_vg_activate (guestfs_h *g,\n"
20448 " char *const *volgroups);\n"
20453 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4874
20455 "This command activates or (if C<activate> is false) deactivates all logical "
20456 "volumes in the listed volume groups C<volgroups>."
20461 #: ../src/guestfs-actions.pod:7322 ../fish/guestfish-actions.pod:4877
20462 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
20467 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4879
20469 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
20470 "activated or deactivated."
20475 #: ../src/guestfs-actions.pod:7331
20476 msgid "guestfs_vg_activate_all"
20481 #: ../src/guestfs-actions.pod:7333
20485 " guestfs_vg_activate_all (guestfs_h *g,\n"
20486 " int activate);\n"
20491 #: ../src/guestfs-actions.pod:7337 ../fish/guestfish-actions.pod:4886
20493 "This command activates or (if C<activate> is false) deactivates all logical "
20494 "volumes in all volume groups."
20499 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4889
20500 msgid "This command is the same as running C<vgchange -a y|n>"
20505 #: ../src/guestfs-actions.pod:7346
20506 msgid "guestfs_vgcreate"
20511 #: ../src/guestfs-actions.pod:7348
20515 " guestfs_vgcreate (guestfs_h *g,\n"
20516 " const char *volgroup,\n"
20517 " char *const *physvols);\n"
20523 #: ../src/guestfs-actions.pod:7353 ../fish/guestfish-actions.pod:4895
20525 "This creates an LVM volume group called C<volgroup> from the non-empty list "
20526 "of physical volumes C<physvols>."
20531 #: ../src/guestfs-actions.pod:7360
20532 msgid "guestfs_vglvuuids"
20537 #: ../src/guestfs-actions.pod:7362
20541 " guestfs_vglvuuids (guestfs_h *g,\n"
20542 " const char *vgname);\n"
20548 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4902
20550 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20551 "volumes created in this volume group."
20556 #: ../src/guestfs-actions.pod:7369
20558 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20559 "associate logical volumes and volume groups."
20564 #: ../src/guestfs-actions.pod:7372
20565 msgid "See also C<guestfs_vgpvuuids>."
20570 #: ../src/guestfs-actions.pod:7380
20571 msgid "guestfs_vgpvuuids"
20576 #: ../src/guestfs-actions.pod:7382
20580 " guestfs_vgpvuuids (guestfs_h *g,\n"
20581 " const char *vgname);\n"
20587 #: ../src/guestfs-actions.pod:7386 ../fish/guestfish-actions.pod:4914
20589 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20590 "volumes that this volume group resides on."
20595 #: ../src/guestfs-actions.pod:7389
20597 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20598 "associate physical volumes and volume groups."
20603 #: ../src/guestfs-actions.pod:7392
20604 msgid "See also C<guestfs_vglvuuids>."
20609 #: ../src/guestfs-actions.pod:7400
20610 msgid "guestfs_vgremove"
20615 #: ../src/guestfs-actions.pod:7402
20619 " guestfs_vgremove (guestfs_h *g,\n"
20620 " const char *vgname);\n"
20626 #: ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:4926
20627 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20632 #: ../src/guestfs-actions.pod:7408 ../fish/guestfish-actions.pod:4928
20634 "This also forcibly removes all logical volumes in the volume group (if any)."
20639 #: ../src/guestfs-actions.pod:7415
20640 msgid "guestfs_vgrename"
20645 #: ../src/guestfs-actions.pod:7417
20649 " guestfs_vgrename (guestfs_h *g,\n"
20650 " const char *volgroup,\n"
20651 " const char *newvolgroup);\n"
20657 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4935
20658 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20663 #: ../src/guestfs-actions.pod:7428
20664 msgid "guestfs_vgs"
20669 #: ../src/guestfs-actions.pod:7430
20673 " guestfs_vgs (guestfs_h *g);\n"
20679 #: ../src/guestfs-actions.pod:7433 ../fish/guestfish-actions.pod:4941
20681 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20687 #: ../src/guestfs-actions.pod:7436 ../fish/guestfish-actions.pod:4944
20689 "This returns a list of just the volume group names that were detected (eg. "
20695 #: ../src/guestfs-actions.pod:7439
20696 msgid "See also C<guestfs_vgs_full>."
20701 #: ../src/guestfs-actions.pod:7447
20702 msgid "guestfs_vgs_full"
20707 #: ../src/guestfs-actions.pod:7449
20710 " struct guestfs_lvm_vg_list *\n"
20711 " guestfs_vgs_full (guestfs_h *g);\n"
20717 #: ../src/guestfs-actions.pod:7452 ../fish/guestfish-actions.pod:4953
20719 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20720 "> command. The \"full\" version includes all fields."
20725 #: ../src/guestfs-actions.pod:7455
20727 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20728 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20733 #: ../src/guestfs-actions.pod:7461
20734 msgid "guestfs_vgscan"
20739 #: ../src/guestfs-actions.pod:7463
20743 " guestfs_vgscan (guestfs_h *g);\n"
20749 #: ../src/guestfs-actions.pod:7466 ../fish/guestfish-actions.pod:4960
20751 "This rescans all block devices and rebuilds the list of LVM physical "
20752 "volumes, volume groups and logical volumes."
20757 #: ../src/guestfs-actions.pod:7473
20758 msgid "guestfs_vguuid"
20763 #: ../src/guestfs-actions.pod:7475
20767 " guestfs_vguuid (guestfs_h *g,\n"
20768 " const char *vgname);\n"
20774 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4967
20775 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20780 #: ../src/guestfs-actions.pod:7486
20781 msgid "guestfs_wait_ready"
20786 #: ../src/guestfs-actions.pod:7488
20790 " guestfs_wait_ready (guestfs_h *g);\n"
20796 #: ../src/guestfs-actions.pod:7491
20797 msgid "This function is a no op."
20802 #: ../src/guestfs-actions.pod:7493
20804 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20805 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20806 "is no longer necessary because C<guestfs_launch> now does the waiting."
20811 #: ../src/guestfs-actions.pod:7498
20813 "If you see any calls to this function in code then you can just remove them, "
20814 "unless you want to retain compatibility with older versions of the API."
20818 #: ../src/guestfs-actions.pod:7504
20820 "This function is deprecated. In new code, use the C<launch> call instead."
20825 #: ../src/guestfs-actions.pod:7513
20826 msgid "guestfs_wc_c"
20831 #: ../src/guestfs-actions.pod:7515
20835 " guestfs_wc_c (guestfs_h *g,\n"
20836 " const char *path);\n"
20842 #: ../src/guestfs-actions.pod:7519 ../fish/guestfish-actions.pod:4973
20844 "This command counts the characters in a file, using the C<wc -c> external "
20850 #: ../src/guestfs-actions.pod:7526
20851 msgid "guestfs_wc_l"
20856 #: ../src/guestfs-actions.pod:7528
20860 " guestfs_wc_l (guestfs_h *g,\n"
20861 " const char *path);\n"
20867 #: ../src/guestfs-actions.pod:7532 ../fish/guestfish-actions.pod:4980
20869 "This command counts the lines in a file, using the C<wc -l> external command."
20874 #: ../src/guestfs-actions.pod:7539
20875 msgid "guestfs_wc_w"
20880 #: ../src/guestfs-actions.pod:7541
20884 " guestfs_wc_w (guestfs_h *g,\n"
20885 " const char *path);\n"
20891 #: ../src/guestfs-actions.pod:7545 ../fish/guestfish-actions.pod:4987
20893 "This command counts the words in a file, using the C<wc -w> external command."
20898 #: ../src/guestfs-actions.pod:7552
20899 msgid "guestfs_write"
20904 #: ../src/guestfs-actions.pod:7554
20908 " guestfs_write (guestfs_h *g,\n"
20909 " const char *path,\n"
20910 " const char *content,\n"
20911 " size_t content_size);\n"
20917 #: ../src/guestfs-actions.pod:7560 ../fish/guestfish-actions.pod:4994
20919 "This call creates a file called C<path>. The content of the file is the "
20920 "string C<content> (which can contain any 8 bit data)."
20925 #: ../src/guestfs-actions.pod:7570
20926 msgid "guestfs_write_file"
20931 #: ../src/guestfs-actions.pod:7572
20935 " guestfs_write_file (guestfs_h *g,\n"
20936 " const char *path,\n"
20937 " const char *content,\n"
20944 #: ../src/guestfs-actions.pod:7578 ../fish/guestfish-actions.pod:5004
20946 "This call creates a file called C<path>. The contents of the file is the "
20947 "string C<content> (which can contain any 8 bit data), with length C<size>."
20952 #: ../src/guestfs-actions.pod:7582 ../fish/guestfish-actions.pod:5008
20954 "As a special case, if C<size> is C<0> then the length is calculated using "
20955 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20960 #: ../src/guestfs-actions.pod:7586 ../fish/guestfish-actions.pod:5012
20962 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20963 "I<not> work, even if the length is specified."
20968 #: ../src/guestfs-actions.pod:7594 ../fish/guestfish-actions.pod:5018
20970 "This function is deprecated. In new code, use the C<write> call instead."
20975 #: ../src/guestfs-actions.pod:7603
20976 msgid "guestfs_zegrep"
20981 #: ../src/guestfs-actions.pod:7605
20985 " guestfs_zegrep (guestfs_h *g,\n"
20986 " const char *regex,\n"
20987 " const char *path);\n"
20993 #: ../src/guestfs-actions.pod:7610 ../fish/guestfish-actions.pod:5029
20995 "This calls the external C<zegrep> program and returns the matching lines."
21000 #: ../src/guestfs-actions.pod:7622
21001 msgid "guestfs_zegrepi"
21006 #: ../src/guestfs-actions.pod:7624
21010 " guestfs_zegrepi (guestfs_h *g,\n"
21011 " const char *regex,\n"
21012 " const char *path);\n"
21018 #: ../src/guestfs-actions.pod:7629 ../fish/guestfish-actions.pod:5039
21020 "This calls the external C<zegrep -i> program and returns the matching lines."
21025 #: ../src/guestfs-actions.pod:7641
21026 msgid "guestfs_zero"
21031 #: ../src/guestfs-actions.pod:7643
21035 " guestfs_zero (guestfs_h *g,\n"
21036 " const char *device);\n"
21042 #: ../src/guestfs-actions.pod:7647 ../fish/guestfish-actions.pod:5049
21043 msgid "This command writes zeroes over the first few blocks of C<device>."
21048 #: ../src/guestfs-actions.pod:7649 ../fish/guestfish-actions.pod:5051
21050 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
21051 "securely wipe the device). It should be sufficient to remove any partition "
21052 "tables, filesystem superblocks and so on."
21056 #: ../src/guestfs-actions.pod:7653
21058 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
21059 "C<guestfs_is_zero_device>"
21064 #: ../src/guestfs-actions.pod:7665
21065 msgid "guestfs_zero_device"
21070 #: ../src/guestfs-actions.pod:7667
21074 " guestfs_zero_device (guestfs_h *g,\n"
21075 " const char *device);\n"
21081 #: ../src/guestfs-actions.pod:7671
21083 "This command writes zeroes over the entire C<device>. Compare with "
21084 "C<guestfs_zero> which just zeroes the first few blocks of a device."
21089 #: ../src/guestfs-actions.pod:7685
21090 msgid "(Added in 1.3.1)"
21095 #: ../src/guestfs-actions.pod:7687
21096 msgid "guestfs_zerofree"
21101 #: ../src/guestfs-actions.pod:7689
21105 " guestfs_zerofree (guestfs_h *g,\n"
21106 " const char *device);\n"
21112 #: ../src/guestfs-actions.pod:7693 ../fish/guestfish-actions.pod:5073
21114 "This runs the I<zerofree> program on C<device>. This program claims to zero "
21115 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
21116 "possible to compress the filesystem more effectively."
21121 #: ../src/guestfs-actions.pod:7698 ../fish/guestfish-actions.pod:5078
21122 msgid "You should B<not> run this program if the filesystem is mounted."
21127 #: ../src/guestfs-actions.pod:7701 ../fish/guestfish-actions.pod:5081
21129 "It is possible that using this program can damage the filesystem or data on "
21135 #: ../src/guestfs-actions.pod:7708
21136 msgid "guestfs_zfgrep"
21141 #: ../src/guestfs-actions.pod:7710
21145 " guestfs_zfgrep (guestfs_h *g,\n"
21146 " const char *pattern,\n"
21147 " const char *path);\n"
21153 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5088
21155 "This calls the external C<zfgrep> program and returns the matching lines."
21160 #: ../src/guestfs-actions.pod:7727
21161 msgid "guestfs_zfgrepi"
21166 #: ../src/guestfs-actions.pod:7729
21170 " guestfs_zfgrepi (guestfs_h *g,\n"
21171 " const char *pattern,\n"
21172 " const char *path);\n"
21178 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5098
21180 "This calls the external C<zfgrep -i> program and returns the matching lines."
21185 #: ../src/guestfs-actions.pod:7746
21186 msgid "guestfs_zfile"
21191 #: ../src/guestfs-actions.pod:7748
21195 " guestfs_zfile (guestfs_h *g,\n"
21196 " const char *meth,\n"
21197 " const char *path);\n"
21203 #: ../src/guestfs-actions.pod:7753 ../fish/guestfish-actions.pod:5108
21205 "This command runs C<file> after first decompressing C<path> using C<method>."
21210 #: ../src/guestfs-actions.pod:7756 ../fish/guestfish-actions.pod:5111
21211 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
21216 #: ../src/guestfs-actions.pod:7758
21218 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
21224 #: ../src/guestfs-actions.pod:7764 ../fish/guestfish-actions.pod:5116
21226 "This function is deprecated. In new code, use the C<file> call instead."
21231 #: ../src/guestfs-actions.pod:7773
21232 msgid "guestfs_zgrep"
21237 #: ../src/guestfs-actions.pod:7775
21241 " guestfs_zgrep (guestfs_h *g,\n"
21242 " const char *regex,\n"
21243 " const char *path);\n"
21249 #: ../src/guestfs-actions.pod:7780 ../fish/guestfish-actions.pod:5127
21251 "This calls the external C<zgrep> program and returns the matching lines."
21256 #: ../src/guestfs-actions.pod:7792
21257 msgid "guestfs_zgrepi"
21262 #: ../src/guestfs-actions.pod:7794
21266 " guestfs_zgrepi (guestfs_h *g,\n"
21267 " const char *regex,\n"
21268 " const char *path);\n"
21274 #: ../src/guestfs-actions.pod:7799 ../fish/guestfish-actions.pod:5137
21276 "This calls the external C<zgrep -i> program and returns the matching lines."
21281 #: ../src/guestfs-availability.pod:3
21287 #: ../src/guestfs-availability.pod:5
21289 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
21290 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
21291 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
21292 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
21293 "L</guestfs_aug_save> L</guestfs_aug_set>"
21298 #: ../src/guestfs-availability.pod:21
21304 #: ../src/guestfs-availability.pod:23
21306 "The following functions: L</guestfs_inotify_add_watch> L</"
21307 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
21308 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
21313 #: ../src/guestfs-availability.pod:31
21314 msgid "B<linuxfsuuid>"
21319 #: ../src/guestfs-availability.pod:33
21321 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
21322 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
21327 #: ../src/guestfs-availability.pod:40
21328 msgid "B<linuxmodules>"
21333 #: ../src/guestfs-availability.pod:42
21334 msgid "The following functions: L</guestfs_modprobe>"
21339 #: ../src/guestfs-availability.pod:45
21340 msgid "B<linuxxattrs>"
21345 #: ../src/guestfs-availability.pod:47
21347 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
21348 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
21349 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
21350 "guestfs_setxattr>"
21355 #: ../src/guestfs-availability.pod:58
21361 #: ../src/guestfs-availability.pod:60
21363 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
21364 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
21365 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
21370 #: ../src/guestfs-availability.pod:69
21376 #: ../src/guestfs-availability.pod:71
21378 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
21379 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
21380 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
21381 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
21382 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
21383 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
21384 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
21389 #: ../src/guestfs-availability.pod:94
21395 #: ../src/guestfs-availability.pod:96
21397 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
21398 "guestfs_mknod_b> L</guestfs_mknod_c>"
21403 #: ../src/guestfs-availability.pod:102
21409 #: ../src/guestfs-availability.pod:104
21410 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
21415 #: ../src/guestfs-availability.pod:107
21416 msgid "B<ntfsprogs>"
21420 #: ../src/guestfs-availability.pod:109
21422 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
21423 "L</guestfs_ntfsresize_size>"
21428 #: ../src/guestfs-availability.pod:114
21429 msgid "B<realpath>"
21434 #: ../src/guestfs-availability.pod:116
21435 msgid "The following functions: L</guestfs_realpath>"
21440 #: ../src/guestfs-availability.pod:119
21446 #: ../src/guestfs-availability.pod:121
21448 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
21449 "guestfs_scrub_freespace>"
21454 #: ../src/guestfs-availability.pod:126
21460 #: ../src/guestfs-availability.pod:128
21461 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
21466 #: ../src/guestfs-availability.pod:132
21472 #: ../src/guestfs-availability.pod:134
21473 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
21478 #: ../src/guestfs-availability.pod:138
21479 msgid "B<zerofree>"
21484 #: ../src/guestfs-availability.pod:140
21485 msgid "The following functions: L</guestfs_zerofree>"
21490 #: ../src/guestfs-structs.pod:1
21491 msgid "guestfs_int_bool"
21496 #: ../src/guestfs-structs.pod:3
21499 " struct guestfs_int_bool {\n"
21508 #: ../src/guestfs-structs.pod:8
21511 " struct guestfs_int_bool_list {\n"
21512 " uint32_t len; /* Number of elements in list. */\n"
21513 " struct guestfs_int_bool *val; /* Elements. */\n"
21520 #: ../src/guestfs-structs.pod:13
21523 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
21524 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
21530 #: ../src/guestfs-structs.pod:16
21531 msgid "guestfs_lvm_pv"
21536 #: ../src/guestfs-structs.pod:18
21539 " struct guestfs_lvm_pv {\n"
21540 " char *pv_name;\n"
21541 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21542 " char pv_uuid[32];\n"
21544 " uint64_t pv_size;\n"
21545 " uint64_t dev_size;\n"
21546 " uint64_t pv_free;\n"
21547 " uint64_t pv_used;\n"
21548 " char *pv_attr;\n"
21549 " int64_t pv_pe_count;\n"
21550 " int64_t pv_pe_alloc_count;\n"
21551 " char *pv_tags;\n"
21552 " uint64_t pe_start;\n"
21553 " int64_t pv_mda_count;\n"
21554 " uint64_t pv_mda_free;\n"
21561 #: ../src/guestfs-structs.pod:36
21564 " struct guestfs_lvm_pv_list {\n"
21565 " uint32_t len; /* Number of elements in list. */\n"
21566 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21573 #: ../src/guestfs-structs.pod:41
21576 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21577 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21583 #: ../src/guestfs-structs.pod:44
21584 msgid "guestfs_lvm_vg"
21589 #: ../src/guestfs-structs.pod:46
21592 " struct guestfs_lvm_vg {\n"
21593 " char *vg_name;\n"
21594 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21595 " char vg_uuid[32];\n"
21597 " char *vg_attr;\n"
21598 " uint64_t vg_size;\n"
21599 " uint64_t vg_free;\n"
21600 " char *vg_sysid;\n"
21601 " uint64_t vg_extent_size;\n"
21602 " int64_t vg_extent_count;\n"
21603 " int64_t vg_free_count;\n"
21604 " int64_t max_lv;\n"
21605 " int64_t max_pv;\n"
21606 " int64_t pv_count;\n"
21607 " int64_t lv_count;\n"
21608 " int64_t snap_count;\n"
21609 " int64_t vg_seqno;\n"
21610 " char *vg_tags;\n"
21611 " int64_t vg_mda_count;\n"
21612 " uint64_t vg_mda_free;\n"
21619 #: ../src/guestfs-structs.pod:69
21622 " struct guestfs_lvm_vg_list {\n"
21623 " uint32_t len; /* Number of elements in list. */\n"
21624 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21631 #: ../src/guestfs-structs.pod:74
21634 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21635 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21641 #: ../src/guestfs-structs.pod:77
21642 msgid "guestfs_lvm_lv"
21647 #: ../src/guestfs-structs.pod:79
21650 " struct guestfs_lvm_lv {\n"
21651 " char *lv_name;\n"
21652 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21653 " char lv_uuid[32];\n"
21654 " char *lv_attr;\n"
21655 " int64_t lv_major;\n"
21656 " int64_t lv_minor;\n"
21657 " int64_t lv_kernel_major;\n"
21658 " int64_t lv_kernel_minor;\n"
21659 " uint64_t lv_size;\n"
21660 " int64_t seg_count;\n"
21662 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21663 " float snap_percent;\n"
21664 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21665 " float copy_percent;\n"
21666 " char *move_pv;\n"
21667 " char *lv_tags;\n"
21668 " char *mirror_log;\n"
21669 " char *modules;\n"
21676 #: ../src/guestfs-structs.pod:101
21679 " struct guestfs_lvm_lv_list {\n"
21680 " uint32_t len; /* Number of elements in list. */\n"
21681 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21688 #: ../src/guestfs-structs.pod:106
21691 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21692 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21698 #: ../src/guestfs-structs.pod:111
21701 " struct guestfs_stat {\n"
21705 " int64_t nlink;\n"
21710 " int64_t blksize;\n"
21711 " int64_t blocks;\n"
21712 " int64_t atime;\n"
21713 " int64_t mtime;\n"
21714 " int64_t ctime;\n"
21721 #: ../src/guestfs-structs.pod:127
21724 " struct guestfs_stat_list {\n"
21725 " uint32_t len; /* Number of elements in list. */\n"
21726 " struct guestfs_stat *val; /* Elements. */\n"
21733 #: ../src/guestfs-structs.pod:132
21736 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21737 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21743 #: ../src/guestfs-structs.pod:137
21746 " struct guestfs_statvfs {\n"
21747 " int64_t bsize;\n"
21748 " int64_t frsize;\n"
21749 " int64_t blocks;\n"
21750 " int64_t bfree;\n"
21751 " int64_t bavail;\n"
21752 " int64_t files;\n"
21753 " int64_t ffree;\n"
21754 " int64_t favail;\n"
21757 " int64_t namemax;\n"
21764 #: ../src/guestfs-structs.pod:151
21767 " struct guestfs_statvfs_list {\n"
21768 " uint32_t len; /* Number of elements in list. */\n"
21769 " struct guestfs_statvfs *val; /* Elements. */\n"
21776 #: ../src/guestfs-structs.pod:156
21779 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21780 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21786 #: ../src/guestfs-structs.pod:159
21787 msgid "guestfs_dirent"
21792 #: ../src/guestfs-structs.pod:161
21795 " struct guestfs_dirent {\n"
21805 #: ../src/guestfs-structs.pod:167
21808 " struct guestfs_dirent_list {\n"
21809 " uint32_t len; /* Number of elements in list. */\n"
21810 " struct guestfs_dirent *val; /* Elements. */\n"
21817 #: ../src/guestfs-structs.pod:172
21820 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21821 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21827 #: ../src/guestfs-structs.pod:177
21830 " struct guestfs_version {\n"
21831 " int64_t major;\n"
21832 " int64_t minor;\n"
21833 " int64_t release;\n"
21841 #: ../src/guestfs-structs.pod:184
21844 " struct guestfs_version_list {\n"
21845 " uint32_t len; /* Number of elements in list. */\n"
21846 " struct guestfs_version *val; /* Elements. */\n"
21853 #: ../src/guestfs-structs.pod:189
21856 " void guestfs_free_version (struct guestfs_free_version *);\n"
21857 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21863 #: ../src/guestfs-structs.pod:192
21864 msgid "guestfs_xattr"
21869 #: ../src/guestfs-structs.pod:194
21872 " struct guestfs_xattr {\n"
21873 " char *attrname;\n"
21874 " /* The next two fields describe a byte array. */\n"
21875 " uint32_t attrval_len;\n"
21876 " char *attrval;\n"
21883 #: ../src/guestfs-structs.pod:201
21886 " struct guestfs_xattr_list {\n"
21887 " uint32_t len; /* Number of elements in list. */\n"
21888 " struct guestfs_xattr *val; /* Elements. */\n"
21895 #: ../src/guestfs-structs.pod:206
21898 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21899 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21905 #: ../src/guestfs-structs.pod:209
21906 msgid "guestfs_inotify_event"
21911 #: ../src/guestfs-structs.pod:211
21914 " struct guestfs_inotify_event {\n"
21915 " int64_t in_wd;\n"
21916 " uint32_t in_mask;\n"
21917 " uint32_t in_cookie;\n"
21918 " char *in_name;\n"
21925 #: ../src/guestfs-structs.pod:218
21928 " struct guestfs_inotify_event_list {\n"
21929 " uint32_t len; /* Number of elements in list. */\n"
21930 " struct guestfs_inotify_event *val; /* Elements. */\n"
21937 #: ../src/guestfs-structs.pod:223
21940 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21941 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21947 #: ../src/guestfs-structs.pod:226
21948 msgid "guestfs_partition"
21953 #: ../src/guestfs-structs.pod:228
21956 " struct guestfs_partition {\n"
21957 " int32_t part_num;\n"
21958 " uint64_t part_start;\n"
21959 " uint64_t part_end;\n"
21960 " uint64_t part_size;\n"
21967 #: ../src/guestfs-structs.pod:235
21970 " struct guestfs_partition_list {\n"
21971 " uint32_t len; /* Number of elements in list. */\n"
21972 " struct guestfs_partition *val; /* Elements. */\n"
21979 #: ../src/guestfs-structs.pod:240
21982 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21983 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21989 #: ../src/guestfs-structs.pod:243
21990 msgid "guestfs_application"
21995 #: ../src/guestfs-structs.pod:245
21998 " struct guestfs_application {\n"
21999 " char *app_name;\n"
22000 " char *app_display_name;\n"
22001 " int32_t app_epoch;\n"
22002 " char *app_version;\n"
22003 " char *app_release;\n"
22004 " char *app_install_path;\n"
22005 " char *app_trans_path;\n"
22006 " char *app_publisher;\n"
22007 " char *app_url;\n"
22008 " char *app_source_package;\n"
22009 " char *app_summary;\n"
22010 " char *app_description;\n"
22017 #: ../src/guestfs-structs.pod:260
22020 " struct guestfs_application_list {\n"
22021 " uint32_t len; /* Number of elements in list. */\n"
22022 " struct guestfs_application *val; /* Elements. */\n"
22029 #: ../src/guestfs-structs.pod:265
22032 " void guestfs_free_application (struct guestfs_free_application *);\n"
22033 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
22039 #: ../fish/guestfish.pod:5
22040 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
22045 #: ../fish/guestfish.pod:9
22048 " guestfish [--options] [commands]\n"
22054 #: ../fish/guestfish.pod:11
22063 #: ../fish/guestfish.pod:13
22066 " guestfish [--ro|--rw] -a disk.img\n"
22072 #: ../fish/guestfish.pod:15
22075 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
22081 #: ../fish/guestfish.pod:17
22084 " guestfish -d libvirt-domain\n"
22090 #: ../fish/guestfish.pod:19
22093 " guestfish [--ro|--rw] -a disk.img -i\n"
22099 #: ../fish/guestfish.pod:21
22102 " guestfish -d libvirt-domain -i\n"
22108 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
22109 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
22115 #: ../fish/guestfish.pod:25
22117 "Using guestfish in read/write mode on live virtual machines can be "
22118 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
22119 "option to use guestfish safely if the disk image or virtual machine might be "
22125 #: ../fish/guestfish.pod:32
22127 "Guestfish is a shell and command-line tool for examining and modifying "
22128 "virtual machine filesystems. It uses libguestfs and exposes all of the "
22129 "functionality of the guestfs API, see L<guestfs(3)>."
22134 #: ../fish/guestfish.pod:36
22136 "Guestfish gives you structured access to the libguestfs API, from shell "
22137 "scripts or the command line or interactively. If you want to rescue a "
22138 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
22144 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
22145 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
22151 #: ../fish/guestfish.pod:43
22152 msgid "As an interactive shell"
22157 #: ../fish/guestfish.pod:45
22166 #: ../fish/guestfish.pod:47
22169 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
22170 " editing virtual machine filesystems.\n"
22176 #: ../fish/guestfish.pod:50
22179 " Type: 'help' for a list of commands\n"
22180 " 'man' to read the manual\n"
22181 " 'quit' to quit the shell\n"
22187 #: ../fish/guestfish.pod:54
22190 " ><fs> add-ro disk.img\n"
22192 " ><fs> list-filesystems\n"
22193 " /dev/sda1: ext4\n"
22194 " /dev/vg_guest/lv_root: ext4\n"
22195 " /dev/vg_guest/lv_swap: swap\n"
22196 " ><fs> mount /dev/vg_guest/lv_root /\n"
22197 " ><fs> cat /etc/fstab\n"
22199 " # Created by anaconda\n"
22207 #: ../fish/guestfish.pod:67
22208 msgid "From shell scripts"
22213 #: ../fish/guestfish.pod:69
22214 msgid "Create a new C</etc/motd> file in a guest or disk image:"
22219 #: ../fish/guestfish.pod:71
22222 " guestfish <<_EOF_\n"
22225 " mount /dev/vg_guest/lv_root /\n"
22226 " write /etc/motd \"Welcome, new users\"\n"
22233 #: ../fish/guestfish.pod:78
22234 msgid "List the LVM logical volumes in a disk image:"
22239 #: ../fish/guestfish.pod:80
22242 " guestfish -a disk.img --ro <<_EOF_\n"
22251 #: ../fish/guestfish.pod:85
22252 msgid "List all the filesystems in a disk image:"
22257 #: ../fish/guestfish.pod:87
22260 " guestfish -a disk.img --ro <<_EOF_\n"
22262 " list-filesystems\n"
22269 #: ../fish/guestfish.pod:92
22270 msgid "On one command line"
22275 #: ../fish/guestfish.pod:94
22276 msgid "Update C</etc/resolv.conf> in a guest:"
22281 #: ../fish/guestfish.pod:96
22285 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
22286 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
22292 #: ../fish/guestfish.pod:100
22293 msgid "Edit C</boot/grub/grub.conf> interactively:"
22298 #: ../fish/guestfish.pod:102
22301 " guestfish --rw --add disk.img \\\n"
22302 " --mount /dev/vg_guest/lv_root \\\n"
22303 " --mount /dev/sda1:/boot \\\n"
22304 " edit /boot/grub/grub.conf\n"
22310 #: ../fish/guestfish.pod:107
22311 msgid "Mount disks automatically"
22316 #: ../fish/guestfish.pod:109
22318 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
22323 #: ../fish/guestfish.pod:112
22326 " guestfish --ro -a disk.img -i cat /etc/group\n"
22332 #: ../fish/guestfish.pod:114
22335 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
22341 #: ../fish/guestfish.pod:116
22342 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
22347 #: ../fish/guestfish.pod:118
22350 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
22356 #: ../fish/guestfish.pod:120
22357 msgid "As a script interpreter"
22362 #: ../fish/guestfish.pod:122
22363 msgid "Create a 100MB disk containing an ext2-formatted partition:"
22368 #: ../fish/guestfish.pod:124
22371 " #!/usr/bin/guestfish -f\n"
22372 " sparse test1.img 100M\n"
22374 " part-disk /dev/sda mbr\n"
22375 " mkfs ext2 /dev/sda1\n"
22381 #: ../fish/guestfish.pod:130
22382 msgid "Start with a prepared disk"
22387 #: ../fish/guestfish.pod:132
22389 "An alternate way to create a 100MB disk called C<test1.img> containing a "
22390 "single ext2-formatted partition:"
22395 #: ../fish/guestfish.pod:135
22398 " guestfish -N fs\n"
22404 #: ../fish/guestfish.pod:137
22405 msgid "To list what is available do:"
22410 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
22413 " guestfish -N help | less\n"
22419 #: ../fish/guestfish.pod:141
22420 msgid "Remote control"
22425 #: ../fish/guestfish.pod:143
22428 " eval \"`guestfish --listen`\"\n"
22429 " guestfish --remote add-ro disk.img\n"
22430 " guestfish --remote run\n"
22431 " guestfish --remote lvs\n"
22437 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
22438 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
22439 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
22440 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
22446 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
22447 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
22448 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
22449 #: ../tools/virt-list-partitions.pl:62
22455 #: ../fish/guestfish.pod:154
22456 msgid "Displays general help on options."
22461 #: ../fish/guestfish.pod:156
22467 #: ../fish/guestfish.pod:158
22468 msgid "B<--cmd-help>"
22473 #: ../fish/guestfish.pod:160
22474 msgid "Lists all available guestfish commands."
22479 #: ../fish/guestfish.pod:162
22485 #: ../fish/guestfish.pod:164
22486 msgid "B<--cmd-help cmd>"
22491 #: ../fish/guestfish.pod:166
22492 msgid "Displays detailed help on a single command C<cmd>."
22497 #: ../fish/guestfish.pod:168
22498 msgid "B<-a image>"
22503 #: ../fish/guestfish.pod:170
22504 msgid "B<--add image>"
22509 #: ../fish/guestfish.pod:172
22510 msgid "Add a block device or virtual machine image to the shell."
22515 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
22517 "The format of the disk image is auto-detected. To override this and force a "
22518 "particular format use the I<--format=..> option."
22522 #: ../fish/guestfish.pod:177
22524 "Using this flag is mostly equivalent to using the C<add> command, with "
22525 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
22526 "the I<--format=...> flag was given."
22531 #: ../fish/guestfish.pod:181
22537 #: ../fish/guestfish.pod:183
22538 msgid "B<--connect URI>"
22543 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22545 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22546 "URI to use. The default is to use the default libvirt connection."
22551 #: ../fish/guestfish.pod:189
22557 #: ../fish/guestfish.pod:191
22559 "If using the I<--listen> option and a csh-like shell, use this option. See "
22560 "section L</REMOTE CONTROL AND CSH> below."
22565 #: ../fish/guestfish.pod:194
22566 msgid "B<-d libvirt-domain>"
22571 #: ../fish/guestfish.pod:196
22572 msgid "B<--domain libvirt-domain>"
22577 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22579 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22580 "used, then any libvirt domain can be used. However in write mode, only "
22581 "libvirt domains which are shut down can be named here."
22585 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
22586 msgid "Domain UUIDs can be used instead of names."
22591 #: ../fish/guestfish.pod:204
22593 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22594 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22595 "if the I<--format:...> flag was given."
22600 #: ../fish/guestfish.pod:208
22606 #: ../fish/guestfish.pod:210
22607 msgid "B<--no-dest-paths>"
22612 #: ../fish/guestfish.pod:212
22614 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22615 "to hit the tab key to complete paths on the guest filesystem, but this "
22616 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22617 "allow this feature to be disabled."
22622 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22623 msgid "B<--echo-keys>"
22628 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
22630 "When prompting for keys and passphrases, guestfish normally turns echoing "
22631 "off so you cannot see what you are typing. If you are not worried about "
22632 "Tempest attacks and there is no one else in the room you can specify this "
22633 "flag to see what you are typing."
22638 #: ../fish/guestfish.pod:224
22644 #: ../fish/guestfish.pod:226
22645 msgid "B<--file file>"
22650 #: ../fish/guestfish.pod:228
22651 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22656 #: ../fish/guestfish.pod:231
22659 " #!/usr/bin/guestfish -f\n"
22665 #: ../fish/guestfish.pod:233
22666 msgid "B<--format=raw|qcow2|..>"
22671 #: ../fish/guestfish.pod:235
22672 msgid "B<--format>"
22677 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
22679 "The default for the I<-a> option is to auto-detect the format of the disk "
22680 "image. Using this forces the disk format for I<-a> options which follow on "
22681 "the command line. Using I<--format> with no argument switches back to auto-"
22682 "detection for subsequent I<-a> options."
22687 #: ../fish/guestfish.pod:244
22690 " guestfish --format=raw -a disk.img\n"
22696 #: ../fish/guestfish.pod:246
22697 msgid "forces raw format (no auto-detection) for C<disk.img>."
22702 #: ../fish/guestfish.pod:248
22705 " guestfish --format=raw -a disk.img --format -a another.img\n"
22711 #: ../fish/guestfish.pod:250
22713 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22714 "detection for C<another.img>."
22719 #: ../fish/guestfish.pod:253
22721 "If you have untrusted raw-format guest disk images, you should use this "
22722 "option to specify the disk format. This avoids a possible security problem "
22723 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22728 #: ../fish/guestfish.pod:258
22734 #: ../fish/guestfish.pod:260
22735 msgid "B<--inspector>"
22740 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
22742 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22743 "system and mount filesystems as they would be mounted on the real virtual "
22749 #: ../fish/guestfish.pod:266
22750 msgid "Typical usage is either:"
22755 #: ../fish/guestfish.pod:268
22758 " guestfish -d myguest -i\n"
22764 #: ../fish/guestfish.pod:270
22765 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22770 #: ../fish/guestfish.pod:272
22773 " guestfish --ro -d myguest -i\n"
22779 #: ../fish/guestfish.pod:274
22780 msgid "(for active domains, readonly), or specify the block device directly:"
22785 #: ../fish/guestfish.pod:276
22788 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22794 #: ../fish/guestfish.pod:278
22796 "Note that the command line syntax changed slightly over older versions of "
22797 "guestfish. You can still use the old syntax:"
22802 #: ../fish/guestfish.pod:281
22805 " guestfish [--ro] -i disk.img\n"
22811 #: ../fish/guestfish.pod:283
22814 " guestfish [--ro] -i libvirt-domain\n"
22820 #: ../fish/guestfish.pod:285
22822 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22823 "then using other commands to mount the filesystems that were found."
22828 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22829 msgid "B<--keys-from-stdin>"
22834 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
22836 "Read key or passphrase parameters from stdin. The default is to try to read "
22837 "passphrases from the user by opening C</dev/tty>."
22842 #: ../fish/guestfish.pod:294
22843 msgid "B<--listen>"
22848 #: ../fish/guestfish.pod:296
22850 "Fork into the background and listen for remote commands. See section L</"
22851 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22855 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22860 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
22862 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22863 "ATTACHING TO RUNNING DAEMONS>)."
22867 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22868 msgid "B<-m dev[:mountpoint[:options]]>"
22872 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
22873 msgid "B<--mount dev[:mountpoint[:options]]>"
22878 #: ../fish/guestfish.pod:308
22879 msgid "Mount the named partition or logical volume on the given mountpoint."
22884 #: ../fish/guestfish.pod:310
22885 msgid "If the mountpoint is omitted, it defaults to C</>."
22890 #: ../fish/guestfish.pod:312
22891 msgid "You have to mount something on C</> before most commands will work."
22896 #: ../fish/guestfish.pod:314
22898 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22904 #: ../fish/guestfish.pod:317
22906 "If you don't know what filesystems a disk image contains, you can either run "
22907 "guestfish without this option, then list the partitions, filesystems and LVs "
22908 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22909 "commands), or you can use the L<virt-filesystems(1)> program."
22913 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
22915 "The third (and rarely used) part of the mount parameter is the list of mount "
22916 "options used to mount the underlying filesystem. If this is not given, then "
22917 "the mount options are either the empty string or C<ro> (the latter if the "
22918 "I<--ro> flag is used). By specifying the mount options, you override this "
22919 "default choice. Probably the only time you would use this is to enable ACLs "
22920 "and/or extended attributes if the filesystem can support them:"
22924 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
22927 " -m /dev/sda1:/:acl,user_xattr\n"
22932 #: ../fish/guestfish.pod:333
22933 msgid "Using this flag is equivalent to using the C<mount-options> command."
22938 #: ../fish/guestfish.pod:335
22944 #: ../fish/guestfish.pod:337
22945 msgid "B<--no-sync>"
22950 #: ../fish/guestfish.pod:339
22952 "Disable autosync. This is enabled by default. See the discussion of "
22953 "autosync in the L<guestfs(3)> manpage."
22958 #: ../fish/guestfish.pod:342
22964 #: ../fish/guestfish.pod:344
22965 msgid "B<--new type>"
22970 #: ../fish/guestfish.pod:346
22976 #: ../fish/guestfish.pod:348
22978 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22979 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22980 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22986 #: ../fish/guestfish.pod:353
22987 msgid "B<--progress-bars>"
22992 #: ../fish/guestfish.pod:355
22993 msgid "Enable progress bars, even when guestfish is used non-interactively."
22998 #: ../fish/guestfish.pod:357
23000 "Progress bars are enabled by default when guestfish is used as an "
23001 "interactive shell."
23006 #: ../fish/guestfish.pod:360
23007 msgid "B<--no-progress-bars>"
23012 #: ../fish/guestfish.pod:362
23013 msgid "Disable progress bars."
23018 #: ../fish/guestfish.pod:364
23019 msgid "B<--remote[=pid]>"
23024 #: ../fish/guestfish.pod:366
23026 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
23027 "CONTROL GUESTFISH OVER A SOCKET> below."
23032 #: ../fish/guestfish.pod:369
23038 #: ../fish/guestfish.pod:371
23044 #: ../fish/guestfish.pod:373
23046 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
23047 "mounts are done read-only."
23052 #: ../fish/guestfish.pod:376
23054 "The option must always be used if the disk image or virtual machine might be "
23055 "running, and is generally recommended in cases where you don't need write "
23056 "access to the disk."
23061 #: ../fish/guestfish.pod:380
23063 "Note that prepared disk images created with I<-N> are not affected by this "
23064 "option. Also commands like C<add> are not affected - you have to specify "
23065 "the C<readonly:true> option explicitly if you need it."
23070 #: ../fish/guestfish.pod:384
23071 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
23076 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
23077 msgid "B<--selinux>"
23082 #: ../fish/guestfish.pod:388
23083 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
23088 #: ../fish/guestfish.pod:390
23094 #: ../fish/guestfish.pod:392
23095 msgid "B<--verbose>"
23100 #: ../fish/guestfish.pod:394
23102 "Enable very verbose messages. This is particularly useful if you find a bug."
23107 #: ../fish/guestfish.pod:397
23113 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
23114 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
23115 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
23116 msgid "B<--version>"
23121 #: ../fish/guestfish.pod:401
23122 msgid "Display the guestfish / libguestfs version number and exit."
23127 #: ../fish/guestfish.pod:403
23133 #: ../fish/guestfish.pod:405
23138 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
23140 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
23141 "mounts are done read-write."
23145 #: ../fish/guestfish.pod:410
23146 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
23151 #: ../fish/guestfish.pod:412
23157 #: ../fish/guestfish.pod:414
23158 msgid "Echo each command before executing it."
23163 #: ../fish/guestfish.pod:418
23164 msgid "COMMANDS ON COMMAND LINE"
23169 #: ../fish/guestfish.pod:420
23171 "Any additional (non-option) arguments are treated as commands to execute."
23176 #: ../fish/guestfish.pod:423
23178 "Commands to execute should be separated by a colon (C<:>), where the colon "
23179 "is a separate parameter. Thus:"
23184 #: ../fish/guestfish.pod:426
23187 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
23193 #: ../fish/guestfish.pod:428
23195 "If there are no additional arguments, then we enter a shell, either an "
23196 "interactive shell with a prompt (if the input is a terminal) or a non-"
23197 "interactive shell."
23202 #: ../fish/guestfish.pod:432
23204 "In either command line mode or non-interactive shell, the first command that "
23205 "gives an error causes the whole shell to exit. In interactive mode (with a "
23206 "prompt) if a command fails, you can continue to enter commands."
23211 #: ../fish/guestfish.pod:437
23212 msgid "USING launch (OR run)"
23217 #: ../fish/guestfish.pod:439
23219 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
23220 "then launch it, then mount any disks you need, and finally issue actions/"
23221 "commands. So the general order of the day is:"
23226 #: ../fish/guestfish.pod:447
23227 msgid "add or -a/--add"
23232 #: ../fish/guestfish.pod:451
23233 msgid "launch (aka run)"
23238 #: ../fish/guestfish.pod:455
23239 msgid "mount or -m/--mount"
23244 #: ../fish/guestfish.pod:459
23245 msgid "any other commands"
23250 #: ../fish/guestfish.pod:463
23252 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
23253 "guest before mounting or performing any other commands."
23258 #: ../fish/guestfish.pod:466
23260 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
23261 "I<--new> options were given then C<run> is done automatically, simply "
23262 "because guestfish can't perform the action you asked for without doing this."
23267 #: ../fish/guestfish.pod:471
23268 msgid "OPENING DISKS FOR READ AND WRITE"
23272 #: ../fish/guestfish.pod:473
23274 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
23275 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
23276 "I<-i> and I<-m> open disk images read-only or for writing."
23280 #: ../fish/guestfish.pod:478
23282 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
23283 "opening disk images supplied on the command line for write. To open a disk "
23284 "image read-only you have to do I<-a image --ro>."
23289 #: ../fish/guestfish.pod:482
23291 "This matters: If you accidentally open a live VM disk image writable then "
23292 "you will cause irreversible disk corruption."
23296 #: ../fish/guestfish.pod:485
23298 "By libguestfs 1.12 we intend to change the default the other way. Disk "
23299 "images will be opened read-only. You will have to either specify "
23300 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
23301 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
23302 "access for disk images specified by those other command line options."
23306 #: ../fish/guestfish.pod:492
23308 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
23309 "which does nothing (it is already the default). However it is highly "
23310 "recommended that you use this option to indicate that you need write access, "
23311 "and prepare your scripts for the day when this option will be required for "
23317 #: ../fish/guestfish.pod:498
23319 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
23320 "other libguestfs program apart from guestfish and guestmount."
23325 #: ../fish/guestfish.pod:501
23331 #: ../fish/guestfish.pod:503
23333 "You can quote ordinary parameters using either single or double quotes. For "
23339 #: ../fish/guestfish.pod:506
23342 " add \"file with a space.img\"\n"
23348 #: ../fish/guestfish.pod:508
23351 " rm '/file name'\n"
23357 #: ../fish/guestfish.pod:510
23366 #: ../fish/guestfish.pod:512
23368 "A few commands require a list of strings to be passed. For these, use a "
23369 "whitespace-separated list, enclosed in quotes. Strings containing "
23370 "whitespace to be passed through must be enclosed in single quotes. A "
23371 "literal single quote must be escaped with a backslash."
23376 #: ../fish/guestfish.pod:517
23379 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
23380 " command \"/bin/echo 'foo bar'\"\n"
23381 " command \"/bin/echo \\'foo\\'\"\n"
23387 #: ../fish/guestfish.pod:521
23388 msgid "OPTIONAL ARGUMENTS"
23393 #: ../fish/guestfish.pod:523
23395 "Some commands take optional arguments. These arguments appear in this "
23396 "documentation as C<[argname:..]>. You can use them as in these examples:"
23401 #: ../fish/guestfish.pod:527
23404 " add-drive-opts filename\n"
23410 #: ../fish/guestfish.pod:529
23413 " add-drive-opts filename readonly:true\n"
23419 #: ../fish/guestfish.pod:531
23422 " add-drive-opts filename format:qcow2 readonly:false\n"
23428 #: ../fish/guestfish.pod:533
23430 "Each optional argument can appear at most once. All optional arguments must "
23431 "appear after the required ones."
23436 #: ../fish/guestfish.pod:536
23442 #: ../fish/guestfish.pod:538
23444 "This section applies to all commands which can take integers as parameters."
23449 #: ../fish/guestfish.pod:541
23450 msgid "SIZE SUFFIX"
23455 #: ../fish/guestfish.pod:543
23457 "When the command takes a parameter measured in bytes, you can use one of the "
23458 "following suffixes to specify kilobytes, megabytes and larger sizes:"
23463 #: ../fish/guestfish.pod:549
23464 msgid "B<k> or B<K> or B<KiB>"
23469 #: ../fish/guestfish.pod:551
23470 msgid "The size in kilobytes (multiplied by 1024)."
23475 #: ../fish/guestfish.pod:553
23481 #: ../fish/guestfish.pod:555
23482 msgid "The size in SI 1000 byte units."
23487 #: ../fish/guestfish.pod:557
23488 msgid "B<M> or B<MiB>"
23493 #: ../fish/guestfish.pod:559
23494 msgid "The size in megabytes (multiplied by 1048576)."
23499 #: ../fish/guestfish.pod:561
23505 #: ../fish/guestfish.pod:563
23506 msgid "The size in SI 1000000 byte units."
23511 #: ../fish/guestfish.pod:565
23512 msgid "B<G> or B<GiB>"
23517 #: ../fish/guestfish.pod:567
23518 msgid "The size in gigabytes (multiplied by 2**30)."
23523 #: ../fish/guestfish.pod:569
23529 #: ../fish/guestfish.pod:571
23530 msgid "The size in SI 10**9 byte units."
23535 #: ../fish/guestfish.pod:573
23536 msgid "B<T> or B<TiB>"
23541 #: ../fish/guestfish.pod:575
23542 msgid "The size in terabytes (multiplied by 2**40)."
23547 #: ../fish/guestfish.pod:577
23553 #: ../fish/guestfish.pod:579
23554 msgid "The size in SI 10**12 byte units."
23559 #: ../fish/guestfish.pod:581
23560 msgid "B<P> or B<PiB>"
23565 #: ../fish/guestfish.pod:583
23566 msgid "The size in petabytes (multiplied by 2**50)."
23571 #: ../fish/guestfish.pod:585
23577 #: ../fish/guestfish.pod:587
23578 msgid "The size in SI 10**15 byte units."
23583 #: ../fish/guestfish.pod:589
23584 msgid "B<E> or B<EiB>"
23589 #: ../fish/guestfish.pod:591
23590 msgid "The size in exabytes (multiplied by 2**60)."
23595 #: ../fish/guestfish.pod:593
23601 #: ../fish/guestfish.pod:595
23602 msgid "The size in SI 10**18 byte units."
23607 #: ../fish/guestfish.pod:597
23608 msgid "B<Z> or B<ZiB>"
23613 #: ../fish/guestfish.pod:599
23614 msgid "The size in zettabytes (multiplied by 2**70)."
23619 #: ../fish/guestfish.pod:601
23625 #: ../fish/guestfish.pod:603
23626 msgid "The size in SI 10**21 byte units."
23631 #: ../fish/guestfish.pod:605
23632 msgid "B<Y> or B<YiB>"
23637 #: ../fish/guestfish.pod:607
23638 msgid "The size in yottabytes (multiplied by 2**80)."
23643 #: ../fish/guestfish.pod:609
23649 #: ../fish/guestfish.pod:611
23650 msgid "The size in SI 10**24 byte units."
23655 #: ../fish/guestfish.pod:617
23658 " truncate-size /file 1G\n"
23664 #: ../fish/guestfish.pod:619
23665 msgid "would truncate the file to 1 gigabyte."
23670 #: ../fish/guestfish.pod:621
23672 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23673 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23674 "suffix will probably not do what you expect."
23679 #: ../fish/guestfish.pod:625
23680 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23685 #: ../fish/guestfish.pod:627
23687 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23688 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23693 #: ../fish/guestfish.pod:630
23696 " 1234 decimal number 1234\n"
23697 " 02322 octal number, equivalent to decimal 1234\n"
23698 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23704 #: ../fish/guestfish.pod:634
23706 "When using the C<chmod> command, you almost always want to specify an octal "
23707 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23708 "L<chmod(1)> program):"
23713 #: ../fish/guestfish.pod:638
23716 " chmod 0777 /public # OK\n"
23717 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23723 #: ../fish/guestfish.pod:641
23725 "Commands that return numbers usually print them in decimal, but some "
23726 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23727 "octal, preceeded by C<0>)."
23732 #: ../fish/guestfish.pod:645
23733 msgid "WILDCARDS AND GLOBBING"
23738 #: ../fish/guestfish.pod:647
23740 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23741 "(globbing) by default. So for example the following will not do what you "
23747 #: ../fish/guestfish.pod:651
23756 #: ../fish/guestfish.pod:653
23758 "Assuming you don't have a directory called literally C</home/*> then the "
23759 "above command will return an error."
23764 #: ../fish/guestfish.pod:656
23765 msgid "To perform wildcard expansion, use the C<glob> command."
23770 #: ../fish/guestfish.pod:658
23773 " glob rm-rf /home/*\n"
23779 #: ../fish/guestfish.pod:660
23781 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23782 "many times), equivalent to:"
23787 #: ../fish/guestfish.pod:663
23790 " rm-rf /home/jim\n"
23791 " rm-rf /home/joe\n"
23792 " rm-rf /home/mary\n"
23798 #: ../fish/guestfish.pod:667
23799 msgid "C<glob> only works on simple guest paths and not on device names."
23804 #: ../fish/guestfish.pod:669
23806 "If you have several parameters, each containing a wildcard, then glob will "
23807 "perform a Cartesian product."
23812 #: ../fish/guestfish.pod:672
23818 #: ../fish/guestfish.pod:674
23820 "Any line which starts with a I<#> character is treated as a comment and "
23821 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23822 "a command. For example:"
23827 #: ../fish/guestfish.pod:678
23830 " # this is a comment\n"
23831 " # this is a comment\n"
23832 " foo # NOT a comment\n"
23838 #: ../fish/guestfish.pod:682
23839 msgid "Blank lines are also ignored."
23844 #: ../fish/guestfish.pod:684
23845 msgid "RUNNING COMMANDS LOCALLY"
23850 #: ../fish/guestfish.pod:686
23852 "Any line which starts with a I<!> character is treated as a command sent to "
23853 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23858 #: ../fish/guestfish.pod:690
23862 " tgz-out /remote local/remote-data.tar.gz\n"
23868 #: ../fish/guestfish.pod:693
23870 "will create a directory C<local> on the host, and then export the contents "
23871 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23872 "(See C<tgz-out>)."
23877 #: ../fish/guestfish.pod:697
23879 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23880 "effect, due to the way that subprocesses work in Unix."
23884 #: ../fish/guestfish.pod:700
23885 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23889 #: ../fish/guestfish.pod:702
23891 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23892 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23893 "and executed as guestfish commands."
23897 #: ../fish/guestfish.pod:706
23899 "Thus you can use shell script to construct arbitrary guestfish commands "
23900 "which are then parsed by guestfish."
23904 #: ../fish/guestfish.pod:709
23906 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23907 "through C</foo.100>) using guestfish commands alone. However this is simple "
23908 "if we use a shell script to create the guestfish commands for us:"
23912 #: ../fish/guestfish.pod:714
23915 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23920 #: ../fish/guestfish.pod:716
23921 msgid "or with names like C</foo.001>:"
23925 #: ../fish/guestfish.pod:718
23928 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23933 #: ../fish/guestfish.pod:720
23935 "When using guestfish interactively it can be helpful to just run the shell "
23936 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23937 "ordinary I<!> local command), see what guestfish commands it would run, and "
23938 "when you are happy with those prepend the C<E<lt>> character to run the "
23939 "guestfish commands for real."
23944 #: ../fish/guestfish.pod:726
23950 #: ../fish/guestfish.pod:728
23952 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23953 "command (a guestfish command) to the second command (any host command). For "
23959 #: ../fish/guestfish.pod:732
23962 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23968 #: ../fish/guestfish.pod:734
23970 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23971 "program). The above command would list all accounts in the guest filesystem "
23972 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23977 #: ../fish/guestfish.pod:739
23980 " hexdump /bin/ls | head\n"
23981 " list-devices | tail -1\n"
23982 " tgz-out / - | tar ztf -\n"
23988 #: ../fish/guestfish.pod:743
23990 "The space before the pipe symbol is required, any space after the pipe "
23991 "symbol is optional. Everything after the pipe symbol is just passed "
23992 "straight to the host shell, so it can contain redirections, globs and "
23993 "anything else that makes sense on the host side."
23998 #: ../fish/guestfish.pod:748
24000 "To use a literal argument which begins with a pipe symbol, you have to quote "
24006 #: ../fish/guestfish.pod:751
24015 #: ../fish/guestfish.pod:753
24016 msgid "HOME DIRECTORIES"
24021 #: ../fish/guestfish.pod:755
24023 "If a parameter starts with the character C<~> then the tilde may be expanded "
24024 "as a home directory path (either C<~> for the current user's home directory, "
24025 "or C<~user> for another user)."
24030 #: ../fish/guestfish.pod:759
24032 "Note that home directory expansion happens for users known I<on the host>, "
24033 "not in the guest filesystem."
24038 #: ../fish/guestfish.pod:762
24040 "To use a literal argument which begins with a tilde, you have to quote it, "
24046 #: ../fish/guestfish.pod:765
24055 #: ../fish/guestfish.pod:769
24057 "Libguestfs has some support for Linux guests encrypted according to the "
24058 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
24059 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
24060 "LUKS is supported."
24065 #: ../fish/guestfish.pod:774
24066 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
24071 #: ../fish/guestfish.pod:776
24074 " ><fs> vfs-type /dev/sda2\n"
24081 #: ../fish/guestfish.pod:779
24083 "Then open those devices using L</luks-open>. This creates a device-mapper "
24084 "device called C</dev/mapper/luksdev>."
24089 #: ../fish/guestfish.pod:782
24092 " ><fs> luks-open /dev/sda2 luksdev\n"
24093 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
24099 #: ../fish/guestfish.pod:785
24101 "Finally you have to tell LVM to scan for volume groups on the newly created "
24107 #: ../fish/guestfish.pod:788
24111 " vg-activate-all true\n"
24117 #: ../fish/guestfish.pod:791
24118 msgid "The logical volume(s) can now be mounted in the usual way."
24123 #: ../fish/guestfish.pod:793
24125 "Before closing a LUKS device you must unmount any logical volumes on it and "
24126 "deactivate the volume groups by calling C<vg-activate false VG> on each "
24127 "one. Then you can close the mapper device:"
24132 #: ../fish/guestfish.pod:797
24135 " vg-activate false /dev/VG\n"
24136 " luks-close /dev/mapper/luksdev\n"
24142 #: ../fish/guestfish.pod:800
24143 msgid "WINDOWS PATHS"
24147 #: ../fish/guestfish.pod:802
24149 "If a path is prefixed with C<win:> then you can use Windows-style drive "
24150 "letters and paths (with some limitations). The following commands are "
24156 #: ../fish/guestfish.pod:806
24159 " file /WINDOWS/system32/config/system.LOG\n"
24165 #: ../fish/guestfish.pod:808
24168 " file win:\\windows\\system32\\config\\system.log\n"
24173 #: ../fish/guestfish.pod:810
24176 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
24181 #: ../fish/guestfish.pod:812
24183 "The parameter is rewritten \"behind the scenes\" by looking up the position "
24184 "where the drive is mounted, prepending that to the path, changing all "
24185 "backslash characters to forward slash, then resolving the result using L</"
24186 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
24187 "the parameter might be rewritten like this:"
24191 #: ../fish/guestfish.pod:818
24194 " win:e:\\foo\\bar => /e/FOO/bar\n"
24199 #: ../fish/guestfish.pod:820
24200 msgid "This only works in argument positions that expect a path."
24205 #: ../fish/guestfish.pod:822
24206 msgid "UPLOADING AND DOWNLOADING FILES"
24211 #: ../fish/guestfish.pod:824
24213 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
24214 "others which upload from or download to a local file, you can use the "
24215 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
24220 #: ../fish/guestfish.pod:828
24229 #: ../fish/guestfish.pod:830
24231 "reads stdin and creates from that a file C</foo> in the disk image, and:"
24236 #: ../fish/guestfish.pod:833
24239 " tar-out /etc - | tar tf -\n"
24245 #: ../fish/guestfish.pod:835
24247 "writes the tarball to stdout and then pipes that into the external \"tar\" "
24248 "command (see L</PIPES>)."
24253 #: ../fish/guestfish.pod:838
24255 "When using C<-> to read from stdin, the input is read up to the end of "
24256 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
24257 "some arbitrary end marker:"
24262 #: ../fish/guestfish.pod:842
24265 " upload -<<END /foo\n"
24275 #: ../fish/guestfish.pod:848
24277 "Any string of characters can be used instead of C<END>. The end marker must "
24278 "appear on a line of its own, without any preceeding or following characters "
24279 "(not even spaces)."
24284 #: ../fish/guestfish.pod:852
24286 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
24287 "upload local files (so-called \"FileIn\" parameters in the generator)."
24292 #: ../fish/guestfish.pod:855
24293 msgid "EXIT ON ERROR BEHAVIOUR"
24298 #: ../fish/guestfish.pod:857
24300 "By default, guestfish will ignore any errors when in interactive mode (ie. "
24301 "taking commands from a human over a tty), and will exit on the first error "
24302 "in non-interactive mode (scripts, commands given on the command line)."
24307 #: ../fish/guestfish.pod:862
24309 "If you prefix a command with a I<-> character, then that command will not "
24310 "cause guestfish to exit, even if that (one) command returns an error."
24315 #: ../fish/guestfish.pod:866
24316 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
24321 #: ../fish/guestfish.pod:868
24323 "Guestfish can be remote-controlled over a socket. This is useful "
24324 "particularly in shell scripts where you want to make several different "
24325 "changes to a filesystem, but you don't want the overhead of starting up a "
24326 "guestfish process each time."
24331 #: ../fish/guestfish.pod:873
24332 msgid "Start a guestfish server process using:"
24337 #: ../fish/guestfish.pod:875
24340 " eval \"`guestfish --listen`\"\n"
24346 #: ../fish/guestfish.pod:877
24347 msgid "and then send it commands by doing:"
24352 #: ../fish/guestfish.pod:879
24355 " guestfish --remote cmd [...]\n"
24361 #: ../fish/guestfish.pod:881
24362 msgid "To cause the server to exit, send it the exit command:"
24367 #: ../fish/guestfish.pod:883
24370 " guestfish --remote exit\n"
24376 #: ../fish/guestfish.pod:885
24378 "Note that the server will normally exit if there is an error in a command. "
24379 "You can change this in the usual way. See section L</EXIT ON ERROR "
24385 #: ../fish/guestfish.pod:889
24386 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
24391 #: ../fish/guestfish.pod:891
24393 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
24394 "is how the I<--remote> option knows where to send the commands. You can "
24395 "have several guestfish listener processes running using:"
24400 #: ../fish/guestfish.pod:895
24403 " eval \"`guestfish --listen`\"\n"
24404 " pid1=$GUESTFISH_PID\n"
24405 " eval \"`guestfish --listen`\"\n"
24406 " pid2=$GUESTFISH_PID\n"
24408 " guestfish --remote=$pid1 cmd\n"
24409 " guestfish --remote=$pid2 cmd\n"
24415 #: ../fish/guestfish.pod:903
24416 msgid "REMOTE CONTROL AND CSH"
24421 #: ../fish/guestfish.pod:905
24423 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
24429 #: ../fish/guestfish.pod:908
24432 " eval \"`guestfish --listen --csh`\"\n"
24438 #: ../fish/guestfish.pod:910
24439 msgid "REMOTE CONTROL DETAILS"
24444 #: ../fish/guestfish.pod:912
24446 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
24447 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
24448 "and C<$PID> is the process ID of the server."
24453 #: ../fish/guestfish.pod:916
24454 msgid "Guestfish client and server versions must match exactly."
24459 #: ../fish/guestfish.pod:918
24460 msgid "PREPARED DISK IMAGES"
24465 #: ../fish/guestfish.pod:920
24467 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
24468 "preformatted disk images that guestfish can make for you to save typing. "
24469 "This is particularly useful for testing purposes. This option is used "
24470 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
24471 "can be mixed with I<-a>)."
24476 #: ../fish/guestfish.pod:926
24478 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
24479 "the second and so on. Existing files in the current directory are "
24485 #: ../fish/guestfish.pod:930
24487 "The type briefly describes how the disk should be sized, partitioned, how "
24488 "filesystem(s) should be created, and how content should be added. "
24489 "Optionally the type can be followed by extra parameters, separated by C<:> "
24490 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
24491 "allocated disk, containing a single partition, with the partition formatted "
24492 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
24498 #: ../fish/guestfish.pod:938
24499 msgid "To list the available types and any extra parameters they take, run:"
24504 #: ../fish/guestfish.pod:942
24506 "Note that the prepared filesystem is not mounted. You would usually have to "
24507 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
24512 #: ../fish/guestfish.pod:946
24514 "If any I<-N> or I<--new> options are given, the guest is automatically "
24520 #: ../fish/guestfish.pod:951
24521 msgid "Create a 100MB disk with an ext4-formatted partition:"
24526 #: ../fish/guestfish.pod:953
24529 " guestfish -N fs:ext4\n"
24535 #: ../fish/guestfish.pod:955
24536 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24541 #: ../fish/guestfish.pod:957
24544 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24550 #: ../fish/guestfish.pod:959
24551 msgid "Create a blank 200MB disk:"
24556 #: ../fish/guestfish.pod:961
24559 " guestfish -N disk:200M\n"
24565 #: ../fish/guestfish.pod:963
24566 msgid "PROGRESS BARS"
24571 #: ../fish/guestfish.pod:965
24573 "Some (not all) long-running commands send progress notification messages as "
24574 "they are running. Guestfish turns these messages into progress bars."
24579 #: ../fish/guestfish.pod:969
24581 "When a command that supports progress bars takes longer than two seconds to "
24582 "run, and if progress bars are enabled, then you will see one appearing below "
24588 #: ../fish/guestfish.pod:973
24591 " ><fs> copy-size /large-file /another-file 2048M\n"
24592 " / 10% [#####-----------------------------------------] 00:30\n"
24598 #: ../fish/guestfish.pod:976
24600 "The spinner on the left hand side moves round once for every progress "
24601 "notification received from the backend. This is a (reasonably) golden "
24602 "assurance that the command is \"doing something\" even if the progress bar "
24603 "is not moving, because the command is able to send the progress "
24604 "notifications. When the bar reaches 100% and the command finishes, the "
24605 "spinner disappears."
24610 #: ../fish/guestfish.pod:983
24612 "Progress bars are enabled by default when guestfish is used interactively. "
24613 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24614 "and you can disable them completely using I<--no-progress-bars>."
24619 #: ../fish/guestfish.pod:988
24620 msgid "GUESTFISH COMMANDS"
24625 #: ../fish/guestfish.pod:990
24627 "The commands in this section are guestfish convenience commands, in other "
24628 "words, they are not part of the L<guestfs(3)> API."
24633 #: ../fish/guestfish.pod:993
24639 #: ../fish/guestfish.pod:995
24649 #: ../fish/guestfish.pod:998
24650 msgid "Without any parameter, this provides general help."
24655 #: ../fish/guestfish.pod:1000
24656 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24661 #: ../fish/guestfish.pod:1002
24662 msgid "quit | exit"
24667 #: ../fish/guestfish.pod:1004
24668 msgid "This exits guestfish. You can also use C<^D> key."
24673 #: ../fish/guestfish.pod:1006
24674 msgid "@FISH_COMMANDS@"
24679 #: ../fish/guestfish.pod:1008
24685 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24691 #: ../fish/guestfish.pod:1014
24693 "guestfish returns 0 if the commands completed without error, or 1 if there "
24699 #: ../fish/guestfish.pod:1021
24705 #: ../fish/guestfish.pod:1023
24707 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24712 #: ../fish/guestfish.pod:1026
24713 msgid "GUESTFISH_DISPLAY_IMAGE"
24717 #: ../fish/guestfish.pod:1028
24719 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
24720 "If not set, it uses L<display(1)>."
24725 #: ../fish/guestfish.pod:1031
24726 msgid "GUESTFISH_PID"
24731 #: ../fish/guestfish.pod:1033
24733 "Used with the I<--remote> option to specify the remote guestfish process to "
24734 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24739 #: ../fish/guestfish.pod:1037
24745 #: ../fish/guestfish.pod:1039
24747 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24748 "not specified, the external L<hexedit(1)> program is used."
24753 #: ../fish/guestfish.pod:1043
24759 #: ../fish/guestfish.pod:1045
24761 "If compiled with GNU readline support, various files in the home directory "
24762 "can be used. See L</FILES>."
24767 #: ../fish/guestfish.pod:1054
24769 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24770 "effect as using the B<-v> option."
24775 #: ../fish/guestfish.pod:1066
24777 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24778 "the discussion of paths in L<guestfs(3)>."
24783 #: ../fish/guestfish.pod:1077
24784 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24789 #: ../fish/guestfish.pod:1079
24795 #: ../fish/guestfish.pod:1081
24797 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24803 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
24808 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
24809 msgid "$HOME/.libguestfs-tools.rc"
24813 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
24814 msgid "/etc/libguestfs-tools.conf"
24818 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
24820 "This configuration file controls the default read-only or read-write mode "
24821 "(I<--ro> or I<--rw>)."
24825 #: ../fish/guestfish.pod:1108
24826 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24831 #: ../fish/guestfish.pod:1110
24832 msgid "$HOME/.guestfish"
24837 #: ../fish/guestfish.pod:1112
24839 "If compiled with GNU readline support, then the command history is saved in "
24845 #: ../fish/guestfish.pod:1115
24846 msgid "$HOME/.inputrc"
24851 #: ../fish/guestfish.pod:1117
24852 msgid "/etc/inputrc"
24857 #: ../fish/guestfish.pod:1119
24859 "If compiled with GNU readline support, then these files can be used to "
24860 "configure readline. For further information, please see L<readline(3)/"
24861 "INITIALIZATION FILE>."
24866 #: ../fish/guestfish.pod:1123
24867 msgid "To write rules which only apply to guestfish, use:"
24872 #: ../fish/guestfish.pod:1125
24883 #: ../fish/guestfish.pod:1129
24885 "Variables that you can set in inputrc that change the behaviour of guestfish "
24886 "in useful ways include:"
24891 #: ../fish/guestfish.pod:1134
24892 msgid "completion-ignore-case (default: on)"
24897 #: ../fish/guestfish.pod:1136
24899 "By default, guestfish will ignore case when tab-completing paths on the "
24905 #: ../fish/guestfish.pod:1139
24908 " set completion-ignore-case off\n"
24914 #: ../fish/guestfish.pod:1141
24915 msgid "to make guestfish case sensitive."
24920 #: ../fish/guestfish.pod:1145
24926 #: ../fish/guestfish.pod:1147
24927 msgid "test2.img (etc)"
24931 #: ../fish/guestfish.pod:1149
24933 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24934 "will be created in the file C<test1.img> in the current directory. The "
24935 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24936 "the same name will be overwritten."
24940 #: ../fish/guestfish.pod:1158
24942 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24943 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24944 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24945 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24946 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24947 ">, L<display(1)>, L<hexedit(1)>."
24952 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
24953 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
24954 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24955 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24957 "This program is free software; you can redistribute it and/or modify it "
24958 "under the terms of the GNU General Public License as published by the Free "
24959 "Software Foundation; either version 2 of the License, or (at your option) "
24960 "any later version."
24965 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
24966 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
24967 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24968 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24970 "This program is distributed in the hope that it will be useful, but WITHOUT "
24971 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24972 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24978 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
24979 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
24980 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24981 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24983 "You should have received a copy of the GNU General Public License along with "
24984 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24985 "Ave, Cambridge, MA 02139, USA."
24990 #: ../fish/guestfish-actions.pod:1
24996 #: ../fish/guestfish-actions.pod:3
24999 " add-cdrom filename\n"
25005 #: ../fish/guestfish-actions.pod:15
25007 "This call checks for the existence of C<filename>. This stops you from "
25008 "specifying other types of drive which are supported by qemu such as C<nbd:> "
25009 "and C<http:> URLs. To specify those, use the general L</config> call "
25015 #: ../fish/guestfish-actions.pod:22
25017 "If you just want to add an ISO file (often you use this as an efficient way "
25018 "to transfer large files into the guest), then you should probably use L</add-"
25019 "drive-ro> instead."
25024 #: ../fish/guestfish-actions.pod:35
25030 #: ../fish/guestfish-actions.pod:37
25035 #: ../fish/guestfish-actions.pod:39
25038 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
25044 #: ../fish/guestfish-actions.pod:41
25046 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
25047 "It works by connecting to libvirt, requesting the domain and domain XML from "
25048 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
25053 #: ../fish/guestfish-actions.pod:76
25055 "The other optional parameters are passed directly through to L</add-drive-"
25061 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
25062 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3103
25063 #: ../fish/guestfish-actions.pod:3276 ../fish/guestfish-actions.pod:3411
25065 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
25070 #: ../fish/guestfish-actions.pod:81
25076 #: ../fish/guestfish-actions.pod:83
25079 " add-drive filename\n"
25085 #: ../fish/guestfish-actions.pod:85
25087 "This function is the equivalent of calling L</add-drive-opts> with no "
25088 "optional parameters, so the disk is added writable, with the format being "
25089 "detected automatically."
25094 #: ../fish/guestfish-actions.pod:89
25096 "Automatic detection of the format opens you up to a potential security hole "
25097 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
25098 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
25099 "you should think about replacing calls to this function with calls to L</add-"
25100 "drive-opts>, and specifying the format."
25105 #: ../fish/guestfish-actions.pod:96
25106 msgid "add-drive-opts"
25111 #: ../fish/guestfish-actions.pod:98
25117 #: ../fish/guestfish-actions.pod:100
25120 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
25126 #: ../fish/guestfish-actions.pod:127
25128 "This forces the image format. If you omit this (or use L</add-drive> or L</"
25129 "add-drive-ro>) then the format is automatically detected. Possible formats "
25130 "include C<raw> and C<qcow2>."
25135 #: ../fish/guestfish-actions.pod:138
25137 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
25138 "add-drive-with-if> call (q.v.)"
25143 #: ../fish/guestfish-actions.pod:145
25144 msgid "add-drive-ro"
25149 #: ../fish/guestfish-actions.pod:147
25155 #: ../fish/guestfish-actions.pod:149
25158 " add-drive-ro filename\n"
25164 #: ../fish/guestfish-actions.pod:151
25166 "This function is the equivalent of calling L</add-drive-opts> with the "
25167 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
25168 "is added read-only, with the format being detected automatically."
25173 #: ../fish/guestfish-actions.pod:156
25174 msgid "add-drive-ro-with-if"
25179 #: ../fish/guestfish-actions.pod:158
25182 " add-drive-ro-with-if filename iface\n"
25188 #: ../fish/guestfish-actions.pod:160
25190 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
25191 "interface emulation to use at run time."
25196 #: ../fish/guestfish-actions.pod:170
25197 msgid "add-drive-with-if"
25202 #: ../fish/guestfish-actions.pod:172
25205 " add-drive-with-if filename iface\n"
25211 #: ../fish/guestfish-actions.pod:174
25213 "This is the same as L</add-drive> but it allows you to specify the QEMU "
25214 "interface emulation to use at run time."
25219 #: ../fish/guestfish-actions.pod:184
25225 #: ../fish/guestfish-actions.pod:186
25228 " aug-clear augpath\n"
25234 #: ../fish/guestfish-actions.pod:191
25240 #: ../fish/guestfish-actions.pod:193
25249 #: ../fish/guestfish-actions.pod:195
25251 "Close the current Augeas handle and free up any resources used by it. After "
25252 "calling this, you have to call L</aug-init> again before you can use any "
25253 "other Augeas functions."
25258 #: ../fish/guestfish-actions.pod:200
25259 msgid "aug-defnode"
25264 #: ../fish/guestfish-actions.pod:202
25267 " aug-defnode name expr val\n"
25273 #: ../fish/guestfish-actions.pod:207
25275 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
25276 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
25277 "containing that single node."
25282 #: ../fish/guestfish-actions.pod:215
25288 #: ../fish/guestfish-actions.pod:217
25291 " aug-defvar name expr\n"
25297 #: ../fish/guestfish-actions.pod:226
25303 #: ../fish/guestfish-actions.pod:228
25306 " aug-get augpath\n"
25312 #: ../fish/guestfish-actions.pod:233
25318 #: ../fish/guestfish-actions.pod:235
25321 " aug-init root flags\n"
25327 #: ../fish/guestfish-actions.pod:241
25328 msgid "You must call this before using any other L</aug-*> commands."
25333 #: ../fish/guestfish-actions.pod:276
25334 msgid "Do not load the tree in L</aug-init>."
25339 #: ../fish/guestfish-actions.pod:280
25340 msgid "To close the handle, you can call L</aug-close>."
25345 #: ../fish/guestfish-actions.pod:284
25351 #: ../fish/guestfish-actions.pod:286
25354 " aug-insert augpath label true|false\n"
25360 #: ../fish/guestfish-actions.pod:296
25366 #: ../fish/guestfish-actions.pod:298
25375 #: ../fish/guestfish-actions.pod:305
25381 #: ../fish/guestfish-actions.pod:307
25384 " aug-ls augpath\n"
25390 #: ../fish/guestfish-actions.pod:309
25392 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
25393 "resulting nodes into alphabetical order."
25398 #: ../fish/guestfish-actions.pod:312
25404 #: ../fish/guestfish-actions.pod:314
25407 " aug-match augpath\n"
25413 #: ../fish/guestfish-actions.pod:320
25419 #: ../fish/guestfish-actions.pod:322
25422 " aug-mv src dest\n"
25428 #: ../fish/guestfish-actions.pod:327
25434 #: ../fish/guestfish-actions.pod:329
25437 " aug-rm augpath\n"
25443 #: ../fish/guestfish-actions.pod:335
25449 #: ../fish/guestfish-actions.pod:337
25458 #: ../fish/guestfish-actions.pod:341
25460 "The flags which were passed to L</aug-init> affect exactly how files are "
25466 #: ../fish/guestfish-actions.pod:344
25472 #: ../fish/guestfish-actions.pod:346
25475 " aug-set augpath val\n"
25481 #: ../fish/guestfish-actions.pod:350
25483 "In the Augeas API, it is possible to clear a node by setting the value to "
25484 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
25485 "this call. Instead you must use the L</aug-clear> call."
25490 #: ../fish/guestfish-actions.pod:355
25496 #: ../fish/guestfish-actions.pod:357
25499 " available 'groups ...'\n"
25505 #: ../fish/guestfish-actions.pod:363
25507 "The libguestfs groups, and the functions that those groups correspond to, "
25508 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
25509 "runtime by calling L</available-all-groups>."
25514 #: ../fish/guestfish-actions.pod:387
25515 msgid "You must call L</launch> before calling this function."
25520 #: ../fish/guestfish-actions.pod:409
25522 "This call was added in version C<1.0.80>. In previous versions of "
25523 "libguestfs all you could do would be to speculatively execute a command to "
25524 "find out if the daemon implemented it. See also L</version>."
25529 #: ../fish/guestfish-actions.pod:416
25530 msgid "available-all-groups"
25535 #: ../fish/guestfish-actions.pod:418
25538 " available-all-groups\n"
25544 #: ../fish/guestfish-actions.pod:420
25546 "This command returns a list of all optional groups that this daemon knows "
25547 "about. Note this returns both supported and unsupported groups. To find "
25548 "out which ones the daemon can actually support you have to call L</"
25549 "available> on each member of the returned list."
25554 #: ../fish/guestfish-actions.pod:426
25555 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25560 #: ../fish/guestfish-actions.pod:428
25566 #: ../fish/guestfish-actions.pod:430
25569 " base64-in (base64file|-) filename\n"
25575 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25576 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
25577 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
25578 #: ../fish/guestfish-actions.pod:4606 ../fish/guestfish-actions.pod:4618
25579 #: ../fish/guestfish-actions.pod:4629 ../fish/guestfish-actions.pod:4640
25580 #: ../fish/guestfish-actions.pod:4692 ../fish/guestfish-actions.pod:4701
25581 #: ../fish/guestfish-actions.pod:4755 ../fish/guestfish-actions.pod:4778
25582 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25587 #: ../fish/guestfish-actions.pod:437
25593 #: ../fish/guestfish-actions.pod:439
25596 " base64-out filename (base64file|-)\n"
25602 #: ../fish/guestfish-actions.pod:446
25603 msgid "blockdev-flushbufs"
25608 #: ../fish/guestfish-actions.pod:448
25611 " blockdev-flushbufs device\n"
25617 #: ../fish/guestfish-actions.pod:455
25618 msgid "blockdev-getbsz"
25623 #: ../fish/guestfish-actions.pod:457
25626 " blockdev-getbsz device\n"
25632 #: ../fish/guestfish-actions.pod:466
25633 msgid "blockdev-getro"
25638 #: ../fish/guestfish-actions.pod:468
25641 " blockdev-getro device\n"
25647 #: ../fish/guestfish-actions.pod:475
25648 msgid "blockdev-getsize64"
25653 #: ../fish/guestfish-actions.pod:477
25656 " blockdev-getsize64 device\n"
25662 #: ../fish/guestfish-actions.pod:481
25663 msgid "See also L</blockdev-getsz>."
25668 #: ../fish/guestfish-actions.pod:485
25669 msgid "blockdev-getss"
25674 #: ../fish/guestfish-actions.pod:487
25677 " blockdev-getss device\n"
25683 #: ../fish/guestfish-actions.pod:492
25685 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25690 #: ../fish/guestfish-actions.pod:497
25691 msgid "blockdev-getsz"
25696 #: ../fish/guestfish-actions.pod:499
25699 " blockdev-getsz device\n"
25705 #: ../fish/guestfish-actions.pod:504
25707 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25708 "blockdev-getsize64> for the more useful I<size in bytes>."
25713 #: ../fish/guestfish-actions.pod:510
25714 msgid "blockdev-rereadpt"
25719 #: ../fish/guestfish-actions.pod:512
25722 " blockdev-rereadpt device\n"
25728 #: ../fish/guestfish-actions.pod:518
25729 msgid "blockdev-setbsz"
25734 #: ../fish/guestfish-actions.pod:520
25737 " blockdev-setbsz device blocksize\n"
25743 #: ../fish/guestfish-actions.pod:529
25744 msgid "blockdev-setro"
25749 #: ../fish/guestfish-actions.pod:531
25752 " blockdev-setro device\n"
25758 #: ../fish/guestfish-actions.pod:537
25759 msgid "blockdev-setrw"
25764 #: ../fish/guestfish-actions.pod:539
25767 " blockdev-setrw device\n"
25773 #: ../fish/guestfish-actions.pod:545
25774 msgid "case-sensitive-path"
25779 #: ../fish/guestfish-actions.pod:547
25782 " case-sensitive-path path\n"
25788 #: ../fish/guestfish-actions.pod:571
25790 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25791 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25792 "the directories were originally created under Windows)."
25797 #: ../fish/guestfish-actions.pod:579
25798 msgid "See also L</realpath>."
25803 #: ../fish/guestfish-actions.pod:581
25809 #: ../fish/guestfish-actions.pod:583
25818 #: ../fish/guestfish-actions.pod:587
25820 "Note that this function cannot correctly handle binary files (specifically, "
25821 "files containing C<\\0> character which is treated as end of string). For "
25822 "those you need to use the L</read-file> or L</download> functions which have "
25823 "a more complex interface."
25828 #: ../fish/guestfish-actions.pod:595
25834 #: ../fish/guestfish-actions.pod:597
25837 " checksum csumtype path\n"
25843 #: ../fish/guestfish-actions.pod:640
25844 msgid "To get the checksum for a device, use L</checksum-device>."
25849 #: ../fish/guestfish-actions.pod:642
25850 msgid "To get the checksums for many files, use L</checksums-out>."
25855 #: ../fish/guestfish-actions.pod:644
25856 msgid "checksum-device"
25861 #: ../fish/guestfish-actions.pod:646
25864 " checksum-device csumtype device\n"
25870 #: ../fish/guestfish-actions.pod:648
25872 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25873 "device named C<device>. For the types of checksums supported see the L</"
25874 "checksum> command."
25879 #: ../fish/guestfish-actions.pod:652
25880 msgid "checksums-out"
25885 #: ../fish/guestfish-actions.pod:654
25888 " checksums-out csumtype directory (sumsfile|-)\n"
25894 #: ../fish/guestfish-actions.pod:670
25900 #: ../fish/guestfish-actions.pod:672
25903 " chmod mode path\n"
25909 #: ../fish/guestfish-actions.pod:683
25915 #: ../fish/guestfish-actions.pod:685
25918 " chown owner group path\n"
25924 #: ../fish/guestfish-actions.pod:693
25930 #: ../fish/guestfish-actions.pod:695
25933 " command 'arguments ...'\n"
25939 #: ../fish/guestfish-actions.pod:702
25941 "The single parameter is an argv-style list of arguments. The first element "
25942 "is the name of the program to run. Subsequent elements are parameters. The "
25943 "list must be non-empty (ie. must contain a program name). Note that the "
25944 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25949 #: ../fish/guestfish-actions.pod:730
25950 msgid "command-lines"
25955 #: ../fish/guestfish-actions.pod:732
25958 " command-lines 'arguments ...'\n"
25964 #: ../fish/guestfish-actions.pod:734
25966 "This is the same as L</command>, but splits the result into a list of lines."
25971 #: ../fish/guestfish-actions.pod:737
25972 msgid "See also: L</sh-lines>"
25977 #: ../fish/guestfish-actions.pod:742
25983 #: ../fish/guestfish-actions.pod:744
25986 " config qemuparam qemuvalue\n"
25992 #: ../fish/guestfish-actions.pod:755
25998 #: ../fish/guestfish-actions.pod:757
26001 " copy-size src dest size\n"
26007 #: ../fish/guestfish-actions.pod:765
26013 #: ../fish/guestfish-actions.pod:767
26022 #: ../fish/guestfish-actions.pod:772
26028 #: ../fish/guestfish-actions.pod:774
26037 #: ../fish/guestfish-actions.pod:779
26043 #: ../fish/guestfish-actions.pod:781
26052 #: ../fish/guestfish-actions.pod:788
26054 "If the destination is a device, it must be as large or larger than the "
26055 "source file or device, otherwise the copy will fail. This command cannot do "
26056 "partial copies (see L</copy-size>)."
26061 #: ../fish/guestfish-actions.pod:792
26067 #: ../fish/guestfish-actions.pod:794
26076 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
26078 "This command is mostly useful for interactive sessions. It is I<not> "
26079 "intended that you try to parse the output string. Use L</statvfs> from "
26085 #: ../fish/guestfish-actions.pod:802
26091 #: ../fish/guestfish-actions.pod:804
26100 #: ../fish/guestfish-actions.pod:813
26106 #: ../fish/guestfish-actions.pod:815
26115 #: ../fish/guestfish-actions.pod:821
26117 "Another way to get the same information is to enable verbose messages with "
26118 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
26119 "before running the program."
26124 #: ../fish/guestfish-actions.pod:826
26130 #: ../fish/guestfish-actions.pod:828
26133 " download remotefilename (filename|-)\n"
26139 #: ../fish/guestfish-actions.pod:835
26140 msgid "See also L</upload>, L</cat>."
26145 #: ../fish/guestfish-actions.pod:839
26146 msgid "download-offset"
26151 #: ../fish/guestfish-actions.pod:841
26154 " download-offset remotefilename (filename|-) offset size\n"
26160 #: ../fish/guestfish-actions.pod:849
26162 "Note that there is no limit on the amount of data that can be downloaded "
26163 "with this call, unlike with L</pread>, and this call always reads the full "
26164 "amount unless an error occurs."
26169 #: ../fish/guestfish-actions.pod:854
26170 msgid "See also L</download>, L</pread>."
26175 #: ../fish/guestfish-actions.pod:858
26176 msgid "drop-caches"
26181 #: ../fish/guestfish-actions.pod:860
26184 " drop-caches whattodrop\n"
26190 #: ../fish/guestfish-actions.pod:872
26196 #: ../fish/guestfish-actions.pod:874
26205 #: ../fish/guestfish-actions.pod:886
26211 #: ../fish/guestfish-actions.pod:888
26214 " e2fsck-f device\n"
26220 #: ../fish/guestfish-actions.pod:894
26222 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
26223 "should use L</fsck>."
26228 #: ../fish/guestfish-actions.pod:897
26229 msgid "echo-daemon"
26234 #: ../fish/guestfish-actions.pod:899
26237 " echo-daemon 'words ...'\n"
26243 #: ../fish/guestfish-actions.pod:906
26244 msgid "See also L</ping-daemon>."
26249 #: ../fish/guestfish-actions.pod:908
26255 #: ../fish/guestfish-actions.pod:910
26258 " egrep regex path\n"
26264 #: ../fish/guestfish-actions.pod:918
26270 #: ../fish/guestfish-actions.pod:920
26273 " egrepi regex path\n"
26279 #: ../fish/guestfish-actions.pod:928
26285 #: ../fish/guestfish-actions.pod:930
26288 " equal file1 file2\n"
26294 #: ../fish/guestfish-actions.pod:937
26300 #: ../fish/guestfish-actions.pod:939
26309 #: ../fish/guestfish-actions.pod:944
26310 msgid "See also L</is-file>, L</is-dir>, L</stat>."
26315 #: ../fish/guestfish-actions.pod:946
26321 #: ../fish/guestfish-actions.pod:948
26324 " fallocate path len\n"
26330 #: ../fish/guestfish-actions.pod:965
26331 msgid "fallocate64"
26336 #: ../fish/guestfish-actions.pod:967
26339 " fallocate64 path len\n"
26345 #: ../fish/guestfish-actions.pod:973
26347 "Note that this call allocates disk blocks for the file. To create a sparse "
26348 "file use L</truncate-size> instead."
26353 #: ../fish/guestfish-actions.pod:976
26355 "The deprecated call L</fallocate> does the same, but owing to an oversight "
26356 "it only allowed 30 bit lengths to be specified, effectively limiting the "
26357 "maximum size of files created through that call to 1GB."
26362 #: ../fish/guestfish-actions.pod:985
26368 #: ../fish/guestfish-actions.pod:987
26371 " fgrep pattern path\n"
26377 #: ../fish/guestfish-actions.pod:995
26383 #: ../fish/guestfish-actions.pod:997
26386 " fgrepi pattern path\n"
26392 #: ../fish/guestfish-actions.pod:1005
26398 #: ../fish/guestfish-actions.pod:1007
26406 #: ../fish/guestfish-actions.pod:1023
26408 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
26409 "(etc), L</is-zero>."
26414 #: ../fish/guestfish-actions.pod:1026
26415 msgid "file-architecture"
26420 #: ../fish/guestfish-actions.pod:1028
26423 " file-architecture filename\n"
26429 #: ../fish/guestfish-actions.pod:1131
26435 #: ../fish/guestfish-actions.pod:1133
26444 #: ../fish/guestfish-actions.pod:1137
26446 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
26447 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
26452 #: ../fish/guestfish-actions.pod:1141
26458 #: ../fish/guestfish-actions.pod:1143
26461 " fill c len path\n"
26467 #: ../fish/guestfish-actions.pod:1149
26469 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26470 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
26471 "L</fill-pattern>."
26476 #: ../fish/guestfish-actions.pod:1154
26477 msgid "fill-pattern"
26482 #: ../fish/guestfish-actions.pod:1156
26485 " fill-pattern pattern len path\n"
26491 #: ../fish/guestfish-actions.pod:1158
26493 "This function is like L</fill> except that it creates a new file of length "
26494 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
26495 "is truncated if necessary to ensure the length of the file is exactly C<len> "
26501 #: ../fish/guestfish-actions.pod:1163
26507 #: ../fish/guestfish-actions.pod:1165
26510 " find directory\n"
26516 #: ../fish/guestfish-actions.pod:1179
26517 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
26522 #: ../fish/guestfish-actions.pod:1192
26523 msgid "See also L</find0>."
26528 #: ../fish/guestfish-actions.pod:1197
26534 #: ../fish/guestfish-actions.pod:1199
26537 " find0 directory (files|-)\n"
26543 #: ../fish/guestfish-actions.pod:1205
26545 "This command works the same way as L</find> with the following exceptions:"
26550 #: ../fish/guestfish-actions.pod:1232
26551 msgid "findfs-label"
26556 #: ../fish/guestfish-actions.pod:1234
26559 " findfs-label label\n"
26565 #: ../fish/guestfish-actions.pod:1240
26566 msgid "To find the label of a filesystem, use L</vfs-label>."
26571 #: ../fish/guestfish-actions.pod:1242
26572 msgid "findfs-uuid"
26577 #: ../fish/guestfish-actions.pod:1244
26580 " findfs-uuid uuid\n"
26586 #: ../fish/guestfish-actions.pod:1250
26587 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26592 #: ../fish/guestfish-actions.pod:1252
26598 #: ../fish/guestfish-actions.pod:1254
26601 " fsck fstype device\n"
26607 #: ../fish/guestfish-actions.pod:1284
26613 #: ../fish/guestfish-actions.pod:1286
26621 #: ../fish/guestfish-actions.pod:1293
26622 msgid "get-attach-method"
26626 #: ../fish/guestfish-actions.pod:1295
26629 " get-attach-method\n"
26634 #: ../fish/guestfish-actions.pod:1297
26635 msgid "Return the current attach method. See L</set-attach-method>."
26640 #: ../fish/guestfish-actions.pod:1299
26641 msgid "get-autosync"
26646 #: ../fish/guestfish-actions.pod:1301
26655 #: ../fish/guestfish-actions.pod:1305
26661 #: ../fish/guestfish-actions.pod:1307
26670 #: ../fish/guestfish-actions.pod:1311
26671 msgid "get-e2label"
26676 #: ../fish/guestfish-actions.pod:1313
26679 " get-e2label device\n"
26685 #: ../fish/guestfish-actions.pod:1325
26691 #: ../fish/guestfish-actions.pod:1327
26694 " get-e2uuid device\n"
26700 #: ../fish/guestfish-actions.pod:1339
26701 msgid "get-memsize"
26706 #: ../fish/guestfish-actions.pod:1341
26715 #: ../fish/guestfish-actions.pod:1346
26717 "If L</set-memsize> was not called on this handle, and if "
26718 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26719 "value for memsize."
26724 #: ../fish/guestfish-actions.pod:1353
26725 msgid "get-network"
26730 #: ../fish/guestfish-actions.pod:1355
26739 #: ../fish/guestfish-actions.pod:1359
26745 #: ../fish/guestfish-actions.pod:1361
26754 #: ../fish/guestfish-actions.pod:1368
26760 #: ../fish/guestfish-actions.pod:1370
26766 #: ../fish/guestfish-actions.pod:1372
26775 #: ../fish/guestfish-actions.pod:1379
26781 #: ../fish/guestfish-actions.pod:1381
26790 #: ../fish/guestfish-actions.pod:1388
26791 msgid "get-recovery-proc"
26796 #: ../fish/guestfish-actions.pod:1390
26799 " get-recovery-proc\n"
26805 #: ../fish/guestfish-actions.pod:1394
26806 msgid "get-selinux"
26811 #: ../fish/guestfish-actions.pod:1396
26820 #: ../fish/guestfish-actions.pod:1398
26822 "This returns the current setting of the selinux flag which is passed to the "
26823 "appliance at boot time. See L</set-selinux>."
26828 #: ../fish/guestfish-actions.pod:1404
26834 #: ../fish/guestfish-actions.pod:1406
26843 #: ../fish/guestfish-actions.pod:1413
26849 #: ../fish/guestfish-actions.pod:1415
26858 #: ../fish/guestfish-actions.pod:1419
26864 #: ../fish/guestfish-actions.pod:1421
26873 #: ../fish/guestfish-actions.pod:1423
26875 "Return the current umask. By default the umask is C<022> unless it has been "
26876 "set by calling L</umask>."
26881 #: ../fish/guestfish-actions.pod:1426
26882 msgid "get-verbose"
26887 #: ../fish/guestfish-actions.pod:1428
26896 #: ../fish/guestfish-actions.pod:1432
26902 #: ../fish/guestfish-actions.pod:1434
26911 #: ../fish/guestfish-actions.pod:1438
26912 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26917 #: ../fish/guestfish-actions.pod:1441
26923 #: ../fish/guestfish-actions.pod:1443
26926 " getxattr path name\n"
26932 #: ../fish/guestfish-actions.pod:1445
26934 "Get a single extended attribute from file C<path> named C<name>. This call "
26935 "follows symlinks. If you want to lookup an extended attribute for the "
26936 "symlink itself, use L</lgetxattr>."
26941 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
26943 "Normally it is better to get all extended attributes from a file in one go "
26944 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26945 "buggy and do not provide a way to list out attributes. For these "
26946 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26947 "attributes you want in advance and call this function."
26952 #: ../fish/guestfish-actions.pod:1459
26953 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26958 #: ../fish/guestfish-actions.pod:1461
26964 #: ../fish/guestfish-actions.pod:1463
26967 " getxattrs path\n"
26973 #: ../fish/guestfish-actions.pod:1471
26974 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26979 #: ../fish/guestfish-actions.pod:1473
26980 msgid "glob-expand"
26985 #: ../fish/guestfish-actions.pod:1475
26988 " glob-expand pattern\n"
26994 #: ../fish/guestfish-actions.pod:1488
27000 #: ../fish/guestfish-actions.pod:1490
27003 " grep regex path\n"
27009 #: ../fish/guestfish-actions.pod:1498
27015 #: ../fish/guestfish-actions.pod:1500
27018 " grepi regex path\n"
27024 #: ../fish/guestfish-actions.pod:1508
27025 msgid "grub-install"
27030 #: ../fish/guestfish-actions.pod:1510
27033 " grub-install root device\n"
27039 #: ../fish/guestfish-actions.pod:1526
27045 #: ../fish/guestfish-actions.pod:1528
27054 #: ../fish/guestfish-actions.pod:1536
27060 #: ../fish/guestfish-actions.pod:1538
27063 " head-n nrlines path\n"
27069 #: ../fish/guestfish-actions.pod:1551
27075 #: ../fish/guestfish-actions.pod:1553
27084 #: ../fish/guestfish-actions.pod:1561
27090 #: ../fish/guestfish-actions.pod:1563
27093 " initrd-cat initrdpath filename\n"
27099 #: ../fish/guestfish-actions.pod:1575
27100 msgid "See also L</initrd-list>."
27105 #: ../fish/guestfish-actions.pod:1580
27106 msgid "initrd-list"
27111 #: ../fish/guestfish-actions.pod:1582
27114 " initrd-list path\n"
27120 #: ../fish/guestfish-actions.pod:1594
27121 msgid "inotify-add-watch"
27126 #: ../fish/guestfish-actions.pod:1596
27129 " inotify-add-watch path mask\n"
27135 #: ../fish/guestfish-actions.pod:1608
27136 msgid "inotify-close"
27141 #: ../fish/guestfish-actions.pod:1610
27150 #: ../fish/guestfish-actions.pod:1616
27151 msgid "inotify-files"
27156 #: ../fish/guestfish-actions.pod:1618
27165 #: ../fish/guestfish-actions.pod:1620
27167 "This function is a helpful wrapper around L</inotify-read> which just "
27168 "returns a list of pathnames of objects that were touched. The returned "
27169 "pathnames are sorted and deduplicated."
27174 #: ../fish/guestfish-actions.pod:1624
27175 msgid "inotify-init"
27180 #: ../fish/guestfish-actions.pod:1626
27183 " inotify-init maxevents\n"
27189 #: ../fish/guestfish-actions.pod:1632
27191 "C<maxevents> is the maximum number of events which will be queued up between "
27192 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
27193 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
27194 "default was 16384 events. Beyond this limit, the kernel throws away events, "
27195 "but records the fact that it threw them away by setting a flag "
27196 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
27201 #: ../fish/guestfish-actions.pod:1642
27203 "Before any events are generated, you have to add some watches to the "
27204 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
27205 "L</inotify-watch-all>."
27210 #: ../fish/guestfish-actions.pod:1648
27212 "Queued up events should be read periodically by calling L</inotify-read> (or "
27213 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
27214 "If you don't read the events out often enough then you risk the internal "
27215 "queue overflowing."
27220 #: ../fish/guestfish-actions.pod:1655
27222 "The handle should be closed after use by calling L</inotify-close>. This "
27223 "also removes any watches automatically."
27228 #: ../fish/guestfish-actions.pod:1664
27229 msgid "inotify-read"
27234 #: ../fish/guestfish-actions.pod:1666
27243 #: ../fish/guestfish-actions.pod:1679
27244 msgid "inotify-rm-watch"
27249 #: ../fish/guestfish-actions.pod:1681
27252 " inotify-rm-watch wd\n"
27258 #: ../fish/guestfish-actions.pod:1683
27259 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
27264 #: ../fish/guestfish-actions.pod:1686
27265 msgid "inspect-get-arch"
27270 #: ../fish/guestfish-actions.pod:1688
27273 " inspect-get-arch root\n"
27279 #: ../fish/guestfish-actions.pod:1690
27281 "This returns the architecture of the inspected operating system. The "
27282 "possible return values are listed under L</file-architecture>."
27287 #: ../fish/guestfish-actions.pod:1699
27288 msgid "inspect-get-distro"
27293 #: ../fish/guestfish-actions.pod:1701
27296 " inspect-get-distro root\n"
27301 #: ../fish/guestfish-actions.pod:1782
27302 msgid "inspect-get-drive-mappings"
27306 #: ../fish/guestfish-actions.pod:1784
27309 " inspect-get-drive-mappings root\n"
27314 #: ../fish/guestfish-actions.pod:1811
27316 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27317 "get-mountpoints>, L</inspect-get-filesystems>."
27322 #: ../fish/guestfish-actions.pod:1815
27323 msgid "inspect-get-filesystems"
27328 #: ../fish/guestfish-actions.pod:1817
27331 " inspect-get-filesystems root\n"
27337 #: ../fish/guestfish-actions.pod:1827
27339 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27340 "get-mountpoints>."
27344 #: ../fish/guestfish-actions.pod:1830
27345 msgid "inspect-get-format"
27349 #: ../fish/guestfish-actions.pod:1832
27352 " inspect-get-format root\n"
27358 #: ../fish/guestfish-actions.pod:1861
27359 msgid "inspect-get-hostname"
27364 #: ../fish/guestfish-actions.pod:1863
27367 " inspect-get-hostname root\n"
27372 #: ../fish/guestfish-actions.pod:1873
27373 msgid "inspect-get-icon"
27377 #: ../fish/guestfish-actions.pod:1875
27380 " inspect-get-icon root [favicon:..] [highquality:..]\n"
27386 #: ../fish/guestfish-actions.pod:1939
27387 msgid "inspect-get-major-version"
27392 #: ../fish/guestfish-actions.pod:1941
27395 " inspect-get-major-version root\n"
27401 #: ../fish/guestfish-actions.pod:1957
27402 msgid "inspect-get-minor-version"
27407 #: ../fish/guestfish-actions.pod:1959
27410 " inspect-get-minor-version root\n"
27416 #: ../fish/guestfish-actions.pod:1966
27418 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27419 "get-major-version>."
27424 #: ../fish/guestfish-actions.pod:1969
27425 msgid "inspect-get-mountpoints"
27430 #: ../fish/guestfish-actions.pod:1971
27433 " inspect-get-mountpoints root\n"
27438 #: ../fish/guestfish-actions.pod:1990
27440 "For operating systems like Windows which still use drive letters, this call "
27441 "will only return an entry for the first drive \"mounted on\" C</>. For "
27442 "information about the mapping of drive letters to partitions, see L</inspect-"
27443 "get-drive-mappings>."
27448 #: ../fish/guestfish-actions.pod:1996
27450 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27451 "get-filesystems>."
27456 #: ../fish/guestfish-actions.pod:1999
27457 msgid "inspect-get-package-format"
27462 #: ../fish/guestfish-actions.pod:2001
27465 " inspect-get-package-format root\n"
27471 #: ../fish/guestfish-actions.pod:2003
27473 "This function and L</inspect-get-package-management> return the package "
27474 "format and package management tool used by the inspected operating system. "
27475 "For example for Fedora these functions would return C<rpm> (package format) "
27476 "and C<yum> (package management)."
27481 #: ../fish/guestfish-actions.pod:2018
27482 msgid "inspect-get-package-management"
27487 #: ../fish/guestfish-actions.pod:2020
27490 " inspect-get-package-management root\n"
27496 #: ../fish/guestfish-actions.pod:2022
27498 "L</inspect-get-package-format> and this function return the package format "
27499 "and package management tool used by the inspected operating system. For "
27500 "example for Fedora these functions would return C<rpm> (package format) and "
27501 "C<yum> (package management)."
27506 #: ../fish/guestfish-actions.pod:2039
27507 msgid "inspect-get-product-name"
27512 #: ../fish/guestfish-actions.pod:2041
27515 " inspect-get-product-name root\n"
27520 #: ../fish/guestfish-actions.pod:2053
27521 msgid "inspect-get-product-variant"
27525 #: ../fish/guestfish-actions.pod:2055
27528 " inspect-get-product-variant root\n"
27533 #: ../fish/guestfish-actions.pod:2076
27535 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27536 "get-product-name>, L</inspect-get-major-version>."
27541 #: ../fish/guestfish-actions.pod:2080
27542 msgid "inspect-get-roots"
27547 #: ../fish/guestfish-actions.pod:2082
27550 " inspect-get-roots\n"
27556 #: ../fish/guestfish-actions.pod:2084
27558 "This function is a convenient way to get the list of root devices, as "
27559 "returned from a previous call to L</inspect-os>, but without redoing the "
27560 "whole inspection process."
27565 #: ../fish/guestfish-actions.pod:2088
27567 "This returns an empty list if either no root devices were found or the "
27568 "caller has not called L</inspect-os>."
27573 #: ../fish/guestfish-actions.pod:2093
27574 msgid "inspect-get-type"
27579 #: ../fish/guestfish-actions.pod:2095
27582 " inspect-get-type root\n"
27587 #: ../fish/guestfish-actions.pod:2125
27588 msgid "inspect-get-windows-current-control-set"
27592 #: ../fish/guestfish-actions.pod:2127
27595 " inspect-get-windows-current-control-set root\n"
27601 #: ../fish/guestfish-actions.pod:2138
27602 msgid "inspect-get-windows-systemroot"
27607 #: ../fish/guestfish-actions.pod:2140
27610 " inspect-get-windows-systemroot root\n"
27615 #: ../fish/guestfish-actions.pod:2151
27616 msgid "inspect-is-live"
27620 #: ../fish/guestfish-actions.pod:2153
27623 " inspect-is-live root\n"
27628 #: ../fish/guestfish-actions.pod:2155
27630 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27631 "then this returns true if a live image was detected on the disk."
27635 #: ../fish/guestfish-actions.pod:2161
27636 msgid "inspect-is-multipart"
27640 #: ../fish/guestfish-actions.pod:2163
27643 " inspect-is-multipart root\n"
27648 #: ../fish/guestfish-actions.pod:2165
27650 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27651 "then this returns true if the disk is part of a set."
27655 #: ../fish/guestfish-actions.pod:2171
27656 msgid "inspect-is-netinst"
27660 #: ../fish/guestfish-actions.pod:2173
27663 " inspect-is-netinst root\n"
27668 #: ../fish/guestfish-actions.pod:2175
27670 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27671 "then this returns true if the disk is a network installer, ie. not a self-"
27672 "contained install CD but one which is likely to require network access to "
27673 "complete the install."
27678 #: ../fish/guestfish-actions.pod:2183
27679 msgid "inspect-list-applications"
27684 #: ../fish/guestfish-actions.pod:2185
27687 " inspect-list-applications root\n"
27693 #: ../fish/guestfish-actions.pod:2189
27695 "I<Note:> This call works differently from other parts of the inspection "
27696 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27697 "then mount up the disks, before calling this. Listing applications is a "
27698 "significantly more difficult operation which requires access to the full "
27699 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27700 "are just returning data cached in the libguestfs handle, this call actually "
27701 "reads parts of the mounted filesystems during the call."
27706 #: ../fish/guestfish-actions.pod:2279
27712 #: ../fish/guestfish-actions.pod:2281
27721 #: ../fish/guestfish-actions.pod:2296
27723 "You can pass the root string(s) returned to other L</inspect-get-*> "
27724 "functions in order to query further information about each operating system, "
27725 "such as the name and version."
27730 #: ../fish/guestfish-actions.pod:2301
27732 "This function uses other libguestfs features such as L</mount-ro> and L</"
27733 "umount-all> in order to mount and unmount filesystems and look at the "
27734 "contents. This should be called with no disks currently mounted. The "
27735 "function may also use Augeas, so any existing Augeas handle will be closed."
27740 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
27741 #: ../fish/guestfish-actions.pod:2570
27742 msgid "See also L</list-filesystems>."
27747 #: ../fish/guestfish-actions.pod:2315
27748 msgid "is-blockdev"
27753 #: ../fish/guestfish-actions.pod:2317
27756 " is-blockdev path\n"
27762 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
27763 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
27764 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
27765 #: ../fish/guestfish-actions.pod:2421
27766 msgid "See also L</stat>."
27771 #: ../fish/guestfish-actions.pod:2324
27777 #: ../fish/guestfish-actions.pod:2326
27786 #: ../fish/guestfish-actions.pod:2333
27792 #: ../fish/guestfish-actions.pod:2335
27795 " is-chardev path\n"
27801 #: ../fish/guestfish-actions.pod:2342
27807 #: ../fish/guestfish-actions.pod:2344
27816 #: ../fish/guestfish-actions.pod:2351
27822 #: ../fish/guestfish-actions.pod:2353
27831 #: ../fish/guestfish-actions.pod:2361
27837 #: ../fish/guestfish-actions.pod:2363
27846 #: ../fish/guestfish-actions.pod:2370
27852 #: ../fish/guestfish-actions.pod:2372
27861 #: ../fish/guestfish-actions.pod:2380
27862 msgid "is-launching"
27867 #: ../fish/guestfish-actions.pod:2382
27876 #: ../fish/guestfish-actions.pod:2389
27882 #: ../fish/guestfish-actions.pod:2391
27891 #: ../fish/guestfish-actions.pod:2396
27897 #: ../fish/guestfish-actions.pod:2398
27906 #: ../fish/guestfish-actions.pod:2405
27912 #: ../fish/guestfish-actions.pod:2407
27915 " is-socket path\n"
27921 #: ../fish/guestfish-actions.pod:2414
27927 #: ../fish/guestfish-actions.pod:2416
27930 " is-symlink path\n"
27935 #: ../fish/guestfish-actions.pod:2423
27940 #: ../fish/guestfish-actions.pod:2425
27948 #: ../fish/guestfish-actions.pod:2430
27949 msgid "is-zero-device"
27953 #: ../fish/guestfish-actions.pod:2432
27956 " is-zero-device device\n"
27962 #: ../fish/guestfish-actions.pod:2438
27963 msgid "kill-subprocess"
27968 #: ../fish/guestfish-actions.pod:2440
27971 " kill-subprocess\n"
27977 #: ../fish/guestfish-actions.pod:2444
27983 #: ../fish/guestfish-actions.pod:2446
27989 #: ../fish/guestfish-actions.pod:2448
27998 #: ../fish/guestfish-actions.pod:2456
28004 #: ../fish/guestfish-actions.pod:2458
28007 " lchown owner group path\n"
28013 #: ../fish/guestfish-actions.pod:2460
28015 "Change the file owner to C<owner> and group to C<group>. This is like L</"
28016 "chown> but if C<path> is a symlink then the link itself is changed, not the "
28022 #: ../fish/guestfish-actions.pod:2468
28028 #: ../fish/guestfish-actions.pod:2470
28031 " lgetxattr path name\n"
28037 #: ../fish/guestfish-actions.pod:2486
28038 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
28043 #: ../fish/guestfish-actions.pod:2488
28049 #: ../fish/guestfish-actions.pod:2490
28052 " lgetxattrs path\n"
28058 #: ../fish/guestfish-actions.pod:2492
28060 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
28061 "it returns the extended attributes of the link itself."
28065 #: ../fish/guestfish-actions.pod:2496
28070 #: ../fish/guestfish-actions.pod:2498
28079 #: ../fish/guestfish-actions.pod:2503
28080 msgid "list-devices"
28085 #: ../fish/guestfish-actions.pod:2505
28093 #: ../fish/guestfish-actions.pod:2513
28094 msgid "list-dm-devices"
28098 #: ../fish/guestfish-actions.pod:2515
28101 " list-dm-devices\n"
28106 #: ../fish/guestfish-actions.pod:2519
28108 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
28109 "previous call to L</luks-open>."
28113 #: ../fish/guestfish-actions.pod:2522
28115 "Device mapper devices which correspond to logical volumes are I<not> "
28116 "returned in this list. Call L</lvs> if you want to list logical volumes."
28121 #: ../fish/guestfish-actions.pod:2526
28122 msgid "list-filesystems"
28127 #: ../fish/guestfish-actions.pod:2528
28130 " list-filesystems\n"
28136 #: ../fish/guestfish-actions.pod:2547
28138 "This command runs other libguestfs commands, which might include L</mount> "
28139 "and L</umount>, and therefore you should use this soon after launch and only "
28140 "when nothing is mounted."
28145 #: ../fish/guestfish-actions.pod:2551
28147 "Not all of the filesystems returned will be mountable. In particular, swap "
28148 "partitions are returned in the list. Also this command does not check that "
28149 "each filesystem found is valid and mountable, and some filesystems might be "
28150 "mountable but require special options. Filesystems may not all belong to a "
28151 "single logical operating system (use L</inspect-os> to look for OSes)."
28156 #: ../fish/guestfish-actions.pod:2559
28157 msgid "list-partitions"
28162 #: ../fish/guestfish-actions.pod:2561
28165 " list-partitions\n"
28171 #: ../fish/guestfish-actions.pod:2567
28173 "This does not return logical volumes. For that you will need to call L</"
28179 #: ../fish/guestfish-actions.pod:2572
28185 #: ../fish/guestfish-actions.pod:2574
28194 #: ../fish/guestfish-actions.pod:2582
28200 #: ../fish/guestfish-actions.pod:2584
28203 " ln target linkname\n"
28209 #: ../fish/guestfish-actions.pod:2588
28215 #: ../fish/guestfish-actions.pod:2590
28218 " ln-f target linkname\n"
28224 #: ../fish/guestfish-actions.pod:2595
28230 #: ../fish/guestfish-actions.pod:2597
28233 " ln-s target linkname\n"
28239 #: ../fish/guestfish-actions.pod:2601
28245 #: ../fish/guestfish-actions.pod:2603
28248 " ln-sf target linkname\n"
28254 #: ../fish/guestfish-actions.pod:2608
28255 msgid "lremovexattr"
28260 #: ../fish/guestfish-actions.pod:2610
28263 " lremovexattr xattr path\n"
28269 #: ../fish/guestfish-actions.pod:2612
28271 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
28272 "it removes an extended attribute of the link itself."
28277 #: ../fish/guestfish-actions.pod:2616
28283 #: ../fish/guestfish-actions.pod:2618
28292 #: ../fish/guestfish-actions.pod:2624
28294 "This command is mostly useful for interactive sessions. Programs should "
28295 "probably use L</readdir> instead."
28300 #: ../fish/guestfish-actions.pod:2627
28306 #: ../fish/guestfish-actions.pod:2629
28309 " lsetxattr xattr val vallen path\n"
28315 #: ../fish/guestfish-actions.pod:2631
28317 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
28318 "sets an extended attribute of the link itself."
28323 #: ../fish/guestfish-actions.pod:2635
28329 #: ../fish/guestfish-actions.pod:2637
28338 #: ../fish/guestfish-actions.pod:2641
28340 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
28341 "the link is stat-ed, not the file it refers to."
28346 #: ../fish/guestfish-actions.pod:2647
28352 #: ../fish/guestfish-actions.pod:2649
28355 " lstatlist path 'names ...'\n"
28361 #: ../fish/guestfish-actions.pod:2651
28363 "This call allows you to perform the L</lstat> operation on multiple files, "
28364 "where all files are in the directory C<path>. C<names> is the list of files "
28365 "from this directory."
28370 #: ../fish/guestfish-actions.pod:2660
28372 "This call is intended for programs that want to efficiently list a directory "
28373 "contents without making many round-trips. See also L</lxattrlist> for a "
28374 "similarly efficient call for getting extended attributes. Very long "
28375 "directory listings might cause the protocol message size to be exceeded, "
28376 "causing this call to fail. The caller must split up such requests into "
28377 "smaller groups of names."
28382 #: ../fish/guestfish-actions.pod:2668
28383 msgid "luks-add-key"
28388 #: ../fish/guestfish-actions.pod:2670
28391 " luks-add-key device keyslot\n"
28397 #: ../fish/guestfish-actions.pod:2677
28399 "Note that if C<keyslot> already contains a key, then this command will "
28400 "fail. You have to use L</luks-kill-slot> first to remove that key."
28405 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2703
28406 #: ../fish/guestfish-actions.pod:2716 ../fish/guestfish-actions.pod:2730
28407 #: ../fish/guestfish-actions.pod:2756 ../fish/guestfish-actions.pod:2766
28409 "This command has one or more key or passphrase parameters. Guestfish will "
28410 "prompt for these separately."
28415 #: ../fish/guestfish-actions.pod:2684
28421 #: ../fish/guestfish-actions.pod:2686
28424 " luks-close device\n"
28430 #: ../fish/guestfish-actions.pod:2688
28432 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
28433 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
28434 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
28440 #: ../fish/guestfish-actions.pod:2694
28441 msgid "luks-format"
28446 #: ../fish/guestfish-actions.pod:2696
28449 " luks-format device keyslot\n"
28455 #: ../fish/guestfish-actions.pod:2709
28456 msgid "luks-format-cipher"
28461 #: ../fish/guestfish-actions.pod:2711
28464 " luks-format-cipher device keyslot cipher\n"
28470 #: ../fish/guestfish-actions.pod:2713
28472 "This command is the same as L</luks-format> but it also allows you to set "
28473 "the C<cipher> used."
28478 #: ../fish/guestfish-actions.pod:2722
28479 msgid "luks-kill-slot"
28484 #: ../fish/guestfish-actions.pod:2724
28487 " luks-kill-slot device keyslot\n"
28493 #: ../fish/guestfish-actions.pod:2733
28499 #: ../fish/guestfish-actions.pod:2735
28502 " luks-open device mapname\n"
28508 #: ../fish/guestfish-actions.pod:2749
28510 "If this block device contains LVM volume groups, then calling L</vgscan> "
28511 "followed by L</vg-activate-all> will make them visible."
28515 #: ../fish/guestfish-actions.pod:2753
28516 msgid "Use L</list-dm-devices> to list all device mapper devices."
28521 #: ../fish/guestfish-actions.pod:2759
28522 msgid "luks-open-ro"
28527 #: ../fish/guestfish-actions.pod:2761
28530 " luks-open-ro device mapname\n"
28536 #: ../fish/guestfish-actions.pod:2763
28538 "This is the same as L</luks-open> except that a read-only mapping is created."
28543 #: ../fish/guestfish-actions.pod:2769
28549 #: ../fish/guestfish-actions.pod:2771
28552 " lvcreate logvol volgroup mbytes\n"
28558 #: ../fish/guestfish-actions.pod:2776
28559 msgid "lvm-canonical-lv-name"
28564 #: ../fish/guestfish-actions.pod:2778
28567 " lvm-canonical-lv-name lvname\n"
28573 #: ../fish/guestfish-actions.pod:2787
28574 msgid "See also L</is-lv>."
28579 #: ../fish/guestfish-actions.pod:2789
28580 msgid "lvm-clear-filter"
28585 #: ../fish/guestfish-actions.pod:2791
28588 " lvm-clear-filter\n"
28594 #: ../fish/guestfish-actions.pod:2793
28596 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
28602 #: ../fish/guestfish-actions.pod:2799
28603 msgid "lvm-remove-all"
28608 #: ../fish/guestfish-actions.pod:2801
28611 " lvm-remove-all\n"
28617 #: ../fish/guestfish-actions.pod:2809
28618 msgid "lvm-set-filter"
28623 #: ../fish/guestfish-actions.pod:2811
28626 " lvm-set-filter 'devices ...'\n"
28632 #: ../fish/guestfish-actions.pod:2836
28638 #: ../fish/guestfish-actions.pod:2838
28641 " lvremove device\n"
28647 #: ../fish/guestfish-actions.pod:2846
28653 #: ../fish/guestfish-actions.pod:2848
28656 " lvrename logvol newlogvol\n"
28662 #: ../fish/guestfish-actions.pod:2852
28668 #: ../fish/guestfish-actions.pod:2854
28671 " lvresize device mbytes\n"
28677 #: ../fish/guestfish-actions.pod:2860
28678 msgid "lvresize-free"
28683 #: ../fish/guestfish-actions.pod:2862
28686 " lvresize-free lv percent\n"
28692 #: ../fish/guestfish-actions.pod:2870
28698 #: ../fish/guestfish-actions.pod:2872
28707 #: ../fish/guestfish-actions.pod:2880
28708 msgid "See also L</lvs-full>, L</list-filesystems>."
28713 #: ../fish/guestfish-actions.pod:2882
28719 #: ../fish/guestfish-actions.pod:2884
28728 #: ../fish/guestfish-actions.pod:2889
28734 #: ../fish/guestfish-actions.pod:2891
28743 #: ../fish/guestfish-actions.pod:2895
28749 #: ../fish/guestfish-actions.pod:2897
28752 " lxattrlist path 'names ...'\n"
28758 #: ../fish/guestfish-actions.pod:2913
28760 "This call is intended for programs that want to efficiently list a directory "
28761 "contents without making many round-trips. See also L</lstatlist> for a "
28762 "similarly efficient call for getting standard stats. Very long directory "
28763 "listings might cause the protocol message size to be exceeded, causing this "
28764 "call to fail. The caller must split up such requests into smaller groups of "
28770 #: ../fish/guestfish-actions.pod:2921
28776 #: ../fish/guestfish-actions.pod:2923
28785 #: ../fish/guestfish-actions.pod:2927
28791 #: ../fish/guestfish-actions.pod:2929
28794 " mkdir-mode path mode\n"
28800 #: ../fish/guestfish-actions.pod:2938
28801 msgid "See also L</mkdir>, L</umask>"
28806 #: ../fish/guestfish-actions.pod:2940
28812 #: ../fish/guestfish-actions.pod:2942
28821 #: ../fish/guestfish-actions.pod:2947
28827 #: ../fish/guestfish-actions.pod:2949
28830 " mkdtemp template\n"
28836 #: ../fish/guestfish-actions.pod:2970
28842 #: ../fish/guestfish-actions.pod:2972
28845 " mke2fs-J fstype blocksize device journal\n"
28851 #: ../fish/guestfish-actions.pod:2980
28852 msgid "See also L</mke2journal>."
28857 #: ../fish/guestfish-actions.pod:2982
28863 #: ../fish/guestfish-actions.pod:2984
28866 " mke2fs-JL fstype blocksize device label\n"
28872 #: ../fish/guestfish-actions.pod:2989
28873 msgid "See also L</mke2journal-L>."
28878 #: ../fish/guestfish-actions.pod:2991
28884 #: ../fish/guestfish-actions.pod:2993
28887 " mke2fs-JU fstype blocksize device uuid\n"
28893 #: ../fish/guestfish-actions.pod:2998
28894 msgid "See also L</mke2journal-U>."
28899 #: ../fish/guestfish-actions.pod:3000
28900 msgid "mke2journal"
28905 #: ../fish/guestfish-actions.pod:3002
28908 " mke2journal blocksize device\n"
28914 #: ../fish/guestfish-actions.pod:3009
28915 msgid "mke2journal-L"
28920 #: ../fish/guestfish-actions.pod:3011
28923 " mke2journal-L blocksize label device\n"
28929 #: ../fish/guestfish-actions.pod:3015
28930 msgid "mke2journal-U"
28935 #: ../fish/guestfish-actions.pod:3017
28938 " mke2journal-U blocksize uuid device\n"
28944 #: ../fish/guestfish-actions.pod:3021
28950 #: ../fish/guestfish-actions.pod:3023
28953 " mkfifo mode path\n"
28959 #: ../fish/guestfish-actions.pod:3025
28961 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28962 "is just a convenient wrapper around L</mknod>."
28967 #: ../fish/guestfish-actions.pod:3031
28973 #: ../fish/guestfish-actions.pod:3033
28976 " mkfs fstype device\n"
28982 #: ../fish/guestfish-actions.pod:3039
28988 #: ../fish/guestfish-actions.pod:3041
28991 " mkfs-b fstype blocksize device\n"
28997 #: ../fish/guestfish-actions.pod:3043
28999 "This call is similar to L</mkfs>, but it allows you to control the block "
29000 "size of the resulting filesystem. Supported block sizes depend on the "
29001 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
29006 #: ../fish/guestfish-actions.pod:3058
29011 #: ../fish/guestfish-actions.pod:3060
29014 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
29020 #: ../fish/guestfish-actions.pod:3105
29021 msgid "mkmountpoint"
29026 #: ../fish/guestfish-actions.pod:3107
29029 " mkmountpoint exemptpath\n"
29035 #: ../fish/guestfish-actions.pod:3109
29037 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
29038 "to create extra mountpoints before mounting the first filesystem."
29043 #: ../fish/guestfish-actions.pod:3133
29045 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
29046 "unexpected errors if you try to mix these calls. It is safest to manually "
29047 "unmount filesystems and remove mountpoints after use."
29052 #: ../fish/guestfish-actions.pod:3137
29054 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
29055 "for this to work for manual mountpoints, you must ensure that the innermost "
29056 "mountpoints have the longest pathnames, as in the example code above."
29060 #: ../fish/guestfish-actions.pod:3144
29062 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
29063 "L</umount-all> to be called when the handle is closed which can also trigger "
29069 #: ../fish/guestfish-actions.pod:3148
29075 #: ../fish/guestfish-actions.pod:3150
29078 " mknod mode devmajor devminor path\n"
29084 #: ../fish/guestfish-actions.pod:3160
29086 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
29087 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
29088 "regular file). These constants are available in the standard Linux header "
29089 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
29090 "wrappers around this command which bitwise OR in the appropriate constant "
29096 #: ../fish/guestfish-actions.pod:3170
29102 #: ../fish/guestfish-actions.pod:3172
29105 " mknod-b mode devmajor devminor path\n"
29111 #: ../fish/guestfish-actions.pod:3174
29113 "This call creates a block device node called C<path> with mode C<mode> and "
29114 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29115 "wrapper around L</mknod>."
29120 #: ../fish/guestfish-actions.pod:3180
29126 #: ../fish/guestfish-actions.pod:3182
29129 " mknod-c mode devmajor devminor path\n"
29135 #: ../fish/guestfish-actions.pod:3184
29137 "This call creates a char device node called C<path> with mode C<mode> and "
29138 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29139 "wrapper around L</mknod>."
29144 #: ../fish/guestfish-actions.pod:3190
29150 #: ../fish/guestfish-actions.pod:3192
29159 #: ../fish/guestfish-actions.pod:3196
29165 #: ../fish/guestfish-actions.pod:3198
29168 " mkswap-L label device\n"
29174 #: ../fish/guestfish-actions.pod:3206
29180 #: ../fish/guestfish-actions.pod:3208
29183 " mkswap-U uuid device\n"
29189 #: ../fish/guestfish-actions.pod:3212
29190 msgid "mkswap-file"
29195 #: ../fish/guestfish-actions.pod:3214
29198 " mkswap-file path\n"
29204 #: ../fish/guestfish-actions.pod:3218
29206 "This command just writes a swap file signature to an existing file. To "
29207 "create the file itself, use something like L</fallocate>."
29212 #: ../fish/guestfish-actions.pod:3221
29218 #: ../fish/guestfish-actions.pod:3223
29221 " modprobe modulename\n"
29227 #: ../fish/guestfish-actions.pod:3230
29233 #: ../fish/guestfish-actions.pod:3232
29236 " mount device mountpoint\n"
29242 #: ../fish/guestfish-actions.pod:3248
29244 "B<Important note:> When you use this call, the filesystem options C<sync> "
29245 "and C<noatime> are set implicitly. This was originally done because we "
29246 "thought it would improve reliability, but it turns out that I<-o sync> has a "
29247 "very large negative performance impact and negligible effect on "
29248 "reliability. Therefore we recommend that you avoid using L</mount> in any "
29249 "code that needs performance, and instead use L</mount-options> (use an empty "
29250 "string for the first parameter if you don't want any options)."
29254 #: ../fish/guestfish-actions.pod:3265
29259 #: ../fish/guestfish-actions.pod:3267
29262 " mount-9p mounttag mountpoint [options:..]\n"
29268 #: ../fish/guestfish-actions.pod:3278
29274 #: ../fish/guestfish-actions.pod:3280
29277 " mount-loop file mountpoint\n"
29283 #: ../fish/guestfish-actions.pod:3286
29284 msgid "mount-options"
29289 #: ../fish/guestfish-actions.pod:3288
29292 " mount-options options device mountpoint\n"
29298 #: ../fish/guestfish-actions.pod:3290
29300 "This is the same as the L</mount> command, but it allows you to set the "
29301 "mount options as for the L<mount(8)> I<-o> flag."
29306 #: ../fish/guestfish-actions.pod:3298
29312 #: ../fish/guestfish-actions.pod:3300
29315 " mount-ro device mountpoint\n"
29321 #: ../fish/guestfish-actions.pod:3302
29323 "This is the same as the L</mount> command, but it mounts the filesystem with "
29324 "the read-only (I<-o ro>) flag."
29329 #: ../fish/guestfish-actions.pod:3305
29335 #: ../fish/guestfish-actions.pod:3307
29338 " mount-vfs options vfstype device mountpoint\n"
29344 #: ../fish/guestfish-actions.pod:3309
29346 "This is the same as the L</mount> command, but it allows you to set both the "
29347 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
29352 #: ../fish/guestfish-actions.pod:3313
29353 msgid "mountpoints"
29358 #: ../fish/guestfish-actions.pod:3315
29367 #: ../fish/guestfish-actions.pod:3317
29369 "This call is similar to L</mounts>. That call returns a list of devices. "
29370 "This one returns a hash table (map) of device name to directory where the "
29371 "device is mounted."
29376 #: ../fish/guestfish-actions.pod:3321
29382 #: ../fish/guestfish-actions.pod:3323
29391 #: ../fish/guestfish-actions.pod:3330
29392 msgid "See also: L</mountpoints>"
29397 #: ../fish/guestfish-actions.pod:3332
29403 #: ../fish/guestfish-actions.pod:3334
29412 #: ../fish/guestfish-actions.pod:3339
29413 msgid "ntfs-3g-probe"
29418 #: ../fish/guestfish-actions.pod:3341
29421 " ntfs-3g-probe true|false device\n"
29427 #: ../fish/guestfish-actions.pod:3355
29433 #: ../fish/guestfish-actions.pod:3357
29436 " ntfsresize device\n"
29441 #: ../fish/guestfish-actions.pod:3379
29442 msgid "ntfsresize-opts"
29446 #: ../fish/guestfish-actions.pod:3381
29449 " ntfsresize-opts device [size:..] [force:..]\n"
29454 #: ../fish/guestfish-actions.pod:3400
29456 "After the resize operation, the filesystem is always marked as requiring a "
29457 "consistency check (for safety). You have to boot into Windows to perform "
29458 "this check and clear this condition. If you I<don't> set the C<force> "
29459 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
29460 "a single filesystem without booting into Windows between each resize."
29465 #: ../fish/guestfish-actions.pod:3413
29466 msgid "ntfsresize-size"
29471 #: ../fish/guestfish-actions.pod:3415
29474 " ntfsresize-size device size\n"
29480 #: ../fish/guestfish-actions.pod:3417
29482 "This command is the same as L</ntfsresize> except that it allows you to "
29483 "specify the new size (in bytes) explicitly."
29488 #: ../fish/guestfish-actions.pod:3427
29494 #: ../fish/guestfish-actions.pod:3429
29497 " part-add device prlogex startsect endsect\n"
29503 #: ../fish/guestfish-actions.pod:3431
29505 "This command adds a partition to C<device>. If there is no partition table "
29506 "on the device, call L</part-init> first."
29511 #: ../fish/guestfish-actions.pod:3443
29513 "Creating a partition which covers the whole disk is not so easy. Use L</"
29514 "part-disk> to do that."
29519 #: ../fish/guestfish-actions.pod:3446
29525 #: ../fish/guestfish-actions.pod:3448
29528 " part-del device partnum\n"
29534 #: ../fish/guestfish-actions.pod:3456
29540 #: ../fish/guestfish-actions.pod:3458
29543 " part-disk device parttype\n"
29549 #: ../fish/guestfish-actions.pod:3460
29551 "This command is simply a combination of L</part-init> followed by L</part-"
29552 "add> to create a single primary partition covering the whole disk."
29557 #: ../fish/guestfish-actions.pod:3464
29559 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29560 "possible values are described in L</part-init>."
29565 #: ../fish/guestfish-actions.pod:3470
29566 msgid "part-get-bootable"
29571 #: ../fish/guestfish-actions.pod:3472
29574 " part-get-bootable device partnum\n"
29580 #: ../fish/guestfish-actions.pod:3477
29581 msgid "See also L</part-set-bootable>."
29586 #: ../fish/guestfish-actions.pod:3479
29587 msgid "part-get-mbr-id"
29592 #: ../fish/guestfish-actions.pod:3481
29595 " part-get-mbr-id device partnum\n"
29601 #: ../fish/guestfish-actions.pod:3486 ../fish/guestfish-actions.pod:3624
29603 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29604 "undefined results for other partition table types (see L</part-get-"
29610 #: ../fish/guestfish-actions.pod:3490
29611 msgid "part-get-parttype"
29616 #: ../fish/guestfish-actions.pod:3492
29619 " part-get-parttype device\n"
29625 #: ../fish/guestfish-actions.pod:3497
29627 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29628 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29629 "possible, although unusual. See L</part-init> for a full list."
29634 #: ../fish/guestfish-actions.pod:3502
29640 #: ../fish/guestfish-actions.pod:3504
29643 " part-init device parttype\n"
29649 #: ../fish/guestfish-actions.pod:3510
29651 "Initially there are no partitions. Following this, you should call L</part-"
29652 "add> for each partition required."
29657 #: ../fish/guestfish-actions.pod:3573
29663 #: ../fish/guestfish-actions.pod:3575
29666 " part-list device\n"
29672 #: ../fish/guestfish-actions.pod:3590
29674 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29675 "the device's sector size, see L</blockdev-getss>."
29680 #: ../fish/guestfish-actions.pod:3603
29681 msgid "part-set-bootable"
29686 #: ../fish/guestfish-actions.pod:3605
29689 " part-set-bootable device partnum true|false\n"
29695 #: ../fish/guestfish-actions.pod:3614
29696 msgid "part-set-mbr-id"
29701 #: ../fish/guestfish-actions.pod:3616
29704 " part-set-mbr-id device partnum idbyte\n"
29710 #: ../fish/guestfish-actions.pod:3628
29711 msgid "part-set-name"
29716 #: ../fish/guestfish-actions.pod:3630
29719 " part-set-name device partnum name\n"
29725 #: ../fish/guestfish-actions.pod:3638
29726 msgid "part-to-dev"
29731 #: ../fish/guestfish-actions.pod:3640
29734 " part-to-dev partition\n"
29740 #: ../fish/guestfish-actions.pod:3646
29742 "The named partition must exist, for example as a string returned from L</"
29743 "list-partitions>."
29748 #: ../fish/guestfish-actions.pod:3649
29749 msgid "ping-daemon"
29754 #: ../fish/guestfish-actions.pod:3651
29763 #: ../fish/guestfish-actions.pod:3658
29769 #: ../fish/guestfish-actions.pod:3660
29772 " pread path count offset\n"
29778 #: ../fish/guestfish-actions.pod:3668
29779 msgid "See also L</pwrite>, L</pread-device>."
29784 #: ../fish/guestfish-actions.pod:3673
29785 msgid "pread-device"
29790 #: ../fish/guestfish-actions.pod:3675
29793 " pread-device device count offset\n"
29799 #: ../fish/guestfish-actions.pod:3683
29800 msgid "See also L</pread>."
29805 #: ../fish/guestfish-actions.pod:3688
29811 #: ../fish/guestfish-actions.pod:3690
29814 " pvcreate device\n"
29820 #: ../fish/guestfish-actions.pod:3696
29826 #: ../fish/guestfish-actions.pod:3698
29829 " pvremove device\n"
29835 #: ../fish/guestfish-actions.pod:3707
29841 #: ../fish/guestfish-actions.pod:3709
29844 " pvresize device\n"
29850 #: ../fish/guestfish-actions.pod:3714
29851 msgid "pvresize-size"
29856 #: ../fish/guestfish-actions.pod:3716
29859 " pvresize-size device size\n"
29865 #: ../fish/guestfish-actions.pod:3718
29867 "This command is the same as L</pvresize> except that it allows you to "
29868 "specify the new size (in bytes) explicitly."
29873 #: ../fish/guestfish-actions.pod:3721
29879 #: ../fish/guestfish-actions.pod:3723
29888 #: ../fish/guestfish-actions.pod:3731
29889 msgid "See also L</pvs-full>."
29894 #: ../fish/guestfish-actions.pod:3733
29900 #: ../fish/guestfish-actions.pod:3735
29909 #: ../fish/guestfish-actions.pod:3740
29915 #: ../fish/guestfish-actions.pod:3742
29924 #: ../fish/guestfish-actions.pod:3746
29930 #: ../fish/guestfish-actions.pod:3748
29933 " pwrite path content offset\n"
29939 #: ../fish/guestfish-actions.pod:3759
29940 msgid "See also L</pread>, L</pwrite-device>."
29945 #: ../fish/guestfish-actions.pod:3764
29946 msgid "pwrite-device"
29951 #: ../fish/guestfish-actions.pod:3766
29954 " pwrite-device device content offset\n"
29960 #: ../fish/guestfish-actions.pod:3776
29961 msgid "See also L</pwrite>."
29966 #: ../fish/guestfish-actions.pod:3781
29972 #: ../fish/guestfish-actions.pod:3783
29975 " read-file path\n"
29981 #: ../fish/guestfish-actions.pod:3788
29983 "Unlike L</cat>, this function can correctly handle files that contain "
29984 "embedded ASCII NUL characters. However unlike L</download>, this function "
29985 "is limited in the total size of file that can be handled."
29990 #: ../fish/guestfish-actions.pod:3796
29996 #: ../fish/guestfish-actions.pod:3798
29999 " read-lines path\n"
30005 #: ../fish/guestfish-actions.pod:3805
30007 "Note that this function cannot correctly handle binary files (specifically, "
30008 "files containing C<\\0> character which is treated as end of line). For "
30009 "those you need to use the L</read-file> function which has a more complex "
30015 #: ../fish/guestfish-actions.pod:3810
30021 #: ../fish/guestfish-actions.pod:3812
30030 #: ../fish/guestfish-actions.pod:3864
30032 "This function is primarily intended for use by programs. To get a simple "
30033 "list of names, use L</ls>. To get a printable directory for human "
30034 "consumption, use L</ll>."
30039 #: ../fish/guestfish-actions.pod:3868
30045 #: ../fish/guestfish-actions.pod:3870
30054 #: ../fish/guestfish-actions.pod:3874
30055 msgid "readlinklist"
30060 #: ../fish/guestfish-actions.pod:3876
30063 " readlinklist path 'names ...'\n"
30069 #: ../fish/guestfish-actions.pod:3900
30075 #: ../fish/guestfish-actions.pod:3902
30084 #: ../fish/guestfish-actions.pod:3907
30085 msgid "removexattr"
30090 #: ../fish/guestfish-actions.pod:3909
30093 " removexattr xattr path\n"
30099 #: ../fish/guestfish-actions.pod:3914
30100 msgid "See also: L</lremovexattr>, L<attr(5)>."
30105 #: ../fish/guestfish-actions.pod:3916
30111 #: ../fish/guestfish-actions.pod:3918
30114 " resize2fs device\n"
30120 #: ../fish/guestfish-actions.pod:3923
30122 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
30123 "before calling this command. For unknown reasons C<resize2fs> sometimes "
30124 "gives an error about this and sometimes not. In any case, it is always safe "
30125 "to call L</e2fsck-f> before calling this function."
30129 #: ../fish/guestfish-actions.pod:3929
30130 msgid "resize2fs-M"
30134 #: ../fish/guestfish-actions.pod:3931
30137 " resize2fs-M device\n"
30142 #: ../fish/guestfish-actions.pod:3933
30144 "This command is the same as L</resize2fs>, but the filesystem is resized to "
30145 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
30150 #: ../fish/guestfish-actions.pod:3937
30152 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
30153 "and read the C<Block size> and C<Block count> values. These two numbers, "
30154 "multiplied together, give the resulting size of the minimal filesystem in "
30160 #: ../fish/guestfish-actions.pod:3942
30161 msgid "resize2fs-size"
30166 #: ../fish/guestfish-actions.pod:3944
30169 " resize2fs-size device size\n"
30175 #: ../fish/guestfish-actions.pod:3946
30177 "This command is the same as L</resize2fs> except that it allows you to "
30178 "specify the new size (in bytes) explicitly."
30183 #: ../fish/guestfish-actions.pod:3949
30189 #: ../fish/guestfish-actions.pod:3951
30198 #: ../fish/guestfish-actions.pod:3955
30204 #: ../fish/guestfish-actions.pod:3957
30213 #: ../fish/guestfish-actions.pod:3963
30219 #: ../fish/guestfish-actions.pod:3965
30228 #: ../fish/guestfish-actions.pod:3969
30229 msgid "rmmountpoint"
30234 #: ../fish/guestfish-actions.pod:3971
30237 " rmmountpoint exemptpath\n"
30243 #: ../fish/guestfish-actions.pod:3973
30245 "This calls removes a mountpoint that was previously created with L</"
30246 "mkmountpoint>. See L</mkmountpoint> for full details."
30251 #: ../fish/guestfish-actions.pod:3977
30252 msgid "scrub-device"
30257 #: ../fish/guestfish-actions.pod:3979
30260 " scrub-device device\n"
30266 #: ../fish/guestfish-actions.pod:3990
30272 #: ../fish/guestfish-actions.pod:3992
30275 " scrub-file file\n"
30281 #: ../fish/guestfish-actions.pod:4002
30282 msgid "scrub-freespace"
30287 #: ../fish/guestfish-actions.pod:4004
30290 " scrub-freespace dir\n"
30296 #: ../fish/guestfish-actions.pod:4006
30298 "This command creates the directory C<dir> and then fills it with files until "
30299 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
30300 "deletes them. The intention is to scrub any free space on the partition "
30301 "containing C<dir>."
30306 #: ../fish/guestfish-actions.pod:4015
30312 #: ../fish/guestfish-actions.pod:4017
30318 #: ../fish/guestfish-actions.pod:4019
30321 " set-append append\n"
30326 #: ../fish/guestfish-actions.pod:4030
30327 msgid "set-attach-method"
30331 #: ../fish/guestfish-actions.pod:4032
30332 msgid "attach-method"
30336 #: ../fish/guestfish-actions.pod:4034
30339 " set-attach-method attachmethod\n"
30345 #: ../fish/guestfish-actions.pod:4056
30346 msgid "set-autosync"
30351 #: ../fish/guestfish-actions.pod:4058
30357 #: ../fish/guestfish-actions.pod:4060
30360 " set-autosync true|false\n"
30366 #: ../fish/guestfish-actions.pod:4070
30372 #: ../fish/guestfish-actions.pod:4072
30378 #: ../fish/guestfish-actions.pod:4074
30381 " set-direct true|false\n"
30387 #: ../fish/guestfish-actions.pod:4080
30389 "One consequence of this is that log messages aren't caught by the library "
30390 "and handled by L</set-log-message-callback>, but go straight to stdout."
30395 #: ../fish/guestfish-actions.pod:4089
30396 msgid "set-e2label"
30401 #: ../fish/guestfish-actions.pod:4091
30404 " set-e2label device label\n"
30410 #: ../fish/guestfish-actions.pod:4097
30412 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
30413 "label on a filesystem."
30418 #: ../fish/guestfish-actions.pod:4100
30424 #: ../fish/guestfish-actions.pod:4102
30427 " set-e2uuid device uuid\n"
30433 #: ../fish/guestfish-actions.pod:4109
30435 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
30436 "UUID of a filesystem."
30441 #: ../fish/guestfish-actions.pod:4112
30442 msgid "set-memsize"
30447 #: ../fish/guestfish-actions.pod:4114
30453 #: ../fish/guestfish-actions.pod:4116
30456 " set-memsize memsize\n"
30462 #: ../fish/guestfish-actions.pod:4118
30464 "This sets the memory size in megabytes allocated to the qemu subprocess. "
30465 "This only has any effect if called before L</launch>."
30470 #: ../fish/guestfish-actions.pod:4129
30471 msgid "set-network"
30476 #: ../fish/guestfish-actions.pod:4131
30482 #: ../fish/guestfish-actions.pod:4133
30485 " set-network true|false\n"
30491 #: ../fish/guestfish-actions.pod:4141
30493 "You must call this before calling L</launch>, otherwise it has no effect."
30498 #: ../fish/guestfish-actions.pod:4144
30504 #: ../fish/guestfish-actions.pod:4146
30510 #: ../fish/guestfish-actions.pod:4148
30513 " set-path searchpath\n"
30519 #: ../fish/guestfish-actions.pod:4157
30525 #: ../fish/guestfish-actions.pod:4159
30531 #: ../fish/guestfish-actions.pod:4161
30540 #: ../fish/guestfish-actions.pod:4181
30541 msgid "set-recovery-proc"
30546 #: ../fish/guestfish-actions.pod:4183
30547 msgid "recovery-proc"
30552 #: ../fish/guestfish-actions.pod:4185
30555 " set-recovery-proc true|false\n"
30561 #: ../fish/guestfish-actions.pod:4187
30563 "If this is called with the parameter C<false> then L</launch> does not "
30564 "create a recovery process. The purpose of the recovery process is to stop "
30565 "runaway qemu processes in the case where the main program aborts abruptly."
30570 #: ../fish/guestfish-actions.pod:4192
30572 "This only has any effect if called before L</launch>, and the default is "
30578 #: ../fish/guestfish-actions.pod:4201
30579 msgid "set-selinux"
30584 #: ../fish/guestfish-actions.pod:4203
30590 #: ../fish/guestfish-actions.pod:4205
30593 " set-selinux true|false\n"
30599 #: ../fish/guestfish-actions.pod:4216
30605 #: ../fish/guestfish-actions.pod:4218
30611 #: ../fish/guestfish-actions.pod:4220
30614 " set-trace true|false\n"
30619 #: ../fish/guestfish-actions.pod:4232
30621 "Trace messages are normally sent to C<stderr>, unless you register a "
30622 "callback to send them somewhere else (see L</set-event-callback>)."
30627 #: ../fish/guestfish-actions.pod:4236
30628 msgid "set-verbose"
30633 #: ../fish/guestfish-actions.pod:4238
30639 #: ../fish/guestfish-actions.pod:4240
30642 " set-verbose true|false\n"
30647 #: ../fish/guestfish-actions.pod:4247
30649 "Verbose messages are normally sent to C<stderr>, unless you register a "
30650 "callback to send them somewhere else (see L</set-event-callback>)."
30655 #: ../fish/guestfish-actions.pod:4251
30661 #: ../fish/guestfish-actions.pod:4253
30664 " setcon context\n"
30670 #: ../fish/guestfish-actions.pod:4260
30676 #: ../fish/guestfish-actions.pod:4262
30679 " setxattr xattr val vallen path\n"
30685 #: ../fish/guestfish-actions.pod:4268
30686 msgid "See also: L</lsetxattr>, L<attr(5)>."
30691 #: ../fish/guestfish-actions.pod:4270
30697 #: ../fish/guestfish-actions.pod:4272
30700 " sfdisk device cyls heads sectors 'lines ...'\n"
30706 #: ../fish/guestfish-actions.pod:4294
30707 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30712 #: ../fish/guestfish-actions.pod:4307
30718 #: ../fish/guestfish-actions.pod:4309
30721 " sfdiskM device 'lines ...'\n"
30727 #: ../fish/guestfish-actions.pod:4311
30729 "This is a simplified interface to the L</sfdisk> command, where partition "
30730 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30731 "you don't need to specify the cyls, heads and sectors parameters which were "
30732 "rarely if ever used anyway."
30737 #: ../fish/guestfish-actions.pod:4317
30738 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30743 #: ../fish/guestfish-actions.pod:4330
30749 #: ../fish/guestfish-actions.pod:4332
30752 " sfdisk-N device partnum cyls heads sectors line\n"
30758 #: ../fish/guestfish-actions.pod:4337
30760 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30761 "cyls/heads/sectors parameters."
30766 #: ../fish/guestfish-actions.pod:4340
30767 msgid "See also: L</part-add>"
30772 #: ../fish/guestfish-actions.pod:4352
30773 msgid "sfdisk-disk-geometry"
30778 #: ../fish/guestfish-actions.pod:4354
30781 " sfdisk-disk-geometry device\n"
30787 #: ../fish/guestfish-actions.pod:4356
30789 "This displays the disk geometry of C<device> read from the partition table. "
30790 "Especially in the case where the underlying block device has been resized, "
30791 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30792 "kernel-geometry>)."
30797 #: ../fish/guestfish-actions.pod:4364
30798 msgid "sfdisk-kernel-geometry"
30803 #: ../fish/guestfish-actions.pod:4366
30806 " sfdisk-kernel-geometry device\n"
30812 #: ../fish/guestfish-actions.pod:4373
30818 #: ../fish/guestfish-actions.pod:4375
30821 " sfdisk-l device\n"
30827 #: ../fish/guestfish-actions.pod:4381
30828 msgid "See also: L</part-list>"
30833 #: ../fish/guestfish-actions.pod:4390
30839 #: ../fish/guestfish-actions.pod:4392
30848 #: ../fish/guestfish-actions.pod:4397
30849 msgid "This is like L</command>, but passes the command to:"
30854 #: ../fish/guestfish-actions.pod:4405
30855 msgid "All the provisos about L</command> apply to this call."
30860 #: ../fish/guestfish-actions.pod:4407
30866 #: ../fish/guestfish-actions.pod:4409
30869 " sh-lines command\n"
30875 #: ../fish/guestfish-actions.pod:4411
30876 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30881 #: ../fish/guestfish-actions.pod:4414
30882 msgid "See also: L</command-lines>"
30887 #: ../fish/guestfish-actions.pod:4416
30893 #: ../fish/guestfish-actions.pod:4418
30902 #: ../fish/guestfish-actions.pod:4422
30908 #: ../fish/guestfish-actions.pod:4424
30917 #: ../fish/guestfish-actions.pod:4430
30923 #: ../fish/guestfish-actions.pod:4432
30932 #: ../fish/guestfish-actions.pod:4440
30938 #: ../fish/guestfish-actions.pod:4442
30947 #: ../fish/guestfish-actions.pod:4450
30953 #: ../fish/guestfish-actions.pod:4452
30956 " strings-e encoding path\n"
30962 #: ../fish/guestfish-actions.pod:4454
30964 "This is like the L</strings> command, but allows you to specify the encoding "
30965 "of strings that are looked for in the source file C<path>."
30970 #: ../fish/guestfish-actions.pod:4464
30972 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30973 "ISO-8859-X (this is what L</strings> uses)."
30978 #: ../fish/guestfish-actions.pod:4496
30979 msgid "swapoff-device"
30984 #: ../fish/guestfish-actions.pod:4498
30987 " swapoff-device device\n"
30993 #: ../fish/guestfish-actions.pod:4500
30995 "This command disables the libguestfs appliance swap device or partition "
30996 "named C<device>. See L</swapon-device>."
31001 #: ../fish/guestfish-actions.pod:4504
31002 msgid "swapoff-file"
31007 #: ../fish/guestfish-actions.pod:4506
31010 " swapoff-file file\n"
31016 #: ../fish/guestfish-actions.pod:4510
31017 msgid "swapoff-label"
31022 #: ../fish/guestfish-actions.pod:4512
31025 " swapoff-label label\n"
31031 #: ../fish/guestfish-actions.pod:4517
31032 msgid "swapoff-uuid"
31037 #: ../fish/guestfish-actions.pod:4519
31040 " swapoff-uuid uuid\n"
31046 #: ../fish/guestfish-actions.pod:4524
31047 msgid "swapon-device"
31052 #: ../fish/guestfish-actions.pod:4526
31055 " swapon-device device\n"
31061 #: ../fish/guestfish-actions.pod:4528
31063 "This command enables the libguestfs appliance to use the swap device or "
31064 "partition named C<device>. The increased memory is made available for all "
31065 "commands, for example those run using L</command> or L</sh>."
31070 #: ../fish/guestfish-actions.pod:4540
31071 msgid "swapon-file"
31076 #: ../fish/guestfish-actions.pod:4542
31079 " swapon-file file\n"
31085 #: ../fish/guestfish-actions.pod:4544
31087 "This command enables swap to a file. See L</swapon-device> for other notes."
31092 #: ../fish/guestfish-actions.pod:4547
31093 msgid "swapon-label"
31098 #: ../fish/guestfish-actions.pod:4549
31101 " swapon-label label\n"
31107 #: ../fish/guestfish-actions.pod:4551
31109 "This command enables swap to a labeled swap partition. See L</swapon-"
31110 "device> for other notes."
31115 #: ../fish/guestfish-actions.pod:4554
31116 msgid "swapon-uuid"
31121 #: ../fish/guestfish-actions.pod:4556
31124 " swapon-uuid uuid\n"
31130 #: ../fish/guestfish-actions.pod:4558
31132 "This command enables swap to a swap partition with the given UUID. See L</"
31133 "swapon-device> for other notes."
31138 #: ../fish/guestfish-actions.pod:4561
31144 #: ../fish/guestfish-actions.pod:4563
31153 #: ../fish/guestfish-actions.pod:4571
31159 #: ../fish/guestfish-actions.pod:4573
31168 #: ../fish/guestfish-actions.pod:4581
31174 #: ../fish/guestfish-actions.pod:4583
31177 " tail-n nrlines path\n"
31183 #: ../fish/guestfish-actions.pod:4596
31189 #: ../fish/guestfish-actions.pod:4598
31192 " tar-in (tarfile|-) directory\n"
31198 #: ../fish/guestfish-actions.pod:4603
31199 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
31204 #: ../fish/guestfish-actions.pod:4608
31210 #: ../fish/guestfish-actions.pod:4610
31213 " tar-out directory (tarfile|-)\n"
31219 #: ../fish/guestfish-actions.pod:4615
31220 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
31225 #: ../fish/guestfish-actions.pod:4620
31231 #: ../fish/guestfish-actions.pod:4622
31234 " tgz-in (tarball|-) directory\n"
31240 #: ../fish/guestfish-actions.pod:4627
31241 msgid "To upload an uncompressed tarball, use L</tar-in>."
31246 #: ../fish/guestfish-actions.pod:4631
31252 #: ../fish/guestfish-actions.pod:4633
31255 " tgz-out directory (tarball|-)\n"
31261 #: ../fish/guestfish-actions.pod:4638
31262 msgid "To download an uncompressed tarball, use L</tar-out>."
31267 #: ../fish/guestfish-actions.pod:4642
31273 #: ../fish/guestfish-actions.pod:4644
31282 #: ../fish/guestfish-actions.pod:4653
31288 #: ../fish/guestfish-actions.pod:4655
31297 #: ../fish/guestfish-actions.pod:4660
31298 msgid "truncate-size"
31303 #: ../fish/guestfish-actions.pod:4662
31306 " truncate-size path size\n"
31312 #: ../fish/guestfish-actions.pod:4667
31314 "If the current file size is less than C<size> then the file is extended to "
31315 "the required size with zero bytes. This creates a sparse file (ie. disk "
31316 "blocks are not allocated for the file until you write to it). To create a "
31317 "non-sparse file of zeroes, use L</fallocate64> instead."
31322 #: ../fish/guestfish-actions.pod:4673
31328 #: ../fish/guestfish-actions.pod:4675
31331 " tune2fs-l device\n"
31337 #: ../fish/guestfish-actions.pod:4685
31343 #: ../fish/guestfish-actions.pod:4687
31346 " txz-in (tarball|-) directory\n"
31352 #: ../fish/guestfish-actions.pod:4694
31358 #: ../fish/guestfish-actions.pod:4696
31361 " txz-out directory (tarball|-)\n"
31367 #: ../fish/guestfish-actions.pod:4703
31373 #: ../fish/guestfish-actions.pod:4705
31382 #: ../fish/guestfish-actions.pod:4719
31383 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
31388 #: ../fish/guestfish-actions.pod:4724
31394 #: ../fish/guestfish-actions.pod:4726
31400 #: ../fish/guestfish-actions.pod:4728
31403 " umount pathordevice\n"
31409 #: ../fish/guestfish-actions.pod:4734
31415 #: ../fish/guestfish-actions.pod:4736
31416 msgid "unmount-all"
31421 #: ../fish/guestfish-actions.pod:4738
31430 #: ../fish/guestfish-actions.pod:4744
31436 #: ../fish/guestfish-actions.pod:4746
31439 " upload (filename|-) remotefilename\n"
31445 #: ../fish/guestfish-actions.pod:4753
31446 msgid "See also L</download>."
31451 #: ../fish/guestfish-actions.pod:4757
31452 msgid "upload-offset"
31457 #: ../fish/guestfish-actions.pod:4759
31460 " upload-offset (filename|-) remotefilename offset\n"
31466 #: ../fish/guestfish-actions.pod:4771
31468 "Note that there is no limit on the amount of data that can be uploaded with "
31469 "this call, unlike with L</pwrite>, and this call always writes the full "
31470 "amount unless an error occurs."
31475 #: ../fish/guestfish-actions.pod:4776
31476 msgid "See also L</upload>, L</pwrite>."
31481 #: ../fish/guestfish-actions.pod:4780
31487 #: ../fish/guestfish-actions.pod:4782
31490 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
31496 #: ../fish/guestfish-actions.pod:4801
31502 #: ../fish/guestfish-actions.pod:4803
31511 #: ../fish/guestfish-actions.pod:4830
31513 "I<Note:> Don't use this call to test for availability of features. In "
31514 "enterprise distributions we backport features from later versions into "
31515 "earlier versions, making this an unreliable way to test for features. Use "
31516 "L</available> instead."
31521 #: ../fish/guestfish-actions.pod:4836
31527 #: ../fish/guestfish-actions.pod:4838
31530 " vfs-label device\n"
31536 #: ../fish/guestfish-actions.pod:4845
31537 msgid "To find a filesystem from the label, use L</findfs-label>."
31542 #: ../fish/guestfish-actions.pod:4847
31548 #: ../fish/guestfish-actions.pod:4849
31551 " vfs-type device\n"
31557 #: ../fish/guestfish-actions.pod:4859
31563 #: ../fish/guestfish-actions.pod:4861
31566 " vfs-uuid device\n"
31572 #: ../fish/guestfish-actions.pod:4868
31573 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
31578 #: ../fish/guestfish-actions.pod:4870
31579 msgid "vg-activate"
31584 #: ../fish/guestfish-actions.pod:4872
31587 " vg-activate true|false 'volgroups ...'\n"
31593 #: ../fish/guestfish-actions.pod:4882
31594 msgid "vg-activate-all"
31599 #: ../fish/guestfish-actions.pod:4884
31602 " vg-activate-all true|false\n"
31608 #: ../fish/guestfish-actions.pod:4891
31614 #: ../fish/guestfish-actions.pod:4893
31617 " vgcreate volgroup 'physvols ...'\n"
31623 #: ../fish/guestfish-actions.pod:4898
31629 #: ../fish/guestfish-actions.pod:4900
31632 " vglvuuids vgname\n"
31638 #: ../fish/guestfish-actions.pod:4905
31640 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
31641 "logical volumes and volume groups."
31646 #: ../fish/guestfish-actions.pod:4908
31647 msgid "See also L</vgpvuuids>."
31652 #: ../fish/guestfish-actions.pod:4910
31658 #: ../fish/guestfish-actions.pod:4912
31661 " vgpvuuids vgname\n"
31667 #: ../fish/guestfish-actions.pod:4917
31669 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31670 "physical volumes and volume groups."
31675 #: ../fish/guestfish-actions.pod:4920
31676 msgid "See also L</vglvuuids>."
31681 #: ../fish/guestfish-actions.pod:4922
31687 #: ../fish/guestfish-actions.pod:4924
31690 " vgremove vgname\n"
31696 #: ../fish/guestfish-actions.pod:4931
31702 #: ../fish/guestfish-actions.pod:4933
31705 " vgrename volgroup newvolgroup\n"
31711 #: ../fish/guestfish-actions.pod:4937
31717 #: ../fish/guestfish-actions.pod:4939
31726 #: ../fish/guestfish-actions.pod:4947
31727 msgid "See also L</vgs-full>."
31732 #: ../fish/guestfish-actions.pod:4949
31738 #: ../fish/guestfish-actions.pod:4951
31747 #: ../fish/guestfish-actions.pod:4956
31753 #: ../fish/guestfish-actions.pod:4958
31762 #: ../fish/guestfish-actions.pod:4963
31768 #: ../fish/guestfish-actions.pod:4965
31777 #: ../fish/guestfish-actions.pod:4969
31783 #: ../fish/guestfish-actions.pod:4971
31792 #: ../fish/guestfish-actions.pod:4976
31798 #: ../fish/guestfish-actions.pod:4978
31807 #: ../fish/guestfish-actions.pod:4983
31813 #: ../fish/guestfish-actions.pod:4985
31822 #: ../fish/guestfish-actions.pod:4990
31828 #: ../fish/guestfish-actions.pod:4992
31831 " write path content\n"
31837 #: ../fish/guestfish-actions.pod:5000
31843 #: ../fish/guestfish-actions.pod:5002
31846 " write-file path content size\n"
31852 #: ../fish/guestfish-actions.pod:5025
31858 #: ../fish/guestfish-actions.pod:5027
31861 " zegrep regex path\n"
31867 #: ../fish/guestfish-actions.pod:5035
31873 #: ../fish/guestfish-actions.pod:5037
31876 " zegrepi regex path\n"
31882 #: ../fish/guestfish-actions.pod:5045
31888 #: ../fish/guestfish-actions.pod:5047
31896 #: ../fish/guestfish-actions.pod:5055
31897 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
31902 #: ../fish/guestfish-actions.pod:5058
31903 msgid "zero-device"
31908 #: ../fish/guestfish-actions.pod:5060
31911 " zero-device device\n"
31917 #: ../fish/guestfish-actions.pod:5062
31919 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31920 "which just zeroes the first few blocks of a device."
31925 #: ../fish/guestfish-actions.pod:5069
31931 #: ../fish/guestfish-actions.pod:5071
31934 " zerofree device\n"
31940 #: ../fish/guestfish-actions.pod:5084
31946 #: ../fish/guestfish-actions.pod:5086
31949 " zfgrep pattern path\n"
31955 #: ../fish/guestfish-actions.pod:5094
31961 #: ../fish/guestfish-actions.pod:5096
31964 " zfgrepi pattern path\n"
31970 #: ../fish/guestfish-actions.pod:5104
31976 #: ../fish/guestfish-actions.pod:5106
31979 " zfile meth path\n"
31985 #: ../fish/guestfish-actions.pod:5113
31987 "Since 1.0.63, use L</file> instead which can now process compressed files."
31992 #: ../fish/guestfish-actions.pod:5123
31998 #: ../fish/guestfish-actions.pod:5125
32001 " zgrep regex path\n"
32007 #: ../fish/guestfish-actions.pod:5133
32013 #: ../fish/guestfish-actions.pod:5135
32016 " zgrepi regex path\n"
32022 #: ../fish/guestfish-commands.pod:1
32028 #: ../fish/guestfish-commands.pod:3
32034 #: ../fish/guestfish-commands.pod:5
32037 " alloc filename size\n"
32043 #: ../fish/guestfish-commands.pod:7
32045 "This creates an empty (zeroed) file of the given size, and then adds so it "
32046 "can be further examined."
32051 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
32052 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
32057 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
32058 msgid "Size can be specified using standard suffixes, eg. C<1M>."
32063 #: ../fish/guestfish-commands.pod:14
32065 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
32066 "image, see L</PREPARED DISK IMAGES>."
32071 #: ../fish/guestfish-commands.pod:17
32077 #: ../fish/guestfish-commands.pod:19
32080 " copy-in local [local ...] /remotedir\n"
32086 #: ../fish/guestfish-commands.pod:21
32088 "C<copy-in> copies local files or directories recursively into the disk "
32089 "image, placing them in the directory called C</remotedir> (which must "
32090 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
32091 "other commands as necessary."
32096 #: ../fish/guestfish-commands.pod:26
32098 "Multiple local files and directories can be specified, but the last "
32099 "parameter must always be a remote directory. Wildcards cannot be used."
32104 #: ../fish/guestfish-commands.pod:30
32110 #: ../fish/guestfish-commands.pod:32
32113 " copy-out remote [remote ...] localdir\n"
32119 #: ../fish/guestfish-commands.pod:34
32121 "C<copy-out> copies remote files or directories recursively out of the disk "
32122 "image, placing them on the host disk in a local directory called C<localdir> "
32123 "(which must exist). This guestfish meta-command turns into a sequence of L</"
32124 "download>, L</tar-out> and other commands as necessary."
32129 #: ../fish/guestfish-commands.pod:40
32131 "Multiple remote files and directories can be specified, but the last "
32132 "parameter must always be a local directory. To download to the current "
32133 "directory, use C<.> as in:"
32138 #: ../fish/guestfish-commands.pod:44
32141 " copy-out /home .\n"
32147 #: ../fish/guestfish-commands.pod:46
32149 "Wildcards cannot be used in the ordinary command, but you can use them with "
32150 "the help of L</glob> like this:"
32155 #: ../fish/guestfish-commands.pod:49
32158 " glob copy-out /home/* .\n"
32163 #: ../fish/guestfish-commands.pod:51
32168 #: ../fish/guestfish-commands.pod:53
32171 " display filename\n"
32176 #: ../fish/guestfish-commands.pod:55
32178 "Use C<display> (a graphical display program) to display an image file. It "
32179 "downloads the file, and runs C<display> on it."
32183 #: ../fish/guestfish-commands.pod:58
32185 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
32186 "environment variable. For example to use the GNOME display program:"
32190 #: ../fish/guestfish-commands.pod:61
32193 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
32198 #: ../fish/guestfish-commands.pod:63
32199 msgid "See also L<display(1)>."
32204 #: ../fish/guestfish-commands.pod:65
32210 #: ../fish/guestfish-commands.pod:67
32213 " echo [params ...]\n"
32219 #: ../fish/guestfish-commands.pod:69
32220 msgid "This echos the parameters to the terminal."
32225 #: ../fish/guestfish-commands.pod:71
32231 #: ../fish/guestfish-commands.pod:73
32237 #: ../fish/guestfish-commands.pod:75
32243 #: ../fish/guestfish-commands.pod:77
32252 #: ../fish/guestfish-commands.pod:79
32254 "This is used to edit a file. It downloads the file, edits it locally using "
32255 "your editor, then uploads the result."
32260 #: ../fish/guestfish-commands.pod:82
32262 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
32263 "or C<emacs> you will get those corresponding editors."
32268 #: ../fish/guestfish-commands.pod:86
32274 #: ../fish/guestfish-commands.pod:88
32277 " glob command args...\n"
32283 #: ../fish/guestfish-commands.pod:90
32285 "Expand wildcards in any paths in the args list, and run C<command> "
32286 "repeatedly on each matching path."
32291 #: ../fish/guestfish-commands.pod:93
32292 msgid "See L</WILDCARDS AND GLOBBING>."
32297 #: ../fish/guestfish-commands.pod:95
32303 #: ../fish/guestfish-commands.pod:97
32306 " hexedit <filename|device>\n"
32307 " hexedit <filename|device> <max>\n"
32308 " hexedit <filename|device> <start> <max>\n"
32314 #: ../fish/guestfish-commands.pod:101
32316 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
32322 #: ../fish/guestfish-commands.pod:104
32324 "This command works by downloading potentially the whole file or device, "
32325 "editing it locally, then uploading it. If the file or device is large, you "
32326 "have to specify which part you wish to edit by using C<max> and/or C<start> "
32327 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
32328 "usual modifiers allowed such as C<1M> (1 megabyte)."
32333 #: ../fish/guestfish-commands.pod:111
32334 msgid "For example to edit the first few sectors of a disk you might do:"
32339 #: ../fish/guestfish-commands.pod:114
32342 " hexedit /dev/sda 1M\n"
32348 #: ../fish/guestfish-commands.pod:116
32350 "which would allow you to edit anywhere within the first megabyte of the disk."
32355 #: ../fish/guestfish-commands.pod:119
32356 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
32361 #: ../fish/guestfish-commands.pod:121
32364 " hexedit /dev/sda1 0x400 0x400\n"
32370 #: ../fish/guestfish-commands.pod:123
32371 msgid "(assuming the superblock is in the standard location)."
32376 #: ../fish/guestfish-commands.pod:125
32378 "This command requires the external L<hexedit(1)> program. You can specify "
32379 "another program to use by setting the C<HEXEDITOR> environment variable."
32384 #: ../fish/guestfish-commands.pod:129
32385 msgid "See also L</hexdump>."
32390 #: ../fish/guestfish-commands.pod:131
32396 #: ../fish/guestfish-commands.pod:133
32405 #: ../fish/guestfish-commands.pod:135
32407 "Change the local directory, ie. the current directory of guestfish itself."
32412 #: ../fish/guestfish-commands.pod:138
32413 msgid "Note that C<!cd> won't do what you might expect."
32418 #: ../fish/guestfish-commands.pod:140
32424 #: ../fish/guestfish-commands.pod:142
32430 #: ../fish/guestfish-commands.pod:144
32439 #: ../fish/guestfish-commands.pod:146
32440 msgid "Opens the manual page for guestfish."
32445 #: ../fish/guestfish-commands.pod:148
32451 #: ../fish/guestfish-commands.pod:150
32457 #: ../fish/guestfish-commands.pod:152
32466 #: ../fish/guestfish-commands.pod:154
32475 #: ../fish/guestfish-commands.pod:156
32476 msgid "This is used to view a file."
32481 #: ../fish/guestfish-commands.pod:158
32483 "The default viewer is C<$PAGER>. However if you use the alternate command "
32484 "C<less> you will get the C<less> command specifically."
32489 #: ../fish/guestfish-commands.pod:161
32495 #: ../fish/guestfish-commands.pod:163
32504 #: ../fish/guestfish-commands.pod:165
32506 "Close and reopen the libguestfs handle. It is not necessary to use this "
32507 "normally, because the handle is closed properly when guestfish exits. "
32508 "However this is occasionally useful for testing."
32513 #: ../fish/guestfish-commands.pod:169
32519 #: ../fish/guestfish-commands.pod:171
32522 " sparse filename size\n"
32528 #: ../fish/guestfish-commands.pod:173
32530 "This creates an empty sparse file of the given size, and then adds so it can "
32531 "be further examined."
32536 #: ../fish/guestfish-commands.pod:176
32538 "In all respects it works the same as the L</alloc> command, except that the "
32539 "image file is allocated sparsely, which means that disk blocks are not "
32540 "assigned to the file until they are needed. Sparse disk files only use "
32541 "space when written to, but they are slower and there is a danger you could "
32542 "run out of real disk space during a write operation."
32547 #: ../fish/guestfish-commands.pod:186
32553 #: ../fish/guestfish-commands.pod:188
32562 #: ../fish/guestfish-commands.pod:190
32564 "This command returns a list of the optional groups known to the daemon, and "
32565 "indicates which ones are supported by this build of the libguestfs appliance."
32570 #: ../fish/guestfish-commands.pod:194
32571 msgid "See also L<guestfs(3)/AVAILABILITY>."
32576 #: ../fish/guestfish-commands.pod:196
32582 #: ../fish/guestfish-commands.pod:198
32585 " time command args...\n"
32591 #: ../fish/guestfish-commands.pod:200
32593 "Run the command as usual, but print the elapsed time afterwards. This can "
32594 "be useful for benchmarking operations."
32599 #: ../test-tool/libguestfs-test-tool.pod:5
32600 msgid "libguestfs-test-tool - End user tests for libguestfs"
32605 #: ../test-tool/libguestfs-test-tool.pod:9
32608 " libguestfs-test-tool [--options]\n"
32614 #: ../test-tool/libguestfs-test-tool.pod:13
32616 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
32617 "and developers, to allow them to check basic libguestfs functionality is "
32618 "working. This is needed because libguestfs occasionally breaks for reasons "
32619 "beyond our control: usually because of changes in the underlying qemu or "
32620 "kernel packages, or the host environment."
32625 #: ../test-tool/libguestfs-test-tool.pod:20
32626 msgid "If you suspect a problem in libguestfs, then just run:"
32631 #: ../test-tool/libguestfs-test-tool.pod:22
32634 " libguestfs-test-tool\n"
32640 #: ../test-tool/libguestfs-test-tool.pod:24
32641 msgid "It will print lots of diagnostic messages."
32646 #: ../test-tool/libguestfs-test-tool.pod:26
32647 msgid "If it runs to completion successfully, you will see this near the end:"
32652 #: ../test-tool/libguestfs-test-tool.pod:28
32655 " ===== TEST FINISHED OK =====\n"
32661 #: ../test-tool/libguestfs-test-tool.pod:30
32662 msgid "and the test tool will exit with code 0."
32667 #: ../test-tool/libguestfs-test-tool.pod:32
32669 "If it fails (and/or exits with non-zero error code), please paste the "
32670 "B<complete, unedited> output of the test tool into a bug report. More "
32671 "information about reporting bugs can be found on the L<http://libguestfs.org/"
32677 #: ../test-tool/libguestfs-test-tool.pod:41
32683 #: ../test-tool/libguestfs-test-tool.pod:43
32684 msgid "Display short usage information and exit."
32689 #: ../test-tool/libguestfs-test-tool.pod:45
32690 msgid "I<--qemu qemu_binary>"
32695 #: ../test-tool/libguestfs-test-tool.pod:47
32697 "If you have downloaded another qemu binary, point this option at the full "
32698 "path of the binary to try it."
32703 #: ../test-tool/libguestfs-test-tool.pod:50
32704 msgid "I<--qemudir qemu_source_dir>"
32709 #: ../test-tool/libguestfs-test-tool.pod:52
32711 "If you have compiled qemu from source, point this option at the source "
32712 "directory to try it."
32717 #: ../test-tool/libguestfs-test-tool.pod:55
32718 msgid "I<--timeout N>"
32723 #: ../test-tool/libguestfs-test-tool.pod:57
32725 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32726 "does not usually need to be adjusted unless your machine is very slow."
32731 #: ../test-tool/libguestfs-test-tool.pod:63
32732 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32737 #: ../test-tool/libguestfs-test-tool.pod:65
32739 "If you have compiled another version of qemu from source and would like to "
32740 "try that, then you can use the I<--qemudir> option to point to the qemu "
32741 "source directory."
32746 #: ../test-tool/libguestfs-test-tool.pod:69
32748 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32749 "option to point to the binary."
32754 #: ../test-tool/libguestfs-test-tool.pod:72
32756 "When using an alternate qemu with libguestfs, usually you would need to "
32757 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32758 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32759 "use either of the I<--qemudir> or I<--qemu> options."
32764 #: ../test-tool/libguestfs-test-tool.pod:79
32766 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32767 "I<1> if there was an error."
32772 #: ../test-tool/libguestfs-test-tool.pod:84
32774 "For the full list of environment variables which may affect libguestfs, "
32775 "please see the L<guestfs(3)> manual page."
32780 #: ../test-tool/libguestfs-test-tool.pod:89
32781 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32786 #: ../fuse/guestmount.pod:5
32788 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32793 #: ../fuse/guestmount.pod:9
32796 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32802 #: ../fuse/guestmount.pod:11
32805 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32811 #: ../fuse/guestmount.pod:13
32814 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32820 #: ../fuse/guestmount.pod:17
32822 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32823 "machines. If you do this, you risk disk corruption in the VM."
32828 #: ../fuse/guestmount.pod:22
32830 "The guestmount program can be used to mount virtual machine filesystems and "
32831 "other disk images on the host. It uses libguestfs for access to the guest "
32832 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32833 "a mountable device."
32838 #: ../fuse/guestmount.pod:27
32840 "Along with other options, you have to give at least one device (I<-a> "
32841 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32842 "option) or use the I<-i> inspection option. How this works is better "
32843 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32849 #: ../fuse/guestmount.pod:33
32851 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32852 "by you, and the filesystem will not be visible to any other users unless you "
32853 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32854 "the filesystem, use the C<fusermount -u> command."
32859 #: ../fuse/guestmount.pod:41
32861 "For a typical Windows guest which has its main filesystem on the first "
32867 #: ../fuse/guestmount.pod:44
32870 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32876 #: ../fuse/guestmount.pod:46
32878 "For a typical Linux guest which has a /boot filesystem on the first "
32879 "partition, and the root filesystem on a logical volume:"
32884 #: ../fuse/guestmount.pod:49
32887 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32893 #: ../fuse/guestmount.pod:51
32894 msgid "To get libguestfs to detect guest mountpoints for you:"
32899 #: ../fuse/guestmount.pod:53
32902 " guestmount -a guest.img -i --ro /mnt\n"
32908 #: ../fuse/guestmount.pod:55
32909 msgid "For a libvirt guest called \"Guest\" you could do:"
32914 #: ../fuse/guestmount.pod:57
32917 " guestmount -d Guest -i --ro /mnt\n"
32923 #: ../fuse/guestmount.pod:59
32925 "If you don't know what filesystems are contained in a guest or disk image, "
32926 "use L<virt-filesystems(1)> first:"
32931 #: ../fuse/guestmount.pod:62
32934 " virt-filesystems MyGuest\n"
32940 #: ../fuse/guestmount.pod:64
32942 "If you want to trace the libguestfs calls but without excessive debugging "
32943 "information, we recommend:"
32948 #: ../fuse/guestmount.pod:67
32951 " guestmount [...] --trace /mnt\n"
32957 #: ../fuse/guestmount.pod:69
32958 msgid "If you want to debug the program, we recommend:"
32963 #: ../fuse/guestmount.pod:71
32966 " guestmount [...] --trace --verbose /mnt\n"
32971 #: ../fuse/guestmount.pod:73
32976 #: ../fuse/guestmount.pod:75
32977 msgid "Other users cannot see the filesystem by default"
32981 #: ../fuse/guestmount.pod:77
32983 "If you mount a filesystem as one user (eg. root), then other users will not "
32984 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32985 "option when mounting:"
32989 #: ../fuse/guestmount.pod:81
32992 " sudo guestmount [...] -o allow_other /mnt\n"
32998 #: ../fuse/guestmount.pod:87
32999 msgid "B<-a image> | B<--add image>"
33004 #: ../fuse/guestmount.pod:89
33005 msgid "Add a block device or virtual machine image."
33010 #: ../fuse/guestmount.pod:94
33011 msgid "B<-c URI> | B<--connect URI>"
33016 #: ../fuse/guestmount.pod:100
33017 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
33022 #: ../fuse/guestmount.pod:108
33023 msgid "B<--dir-cache-timeout N>"
33028 #: ../fuse/guestmount.pod:110
33030 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
33031 "seconds. The readdir cache [actually, there are several semi-independent "
33032 "caches] is populated after a readdir(2) call with the stat and extended "
33033 "attributes of the files in the directory, in anticipation that they will be "
33034 "requested soon after."
33039 #: ../fuse/guestmount.pod:116
33041 "There is also a different attribute cache implemented by FUSE (see the FUSE "
33042 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
33043 "requests, only cache existing ones."
33048 #: ../fuse/guestmount.pod:127
33049 msgid "B<--format=raw|qcow2|..> | B<--format>"
33054 #: ../fuse/guestmount.pod:134
33056 "If you have untrusted raw-format guest disk images, you should use this "
33057 "option to specify the disk format. This avoids a possible security problem "
33058 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
33059 "guestfs_add_drive_opts>."
33064 #: ../fuse/guestmount.pod:139
33065 msgid "B<--fuse-help>"
33070 #: ../fuse/guestmount.pod:141
33071 msgid "Display help on special FUSE options (see I<-o> below)."
33076 #: ../fuse/guestmount.pod:145
33077 msgid "Display brief help and exit."
33082 #: ../fuse/guestmount.pod:147
33083 msgid "B<-i> | B<--inspector>"
33088 #: ../fuse/guestmount.pod:167
33090 "Mount the named partition or logical volume on the given mountpoint B<in the "
33091 "guest> (this has nothing to do with mountpoints in the host)."
33096 #: ../fuse/guestmount.pod:170
33098 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
33099 "something on C</>."
33104 #: ../fuse/guestmount.pod:183
33105 msgid "B<-n> | B<--no-sync>"
33110 #: ../fuse/guestmount.pod:185
33112 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
33113 "unmounted. If you specify this option, then we don't attempt to sync the "
33114 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
33119 #: ../fuse/guestmount.pod:190
33120 msgid "B<-o option> | B<--option option>"
33125 #: ../fuse/guestmount.pod:192
33126 msgid "Pass extra options to FUSE."
33131 #: ../fuse/guestmount.pod:194
33133 "To get a list of all the extra options supported by FUSE, use the command "
33134 "below. Note that only the FUSE I<-o> options can be passed, and only some "
33135 "of them are a good idea."
33140 #: ../fuse/guestmount.pod:198
33143 " guestmount --fuse-help\n"
33149 #: ../fuse/guestmount.pod:200
33150 msgid "Some potentially useful FUSE options:"
33155 #: ../fuse/guestmount.pod:204
33156 msgid "B<-o allow_other>"
33161 #: ../fuse/guestmount.pod:206
33162 msgid "Allow other users to see the filesystem."
33167 #: ../fuse/guestmount.pod:208
33168 msgid "B<-o attr_timeout=N>"
33173 #: ../fuse/guestmount.pod:210
33174 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
33179 #: ../fuse/guestmount.pod:212
33180 msgid "B<-o kernel_cache>"
33185 #: ../fuse/guestmount.pod:214
33187 "Allow the kernel to cache files (reduces the number of reads that have to go "
33188 "through the L<guestfs(3)> API). This is generally a good idea if you can "
33189 "afford the extra memory usage."
33194 #: ../fuse/guestmount.pod:218
33195 msgid "B<-o uid=N> B<-o gid=N>"
33200 #: ../fuse/guestmount.pod:220
33202 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
33203 "the chosen values."
33208 #: ../fuse/guestmount.pod:225
33209 msgid "B<-r> | B<--ro>"
33214 #: ../fuse/guestmount.pod:227
33216 "Add devices and mount everything read-only. Also disallow writes and make "
33217 "the disk appear read-only to FUSE."
33222 #: ../fuse/guestmount.pod:230
33224 "This is highly recommended if you are not going to edit the guest disk. If "
33225 "the guest is running and this option is I<not> supplied, then there is a "
33226 "strong risk of disk corruption in the guest. We try to prevent this from "
33227 "happening, but it is not always possible."
33232 #: ../fuse/guestmount.pod:235
33233 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
33238 #: ../fuse/guestmount.pod:239
33239 msgid "Enable SELinux support for the guest."
33244 #: ../fuse/guestmount.pod:241
33245 msgid "B<-v> | B<--verbose>"
33250 #: ../fuse/guestmount.pod:243
33251 msgid "Enable verbose messages from underlying libguestfs."
33256 #: ../fuse/guestmount.pod:245
33257 msgid "B<-V> | B<--version>"
33262 #: ../fuse/guestmount.pod:247
33263 msgid "Display the program version and exit."
33268 #: ../fuse/guestmount.pod:249
33269 msgid "B<-w> | B<--rw>"
33273 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
33274 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
33279 #: ../fuse/guestmount.pod:256
33280 msgid "B<-x> | B<--trace>"
33285 #: ../fuse/guestmount.pod:258
33286 msgid "Trace libguestfs calls and entry into each FUSE function."
33291 #: ../fuse/guestmount.pod:260
33292 msgid "This also stops the daemon from forking into the background."
33297 #: ../fuse/guestmount.pod:281
33299 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
33300 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
33306 #: ../fuse/guestmount.pod:296
33307 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
33312 #: ../tools/virt-win-reg.pl:37
33314 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33319 #: ../tools/virt-win-reg.pl:41
33322 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33328 #: ../tools/virt-win-reg.pl:43
33331 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33337 #: ../tools/virt-win-reg.pl:45
33340 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33346 #: ../tools/virt-win-reg.pl:47
33349 " virt-win-reg --merge domname [input.reg ...]\n"
33355 #: ../tools/virt-win-reg.pl:49
33358 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33363 #: ../tools/virt-win-reg.pl:53
33365 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33366 "virtual machines. If you do this, you I<will> get irreversible disk "
33367 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33368 "but doesn't catch all cases."
33372 #: ../tools/virt-win-reg.pl:58
33374 "Modifying the Windows Registry is an inherently risky operation. The format "
33375 "is deliberately obscure and undocumented, and Registry changes can leave the "
33376 "system unbootable. Therefore when using the I<--merge> option, make sure "
33377 "you have a reliable backup first."
33382 #: ../tools/virt-win-reg.pl:65
33384 "This program can export and merge Windows Registry entries from a Windows "
33390 #: ../tools/virt-win-reg.pl:68
33392 "The first parameter is the libvirt guest name or the raw disk image of a "
33397 #: ../tools/virt-win-reg.pl:71
33399 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33400 "exported (recursively). For example:"
33405 #: ../tools/virt-win-reg.pl:74
33408 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33414 #: ../tools/virt-win-reg.pl:76
33416 "You can also display single values from within registry keys, for example:"
33421 #: ../tools/virt-win-reg.pl:79
33424 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33425 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33426 " Windows 7 Enterprise\n"
33431 #: ../tools/virt-win-reg.pl:83
33433 "With I<--merge>, you can merge a textual regedit file into the Windows "
33439 #: ../tools/virt-win-reg.pl:86
33442 " $ virt-win-reg --merge Windows7 changes.reg\n"
33448 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33454 #: ../tools/virt-win-reg.pl:90
33456 "This program is only meant for simple access to the registry. If you want "
33457 "to do complicated things with the registry, we suggest you download the "
33458 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33459 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33460 "L<hivexregedit(1)>."
33465 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
33466 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
33467 #: ../tools/virt-list-partitions.pl:64
33468 msgid "Display brief help."
33473 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
33474 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
33475 #: ../tools/virt-list-partitions.pl:72
33476 msgid "Display version number and exit."
33481 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33487 #: ../tools/virt-win-reg.pl:122
33488 msgid "Enable debugging messages."
33493 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
33494 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
33495 msgid "B<--connect URI> | B<-c URI>"
33500 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
33501 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
33503 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
33504 "to the default libvirt hypervisor."
33509 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
33510 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
33512 "If you specify guest block devices directly, then libvirt is not used at all."
33517 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
33518 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
33519 msgid "B<--format> raw"
33524 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
33525 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
33527 "Specify the format of disk images given on the command line. If this is "
33528 "omitted then the format is autodetected from the content of the disk image."
33533 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
33534 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
33536 "If disk images are requested from libvirt, then this program asks libvirt "
33537 "for this information. In this case, the value of the format parameter is "
33543 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
33544 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
33546 "If working with untrusted raw-format guest disk images, you should ensure "
33547 "the format is always specified."
33552 #: ../tools/virt-win-reg.pl:157
33558 #: ../tools/virt-win-reg.pl:159
33560 "In merge mode, this merges a textual regedit file into the Windows Registry "
33561 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33562 "displays or exports Registry entries instead."
33566 #: ../tools/virt-win-reg.pl:163
33568 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33569 "result in disk corruption. However exporting (without this flag) is always "
33575 #: ../tools/virt-win-reg.pl:171
33576 msgid "B<--encoding> UTF-16LE|ASCII"
33581 #: ../tools/virt-win-reg.pl:173
33583 "When merging (only), you may need to specify the encoding for strings to be "
33584 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33585 "(3)/ENCODING STRINGS>."
33590 #: ../tools/virt-win-reg.pl:177
33592 "The default is to use UTF-16LE, which should work with recent versions of "
33597 #: ../tools/virt-win-reg.pl:184
33598 msgid "B<--unsafe-printable-strings>"
33602 #: ../tools/virt-win-reg.pl:186
33604 "When exporting (only), assume strings are UTF-16LE and print them as strings "
33605 "instead of hex sequences. Remove the final zero codepoint from strings if "
33610 #: ../tools/virt-win-reg.pl:190
33612 "This is unsafe and does not preserve the fidelity of strings in the original "
33613 "Registry for various reasons:"
33617 #: ../tools/virt-win-reg.pl:197
33619 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
33620 "other encodings will be corrupted by this transformation."
33624 #: ../tools/virt-win-reg.pl:202
33626 "Assumes that everything which has type 1 or 2 is really a string and that "
33627 "everything else is not a string, but the type field in real Registries is "
33632 #: ../tools/virt-win-reg.pl:208
33634 "Loses information about whether a zero codepoint followed the string in the "
33639 #: ../tools/virt-win-reg.pl:213
33641 "This all happens because the Registry itself contains no information about "
33642 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
33646 #: ../tools/virt-win-reg.pl:217
33648 "You should only use this option for quick hacking and debugging of the "
33649 "Registry contents, and I<never> use it if the output is going to be passed "
33650 "into another program or stored in another Registry."
33655 #: ../tools/virt-win-reg.pl:554
33656 msgid "SUPPORTED SYSTEMS"
33661 #: ../tools/virt-win-reg.pl:556
33663 "The program currently supports Windows NT-derived guests starting with "
33664 "Windows XP through to at least Windows 7."
33668 #: ../tools/virt-win-reg.pl:559
33669 msgid "The following Registry keys are supported:"
33673 #: ../tools/virt-win-reg.pl:563
33674 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
33678 #: ../tools/virt-win-reg.pl:565
33679 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
33683 #: ../tools/virt-win-reg.pl:567
33684 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
33688 #: ../tools/virt-win-reg.pl:569
33689 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
33693 #: ../tools/virt-win-reg.pl:571
33694 msgid "C<HKEY_USERS\\.DEFAULT>"
33698 #: ../tools/virt-win-reg.pl:573
33699 msgid "C<HKEY_USERS\\I<SID>>"
33703 #: ../tools/virt-win-reg.pl:575
33704 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
33708 #: ../tools/virt-win-reg.pl:577
33709 msgid "C<HKEY_USERS\\I<username>>"
33713 #: ../tools/virt-win-reg.pl:579
33715 "where I<username> is a local user name (this is a libguestfs extension)."
33720 #: ../tools/virt-win-reg.pl:583
33722 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33727 #: ../tools/virt-win-reg.pl:586
33729 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
33730 "supported (there is no \"current user\")."
33735 #: ../tools/virt-win-reg.pl:589
33741 #: ../tools/virt-win-reg.pl:591
33743 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33744 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33745 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33746 "Windows-style line endings, you may need to reencode the whole file before "
33747 "or after processing."
33751 #: ../tools/virt-win-reg.pl:597
33753 "To reencode a file from Windows format to Linux (before processing it with "
33754 "the I<--merge> option), you would do something like this:"
33759 #: ../tools/virt-win-reg.pl:600
33762 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33768 #: ../tools/virt-win-reg.pl:602
33770 "To go in the opposite direction, after exporting and before sending the file "
33771 "to a Windows user, do something like this:"
33776 #: ../tools/virt-win-reg.pl:605
33779 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33785 #: ../tools/virt-win-reg.pl:607
33786 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33791 #: ../tools/virt-win-reg.pl:609
33793 "If you are unsure about the current encoding, use the L<file(1)> command. "
33794 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33795 "style (CRLF) line endings, like this:"
33800 #: ../tools/virt-win-reg.pl:613
33803 " $ file software.reg\n"
33804 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33805 " with CRLF line terminators\n"
33810 #: ../tools/virt-win-reg.pl:617
33811 msgid "This file would need conversion before you could I<--merge> it."
33816 #: ../tools/virt-win-reg.pl:619
33817 msgid "CurrentControlSet etc."
33822 #: ../tools/virt-win-reg.pl:621
33824 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33825 "Registry at the level of the hive file, and therefore you cannot modify "
33831 #: ../tools/virt-win-reg.pl:625
33833 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33834 "circumstances it might refer to another control set. The way to find out is "
33835 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33840 #: ../tools/virt-win-reg.pl:629
33843 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33844 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33845 " \"Current\"=dword:00000001\n"
33846 " \"Default\"=dword:00000001\n"
33847 " \"Failed\"=dword:00000000\n"
33848 " \"LastKnownGood\"=dword:00000002\n"
33854 #: ../tools/virt-win-reg.pl:636
33855 msgid "\"Current\" is the one which Windows will choose when it boots."
33860 #: ../tools/virt-win-reg.pl:638
33862 "Similarly, other C<Current...> keys in the path may need to be replaced."
33867 #: ../tools/virt-win-reg.pl:641
33868 msgid "WINDOWS TIPS"
33873 #: ../tools/virt-win-reg.pl:643
33875 "Note that some of these tips modify the guest disk image. The guest I<must> "
33876 "be shut off, else you will get disk corruption."
33881 #: ../tools/virt-win-reg.pl:646
33882 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33887 #: ../tools/virt-win-reg.pl:648
33889 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33890 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33891 "is uploaded into C<C:\\>:"
33896 #: ../tools/virt-win-reg.pl:652
33899 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33905 #: ../tools/virt-win-reg.pl:654
33906 msgid "Prepare a regedit file containing the registry change:"
33911 #: ../tools/virt-win-reg.pl:656
33914 " cat > test.reg <<'EOF'\n"
33915 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33916 " \"Test\"=\"c:\\\\test.bat\"\n"
33923 #: ../tools/virt-win-reg.pl:661
33925 "In this example we use the key C<RunOnce> which means that the script will "
33926 "run precisely once when the first user logs in. If you want it to run every "
33927 "time a user logs in, replace C<RunOnce> with C<Run>."
33932 #: ../tools/virt-win-reg.pl:665
33933 msgid "Now update the registry:"
33938 #: ../tools/virt-win-reg.pl:667
33941 " virt-win-reg --merge WindowsGuest test.reg\n"
33947 #: ../tools/virt-win-reg.pl:669
33948 msgid "INSTALLING A SERVICE"
33953 #: ../tools/virt-win-reg.pl:671
33955 "This section assumes you are familiar with Windows services, and you either "
33956 "have a program which handles the Windows Service Control Protocol directly "
33957 "or you want to run any program using a service wrapper like SrvAny or the "
33963 #: ../tools/virt-win-reg.pl:676
33965 "First upload the program and optionally the service wrapper. In this case "
33966 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33971 #: ../tools/virt-win-reg.pl:680
33974 " guestfish -i -d WindowsGuest <<EOF\n"
33975 " upload rhsrvany.exe /rhsrvany.exe\n"
33976 " upload test.exe /test.exe\n"
33983 #: ../tools/virt-win-reg.pl:685
33985 "Prepare a regedit file containing the registry changes. In this example, "
33986 "the first registry change is needed for the service itself or the service "
33987 "wrapper (if used). The second registry change is only needed because I am "
33988 "using the RHSrvAny service wrapper."
33993 #: ../tools/virt-win-reg.pl:690
33996 " cat > service.reg <<'EOF'\n"
33997 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33998 " \"Type\"=dword:00000010\n"
33999 " \"Start\"=dword:00000002\n"
34000 " \"ErrorControl\"=dword:00000001\n"
34001 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
34002 " \"DisplayName\"=\"RHSrvAny\"\n"
34003 " \"ObjectName\"=\"NetworkService\"\n"
34009 #: ../tools/virt-win-reg.pl:699
34012 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
34013 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
34014 " \"PWD\"=\"c:\\\\Temp\"\n"
34021 #: ../tools/virt-win-reg.pl:710
34023 "For use of C<ControlSet001> see the section above in this manual page. You "
34024 "may need to adjust this according to the control set that is in use by the "
34030 #: ../tools/virt-win-reg.pl:716
34032 "C<\"ObjectName\"> controls the privileges that the service will have. An "
34033 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
34034 "privileged account."
34039 #: ../tools/virt-win-reg.pl:722
34041 "For the meaning of the magic numbers, see this Microsoft KB article: "
34042 "L<http://support.microsoft.com/kb/103000>."
34047 #: ../tools/virt-win-reg.pl:727
34048 msgid "Update the registry:"
34053 #: ../tools/virt-win-reg.pl:729
34056 " virt-win-reg --merge WindowsGuest service.reg\n"
34062 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
34063 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
34064 #: ../tools/virt-list-partitions.pl:250
34065 msgid "SHELL QUOTING"
34070 #: ../tools/virt-win-reg.pl:733
34072 "Be careful when passing parameters containing C<\\> (backslash) in the "
34073 "shell. Usually you will have to use 'single quotes' or double backslashes "
34074 "(but not both) to protect them from the shell."
34079 #: ../tools/virt-win-reg.pl:737
34080 msgid "Paths and value names are case-insensitive."
34085 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
34086 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
34087 #: ../tools/virt-list-partitions.pl:252
34089 "Libvirt guest names can contain arbitrary characters, some of which have "
34090 "meaning to the shell such as C<#> and space. You may need to quote or "
34091 "escape these characters on the command line. See the shell manual page L<sh"
34092 "(1)> for details."
34097 #: ../tools/virt-win-reg.pl:746
34099 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
34100 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
34101 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34106 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
34108 "When reporting bugs, please enable debugging and capture the I<complete> "
34114 #: ../tools/virt-win-reg.pl:764
34117 " export LIBGUESTFS_DEBUG=1\n"
34118 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
34124 #: ../tools/virt-win-reg.pl:767
34126 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
34132 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
34133 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
34134 #: ../tools/virt-list-partitions.pl:269
34140 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
34141 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
34142 #: ../tools/virt-list-partitions.pl:271
34143 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
34148 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
34149 msgid "Copyright (C) 2010 Red Hat Inc."
34154 #: ../tools/virt-list-filesystems.pl:32
34156 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34161 #: ../tools/virt-list-filesystems.pl:36
34164 " virt-list-filesystems [--options] domname\n"
34170 #: ../tools/virt-list-filesystems.pl:38
34173 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34179 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34181 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34187 #: ../tools/virt-list-filesystems.pl:45
34189 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34190 "are contained in a virtual machine or disk image."
34195 #: ../tools/virt-list-filesystems.pl:49
34197 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34198 "functionality. For more complex cases you should look at the L<guestfish(1)"
34204 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34205 msgid "B<-l> | B<--long>"
34210 #: ../tools/virt-list-filesystems.pl:108
34212 "With this option, C<virt-list-filesystems> displays the type of each "
34213 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34218 #: ../tools/virt-list-filesystems.pl:115
34219 msgid "B<-a> | B<--all>"
34224 #: ../tools/virt-list-filesystems.pl:117
34226 "Normally we only show mountable filesystems. If this option is given then "
34227 "swap devices are shown too."
34232 #: ../tools/virt-list-filesystems.pl:191
34234 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34235 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34236 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34241 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34242 msgid "Copyright (C) 2009 Red Hat Inc."
34247 #: ../tools/virt-tar.pl:33
34248 msgid "virt-tar - Extract or upload files to a virtual machine"
34253 #: ../tools/virt-tar.pl:37
34256 " virt-tar [--options] -x domname directory tarball\n"
34262 #: ../tools/virt-tar.pl:39
34265 " virt-tar [--options] -u domname tarball directory\n"
34271 #: ../tools/virt-tar.pl:41
34274 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34280 #: ../tools/virt-tar.pl:43
34283 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34288 #: ../tools/virt-tar.pl:47
34290 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34291 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34296 #: ../tools/virt-tar.pl:52
34297 msgid "Download C</home> from the VM into a local tarball:"
34302 #: ../tools/virt-tar.pl:54
34305 " virt-tar -x domname /home home.tar\n"
34311 #: ../tools/virt-tar.pl:56
34314 " virt-tar -zx domname /home home.tar.gz\n"
34320 #: ../tools/virt-tar.pl:58
34321 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34326 #: ../tools/virt-tar.pl:60
34329 " virt-tar -u domname uploadstuff.tar /tmp\n"
34335 #: ../tools/virt-tar.pl:62
34338 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34343 #: ../tools/virt-tar.pl:66
34345 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34346 "virtual machines. If you do this, you risk disk corruption in the VM. "
34347 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34351 #: ../tools/virt-tar.pl:71
34353 "You can use I<-x> (extract) on live virtual machines, but you might get "
34354 "inconsistent results or errors if there is filesystem activity inside the "
34355 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34356 "work, but the only way to guarantee consistent results is if the virtual "
34357 "machine is shut down."
34362 #: ../tools/virt-tar.pl:79
34364 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34365 "parts of a guest filesystem. There are many possibilities: making backups, "
34366 "uploading data files, snooping on guest activity, fixing or customizing "
34372 #: ../tools/virt-tar.pl:84
34374 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34375 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34376 "should look at the L<guestfish(1)> tool."
34380 #: ../tools/virt-tar.pl:88
34382 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34383 "its contents (recursively) from the virtual machine into a local tarball. "
34384 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34385 "virtual machine. You cannot use these two options together."
34389 #: ../tools/virt-tar.pl:94
34391 "In addition, you may need to use the I<-z> (gZip) option to enable "
34392 "compression. When uploading, you have to specify I<-z> if the upload file "
34393 "is compressed because virt-tar won't detect this on its own."
34398 #: ../tools/virt-tar.pl:98
34400 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34401 "example it cannot do PKZip files or bzip2 compression. If you want that "
34402 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34403 "the L<libguestfs(3)> API)."
34408 #: ../tools/virt-tar.pl:156
34409 msgid "B<-x> | B<--extract> | B<--download>"
34414 #: ../tools/virt-tar.pl:158
34415 msgid "B<-u> | B<--upload>"
34419 #: ../tools/virt-tar.pl:160
34421 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34426 #: ../tools/virt-tar.pl:163
34428 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34429 "Please read the L</WARNING> section above before using this option."
34434 #: ../tools/virt-tar.pl:167
34435 msgid "You must specify exactly one of these options."
34440 #: ../tools/virt-tar.pl:173
34441 msgid "B<-z> | B<--gzip>"
34446 #: ../tools/virt-tar.pl:175
34447 msgid "Specify that the input or output tarball is gzip-compressed."
34451 #: ../tools/virt-tar.pl:288
34453 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34454 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34455 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34461 #: ../tools/virt-make-fs.pl:37
34462 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34467 #: ../tools/virt-make-fs.pl:41
34470 " virt-make-fs [--options] input.tar output.img\n"
34476 #: ../tools/virt-make-fs.pl:43
34479 " virt-make-fs [--options] input.tar.gz output.img\n"
34485 #: ../tools/virt-make-fs.pl:45
34488 " virt-make-fs [--options] directory output.img\n"
34494 #: ../tools/virt-make-fs.pl:49
34496 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34497 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34498 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34499 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34500 "you want to attach these filesystems to existing virtual machines (eg. to "
34501 "import large amounts of read-only data to a VM)."
34506 #: ../tools/virt-make-fs.pl:57
34507 msgid "Basic usage is:"
34512 #: ../tools/virt-make-fs.pl:59
34515 " virt-make-fs input output\n"
34521 #: ../tools/virt-make-fs.pl:61
34523 "where C<input> is either a directory containing files that you want to add, "
34524 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34525 "C<output> is a disk image. The input type is detected automatically. The "
34526 "output disk image defaults to a raw ext2 image unless you specify extra "
34527 "flags (see L</OPTIONS> below)."
34532 #: ../tools/virt-make-fs.pl:67
34533 msgid "EXTRA SPACE"
34537 #: ../tools/virt-make-fs.pl:69
34539 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34540 "the files that it contains, but might have extra space. Depending on how "
34541 "you are going to use the output, you might think this extra space is wasted "
34542 "and want to minimize it, or you might want to leave space so that more files "
34543 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34544 "but you can use the I<--size> flag to leave space in the filesystem if you "
34549 #: ../tools/virt-make-fs.pl:77
34551 "An alternative way to leave extra space but not make the output image any "
34552 "bigger is to use an alternative disk image format (instead of the default "
34553 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34554 "image format (check your hypervisor supports this before using it). This "
34555 "allows you to choose a large I<--size> but the extra space won't actually be "
34556 "allocated in the image until you try to store something in it."
34560 #: ../tools/virt-make-fs.pl:85
34562 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34563 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34564 "to build another image from scratch."
34569 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34570 #: ../tools/virt-make-fs.pl:142
34576 #: ../tools/virt-make-fs.pl:91
34579 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34585 #: ../tools/virt-make-fs.pl:93
34586 msgid "FILESYSTEM TYPE"
34591 #: ../tools/virt-make-fs.pl:95
34593 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34594 "libguestfs supports can be used (but I<not> read-only formats like "
34595 "ISO9660). Here are some of the more common choices:"
34600 #: ../tools/virt-make-fs.pl:101
34606 #: ../tools/virt-make-fs.pl:103
34608 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34609 "you are not going to use the filesystem in a way that requires the journal, "
34610 "then this is just wasted overhead."
34615 #: ../tools/virt-make-fs.pl:107
34616 msgid "I<ntfs> or I<vfat>"
34621 #: ../tools/virt-make-fs.pl:109
34622 msgid "Useful if exporting data to a Windows guest."
34627 #: ../tools/virt-make-fs.pl:111
34629 "I<Note for vfat>: The tar archive or local directory must only contain files "
34630 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34631 "program running within libguestfs is unable to change the ownership of non-"
34632 "root files, since vfat itself does not support this."
34637 #: ../tools/virt-make-fs.pl:116
34643 #: ../tools/virt-make-fs.pl:118
34645 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34646 "total filesystem size."
34651 #: ../tools/virt-make-fs.pl:125
34654 " virt-make-fs --type=minix input minixfs.img\n"
34660 #: ../tools/virt-make-fs.pl:127
34661 msgid "TO PARTITION OR NOT TO PARTITION"
34666 #: ../tools/virt-make-fs.pl:129
34667 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34672 #: ../tools/virt-make-fs.pl:131
34674 "Adding a partition can make the disk image more compatible with certain "
34675 "virtualized operating systems which don't expect to see a filesystem "
34676 "directly located on a block device (Linux doesn't care and will happily "
34677 "handle both types)."
34682 #: ../tools/virt-make-fs.pl:136
34684 "On the other hand, if you have a partition table then the output image is no "
34685 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34686 "directly on a partitioned disk image. (However libguestfs tools such as "
34687 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34692 #: ../tools/virt-make-fs.pl:144
34693 msgid "Add an MBR partition:"
34698 #: ../tools/virt-make-fs.pl:146
34701 " virt-make-fs --partition -- input disk.img\n"
34707 #: ../tools/virt-make-fs.pl:148
34709 "If the output disk image could be terabyte-sized or larger, it's better to "
34710 "use an EFI/GPT-compatible partition table:"
34715 #: ../tools/virt-make-fs.pl:151
34718 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34724 #: ../tools/virt-make-fs.pl:179
34725 msgid "Enable debugging information."
34730 #: ../tools/virt-make-fs.pl:185
34731 msgid "B<--size=E<lt>NE<gt>>"
34736 #: ../tools/virt-make-fs.pl:187
34737 msgid "B<--size=+E<lt>NE<gt>>"
34742 #: ../tools/virt-make-fs.pl:189
34743 msgid "B<-s E<lt>NE<gt>>"
34748 #: ../tools/virt-make-fs.pl:191
34749 msgid "B<-s +E<lt>NE<gt>>"
34753 #: ../tools/virt-make-fs.pl:193
34755 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34760 #: ../tools/virt-make-fs.pl:196
34762 "If this option is I<not> given, then the output image will be just large "
34763 "enough to contain all the files, with not much wasted space."
34768 #: ../tools/virt-make-fs.pl:199
34770 "To choose a fixed size output disk, specify an absolute number followed by b/"
34771 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34772 "Petabytes or Exabytes. This must be large enough to contain all the input "
34773 "files, else you will get an error."
34777 #: ../tools/virt-make-fs.pl:204
34779 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34780 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34781 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34782 "the input files, and (approximately) an extra 200 MB free space."
34787 #: ../tools/virt-make-fs.pl:210
34789 "Note that virt-make-fs estimates free space, and therefore will not produce "
34790 "filesystems containing precisely the free space requested. (It is much more "
34791 "expensive and time-consuming to produce a filesystem which has precisely the "
34792 "desired free space)."
34797 #: ../tools/virt-make-fs.pl:219
34798 msgid "B<--format=E<lt>fmtE<gt>>"
34803 #: ../tools/virt-make-fs.pl:221
34804 msgid "B<-F E<lt>fmtE<gt>>"
34809 #: ../tools/virt-make-fs.pl:223
34810 msgid "Choose the output disk image format."
34815 #: ../tools/virt-make-fs.pl:225
34816 msgid "The default is C<raw> (raw disk image)."
34821 #: ../tools/virt-make-fs.pl:227
34823 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34824 "that would really make sense here is C<qcow2>."
34829 #: ../tools/virt-make-fs.pl:234
34830 msgid "B<--type=E<lt>fsE<gt>>"
34835 #: ../tools/virt-make-fs.pl:236
34836 msgid "B<-t E<lt>fsE<gt>>"
34841 #: ../tools/virt-make-fs.pl:238
34842 msgid "Choose the output filesystem type."
34847 #: ../tools/virt-make-fs.pl:240
34848 msgid "The default is C<ext2>."
34853 #: ../tools/virt-make-fs.pl:242
34855 "Any filesystem which is supported read-write by libguestfs can be used here."
34860 #: ../tools/virt-make-fs.pl:249
34861 msgid "B<--partition>"
34866 #: ../tools/virt-make-fs.pl:251
34867 msgid "B<--partition=E<lt>parttypeE<gt>>"
34872 #: ../tools/virt-make-fs.pl:253
34874 "If specified, this flag adds an MBR partition table to the output disk image."
34878 #: ../tools/virt-make-fs.pl:256
34880 "You can change the partition table type, eg. I<--partition=gpt> for large "
34885 #: ../tools/virt-make-fs.pl:259
34887 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34888 "might consider the next parameter to be the partition type. For example:"
34893 #: ../tools/virt-make-fs.pl:263
34896 " virt-make-fs --partition input.tar ...\n"
34901 #: ../tools/virt-make-fs.pl:265
34903 "would cause virt-make-fs to think you wanted to use a partition type of "
34904 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34905 "dash) between options and the input file argument:"
34910 #: ../tools/virt-make-fs.pl:269
34913 " virt-make-fs --partition -- input.tar ...\n"
34918 #: ../tools/virt-make-fs.pl:541
34920 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34921 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34922 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34927 #: ../tools/virt-make-fs.pl:558
34930 " export LIBGUESTFS_DEBUG=1\n"
34931 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34937 #: ../tools/virt-make-fs.pl:561
34939 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34945 #: ../tools/virt-list-partitions.pl:32
34947 "virt-list-partitions - List partitions in a virtual machine or disk image"
34952 #: ../tools/virt-list-partitions.pl:36
34955 " virt-list-partitions [--options] domname\n"
34961 #: ../tools/virt-list-partitions.pl:38
34964 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34970 #: ../tools/virt-list-partitions.pl:45
34972 "C<virt-list-partitions> is a command line tool to list the partitions that "
34973 "are contained in a virtual machine or disk image. It is mainly useful as a "
34974 "first step to using L<virt-resize(1)>."
34979 #: ../tools/virt-list-partitions.pl:50
34981 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34982 "functionality. For more complex cases you should look at the L<guestfish(1)"
34988 #: ../tools/virt-list-partitions.pl:107
34989 msgid "B<-h> | B<--human-readable>"
34994 #: ../tools/virt-list-partitions.pl:109
34995 msgid "Show sizes in human-readable form (eg. \"1G\")."
35000 #: ../tools/virt-list-partitions.pl:117
35002 "With this option, C<virt-list-partitions> displays the type and size of each "
35003 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35008 #: ../tools/virt-list-partitions.pl:124
35009 msgid "B<-t> | B<--total>"
35014 #: ../tools/virt-list-partitions.pl:126
35016 "Display the total size of each block device (as a separate row or rows)."
35021 #: ../tools/virt-list-partitions.pl:259
35023 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35024 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35025 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35030 #: ../tools/virt-list-partitions.pl:275
35031 msgid "Copyright (C) 2009-2010 Red Hat Inc."
git.annexia.org / libguestfs.git / blob