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-27 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-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
25 #: ../tools/virt-make-fs.pl:35 ../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-edit.pl:36 ../tools/virt-win-reg.pl:39
40 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
41 #: ../tools/virt-make-fs.pl:39 ../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-edit.pl:50 ../tools/virt-win-reg.pl:63
85 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
86 #: ../tools/virt-make-fs.pl:47 ../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:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762
923 #: ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
924 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380
925 #: ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397
926 #: ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976
927 #: ../src/guestfs.pod:2980 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
929 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
930 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1597
931 #: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1605
932 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1617
933 #: ../src/guestfs-actions.pod:1621 ../src/guestfs-actions.pod:1625
934 #: ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1639
935 #: ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1781
936 #: ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1790
937 #: ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1856
938 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865
939 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
940 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
941 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
942 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
943 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
944 #: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073
945 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081
946 #: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093
947 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1107
948 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1115
949 #: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1209
950 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
951 #: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1265
952 #: ../fish/guestfish-actions.pod:1270 ../tools/virt-edit.pl:351
953 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
954 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
955 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
956 #: ../tools/virt-win-reg.pl:548
962 #: ../src/guestfs.pod:390
964 "The kernel version that the command runs under will be different from what "
970 #: ../src/guestfs.pod:395
972 "If the command needs to communicate with daemons, then most likely they "
978 #: ../src/guestfs.pod:400
979 msgid "The command will be running in limited memory."
984 #: ../src/guestfs.pod:404
986 "The network may not be available unless you enable it (see L</"
987 "guestfs_set_network>)."
992 #: ../src/guestfs.pod:409
993 msgid "Only supports Linux guests (not Windows, BSD, etc)."
998 #: ../src/guestfs.pod:413
1000 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1005 #: ../src/guestfs.pod:418
1007 "For SELinux guests, you may need to enable SELinux and load policy first. "
1008 "See L</SELINUX> in this manpage."
1013 #: ../src/guestfs.pod:423
1015 "I<Security:> It is not safe to run commands from untrusted, possibly "
1016 "malicious guests. These commands may attempt to exploit your program by "
1017 "sending unexpected output. They could also try to exploit the Linux kernel "
1018 "or qemu provided by the libguestfs appliance. They could use the network "
1019 "provided by the libguestfs appliance to bypass ordinary network partitions "
1020 "and firewalls. They could use the elevated privileges or different SELinux "
1021 "context of your program to their advantage."
1026 #: ../src/guestfs.pod:432
1028 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1029 "(a script which runs when the guest next boots normally), and to have this "
1030 "script run the commands you want in the normal context of the running guest, "
1031 "network security and so on. For information about other security issues, "
1037 #: ../src/guestfs.pod:440
1039 "The two main API calls to run commands are L</guestfs_command> and L</"
1040 "guestfs_sh> (there are also variations)."
1045 #: ../src/guestfs.pod:443
1047 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1048 "shell globs, redirections, etc will work."
1053 #: ../src/guestfs.pod:446
1054 msgid "CONFIGURATION FILES"
1059 #: ../src/guestfs.pod:448
1061 "To read and write configuration files in Linux guest filesystems, we "
1062 "strongly recommend using Augeas. For example, Augeas understands how to "
1063 "read and write, say, a Linux shadow password file or X.org configuration "
1064 "file, and so avoids you having to write that code."
1069 #: ../src/guestfs.pod:453
1071 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1072 "document Augeas itself here because there is excellent documentation on the "
1073 "L<http://augeas.net/> website."
1078 #: ../src/guestfs.pod:457
1080 "If you don't want to use Augeas (you fool!) then try calling L</"
1081 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1087 #: ../src/guestfs.pod:461
1093 #: ../src/guestfs.pod:463
1095 "We support SELinux guests. To ensure that labeling happens correctly in "
1096 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1101 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1102 #: ../src/guestfs.pod:2425
1108 #: ../src/guestfs.pod:471
1109 msgid "Before launching, do:"
1114 #: ../src/guestfs.pod:473
1117 " guestfs_set_selinux (g, 1);\n"
1123 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1124 #: ../src/guestfs.pod:2450
1130 #: ../src/guestfs.pod:477
1132 "After mounting the guest's filesystem(s), load the policy. This is best "
1133 "done by running the L<load_policy(8)> command in the guest itself:"
1138 #: ../src/guestfs.pod:481
1141 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1147 #: ../src/guestfs.pod:483
1149 "(Older versions of C<load_policy> require you to specify the name of the "
1155 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1161 #: ../src/guestfs.pod:488
1163 "Optionally, set the security context for the API. The correct security "
1164 "context to use can only be known by inspecting the guest. As an example:"
1169 #: ../src/guestfs.pod:492
1172 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1178 #: ../src/guestfs.pod:496
1179 msgid "This will work for running commands and editing existing files."
1184 #: ../src/guestfs.pod:498
1186 "When new files are created, you may need to label them explicitly, for "
1187 "example by running the external command C<restorecon pathname>."
1192 #: ../src/guestfs.pod:502
1198 #: ../src/guestfs.pod:504
1200 "Certain calls are affected by the current file mode creation mask (the "
1201 "\"umask\"). In particular ones which create files or directories, such as "
1202 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1203 "either the default mode that the file is created with or modifies the mode "
1209 #: ../src/guestfs.pod:510
1211 "The default umask is C<022>, so files are created with modes such as C<0644> "
1212 "and directories with C<0755>."
1217 #: ../src/guestfs.pod:513
1219 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1220 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1221 "guestfs_chmod> after creating each file or directory."
1226 #: ../src/guestfs.pod:517
1227 msgid "For more information about umask, see L<umask(2)>."
1232 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1233 msgid "ENCRYPTED DISKS"
1238 #: ../src/guestfs.pod:521
1240 "Libguestfs allows you to access Linux guests which have been encrypted using "
1241 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1242 "standard. This includes nearly all whole disk encryption systems used by "
1243 "modern Linux guests."
1248 #: ../src/guestfs.pod:527
1250 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1251 "returns the string C<crypto_LUKS>)."
1256 #: ../src/guestfs.pod:530
1258 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1259 "will require the passphrase!"
1264 #: ../src/guestfs.pod:533
1266 "Opening a LUKS device creates a new device mapper device called C</dev/"
1267 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1268 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1269 "from and encrypted to the underlying block device respectively."
1274 #: ../src/guestfs.pod:539
1276 "LVM volume groups on the device can be made visible by calling L</"
1277 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1278 "(s) can now be mounted in the usual way."
1283 #: ../src/guestfs.pod:543
1285 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1286 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1287 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1288 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1289 "underlying encrypted block device)."
1294 #: ../src/guestfs.pod:550
1299 #: ../src/guestfs.pod:552
1301 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1302 "contains operating systems, an install CD or a live CD. (These APIs used to "
1303 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1304 "version 1.5.3 the most frequently used part of this library has been "
1305 "rewritten in C and moved into the core code)."
1310 #: ../src/guestfs.pod:559
1312 "Add all disks belonging to the unknown virtual machine and call L</"
1313 "guestfs_launch> in the usual way."
1318 #: ../src/guestfs.pod:562
1320 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1321 "and certain heuristics, and returns a list of operating systems that were "
1322 "found. An empty list means none were found. A single element is the root "
1323 "filesystem of the operating system. For dual- or multi-boot guests, "
1324 "multiple roots can be returned, each one corresponding to a separate "
1325 "operating system. (Multi-boot virtual machines are extremely rare in the "
1326 "world of virtualization, but since this scenario can happen, we have built "
1327 "libguestfs to deal with it.)"
1332 #: ../src/guestfs.pod:571
1334 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1335 "to get additional details about that operating system. For example, call L</"
1336 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1337 "Windows and Linux-based operating systems respectively."
1342 #: ../src/guestfs.pod:577
1344 "Un*x-like and Linux-based operating systems usually consist of several "
1345 "filesystems which are mounted at boot time (for example, a separate boot "
1346 "partition mounted on C</boot>). The inspection rules are able to detect how "
1347 "filesystems correspond to mount points. Call "
1348 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1349 "hash table like this example:"
1354 #: ../src/guestfs.pod:584
1357 " /boot => /dev/sda1\n"
1358 " / => /dev/vg_guest/lv_root\n"
1359 " /usr => /dev/vg_guest/lv_usr\n"
1365 #: ../src/guestfs.pod:588
1367 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1368 "filesystems as suggested."
1373 #: ../src/guestfs.pod:591
1375 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1376 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1381 #: ../src/guestfs.pod:595
1383 "Inspection currently only works for some common operating systems. "
1384 "Contributors are welcome to send patches for other operating systems that we "
1385 "currently cannot detect."
1390 #: ../src/guestfs.pod:599
1392 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1393 "for more details. The L</guestfs_inspect_os> function just ignores any "
1394 "encrypted devices."
1399 #: ../src/guestfs.pod:603
1401 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1402 "inspection and caches the results in the guest handle. Subsequent calls to "
1403 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1404 "read the disks. If you change the content of the guest disks, you can redo "
1405 "inspection by calling L</guestfs_inspect_os> again. (L</"
1406 "guestfs_inspect_list_applications> works a little differently from the other "
1407 "calls and does read the disks. See documentation for that function for "
1412 #: ../src/guestfs.pod:612
1413 msgid "INSPECTING INSTALL DISKS"
1417 #: ../src/guestfs.pod:614
1419 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1424 #: ../src/guestfs.pod:617
1426 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1427 "system, which currently can be C<installed> (a regular operating system) or "
1428 "C<installer> (some sort of install disk)."
1432 #: ../src/guestfs.pod:621
1434 "Further information is available about the operating system that can be "
1435 "installed using the regular inspection APIs like L</"
1436 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1440 #: ../src/guestfs.pod:626
1442 "Some additional information specific to installer disks is also available "
1443 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1444 "guestfs_inspect_is_multipart> calls."
1449 #: ../src/guestfs.pod:631
1450 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1455 #: ../src/guestfs.pod:633
1457 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1458 "ntfs-3g.org/> driver."
1463 #: ../src/guestfs.pod:636
1464 msgid "DRIVE LETTERS AND PATHS"
1469 #: ../src/guestfs.pod:638
1471 "DOS and Windows still use drive letters, and the filesystems are always "
1472 "treated as case insensitive by Windows itself, and therefore you might find "
1473 "a Windows configuration file referring to a path like C<c:\\windows"
1474 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1475 "might be referred to as C</WINDOWS/System32>."
1479 #: ../src/guestfs.pod:644
1481 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1482 "L</guestfs_inspect_get_drive_mappings>)"
1486 #: ../src/guestfs.pod:647
1488 "Dealing with separator characters (backslash vs forward slash) is outside "
1489 "the scope of libguestfs, but usually a simple character replacement will "
1494 #: ../src/guestfs.pod:651
1496 "To resolve the case insensitivity of paths, call L</"
1497 "guestfs_case_sensitive_path>."
1502 #: ../src/guestfs.pod:654
1503 msgid "ACCESSING THE WINDOWS REGISTRY"
1508 #: ../src/guestfs.pod:656
1510 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1511 "files, through the library C<hivex> which is part of the libguestfs project "
1512 "although ships as a separate tarball. You have to locate and download the "
1513 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1514 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1515 "reg(1)> for more help on this issue."
1520 #: ../src/guestfs.pod:664
1521 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1526 #: ../src/guestfs.pod:666
1528 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1529 "provide something which looks like a Linux symlink. The way it tries to do "
1530 "the rewriting is described here:"
1535 #: ../src/guestfs.pod:670
1537 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1543 #: ../src/guestfs.pod:672
1545 "The essential problem is that ntfs-3g simply does not have enough "
1546 "information to do a correct job. NTFS links can contain drive letters and "
1547 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1548 "It is almost certainly the case that libguestfs callers should ignore what "
1549 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1554 #: ../src/guestfs.pod:679
1556 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1557 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1558 "attribute, and read the raw reparse data from that (you can find the format "
1559 "documented in various places around the web)."
1564 #: ../src/guestfs.pod:684
1565 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1570 #: ../src/guestfs.pod:686
1572 "There are other useful extended attributes that can be read from ntfs-3g "
1573 "filesystems (using L</guestfs_getxattr>). See:"
1578 #: ../src/guestfs.pod:689
1580 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1585 #: ../src/guestfs.pod:691
1586 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1591 #: ../src/guestfs.pod:693
1593 "Although we don't want to discourage you from using the C API, we will "
1594 "mention here that the same API is also available in other languages."
1598 #: ../src/guestfs.pod:696
1600 "The API is broadly identical in all supported languages. This means that "
1601 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1602 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1603 "OCaml. In other words, a straightforward, predictable isomorphism between "
1609 #: ../src/guestfs.pod:702
1611 "Error messages are automatically transformed into exceptions if the language "
1617 #: ../src/guestfs.pod:705
1619 "We don't try to \"object orientify\" parts of the API in OO languages, "
1620 "although contributors are welcome to write higher level APIs above what we "
1621 "provide in their favourite languages if they wish."
1626 #: ../src/guestfs.pod:711
1632 #: ../src/guestfs.pod:713
1634 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1635 "identical to the C API. C++ classes and exceptions are not used."
1640 #: ../src/guestfs.pod:717
1646 #: ../src/guestfs.pod:719
1648 "The C# bindings are highly experimental. Please read the warnings at the "
1649 "top of C<csharp/Libguestfs.cs>."
1654 #: ../src/guestfs.pod:722
1660 #: ../src/guestfs.pod:724
1662 "This is the only language binding that is working but incomplete. Only "
1663 "calls which return simple integers have been bound in Haskell, and we are "
1664 "looking for help to complete this binding."
1669 #: ../src/guestfs.pod:728
1675 #: ../src/guestfs.pod:730
1677 "Full documentation is contained in the Javadoc which is distributed with "
1683 #: ../src/guestfs.pod:733
1688 #: ../src/guestfs.pod:735
1689 msgid "See L<guestfs-ocaml(3)>."
1694 #: ../src/guestfs.pod:737
1699 #: ../src/guestfs.pod:739
1700 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1705 #: ../src/guestfs.pod:741
1711 #: ../src/guestfs.pod:743
1713 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1714 "the php-libguestfs package for your distribution."
1719 #: ../src/guestfs.pod:746
1720 msgid "The PHP binding only works correctly on 64 bit machines."
1725 #: ../src/guestfs.pod:748
1730 #: ../src/guestfs.pod:750
1731 msgid "See L<guestfs-python(3)>."
1736 #: ../src/guestfs.pod:752
1741 #: ../src/guestfs.pod:754
1742 msgid "See L<guestfs-ruby(3)>."
1747 #: ../src/guestfs.pod:756
1748 msgid "B<shell scripts>"
1752 #: ../src/guestfs.pod:758
1753 msgid "See L<guestfish(1)>."
1758 #: ../src/guestfs.pod:762
1759 msgid "LIBGUESTFS GOTCHAS"
1764 #: ../src/guestfs.pod:764
1766 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1767 "system [...] that works in the way it is documented but is counterintuitive "
1768 "and almost invites mistakes.\""
1773 #: ../src/guestfs.pod:768
1775 "Since we developed libguestfs and the associated tools, there are several "
1776 "things we would have designed differently, but are now stuck with for "
1777 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1778 "release, you can expect these to change. Beware of them."
1783 #: ../src/guestfs.pod:776
1784 msgid "Autosync / forgetting to sync."
1788 #: ../src/guestfs.pod:778
1790 "I<Update:> Autosync is enabled by default for all API users starting from "
1791 "libguestfs 1.5.24. This section only applies to older versions."
1796 #: ../src/guestfs.pod:781
1798 "When modifying a filesystem from C or another language, you B<must> unmount "
1799 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1800 "libguestfs handle. You can also call:"
1805 #: ../src/guestfs.pod:785
1808 " guestfs_set_autosync (g, 1);\n"
1814 #: ../src/guestfs.pod:787
1816 "to have the unmount/sync done automatically for you when the handle 'g' is "
1817 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1822 #: ../src/guestfs.pod:791
1824 "If you forget to do this, then it is entirely possible that your changes "
1825 "won't be written out, or will be partially written, or (very rarely) that "
1826 "you'll get disk corruption."
1831 #: ../src/guestfs.pod:795
1833 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1834 "guestfish scripts that forget to sync will work just fine, which can make "
1835 "this very puzzling if you are trying to debug a problem."
1840 #: ../src/guestfs.pod:799
1841 msgid "Mount option C<-o sync> should not be the default."
1846 #: ../src/guestfs.pod:801
1848 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1849 "However C<-o sync> does not add any reliability benefit, but does have a "
1850 "very large performance impact."
1855 #: ../src/guestfs.pod:805
1857 "The work around is to use L</guestfs_mount_options> and set the mount "
1858 "options that you actually want to use."
1863 #: ../src/guestfs.pod:808
1864 msgid "Read-only should be the default."
1869 #: ../src/guestfs.pod:810
1871 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1872 "specify I<--rw> if you want to make changes to the image."
1877 #: ../src/guestfs.pod:813
1878 msgid "This would reduce the potential to corrupt live VM images."
1883 #: ../src/guestfs.pod:815
1885 "Note that many filesystems change the disk when you just mount and unmount, "
1886 "even if you didn't perform any writes. You need to use L</"
1887 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1892 #: ../src/guestfs.pod:819
1893 msgid "guestfish command line is hard to use."
1898 #: ../src/guestfs.pod:821
1900 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1901 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1902 "exist, so it fails. In earlier versions of guestfish the error message was "
1903 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1904 "we should have used C<guestfish -c command> to run commands."
1909 #: ../src/guestfs.pod:828
1910 msgid "guestfish megabyte modifiers don't work right on all commands"
1915 #: ../src/guestfs.pod:830
1917 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1918 "other modifiers). What guestfish actually does is to multiply the number "
1919 "part by the modifier part and pass the result to the C API. However this "
1920 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1921 "expecting some other unit (eg. megabytes)."
1926 #: ../src/guestfs.pod:837
1927 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1932 #: ../src/guestfs.pod:839
1935 " lvcreate LV VG 100M\n"
1941 #: ../src/guestfs.pod:841
1943 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1944 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1945 "megabytes * megabytes) logical volume. The error message you get from this "
1946 "is also a little obscure."
1951 #: ../src/guestfs.pod:846
1953 "This could be fixed in the generator by specially marking parameters and "
1954 "return values which take bytes or other units."
1959 #: ../src/guestfs.pod:849
1960 msgid "Ambiguity between devices and paths"
1965 #: ../src/guestfs.pod:851
1967 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1968 "sdb2>) and a similar pathname. A file might just happen to be called "
1969 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1974 #: ../src/guestfs.pod:856
1976 "In the current API we usually resolve this ambiguity by having two separate "
1977 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1978 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1979 "detecting if the path supplied begins with C</dev/>."
1984 #: ../src/guestfs.pod:862
1986 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1987 "make paths/devices into structured names. One way to do this would be to "
1988 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1989 "aspect of grub. Another way would be to use a structured type, equivalent "
1990 "to this OCaml type:"
1995 #: ../src/guestfs.pod:868
1998 " type path = Path of string | Device of int | Partition of int * int\n"
2004 #: ../src/guestfs.pod:870
2005 msgid "which would allow you to pass arguments like:"
2010 #: ../src/guestfs.pod:872
2013 " Path \"/foo/bar\"\n"
2014 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2015 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2016 " Path \"/dev/sdb2\" (* not a device *)\n"
2022 #: ../src/guestfs.pod:877
2024 "As you can see there are still problems to resolve even with this "
2025 "representation. Also consider how it might work in guestfish."
2030 #: ../src/guestfs.pod:882
2031 msgid "KEYS AND PASSPHRASES"
2036 #: ../src/guestfs.pod:884
2038 "Certain libguestfs calls take a parameter that contains sensitive key "
2039 "material, passed in as a C string."
2044 #: ../src/guestfs.pod:887
2046 "In the future we would hope to change the libguestfs implementation so that "
2047 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2048 "swap. However this is I<not> done at the moment, because of the complexity "
2049 "of such an implementation."
2054 #: ../src/guestfs.pod:892
2056 "Therefore you should be aware that any key parameter you pass to libguestfs "
2057 "might end up being written out to the swap partition. If this is a concern, "
2058 "scrub the swap partition or don't use libguestfs on encrypted devices."
2063 #: ../src/guestfs.pod:897
2064 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2069 #: ../src/guestfs.pod:899
2071 "All high-level libguestfs actions are synchronous. If you want to use "
2072 "libguestfs asynchronously then you must create a thread."
2077 #: ../src/guestfs.pod:902
2079 "Only use the handle from a single thread. Either use the handle exclusively "
2080 "from one thread, or provide your own mutex so that two threads cannot issue "
2081 "calls on the same handle at the same time."
2086 #: ../src/guestfs.pod:906
2088 "See the graphical program guestfs-browser for one possible architecture for "
2089 "multithreaded programs using libvirt and libguestfs."
2094 #: ../src/guestfs.pod:909
2099 #: ../src/guestfs.pod:911
2101 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2107 #: ../src/guestfs.pod:914
2109 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2110 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2115 #: ../src/guestfs.pod:917
2117 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2118 "to change the directories that libguestfs will search in. The value is a "
2119 "colon-separated list of paths. The current directory is I<not> searched "
2120 "unless the path contains an empty element or C<.>. For example "
2121 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2122 "then C</usr/lib/guestfs>."
2127 #: ../src/guestfs.pod:924
2128 msgid "QEMU WRAPPERS"
2133 #: ../src/guestfs.pod:926
2135 "If you want to compile your own qemu, run qemu from a non-standard location, "
2136 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2142 #: ../src/guestfs.pod:930
2144 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2145 "last command in the shell script (so that qemu replaces the shell and "
2146 "becomes the direct child of the libguestfs-using program). If you don't do "
2147 "this, then the qemu process won't be cleaned up correctly."
2152 #: ../src/guestfs.pod:935
2154 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2160 #: ../src/guestfs.pod:938
2164 " qemudir=/home/rjones/d/qemu\n"
2165 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2171 #: ../src/guestfs.pod:942
2173 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2174 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2180 #: ../src/guestfs.pod:946
2183 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2189 #: ../src/guestfs.pod:948
2191 "Note that libguestfs also calls qemu with the -help and -version options in "
2192 "order to determine features."
2196 #: ../src/guestfs.pod:951
2197 msgid "ATTACHING TO RUNNING DAEMONS"
2201 #: ../src/guestfs.pod:953
2203 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2204 "babies. Use with caution."
2208 #: ../src/guestfs.pod:956
2210 "I<Note (2):> This section explains how to attach to a running daemon from a "
2211 "low level perspective. For most users, simply using virt tools such as "
2212 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2216 #: ../src/guestfs.pod:960
2217 msgid "Using guestfs_set_attach_method"
2221 #: ../src/guestfs.pod:962
2223 "By calling L</guestfs_set_attach_method> you can change how the library "
2224 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2225 "ARCHITECTURE> for some background)."
2229 #: ../src/guestfs.pod:966
2231 "The normal attach method is C<appliance>, where a small appliance is created "
2232 "containing the daemon, and then the library connects to this."
2236 #: ../src/guestfs.pod:969
2238 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2239 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2240 "daemon over the Unix domain socket."
2244 #: ../src/guestfs.pod:973
2246 "The normal use for this is to connect to a running virtual machine that "
2247 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2248 "files inside the live virtual machine."
2252 #: ../src/guestfs.pod:977
2253 msgid "Using guestfs_add_domain with live flag"
2257 #: ../src/guestfs.pod:979
2259 "L</guestfs_add_domain> provides some help for getting the correct attach "
2260 "method. If you pass the C<live> option to this function, then (if the "
2261 "virtual machine is running) it will examine the libvirt XML looking for a "
2262 "virtio-serial channel to connect to:"
2266 #: ../src/guestfs.pod:985
2273 " <channel type='unix'>\n"
2274 " <source mode='bind' path='/path/to/socket'/>\n"
2275 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2284 #: ../src/guestfs.pod:997
2286 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2287 "method to C<unix:/path/to/socket>."
2291 #: ../src/guestfs.pod:1000
2293 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2294 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2295 "to attach to and modify live virtual machines."
2299 #: ../src/guestfs.pod:1004
2301 "The virtual machine needs to have been set up beforehand so that it has the "
2302 "virtio-serial channel and so that guestfsd is running inside it."
2307 #: ../src/guestfs.pod:1008
2308 msgid "ABI GUARANTEE"
2313 #: ../src/guestfs.pod:1010
2315 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2316 "actions as outlined in this section. Although we will deprecate some "
2317 "actions, for example if they get replaced by newer calls, we will keep the "
2318 "old actions forever. This allows you the developer to program in confidence "
2319 "against the libguestfs API."
2324 #: ../src/guestfs.pod:1016
2325 msgid "BLOCK DEVICE NAMING"
2330 #: ../src/guestfs.pod:1018
2332 "In the kernel there is now quite a profusion of schemata for naming block "
2333 "devices (in this context, by I<block device> I mean a physical or virtual "
2334 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2335 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2336 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2337 "for the old IDE driver (particularly for SATA devices) those devices also "
2338 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2339 "paravirtualized drivers. This has created several different naming systems, "
2340 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2345 #: ../src/guestfs.pod:1030
2347 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2348 "Linux kernel to access block devices. We can run a variety of appliances "
2349 "based on a variety of Linux kernels."
2354 #: ../src/guestfs.pod:1034
2356 "This causes a problem for libguestfs because many API calls use device or "
2357 "partition names. Working scripts and the recipe (example) scripts that we "
2358 "make available over the internet could fail if the naming scheme changes."
2363 #: ../src/guestfs.pod:1039
2365 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2366 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2367 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2368 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2373 #: ../src/guestfs.pod:1045
2375 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2376 "L</guestfs_list_partitions> and similar calls return the true names of the "
2377 "devices and partitions as known to the appliance."
2382 #: ../src/guestfs.pod:1050
2383 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2388 #: ../src/guestfs.pod:1052
2390 "Usually this translation is transparent. However in some (very rare) cases "
2391 "you may need to know the exact algorithm. Such cases include where you use "
2392 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2393 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2398 #: ../src/guestfs.pod:1058
2400 "The algorithm is applied only to I<parameters> which are known to be either "
2401 "device or partition names. Return values from functions such as L</"
2402 "guestfs_list_devices> are never changed."
2407 #: ../src/guestfs.pod:1066
2408 msgid "Is the string a parameter which is a device or partition name?"
2413 #: ../src/guestfs.pod:1070
2414 msgid "Does the string begin with C</dev/sd>?"
2419 #: ../src/guestfs.pod:1074
2421 "Does the named device exist? If so, we use that device. However if I<not> "
2422 "then we continue with this algorithm."
2427 #: ../src/guestfs.pod:1079
2428 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2433 #: ../src/guestfs.pod:1081
2434 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2439 #: ../src/guestfs.pod:1083
2440 msgid "If that named device exists, use it. If not, continue."
2445 #: ../src/guestfs.pod:1087
2446 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2451 #: ../src/guestfs.pod:1089
2452 msgid "If that named device exists, use it. If not, return an error."
2457 #: ../src/guestfs.pod:1093
2458 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2463 #: ../src/guestfs.pod:1095
2465 "Although the standard naming scheme and automatic translation is useful for "
2466 "simple programs and guestfish scripts, for larger programs it is best not to "
2467 "rely on this mechanism."
2472 #: ../src/guestfs.pod:1099
2474 "Where possible for maximum future portability programs using libguestfs "
2475 "should use these future-proof techniques:"
2480 #: ../src/guestfs.pod:1106
2482 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2483 "device names, and then use those names directly."
2488 #: ../src/guestfs.pod:1109
2490 "Since those device names exist by definition, they will never be translated."
2495 #: ../src/guestfs.pod:1114
2497 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2498 "filesystem labels."
2503 #: ../src/guestfs.pod:1119
2509 #: ../src/guestfs.pod:1121
2511 "This section discusses security implications of using libguestfs, "
2512 "particularly with untrusted or malicious guests or disk images."
2517 #: ../src/guestfs.pod:1124
2518 msgid "GENERAL SECURITY CONSIDERATIONS"
2523 #: ../src/guestfs.pod:1126
2525 "Be careful with any files or data that you download from a guest (by "
2526 "\"download\" we mean not just the L</guestfs_download> command but any "
2527 "command that reads files, filenames, directories or anything else from a "
2528 "disk image). An attacker could manipulate the data to fool your program "
2529 "into doing the wrong thing. Consider cases such as:"
2534 #: ../src/guestfs.pod:1136
2535 msgid "the data (file etc) not being present"
2540 #: ../src/guestfs.pod:1140
2541 msgid "being present but empty"
2546 #: ../src/guestfs.pod:1144
2547 msgid "being much larger than normal"
2552 #: ../src/guestfs.pod:1148
2553 msgid "containing arbitrary 8 bit data"
2558 #: ../src/guestfs.pod:1152
2559 msgid "being in an unexpected character encoding"
2564 #: ../src/guestfs.pod:1156
2565 msgid "containing homoglyphs."
2570 #: ../src/guestfs.pod:1160
2571 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2576 #: ../src/guestfs.pod:1162
2578 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2579 "(VFS) module can sometimes be escalated into exploits by deliberately "
2580 "creating a malicious, malformed filesystem. These exploits are very severe "
2581 "for two reasons. Firstly there are very many filesystem drivers in the "
2582 "kernel, and many of them are infrequently used and not much developer "
2583 "attention has been paid to the code. Linux userspace helps potential "
2584 "crackers by detecting the filesystem type and automatically choosing the "
2585 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2586 "the administrator. Secondly, a kernel-level exploit is like a local root "
2587 "exploit (worse in some ways), giving immediate and total access to the "
2588 "system right down to the hardware level."
2593 #: ../src/guestfs.pod:1175
2595 "That explains why you should never mount a filesystem from an untrusted "
2596 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2597 "inside a qemu virtual machine, usually running as a non-root user. The "
2598 "attacker would need to write a filesystem which first exploited the kernel, "
2599 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2600 "the libguestfs protocol, and finally to be as serious as the host kernel "
2601 "exploit it would need to escalate its privileges to root. This multi-step "
2602 "escalation, performed by a static piece of data, is thought to be extremely "
2603 "hard to do, although we never say 'never' about security issues."
2608 #: ../src/guestfs.pod:1186
2610 "In any case callers can reduce the attack surface by forcing the filesystem "
2611 "type when mounting (use L</guestfs_mount_vfs>)."
2616 #: ../src/guestfs.pod:1189
2617 msgid "PROTOCOL SECURITY"
2622 #: ../src/guestfs.pod:1191
2624 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2625 "defined upper message size. However a program that uses libguestfs must "
2626 "also take care - for example you can write a program that downloads a binary "
2627 "from a disk image and executes it locally, and no amount of protocol "
2628 "security will save you from the consequences."
2633 #: ../src/guestfs.pod:1197
2634 msgid "INSPECTION SECURITY"
2639 #: ../src/guestfs.pod:1199
2641 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2642 "directly from the guest, and these could contain any 8 bit data. Callers "
2643 "should be careful to escape these before printing them to a structured file "
2644 "(for example, use HTML escaping if creating a web page)."
2649 #: ../src/guestfs.pod:1205
2651 "Guest configuration may be altered in unusual ways by the administrator of "
2652 "the virtual machine, and may not reflect reality (particularly for untrusted "
2653 "or actively malicious guests). For example we parse the hostname from "
2654 "configuration files like C</etc/sysconfig/network> that we find in the "
2655 "guest, but the guest administrator can easily manipulate these files to "
2656 "provide the wrong hostname."
2661 #: ../src/guestfs.pod:1213
2663 "The inspection API parses guest configuration using two external libraries: "
2664 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2665 "designed to be robust in the face of malicious data, although denial of "
2666 "service attacks are still possible, for example with oversized configuration "
2672 #: ../src/guestfs.pod:1219
2673 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2678 #: ../src/guestfs.pod:1221
2680 "Be very cautious about running commands from the guest. By running a "
2681 "command in the guest, you are giving CPU time to a binary that you do not "
2682 "control, under the same user account as the library, albeit wrapped in qemu "
2683 "virtualization. More information and alternatives can be found in the "
2684 "section L</RUNNING COMMANDS>."
2689 #: ../src/guestfs.pod:1227
2690 msgid "CVE-2010-3851"
2695 #: ../src/guestfs.pod:1229
2696 msgid "https://bugzilla.redhat.com/642934"
2701 #: ../src/guestfs.pod:1231
2703 "This security bug concerns the automatic disk format detection that qemu "
2704 "does on disk images."
2709 #: ../src/guestfs.pod:1234
2711 "A raw disk image is just the raw bytes, there is no header. Other disk "
2712 "images like qcow2 contain a special header. Qemu deals with this by looking "
2713 "for one of the known headers, and if none is found then assuming the disk "
2714 "image must be raw."
2719 #: ../src/guestfs.pod:1239
2721 "This allows a guest which has been given a raw disk image to write some "
2722 "other header. At next boot (or when the disk image is accessed by "
2723 "libguestfs) qemu would do autodetection and think the disk image format was, "
2724 "say, qcow2 based on the header written by the guest."
2729 #: ../src/guestfs.pod:1244
2731 "This in itself would not be a problem, but qcow2 offers many features, one "
2732 "of which is to allow a disk image to refer to another image (called the "
2733 "\"backing disk\"). It does this by placing the path to the backing disk "
2734 "into the qcow2 header. This path is not validated and could point to any "
2735 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2736 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2737 "control of the attacker."
2742 #: ../src/guestfs.pod:1252
2744 "In libguestfs this is rather hard to exploit except under two circumstances:"
2749 #: ../src/guestfs.pod:1259
2750 msgid "You have enabled the network or have opened the disk in write mode."
2755 #: ../src/guestfs.pod:1263
2757 "You are also running untrusted code from the guest (see L</RUNNING "
2763 #: ../src/guestfs.pod:1268
2765 "The way to avoid this is to specify the expected disk format when adding "
2766 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2767 "should always do this if the disk is raw format, and it's a good idea for "
2773 #: ../src/guestfs.pod:1273
2775 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2776 "format is fetched from libvirt and passed through."
2781 #: ../src/guestfs.pod:1276
2783 "For libguestfs tools, use the I<--format> command line parameter as "
2789 #: ../src/guestfs.pod:1279
2790 msgid "CONNECTION MANAGEMENT"
2795 #: ../src/guestfs.pod:1281
2801 #: ../src/guestfs.pod:1283
2803 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2804 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2805 "handle and release all resources used."
2809 #: ../src/guestfs.pod:1287
2811 "For information on using multiple handles and threads, see the section L</"
2812 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2817 #: ../src/guestfs.pod:1290
2818 msgid "guestfs_create"
2823 #: ../src/guestfs.pod:1292
2826 " guestfs_h *guestfs_create (void);\n"
2832 #: ../src/guestfs.pod:1294
2833 msgid "Create a connection handle."
2837 #: ../src/guestfs.pod:1296
2839 "On success this returns a non-NULL pointer to a handle. On error it returns "
2844 #: ../src/guestfs.pod:1299
2846 "You have to \"configure\" the handle after creating it. This includes "
2847 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2848 "handle at least once."
2853 #: ../src/guestfs.pod:1303
2854 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2858 #: ../src/guestfs.pod:1305
2860 "You may also want to configure error handling for the handle. See the L</"
2861 "ERROR HANDLING> section below."
2866 #: ../src/guestfs.pod:1308
2867 msgid "guestfs_close"
2872 #: ../src/guestfs.pod:1310
2875 " void guestfs_close (guestfs_h *g);\n"
2881 #: ../src/guestfs.pod:1312
2882 msgid "This closes the connection handle and frees up all resources used."
2886 #: ../src/guestfs.pod:1314
2888 "If autosync was set on the handle and the handle was launched, then this "
2889 "implicitly calls various functions to unmount filesystems and sync the "
2890 "disk. See L</guestfs_set_autosync> for more details."
2894 #: ../src/guestfs.pod:1318
2895 msgid "If a close callback was set on the handle, then it is called."
2900 #: ../src/guestfs.pod:1320
2901 msgid "ERROR HANDLING"
2906 #: ../src/guestfs.pod:1322
2908 "API functions can return errors. For example, almost all functions that "
2909 "return C<int> will return C<-1> to indicate an error."
2914 #: ../src/guestfs.pod:1325
2916 "Additional information is available for errors: an error message string and "
2917 "optionally an error number (errno) if the thing that failed was a system "
2923 #: ../src/guestfs.pod:1329
2925 "You can get at the additional information about the last error on the handle "
2926 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2927 "up an error handler with L</guestfs_set_error_handler>."
2932 #: ../src/guestfs.pod:1334
2934 "When the handle is created, a default error handler is installed which "
2935 "prints the error message string to C<stderr>. For small short-running "
2936 "command line programs it is sufficient to do:"
2941 #: ../src/guestfs.pod:1338
2944 " if (guestfs_launch (g) == -1)\n"
2945 " exit (EXIT_FAILURE);\n"
2951 #: ../src/guestfs.pod:1341
2953 "since the default error handler will ensure that an error message has been "
2954 "printed to C<stderr> before the program exits."
2959 #: ../src/guestfs.pod:1344
2961 "For other programs the caller will almost certainly want to install an "
2962 "alternate error handler or do error handling in-line like this:"
2967 #: ../src/guestfs.pod:1347
2970 " g = guestfs_create ();\n"
2976 #: ../src/guestfs.pod:1349
2979 " /* This disables the default behaviour of printing errors\n"
2981 " guestfs_set_error_handler (g, NULL, NULL);\n"
2987 #: ../src/guestfs.pod:1353
2990 " if (guestfs_launch (g) == -1) {\n"
2991 " /* Examine the error message and print it etc. */\n"
2992 " char *msg = guestfs_last_error (g);\n"
2993 " int errnum = guestfs_last_errno (g);\n"
2994 " fprintf (stderr, \"%s\\n\", msg);\n"
3002 #: ../src/guestfs.pod:1361
3004 "Out of memory errors are handled differently. The default action is to call "
3005 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3006 "guestfs_set_out_of_memory_handler>."
3011 #: ../src/guestfs.pod:1365
3013 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3014 "because there is no handle if this happens there is no way to get additional "
3015 "error information. However L</guestfs_create> is supposed to be a "
3016 "lightweight operation which can only fail because of insufficient memory (it "
3017 "returns NULL in this case)."
3022 #: ../src/guestfs.pod:1371
3023 msgid "guestfs_last_error"
3028 #: ../src/guestfs.pod:1373
3031 " const char *guestfs_last_error (guestfs_h *g);\n"
3037 #: ../src/guestfs.pod:1375
3039 "This returns the last error message that happened on C<g>. If there has not "
3040 "been an error since the handle was created, then this returns C<NULL>."
3045 #: ../src/guestfs.pod:1379
3047 "The lifetime of the returned string is until the next error occurs, or L</"
3048 "guestfs_close> is called."
3053 #: ../src/guestfs.pod:1382
3054 msgid "guestfs_last_errno"
3059 #: ../src/guestfs.pod:1384
3062 " int guestfs_last_errno (guestfs_h *g);\n"
3068 #: ../src/guestfs.pod:1386
3069 msgid "This returns the last error number (errno) that happened on C<g>."
3074 #: ../src/guestfs.pod:1388
3075 msgid "If successful, an errno integer not equal to zero is returned."
3080 #: ../src/guestfs.pod:1390
3082 "If no error, this returns 0. This call can return 0 in three situations:"
3087 #: ../src/guestfs.pod:1397
3088 msgid "There has not been any error on the handle."
3093 #: ../src/guestfs.pod:1401
3095 "There has been an error but the errno was meaningless. This corresponds to "
3096 "the case where the error did not come from a failed system call, but for "
3097 "some other reason."
3102 #: ../src/guestfs.pod:1407
3104 "There was an error from a failed system call, but for some reason the errno "
3105 "was not captured and returned. This usually indicates a bug in libguestfs."
3110 #: ../src/guestfs.pod:1413
3112 "Libguestfs tries to convert the errno from inside the applicance into a "
3113 "corresponding errno for the caller (not entirely trivial: the appliance "
3114 "might be running a completely different operating system from the library "
3115 "and error numbers are not standardized across Un*xen). If this could not be "
3116 "done, then the error is translated to C<EINVAL>. In practice this should "
3117 "only happen in very rare circumstances."
3122 #: ../src/guestfs.pod:1421
3123 msgid "guestfs_set_error_handler"
3128 #: ../src/guestfs.pod:1423
3131 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3133 " const char *msg);\n"
3134 " void guestfs_set_error_handler (guestfs_h *g,\n"
3135 " guestfs_error_handler_cb cb,\n"
3142 #: ../src/guestfs.pod:1430
3144 "The callback C<cb> will be called if there is an error. The parameters "
3145 "passed to the callback are an opaque data pointer and the error message "
3151 #: ../src/guestfs.pod:1434
3153 "C<errno> is not passed to the callback. To get that the callback must call "
3154 "L</guestfs_last_errno>."
3159 #: ../src/guestfs.pod:1437
3161 "Note that the message string C<msg> is freed as soon as the callback "
3162 "function returns, so if you want to stash it somewhere you must make your "
3168 #: ../src/guestfs.pod:1441
3169 msgid "The default handler prints messages on C<stderr>."
3174 #: ../src/guestfs.pod:1443
3175 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3180 #: ../src/guestfs.pod:1445
3181 msgid "guestfs_get_error_handler"
3186 #: ../src/guestfs.pod:1447
3189 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3190 " void **opaque_rtn);\n"
3196 #: ../src/guestfs.pod:1450
3197 msgid "Returns the current error handler callback."
3202 #: ../src/guestfs.pod:1452
3203 msgid "guestfs_set_out_of_memory_handler"
3208 #: ../src/guestfs.pod:1454
3211 " typedef void (*guestfs_abort_cb) (void);\n"
3212 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3213 " guestfs_abort_cb);\n"
3219 #: ../src/guestfs.pod:1458
3221 "The callback C<cb> will be called if there is an out of memory situation. "
3222 "I<Note this callback must not return>."
3227 #: ../src/guestfs.pod:1461
3228 msgid "The default is to call L<abort(3)>."
3233 #: ../src/guestfs.pod:1463
3235 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3240 #: ../src/guestfs.pod:1466
3241 msgid "guestfs_get_out_of_memory_handler"
3246 #: ../src/guestfs.pod:1468
3249 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3255 #: ../src/guestfs.pod:1470
3256 msgid "This returns the current out of memory handler."
3261 #: ../src/guestfs.pod:1472
3267 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1008
3273 #: ../src/guestfs.pod:1476
3279 #: ../src/guestfs.pod:1478
3285 #: ../src/guestfs.pod:1480
3286 msgid "AVAILABILITY"
3291 #: ../src/guestfs.pod:1482
3292 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3297 #: ../src/guestfs.pod:1484
3299 "Using L</guestfs_available> you can test availability of the following "
3300 "groups of functions. This test queries the appliance to see if the "
3301 "appliance you are currently using supports the functionality."
3306 #: ../src/guestfs.pod:1489
3307 msgid "@AVAILABILITY@"
3312 #: ../src/guestfs.pod:1491
3313 msgid "GUESTFISH supported COMMAND"
3318 #: ../src/guestfs.pod:1493
3320 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3321 "prints out the available groups and whether they are supported by this build "
3322 "of libguestfs. Note however that you have to do C<run> first."
3327 #: ../src/guestfs.pod:1498
3328 msgid "SINGLE CALLS AT COMPILE TIME"
3333 #: ../src/guestfs.pod:1500
3335 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3336 "function, such as:"
3341 #: ../src/guestfs.pod:1503
3344 " #define LIBGUESTFS_HAVE_DD 1\n"
3350 #: ../src/guestfs.pod:1505
3351 msgid "if L</guestfs_dd> is available."
3356 #: ../src/guestfs.pod:1507
3358 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3359 "function is available at compile time, we recommended using build tools such "
3360 "as autoconf or cmake. For example in autotools you could use:"
3365 #: ../src/guestfs.pod:1512
3368 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3369 " AC_CHECK_FUNCS([guestfs_dd])\n"
3375 #: ../src/guestfs.pod:1515
3377 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3383 #: ../src/guestfs.pod:1518
3384 msgid "SINGLE CALLS AT RUN TIME"
3389 #: ../src/guestfs.pod:1520
3391 "Testing at compile time doesn't guarantee that a function really exists in "
3392 "the library. The reason is that you might be dynamically linked against a "
3393 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3394 "This situation unfortunately results in a segmentation fault, which is a "
3395 "shortcoming of the C dynamic linking system itself."
3400 #: ../src/guestfs.pod:1527
3402 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3403 "in this example program (note that you still need the compile time check as "
3409 #: ../src/guestfs.pod:1531
3412 " #include <stdio.h>\n"
3413 " #include <stdlib.h>\n"
3414 " #include <unistd.h>\n"
3415 " #include <dlfcn.h>\n"
3416 " #include <guestfs.h>\n"
3422 #: ../src/guestfs.pod:1537
3427 " #ifdef LIBGUESTFS_HAVE_DD\n"
3429 " int has_function;\n"
3435 #: ../src/guestfs.pod:1543
3438 " /* Test if the function guestfs_dd is really available. */\n"
3439 " dl = dlopen (NULL, RTLD_LAZY);\n"
3441 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3442 " exit (EXIT_FAILURE);\n"
3444 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3451 #: ../src/guestfs.pod:1552
3454 " if (!has_function)\n"
3455 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3457 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3458 " /* Now it's safe to call\n"
3459 " guestfs_dd (g, \"foo\", \"bar\");\n"
3463 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3471 #: ../src/guestfs.pod:1565
3473 "You may think the above is an awful lot of hassle, and it is. There are "
3474 "other ways outside of the C linking system to ensure that this kind of "
3475 "incompatibility never arises, such as using package versioning:"
3480 #: ../src/guestfs.pod:1570
3483 " Requires: libguestfs >= 1.0.80\n"
3489 #: ../src/guestfs.pod:1572
3490 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3495 #: ../src/guestfs.pod:1574
3497 "A recent feature of the API is the introduction of calls which take optional "
3498 "arguments. In C these are declared 3 ways. The main way is as a call which "
3499 "takes variable arguments (ie. C<...>), as in this example:"
3504 #: ../src/guestfs.pod:1579
3507 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3513 #: ../src/guestfs.pod:1581
3515 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3516 "call with no optional arguments specified:"
3521 #: ../src/guestfs.pod:1584
3524 " guestfs_add_drive_opts (g, filename, -1);\n"
3530 #: ../src/guestfs.pod:1586
3531 msgid "With a single optional argument:"
3536 #: ../src/guestfs.pod:1588
3539 " guestfs_add_drive_opts (g, filename,\n"
3540 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3547 #: ../src/guestfs.pod:1592
3553 #: ../src/guestfs.pod:1594
3556 " guestfs_add_drive_opts (g, filename,\n"
3557 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3558 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3565 #: ../src/guestfs.pod:1599
3567 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3573 #: ../src/guestfs.pod:1602
3574 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3579 #: ../src/guestfs.pod:1604
3581 "The second variant has the same name with the suffix C<_va>, which works the "
3582 "same way but takes a C<va_list>. See the C manual for details. For the "
3583 "example function, this is declared:"
3588 #: ../src/guestfs.pod:1608
3591 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3598 #: ../src/guestfs.pod:1611
3599 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3604 #: ../src/guestfs.pod:1613
3606 "The third variant is useful where you need to construct these calls. You "
3607 "pass in a structure where you fill in the optional fields. The structure "
3608 "has a bitmask as the first element which you must set to indicate which "
3609 "fields you have filled in. For our example function the structure and call "
3615 #: ../src/guestfs.pod:1619
3618 " struct guestfs_add_drive_opts_argv {\n"
3619 " uint64_t bitmask;\n"
3621 " const char *format;\n"
3624 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3625 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3631 #: ../src/guestfs.pod:1628
3632 msgid "You could call it like this:"
3637 #: ../src/guestfs.pod:1630
3640 " struct guestfs_add_drive_opts_argv optargs = {\n"
3641 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3642 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3644 " .format = \"qcow2\"\n"
3651 #: ../src/guestfs.pod:1637
3654 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3660 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3661 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:9
3662 #: ../fish/guestfish-actions.pod:1257 ../tools/virt-win-reg.pl:532
3668 #: ../src/guestfs.pod:1645
3669 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3674 #: ../src/guestfs.pod:1650
3675 msgid "You do not need to fill in all fields of the structure."
3680 #: ../src/guestfs.pod:1654
3682 "There must be a one-to-one correspondence between fields of the structure "
3683 "that are filled in, and bits set in the bitmask."
3688 #: ../src/guestfs.pod:1659
3689 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3694 #: ../src/guestfs.pod:1661
3696 "In other languages, optional arguments are expressed in the way that is "
3697 "natural for that language. We refer you to the language-specific "
3698 "documentation for more details on that."
3703 #: ../src/guestfs.pod:1665
3704 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3709 #: ../src/guestfs.pod:1667
3710 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3714 #: ../src/guestfs.pod:1669
3716 "B<Note:> This section documents the generic event mechanism introduced in "
3717 "libguestfs 1.10, which you should use in new code if possible. The old "
3718 "functions C<guestfs_set_log_message_callback>, "
3719 "C<guestfs_set_subprocess_quit_callback>, "
3720 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3721 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3726 #: ../src/guestfs.pod:1677
3728 "Handles generate events when certain things happen, such as log messages "
3729 "being generated, progress messages during long-running operations, or the "
3730 "handle being closed. The API calls described below let you register a "
3731 "callback to be called when events happen. You can register multiple "
3732 "callbacks (for the same, different or overlapping sets of events), and "
3733 "individually remove callbacks. If callbacks are not removed, then they "
3734 "remain in force until the handle is closed."
3738 #: ../src/guestfs.pod:1685
3740 "In the current implementation, events are only generated synchronously: that "
3741 "means that events (and hence callbacks) can only happen while you are in the "
3742 "middle of making another libguestfs call. The callback is called in the "
3747 #: ../src/guestfs.pod:1690
3749 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3750 "unsigned integers, or a message buffer. Payloads are discussed later on."
3754 #: ../src/guestfs.pod:1694
3755 msgid "CLASSES OF EVENTS"
3759 #: ../src/guestfs.pod:1698
3760 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3764 #: ../src/guestfs.pod:1701
3766 "The callback function will be called while the handle is being closed "
3767 "(synchronously from L</guestfs_close>)."
3772 #: ../src/guestfs.pod:1704
3774 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3775 "handles that are open when the program exits. This means that this callback "
3776 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3777 "problems in higher-level languages (eg. if your HLL interpreter has already "
3778 "been cleaned up by the time this is called, and if your callback then jumps "
3779 "into some HLL function)."
3783 #: ../src/guestfs.pod:1711
3785 "If no callback is registered: the handle is closed without any callback "
3790 #: ../src/guestfs.pod:1714
3791 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3795 #: ../src/guestfs.pod:1717
3797 "The callback function will be called when the child process quits, either "
3798 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3799 "corresponds to a transition from any state to the CONFIG state)."
3803 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3804 msgid "If no callback is registered: the event is ignored."
3808 #: ../src/guestfs.pod:1723
3809 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3813 #: ../src/guestfs.pod:1726
3815 "The callback function will be called when the child process becomes ready "
3816 "first time after it has been launched. (This corresponds to a transition "
3817 "from LAUNCHING to the READY state)."
3821 #: ../src/guestfs.pod:1732
3822 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3827 #: ../src/guestfs.pod:1735
3829 "Some long-running operations can generate progress messages. If this "
3830 "callback is registered, then it will be called each time a progress message "
3831 "is generated (usually two seconds after the operation started, and three "
3832 "times per second thereafter until it completes, although the frequency may "
3833 "change in future versions)."
3837 #: ../src/guestfs.pod:1741
3839 "The callback receives in the payload four unsigned 64 bit numbers which are "
3840 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3844 #: ../src/guestfs.pod:1744
3846 "The units of C<total> are not defined, although for some operations C<total> "
3847 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3848 "or megabytes), and C<position> may be the portion which has been transferred."
3853 #: ../src/guestfs.pod:1749
3854 msgid "The only defined and stable parts of the API are:"
3859 #: ../src/guestfs.pod:1755
3861 "The callback can display to the user some type of progress bar or indicator "
3862 "which shows the ratio of C<position>:C<total>."
3867 #: ../src/guestfs.pod:1760
3868 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3872 #: ../src/guestfs.pod:1764
3874 "If any progress notification is sent during a call, then a final progress "
3875 "notification is always sent when C<position> = C<total> (I<unless> the call "
3876 "fails with an error)."
3881 #: ../src/guestfs.pod:1768
3883 "This is to simplify caller code, so callers can easily set the progress "
3884 "indicator to \"100%\" at the end of the operation, without requiring special "
3885 "code to detect this case."
3889 #: ../src/guestfs.pod:1774
3891 "For some calls we are unable to estimate the progress of the call, but we "
3892 "can still generate progress messages to indicate activity. This is known as "
3893 "\"pulse mode\", and is directly supported by certain progress bar "
3894 "implementations (eg. GtkProgressBar)."
3898 #: ../src/guestfs.pod:1779
3900 "For these calls, zero or more progress messages are generated with "
3901 "C<position = 0> and C<total = 1>, followed by a final message with "
3902 "C<position = total = 1>."
3906 #: ../src/guestfs.pod:1783
3908 "As noted above, if the call fails with an error then the final message may "
3913 #: ../src/guestfs.pod:1788
3915 "The callback also receives the procedure number (C<proc_nr>) and serial "
3916 "number (C<serial>) of the call. These are only useful for debugging "
3917 "protocol issues, and the callback can normally ignore them. The callback "
3918 "may want to print these numbers in error messages or debugging messages."
3922 #: ../src/guestfs.pod:1794
3923 msgid "If no callback is registered: progress messages are discarded."
3927 #: ../src/guestfs.pod:1796
3928 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3932 #: ../src/guestfs.pod:1799
3934 "The callback function is called whenever a log message is generated by qemu, "
3935 "the appliance kernel, guestfsd (daemon), or utility programs."
3939 #: ../src/guestfs.pod:1802
3941 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3942 "guestfs_launch>) then additional debug messages are generated."
3946 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3948 "If no callback is registered: the messages are discarded unless the verbose "
3949 "flag is set in which case they are sent to stderr. You can override the "
3950 "printing of verbose messages to stderr by setting up a callback."
3954 #: ../src/guestfs.pod:1810
3955 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3959 #: ../src/guestfs.pod:1813
3961 "The callback function is called whenever a log message is generated by the "
3962 "library part of libguestfs."
3966 #: ../src/guestfs.pod:1816
3968 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3969 "messages are generated."
3973 #: ../src/guestfs.pod:1824
3974 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3978 #: ../src/guestfs.pod:1827
3980 "The callback function is called whenever a trace message is generated. This "
3981 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3985 #: ../src/guestfs.pod:1830
3987 "If no callback is registered: the messages are sent to stderr. You can "
3988 "override the printing of trace messages to stderr by setting up a callback."
3992 #: ../src/guestfs.pod:1836
3993 msgid "guestfs_set_event_callback"
3997 #: ../src/guestfs.pod:1838
4000 " int guestfs_set_event_callback (guestfs_h *g,\n"
4001 " guestfs_event_callback cb,\n"
4002 " uint64_t event_bitmask,\n"
4009 #: ../src/guestfs.pod:1844
4011 "This function registers a callback (C<cb>) for all event classes in the "
4016 #: ../src/guestfs.pod:1847
4018 "For example, to register for all log message events, you could call this "
4019 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4020 "To register a single callback for all possible classes of events, use "
4021 "C<GUESTFS_EVENT_ALL>."
4025 #: ../src/guestfs.pod:1853
4026 msgid "C<flags> should always be passed as 0."
4030 #: ../src/guestfs.pod:1855
4032 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4033 "it for any purpose."
4037 #: ../src/guestfs.pod:1858
4039 "The return value is the event handle (an integer) which you can use to "
4040 "delete the callback (see below)."
4044 #: ../src/guestfs.pod:1861
4046 "If there is an error, this function returns C<-1>, and sets the error in the "
4047 "handle in the usual way (see L</guestfs_last_error> etc.)"
4051 #: ../src/guestfs.pod:1864
4053 "Callbacks remain in effect until they are deleted, or until the handle is "
4058 #: ../src/guestfs.pod:1867
4060 "In the case where multiple callbacks are registered for a particular event "
4061 "class, all of the callbacks are called. The order in which multiple "
4062 "callbacks are called is not defined."
4066 #: ../src/guestfs.pod:1871
4067 msgid "guestfs_delete_event_callback"
4071 #: ../src/guestfs.pod:1873
4074 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4079 #: ../src/guestfs.pod:1875
4081 "Delete a callback that was previously registered. C<event_handle> should be "
4082 "the integer that was returned by a previous call to "
4083 "C<guestfs_set_event_callback> on the same handle."
4087 #: ../src/guestfs.pod:1879
4088 msgid "guestfs_event_callback"
4092 #: ../src/guestfs.pod:1881
4095 " typedef void (*guestfs_event_callback) (\n"
4098 " uint64_t event,\n"
4099 " int event_handle,\n"
4101 " const char *buf, size_t buf_len,\n"
4102 " const uint64_t *array, size_t array_len);\n"
4107 #: ../src/guestfs.pod:1890
4109 "This is the type of the event callback function that you have to provide."
4113 #: ../src/guestfs.pod:1893
4115 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4116 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4117 "handle, and C<flags> which in the current API you should ignore."
4121 #: ../src/guestfs.pod:1897
4123 "The remaining parameters contain the event payload (if any). Each event may "
4124 "contain a payload, which usually relates to the event class, but for future "
4125 "proofing your code should be written to handle any payload for any event "
4130 #: ../src/guestfs.pod:1902
4132 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4133 "there is no message buffer). Note that this message buffer can contain "
4134 "arbitrary 8 bit data, including NUL bytes."
4138 #: ../src/guestfs.pod:1906
4140 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4141 "moment this is only used for progress messages."
4145 #: ../src/guestfs.pod:1909
4146 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4150 #: ../src/guestfs.pod:1911
4152 "One motivation for the generic event API was to allow GUI programs to "
4153 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4154 "unconditionally to C<stderr>."
4158 #: ../src/guestfs.pod:1915
4160 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4161 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4162 "messages are not events; you must capture error messages separately)."
4166 #: ../src/guestfs.pod:1920
4168 "Programs have to set up a callback to capture the classes of events of "
4173 #: ../src/guestfs.pod:1923
4177 " guestfs_set_event_callback\n"
4178 " (g, message_callback,\n"
4179 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4180 " GUESTFS_EVENT_TRACE,\n"
4181 " 0, NULL) == -1)\n"
4182 " if (eh == -1) {\n"
4183 " // handle error in the usual way\n"
4189 #: ../src/guestfs.pod:1933
4191 "The callback can then direct messages to the appropriate place. In this "
4192 "example, messages are directed to syslog:"
4196 #: ../src/guestfs.pod:1936
4200 " message_callback (\n"
4203 " uint64_t event,\n"
4204 " int event_handle,\n"
4206 " const char *buf, size_t buf_len,\n"
4207 " const uint64_t *array, size_t array_len)\n"
4209 " const int priority = LOG_USER|LOG_INFO;\n"
4210 " if (buf_len > 0)\n"
4211 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4218 #: ../src/guestfs.pod:1951
4219 msgid "PRIVATE DATA AREA"
4223 #: ../src/guestfs.pod:1953
4225 "You can attach named pieces of private data to the libguestfs handle, fetch "
4226 "them by name, and walk over them, for the lifetime of the handle. This is "
4227 "called the private data area and is only available from the C API."
4232 #: ../src/guestfs.pod:1958
4233 msgid "To attach a named piece of data, use the following call:"
4238 #: ../src/guestfs.pod:1960
4241 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4246 #: ../src/guestfs.pod:1962
4248 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4249 "pointer (which can be C<NULL>). Any previous item with the same key is "
4254 #: ../src/guestfs.pod:1966
4256 "You can use any C<key> you want, but your key should I<not> start with an "
4257 "underscore character. Keys beginning with an underscore character are "
4258 "reserved for internal libguestfs purposes (eg. for implementing language "
4259 "bindings). It is recommended that you prefix the key with some unique "
4260 "string to avoid collisions with other users."
4265 #: ../src/guestfs.pod:1972
4266 msgid "To retrieve the pointer, use:"
4271 #: ../src/guestfs.pod:1974
4274 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4280 #: ../src/guestfs.pod:1976
4282 "This function returns C<NULL> if either no data is found associated with "
4283 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4288 #: ../src/guestfs.pod:1980
4290 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4291 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4292 "all. In particular, libguestfs does I<not> try to free the data when the "
4293 "handle is closed. If the data must be freed, then the caller must either "
4294 "free it before calling L</guestfs_close> or must set up a close callback to "
4295 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4299 #: ../src/guestfs.pod:1987
4300 msgid "To walk over all entries, use these two functions:"
4304 #: ../src/guestfs.pod:1989
4307 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4312 #: ../src/guestfs.pod:1991
4315 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4320 #: ../src/guestfs.pod:1993
4322 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4323 "not have any particular meaning -- keys are not returned in any defined "
4324 "order). A pointer to the key is returned in C<*key_rtn> and the "
4325 "corresponding data pointer is returned from the function. C<NULL> is "
4326 "returned if there are no keys stored in the handle."
4330 #: ../src/guestfs.pod:1999
4332 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4333 "value of this function is also C<NULL> is there are no further entries to "
4338 #: ../src/guestfs.pod:2003
4339 msgid "Notes about walking over entries:"
4343 #: ../src/guestfs.pod:2009
4345 "You must not call C<guestfs_set_private> while walking over the entries."
4349 #: ../src/guestfs.pod:2014
4351 "The handle maintains an internal iterator which is reset when you call "
4352 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4353 "call C<guestfs_set_private>."
4357 #: ../src/guestfs.pod:2020
4358 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4362 #: ../src/guestfs.pod:2022
4365 " guestfs_set_private (g, key, NULL);\n"
4370 #: ../src/guestfs.pod:2024
4371 msgid "then that C<key> is not returned when walking."
4375 #: ../src/guestfs.pod:2028
4377 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4378 "C<guestfs_next_private> or C<guestfs_set_private>."
4382 #: ../src/guestfs.pod:2034
4384 "The following example code shows how to print all keys and data pointers "
4385 "that are associated with the handle C<g>:"
4389 #: ../src/guestfs.pod:2037
4392 " const char *key;\n"
4393 " void *data = guestfs_first_private (g, &key);\n"
4394 " while (data != NULL)\n"
4396 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4397 " data = guestfs_next_private (g, &key);\n"
4403 #: ../src/guestfs.pod:2045
4405 "More commonly you are only interested in keys that begin with an application-"
4406 "specific prefix C<foo_>. Modify the loop like so:"
4410 #: ../src/guestfs.pod:2048
4413 " const char *key;\n"
4414 " void *data = guestfs_first_private (g, &key);\n"
4415 " while (data != NULL)\n"
4417 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4418 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4419 " data = guestfs_next_private (g, &key);\n"
4425 #: ../src/guestfs.pod:2057
4427 "If you need to modify keys while walking, then you have to jump back to the "
4428 "beginning of the loop. For example, to delete all keys prefixed with "
4433 #: ../src/guestfs.pod:2061
4436 " const char *key;\n"
4439 " data = guestfs_first_private (g, &key);\n"
4440 " while (data != NULL)\n"
4442 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4444 " guestfs_set_private (g, key, NULL);\n"
4445 " /* note that 'key' pointer is now invalid, and so is\n"
4446 " the internal iterator */\n"
4449 " data = guestfs_next_private (g, &key);\n"
4455 #: ../src/guestfs.pod:2077
4457 "Note that the above loop is guaranteed to terminate because the keys are "
4458 "being deleted, but other manipulations of keys within the loop might not "
4459 "terminate unless you also maintain an indication of which keys have been "
4465 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4471 #: ../src/guestfs.pod:2084
4473 "<!-- old anchor for the next section --> <a name="
4474 "\"state_machine_and_low_level_event_api\"/>"
4479 #: ../src/guestfs.pod:2089
4480 msgid "ARCHITECTURE"
4485 #: ../src/guestfs.pod:2091
4487 "Internally, libguestfs is implemented by running an appliance (a special "
4488 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4489 "process of the main program."
4494 #: ../src/guestfs.pod:2095
4497 " ___________________\n"
4499 " | main program |\n"
4501 " | | child process / appliance\n"
4502 " | | __________________________\n"
4504 " +-------------------+ RPC | +-----------------+ |\n"
4505 " | libguestfs <--------------------> guestfsd | |\n"
4506 " | | | +-----------------+ |\n"
4507 " \\___________________/ | | Linux kernel | |\n"
4508 " | +--^--------------+ |\n"
4509 " \\_________|________________/\n"
4515 " \\______________/\n"
4521 #: ../src/guestfs.pod:2115
4523 "The library, linked to the main program, creates the child process and hence "
4524 "the appliance in the L</guestfs_launch> function."
4529 #: ../src/guestfs.pod:2118
4531 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4532 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4533 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4534 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4535 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4536 "attached to the qemu process which translates device access by the "
4537 "appliance's Linux kernel into accesses to the image."
4542 #: ../src/guestfs.pod:2127
4544 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4545 "Although the disk image you are attached to might also be used by some "
4546 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4547 "care if both libguestfs's qemu process and your virtual machine are trying "
4548 "to update the disk image at the same time, since these usually results in "
4549 "massive disk corruption)."
4554 #: ../src/guestfs.pod:2134
4555 msgid "STATE MACHINE"
4560 #: ../src/guestfs.pod:2136
4561 msgid "libguestfs uses a state machine to model the child process:"
4566 #: ../src/guestfs.pod:2138
4578 " / | \\ \\ guestfs_launch\n"
4579 " / | _\\__V______\n"
4581 " / | | LAUNCHING |\n"
4582 " / | \\___________/\n"
4584 " / | guestfs_launch\n"
4586 " ______ / __|____V\n"
4587 " / \\ ------> / \\\n"
4588 " | BUSY | | READY |\n"
4589 " \\______/ <------ \\________/\n"
4595 #: ../src/guestfs.pod:2160
4597 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4598 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4599 "(3) alternating between READY and BUSY as commands are issued to, and "
4600 "carried out by, the child process."
4605 #: ../src/guestfs.pod:2165
4607 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4608 "asynchronously at any time (eg. due to some internal error), and that causes "
4609 "the state to transition back to CONFIG."
4614 #: ../src/guestfs.pod:2169
4616 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4617 "issued when in the CONFIG state."
4622 #: ../src/guestfs.pod:2172
4624 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4625 "L</guestfs_launch> blocks until the child process is READY to accept "
4626 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4627 "moves the state from CONFIG to LAUNCHING while it is running."
4632 #: ../src/guestfs.pod:2178
4634 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4635 "state. These API calls block waiting for the command to be carried out (ie. "
4636 "the state to transition to BUSY and then back to READY). There are no non-"
4637 "blocking versions, and no way to issue more than one command per handle at "
4643 #: ../src/guestfs.pod:2184
4645 "Finally, the child process sends asynchronous messages back to the main "
4646 "program, such as kernel log messages. You can register a callback to "
4647 "receive these messages."
4652 #: ../src/guestfs.pod:2188
4658 #: ../src/guestfs.pod:2190
4659 msgid "COMMUNICATION PROTOCOL"
4664 #: ../src/guestfs.pod:2192
4666 "Don't rely on using this protocol directly. This section documents how it "
4667 "currently works, but it may change at any time."
4672 #: ../src/guestfs.pod:2195
4674 "The protocol used to talk between the library and the daemon running inside "
4675 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4676 "1014, RFC 1832, RFC 4506)."
4681 #: ../src/guestfs.pod:2199
4683 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4684 "this file is automatically generated)."
4689 #: ../src/guestfs.pod:2202
4691 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4692 "and C<FileOut> parameters, which are handled with very simple request/reply "
4693 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4694 "parameters, which use the same request and reply messages, but they may also "
4695 "be followed by files sent using a chunked encoding."
4700 #: ../src/guestfs.pod:2209
4701 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4706 #: ../src/guestfs.pod:2211
4707 msgid "For ordinary functions, the request message is:"
4712 #: ../src/guestfs.pod:2213
4715 " total length (header + arguments,\n"
4716 " but not including the length word itself)\n"
4717 " struct guestfs_message_header (encoded as XDR)\n"
4718 " struct guestfs_<foo>_args (encoded as XDR)\n"
4724 #: ../src/guestfs.pod:2218
4726 "The total length field allows the daemon to allocate a fixed size buffer "
4727 "into which it slurps the rest of the message. As a result, the total length "
4728 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4729 "effective size of any request is limited to somewhere under this size."
4734 #: ../src/guestfs.pod:2224
4736 "Note also that many functions don't take any arguments, in which case the "
4737 "C<guestfs_I<foo>_args> is completely omitted."
4742 #: ../src/guestfs.pod:2227
4744 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4745 "receiver knows what type of args structure to expect, or none at all."
4750 #: ../src/guestfs.pod:2231
4752 "For functions that take optional arguments, the optional arguments are "
4753 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4754 "arguments. A bitmask in the header indicates which optional arguments are "
4755 "meaningful. The bitmask is also checked to see if it contains bits set "
4756 "which the daemon does not know about (eg. if more optional arguments were "
4757 "added in a later version of the library), and this causes the call to be "
4763 #: ../src/guestfs.pod:2239
4764 msgid "The reply message for ordinary functions is:"
4769 #: ../src/guestfs.pod:2241
4772 " total length (header + ret,\n"
4773 " but not including the length word itself)\n"
4774 " struct guestfs_message_header (encoded as XDR)\n"
4775 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4781 #: ../src/guestfs.pod:2246
4783 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4784 "functions that return no formal return values."
4789 #: ../src/guestfs.pod:2249
4791 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4796 #: ../src/guestfs.pod:2252
4798 "In the case of an error, a flag is set in the header, and the reply message "
4799 "is slightly changed:"
4804 #: ../src/guestfs.pod:2255
4807 " total length (header + error,\n"
4808 " but not including the length word itself)\n"
4809 " struct guestfs_message_header (encoded as XDR)\n"
4810 " struct guestfs_message_error (encoded as XDR)\n"
4816 #: ../src/guestfs.pod:2260
4818 "The C<guestfs_message_error> structure contains the error message as a "
4824 #: ../src/guestfs.pod:2263
4825 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4830 #: ../src/guestfs.pod:2265
4832 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4833 "The normal request message is sent (see above). However this is followed by "
4834 "a sequence of file chunks."
4839 #: ../src/guestfs.pod:2269
4842 " total length (header + arguments,\n"
4843 " but not including the length word itself,\n"
4844 " and not including the chunks)\n"
4845 " struct guestfs_message_header (encoded as XDR)\n"
4846 " struct guestfs_<foo>_args (encoded as XDR)\n"
4847 " sequence of chunks for FileIn param #0\n"
4848 " sequence of chunks for FileIn param #1 etc.\n"
4854 #: ../src/guestfs.pod:2277
4855 msgid "The \"sequence of chunks\" is:"
4860 #: ../src/guestfs.pod:2279
4863 " length of chunk (not including length word itself)\n"
4864 " struct guestfs_chunk (encoded as XDR)\n"
4865 " length of chunk\n"
4866 " struct guestfs_chunk (encoded as XDR)\n"
4868 " length of chunk\n"
4869 " struct guestfs_chunk (with data.data_len == 0)\n"
4875 #: ../src/guestfs.pod:2287
4877 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4878 "is set in the final chunk to indicate either successful completion or early "
4884 #: ../src/guestfs.pod:2291
4886 "At time of writing there are no functions that have more than one FileIn "
4887 "parameter. However this is (theoretically) supported, by sending the "
4888 "sequence of chunks for each FileIn parameter one after another (from left to "
4894 #: ../src/guestfs.pod:2296
4896 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4897 "transfer. The library does this by sending a chunk with a special flag set "
4898 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4899 "RPC, does I<not> send any reply, and goes back to reading the next request."
4904 #: ../src/guestfs.pod:2302
4906 "The daemon may also cancel. It does this by writing a special word "
4907 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4908 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4909 "cancel chunk). The special word is chosen so that even if cancellation "
4910 "happens right at the end of the transfer (after the library has finished "
4911 "writing and has started listening for the reply), the \"spurious\" cancel "
4912 "flag will not be confused with the reply message."
4917 #: ../src/guestfs.pod:2311
4919 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4920 "limit), and also files where the size is not known in advance (eg. from "
4921 "pipes or sockets). However the chunks are rather small "
4922 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4923 "to keep much in memory."
4928 #: ../src/guestfs.pod:2317
4929 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4934 #: ../src/guestfs.pod:2319
4936 "The protocol for FileOut parameters is exactly the same as for FileIn "
4937 "parameters, but with the roles of daemon and library reversed."
4942 #: ../src/guestfs.pod:2322
4945 " total length (header + ret,\n"
4946 " but not including the length word itself,\n"
4947 " and not including the chunks)\n"
4948 " struct guestfs_message_header (encoded as XDR)\n"
4949 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4950 " sequence of chunks for FileOut param #0\n"
4951 " sequence of chunks for FileOut param #1 etc.\n"
4957 #: ../src/guestfs.pod:2330
4958 msgid "INITIAL MESSAGE"
4963 #: ../src/guestfs.pod:2332
4965 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4966 "which indicates that the guest and daemon is alive. This is what L</"
4967 "guestfs_launch> waits for."
4972 #: ../src/guestfs.pod:2336
4973 msgid "PROGRESS NOTIFICATION MESSAGES"
4978 #: ../src/guestfs.pod:2338
4980 "The daemon may send progress notification messages at any time. These are "
4981 "distinguished by the normal length word being replaced by "
4982 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4986 #: ../src/guestfs.pod:2342
4988 "The library turns them into progress callbacks (see L</"
4989 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4995 #: ../src/guestfs.pod:2346
4997 "The daemon self-limits the frequency of progress messages it sends (see "
4998 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5004 #: ../src/guestfs.pod:2350
5005 msgid "LIBGUESTFS VERSION NUMBERS"
5010 #: ../src/guestfs.pod:2352
5012 "Since April 2010, libguestfs has started to make separate development and "
5013 "stable releases, along with corresponding branches in our git repository. "
5014 "These separate releases can be identified by version number:"
5019 #: ../src/guestfs.pod:2357
5022 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5023 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5029 " | `-------- sub-version\n"
5031 " `------ always '1' because we don't change the ABI\n"
5037 #: ../src/guestfs.pod:2368
5038 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5043 #: ../src/guestfs.pod:2370
5045 "As time passes we cherry pick fixes from the development branch and backport "
5046 "those into the stable branch, the effect being that the stable branch should "
5047 "get more stable and less buggy over time. So the stable releases are ideal "
5048 "for people who don't need new features but would just like the software to "
5054 #: ../src/guestfs.pod:2376
5055 msgid "Our criteria for backporting changes are:"
5060 #: ../src/guestfs.pod:2382
5062 "Documentation changes which don't affect any code are backported unless the "
5063 "documentation refers to a future feature which is not in stable."
5068 #: ../src/guestfs.pod:2388
5070 "Bug fixes which are not controversial, fix obvious problems, and have been "
5071 "well tested are backported."
5076 #: ../src/guestfs.pod:2393
5078 "Simple rearrangements of code which shouldn't affect how it works get "
5079 "backported. This is so that the code in the two branches doesn't get too "
5080 "far out of step, allowing us to backport future fixes more easily."
5085 #: ../src/guestfs.pod:2399
5087 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5088 "exceptional case: the new feature is required in order to implement an "
5089 "important bug fix."
5094 #: ../src/guestfs.pod:2405
5096 "A new stable branch starts when we think the new features in development are "
5097 "substantial and compelling enough over the current stable branch to warrant "
5098 "it. When that happens we create new stable and development versions 1.N.0 "
5099 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5100 "stable at this point, but by backporting fixes from development, that branch "
5101 "will stabilize over time."
5105 #: ../src/guestfs.pod:2413
5106 msgid "EXTENDING LIBGUESTFS"
5110 #: ../src/guestfs.pod:2415
5111 msgid "ADDING A NEW API ACTION"
5115 #: ../src/guestfs.pod:2417
5117 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5118 "documentation) are generated, and this makes it easy to extend the "
5123 #: ../src/guestfs.pod:2421
5124 msgid "To add a new API action there are two changes:"
5128 #: ../src/guestfs.pod:2427
5130 "You need to add a description of the call (name, parameters, return type, "
5131 "tests, documentation) to C<generator/generator_actions.ml>."
5135 #: ../src/guestfs.pod:2430
5137 "There are two sorts of API action, depending on whether the call goes "
5138 "through to the daemon in the appliance, or is serviced entirely by the "
5139 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5140 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5141 "an example of the latter, since a trace flag is maintained in the handle and "
5142 "all tracing is done on the library side."
5146 #: ../src/guestfs.pod:2438
5148 "Most new actions are of the first type, and get added to the "
5149 "C<daemon_functions> list. Each function has a unique procedure number used "
5150 "in the RPC protocol which is assigned to that action when we publish "
5151 "libguestfs and cannot be reused. Take the latest procedure number and "
5156 #: ../src/guestfs.pod:2444
5158 "For library-only actions of the second type, add to the "
5159 "C<non_daemon_functions> list. Since these functions are serviced by the "
5160 "library and do not travel over the RPC mechanism to the daemon, these "
5161 "functions do not need a procedure number, and so the procedure number is set "
5166 #: ../src/guestfs.pod:2452
5167 msgid "Implement the action (in C):"
5171 #: ../src/guestfs.pod:2454
5173 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5174 "C<daemon/> directory."
5178 #: ../src/guestfs.pod:2457
5180 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5181 "(note: double underscore) in the C<src/> directory."
5185 #: ../src/guestfs.pod:2460
5186 msgid "In either case, use another function as an example of what to do."
5190 #: ../src/guestfs.pod:2464
5191 msgid "After making these changes, use C<make> to compile."
5195 #: ../src/guestfs.pod:2466
5197 "Note that you don't need to implement the RPC, language bindings, manual "
5198 "pages or anything else. It's all automatically generated from the OCaml "
5203 #: ../src/guestfs.pod:2470
5204 msgid "ADDING TESTS FOR AN API ACTION"
5208 #: ../src/guestfs.pod:2472
5210 "You can supply zero or as many tests as you want per API call. The tests "
5211 "can either be added as part of the API description (C<generator/"
5212 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5213 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5214 "slower, so if possible use the first method."
5218 #: ../src/guestfs.pod:2478
5220 "The following describes the test environment used when you add an API test "
5221 "in C<generator_actions.ml>."
5225 #: ../src/guestfs.pod:2481
5226 msgid "The test environment has 4 block devices:"
5230 #: ../src/guestfs.pod:2485
5231 msgid "C</dev/sda> 500MB"
5235 #: ../src/guestfs.pod:2487
5236 msgid "General block device for testing."
5240 #: ../src/guestfs.pod:2489
5241 msgid "C</dev/sdb> 50MB"
5245 #: ../src/guestfs.pod:2491
5247 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5252 #: ../src/guestfs.pod:2494
5253 msgid "C</dev/sdc> 10MB"
5257 #: ../src/guestfs.pod:2496
5258 msgid "Used in a few tests where two block devices are needed."
5262 #: ../src/guestfs.pod:2498
5267 #: ../src/guestfs.pod:2500
5268 msgid "ISO with fixed content (see C<images/test.iso>)."
5272 #: ../src/guestfs.pod:2504
5274 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5275 "appliance and block devices are reused between tests. So don't try testing "
5276 "L</guestfs_kill_subprocess> :-x"
5280 #: ../src/guestfs.pod:2508
5282 "Each test starts with an initial scenario, selected using one of the "
5283 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5284 "initialize the disks mentioned above in a particular way as documented in "
5285 "C<generator_types.ml>. You should not assume anything about the previous "
5286 "contents of other disks that are not initialized."
5290 #: ../src/guestfs.pod:2514
5292 "You can add a prerequisite clause to any individual test. This is a run-"
5293 "time check, which, if it fails, causes the test to be skipped. Useful if "
5294 "testing a command which might not work on all variations of libguestfs "
5295 "builds. A test that has prerequisite of C<Always> means to run "
5300 #: ../src/guestfs.pod:2520
5302 "In addition, packagers can skip individual tests by setting environment "
5303 "variables before running C<make check>."
5307 #: ../src/guestfs.pod:2523
5310 " SKIP_TEST_<CMD>_<NUM>=1\n"
5315 #: ../src/guestfs.pod:2525
5316 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5320 #: ../src/guestfs.pod:2527
5325 #: ../src/guestfs.pod:2529
5328 " SKIP_TEST_<CMD>=1\n"
5333 #: ../src/guestfs.pod:2531
5334 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5338 #: ../src/guestfs.pod:2533
5339 msgid "Packagers can run only certain tests by setting for example:"
5343 #: ../src/guestfs.pod:2535
5346 " TEST_ONLY=\"vfs_type zerofree\"\n"
5351 #: ../src/guestfs.pod:2537
5353 "See C<capitests/tests.c> for more details of how these environment variables "
5358 #: ../src/guestfs.pod:2540
5359 msgid "DEBUGGING NEW API ACTIONS"
5363 #: ../src/guestfs.pod:2542
5364 msgid "Test new actions work before submitting them."
5368 #: ../src/guestfs.pod:2544
5369 msgid "You can use guestfish to try out new commands."
5373 #: ../src/guestfs.pod:2546
5375 "Debugging the daemon is a problem because it runs inside a minimal "
5376 "environment. However you can fprintf messages in the daemon to stderr, and "
5377 "they will show up if you use C<guestfish -v>."
5381 #: ../src/guestfs.pod:2550
5382 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5386 #: ../src/guestfs.pod:2552
5388 "Our C source code generally adheres to some basic code-formatting "
5389 "conventions. The existing code base is not totally consistent on this "
5390 "front, but we do prefer that contributed code be formatted similarly. In "
5391 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5392 "indentation level, and other than that, follow the K&R style."
5396 #: ../src/guestfs.pod:2558
5398 "If you use Emacs, add the following to one of one of your start-up files (e."
5399 "g., ~/.emacs), to help ensure that you get indentation right:"
5403 #: ../src/guestfs.pod:2561
5406 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5407 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5408 " (add-hook 'find-file-hook\n"
5409 " '(lambda () (if (and buffer-file-name\n"
5410 " (string-match \"/libguestfs\\\\>\"\n"
5411 " (buffer-file-name))\n"
5412 " (not (string-equal mode-name \"Change Log\"))\n"
5413 " (not (string-equal mode-name \"Makefile\")))\n"
5414 " (setq indent-tabs-mode nil))))\n"
5419 #: ../src/guestfs.pod:2571
5422 " ;;; When editing C sources in libguestfs, use this style.\n"
5423 " (defun libguestfs-c-mode ()\n"
5424 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5426 " (c-set-style \"K&R\")\n"
5427 " (setq c-indent-level 2)\n"
5428 " (setq c-basic-offset 2))\n"
5429 " (add-hook 'c-mode-hook\n"
5430 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5431 " (buffer-file-name))\n"
5432 " (libguestfs-c-mode))))\n"
5437 #: ../src/guestfs.pod:2583
5438 msgid "Enable warnings when compiling (and fix any problems this finds):"
5442 #: ../src/guestfs.pod:2586
5445 " ./configure --enable-gcc-warnings\n"
5450 #: ../src/guestfs.pod:2588
5451 msgid "Useful targets are:"
5455 #: ../src/guestfs.pod:2590
5458 " make syntax-check # checks the syntax of the C code\n"
5459 " make check # runs the test suite\n"
5464 #: ../src/guestfs.pod:2593
5465 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5469 #: ../src/guestfs.pod:2595
5471 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5472 "which are used to do shell quoting."
5476 #: ../src/guestfs.pod:2600
5481 #: ../src/guestfs.pod:2602
5483 "Simple shell quoted string. Any spaces or other shell characters are "
5488 #: ../src/guestfs.pod:2605
5493 #: ../src/guestfs.pod:2607
5495 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5501 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5502 msgid "For example:"
5506 #: ../src/guestfs.pod:2614
5509 " asprintf (&cmd, \"cat %R\", path);\n"
5514 #: ../src/guestfs.pod:2616
5515 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5519 #: ../src/guestfs.pod:2618
5521 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5522 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5523 "they are not passed via the shell (instead, straight to exec). You probably "
5524 "want to use the C<sysroot_path()> function however."
5528 #: ../src/guestfs.pod:2624
5529 msgid "SUBMITTING YOUR NEW API ACTIONS"
5533 #: ../src/guestfs.pod:2626
5535 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5536 "libguestfs> and CC to L<rjones@redhat.com>."
5540 #: ../src/guestfs.pod:2630
5541 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5545 #: ../src/guestfs.pod:2632
5546 msgid "We support i18n (gettext anyhow) in the library."
5550 #: ../src/guestfs.pod:2634
5552 "However many messages come from the daemon, and we don't translate those at "
5553 "the moment. One reason is that the appliance generally has all locale files "
5554 "removed from it, because they take up a lot of space. So we'd have to readd "
5555 "some of those, as well as copying our PO files into the appliance."
5559 #: ../src/guestfs.pod:2640
5561 "Debugging messages are never translated, since they are intended for the "
5566 #: ../src/guestfs.pod:2643
5567 msgid "SOURCE CODE SUBDIRECTORIES"
5571 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5827
5572 #: ../fish/guestfish-actions.pod:3921
5573 msgid "C<appliance>"
5577 #: ../src/guestfs.pod:2649
5578 msgid "The libguestfs appliance, build scripts and so on."
5582 #: ../src/guestfs.pod:2651
5583 msgid "C<capitests>"
5587 #: ../src/guestfs.pod:2653
5588 msgid "Automated tests of the C API."
5592 #: ../src/guestfs.pod:2655
5597 #: ../src/guestfs.pod:2657
5599 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5604 #: ../src/guestfs.pod:2660
5609 #: ../src/guestfs.pod:2662
5611 "Safety and liveness tests of components that libguestfs depends upon (not of "
5612 "libguestfs itself). Mainly this is for qemu and the kernel."
5616 #: ../src/guestfs.pod:2665
5621 #: ../src/guestfs.pod:2667
5622 msgid "Outside contributions, experimental parts."
5626 #: ../src/guestfs.pod:2669
5631 #: ../src/guestfs.pod:2671
5633 "The daemon that runs inside the libguestfs appliance and carries out actions."
5637 #: ../src/guestfs.pod:2674
5642 #: ../src/guestfs.pod:2676
5643 msgid "L<virt-df(1)> command and documentation."
5647 #: ../src/guestfs.pod:2678
5652 #: ../src/guestfs.pod:2680
5653 msgid "C API example code."
5657 #: ../src/guestfs.pod:2682
5662 #: ../src/guestfs.pod:2684
5664 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5665 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5666 "L<virt-tar-out(1)>."
5670 #: ../src/guestfs.pod:2688
5675 #: ../src/guestfs.pod:2690
5677 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5681 #: ../src/guestfs.pod:2692
5682 msgid "C<generator>"
5686 #: ../src/guestfs.pod:2694
5688 "The crucially important generator, used to automatically generate large "
5689 "amounts of boilerplate C code for things like RPC and bindings."
5693 #: ../src/guestfs.pod:2697
5698 #: ../src/guestfs.pod:2699
5699 msgid "Files used by the test suite."
5703 #: ../src/guestfs.pod:2701
5704 msgid "Some \"phony\" guest images which we test against."
5708 #: ../src/guestfs.pod:2703
5709 msgid "C<inspector>"
5713 #: ../src/guestfs.pod:2705
5714 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5718 #: ../src/guestfs.pod:2707
5723 #: ../src/guestfs.pod:2709
5724 msgid "Logo used on the website. The fish is called Arthur by the way."
5728 #: ../src/guestfs.pod:2711
5733 #: ../src/guestfs.pod:2713
5734 msgid "M4 macros used by autoconf."
5738 #: ../src/guestfs.pod:2715
5743 #: ../src/guestfs.pod:2717
5744 msgid "Translations of simple gettext strings."
5748 #: ../src/guestfs.pod:2719
5753 #: ../src/guestfs.pod:2721
5755 "The build infrastructure and PO files for translations of manpages and POD "
5756 "files. Eventually this will be combined with the C<po> directory, but that "
5757 "is rather complicated."
5761 #: ../src/guestfs.pod:2725
5762 msgid "C<regressions>"
5766 #: ../src/guestfs.pod:2727
5767 msgid "Regression tests."
5771 #: ../src/guestfs.pod:2729
5776 #: ../src/guestfs.pod:2731
5777 msgid "L<virt-rescue(1)> command and documentation."
5781 #: ../src/guestfs.pod:2733
5786 #: ../src/guestfs.pod:2735
5787 msgid "Source code to the C library."
5791 #: ../src/guestfs.pod:2737
5796 #: ../src/guestfs.pod:2739
5797 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5801 #: ../src/guestfs.pod:2741
5802 msgid "C<test-tool>"
5806 #: ../src/guestfs.pod:2743
5808 "Test tool for end users to test if their qemu/kernel combination will work "
5813 #: ../src/guestfs.pod:2746
5818 #: ../src/guestfs.pod:2748
5823 #: ../src/guestfs.pod:2750
5828 #: ../src/guestfs.pod:2752
5833 #: ../src/guestfs.pod:2754
5838 #: ../src/guestfs.pod:2756
5843 #: ../src/guestfs.pod:2758
5848 #: ../src/guestfs.pod:2760
5853 #: ../src/guestfs.pod:2762
5854 msgid "Language bindings."
5858 #: ../src/guestfs.pod:2766
5864 #: ../src/guestfs.pod:2768
5865 msgid "PROTOCOL LIMITS"
5870 #: ../src/guestfs.pod:2770
5872 "Internally libguestfs uses a message-based protocol to pass API calls and "
5873 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5874 "plenty more detail about this). The maximum message size used by the "
5875 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5876 "aware of this limit. The API calls which may be affected are individually "
5877 "documented, with a link back to this section of the documentation."
5882 #: ../src/guestfs.pod:2778
5884 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5885 "a simple string. Because this string is at some point internally encoded as "
5886 "a message, the maximum size that it can return is slightly under 4 MB. If "
5887 "the requested file is larger than this then you will get an error."
5892 #: ../src/guestfs.pod:2784
5894 "In order to transfer large files into and out of the guest filesystem, you "
5895 "need to use particular calls that support this. The sections L</UPLOADING> "
5896 "and L</DOWNLOADING> document how to do this."
5901 #: ../src/guestfs.pod:2788
5903 "You might also consider mounting the disk image using our FUSE filesystem "
5904 "support (L<guestmount(1)>)."
5908 #: ../src/guestfs.pod:2791
5909 msgid "MAXIMUM NUMBER OF DISKS"
5913 #: ../src/guestfs.pod:2793
5914 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5918 #: ../src/guestfs.pod:2796
5920 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5921 "slots. However febootstrap only understands disks with names C</dev/vda> "
5922 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5927 #: ../src/guestfs.pod:2801
5929 "We are working to substantially raise this limit in future versions but it "
5930 "requires complex changes to qemu."
5934 #: ../src/guestfs.pod:2804
5936 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5937 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5938 "requires changes to qemu."
5942 #: ../src/guestfs.pod:2808
5943 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5947 #: ../src/guestfs.pod:2810
5948 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5952 #: ../src/guestfs.pod:2812
5954 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5955 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5959 #: ../src/guestfs.pod:2815
5961 "If you attach a disk with more than 15 partitions, the extra partitions are "
5962 "ignored by libguestfs."
5966 #: ../src/guestfs.pod:2818
5967 msgid "MAXIMUM SIZE OF A DISK"
5971 #: ../src/guestfs.pod:2820
5972 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5976 #: ../src/guestfs.pod:2822
5978 "We have tested block devices up to 1 exabyte (2**60 or "
5979 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5984 #: ../src/guestfs.pod:2826
5986 "Although libguestfs probably does not impose any limit, the underlying host "
5987 "storage will. If you store disk images on a host ext4 filesystem, then the "
5988 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5989 "TB). If you store disk images as host logical volumes then you are limited "
5990 "by the maximum size of an LV."
5994 #: ../src/guestfs.pod:2832
5996 "For the hugest disk image files, we recommend using XFS on the host for "
6001 #: ../src/guestfs.pod:2835
6002 msgid "MAXIMUM SIZE OF A PARTITION"
6006 #: ../src/guestfs.pod:2837
6008 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6009 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6010 "address a partition located beyond 2 TB on the disk."
6014 #: ../src/guestfs.pod:2841
6016 "It is recommended that you use GPT partitions on disks which are larger than "
6017 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6018 "which are theoretically larger than the largest disk we could support."
6022 #: ../src/guestfs.pod:2846
6023 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6027 #: ../src/guestfs.pod:2848
6029 "This depends on the filesystem type. libguestfs itself does not impose any "
6030 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6031 "what these limits are."
6035 #: ../src/guestfs.pod:2852
6036 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6040 #: ../src/guestfs.pod:2854
6042 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6043 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6044 "uploads and downloads."
6048 #: ../src/guestfs.pod:2858
6049 msgid "INSPECTION LIMITS"
6053 #: ../src/guestfs.pod:2860
6055 "The inspection code has several arbitrary limits on things like the size of "
6056 "Windows Registry hive it will read, and the length of product name. These "
6057 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6058 "memory and disk space on the host, and should not be reached in practice. "
6059 "See the source code for more information."
6064 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1015
6065 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
6066 msgid "ENVIRONMENT VARIABLES"
6071 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1041
6072 msgid "LIBGUESTFS_APPEND"
6077 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1043
6078 msgid "Pass additional options to the guest kernel."
6083 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1045
6084 msgid "LIBGUESTFS_DEBUG"
6089 #: ../src/guestfs.pod:2876
6091 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6092 "effect as calling C<guestfs_set_verbose (g, 1)>."
6097 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1050
6098 msgid "LIBGUESTFS_MEMSIZE"
6103 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1052
6105 "Set the memory allocated to the qemu process, in megabytes. For example:"
6110 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1055
6113 " LIBGUESTFS_MEMSIZE=700\n"
6119 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1057
6120 msgid "LIBGUESTFS_PATH"
6124 #: ../src/guestfs.pod:2888
6126 "Set the path that libguestfs uses to search for a supermin appliance. See "
6127 "the discussion of paths in section L</PATH> above."
6132 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1062
6133 msgid "LIBGUESTFS_QEMU"
6138 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1064
6140 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6141 "which was found at compile time by the configure script is used."
6146 #: ../src/guestfs.pod:2897
6147 msgid "See also L</QEMU WRAPPERS> above."
6152 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1068
6153 msgid "LIBGUESTFS_TRACE"
6158 #: ../src/guestfs.pod:2901
6160 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6161 "effect as calling C<guestfs_set_trace (g, 1)>."
6166 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1077
6171 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1079
6173 "Location of temporary directory, defaults to C</tmp> except for the cached "
6174 "supermin appliance which defaults to C</var/tmp>."
6178 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1082
6180 "If libguestfs was compiled to use the supermin appliance then the real "
6181 "appliance is cached in this directory, shared between all handles belonging "
6182 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6183 "use in case C</var/tmp> is not large enough."
6188 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1149
6189 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
6190 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6191 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6192 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6197 #: ../src/guestfs.pod:2919
6199 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
6200 "python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat"
6201 "(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)"
6202 ">, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)"
6203 ">, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
6204 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
6205 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs."
6211 #: ../src/guestfs.pod:2947
6213 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6214 "(8)>, L<disktype(1)>."
6219 #: ../src/guestfs.pod:2954 ../tools/virt-win-reg.pl:587
6220 #: ../tools/virt-make-fs.pl:553
6226 #: ../src/guestfs.pod:2956
6227 msgid "To get a list of bugs against libguestfs use this link:"
6232 #: ../src/guestfs.pod:2958
6234 "L<https://bugzilla.redhat.com/buglist.cgi?"
6235 "component=libguestfs&product=Virtualization+Tools>"
6240 #: ../src/guestfs.pod:2960
6241 msgid "To report a new bug against libguestfs use this link:"
6246 #: ../src/guestfs.pod:2962
6248 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6249 "component=libguestfs&product=Virtualization+Tools>"
6254 #: ../src/guestfs.pod:2964
6255 msgid "When reporting a bug, please check:"
6260 #: ../src/guestfs.pod:2970
6261 msgid "That the bug hasn't been reported already."
6266 #: ../src/guestfs.pod:2974
6267 msgid "That you are testing a recent version."
6272 #: ../src/guestfs.pod:2978
6273 msgid "Describe the bug accurately, and give a way to reproduce it."
6278 #: ../src/guestfs.pod:2982
6280 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6286 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1172
6287 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
6293 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1174
6294 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
6295 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6300 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1176
6301 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
6302 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6303 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6304 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6309 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1178
6310 #: ../test-tool/libguestfs-test-tool.pod:99
6311 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6316 #: ../src/guestfs.pod:2996
6318 "This library is free software; you can redistribute it and/or modify it "
6319 "under the terms of the GNU Lesser General Public License as published by the "
6320 "Free Software Foundation; either version 2 of the License, or (at your "
6321 "option) any later version."
6326 #: ../src/guestfs.pod:3001
6328 "This library is distributed in the hope that it will be useful, but WITHOUT "
6329 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6330 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6336 #: ../src/guestfs.pod:3006
6338 "You should have received a copy of the GNU Lesser General Public License "
6339 "along with this library; if not, write to the Free Software Foundation, "
6340 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6345 #: ../src/guestfs-actions.pod:1
6346 msgid "guestfs_add_cdrom"
6351 #: ../src/guestfs-actions.pod:3
6355 " guestfs_add_cdrom (guestfs_h *g,\n"
6356 " const char *filename);\n"
6362 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6363 msgid "This function adds a virtual CD-ROM disk image to the guest."
6367 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6368 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6373 #: ../src/guestfs-actions.pod:17
6375 "This call checks for the existence of C<filename>. This stops you from "
6376 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6377 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6383 #: ../src/guestfs-actions.pod:24
6385 "If you just want to add an ISO file (often you use this as an efficient way "
6386 "to transfer large files into the guest), then you should probably use "
6387 "C<guestfs_add_drive_ro> instead."
6392 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6393 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6394 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6395 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6396 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6397 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6398 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6399 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6400 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6401 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6402 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6403 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6404 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6405 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6406 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6407 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6408 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6409 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6410 #: ../src/guestfs-actions.pod:1692 ../src/guestfs-actions.pod:1714
6411 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:2263
6412 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2468
6413 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3456
6414 #: ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3496
6415 #: ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3665
6416 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692
6417 #: ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3743
6418 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3835
6419 #: ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875
6420 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930
6421 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:3968
6422 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4015
6423 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4067
6424 #: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095
6425 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4205
6426 #: ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4238
6427 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4307
6428 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4341
6429 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4369
6430 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4401
6431 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4479
6432 #: ../src/guestfs-actions.pod:4552 ../src/guestfs-actions.pod:4583
6433 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4621
6434 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4650
6435 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4678
6436 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4728
6437 #: ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4770
6438 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4801
6439 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4896
6440 #: ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:4938
6441 #: ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:4973
6442 #: ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5164
6443 #: ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5204
6444 #: ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5302
6445 #: ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5332
6446 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5635
6447 #: ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5673
6448 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5697
6449 #: ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5723
6450 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5753
6451 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5793
6452 #: ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5842
6453 #: ../src/guestfs-actions.pod:5858 ../src/guestfs-actions.pod:5881
6454 #: ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918
6455 #: ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:5958
6456 #: ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6003
6457 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6046
6458 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6089
6459 #: ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6123
6460 #: ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6190
6461 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6345
6462 #: ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6478
6463 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
6464 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6539
6465 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6565
6466 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6639
6467 #: ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6672
6468 #: ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6705
6469 #: ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6738
6470 #: ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6788
6471 #: ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842
6472 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6894
6473 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:7049
6474 #: ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7081
6475 #: ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7149
6476 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-actions.pod:7227
6477 #: ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7314
6478 #: ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7399
6479 #: ../src/guestfs-actions.pod:7428
6480 msgid "This function returns 0 on success or -1 on error."
6485 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6486 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6487 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6489 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6495 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6496 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6497 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962
6498 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4733
6499 #: ../src/guestfs-actions.pod:6168 ../src/guestfs-actions.pod:6198
6500 #: ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6290
6501 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7322
6502 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:31
6503 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6504 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1316
6505 #: ../fish/guestfish-actions.pod:1330 ../fish/guestfish-actions.pod:3005
6506 #: ../fish/guestfish-actions.pod:3202 ../fish/guestfish-actions.pod:4183
6507 #: ../fish/guestfish-actions.pod:4206 ../fish/guestfish-actions.pod:4228
6508 #: ../fish/guestfish-actions.pod:4266 ../fish/guestfish-actions.pod:4907
6509 #: ../fish/guestfish-actions.pod:5004
6511 "Deprecated functions will not be removed from the API, but the fact that "
6512 "they are deprecated indicates that there are problems with correct use of "
6518 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6519 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1913
6520 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2114
6521 #: ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3478
6522 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5860
6523 #: ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:6091
6524 #: ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6707
6525 #: ../src/guestfs-actions.pod:7236
6526 msgid "(Added in 0.3)"
6531 #: ../src/guestfs-actions.pod:41
6532 msgid "guestfs_add_domain"
6537 #: ../src/guestfs-actions.pod:43
6541 " guestfs_add_domain (guestfs_h *g,\n"
6542 " const char *dom,\n"
6549 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6550 #: ../src/guestfs-actions.pod:4440
6552 "You may supply a list of optional arguments to this call. Use zero or more "
6553 "of the following pairs of parameters, and terminate the list with C<-1> on "
6554 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6558 #: ../src/guestfs-actions.pod:53
6561 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6562 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6563 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6564 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6570 #: ../src/guestfs-actions.pod:58
6572 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6573 "It works by connecting to libvirt, requesting the domain and domain XML from "
6574 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6580 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6582 "The number of disks added is returned. This operation is atomic: if an "
6583 "error is returned, then no disks are added."
6588 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6590 "This function does some minimal checks to make sure the libvirt domain is "
6591 "not running (unless C<readonly> is true). In a future version we will try "
6592 "to acquire the libvirt lock on each disk."
6597 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6599 "Disks must be accessible locally. This often means that adding disks from a "
6600 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6601 "unless those disks are accessible via the same device path locally too."
6605 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6607 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6608 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6609 "libvirt URI (or one set through an environment variable, see the libvirt "
6610 "documentation for full details)."
6614 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6616 "The optional C<live> flag controls whether this call will try to connect to "
6617 "a running virtual machine C<guestfsd> process if it sees a suitable "
6618 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6619 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6620 "DAEMONS> for more information."
6625 #: ../src/guestfs-actions.pod:88
6627 "The other optional parameters are passed directly through to "
6628 "C<guestfs_add_drive_opts>."
6633 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6634 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6635 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6636 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6637 #: ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1874
6638 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2023
6639 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2101
6640 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2777
6641 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:4873
6642 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5416
6643 #: ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:6815
6644 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7260
6645 #: ../src/guestfs-actions.pod:7273
6646 msgid "On error this function returns -1."
6651 #: ../src/guestfs-actions.pod:93
6652 msgid "(Added in 1.7.4)"
6657 #: ../src/guestfs-actions.pod:95
6658 msgid "guestfs_add_domain_va"
6663 #: ../src/guestfs-actions.pod:97
6667 " guestfs_add_domain_va (guestfs_h *g,\n"
6668 " const char *dom,\n"
6675 #: ../src/guestfs-actions.pod:102
6676 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6681 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6682 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6683 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4505
6684 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6689 #: ../src/guestfs-actions.pod:106
6690 msgid "guestfs_add_domain_argv"
6695 #: ../src/guestfs-actions.pod:108
6699 " guestfs_add_domain_argv (guestfs_h *g,\n"
6700 " const char *dom,\n"
6701 " const struct guestfs_add_domain_argv *optargs);\n"
6707 #: ../src/guestfs-actions.pod:113
6708 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6713 #: ../src/guestfs-actions.pod:117
6714 msgid "guestfs_add_drive"
6719 #: ../src/guestfs-actions.pod:119
6723 " guestfs_add_drive (guestfs_h *g,\n"
6724 " const char *filename);\n"
6730 #: ../src/guestfs-actions.pod:123
6732 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6733 "optional parameters, so the disk is added writable, with the format being "
6734 "detected automatically."
6739 #: ../src/guestfs-actions.pod:127
6741 "Automatic detection of the format opens you up to a potential security hole "
6742 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6743 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6744 "you should think about replacing calls to this function with calls to "
6745 "C<guestfs_add_drive_opts>, and specifying the format."
6750 #: ../src/guestfs-actions.pod:138
6751 msgid "guestfs_add_drive_opts"
6756 #: ../src/guestfs-actions.pod:140
6760 " guestfs_add_drive_opts (guestfs_h *g,\n"
6761 " const char *filename,\n"
6768 #: ../src/guestfs-actions.pod:150
6771 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6772 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6773 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6779 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6781 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6782 "The first time you call this function, the disk appears as C</dev/sda>, the "
6783 "second time as C</dev/sdb>, and so on."
6788 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6790 "You don't necessarily need to be root when using libguestfs. However you "
6791 "obviously do need sufficient permissions to access the filename for whatever "
6792 "operations you want to perform (ie. read access if you just want to read the "
6793 "image or write access if you want to modify the image)."
6798 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6799 msgid "This call checks that C<filename> exists."
6804 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4451
6805 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3016
6806 msgid "The optional arguments are:"
6811 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6817 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6819 "If true then the image is treated as read-only. Writes are still allowed, "
6820 "but they are stored in a temporary snapshot overlay which is discarded at "
6821 "the end. The disk that you add is not modified."
6826 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6832 #: ../src/guestfs-actions.pod:179
6834 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6835 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6836 "Possible formats include C<raw> and C<qcow2>."
6841 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6843 "Automatic detection of the format opens you up to a potential security hole "
6844 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6845 "RHBZ#642934. Specifying the format closes this security hole."
6850 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6856 #: ../src/guestfs-actions.pod:190
6858 "This rarely-used option lets you emulate the behaviour of the deprecated "
6859 "C<guestfs_add_drive_with_if> call (q.v.)"
6864 #: ../src/guestfs-actions.pod:197
6865 msgid "(Added in 1.5.23)"
6870 #: ../src/guestfs-actions.pod:199
6871 msgid "guestfs_add_drive_opts_va"
6876 #: ../src/guestfs-actions.pod:201
6880 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6881 " const char *filename,\n"
6888 #: ../src/guestfs-actions.pod:206
6889 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6894 #: ../src/guestfs-actions.pod:210
6895 msgid "guestfs_add_drive_opts_argv"
6900 #: ../src/guestfs-actions.pod:212
6904 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6905 " const char *filename,\n"
6906 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6912 #: ../src/guestfs-actions.pod:217
6913 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6918 #: ../src/guestfs-actions.pod:221
6919 msgid "guestfs_add_drive_ro"
6924 #: ../src/guestfs-actions.pod:223
6928 " guestfs_add_drive_ro (guestfs_h *g,\n"
6929 " const char *filename);\n"
6935 #: ../src/guestfs-actions.pod:227
6937 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6938 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6939 "disk is added read-only, with the format being detected automatically."
6944 #: ../src/guestfs-actions.pod:234
6945 msgid "(Added in 1.0.38)"
6950 #: ../src/guestfs-actions.pod:236
6951 msgid "guestfs_add_drive_ro_with_if"
6956 #: ../src/guestfs-actions.pod:238
6960 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6961 " const char *filename,\n"
6962 " const char *iface);\n"
6968 #: ../src/guestfs-actions.pod:243
6970 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6971 "QEMU interface emulation to use at run time."
6976 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6977 #: ../src/guestfs-actions.pod:2353
6978 msgid "(Added in 1.0.84)"
6983 #: ../src/guestfs-actions.pod:257
6984 msgid "guestfs_add_drive_with_if"
6989 #: ../src/guestfs-actions.pod:259
6993 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6994 " const char *filename,\n"
6995 " const char *iface);\n"
7001 #: ../src/guestfs-actions.pod:264
7003 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7004 "QEMU interface emulation to use at run time."
7009 #: ../src/guestfs-actions.pod:278
7010 msgid "guestfs_aug_clear"
7015 #: ../src/guestfs-actions.pod:280
7019 " guestfs_aug_clear (guestfs_h *g,\n"
7020 " const char *augpath);\n"
7026 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
7028 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7029 "L<augtool(1)> C<clear> command."
7034 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2103
7035 msgid "(Added in 1.3.4)"
7040 #: ../src/guestfs-actions.pod:291
7041 msgid "guestfs_aug_close"
7046 #: ../src/guestfs-actions.pod:293
7050 " guestfs_aug_close (guestfs_h *g);\n"
7056 #: ../src/guestfs-actions.pod:296
7058 "Close the current Augeas handle and free up any resources used by it. After "
7059 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7060 "any other Augeas functions."
7065 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
7066 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
7067 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
7068 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
7069 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
7070 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
7071 #: ../src/guestfs-actions.pod:5493
7072 msgid "(Added in 0.7)"
7077 #: ../src/guestfs-actions.pod:305
7078 msgid "guestfs_aug_defnode"
7083 #: ../src/guestfs-actions.pod:307
7086 " struct guestfs_int_bool *\n"
7087 " guestfs_aug_defnode (guestfs_h *g,\n"
7088 " const char *name,\n"
7089 " const char *expr,\n"
7090 " const char *val);\n"
7096 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
7098 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7103 #: ../src/guestfs-actions.pod:316
7105 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7106 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7107 "containing that single node."
7112 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
7114 "On success this returns a pair containing the number of nodes in the "
7115 "nodeset, and a boolean flag if a node was created."
7120 #: ../src/guestfs-actions.pod:324
7122 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7123 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7128 #: ../src/guestfs-actions.pod:330
7129 msgid "guestfs_aug_defvar"
7134 #: ../src/guestfs-actions.pod:332
7138 " guestfs_aug_defvar (guestfs_h *g,\n"
7139 " const char *name,\n"
7140 " const char *expr);\n"
7146 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
7148 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7149 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7154 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
7156 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7157 "evaluates to something which is not a nodeset."
7162 #: ../src/guestfs-actions.pod:348
7163 msgid "guestfs_aug_get"
7168 #: ../src/guestfs-actions.pod:350
7172 " guestfs_aug_get (guestfs_h *g,\n"
7173 " const char *augpath);\n"
7179 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7181 "Look up the value associated with C<path>. If C<path> matches exactly one "
7182 "node, the C<value> is returned."
7187 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7188 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7189 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7190 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7191 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7192 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1654
7193 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1834
7194 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:1935
7195 #: ../src/guestfs-actions.pod:1956 ../src/guestfs-actions.pod:2126
7196 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2525
7197 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
7198 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:2869
7199 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2924
7200 #: ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3021
7201 #: ../src/guestfs-actions.pod:3044 ../src/guestfs-actions.pod:3065
7202 #: ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3987
7203 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4267
7204 #: ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5221
7205 #: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5569
7206 #: ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6251
7207 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6284
7208 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6989
7209 #: ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026
7210 #: ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7485
7212 "This function returns a string, or NULL on error. I<The caller must free "
7213 "the returned string after use>."
7218 #: ../src/guestfs-actions.pod:362
7219 msgid "guestfs_aug_init"
7224 #: ../src/guestfs-actions.pod:364
7228 " guestfs_aug_init (guestfs_h *g,\n"
7229 " const char *root,\n"
7236 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7238 "Create a new Augeas handle for editing configuration files. If there was "
7239 "any previous Augeas handle associated with this guestfs session, then it is "
7245 #: ../src/guestfs-actions.pod:373
7246 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7251 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7253 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7258 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7260 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7261 "logical I<or> of the following integers:"
7266 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7267 msgid "C<AUG_SAVE_BACKUP> = 1"
7272 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7273 msgid "Keep the original file with a C<.augsave> extension."
7278 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7279 msgid "C<AUG_SAVE_NEWFILE> = 2"
7284 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7286 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7287 "original. Overrides C<AUG_SAVE_BACKUP>."
7292 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7293 msgid "C<AUG_TYPE_CHECK> = 4"
7298 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7299 msgid "Typecheck lenses (can be expensive)."
7304 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7305 msgid "C<AUG_NO_STDINC> = 8"
7310 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7311 msgid "Do not use standard load path for modules."
7316 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7317 msgid "C<AUG_SAVE_NOOP> = 16"
7322 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7323 msgid "Make save a no-op, just record what would have been changed."
7328 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7329 msgid "C<AUG_NO_LOAD> = 32"
7334 #: ../src/guestfs-actions.pod:408
7335 msgid "Do not load the tree in C<guestfs_aug_init>."
7340 #: ../src/guestfs-actions.pod:412
7341 msgid "To close the handle, you can call C<guestfs_aug_close>."
7346 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7347 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7352 #: ../src/guestfs-actions.pod:420
7353 msgid "guestfs_aug_insert"
7358 #: ../src/guestfs-actions.pod:422
7362 " guestfs_aug_insert (guestfs_h *g,\n"
7363 " const char *augpath,\n"
7364 " const char *label,\n"
7371 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7373 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7374 "or after C<path> (depending on the boolean flag C<before>)."
7379 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7381 "C<path> must match exactly one existing node in the tree, and C<label> must "
7382 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7387 #: ../src/guestfs-actions.pod:440
7388 msgid "guestfs_aug_load"
7393 #: ../src/guestfs-actions.pod:442
7397 " guestfs_aug_load (guestfs_h *g);\n"
7403 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7404 msgid "Load files into the tree."
7409 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7410 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7415 #: ../src/guestfs-actions.pod:454
7416 msgid "guestfs_aug_ls"
7421 #: ../src/guestfs-actions.pod:456
7425 " guestfs_aug_ls (guestfs_h *g,\n"
7426 " const char *augpath);\n"
7432 #: ../src/guestfs-actions.pod:460
7434 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7435 "sorting the resulting nodes into alphabetical order."
7440 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7441 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7442 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7443 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7444 #: ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:2198
7445 #: ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2233
7446 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2300
7447 #: ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2420
7448 #: ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2978
7449 #: ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3557
7450 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3724
7451 #: ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4834
7452 #: ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5489
7453 #: ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:6331
7454 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6447
7455 #: ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6617
7456 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
7457 #: ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7338
7458 #: ../src/guestfs-actions.pod:7357 ../src/guestfs-actions.pod:7442
7459 #: ../src/guestfs-actions.pod:7461 ../src/guestfs-actions.pod:7507
7460 #: ../src/guestfs-actions.pod:7526
7462 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7463 ">), or NULL if there was an error. I<The caller must free the strings and "
7464 "the array after use>."
7469 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7470 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7471 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3376
7472 #: ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4020
7473 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4240
7474 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4838
7475 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5699
7476 #: ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5725
7477 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6831
7478 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:7083
7479 #: ../src/guestfs-actions.pod:7326
7480 msgid "(Added in 0.8)"
7485 #: ../src/guestfs-actions.pod:469
7486 msgid "guestfs_aug_match"
7491 #: ../src/guestfs-actions.pod:471
7495 " guestfs_aug_match (guestfs_h *g,\n"
7496 " const char *augpath);\n"
7502 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7504 "Returns a list of paths which match the path expression C<path>. The "
7505 "returned paths are sufficiently qualified so that they match exactly one "
7506 "node in the current tree."
7511 #: ../src/guestfs-actions.pod:485
7512 msgid "guestfs_aug_mv"
7517 #: ../src/guestfs-actions.pod:487
7521 " guestfs_aug_mv (guestfs_h *g,\n"
7522 " const char *src,\n"
7523 " const char *dest);\n"
7529 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7531 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7532 "C<dest> is overwritten if it exists."
7537 #: ../src/guestfs-actions.pod:499
7538 msgid "guestfs_aug_rm"
7543 #: ../src/guestfs-actions.pod:501
7547 " guestfs_aug_rm (guestfs_h *g,\n"
7548 " const char *augpath);\n"
7554 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7555 msgid "Remove C<path> and all of its children."
7560 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7561 msgid "On success this returns the number of entries which were removed."
7566 #: ../src/guestfs-actions.pod:513
7567 msgid "guestfs_aug_save"
7572 #: ../src/guestfs-actions.pod:515
7576 " guestfs_aug_save (guestfs_h *g);\n"
7582 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7583 msgid "This writes all pending changes to disk."
7588 #: ../src/guestfs-actions.pod:520
7590 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7596 #: ../src/guestfs-actions.pod:527
7597 msgid "guestfs_aug_set"
7602 #: ../src/guestfs-actions.pod:529
7606 " guestfs_aug_set (guestfs_h *g,\n"
7607 " const char *augpath,\n"
7608 " const char *val);\n"
7614 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7615 msgid "Set the value associated with C<path> to C<val>."
7620 #: ../src/guestfs-actions.pod:536
7622 "In the Augeas API, it is possible to clear a node by setting the value to "
7623 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7624 "this call. Instead you must use the C<guestfs_aug_clear> call."
7629 #: ../src/guestfs-actions.pod:545
7630 msgid "guestfs_available"
7635 #: ../src/guestfs-actions.pod:547
7639 " guestfs_available (guestfs_h *g,\n"
7640 " char *const *groups);\n"
7646 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7648 "This command is used to check the availability of some groups of "
7649 "functionality in the appliance, which not all builds of the libguestfs "
7650 "appliance will be able to provide."
7655 #: ../src/guestfs-actions.pod:555
7657 "The libguestfs groups, and the functions that those groups correspond to, "
7658 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7659 "runtime by calling C<guestfs_available_all_groups>."
7664 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7666 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7667 "\"]> would check for the availability of the Linux inotify functions and "
7668 "Augeas (configuration file editing) functions."
7673 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7674 msgid "The command returns no error if I<all> requested groups are available."
7679 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7681 "It fails with an error if one or more of the requested groups is unavailable "
7687 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7689 "If an unknown group name is included in the list of groups then an error is "
7695 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7701 #: ../src/guestfs-actions.pod:579
7702 msgid "You must call C<guestfs_launch> before calling this function."
7707 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7709 "The reason is because we don't know what groups are supported by the "
7710 "appliance/daemon until it is running and can be queried."
7715 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7717 "If a group of functions is available, this does not necessarily mean that "
7718 "they will work. You still have to check for errors when calling individual "
7719 "API functions even if they are available."
7724 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7726 "It is usually the job of distro packagers to build complete functionality "
7727 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7728 "with all requirements satisfied, will support everything."
7733 #: ../src/guestfs-actions.pod:601
7735 "This call was added in version C<1.0.80>. In previous versions of "
7736 "libguestfs all you could do would be to speculatively execute a command to "
7737 "find out if the daemon implemented it. See also C<guestfs_version>."
7742 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7743 msgid "(Added in 1.0.80)"
7748 #: ../src/guestfs-actions.pod:612
7749 msgid "guestfs_available_all_groups"
7754 #: ../src/guestfs-actions.pod:614
7758 " guestfs_available_all_groups (guestfs_h *g);\n"
7764 #: ../src/guestfs-actions.pod:617
7766 "This command returns a list of all optional groups that this daemon knows "
7767 "about. Note this returns both supported and unsupported groups. To find "
7768 "out which ones the daemon can actually support you have to call "
7769 "C<guestfs_available> on each member of the returned list."
7774 #: ../src/guestfs-actions.pod:623
7775 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7780 #: ../src/guestfs-actions.pod:629
7781 msgid "(Added in 1.3.15)"
7786 #: ../src/guestfs-actions.pod:631
7787 msgid "guestfs_base64_in"
7792 #: ../src/guestfs-actions.pod:633
7796 " guestfs_base64_in (guestfs_h *g,\n"
7797 " const char *base64file,\n"
7798 " const char *filename);\n"
7804 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7806 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7811 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7812 msgid "(Added in 1.3.5)"
7817 #: ../src/guestfs-actions.pod:645
7818 msgid "guestfs_base64_out"
7823 #: ../src/guestfs-actions.pod:647
7827 " guestfs_base64_out (guestfs_h *g,\n"
7828 " const char *filename,\n"
7829 " const char *base64file);\n"
7835 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7837 "This command downloads the contents of C<filename>, writing it out to local "
7838 "file C<base64file> encoded as base64."
7843 #: ../src/guestfs-actions.pod:659
7844 msgid "guestfs_blockdev_flushbufs"
7849 #: ../src/guestfs-actions.pod:661
7853 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7854 " const char *device);\n"
7860 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7862 "This tells the kernel to flush internal buffers associated with C<device>."
7867 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7868 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7869 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7870 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7871 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7872 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7873 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7874 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7875 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7876 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7877 msgid "This uses the L<blockdev(8)> command."
7882 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7883 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7884 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7885 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7886 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7887 msgid "(Added in 0.9.3)"
7892 #: ../src/guestfs-actions.pod:674
7893 msgid "guestfs_blockdev_getbsz"
7898 #: ../src/guestfs-actions.pod:676
7902 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7903 " const char *device);\n"
7909 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7910 msgid "This returns the block size of a device."
7915 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7916 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7918 "(Note this is different from both I<size in blocks> and I<filesystem block "
7924 #: ../src/guestfs-actions.pod:691
7925 msgid "guestfs_blockdev_getro"
7930 #: ../src/guestfs-actions.pod:693
7934 " guestfs_blockdev_getro (guestfs_h *g,\n"
7935 " const char *device);\n"
7941 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7943 "Returns a boolean indicating if the block device is read-only (true if read-"
7944 "only, false if not)."
7949 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7950 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1911
7951 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1994
7952 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2064
7953 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:2112
7954 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
7955 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3284
7956 #: ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3313
7957 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3343
7958 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3374
7959 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3401
7960 #: ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3430
7961 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:4992
7962 msgid "This function returns a C truth value on success or -1 on error."
7967 #: ../src/guestfs-actions.pod:706
7968 msgid "guestfs_blockdev_getsize64"
7973 #: ../src/guestfs-actions.pod:708
7977 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7978 " const char *device);\n"
7984 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7985 msgid "This returns the size of the device in bytes."
7990 #: ../src/guestfs-actions.pod:714
7991 msgid "See also C<guestfs_blockdev_getsz>."
7996 #: ../src/guestfs-actions.pod:722
7997 msgid "guestfs_blockdev_getss"
8002 #: ../src/guestfs-actions.pod:724
8006 " guestfs_blockdev_getss (guestfs_h *g,\n"
8007 " const char *device);\n"
8013 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
8015 "This returns the size of sectors on a block device. Usually 512, but can be "
8016 "larger for modern devices."
8021 #: ../src/guestfs-actions.pod:731
8023 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8029 #: ../src/guestfs-actions.pod:740
8030 msgid "guestfs_blockdev_getsz"
8035 #: ../src/guestfs-actions.pod:742
8039 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8040 " const char *device);\n"
8046 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
8048 "This returns the size of the device in units of 512-byte sectors (even if "
8049 "the sectorsize isn't 512 bytes ... weird)."
8054 #: ../src/guestfs-actions.pod:749
8056 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8057 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8062 #: ../src/guestfs-actions.pod:759
8063 msgid "guestfs_blockdev_rereadpt"
8068 #: ../src/guestfs-actions.pod:761
8072 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8073 " const char *device);\n"
8079 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
8080 msgid "Reread the partition table on C<device>."
8085 #: ../src/guestfs-actions.pod:773
8086 msgid "guestfs_blockdev_setbsz"
8091 #: ../src/guestfs-actions.pod:775
8095 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8096 " const char *device,\n"
8097 " int blocksize);\n"
8103 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
8104 msgid "This sets the block size of a device."
8109 #: ../src/guestfs-actions.pod:791
8110 msgid "guestfs_blockdev_setro"
8115 #: ../src/guestfs-actions.pod:793
8119 " guestfs_blockdev_setro (guestfs_h *g,\n"
8120 " const char *device);\n"
8126 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
8127 msgid "Sets the block device named C<device> to read-only."
8132 #: ../src/guestfs-actions.pod:805
8133 msgid "guestfs_blockdev_setrw"
8138 #: ../src/guestfs-actions.pod:807
8142 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8143 " const char *device);\n"
8149 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
8150 msgid "Sets the block device named C<device> to read-write."
8155 #: ../src/guestfs-actions.pod:819
8156 msgid "guestfs_case_sensitive_path"
8161 #: ../src/guestfs-actions.pod:821
8165 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8166 " const char *path);\n"
8172 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
8174 "This can be used to resolve case insensitive paths on a filesystem which is "
8175 "case sensitive. The use case is to resolve paths which you have read from "
8176 "Windows configuration files or the Windows Registry, to the true path."
8181 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8183 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8184 "(and probably others), which is that although the underlying filesystem is "
8185 "case-insensitive, the driver exports the filesystem to Linux as case-"
8191 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8193 "One consequence of this is that special directories such as C<c:\\windows> "
8194 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8195 "precise details of how they were created. In Windows itself this would not "
8201 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8203 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8209 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8211 "This function resolves the true case of each element in the path and returns "
8212 "the case-sensitive path."
8217 #: ../src/guestfs-actions.pod:847
8219 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8220 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8221 "how the directories were originally created under Windows)."
8226 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8227 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8232 #: ../src/guestfs-actions.pod:855
8233 msgid "See also C<guestfs_realpath>."
8238 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:7011
8239 msgid "(Added in 1.0.75)"
8244 #: ../src/guestfs-actions.pod:862
8250 #: ../src/guestfs-actions.pod:864
8254 " guestfs_cat (guestfs_h *g,\n"
8255 " const char *path);\n"
8261 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5479
8262 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3680
8263 msgid "Return the contents of the file named C<path>."
8268 #: ../src/guestfs-actions.pod:870
8270 "Note that this function cannot correctly handle binary files (specifically, "
8271 "files containing C<\\0> character which is treated as end of string). For "
8272 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8273 "functions which have a more complex interface."
8278 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8279 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8280 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8281 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1760
8282 #: ../src/guestfs-actions.pod:2218 ../src/guestfs-actions.pod:2237
8283 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304
8284 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2350
8285 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5287
8286 #: ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5444
8287 #: ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:6396
8288 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6597
8289 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:7290
8290 #: ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7342
8291 #: ../src/guestfs-actions.pod:7361 ../src/guestfs-actions.pod:7446
8292 #: ../src/guestfs-actions.pod:7465 ../src/guestfs-actions.pod:7511
8293 #: ../src/guestfs-actions.pod:7530 ../fish/guestfish-actions.pod:587
8294 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8295 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8296 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8297 #: ../fish/guestfish-actions.pod:1189 ../fish/guestfish-actions.pod:1490
8298 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1528
8299 #: ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1553
8300 #: ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:3550
8301 #: ../fish/guestfish-actions.pod:3565 ../fish/guestfish-actions.pod:3641
8302 #: ../fish/guestfish-actions.pod:3658 ../fish/guestfish-actions.pod:3673
8303 #: ../fish/guestfish-actions.pod:4327 ../fish/guestfish-actions.pod:4373
8304 #: ../fish/guestfish-actions.pod:4458 ../fish/guestfish-actions.pod:4473
8305 #: ../fish/guestfish-actions.pod:4883 ../fish/guestfish-actions.pod:4901
8306 #: ../fish/guestfish-actions.pod:4918 ../fish/guestfish-actions.pod:4928
8307 #: ../fish/guestfish-actions.pod:4976 ../fish/guestfish-actions.pod:4986
8308 #: ../fish/guestfish-actions.pod:5015 ../fish/guestfish-actions.pod:5025
8310 "Because of the message protocol, there is a transfer limit of somewhere "
8311 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8316 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3561
8317 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3640
8318 #: ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4133
8319 #: ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:5367
8320 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7170
8321 #: ../src/guestfs-actions.pod:7184
8322 msgid "(Added in 0.4)"
8327 #: ../src/guestfs-actions.pod:883
8328 msgid "guestfs_checksum"
8333 #: ../src/guestfs-actions.pod:885
8337 " guestfs_checksum (guestfs_h *g,\n"
8338 " const char *csumtype,\n"
8339 " const char *path);\n"
8345 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8347 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8352 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8354 "The type of checksum to compute is given by the C<csumtype> parameter which "
8355 "must have one of the following values:"
8360 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8366 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8368 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8374 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8380 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8381 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8386 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8392 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8393 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8398 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8404 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8405 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8410 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8416 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8417 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8422 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8428 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8429 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8434 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8440 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8441 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8446 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8447 msgid "The checksum is returned as a printable string."
8452 #: ../src/guestfs-actions.pod:931
8453 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8458 #: ../src/guestfs-actions.pod:933
8459 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8464 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8465 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:3300
8466 #: ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3390
8467 #: ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:6867
8468 msgid "(Added in 1.0.2)"
8473 #: ../src/guestfs-actions.pod:940
8474 msgid "guestfs_checksum_device"
8479 #: ../src/guestfs-actions.pod:942
8483 " guestfs_checksum_device (guestfs_h *g,\n"
8484 " const char *csumtype,\n"
8485 " const char *device);\n"
8491 #: ../src/guestfs-actions.pod:947
8493 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8494 "device named C<device>. For the types of checksums supported see the "
8495 "C<guestfs_checksum> command."
8500 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4898
8501 #: ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4994
8502 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5188
8503 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6790
8504 #: ../src/guestfs-actions.pod:7196
8505 msgid "(Added in 1.3.2)"
8510 #: ../src/guestfs-actions.pod:956
8511 msgid "guestfs_checksums_out"
8516 #: ../src/guestfs-actions.pod:958
8520 " guestfs_checksums_out (guestfs_h *g,\n"
8521 " const char *csumtype,\n"
8522 " const char *directory,\n"
8523 " const char *sumsfile);\n"
8529 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8531 "This command computes the checksums of all regular files in C<directory> and "
8532 "then emits a list of those checksums to the local output file C<sumsfile>."
8537 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8539 "This can be used for verifying the integrity of a virtual machine. However "
8540 "to be properly secure you should pay attention to the output of the checksum "
8541 "command (it uses the ones from GNU coreutils). In particular when the "
8542 "filename is not printable, coreutils uses a special backslash syntax. For "
8543 "more information, see the GNU coreutils info file."
8548 #: ../src/guestfs-actions.pod:978
8549 msgid "(Added in 1.3.7)"
8554 #: ../src/guestfs-actions.pod:980
8555 msgid "guestfs_chmod"
8560 #: ../src/guestfs-actions.pod:982
8564 " guestfs_chmod (guestfs_h *g,\n"
8566 " const char *path);\n"
8572 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8574 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8580 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8582 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8583 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8589 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4384
8590 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4600
8591 #: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:676
8592 #: ../fish/guestfish-actions.pod:2980 ../fish/guestfish-actions.pod:3109
8593 #: ../fish/guestfish-actions.pod:3119 ../fish/guestfish-actions.pod:3129
8594 msgid "The mode actually set is affected by the umask."
8599 #: ../src/guestfs-actions.pod:1000
8600 msgid "guestfs_chown"
8605 #: ../src/guestfs-actions.pod:1002
8609 " guestfs_chown (guestfs_h *g,\n"
8612 " const char *path);\n"
8618 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8619 msgid "Change the file owner to C<owner> and group to C<group>."
8624 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3492
8625 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2438
8627 "Only numeric uid and gid are supported. If you want to use names, you will "
8628 "need to locate and parse the password file yourself (Augeas support makes "
8629 "this relatively easy)."
8634 #: ../src/guestfs-actions.pod:1018
8635 msgid "guestfs_command"
8640 #: ../src/guestfs-actions.pod:1020
8644 " guestfs_command (guestfs_h *g,\n"
8645 " char *const *arguments);\n"
8651 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8653 "This call runs a command from the guest filesystem. The filesystem must be "
8654 "mounted, and must contain a compatible operating system (ie. something "
8655 "Linux, with the same or compatible processor architecture)."
8660 #: ../src/guestfs-actions.pod:1029
8662 "The single parameter is an argv-style list of arguments. The first element "
8663 "is the name of the program to run. Subsequent elements are parameters. The "
8664 "list must be non-empty (ie. must contain a program name). Note that the "
8665 "command runs directly, and is I<not> invoked via the shell (see "
8671 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8672 msgid "The return value is anything printed to I<stdout> by the command."
8677 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8679 "If the command returns a non-zero exit status, then this function returns an "
8680 "error message. The error message string is the content of I<stderr> from "
8686 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8688 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8689 "bin>. If you require a program from another location, you should provide "
8690 "the full path in the first parameter."
8695 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8697 "Shared libraries and data files required by the program must be available on "
8698 "filesystems which are mounted in the correct places. It is the caller's "
8699 "responsibility to ensure all filesystems that are needed are mounted at the "
8705 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8706 #: ../src/guestfs-actions.pod:1545
8707 msgid "(Added in 0.9.1)"
8712 #: ../src/guestfs-actions.pod:1062
8713 msgid "guestfs_command_lines"
8718 #: ../src/guestfs-actions.pod:1064
8722 " guestfs_command_lines (guestfs_h *g,\n"
8723 " char *const *arguments);\n"
8729 #: ../src/guestfs-actions.pod:1068
8731 "This is the same as C<guestfs_command>, but splits the result into a list of "
8737 #: ../src/guestfs-actions.pod:1071
8738 msgid "See also: C<guestfs_sh_lines>"
8743 #: ../src/guestfs-actions.pod:1082
8744 msgid "guestfs_config"
8749 #: ../src/guestfs-actions.pod:1084
8753 " guestfs_config (guestfs_h *g,\n"
8754 " const char *qemuparam,\n"
8755 " const char *qemuvalue);\n"
8760 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8762 "This can be used to add arbitrary qemu command line parameters of the form "
8763 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8764 "setting some parameters which would interfere with parameters that we use."
8769 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8770 msgid "The first character of C<param> string must be a C<-> (dash)."
8775 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8776 msgid "C<value> can be NULL."
8781 #: ../src/guestfs-actions.pod:1102
8782 msgid "guestfs_copy_size"
8787 #: ../src/guestfs-actions.pod:1104
8791 " guestfs_copy_size (guestfs_h *g,\n"
8792 " const char *src,\n"
8793 " const char *dest,\n"
8800 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8802 "This command copies exactly C<size> bytes from one source device or file "
8803 "C<src> to another destination device or file C<dest>."
8808 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8810 "Note this will fail if the source is too short or if the destination is not "
8815 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8816 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8817 #: ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1716
8818 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:6862
8819 #: ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7382
8820 #: ../src/guestfs-actions.pod:7401
8822 "This long-running command can generate progress notification messages so "
8823 "that the caller can display a progress bar or indicator. To receive these "
8824 "messages, the caller must register a progress event callback. See L<guestfs"
8825 "(3)/GUESTFS_EVENT_PROGRESS>."
8830 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4160
8831 #: ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:7103
8832 #: ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7209
8833 msgid "(Added in 1.0.87)"
8838 #: ../src/guestfs-actions.pod:1125
8844 #: ../src/guestfs-actions.pod:1127
8848 " guestfs_cp (guestfs_h *g,\n"
8849 " const char *src,\n"
8850 " const char *dest);\n"
8856 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8858 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8859 "destination filename or destination directory."
8864 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8865 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8866 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4852
8867 #: ../src/guestfs-actions.pod:5238
8868 msgid "(Added in 1.0.18)"
8873 #: ../src/guestfs-actions.pod:1139
8874 msgid "guestfs_cp_a"
8879 #: ../src/guestfs-actions.pod:1141
8883 " guestfs_cp_a (guestfs_h *g,\n"
8884 " const char *src,\n"
8885 " const char *dest);\n"
8891 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8893 "This copies a file or directory from C<src> to C<dest> recursively using the "
8899 #: ../src/guestfs-actions.pod:1153
8905 #: ../src/guestfs-actions.pod:1155
8909 " guestfs_dd (guestfs_h *g,\n"
8910 " const char *src,\n"
8911 " const char *dest);\n"
8917 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8919 "This command copies from one source device or file C<src> to another "
8920 "destination device or file C<dest>. Normally you would use this to copy to "
8921 "or from a device or partition, for example to duplicate a filesystem."
8926 #: ../src/guestfs-actions.pod:1165
8928 "If the destination is a device, it must be as large or larger than the "
8929 "source file or device, otherwise the copy will fail. This command cannot do "
8930 "partial copies (see C<guestfs_copy_size>)."
8935 #: ../src/guestfs-actions.pod:1173
8941 #: ../src/guestfs-actions.pod:1175
8945 " guestfs_df (guestfs_h *g);\n"
8951 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8952 msgid "This command runs the C<df> command to report disk space used."
8957 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8959 "This command is mostly useful for interactive sessions. It is I<not> "
8960 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8966 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8967 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2283
8968 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2375
8969 #: ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4752
8970 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6624
8971 #: ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7262
8972 #: ../src/guestfs-actions.pod:7275
8973 msgid "(Added in 1.0.54)"
8978 #: ../src/guestfs-actions.pod:1189
8979 msgid "guestfs_df_h"
8984 #: ../src/guestfs-actions.pod:1191
8988 " guestfs_df_h (guestfs_h *g);\n"
8994 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8996 "This command runs the C<df -h> command to report disk space used in human-"
9002 #: ../src/guestfs-actions.pod:1206
9003 msgid "guestfs_dmesg"
9008 #: ../src/guestfs-actions.pod:1208
9012 " guestfs_dmesg (guestfs_h *g);\n"
9018 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
9020 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9021 "This is sometimes useful for extended debugging of problems."
9026 #: ../src/guestfs-actions.pod:1215
9028 "Another way to get the same information is to enable verbose messages with "
9029 "C<guestfs_set_verbose> or by setting the environment variable "
9030 "C<LIBGUESTFS_DEBUG=1> before running the program."
9035 #: ../src/guestfs-actions.pod:1225
9036 msgid "guestfs_download"
9041 #: ../src/guestfs-actions.pod:1227
9045 " guestfs_download (guestfs_h *g,\n"
9046 " const char *remotefilename,\n"
9047 " const char *filename);\n"
9053 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
9054 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
9056 "Download file C<remotefilename> and save it as C<filename> on the local "
9062 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6856
9063 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4631
9064 msgid "C<filename> can also be a named pipe."
9069 #: ../src/guestfs-actions.pod:1237
9070 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9075 #: ../src/guestfs-actions.pod:1248
9076 msgid "guestfs_download_offset"
9081 #: ../src/guestfs-actions.pod:1250
9085 " guestfs_download_offset (guestfs_h *g,\n"
9086 " const char *remotefilename,\n"
9087 " const char *filename,\n"
9088 " int64_t offset,\n"
9095 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
9097 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9098 "region must be within the file or device)."
9103 #: ../src/guestfs-actions.pod:1263
9105 "Note that there is no limit on the amount of data that can be downloaded "
9106 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9107 "full amount unless an error occurs."
9112 #: ../src/guestfs-actions.pod:1268
9113 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9118 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6901
9119 msgid "(Added in 1.5.17)"
9124 #: ../src/guestfs-actions.pod:1279
9125 msgid "guestfs_drop_caches"
9130 #: ../src/guestfs-actions.pod:1281
9134 " guestfs_drop_caches (guestfs_h *g,\n"
9135 " int whattodrop);\n"
9141 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
9143 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9144 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9145 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9150 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
9151 msgid "Setting C<whattodrop> to 3 should drop everything."
9156 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
9158 "This automatically calls L<sync(2)> before the operation, so that the "
9159 "maximum guest memory is freed."
9164 #: ../src/guestfs-actions.pod:1299
9170 #: ../src/guestfs-actions.pod:1301
9174 " guestfs_du (guestfs_h *g,\n"
9175 " const char *path);\n"
9181 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9183 "This command runs the C<du -s> command to estimate file space usage for "
9189 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9191 "C<path> can be a file or a directory. If C<path> is a directory then the "
9192 "estimate includes the contents of the directory and all subdirectories "
9198 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9200 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9205 #: ../src/guestfs-actions.pod:1324
9206 msgid "guestfs_e2fsck_f"
9211 #: ../src/guestfs-actions.pod:1326
9215 " guestfs_e2fsck_f (guestfs_h *g,\n"
9216 " const char *device);\n"
9221 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9223 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9224 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9230 #: ../src/guestfs-actions.pod:1334
9232 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9233 "Normally you should use C<guestfs_fsck>."
9238 #: ../src/guestfs-actions.pod:1339
9239 msgid "(Added in 1.0.29)"
9244 #: ../src/guestfs-actions.pod:1341
9245 msgid "guestfs_echo_daemon"
9250 #: ../src/guestfs-actions.pod:1343
9254 " guestfs_echo_daemon (guestfs_h *g,\n"
9255 " char *const *words);\n"
9261 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9263 "This command concatenates the list of C<words> passed with single spaces "
9264 "between them and returns the resulting string."
9269 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9270 msgid "You can use this command to test the connection through to the daemon."
9275 #: ../src/guestfs-actions.pod:1352
9276 msgid "See also C<guestfs_ping_daemon>."
9281 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2091
9282 #: ../src/guestfs-actions.pod:6072
9283 msgid "(Added in 1.0.69)"
9288 #: ../src/guestfs-actions.pod:1359
9289 msgid "guestfs_egrep"
9294 #: ../src/guestfs-actions.pod:1361
9298 " guestfs_egrep (guestfs_h *g,\n"
9299 " const char *regex,\n"
9300 " const char *path);\n"
9306 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9308 "This calls the external C<egrep> program and returns the matching lines."
9313 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9314 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9315 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2221
9316 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2396
9317 #: ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2424
9318 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2492
9319 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:3653
9320 #: ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3680
9321 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4680
9322 #: ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5621
9323 #: ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6480
9324 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
9325 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6541
9326 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6567
9327 #: ../src/guestfs-actions.pod:7345 ../src/guestfs-actions.pod:7364
9328 #: ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7468
9329 #: ../src/guestfs-actions.pod:7514 ../src/guestfs-actions.pod:7533
9330 msgid "(Added in 1.0.66)"
9335 #: ../src/guestfs-actions.pod:1378
9336 msgid "guestfs_egrepi"
9341 #: ../src/guestfs-actions.pod:1380
9345 " guestfs_egrepi (guestfs_h *g,\n"
9346 " const char *regex,\n"
9347 " const char *path);\n"
9353 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9355 "This calls the external C<egrep -i> program and returns the matching lines."
9360 #: ../src/guestfs-actions.pod:1397
9361 msgid "guestfs_equal"
9366 #: ../src/guestfs-actions.pod:1399
9370 " guestfs_equal (guestfs_h *g,\n"
9371 " const char *file1,\n"
9372 " const char *file2);\n"
9378 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9380 "This compares the two files C<file1> and C<file2> and returns true if their "
9381 "content is exactly equal, or false otherwise."
9386 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9387 msgid "The external L<cmp(1)> program is used for the comparison."
9392 #: ../src/guestfs-actions.pod:1413
9393 msgid "guestfs_exists"
9398 #: ../src/guestfs-actions.pod:1415
9402 " guestfs_exists (guestfs_h *g,\n"
9403 " const char *path);\n"
9409 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9411 "This returns C<true> if and only if there is a file, directory (or anything) "
9412 "with the given C<path> name."
9417 #: ../src/guestfs-actions.pod:1422
9418 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9423 #: ../src/guestfs-actions.pod:1428
9424 msgid "guestfs_fallocate"
9429 #: ../src/guestfs-actions.pod:1430
9433 " guestfs_fallocate (guestfs_h *g,\n"
9434 " const char *path,\n"
9441 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9442 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9444 "This command preallocates a file (containing zero bytes) named C<path> of "
9445 "size C<len> bytes. If the file exists already, it is overwritten."
9450 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9452 "Do not confuse this with the guestfish-specific C<alloc> command which "
9453 "allocates a file in the host and attaches it as a device."
9458 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9460 "This function is deprecated. In new code, use the C<fallocate64> call "
9466 #: ../src/guestfs-actions.pod:1454
9467 msgid "guestfs_fallocate64"
9472 #: ../src/guestfs-actions.pod:1456
9476 " guestfs_fallocate64 (guestfs_h *g,\n"
9477 " const char *path,\n"
9484 #: ../src/guestfs-actions.pod:1465
9486 "Note that this call allocates disk blocks for the file. To create a sparse "
9487 "file use C<guestfs_truncate_size> instead."
9492 #: ../src/guestfs-actions.pod:1468
9494 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9495 "oversight it only allowed 30 bit lengths to be specified, effectively "
9496 "limiting the maximum size of files created through that call to 1GB."
9501 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9503 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9504 "commands which create a file in the host and attach it as a device."
9509 #: ../src/guestfs-actions.pod:1479
9510 msgid "(Added in 1.3.17)"
9515 #: ../src/guestfs-actions.pod:1481
9516 msgid "guestfs_fgrep"
9521 #: ../src/guestfs-actions.pod:1483
9525 " guestfs_fgrep (guestfs_h *g,\n"
9526 " const char *pattern,\n"
9527 " const char *path);\n"
9533 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9535 "This calls the external C<fgrep> program and returns the matching lines."
9540 #: ../src/guestfs-actions.pod:1500
9541 msgid "guestfs_fgrepi"
9546 #: ../src/guestfs-actions.pod:1502
9550 " guestfs_fgrepi (guestfs_h *g,\n"
9551 " const char *pattern,\n"
9552 " const char *path);\n"
9558 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9560 "This calls the external C<fgrep -i> program and returns the matching lines."
9565 #: ../src/guestfs-actions.pod:1519
9566 msgid "guestfs_file"
9571 #: ../src/guestfs-actions.pod:1521
9575 " guestfs_file (guestfs_h *g,\n"
9576 " const char *path);\n"
9582 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9584 "This call uses the standard L<file(1)> command to determine the type or "
9585 "contents of the file."
9590 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9592 "This call will also transparently look inside various types of compressed "
9597 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9599 "The exact command which runs is C<file -zb path>. Note in particular that "
9600 "the filename is not prepended to the output (the I<-b> option)."
9604 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1014
9606 "The output depends on the output of the underlying L<file(1)> command and it "
9607 "can change in future in ways beyond our control. In other words, the output "
9608 "is not guaranteed by the ABI."
9612 #: ../src/guestfs-actions.pod:1539
9614 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9615 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
9620 #: ../src/guestfs-actions.pod:1547
9621 msgid "guestfs_file_architecture"
9626 #: ../src/guestfs-actions.pod:1549
9630 " guestfs_file_architecture (guestfs_h *g,\n"
9631 " const char *filename);\n"
9637 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1025
9639 "This detects the architecture of the binary C<filename>, and returns it if "
9645 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9646 msgid "Currently defined architectures are:"
9651 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1032
9657 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1034
9659 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9660 "irrespective of the precise processor requirements of the binary."
9665 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9671 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
9672 msgid "64 bit x86-64."
9677 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1041
9683 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1043
9684 msgid "32 bit SPARC."
9689 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1045
9695 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1047
9696 msgid "64 bit SPARC V9 and above."
9701 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1049
9707 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1051
9708 msgid "Intel Itanium."
9713 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1053
9719 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1055
9720 msgid "32 bit Power PC."
9725 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1057
9731 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1059
9732 msgid "64 bit Power PC."
9737 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1063
9738 msgid "Libguestfs may return other architecture strings in future."
9743 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1065
9744 msgid "The function works on at least the following types of files:"
9749 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1071
9750 msgid "many types of Un*x and Linux binary"
9755 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1075
9756 msgid "many types of Un*x and Linux shared library"
9761 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1079
9762 msgid "Windows Win32 and Win64 binaries"
9767 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1083
9768 msgid "Windows Win32 and Win64 DLLs"
9773 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1085
9774 msgid "Win32 binaries and DLLs return C<i386>."
9779 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1087
9780 msgid "Win64 binaries and DLLs return C<x86_64>."
9785 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1091
9786 msgid "Linux kernel modules"
9791 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1095
9792 msgid "Linux new-style initrd images"
9797 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1099
9798 msgid "some non-x86 Linux vmlinuz kernels"
9803 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1103
9804 msgid "What it can't do currently:"
9809 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1109
9810 msgid "static libraries (libfoo.a)"
9815 #: ../src/guestfs-actions.pod:1641 ../fish/guestfish-actions.pod:1113
9816 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9821 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1117
9822 msgid "x86 Linux vmlinuz kernels"
9827 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1119
9829 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9830 "compressed code, and are horribly hard to unpack. If you want to find the "
9831 "architecture of a kernel, use the architecture of the associated initrd or "
9832 "kernel module(s) instead."
9837 #: ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820
9838 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:2528
9839 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2691
9840 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2800
9841 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2927
9842 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3271
9843 #: ../src/guestfs-actions.pod:3403
9844 msgid "(Added in 1.5.3)"
9849 #: ../src/guestfs-actions.pod:1659
9850 msgid "guestfs_filesize"
9855 #: ../src/guestfs-actions.pod:1661
9859 " guestfs_filesize (guestfs_h *g,\n"
9860 " const char *file);\n"
9866 #: ../src/guestfs-actions.pod:1665 ../fish/guestfish-actions.pod:1130
9867 msgid "This command returns the size of C<file> in bytes."
9872 #: ../src/guestfs-actions.pod:1667
9874 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9875 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9876 "devices, use C<guestfs_blockdev_getsize64>."
9881 #: ../src/guestfs-actions.pod:1673
9882 msgid "(Added in 1.0.82)"
9887 #: ../src/guestfs-actions.pod:1675
9888 msgid "guestfs_fill"
9893 #: ../src/guestfs-actions.pod:1677
9897 " guestfs_fill (guestfs_h *g,\n"
9900 " const char *path);\n"
9906 #: ../src/guestfs-actions.pod:1683 ../fish/guestfish-actions.pod:1140
9908 "This command creates a new file called C<path>. The initial content of the "
9909 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9915 #: ../src/guestfs-actions.pod:1687
9917 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9918 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9919 "bytes use C<guestfs_fill_pattern>."
9924 #: ../src/guestfs-actions.pod:1699
9925 msgid "(Added in 1.0.79)"
9930 #: ../src/guestfs-actions.pod:1701
9931 msgid "guestfs_fill_pattern"
9936 #: ../src/guestfs-actions.pod:1703
9940 " guestfs_fill_pattern (guestfs_h *g,\n"
9941 " const char *pattern,\n"
9943 " const char *path);\n"
9949 #: ../src/guestfs-actions.pod:1709
9951 "This function is like C<guestfs_fill> except that it creates a new file of "
9952 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9953 "pattern is truncated if necessary to ensure the length of the file is "
9954 "exactly C<len> bytes."
9959 #: ../src/guestfs-actions.pod:1721
9960 msgid "(Added in 1.3.12)"
9965 #: ../src/guestfs-actions.pod:1723
9966 msgid "guestfs_find"
9971 #: ../src/guestfs-actions.pod:1725
9975 " guestfs_find (guestfs_h *g,\n"
9976 " const char *directory);\n"
9982 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1162
9984 "This command lists out all files and directories, recursively, starting at "
9985 "C<directory>. It is essentially equivalent to running the shell command "
9986 "C<find directory -print> but some post-processing happens on the output, "
9992 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9994 "This returns a list of strings I<without any prefix>. Thus if the directory "
10000 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
10011 #: ../src/guestfs-actions.pod:1741
10013 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10018 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1177
10030 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
10031 msgid "If C<directory> is not a directory, then this command returns an error."
10036 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
10037 msgid "The returned list is sorted."
10042 #: ../src/guestfs-actions.pod:1754
10043 msgid "See also C<guestfs_find0>."
10048 #: ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:4097
10049 #: ../src/guestfs-actions.pod:5656
10050 msgid "(Added in 1.0.27)"
10055 #: ../src/guestfs-actions.pod:1765
10056 msgid "guestfs_find0"
10061 #: ../src/guestfs-actions.pod:1767
10065 " guestfs_find0 (guestfs_h *g,\n"
10066 " const char *directory,\n"
10067 " const char *files);\n"
10073 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1196
10075 "This command lists out all files and directories, recursively, starting at "
10076 "C<directory>, placing the resulting list in the external file called "
10082 #: ../src/guestfs-actions.pod:1776
10084 "This command works the same way as C<guestfs_find> with the following "
10090 #: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1207
10091 msgid "The resulting list is written to an external file."
10096 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1211
10098 "Items (filenames) in the result are separated by C<\\0> characters. See "
10099 "L<find(1)> option I<-print0>."
10104 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
10105 msgid "This command is not limited in the number of names that it can return."
10110 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
10111 msgid "The result list is not sorted."
10116 #: ../src/guestfs-actions.pod:1803
10117 msgid "(Added in 1.0.74)"
10122 #: ../src/guestfs-actions.pod:1805
10123 msgid "guestfs_findfs_label"
10128 #: ../src/guestfs-actions.pod:1807
10132 " guestfs_findfs_label (guestfs_h *g,\n"
10133 " const char *label);\n"
10139 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1231
10141 "This command searches the filesystems and returns the one which has the "
10142 "given label. An error is returned if no such filesystem can be found."
10147 #: ../src/guestfs-actions.pod:1815
10148 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10153 #: ../src/guestfs-actions.pod:1822
10154 msgid "guestfs_findfs_uuid"
10159 #: ../src/guestfs-actions.pod:1824
10163 " guestfs_findfs_uuid (guestfs_h *g,\n"
10164 " const char *uuid);\n"
10170 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1241
10172 "This command searches the filesystems and returns the one which has the "
10173 "given UUID. An error is returned if no such filesystem can be found."
10178 #: ../src/guestfs-actions.pod:1832
10179 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10184 #: ../src/guestfs-actions.pod:1839
10185 msgid "guestfs_fsck"
10190 #: ../src/guestfs-actions.pod:1841
10194 " guestfs_fsck (guestfs_h *g,\n"
10195 " const char *fstype,\n"
10196 " const char *device);\n"
10202 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1251
10204 "This runs the filesystem checker (fsck) on C<device> which should have "
10205 "filesystem type C<fstype>."
10210 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10212 "The returned integer is the status. See L<fsck(8)> for the list of status "
10213 "codes from C<fsck>."
10218 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1263
10219 msgid "Multiple status codes can be summed together."
10224 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1267
10226 "A non-zero return code can mean \"success\", for example if errors have been "
10227 "corrected on the filesystem."
10232 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
10233 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10238 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
10240 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10245 #: ../src/guestfs-actions.pod:1876 ../src/guestfs-actions.pod:7387
10246 msgid "(Added in 1.0.16)"
10251 #: ../src/guestfs-actions.pod:1878
10252 msgid "guestfs_get_append"
10257 #: ../src/guestfs-actions.pod:1880
10261 " guestfs_get_append (guestfs_h *g);\n"
10267 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1283
10269 "Return the additional kernel options which are added to the guest kernel "
10275 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10276 msgid "If C<NULL> then no options are added."
10281 #: ../src/guestfs-actions.pod:1888
10283 "This function returns a string which may be NULL. There is no way to return "
10284 "an error from this function. The string is owned by the guest handle and "
10285 "must I<not> be freed."
10290 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:5334
10291 #: ../src/guestfs-actions.pod:5814 ../src/guestfs-actions.pod:6235
10292 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6270
10293 #: ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:7051
10294 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7430
10295 msgid "(Added in 1.0.26)"
10299 #: ../src/guestfs-actions.pod:1894
10300 msgid "guestfs_get_attach_method"
10304 #: ../src/guestfs-actions.pod:1896
10308 " guestfs_get_attach_method (guestfs_h *g);\n"
10313 #: ../src/guestfs-actions.pod:1899
10314 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10319 #: ../src/guestfs-actions.pod:1904
10320 msgid "guestfs_get_autosync"
10325 #: ../src/guestfs-actions.pod:1906
10329 " guestfs_get_autosync (guestfs_h *g);\n"
10335 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1298
10336 msgid "Get the autosync flag."
10341 #: ../src/guestfs-actions.pod:1915
10342 msgid "guestfs_get_direct"
10347 #: ../src/guestfs-actions.pod:1917
10351 " guestfs_get_direct (guestfs_h *g);\n"
10357 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1304
10358 msgid "Return the direct appliance mode flag."
10363 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:5883
10364 msgid "(Added in 1.0.72)"
10369 #: ../src/guestfs-actions.pod:1926
10370 msgid "guestfs_get_e2label"
10375 #: ../src/guestfs-actions.pod:1928
10379 " guestfs_get_e2label (guestfs_h *g,\n"
10380 " const char *device);\n"
10386 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1310
10388 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10393 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1313
10395 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10400 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:1966
10401 #: ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5920
10402 msgid "(Added in 1.0.15)"
10407 #: ../src/guestfs-actions.pod:1947
10408 msgid "guestfs_get_e2uuid"
10413 #: ../src/guestfs-actions.pod:1949
10417 " guestfs_get_e2uuid (guestfs_h *g,\n"
10418 " const char *device);\n"
10424 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1324
10426 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10431 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1327
10433 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10438 #: ../src/guestfs-actions.pod:1968
10439 msgid "guestfs_get_memsize"
10444 #: ../src/guestfs-actions.pod:1970
10448 " guestfs_get_memsize (guestfs_h *g);\n"
10454 #: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1338
10456 "This gets the memory size in megabytes allocated to the qemu subprocess."
10461 #: ../src/guestfs-actions.pod:1976
10463 "If C<guestfs_set_memsize> was not called on this handle, and if "
10464 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10465 "value for memsize."
10470 #: ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2061
10471 #: ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:6043
10472 #: ../fish/guestfish-actions.pod:1345 ../fish/guestfish-actions.pod:1396
10473 #: ../fish/guestfish-actions.pod:4006 ../fish/guestfish-actions.pod:4093
10475 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10480 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:4388
10481 #: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4604
10482 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4635
10483 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4665
10484 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5941
10485 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6817
10486 msgid "(Added in 1.0.55)"
10491 #: ../src/guestfs-actions.pod:1987
10492 msgid "guestfs_get_network"
10497 #: ../src/guestfs-actions.pod:1989
10501 " guestfs_get_network (guestfs_h *g);\n"
10507 #: ../src/guestfs-actions.pod:1992 ../fish/guestfish-actions.pod:1352
10508 msgid "This returns the enable network flag."
10513 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:5960
10514 msgid "(Added in 1.5.4)"
10519 #: ../src/guestfs-actions.pod:1998
10520 msgid "guestfs_get_path"
10525 #: ../src/guestfs-actions.pod:2000
10529 " guestfs_get_path (guestfs_h *g);\n"
10535 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1358
10536 msgid "Return the current search path."
10541 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1360
10543 "This is always non-NULL. If it wasn't set already, then this will return "
10544 "the default path."
10549 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2037
10551 "This function returns a string, or NULL on error. The string is owned by "
10552 "the guest handle and must I<not> be freed."
10557 #: ../src/guestfs-actions.pod:2013
10558 msgid "guestfs_get_pid"
10563 #: ../src/guestfs-actions.pod:2015
10567 " guestfs_get_pid (guestfs_h *g);\n"
10573 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1369
10575 "Return the process ID of the qemu subprocess. If there is no qemu "
10576 "subprocess, then this will return an error."
10581 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10582 msgid "This is an internal call used for debugging and testing."
10587 #: ../src/guestfs-actions.pod:2025
10588 msgid "(Added in 1.0.56)"
10593 #: ../src/guestfs-actions.pod:2027
10594 msgid "guestfs_get_qemu"
10599 #: ../src/guestfs-actions.pod:2029
10603 " guestfs_get_qemu (guestfs_h *g);\n"
10609 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1378
10610 msgid "Return the current qemu binary."
10615 #: ../src/guestfs-actions.pod:2034 ../fish/guestfish-actions.pod:1380
10617 "This is always non-NULL. If it wasn't set already, then this will return "
10618 "the default qemu binary name."
10623 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:6005
10624 msgid "(Added in 1.0.6)"
10629 #: ../src/guestfs-actions.pod:2042
10630 msgid "guestfs_get_recovery_proc"
10635 #: ../src/guestfs-actions.pod:2044
10639 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10645 #: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1387
10646 msgid "Return the recovery process enabled flag."
10651 #: ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:3498
10652 #: ../src/guestfs-actions.pod:3795 ../src/guestfs-actions.pod:4195
10653 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5264
10654 #: ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:6029
10655 #: ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6740
10656 #: ../src/guestfs-actions.pod:6932
10657 msgid "(Added in 1.0.77)"
10662 #: ../src/guestfs-actions.pod:2053
10663 msgid "guestfs_get_selinux"
10668 #: ../src/guestfs-actions.pod:2055
10672 " guestfs_get_selinux (guestfs_h *g);\n"
10678 #: ../src/guestfs-actions.pod:2058
10680 "This returns the current setting of the selinux flag which is passed to the "
10681 "appliance at boot time. See C<guestfs_set_selinux>."
10686 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2129
10687 #: ../src/guestfs-actions.pod:6048 ../src/guestfs-actions.pod:6106
10688 msgid "(Added in 1.0.67)"
10693 #: ../src/guestfs-actions.pod:2068
10694 msgid "guestfs_get_state"
10699 #: ../src/guestfs-actions.pod:2070
10703 " guestfs_get_state (guestfs_h *g);\n"
10709 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1403
10711 "This returns the current state as an opaque integer. This is only useful "
10712 "for printing debug and internal error messages."
10717 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:3296
10718 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3386
10719 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:1406
10720 #: ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2338
10721 #: ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2392
10722 msgid "For more information on states, see L<guestfs(3)>."
10727 #: ../src/guestfs-actions.pod:2082
10728 msgid "guestfs_get_trace"
10733 #: ../src/guestfs-actions.pod:2084
10737 " guestfs_get_trace (guestfs_h *g);\n"
10743 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
10744 msgid "Return the command trace flag."
10749 #: ../src/guestfs-actions.pod:2093
10750 msgid "guestfs_get_umask"
10755 #: ../src/guestfs-actions.pod:2095
10759 " guestfs_get_umask (guestfs_h *g);\n"
10765 #: ../src/guestfs-actions.pod:2098
10767 "Return the current umask. By default the umask is C<022> unless it has been "
10768 "set by calling C<guestfs_umask>."
10773 #: ../src/guestfs-actions.pod:2105
10774 msgid "guestfs_get_verbose"
10779 #: ../src/guestfs-actions.pod:2107
10783 " guestfs_get_verbose (guestfs_h *g);\n"
10789 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1425
10790 msgid "This returns the verbose messages flag."
10795 #: ../src/guestfs-actions.pod:2116
10796 msgid "guestfs_getcon"
10801 #: ../src/guestfs-actions.pod:2118
10805 " guestfs_getcon (guestfs_h *g);\n"
10811 #: ../src/guestfs-actions.pod:2121 ../fish/guestfish-actions.pod:1431
10812 msgid "This gets the SELinux security context of the daemon."
10817 #: ../src/guestfs-actions.pod:2123
10819 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10824 #: ../src/guestfs-actions.pod:2131
10825 msgid "guestfs_getxattr"
10830 #: ../src/guestfs-actions.pod:2133
10834 " guestfs_getxattr (guestfs_h *g,\n"
10835 " const char *path,\n"
10836 " const char *name,\n"
10837 " size_t *size_r);\n"
10843 #: ../src/guestfs-actions.pod:2139
10845 "Get a single extended attribute from file C<path> named C<name>. This call "
10846 "follows symlinks. If you want to lookup an extended attribute for the "
10847 "symlink itself, use C<guestfs_lgetxattr>."
10852 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:3512
10854 "Normally it is better to get all extended attributes from a file in one go "
10855 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10856 "implementations are buggy and do not provide a way to list out attributes. "
10857 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10858 "extended attributes you want in advance and call this function."
10863 #: ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:3519
10864 #: ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:2457
10866 "Extended attribute values are blobs of binary data. If there is no extended "
10867 "attribute named C<name>, this returns an error."
10872 #: ../src/guestfs-actions.pod:2153
10873 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10878 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2346
10879 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:5257
10880 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5464
10882 "This function returns a buffer, or NULL on error. The size of the returned "
10883 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10888 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
10889 msgid "(Added in 1.7.24)"
10894 #: ../src/guestfs-actions.pod:2161
10895 msgid "guestfs_getxattrs"
10900 #: ../src/guestfs-actions.pod:2163
10903 " struct guestfs_xattr_list *\n"
10904 " guestfs_getxattrs (guestfs_h *g,\n"
10905 " const char *path);\n"
10911 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1460
10913 "This call lists the extended attributes of the file or directory C<path>."
10918 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10920 "At the system call level, this is a combination of the L<listxattr(2)> and "
10921 "L<getxattr(2)> calls."
10926 #: ../src/guestfs-actions.pod:2173
10927 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10932 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:3540
10933 #: ../src/guestfs-actions.pod:4191
10935 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10936 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10941 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3544
10942 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3745
10943 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:6125
10944 #: ../src/guestfs-actions.pod:7495
10945 msgid "(Added in 1.0.59)"
10950 #: ../src/guestfs-actions.pod:2181
10951 msgid "guestfs_glob_expand"
10956 #: ../src/guestfs-actions.pod:2183
10960 " guestfs_glob_expand (guestfs_h *g,\n"
10961 " const char *pattern);\n"
10967 #: ../src/guestfs-actions.pod:2187 ../fish/guestfish-actions.pod:1472
10969 "This command searches for all the pathnames matching C<pattern> according to "
10970 "the wildcard expansion rules used by the shell."
10975 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1476
10977 "If no paths match, then this returns an empty list (note: not an error)."
10982 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10984 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10985 "GLOB_BRACE>. See that manual page for more details."
10990 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:6318
10991 #: ../src/guestfs-actions.pod:6335
10992 msgid "(Added in 1.0.50)"
10997 #: ../src/guestfs-actions.pod:2204
10998 msgid "guestfs_grep"
11003 #: ../src/guestfs-actions.pod:2206
11007 " guestfs_grep (guestfs_h *g,\n"
11008 " const char *regex,\n"
11009 " const char *path);\n"
11015 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1487
11016 msgid "This calls the external C<grep> program and returns the matching lines."
11021 #: ../src/guestfs-actions.pod:2223
11022 msgid "guestfs_grepi"
11027 #: ../src/guestfs-actions.pod:2225
11031 " guestfs_grepi (guestfs_h *g,\n"
11032 " const char *regex,\n"
11033 " const char *path);\n"
11039 #: ../src/guestfs-actions.pod:2230 ../fish/guestfish-actions.pod:1497
11041 "This calls the external C<grep -i> program and returns the matching lines."
11046 #: ../src/guestfs-actions.pod:2242
11047 msgid "guestfs_grub_install"
11052 #: ../src/guestfs-actions.pod:2244
11056 " guestfs_grub_install (guestfs_h *g,\n"
11057 " const char *root,\n"
11058 " const char *device);\n"
11064 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1507
11066 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11067 "the root directory being C<root>."
11072 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
11074 "Note: If grub-install reports the error \"No suitable drive was found in the "
11075 "generated device map.\" it may be that you need to create a C</boot/grub/"
11076 "device.map> file first that contains the mapping between grub device names "
11077 "and Linux device names. It is usually sufficient to create a file "
11083 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1517
11086 " (hd0) /dev/vda\n"
11092 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1519
11093 msgid "replacing C</dev/vda> with the name of the installation device."
11098 #: ../src/guestfs-actions.pod:2265
11099 msgid "(Added in 1.0.17)"
11104 #: ../src/guestfs-actions.pod:2267
11105 msgid "guestfs_head"
11110 #: ../src/guestfs-actions.pod:2269
11114 " guestfs_head (guestfs_h *g,\n"
11115 " const char *path);\n"
11121 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1525
11123 "This command returns up to the first 10 lines of a file as a list of strings."
11128 #: ../src/guestfs-actions.pod:2285
11129 msgid "guestfs_head_n"
11134 #: ../src/guestfs-actions.pod:2287
11138 " guestfs_head_n (guestfs_h *g,\n"
11140 " const char *path);\n"
11146 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1535
11148 "If the parameter C<nrlines> is a positive number, this returns the first "
11149 "C<nrlines> lines of the file C<path>."
11154 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
11156 "If the parameter C<nrlines> is a negative number, this returns lines from "
11157 "the file C<path>, excluding the last C<nrlines> lines."
11162 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:6615
11163 #: ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:4471
11164 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11169 #: ../src/guestfs-actions.pod:2309
11170 msgid "guestfs_hexdump"
11175 #: ../src/guestfs-actions.pod:2311
11179 " guestfs_hexdump (guestfs_h *g,\n"
11180 " const char *path);\n"
11186 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1550
11188 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11189 "readable, canonical hex dump of the file."
11194 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:6399
11195 #: ../src/guestfs-actions.pod:6454
11196 msgid "(Added in 1.0.22)"
11201 #: ../src/guestfs-actions.pod:2326
11202 msgid "guestfs_initrd_cat"
11207 #: ../src/guestfs-actions.pod:2328
11211 " guestfs_initrd_cat (guestfs_h *g,\n"
11212 " const char *initrdpath,\n"
11213 " const char *filename,\n"
11214 " size_t *size_r);\n"
11220 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1560
11222 "This command unpacks the file C<filename> from the initrd file called "
11223 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11229 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1564
11231 "For example, in guestfish you could use the following command to examine the "
11232 "boot script (usually called C</init>) contained in a Linux initrd or "
11238 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1568
11241 " initrd-cat /boot/initrd-<version>.img init\n"
11247 #: ../src/guestfs-actions.pod:2344
11248 msgid "See also C<guestfs_initrd_list>."
11253 #: ../src/guestfs-actions.pod:2355
11254 msgid "guestfs_initrd_list"
11259 #: ../src/guestfs-actions.pod:2357
11263 " guestfs_initrd_list (guestfs_h *g,\n"
11264 " const char *path);\n"
11270 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1579
11271 msgid "This command lists out files contained in an initrd."
11276 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1581
11278 "The files are listed without any initial C</> character. The files are "
11279 "listed in the order they appear (not necessarily alphabetical). Directory "
11280 "names are listed as separate items."
11285 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1585
11287 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11288 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11294 #: ../src/guestfs-actions.pod:2377
11295 msgid "guestfs_inotify_add_watch"
11300 #: ../src/guestfs-actions.pod:2379
11304 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11305 " const char *path,\n"
11312 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1593
11313 msgid "Watch C<path> for the events listed in C<mask>."
11318 #: ../src/guestfs-actions.pod:2386 ../fish/guestfish-actions.pod:1595
11320 "Note that if C<path> is a directory then events within that directory are "
11321 "watched, but this does I<not> happen recursively (in subdirectories)."
11326 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1599
11328 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11329 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11334 #: ../src/guestfs-actions.pod:2398
11335 msgid "guestfs_inotify_close"
11340 #: ../src/guestfs-actions.pod:2400
11344 " guestfs_inotify_close (guestfs_h *g);\n"
11350 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1607
11352 "This closes the inotify handle which was previously opened by inotify_init. "
11353 "It removes all watches, throws away any pending events, and deallocates all "
11359 #: ../src/guestfs-actions.pod:2411
11360 msgid "guestfs_inotify_files"
11365 #: ../src/guestfs-actions.pod:2413
11369 " guestfs_inotify_files (guestfs_h *g);\n"
11375 #: ../src/guestfs-actions.pod:2416
11377 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11378 "returns a list of pathnames of objects that were touched. The returned "
11379 "pathnames are sorted and deduplicated."
11384 #: ../src/guestfs-actions.pod:2426
11385 msgid "guestfs_inotify_init"
11390 #: ../src/guestfs-actions.pod:2428
11394 " guestfs_inotify_init (guestfs_h *g,\n"
11395 " int maxevents);\n"
11401 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1623
11403 "This command creates a new inotify handle. The inotify subsystem can be "
11404 "used to notify events which happen to objects in the guest filesystem."
11409 #: ../src/guestfs-actions.pod:2436
11411 "C<maxevents> is the maximum number of events which will be queued up between "
11412 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11413 "passed as C<0>, then the kernel (or previously set) default is used. For "
11414 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11415 "throws away events, but records the fact that it threw them away by setting "
11416 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11417 "C<guestfs_inotify_read>)."
11422 #: ../src/guestfs-actions.pod:2446
11424 "Before any events are generated, you have to add some watches to the "
11425 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11426 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11431 #: ../src/guestfs-actions.pod:2452
11433 "Queued up events should be read periodically by calling "
11434 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11435 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11436 "often enough then you risk the internal queue overflowing."
11441 #: ../src/guestfs-actions.pod:2459
11443 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11444 "This also removes any watches automatically."
11449 #: ../src/guestfs-actions.pod:2463 ../fish/guestfish-actions.pod:1654
11451 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11452 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11453 "that there is one global inotify handle per libguestfs instance."
11458 #: ../src/guestfs-actions.pod:2472
11459 msgid "guestfs_inotify_read"
11464 #: ../src/guestfs-actions.pod:2474
11467 " struct guestfs_inotify_event_list *\n"
11468 " guestfs_inotify_read (guestfs_h *g);\n"
11474 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1663
11476 "Return the complete queue of events that have happened since the previous "
11482 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11483 msgid "If no events have happened, this returns an empty list."
11488 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
11490 "I<Note>: In order to make sure that all events have been read, you must call "
11491 "this function repeatedly until it returns an empty list. The reason is that "
11492 "the call will read events up to the maximum appliance-to-host message size "
11493 "and leave remaining events in the queue."
11498 #: ../src/guestfs-actions.pod:2488
11500 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11501 "there was an error. I<The caller must call "
11502 "C<guestfs_free_inotify_event_list> after use>."
11507 #: ../src/guestfs-actions.pod:2494
11508 msgid "guestfs_inotify_rm_watch"
11513 #: ../src/guestfs-actions.pod:2496
11517 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11524 #: ../src/guestfs-actions.pod:2500
11526 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11531 #: ../src/guestfs-actions.pod:2507
11532 msgid "guestfs_inspect_get_arch"
11537 #: ../src/guestfs-actions.pod:2509
11541 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11542 " const char *root);\n"
11548 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2536
11549 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2673
11550 #: ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2738
11551 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:2787
11552 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2851
11553 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2911
11554 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2990
11555 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3053
11556 #: ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3093
11557 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3129
11559 "This function should only be called with a root device string as returned by "
11560 "C<guestfs_inspect_os>."
11565 #: ../src/guestfs-actions.pod:2516
11567 "This returns the architecture of the inspected operating system. The "
11568 "possible return values are listed under C<guestfs_file_architecture>."
11573 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1692
11575 "If the architecture could not be determined, then the string C<unknown> is "
11581 #: ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2616
11582 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2747
11583 #: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2867
11584 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:2922
11585 #: ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:3019
11586 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
11587 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3100
11588 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3222
11589 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:1695
11590 #: ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869
11591 #: ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1905
11592 #: ../fish/guestfish-actions.pod:1975 ../fish/guestfish-actions.pod:1999
11593 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2059
11594 #: ../fish/guestfish-actions.pod:2094 ../fish/guestfish-actions.pod:2110
11595 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2139
11596 #: ../fish/guestfish-actions.pod:2152 ../fish/guestfish-actions.pod:2167
11597 #: ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2300
11598 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11603 #: ../src/guestfs-actions.pod:2530
11604 msgid "guestfs_inspect_get_distro"
11609 #: ../src/guestfs-actions.pod:2532
11613 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11614 " const char *root);\n"
11620 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1704
11622 "This returns the distro (distribution) of the inspected operating system."
11627 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11628 msgid "Currently defined distros are:"
11633 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1711
11634 msgid "\"archlinux\""
11639 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1713
11640 msgid "Arch Linux."
11644 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1715
11649 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1717
11655 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1719
11661 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1721
11667 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1723
11673 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1725
11679 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1727
11685 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1729
11691 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
11692 msgid "\"linuxmint\""
11697 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1733
11698 msgid "Linux Mint."
11703 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1735
11704 msgid "\"mandriva\""
11709 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1737
11715 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1739
11721 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1741
11727 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1743
11733 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1745
11739 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1747
11740 msgid "\"redhat-based\""
11745 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1749
11746 msgid "Some Red Hat-derived distro."
11751 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1751
11756 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1753
11757 msgid "Red Hat Enterprise Linux."
11761 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1755
11762 msgid "\"scientificlinux\""
11766 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1757
11767 msgid "Scientific Linux."
11771 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1759
11772 msgid "\"slackware\""
11776 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1761
11782 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1763
11788 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1765
11794 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2718
11795 #: ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:1767
11796 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:2085
11797 msgid "\"unknown\""
11802 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1769
11803 msgid "The distro could not be determined."
11808 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3002
11809 #: ../fish/guestfish-actions.pod:1771 ../fish/guestfish-actions.pod:2077
11810 msgid "\"windows\""
11815 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1773
11817 "Windows does not have distributions. This string is returned if the OS type "
11823 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
11824 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1778
11825 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:2091
11827 "Future versions of libguestfs may return other strings here. The caller "
11828 "should be prepared to handle any string."
11832 #: ../src/guestfs-actions.pod:2623
11833 msgid "guestfs_inspect_get_drive_mappings"
11837 #: ../src/guestfs-actions.pod:2625
11841 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11842 " const char *root);\n"
11847 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
11849 "This call is useful for Windows which uses a primitive system of assigning "
11850 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11851 "Windows Registry to find out how disks/partitions are mapped to drive "
11852 "letters, and returns a hash table as in the example below:"
11856 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1796
11859 " C => /dev/vda2\n"
11860 " E => /dev/vdb1\n"
11861 " F => /dev/vdc1\n"
11866 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1800
11868 "Note that keys are drive letters. For Windows, the key is case insensitive "
11869 "and just contains the drive letter, without the customary colon separator "
11874 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
11876 "In future we may support other operating systems that also used drive "
11877 "letters, but the keys for those might not be case insensitive and might be "
11878 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11883 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
11885 "For Windows guests, currently only hard drive mappings are returned. "
11886 "Removable disks (eg. DVD-ROMs) are ignored."
11890 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
11892 "For guests that do not use drive mappings, or if the drive mappings could "
11893 "not be determined, this returns an empty hash table."
11897 #: ../src/guestfs-actions.pod:2657
11899 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11900 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11905 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2837
11906 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:4814
11907 #: ../src/guestfs-actions.pod:6756
11909 "This function returns a NULL-terminated array of strings, or NULL if there "
11910 "was an error. The array of strings will always have length C<2n+1>, where "
11911 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11912 "caller must free the strings and the array after use>."
11917 #: ../src/guestfs-actions.pod:2667
11918 msgid "guestfs_inspect_get_filesystems"
11923 #: ../src/guestfs-actions.pod:2669
11927 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11928 " const char *root);\n"
11934 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
11936 "This returns a list of all the filesystems that we think are associated with "
11937 "this operating system. This includes the root filesystem, other ordinary "
11938 "filesystems, and non-mounted devices like swap partitions."
11943 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
11945 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11946 "to be shared between operating systems."
11951 #: ../src/guestfs-actions.pod:2684
11953 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11954 "C<guestfs_inspect_get_mountpoints>."
11958 #: ../src/guestfs-actions.pod:2693
11959 msgid "guestfs_inspect_get_format"
11963 #: ../src/guestfs-actions.pod:2695
11967 " guestfs_inspect_get_format (guestfs_h *g,\n"
11968 " const char *root);\n"
11973 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1844
11975 "This returns the format of the inspected operating system. You can use it "
11976 "to detect install images, live CDs and similar."
11980 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
11981 msgid "Currently defined formats are:"
11985 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1851
11986 msgid "\"installed\""
11990 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1853
11991 msgid "This is an installed operating system."
11995 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1855
11996 msgid "\"installer\""
12000 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
12002 "The disk image being inspected is not an installed operating system, but a "
12003 "I<bootable> install disk, live CD, or similar."
12007 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
12008 msgid "The format of this disk image is not known."
12013 #: ../src/guestfs-actions.pod:2732
12014 msgid "guestfs_inspect_get_hostname"
12019 #: ../src/guestfs-actions.pod:2734
12023 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12024 " const char *root);\n"
12030 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1878
12032 "This function returns the hostname of the operating system as found by "
12033 "inspection of the guest's configuration files."
12038 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
12040 "If the hostname could not be determined, then the string C<unknown> is "
12046 #: ../src/guestfs-actions.pod:2752
12047 msgid "(Added in 1.7.9)"
12052 #: ../src/guestfs-actions.pod:2754
12053 msgid "guestfs_inspect_get_major_version"
12058 #: ../src/guestfs-actions.pod:2756
12062 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12063 " const char *root);\n"
12069 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1893
12071 "This returns the major version number of the inspected operating system."
12076 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
12078 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12079 "popular public names used by the operating system. Notably the operating "
12080 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12081 "1). You can find out the real versions corresponding to releases of Windows "
12082 "by consulting Wikipedia or MSDN."
12087 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2793
12088 #: ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1917
12089 msgid "If the version could not be determined, then C<0> is returned."
12094 #: ../src/guestfs-actions.pod:2781
12095 msgid "guestfs_inspect_get_minor_version"
12100 #: ../src/guestfs-actions.pod:2783
12104 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12105 " const char *root);\n"
12111 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1914
12113 "This returns the minor version number of the inspected operating system."
12118 #: ../src/guestfs-actions.pod:2795
12120 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12121 "C<guestfs_inspect_get_major_version>."
12126 #: ../src/guestfs-actions.pod:2802
12127 msgid "guestfs_inspect_get_mountpoints"
12132 #: ../src/guestfs-actions.pod:2804
12136 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12137 " const char *root);\n"
12142 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1929
12144 "This returns a hash of where we think the filesystems associated with this "
12145 "operating system should be mounted. Callers should note that this is at "
12146 "best an educated guess made by reading configuration files such as C</etc/"
12147 "fstab>. I<In particular note> that this may return filesystems which are "
12148 "non-existent or not mountable and callers should be prepared to handle or "
12149 "ignore failures if they try to mount them."
12154 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
12156 "Each element in the returned hashtable has a key which is the path of the "
12157 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12158 "mounted there (eg. C</dev/sda1>)."
12163 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
12165 "Non-mounted devices such as swap devices are I<not> returned in this list."
12169 #: ../src/guestfs-actions.pod:2828
12171 "For operating systems like Windows which still use drive letters, this call "
12172 "will only return an entry for the first drive \"mounted on\" C</>. For "
12173 "information about the mapping of drive letters to partitions, see "
12174 "C<guestfs_inspect_get_drive_mappings>."
12179 #: ../src/guestfs-actions.pod:2834
12181 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12182 "C<guestfs_inspect_get_filesystems>."
12187 #: ../src/guestfs-actions.pod:2845
12188 msgid "guestfs_inspect_get_package_format"
12193 #: ../src/guestfs-actions.pod:2847
12197 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12198 " const char *root);\n"
12204 #: ../src/guestfs-actions.pod:2854
12206 "This function and C<guestfs_inspect_get_package_management> return the "
12207 "package format and package management tool used by the inspected operating "
12208 "system. For example for Fedora these functions would return C<rpm> (package "
12209 "format) and C<yum> (package management)."
12214 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1968
12216 "This returns the string C<unknown> if we could not determine the package "
12217 "format I<or> if the operating system does not have a real packaging system "
12223 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1972
12225 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12226 "Future versions of libguestfs may return other strings."
12231 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903
12232 msgid "(Added in 1.7.5)"
12237 #: ../src/guestfs-actions.pod:2874
12238 msgid "guestfs_inspect_get_package_management"
12243 #: ../src/guestfs-actions.pod:2876
12247 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12248 " const char *root);\n"
12254 #: ../src/guestfs-actions.pod:2883
12256 "C<guestfs_inspect_get_package_format> and this function return the package "
12257 "format and package management tool used by the inspected operating system. "
12258 "For example for Fedora these functions would return C<rpm> (package format) "
12259 "and C<yum> (package management)."
12264 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1990
12266 "This returns the string C<unknown> if we could not determine the package "
12267 "management tool I<or> if the operating system does not have a real packaging "
12268 "system (eg. Windows)."
12273 #: ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1994
12275 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12276 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12277 "libguestfs may return other strings."
12282 #: ../src/guestfs-actions.pod:2905
12283 msgid "guestfs_inspect_get_product_name"
12288 #: ../src/guestfs-actions.pod:2907
12292 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12293 " const char *root);\n"
12299 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
12301 "This returns the product name of the inspected operating system. The "
12302 "product name is generally some freeform string which can be displayed to the "
12303 "user, but should not be parsed by programs."
12308 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
12310 "If the product name could not be determined, then the string C<unknown> is "
12315 #: ../src/guestfs-actions.pod:2929
12316 msgid "guestfs_inspect_get_product_variant"
12320 #: ../src/guestfs-actions.pod:2931
12324 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12325 " const char *root);\n"
12330 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2025
12331 msgid "This returns the product variant of the inspected operating system."
12335 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
12337 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12338 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12339 "is usually a string such as C<Client> or C<Server> (other values are "
12340 "possible). This can be used to distinguish consumer and enterprise versions "
12341 "of Windows that have the same version number (for example, Windows 7 and "
12342 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12343 "the latter is C<Server>)."
12347 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2037
12349 "For enterprise Linux guests, in future we intend this to return the product "
12350 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12351 "implemented at present."
12355 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2041
12357 "If the product variant could not be determined, then the string C<unknown> "
12362 #: ../src/guestfs-actions.pod:2957
12364 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12365 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12370 #: ../src/guestfs-actions.pod:2964
12371 msgid "guestfs_inspect_get_roots"
12376 #: ../src/guestfs-actions.pod:2966
12380 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12386 #: ../src/guestfs-actions.pod:2969
12388 "This function is a convenient way to get the list of root devices, as "
12389 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12390 "the whole inspection process."
12395 #: ../src/guestfs-actions.pod:2973
12397 "This returns an empty list if either no root devices were found or the "
12398 "caller has not called C<guestfs_inspect_os>."
12403 #: ../src/guestfs-actions.pod:2982
12404 msgid "(Added in 1.7.3)"
12409 #: ../src/guestfs-actions.pod:2984
12410 msgid "guestfs_inspect_get_type"
12415 #: ../src/guestfs-actions.pod:2986
12419 " guestfs_inspect_get_type (guestfs_h *g,\n"
12420 " const char *root);\n"
12426 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
12428 "This returns the type of the inspected operating system. Currently defined "
12434 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
12440 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2075
12441 msgid "Any Linux-based operating system."
12446 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2079
12447 msgid "Any Microsoft Windows operating system."
12452 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2081
12453 msgid "\"freebsd\""
12458 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2083
12464 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2087
12465 msgid "The operating system type could not be determined."
12469 #: ../src/guestfs-actions.pod:3026
12470 msgid "guestfs_inspect_get_windows_current_control_set"
12474 #: ../src/guestfs-actions.pod:3028
12478 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12479 " const char *root);\n"
12484 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2103
12486 "This returns the Windows CurrentControlSet of the inspected guest. The "
12487 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12491 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
12493 "This call assumes that the guest is Windows and that the Registry could be "
12494 "examined by inspection. If this is not the case then an error is returned."
12499 #: ../src/guestfs-actions.pod:3047
12500 msgid "guestfs_inspect_get_windows_systemroot"
12505 #: ../src/guestfs-actions.pod:3049
12509 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12510 " const char *root);\n"
12516 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2119
12518 "This returns the Windows systemroot of the inspected guest. The systemroot "
12519 "is a directory path such as C</WINDOWS>."
12524 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
12526 "This call assumes that the guest is Windows and that the systemroot could be "
12527 "determined by inspection. If this is not the case then an error is returned."
12532 #: ../src/guestfs-actions.pod:3068
12533 msgid "(Added in 1.5.25)"
12537 #: ../src/guestfs-actions.pod:3070
12538 msgid "guestfs_inspect_is_live"
12542 #: ../src/guestfs-actions.pod:3072
12546 " guestfs_inspect_is_live (guestfs_h *g,\n"
12547 " const char *root);\n"
12552 #: ../src/guestfs-actions.pod:3079
12554 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12555 "disk), then this returns true if a live image was detected on the disk."
12559 #: ../src/guestfs-actions.pod:3087
12560 msgid "guestfs_inspect_is_multipart"
12564 #: ../src/guestfs-actions.pod:3089
12568 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12569 " const char *root);\n"
12574 #: ../src/guestfs-actions.pod:3096
12576 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12577 "disk), then this returns true if the disk is part of a set."
12581 #: ../src/guestfs-actions.pod:3104
12582 msgid "guestfs_inspect_is_netinst"
12586 #: ../src/guestfs-actions.pod:3106
12590 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12591 " const char *root);\n"
12596 #: ../src/guestfs-actions.pod:3113
12598 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12599 "disk), then this returns true if the disk is a network installer, ie. not a "
12600 "self-contained install CD but one which is likely to require network access "
12601 "to complete the install."
12606 #: ../src/guestfs-actions.pod:3123
12607 msgid "guestfs_inspect_list_applications"
12612 #: ../src/guestfs-actions.pod:3125
12615 " struct guestfs_application_list *\n"
12616 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12617 " const char *root);\n"
12623 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2176
12624 msgid "Return the list of applications installed in the operating system."
12629 #: ../src/guestfs-actions.pod:3134
12631 "I<Note:> This call works differently from other parts of the inspection "
12632 "API. You have to call C<guestfs_inspect_os>, then "
12633 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12634 "this. Listing applications is a significantly more difficult operation "
12635 "which requires access to the full filesystem. Also note that unlike the "
12636 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12637 "the libguestfs handle, this call actually reads parts of the mounted "
12638 "filesystems during the call."
12643 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2188
12645 "This returns an empty list if the inspection code was not able to determine "
12646 "the list of applications."
12651 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
12652 msgid "The application structure contains the following fields:"
12657 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
12658 msgid "C<app_name>"
12663 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
12665 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12666 "guests, this is the package name."
12671 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12672 msgid "C<app_display_name>"
12677 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
12679 "The display name of the application, sometimes localized to the install "
12680 "language of the guest operating system."
12685 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12687 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12688 "to display something can use C<app_name> instead."
12693 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12694 msgid "C<app_epoch>"
12699 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
12701 "For package managers which use epochs, this contains the epoch of the "
12702 "package (an integer). If unavailable, this is returned as C<0>."
12707 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12708 msgid "C<app_version>"
12713 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
12715 "The version string of the application or package. If unavailable this is "
12716 "returned as an empty string C<\"\">."
12721 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
12722 msgid "C<app_release>"
12727 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
12729 "The release string of the application or package, for package managers that "
12730 "use this. If unavailable this is returned as an empty string C<\"\">."
12735 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
12736 msgid "C<app_install_path>"
12741 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
12743 "The installation path of the application (on operating systems such as "
12744 "Windows which use installation paths). This path is in the format used by "
12745 "the guest operating system, it is not a libguestfs path."
12750 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
12751 msgid "If unavailable this is returned as an empty string C<\"\">."
12756 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
12757 msgid "C<app_trans_path>"
12762 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
12764 "The install path translated into a libguestfs path. If unavailable this is "
12765 "returned as an empty string C<\"\">."
12770 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
12771 msgid "C<app_publisher>"
12776 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
12778 "The name of the publisher of the application, for package managers that use "
12779 "this. If unavailable this is returned as an empty string C<\"\">."
12784 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
12790 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
12792 "The URL (eg. upstream URL) of the application. If unavailable this is "
12793 "returned as an empty string C<\"\">."
12798 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12799 msgid "C<app_source_package>"
12804 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
12806 "For packaging systems which support this, the name of the source package. "
12807 "If unavailable this is returned as an empty string C<\"\">."
12812 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12813 msgid "C<app_summary>"
12818 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
12820 "A short (usually one line) description of the application or package. If "
12821 "unavailable this is returned as an empty string C<\"\">."
12826 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
12827 msgid "C<app_description>"
12832 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
12834 "A longer description of the application or package. If unavailable this is "
12835 "returned as an empty string C<\"\">."
12840 #: ../src/guestfs-actions.pod:3224
12842 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12843 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12849 #: ../src/guestfs-actions.pod:3228
12850 msgid "(Added in 1.7.8)"
12855 #: ../src/guestfs-actions.pod:3230
12856 msgid "guestfs_inspect_os"
12861 #: ../src/guestfs-actions.pod:3232
12865 " guestfs_inspect_os (guestfs_h *g);\n"
12871 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2272
12873 "This function uses other libguestfs functions and certain heuristics to "
12874 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12875 "for operating systems."
12880 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2276
12881 msgid "The list returned is empty if no operating systems were found."
12886 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2278
12888 "If one operating system was found, then this returns a list with a single "
12889 "element, which is the name of the root filesystem of this operating system. "
12890 "It is also possible for this function to return a list containing more than "
12891 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12892 "element being the root filesystem of one of the operating systems."
12897 #: ../src/guestfs-actions.pod:3248
12899 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12900 "functions in order to query further information about each operating system, "
12901 "such as the name and version."
12906 #: ../src/guestfs-actions.pod:3253
12908 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12909 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12910 "the contents. This should be called with no disks currently mounted. The "
12911 "function may also use Augeas, so any existing Augeas handle will be closed."
12916 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2296
12918 "This function cannot decrypt encrypted disks. The caller must do that first "
12919 "(supplying the necessary keys) if the disk is encrypted."
12924 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3555
12925 #: ../src/guestfs-actions.pod:3617
12926 msgid "See also C<guestfs_list_filesystems>."
12931 #: ../src/guestfs-actions.pod:3273
12932 msgid "guestfs_is_blockdev"
12937 #: ../src/guestfs-actions.pod:3275
12941 " guestfs_is_blockdev (guestfs_h *g,\n"
12942 " const char *path);\n"
12948 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2308
12950 "This returns C<true> if and only if there is a block device with the given "
12956 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3311
12957 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:3356
12958 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3428
12959 #: ../src/guestfs-actions.pod:3443
12960 msgid "See also C<guestfs_stat>."
12965 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3315
12966 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3432
12967 #: ../src/guestfs-actions.pod:3447
12968 msgid "(Added in 1.5.10)"
12973 #: ../src/guestfs-actions.pod:3288
12974 msgid "guestfs_is_busy"
12979 #: ../src/guestfs-actions.pod:3290
12983 " guestfs_is_busy (guestfs_h *g);\n"
12989 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2317
12991 "This returns true iff this handle is busy processing a command (in the "
12997 #: ../src/guestfs-actions.pod:3302
12998 msgid "guestfs_is_chardev"
13003 #: ../src/guestfs-actions.pod:3304
13007 " guestfs_is_chardev (guestfs_h *g,\n"
13008 " const char *path);\n"
13014 #: ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:2326
13016 "This returns C<true> if and only if there is a character device with the "
13017 "given C<path> name."
13022 #: ../src/guestfs-actions.pod:3317
13023 msgid "guestfs_is_config"
13028 #: ../src/guestfs-actions.pod:3319
13032 " guestfs_is_config (guestfs_h *g);\n"
13038 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2335
13040 "This returns true iff this handle is being configured (in the C<CONFIG> "
13046 #: ../src/guestfs-actions.pod:3331
13047 msgid "guestfs_is_dir"
13052 #: ../src/guestfs-actions.pod:3333
13056 " guestfs_is_dir (guestfs_h *g,\n"
13057 " const char *path);\n"
13063 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2344
13065 "This returns C<true> if and only if there is a directory with the given "
13066 "C<path> name. Note that it returns false for other objects like files."
13071 #: ../src/guestfs-actions.pod:3347
13072 msgid "guestfs_is_fifo"
13077 #: ../src/guestfs-actions.pod:3349
13081 " guestfs_is_fifo (guestfs_h *g,\n"
13082 " const char *path);\n"
13088 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2354
13090 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13091 "given C<path> name."
13096 #: ../src/guestfs-actions.pod:3362
13097 msgid "guestfs_is_file"
13102 #: ../src/guestfs-actions.pod:3364
13106 " guestfs_is_file (guestfs_h *g,\n"
13107 " const char *path);\n"
13113 #: ../src/guestfs-actions.pod:3368 ../fish/guestfish-actions.pod:2363
13115 "This returns C<true> if and only if there is a regular file with the given "
13116 "C<path> name. Note that it returns false for other objects like directories."
13121 #: ../src/guestfs-actions.pod:3378
13122 msgid "guestfs_is_launching"
13127 #: ../src/guestfs-actions.pod:3380
13131 " guestfs_is_launching (guestfs_h *g);\n"
13137 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2373
13139 "This returns true iff this handle is launching the subprocess (in the "
13140 "C<LAUNCHING> state)."
13145 #: ../src/guestfs-actions.pod:3392
13146 msgid "guestfs_is_lv"
13151 #: ../src/guestfs-actions.pod:3394
13155 " guestfs_is_lv (guestfs_h *g,\n"
13156 " const char *device);\n"
13162 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2382
13164 "This command tests whether C<device> is a logical volume, and returns true "
13165 "iff this is the case."
13170 #: ../src/guestfs-actions.pod:3405
13171 msgid "guestfs_is_ready"
13176 #: ../src/guestfs-actions.pod:3407
13180 " guestfs_is_ready (guestfs_h *g);\n"
13186 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2389
13188 "This returns true iff this handle is ready to accept commands (in the "
13194 #: ../src/guestfs-actions.pod:3419
13195 msgid "guestfs_is_socket"
13200 #: ../src/guestfs-actions.pod:3421
13204 " guestfs_is_socket (guestfs_h *g,\n"
13205 " const char *path);\n"
13211 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2398
13213 "This returns C<true> if and only if there is a Unix domain socket with the "
13214 "given C<path> name."
13219 #: ../src/guestfs-actions.pod:3434
13220 msgid "guestfs_is_symlink"
13225 #: ../src/guestfs-actions.pod:3436
13229 " guestfs_is_symlink (guestfs_h *g,\n"
13230 " const char *path);\n"
13236 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:2407
13238 "This returns C<true> if and only if there is a symbolic link with the given "
13244 #: ../src/guestfs-actions.pod:3449
13245 msgid "guestfs_kill_subprocess"
13250 #: ../src/guestfs-actions.pod:3451
13254 " guestfs_kill_subprocess (guestfs_h *g);\n"
13260 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2416
13261 msgid "This kills the qemu subprocess. You should never need to call this."
13266 #: ../src/guestfs-actions.pod:3460
13267 msgid "guestfs_launch"
13272 #: ../src/guestfs-actions.pod:3462
13276 " guestfs_launch (guestfs_h *g);\n"
13282 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2424
13284 "Internally libguestfs is implemented by running a virtual machine using "
13290 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
13292 "You should call this after configuring the handle (eg. adding drives) but "
13293 "before performing any actions."
13298 #: ../src/guestfs-actions.pod:3480
13299 msgid "guestfs_lchown"
13304 #: ../src/guestfs-actions.pod:3482
13308 " guestfs_lchown (guestfs_h *g,\n"
13311 " const char *path);\n"
13317 #: ../src/guestfs-actions.pod:3488
13319 "Change the file owner to C<owner> and group to C<group>. This is like "
13320 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13321 "changed, not the target."
13326 #: ../src/guestfs-actions.pod:3500
13327 msgid "guestfs_lgetxattr"
13332 #: ../src/guestfs-actions.pod:3502
13336 " guestfs_lgetxattr (guestfs_h *g,\n"
13337 " const char *path,\n"
13338 " const char *name,\n"
13339 " size_t *size_r);\n"
13345 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2446
13347 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13348 "is a symlink, then this call returns an extended attribute from the symlink."
13353 #: ../src/guestfs-actions.pod:3522
13354 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13359 #: ../src/guestfs-actions.pod:3530
13360 msgid "guestfs_lgetxattrs"
13365 #: ../src/guestfs-actions.pod:3532
13368 " struct guestfs_xattr_list *\n"
13369 " guestfs_lgetxattrs (guestfs_h *g,\n"
13370 " const char *path);\n"
13376 #: ../src/guestfs-actions.pod:3536
13378 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13379 "then it returns the extended attributes of the link itself."
13384 #: ../src/guestfs-actions.pod:3546
13385 msgid "guestfs_list_devices"
13390 #: ../src/guestfs-actions.pod:3548
13394 " guestfs_list_devices (guestfs_h *g);\n"
13400 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2474
13401 msgid "List all the block devices."
13406 #: ../src/guestfs-actions.pod:3553 ../fish/guestfish-actions.pod:2476
13407 msgid "The full block device names are returned, eg. C</dev/sda>."
13412 #: ../src/guestfs-actions.pod:3563
13413 msgid "guestfs_list_filesystems"
13418 #: ../src/guestfs-actions.pod:3565
13422 " guestfs_list_filesystems (guestfs_h *g);\n"
13428 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2484
13430 "This inspection command looks for filesystems on partitions, block devices "
13431 "and logical volumes, returning a list of devices containing filesystems and "
13437 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2488
13439 "The return value is a hash, where the keys are the devices containing "
13440 "filesystems, and the values are the filesystem types. For example:"
13445 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
13448 " \"/dev/sda1\" => \"ntfs\"\n"
13449 " \"/dev/sda2\" => \"ext2\"\n"
13450 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13451 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13457 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
13459 "The value can have the special value \"unknown\", meaning the content of the "
13460 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13465 #: ../src/guestfs-actions.pod:3585
13467 "This command runs other libguestfs commands, which might include "
13468 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13469 "soon after launch and only when nothing is mounted."
13474 #: ../src/guestfs-actions.pod:3589
13476 "Not all of the filesystems returned will be mountable. In particular, swap "
13477 "partitions are returned in the list. Also this command does not check that "
13478 "each filesystem found is valid and mountable, and some filesystems might be "
13479 "mountable but require special options. Filesystems may not all belong to a "
13480 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13485 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:5224
13486 msgid "(Added in 1.5.15)"
13491 #: ../src/guestfs-actions.pod:3605
13492 msgid "guestfs_list_partitions"
13497 #: ../src/guestfs-actions.pod:3607
13501 " guestfs_list_partitions (guestfs_h *g);\n"
13507 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
13508 msgid "List all the partitions detected on all block devices."
13513 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2519
13514 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13519 #: ../src/guestfs-actions.pod:3614
13521 "This does not return logical volumes. For that you will need to call "
13527 #: ../src/guestfs-actions.pod:3625
13533 #: ../src/guestfs-actions.pod:3627
13537 " guestfs_ll (guestfs_h *g,\n"
13538 " const char *directory);\n"
13544 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2530
13546 "List the files in C<directory> (relative to the root directory, there is no "
13547 "cwd) in the format of 'ls -la'."
13552 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
13554 "This command is mostly useful for interactive sessions. It is I<not> "
13555 "intended that you try to parse the output string."
13560 #: ../src/guestfs-actions.pod:3642
13566 #: ../src/guestfs-actions.pod:3644
13570 " guestfs_ln (guestfs_h *g,\n"
13571 " const char *target,\n"
13572 " const char *linkname);\n"
13578 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2540
13579 msgid "This command creates a hard link using the C<ln> command."
13584 #: ../src/guestfs-actions.pod:3655
13585 msgid "guestfs_ln_f"
13590 #: ../src/guestfs-actions.pod:3657
13594 " guestfs_ln_f (guestfs_h *g,\n"
13595 " const char *target,\n"
13596 " const char *linkname);\n"
13601 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2546
13603 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13604 "option removes the link (C<linkname>) if it exists already."
13609 #: ../src/guestfs-actions.pod:3669
13610 msgid "guestfs_ln_s"
13615 #: ../src/guestfs-actions.pod:3671
13619 " guestfs_ln_s (guestfs_h *g,\n"
13620 " const char *target,\n"
13621 " const char *linkname);\n"
13627 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2553
13628 msgid "This command creates a symbolic link using the C<ln -s> command."
13633 #: ../src/guestfs-actions.pod:3682
13634 msgid "guestfs_ln_sf"
13639 #: ../src/guestfs-actions.pod:3684
13643 " guestfs_ln_sf (guestfs_h *g,\n"
13644 " const char *target,\n"
13645 " const char *linkname);\n"
13650 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2559
13652 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13653 "option removes the link (C<linkname>) if it exists already."
13658 #: ../src/guestfs-actions.pod:3696
13659 msgid "guestfs_lremovexattr"
13664 #: ../src/guestfs-actions.pod:3698
13668 " guestfs_lremovexattr (guestfs_h *g,\n"
13669 " const char *xattr,\n"
13670 " const char *path);\n"
13676 #: ../src/guestfs-actions.pod:3703
13678 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13679 "link, then it removes an extended attribute of the link itself."
13684 #: ../src/guestfs-actions.pod:3711
13690 #: ../src/guestfs-actions.pod:3713
13694 " guestfs_ls (guestfs_h *g,\n"
13695 " const char *directory);\n"
13701 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2574
13703 "List the files in C<directory> (relative to the root directory, there is no "
13704 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13709 #: ../src/guestfs-actions.pod:3721
13711 "This command is mostly useful for interactive sessions. Programs should "
13712 "probably use C<guestfs_readdir> instead."
13717 #: ../src/guestfs-actions.pod:3730
13718 msgid "guestfs_lsetxattr"
13723 #: ../src/guestfs-actions.pod:3732
13727 " guestfs_lsetxattr (guestfs_h *g,\n"
13728 " const char *xattr,\n"
13729 " const char *val,\n"
13731 " const char *path);\n"
13737 #: ../src/guestfs-actions.pod:3739
13739 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13740 "then it sets an extended attribute of the link itself."
13745 #: ../src/guestfs-actions.pod:3747
13746 msgid "guestfs_lstat"
13751 #: ../src/guestfs-actions.pod:3749
13754 " struct guestfs_stat *\n"
13755 " guestfs_lstat (guestfs_h *g,\n"
13756 " const char *path);\n"
13762 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:6355
13763 #: ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:4306
13764 msgid "Returns file information for the given C<path>."
13769 #: ../src/guestfs-actions.pod:3755
13771 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13772 "link, then the link is stat-ed, not the file it refers to."
13777 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2599
13778 msgid "This is the same as the C<lstat(2)> system call."
13783 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:6359
13785 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13786 "error. I<The caller must call C<guestfs_free_stat> after use>."
13791 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:6363
13792 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6762
13793 msgid "(Added in 0.9.2)"
13798 #: ../src/guestfs-actions.pod:3767
13799 msgid "guestfs_lstatlist"
13804 #: ../src/guestfs-actions.pod:3769
13807 " struct guestfs_stat_list *\n"
13808 " guestfs_lstatlist (guestfs_h *g,\n"
13809 " const char *path,\n"
13810 " char *const *names);\n"
13816 #: ../src/guestfs-actions.pod:3774
13818 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13819 "files, where all files are in the directory C<path>. C<names> is the list "
13820 "of files from this directory."
13825 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2609
13827 "On return you get a list of stat structs, with a one-to-one correspondence "
13828 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13829 "then the C<ino> field of that structure is set to C<-1>."
13834 #: ../src/guestfs-actions.pod:3783
13836 "This call is intended for programs that want to efficiently list a directory "
13837 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13838 "for a similarly efficient call for getting extended attributes. Very long "
13839 "directory listings might cause the protocol message size to be exceeded, "
13840 "causing this call to fail. The caller must split up such requests into "
13841 "smaller groups of names."
13846 #: ../src/guestfs-actions.pod:3791
13848 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13849 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13854 #: ../src/guestfs-actions.pod:3797
13855 msgid "guestfs_luks_add_key"
13860 #: ../src/guestfs-actions.pod:3799
13864 " guestfs_luks_add_key (guestfs_h *g,\n"
13865 " const char *device,\n"
13866 " const char *key,\n"
13867 " const char *newkey,\n"
13874 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2626
13876 "This command adds a new key on LUKS device C<device>. C<key> is any "
13877 "existing key, and is used to access the device. C<newkey> is the new key to "
13878 "add. C<keyslot> is the key slot that will be replaced."
13883 #: ../src/guestfs-actions.pod:3811
13885 "Note that if C<keyslot> already contains a key, then this command will "
13886 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13891 #: ../src/guestfs-actions.pod:3817 ../src/guestfs-actions.pod:3857
13892 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3900
13893 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3951
13895 "This function takes a key or passphrase parameter which could contain "
13896 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13902 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:3861
13903 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3904
13904 msgid "(Added in 1.5.2)"
13909 #: ../src/guestfs-actions.pod:3823
13910 msgid "guestfs_luks_close"
13915 #: ../src/guestfs-actions.pod:3825
13919 " guestfs_luks_close (guestfs_h *g,\n"
13920 " const char *device);\n"
13926 #: ../src/guestfs-actions.pod:3829
13928 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13929 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13930 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13931 "underlying block device."
13936 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3936
13937 #: ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:4005
13938 #: ../src/guestfs-actions.pod:4053
13939 msgid "(Added in 1.5.1)"
13944 #: ../src/guestfs-actions.pod:3839
13945 msgid "guestfs_luks_format"
13950 #: ../src/guestfs-actions.pod:3841
13954 " guestfs_luks_format (guestfs_h *g,\n"
13955 " const char *device,\n"
13956 " const char *key,\n"
13963 #: ../src/guestfs-actions.pod:3847 ../fish/guestfish-actions.pod:2652
13965 "This command erases existing data on C<device> and formats the device as a "
13966 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13967 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13972 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3877
13973 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4975
13974 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6162
13975 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6225
13976 #: ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:2660
13977 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2757
13978 #: ../fish/guestfish-actions.pod:3347 ../fish/guestfish-actions.pod:3867
13979 #: ../fish/guestfish-actions.pod:4177 ../fish/guestfish-actions.pod:4200
13980 #: ../fish/guestfish-actions.pod:4222 ../fish/guestfish-actions.pod:4951
13982 "B<This command is dangerous. Without careful use you can easily destroy all "
13988 #: ../src/guestfs-actions.pod:3863
13989 msgid "guestfs_luks_format_cipher"
13994 #: ../src/guestfs-actions.pod:3865
13998 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13999 " const char *device,\n"
14000 " const char *key,\n"
14002 " const char *cipher);\n"
14008 #: ../src/guestfs-actions.pod:3872
14010 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14011 "set the C<cipher> used."
14016 #: ../src/guestfs-actions.pod:3886
14017 msgid "guestfs_luks_kill_slot"
14022 #: ../src/guestfs-actions.pod:3888
14026 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14027 " const char *device,\n"
14028 " const char *key,\n"
14035 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2680
14037 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14038 "device C<device>. C<key> must be one of the I<other> keys."
14043 #: ../src/guestfs-actions.pod:3906
14044 msgid "guestfs_luks_open"
14049 #: ../src/guestfs-actions.pod:3908
14053 " guestfs_luks_open (guestfs_h *g,\n"
14054 " const char *device,\n"
14055 " const char *key,\n"
14056 " const char *mapname);\n"
14062 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
14064 "This command opens a block device which has been encrypted according to the "
14065 "Linux Unified Key Setup (LUKS) standard."
14070 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
14071 msgid "C<device> is the encrypted block device or partition."
14076 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
14078 "The caller must supply one of the keys associated with the LUKS block "
14079 "device, in the C<key> parameter."
14084 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
14086 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14087 "writes to this block device are decrypted from and encrypted to the "
14088 "underlying C<device> respectively."
14093 #: ../src/guestfs-actions.pod:3926
14095 "If this block device contains LVM volume groups, then calling "
14096 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14102 #: ../src/guestfs-actions.pod:3938
14103 msgid "guestfs_luks_open_ro"
14108 #: ../src/guestfs-actions.pod:3940
14112 " guestfs_luks_open_ro (guestfs_h *g,\n"
14113 " const char *device,\n"
14114 " const char *key,\n"
14115 " const char *mapname);\n"
14121 #: ../src/guestfs-actions.pod:3946
14123 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14129 #: ../src/guestfs-actions.pod:3957
14130 msgid "guestfs_lvcreate"
14135 #: ../src/guestfs-actions.pod:3959
14139 " guestfs_lvcreate (guestfs_h *g,\n"
14140 " const char *logvol,\n"
14141 " const char *volgroup,\n"
14148 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2724
14150 "This creates an LVM logical volume called C<logvol> on the volume group "
14151 "C<volgroup>, with C<size> megabytes."
14156 #: ../src/guestfs-actions.pod:3972
14157 msgid "guestfs_lvm_canonical_lv_name"
14162 #: ../src/guestfs-actions.pod:3974
14166 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14167 " const char *lvname);\n"
14173 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
14175 "This converts alternative naming schemes for LVs that you might find to the "
14176 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14182 #: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:2735
14184 "This command returns an error if the C<lvname> parameter does not refer to a "
14190 #: ../src/guestfs-actions.pod:3985
14191 msgid "See also C<guestfs_is_lv>."
14196 #: ../src/guestfs-actions.pod:3990
14197 msgid "(Added in 1.5.24)"
14202 #: ../src/guestfs-actions.pod:3992
14203 msgid "guestfs_lvm_clear_filter"
14208 #: ../src/guestfs-actions.pod:3994
14212 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14218 #: ../src/guestfs-actions.pod:3997
14220 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14221 "see every block device."
14226 #: ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4042
14227 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2778
14229 "This command also clears the LVM cache and performs a volume group scan."
14234 #: ../src/guestfs-actions.pod:4007
14235 msgid "guestfs_lvm_remove_all"
14240 #: ../src/guestfs-actions.pod:4009
14244 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14250 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2754
14252 "This command removes all LVM logical volumes, volume groups and physical "
14258 #: ../src/guestfs-actions.pod:4022
14259 msgid "guestfs_lvm_set_filter"
14264 #: ../src/guestfs-actions.pod:4024
14268 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14269 " char *const *devices);\n"
14275 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2764
14277 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14278 "block devices in the list C<devices>, and will ignore all other attached "
14284 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2768
14286 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14287 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14288 "there are two types of duplication possible: either cloned PVs/VGs which "
14289 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14290 "same name. In normal operation you cannot create this situation, but you "
14291 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14292 "inside the LVM metadata."
14297 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2781
14298 msgid "You can filter whole block devices or individual partitions."
14303 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2783
14305 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14306 "filesystem), even if you are not filtering out that VG."
14311 #: ../src/guestfs-actions.pod:4055
14312 msgid "guestfs_lvremove"
14317 #: ../src/guestfs-actions.pod:4057
14321 " guestfs_lvremove (guestfs_h *g,\n"
14322 " const char *device);\n"
14328 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2791
14330 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14331 "LV, such as C</dev/VG/LV>."
14336 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
14338 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14344 #: ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:5321
14345 #: ../src/guestfs-actions.pod:7138
14346 msgid "(Added in 1.0.13)"
14351 #: ../src/guestfs-actions.pod:4071
14352 msgid "guestfs_lvrename"
14357 #: ../src/guestfs-actions.pod:4073
14361 " guestfs_lvrename (guestfs_h *g,\n"
14362 " const char *logvol,\n"
14363 " const char *newlogvol);\n"
14369 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2801
14370 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14375 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:7151
14376 msgid "(Added in 1.0.83)"
14381 #: ../src/guestfs-actions.pod:4084
14382 msgid "guestfs_lvresize"
14387 #: ../src/guestfs-actions.pod:4086
14391 " guestfs_lvresize (guestfs_h *g,\n"
14392 " const char *device,\n"
14399 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2807
14401 "This resizes (expands or shrinks) an existing LVM logical volume to "
14402 "C<mbytes>. When reducing, data in the reduced part is lost."
14407 #: ../src/guestfs-actions.pod:4099
14408 msgid "guestfs_lvresize_free"
14413 #: ../src/guestfs-actions.pod:4101
14417 " guestfs_lvresize_free (guestfs_h *g,\n"
14418 " const char *lv,\n"
14425 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2815
14427 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14428 "remaining free space in the volume group. Commonly you would call this with "
14429 "pc = 100 which expands the logical volume as much as possible, using all "
14430 "remaining free space in the volume group."
14435 #: ../src/guestfs-actions.pod:4114
14436 msgid "(Added in 1.3.3)"
14441 #: ../src/guestfs-actions.pod:4116
14442 msgid "guestfs_lvs"
14447 #: ../src/guestfs-actions.pod:4118
14451 " guestfs_lvs (guestfs_h *g);\n"
14457 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2825
14459 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14465 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
14467 "This returns a list of the logical volume device names (eg. C</dev/"
14468 "VolGroup00/LogVol00>)."
14473 #: ../src/guestfs-actions.pod:4127
14474 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14479 #: ../src/guestfs-actions.pod:4135
14480 msgid "guestfs_lvs_full"
14485 #: ../src/guestfs-actions.pod:4137
14488 " struct guestfs_lvm_lv_list *\n"
14489 " guestfs_lvs_full (guestfs_h *g);\n"
14495 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2837
14497 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14498 "(8)> command. The \"full\" version includes all fields."
14503 #: ../src/guestfs-actions.pod:4143
14505 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14506 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14511 #: ../src/guestfs-actions.pod:4149
14512 msgid "guestfs_lvuuid"
14517 #: ../src/guestfs-actions.pod:4151
14521 " guestfs_lvuuid (guestfs_h *g,\n"
14522 " const char *device);\n"
14528 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2844
14529 msgid "This command returns the UUID of the LVM LV C<device>."
14534 #: ../src/guestfs-actions.pod:4162
14535 msgid "guestfs_lxattrlist"
14540 #: ../src/guestfs-actions.pod:4164
14543 " struct guestfs_xattr_list *\n"
14544 " guestfs_lxattrlist (guestfs_h *g,\n"
14545 " const char *path,\n"
14546 " char *const *names);\n"
14552 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2850
14554 "This call allows you to get the extended attributes of multiple files, where "
14555 "all files are in the directory C<path>. C<names> is the list of files from "
14561 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2854
14563 "On return you get a flat list of xattr structs which must be interpreted "
14564 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14565 "C<attrval> in this struct is zero-length to indicate there was an error "
14566 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14567 "number (the number of following attributes for this file, which could be C<"
14568 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14569 "for the first named file. This repeats for the second and subsequent files."
14574 #: ../src/guestfs-actions.pod:4183
14576 "This call is intended for programs that want to efficiently list a directory "
14577 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14578 "a similarly efficient call for getting standard stats. Very long directory "
14579 "listings might cause the protocol message size to be exceeded, causing this "
14580 "call to fail. The caller must split up such requests into smaller groups of "
14586 #: ../src/guestfs-actions.pod:4197
14587 msgid "guestfs_mkdir"
14592 #: ../src/guestfs-actions.pod:4199
14596 " guestfs_mkdir (guestfs_h *g,\n"
14597 " const char *path);\n"
14603 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:2876
14604 msgid "Create a directory named C<path>."
14609 #: ../src/guestfs-actions.pod:4209
14610 msgid "guestfs_mkdir_mode"
14615 #: ../src/guestfs-actions.pod:4211
14619 " guestfs_mkdir_mode (guestfs_h *g,\n"
14620 " const char *path,\n"
14627 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2882
14629 "This command creates a directory, setting the initial permissions of the "
14630 "directory to C<mode>."
14635 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
14637 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14638 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14644 #: ../src/guestfs-actions.pod:4223
14645 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14650 #: ../src/guestfs-actions.pod:4229
14651 msgid "guestfs_mkdir_p"
14656 #: ../src/guestfs-actions.pod:4231
14660 " guestfs_mkdir_p (guestfs_h *g,\n"
14661 " const char *path);\n"
14667 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2895
14669 "Create a directory named C<path>, creating any parent directories as "
14670 "necessary. This is like the C<mkdir -p> shell command."
14675 #: ../src/guestfs-actions.pod:4242
14676 msgid "guestfs_mkdtemp"
14681 #: ../src/guestfs-actions.pod:4244
14685 " guestfs_mkdtemp (guestfs_h *g,\n"
14686 " const char *template);\n"
14692 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
14694 "This command creates a temporary directory. The C<template> parameter "
14695 "should be a full pathname for the temporary directory name with the final "
14696 "six characters being \"XXXXXX\"."
14701 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
14703 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14704 "being suitable for Windows filesystems."
14709 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
14710 msgid "The name of the temporary directory that was created is returned."
14715 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
14716 msgid "The temporary directory is created with mode 0700 and is owned by root."
14721 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
14723 "The caller is responsible for deleting the temporary directory and its "
14724 "contents after use."
14729 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
14730 msgid "See also: L<mkdtemp(3)>"
14735 #: ../src/guestfs-actions.pod:4272
14736 msgid "guestfs_mke2fs_J"
14741 #: ../src/guestfs-actions.pod:4274
14745 " guestfs_mke2fs_J (guestfs_h *g,\n"
14746 " const char *fstype,\n"
14747 " int blocksize,\n"
14748 " const char *device,\n"
14749 " const char *journal);\n"
14755 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2925
14757 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14758 "C<journal>. It is equivalent to the command:"
14763 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2929
14766 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14772 #: ../src/guestfs-actions.pod:4287
14773 msgid "See also C<guestfs_mke2journal>."
14778 #: ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4309
14779 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4343
14780 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4371
14781 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4695
14782 msgid "(Added in 1.0.68)"
14787 #: ../src/guestfs-actions.pod:4293
14788 msgid "guestfs_mke2fs_JL"
14793 #: ../src/guestfs-actions.pod:4295
14797 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14798 " const char *fstype,\n"
14799 " int blocksize,\n"
14800 " const char *device,\n"
14801 " const char *label);\n"
14807 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:2937
14809 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14810 "the journal labeled C<label>."
14815 #: ../src/guestfs-actions.pod:4305
14816 msgid "See also C<guestfs_mke2journal_L>."
14821 #: ../src/guestfs-actions.pod:4311
14822 msgid "guestfs_mke2fs_JU"
14827 #: ../src/guestfs-actions.pod:4313
14831 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14832 " const char *fstype,\n"
14833 " int blocksize,\n"
14834 " const char *device,\n"
14835 " const char *uuid);\n"
14841 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2946
14843 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14844 "the journal with UUID C<uuid>."
14849 #: ../src/guestfs-actions.pod:4323
14850 msgid "See also C<guestfs_mke2journal_U>."
14855 #: ../src/guestfs-actions.pod:4329
14856 msgid "guestfs_mke2journal"
14861 #: ../src/guestfs-actions.pod:4331
14865 " guestfs_mke2journal (guestfs_h *g,\n"
14866 " int blocksize,\n"
14867 " const char *device);\n"
14873 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2955
14875 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14881 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
14884 " mke2fs -O journal_dev -b blocksize device\n"
14890 #: ../src/guestfs-actions.pod:4345
14891 msgid "guestfs_mke2journal_L"
14896 #: ../src/guestfs-actions.pod:4347
14900 " guestfs_mke2journal_L (guestfs_h *g,\n"
14901 " int blocksize,\n"
14902 " const char *label,\n"
14903 " const char *device);\n"
14909 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:2964
14910 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14915 #: ../src/guestfs-actions.pod:4359
14916 msgid "guestfs_mke2journal_U"
14921 #: ../src/guestfs-actions.pod:4361
14925 " guestfs_mke2journal_U (guestfs_h *g,\n"
14926 " int blocksize,\n"
14927 " const char *uuid,\n"
14928 " const char *device);\n"
14934 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2970
14935 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14940 #: ../src/guestfs-actions.pod:4373
14941 msgid "guestfs_mkfifo"
14946 #: ../src/guestfs-actions.pod:4375
14950 " guestfs_mkfifo (guestfs_h *g,\n"
14952 " const char *path);\n"
14958 #: ../src/guestfs-actions.pod:4380
14960 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14961 "is just a convenient wrapper around C<guestfs_mknod>."
14966 #: ../src/guestfs-actions.pod:4390
14967 msgid "guestfs_mkfs"
14972 #: ../src/guestfs-actions.pod:4392
14976 " guestfs_mkfs (guestfs_h *g,\n"
14977 " const char *fstype,\n"
14978 " const char *device);\n"
14984 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2986
14986 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14987 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14992 #: ../src/guestfs-actions.pod:4405
14993 msgid "guestfs_mkfs_b"
14998 #: ../src/guestfs-actions.pod:4407
15002 " guestfs_mkfs_b (guestfs_h *g,\n"
15003 " const char *fstype,\n"
15004 " int blocksize,\n"
15005 " const char *device);\n"
15011 #: ../src/guestfs-actions.pod:4413
15013 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15014 "block size of the resulting filesystem. Supported block sizes depend on the "
15015 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15020 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4461
15021 #: ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3026
15023 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15029 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3002
15031 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15036 #: ../src/guestfs-actions.pod:4432
15037 msgid "guestfs_mkfs_opts"
15042 #: ../src/guestfs-actions.pod:4434
15046 " guestfs_mkfs_opts (guestfs_h *g,\n"
15047 " const char *fstype,\n"
15048 " const char *device,\n"
15054 #: ../src/guestfs-actions.pod:4445
15057 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15058 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15064 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3013
15066 "This function creates a filesystem on C<device>. The filesystem type is "
15067 "C<fstype>, for example C<ext3>."
15072 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:3020
15073 msgid "C<blocksize>"
15078 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3022
15080 "The filesystem block size. Supported block sizes depend on the filesystem "
15081 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15086 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3029
15087 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15091 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3031
15092 msgid "C<features>"
15096 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3033
15097 msgid "This passes the I<-O> parameter to the external mkfs program."
15101 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3035
15103 "For certain filesystem types, this allows extra filesystem features to be "
15104 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15108 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3039
15110 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15115 #: ../src/guestfs-actions.pod:4481
15116 msgid "(Added in 1.7.19)"
15121 #: ../src/guestfs-actions.pod:4483
15122 msgid "guestfs_mkfs_opts_va"
15127 #: ../src/guestfs-actions.pod:4485
15131 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15132 " const char *fstype,\n"
15133 " const char *device,\n"
15134 " va_list args);\n"
15140 #: ../src/guestfs-actions.pod:4491
15141 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15146 #: ../src/guestfs-actions.pod:4495
15147 msgid "guestfs_mkfs_opts_argv"
15152 #: ../src/guestfs-actions.pod:4497
15156 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15157 " const char *fstype,\n"
15158 " const char *device,\n"
15159 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15165 #: ../src/guestfs-actions.pod:4503
15166 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15171 #: ../src/guestfs-actions.pod:4507
15172 msgid "guestfs_mkmountpoint"
15177 #: ../src/guestfs-actions.pod:4509
15181 " guestfs_mkmountpoint (guestfs_h *g,\n"
15182 " const char *exemptpath);\n"
15188 #: ../src/guestfs-actions.pod:4513
15190 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15191 "that can be used to create extra mountpoints before mounting the first "
15197 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3054
15199 "These calls are I<only> necessary in some very limited circumstances, mainly "
15200 "the case where you want to mount a mix of unrelated and/or read-only "
15201 "filesystems together."
15206 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
15208 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15209 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15210 "inside that. You can unpack this as follows in guestfish:"
15215 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
15218 " add-ro Fedora-11-i686-Live.iso\n"
15220 " mkmountpoint /cd\n"
15221 " mkmountpoint /sqsh\n"
15222 " mkmountpoint /ext3fs\n"
15223 " mount /dev/sda /cd\n"
15224 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15225 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15231 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3072
15232 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15237 #: ../src/guestfs-actions.pod:4537
15239 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15240 "may get unexpected errors if you try to mix these calls. It is safest to "
15241 "manually unmount filesystems and remove mountpoints after use."
15246 #: ../src/guestfs-actions.pod:4541
15248 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15249 "first, so for this to work for manual mountpoints, you must ensure that the "
15250 "innermost mountpoints have the longest pathnames, as in the example code "
15256 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3083
15258 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15262 #: ../src/guestfs-actions.pod:4548
15264 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15265 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15266 "can also trigger these issues."
15271 #: ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4820
15272 #: ../src/guestfs-actions.pod:5739
15273 msgid "(Added in 1.0.62)"
15278 #: ../src/guestfs-actions.pod:4556
15279 msgid "guestfs_mknod"
15284 #: ../src/guestfs-actions.pod:4558
15288 " guestfs_mknod (guestfs_h *g,\n"
15292 " const char *path);\n"
15298 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3093
15300 "This call creates block or character special devices, or named pipes (FIFOs)."
15305 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
15307 "The C<mode> parameter should be the mode, using the standard constants. "
15308 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15309 "used when creating block and character special devices."
15314 #: ../src/guestfs-actions.pod:4573
15316 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15317 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15318 "regular file). These constants are available in the standard Linux header "
15319 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15320 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15321 "the appropriate constant for you."
15326 #: ../src/guestfs-actions.pod:4587
15327 msgid "guestfs_mknod_b"
15332 #: ../src/guestfs-actions.pod:4589
15336 " guestfs_mknod_b (guestfs_h *g,\n"
15340 " const char *path);\n"
15346 #: ../src/guestfs-actions.pod:4596
15348 "This call creates a block device node called C<path> with mode C<mode> and "
15349 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15350 "wrapper around C<guestfs_mknod>."
15355 #: ../src/guestfs-actions.pod:4606
15356 msgid "guestfs_mknod_c"
15361 #: ../src/guestfs-actions.pod:4608
15365 " guestfs_mknod_c (guestfs_h *g,\n"
15369 " const char *path);\n"
15375 #: ../src/guestfs-actions.pod:4615
15377 "This call creates a char device node called C<path> with mode C<mode> and "
15378 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15379 "wrapper around C<guestfs_mknod>."
15384 #: ../src/guestfs-actions.pod:4625
15385 msgid "guestfs_mkswap"
15390 #: ../src/guestfs-actions.pod:4627
15394 " guestfs_mkswap (guestfs_h *g,\n"
15395 " const char *device);\n"
15401 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3135
15402 msgid "Create a swap partition on C<device>."
15407 #: ../src/guestfs-actions.pod:4637
15408 msgid "guestfs_mkswap_L"
15413 #: ../src/guestfs-actions.pod:4639
15417 " guestfs_mkswap_L (guestfs_h *g,\n"
15418 " const char *label,\n"
15419 " const char *device);\n"
15425 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3141
15426 msgid "Create a swap partition on C<device> with label C<label>."
15431 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3143
15433 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15434 "sda>), just to a partition. This appears to be a limitation of the kernel "
15440 #: ../src/guestfs-actions.pod:4654
15441 msgid "guestfs_mkswap_U"
15446 #: ../src/guestfs-actions.pod:4656
15450 " guestfs_mkswap_U (guestfs_h *g,\n"
15451 " const char *uuid,\n"
15452 " const char *device);\n"
15458 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3151
15459 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15464 #: ../src/guestfs-actions.pod:4667
15465 msgid "guestfs_mkswap_file"
15470 #: ../src/guestfs-actions.pod:4669
15474 " guestfs_mkswap_file (guestfs_h *g,\n"
15475 " const char *path);\n"
15481 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3157
15482 msgid "Create a swap file."
15487 #: ../src/guestfs-actions.pod:4675
15489 "This command just writes a swap file signature to an existing file. To "
15490 "create the file itself, use something like C<guestfs_fallocate>."
15495 #: ../src/guestfs-actions.pod:4682
15496 msgid "guestfs_modprobe"
15501 #: ../src/guestfs-actions.pod:4684
15505 " guestfs_modprobe (guestfs_h *g,\n"
15506 " const char *modulename);\n"
15512 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3166
15513 msgid "This loads a kernel module in the appliance."
15518 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3168
15520 "The kernel module must have been whitelisted when libguestfs was built (see "
15521 "C<appliance/kmod.whitelist.in> in the source)."
15526 #: ../src/guestfs-actions.pod:4697
15527 msgid "guestfs_mount"
15532 #: ../src/guestfs-actions.pod:4699
15536 " guestfs_mount (guestfs_h *g,\n"
15537 " const char *device,\n"
15538 " const char *mountpoint);\n"
15544 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3175
15546 "Mount a guest disk at a position in the filesystem. Block devices are named "
15547 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15548 "those block devices contain partitions, they will have the usual names (eg. "
15549 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15554 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
15556 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15557 "mounted on C</> before others can be mounted. Other filesystems can only be "
15558 "mounted on directories which already exist."
15563 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
15565 "The mounted filesystem is writable, if we have sufficient permissions on the "
15566 "underlying device."
15571 #: ../src/guestfs-actions.pod:4718
15573 "B<Important note:> When you use this call, the filesystem options C<sync> "
15574 "and C<noatime> are set implicitly. This was originally done because we "
15575 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15576 "very large negative performance impact and negligible effect on "
15577 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15578 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15579 "(use an empty string for the first parameter if you don't want any options)."
15583 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3199
15585 "This function is deprecated. In new code, use the C<mount_options> call "
15591 #: ../src/guestfs-actions.pod:4739
15592 msgid "guestfs_mount_loop"
15597 #: ../src/guestfs-actions.pod:4741
15601 " guestfs_mount_loop (guestfs_h *g,\n"
15602 " const char *file,\n"
15603 " const char *mountpoint);\n"
15609 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3210
15611 "This command lets you mount C<file> (a filesystem image in a file) on a "
15612 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15618 #: ../src/guestfs-actions.pod:4754
15619 msgid "guestfs_mount_options"
15624 #: ../src/guestfs-actions.pod:4756
15628 " guestfs_mount_options (guestfs_h *g,\n"
15629 " const char *options,\n"
15630 " const char *device,\n"
15631 " const char *mountpoint);\n"
15637 #: ../src/guestfs-actions.pod:4762
15639 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15640 "the mount options as for the L<mount(8)> I<-o> flag."
15645 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3222
15647 "If the C<options> parameter is an empty string, then no options are passed "
15648 "(all options default to whatever the filesystem uses)."
15653 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4786
15654 #: ../src/guestfs-actions.pod:4803
15655 msgid "(Added in 1.0.10)"
15660 #: ../src/guestfs-actions.pod:4774
15661 msgid "guestfs_mount_ro"
15666 #: ../src/guestfs-actions.pod:4776
15670 " guestfs_mount_ro (guestfs_h *g,\n"
15671 " const char *device,\n"
15672 " const char *mountpoint);\n"
15678 #: ../src/guestfs-actions.pod:4781
15680 "This is the same as the C<guestfs_mount> command, but it mounts the "
15681 "filesystem with the read-only (I<-o ro>) flag."
15686 #: ../src/guestfs-actions.pod:4788
15687 msgid "guestfs_mount_vfs"
15692 #: ../src/guestfs-actions.pod:4790
15696 " guestfs_mount_vfs (guestfs_h *g,\n"
15697 " const char *options,\n"
15698 " const char *vfstype,\n"
15699 " const char *device,\n"
15700 " const char *mountpoint);\n"
15706 #: ../src/guestfs-actions.pod:4797
15708 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15709 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15715 #: ../src/guestfs-actions.pod:4805
15716 msgid "guestfs_mountpoints"
15721 #: ../src/guestfs-actions.pod:4807
15725 " guestfs_mountpoints (guestfs_h *g);\n"
15731 #: ../src/guestfs-actions.pod:4810
15733 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15734 "devices. This one returns a hash table (map) of device name to directory "
15735 "where the device is mounted."
15740 #: ../src/guestfs-actions.pod:4822
15741 msgid "guestfs_mounts"
15746 #: ../src/guestfs-actions.pod:4824
15750 " guestfs_mounts (guestfs_h *g);\n"
15756 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3253
15758 "This returns the list of currently mounted filesystems. It returns the list "
15759 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15764 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3256
15765 msgid "Some internal mounts are not shown."
15770 #: ../src/guestfs-actions.pod:4832
15771 msgid "See also: C<guestfs_mountpoints>"
15776 #: ../src/guestfs-actions.pod:4840
15782 #: ../src/guestfs-actions.pod:4842
15786 " guestfs_mv (guestfs_h *g,\n"
15787 " const char *src,\n"
15788 " const char *dest);\n"
15794 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3264
15796 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15797 "destination filename or destination directory."
15802 #: ../src/guestfs-actions.pod:4854
15803 msgid "guestfs_ntfs_3g_probe"
15808 #: ../src/guestfs-actions.pod:4856
15812 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15814 " const char *device);\n"
15820 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
15822 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15823 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15824 "write, and some cannot be mounted at all)."
15829 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
15831 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15832 "can be mounted read-write. Set it to false if you want to test if the "
15833 "volume can be mounted read-only."
15838 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3279
15840 "The return value is an integer which C<0> if the operation would succeed, or "
15841 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15846 #: ../src/guestfs-actions.pod:4875
15847 msgid "(Added in 1.0.43)"
15852 #: ../src/guestfs-actions.pod:4877
15853 msgid "guestfs_ntfsresize"
15858 #: ../src/guestfs-actions.pod:4879
15862 " guestfs_ntfsresize (guestfs_h *g,\n"
15863 " const char *device);\n"
15868 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3287
15870 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15871 "size of the underlying device."
15875 #: ../src/guestfs-actions.pod:4886 ../fish/guestfish-actions.pod:3290
15877 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
15878 "consistency check (for safety). You have to boot into Windows to perform "
15879 "this check and clear this condition. Furthermore, ntfsresize refuses to "
15880 "resize filesystems which have been marked in this way. So in effect it is "
15881 "not possible to call ntfsresize multiple times on a single filesystem "
15882 "without booting into Windows between each resize."
15886 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3298
15887 msgid "See also L<ntfsresize(8)>."
15892 #: ../src/guestfs-actions.pod:4900
15893 msgid "guestfs_ntfsresize_size"
15898 #: ../src/guestfs-actions.pod:4902
15902 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15903 " const char *device,\n"
15904 " int64_t size);\n"
15910 #: ../src/guestfs-actions.pod:4907
15912 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15913 "to specify the new size (in bytes) explicitly."
15918 #: ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:5348
15919 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5687
15920 #: ../src/guestfs-actions.pod:7293
15921 msgid "(Added in 1.3.14)"
15926 #: ../src/guestfs-actions.pod:4914
15927 msgid "guestfs_part_add"
15932 #: ../src/guestfs-actions.pod:4916
15936 " guestfs_part_add (guestfs_h *g,\n"
15937 " const char *device,\n"
15938 " const char *prlogex,\n"
15939 " int64_t startsect,\n"
15940 " int64_t endsect);\n"
15946 #: ../src/guestfs-actions.pod:4923
15948 "This command adds a partition to C<device>. If there is no partition table "
15949 "on the device, call C<guestfs_part_init> first."
15954 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3314
15956 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15957 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15958 "C<logical>) and C<e> (or C<extended>) partition types."
15963 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
15965 "C<startsect> and C<endsect> are the start and end of the partition in "
15966 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15967 "from the end of the disk (C<-1> is the last sector)."
15972 #: ../src/guestfs-actions.pod:4935
15974 "Creating a partition which covers the whole disk is not so easy. Use "
15975 "C<guestfs_part_disk> to do that."
15980 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4978
15981 #: ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5109
15982 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5166
15983 #: ../src/guestfs-actions.pod:5206
15984 msgid "(Added in 1.0.78)"
15989 #: ../src/guestfs-actions.pod:4942
15990 msgid "guestfs_part_del"
15995 #: ../src/guestfs-actions.pod:4944
15999 " guestfs_part_del (guestfs_h *g,\n"
16000 " const char *device,\n"
16007 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3330
16008 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16013 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3332
16015 "Note that in the case of MBR partitioning, deleting an extended partition "
16016 "also deletes any logical partitions it contains."
16021 #: ../src/guestfs-actions.pod:4959
16022 msgid "guestfs_part_disk"
16027 #: ../src/guestfs-actions.pod:4961
16031 " guestfs_part_disk (guestfs_h *g,\n"
16032 " const char *device,\n"
16033 " const char *parttype);\n"
16039 #: ../src/guestfs-actions.pod:4966
16041 "This command is simply a combination of C<guestfs_part_init> followed by "
16042 "C<guestfs_part_add> to create a single primary partition covering the whole "
16048 #: ../src/guestfs-actions.pod:4970
16050 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16051 "possible values are described in C<guestfs_part_init>."
16056 #: ../src/guestfs-actions.pod:4980
16057 msgid "guestfs_part_get_bootable"
16062 #: ../src/guestfs-actions.pod:4982
16066 " guestfs_part_get_bootable (guestfs_h *g,\n"
16067 " const char *device,\n"
16074 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3354
16076 "This command returns true if the partition C<partnum> on C<device> has the "
16077 "bootable flag set."
16082 #: ../src/guestfs-actions.pod:4990
16083 msgid "See also C<guestfs_part_set_bootable>."
16088 #: ../src/guestfs-actions.pod:4996
16089 msgid "guestfs_part_get_mbr_id"
16094 #: ../src/guestfs-actions.pod:4998
16098 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16099 " const char *device,\n"
16106 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3363
16108 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16109 "partition C<partnum>."
16114 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5182
16116 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16117 "undefined results for other partition table types (see "
16118 "C<guestfs_part_get_parttype>)."
16123 #: ../src/guestfs-actions.pod:5014
16124 msgid "guestfs_part_get_parttype"
16129 #: ../src/guestfs-actions.pod:5016
16133 " guestfs_part_get_parttype (guestfs_h *g,\n"
16134 " const char *device);\n"
16140 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3374
16142 "This command examines the partition table on C<device> and returns the "
16143 "partition table type (format) being used."
16148 #: ../src/guestfs-actions.pod:5023
16150 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16151 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16152 "possible, although unusual. See C<guestfs_part_init> for a full list."
16157 #: ../src/guestfs-actions.pod:5033
16158 msgid "guestfs_part_init"
16163 #: ../src/guestfs-actions.pod:5035
16167 " guestfs_part_init (guestfs_h *g,\n"
16168 " const char *device,\n"
16169 " const char *parttype);\n"
16175 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
16177 "This creates an empty partition table on C<device> of one of the partition "
16178 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16179 "(for large disks)."
16184 #: ../src/guestfs-actions.pod:5044
16186 "Initially there are no partitions. Following this, you should call "
16187 "C<guestfs_part_add> for each partition required."
16192 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
16193 msgid "Possible values for C<parttype> are:"
16198 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3397
16199 msgid "B<efi> | B<gpt>"
16204 #: ../src/guestfs-actions.pod:5053 ../fish/guestfish-actions.pod:3399
16205 msgid "Intel EFI / GPT partition table."
16210 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
16212 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16213 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16214 "the C<mbr> format."
16219 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3405
16220 msgid "B<mbr> | B<msdos>"
16225 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3407
16227 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16228 "Windows. This partition type will B<only> work for device sizes up to 2 "
16229 "TB. For large disks we recommend using C<gpt>."
16234 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16236 "Other partition table types that may work but are not supported include:"
16241 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
16247 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3421
16248 msgid "AIX disk labels."
16253 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3423
16254 msgid "B<amiga> | B<rdb>"
16259 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3425
16260 msgid "Amiga \"Rigid Disk Block\" format."
16265 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3427
16271 #: ../src/guestfs-actions.pod:5083 ../fish/guestfish-actions.pod:3429
16272 msgid "BSD disk labels."
16277 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3431
16283 #: ../src/guestfs-actions.pod:5087 ../fish/guestfish-actions.pod:3433
16284 msgid "DASD, used on IBM mainframes."
16289 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3435
16295 #: ../src/guestfs-actions.pod:5091 ../fish/guestfish-actions.pod:3437
16296 msgid "MIPS/SGI volumes."
16301 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3439
16307 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3441
16308 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16313 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3443
16319 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3445
16320 msgid "NEC PC-98 format, common in Japan apparently."
16325 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3447
16331 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3449
16332 msgid "Sun disk labels."
16337 #: ../src/guestfs-actions.pod:5111
16338 msgid "guestfs_part_list"
16343 #: ../src/guestfs-actions.pod:5113
16346 " struct guestfs_partition_list *\n"
16347 " guestfs_part_list (guestfs_h *g,\n"
16348 " const char *device);\n"
16354 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3457
16356 "This command parses the partition table on C<device> and returns the list of "
16357 "partitions found."
16362 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
16363 msgid "The fields in the returned structure are:"
16368 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
16369 msgid "B<part_num>"
16374 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
16375 msgid "Partition number, counting from 1."
16380 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3468
16381 msgid "B<part_start>"
16386 #: ../src/guestfs-actions.pod:5130
16388 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16389 "the device's sector size, see C<guestfs_blockdev_getss>."
16394 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
16395 msgid "B<part_end>"
16400 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3475
16401 msgid "End of the partition in bytes."
16406 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3477
16407 msgid "B<part_size>"
16412 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3479
16413 msgid "Size of the partition in bytes."
16418 #: ../src/guestfs-actions.pod:5143
16420 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16421 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16427 #: ../src/guestfs-actions.pod:5149
16428 msgid "guestfs_part_set_bootable"
16433 #: ../src/guestfs-actions.pod:5151
16437 " guestfs_part_set_bootable (guestfs_h *g,\n"
16438 " const char *device,\n"
16440 " int bootable);\n"
16446 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3487
16448 "This sets the bootable flag on partition numbered C<partnum> on device "
16449 "C<device>. Note that partitions are numbered from 1."
16454 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3490
16456 "The bootable flag is used by some operating systems (notably Windows) to "
16457 "determine which partition to boot from. It is by no means universally "
16463 #: ../src/guestfs-actions.pod:5168
16464 msgid "guestfs_part_set_mbr_id"
16469 #: ../src/guestfs-actions.pod:5170
16473 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16474 " const char *device,\n"
16482 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:3498
16484 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16485 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16486 "documentation are in fact hexadecimal numbers, but usually documented "
16487 "without any leading \"0x\" which might be confusing."
16492 #: ../src/guestfs-actions.pod:5190
16493 msgid "guestfs_part_set_name"
16498 #: ../src/guestfs-actions.pod:5192
16502 " guestfs_part_set_name (guestfs_h *g,\n"
16503 " const char *device,\n"
16505 " const char *name);\n"
16511 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3512
16513 "This sets the partition name on partition numbered C<partnum> on device "
16514 "C<device>. Note that partitions are numbered from 1."
16519 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3515
16521 "The partition name can only be set on certain types of partition table. "
16522 "This works on C<gpt> but not on C<mbr> partitions."
16527 #: ../src/guestfs-actions.pod:5208
16528 msgid "guestfs_part_to_dev"
16533 #: ../src/guestfs-actions.pod:5210
16537 " guestfs_part_to_dev (guestfs_h *g,\n"
16538 " const char *partition);\n"
16544 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3522
16546 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16547 "partition number, returning the device name (eg. \"/dev/sdb\")."
16552 #: ../src/guestfs-actions.pod:5218
16554 "The named partition must exist, for example as a string returned from "
16555 "C<guestfs_list_partitions>."
16560 #: ../src/guestfs-actions.pod:5226
16561 msgid "guestfs_ping_daemon"
16566 #: ../src/guestfs-actions.pod:5228
16570 " guestfs_ping_daemon (guestfs_h *g);\n"
16576 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3533
16578 "This is a test probe into the guestfs daemon running inside the qemu "
16579 "subprocess. Calling this function checks that the daemon responds to the "
16580 "ping message, without affecting the daemon or attached block device(s) in "
16586 #: ../src/guestfs-actions.pod:5240
16587 msgid "guestfs_pread"
16592 #: ../src/guestfs-actions.pod:5242
16596 " guestfs_pread (guestfs_h *g,\n"
16597 " const char *path,\n"
16599 " int64_t offset,\n"
16600 " size_t *size_r);\n"
16606 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3542
16608 "This command lets you read part of a file. It reads C<count> bytes of the "
16609 "file, starting at C<offset>, from file C<path>."
16614 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278
16615 #: ../fish/guestfish-actions.pod:3545 ../fish/guestfish-actions.pod:3560
16617 "This may read fewer bytes than requested. For further details see the "
16618 "L<pread(2)> system call."
16623 #: ../src/guestfs-actions.pod:5255
16624 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16629 #: ../src/guestfs-actions.pod:5266
16630 msgid "guestfs_pread_device"
16635 #: ../src/guestfs-actions.pod:5268
16639 " guestfs_pread_device (guestfs_h *g,\n"
16640 " const char *device,\n"
16642 " int64_t offset,\n"
16643 " size_t *size_r);\n"
16649 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3557
16651 "This command lets you read part of a file. It reads C<count> bytes of "
16652 "C<device>, starting at C<offset>."
16657 #: ../src/guestfs-actions.pod:5281
16658 msgid "See also C<guestfs_pread>."
16663 #: ../src/guestfs-actions.pod:5290
16664 msgid "(Added in 1.5.21)"
16669 #: ../src/guestfs-actions.pod:5292
16670 msgid "guestfs_pvcreate"
16675 #: ../src/guestfs-actions.pod:5294
16679 " guestfs_pvcreate (guestfs_h *g,\n"
16680 " const char *device);\n"
16686 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3572
16688 "This creates an LVM physical volume on the named C<device>, where C<device> "
16689 "should usually be a partition name such as C</dev/sda1>."
16694 #: ../src/guestfs-actions.pod:5306
16695 msgid "guestfs_pvremove"
16700 #: ../src/guestfs-actions.pod:5308
16704 " guestfs_pvremove (guestfs_h *g,\n"
16705 " const char *device);\n"
16711 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3580
16713 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16719 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3583
16721 "The implementation uses the C<pvremove> command which refuses to wipe "
16722 "physical volumes that contain any volume groups, so you have to remove those "
16728 #: ../src/guestfs-actions.pod:5323
16729 msgid "guestfs_pvresize"
16734 #: ../src/guestfs-actions.pod:5325
16738 " guestfs_pvresize (guestfs_h *g,\n"
16739 " const char *device);\n"
16745 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3591
16747 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16748 "the new size of the underlying device."
16753 #: ../src/guestfs-actions.pod:5336
16754 msgid "guestfs_pvresize_size"
16759 #: ../src/guestfs-actions.pod:5338
16763 " guestfs_pvresize_size (guestfs_h *g,\n"
16764 " const char *device,\n"
16765 " int64_t size);\n"
16771 #: ../src/guestfs-actions.pod:5343
16773 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16774 "specify the new size (in bytes) explicitly."
16779 #: ../src/guestfs-actions.pod:5350
16780 msgid "guestfs_pvs"
16785 #: ../src/guestfs-actions.pod:5352
16789 " guestfs_pvs (guestfs_h *g);\n"
16795 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3605
16797 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16803 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3608
16805 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16811 #: ../src/guestfs-actions.pod:5361
16812 msgid "See also C<guestfs_pvs_full>."
16817 #: ../src/guestfs-actions.pod:5369
16818 msgid "guestfs_pvs_full"
16823 #: ../src/guestfs-actions.pod:5371
16826 " struct guestfs_lvm_pv_list *\n"
16827 " guestfs_pvs_full (guestfs_h *g);\n"
16833 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3617
16835 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16836 "(8)> command. The \"full\" version includes all fields."
16841 #: ../src/guestfs-actions.pod:5377
16843 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16844 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16849 #: ../src/guestfs-actions.pod:5383
16850 msgid "guestfs_pvuuid"
16855 #: ../src/guestfs-actions.pod:5385
16859 " guestfs_pvuuid (guestfs_h *g,\n"
16860 " const char *device);\n"
16866 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3624
16867 msgid "This command returns the UUID of the LVM PV C<device>."
16872 #: ../src/guestfs-actions.pod:5396
16873 msgid "guestfs_pwrite"
16878 #: ../src/guestfs-actions.pod:5398
16882 " guestfs_pwrite (guestfs_h *g,\n"
16883 " const char *path,\n"
16884 " const char *content,\n"
16885 " size_t content_size,\n"
16886 " int64_t offset);\n"
16892 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3630
16894 "This command writes to part of a file. It writes the data buffer C<content> "
16895 "to the file C<path> starting at offset C<offset>."
16900 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3633
16902 "This command implements the L<pwrite(2)> system call, and like that system "
16903 "call it may not write the full data requested. The return value is the "
16904 "number of bytes that were actually written to the file. This could even be "
16905 "0, although short writes are unlikely for regular files in ordinary "
16911 #: ../src/guestfs-actions.pod:5414
16912 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16917 #: ../src/guestfs-actions.pod:5423
16918 msgid "guestfs_pwrite_device"
16923 #: ../src/guestfs-actions.pod:5425
16927 " guestfs_pwrite_device (guestfs_h *g,\n"
16928 " const char *device,\n"
16929 " const char *content,\n"
16930 " size_t content_size,\n"
16931 " int64_t offset);\n"
16937 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
16939 "This command writes to part of a device. It writes the data buffer "
16940 "C<content> to C<device> starting at offset C<offset>."
16945 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3651
16947 "This command implements the L<pwrite(2)> system call, and like that system "
16948 "call it may not write the full data requested (although short writes to disk "
16949 "devices and partitions are probably impossible with standard Linux kernels)."
16954 #: ../src/guestfs-actions.pod:5440
16955 msgid "See also C<guestfs_pwrite>."
16960 #: ../src/guestfs-actions.pod:5447
16961 msgid "(Added in 1.5.20)"
16966 #: ../src/guestfs-actions.pod:5449
16967 msgid "guestfs_read_file"
16972 #: ../src/guestfs-actions.pod:5451
16976 " guestfs_read_file (guestfs_h *g,\n"
16977 " const char *path,\n"
16978 " size_t *size_r);\n"
16984 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3665
16985 msgid "This calls returns the contents of the file C<path> as a buffer."
16990 #: ../src/guestfs-actions.pod:5459
16992 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16993 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16994 "function is limited in the total size of file that can be handled."
16999 #: ../src/guestfs-actions.pod:5471
17000 msgid "(Added in 1.0.63)"
17005 #: ../src/guestfs-actions.pod:5473
17006 msgid "guestfs_read_lines"
17011 #: ../src/guestfs-actions.pod:5475
17015 " guestfs_read_lines (guestfs_h *g,\n"
17016 " const char *path);\n"
17022 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3682
17024 "The file contents are returned as a list of lines. Trailing C<LF> and "
17025 "C<CRLF> character sequences are I<not> returned."
17030 #: ../src/guestfs-actions.pod:5484
17032 "Note that this function cannot correctly handle binary files (specifically, "
17033 "files containing C<\\0> character which is treated as end of line). For "
17034 "those you need to use the C<guestfs_read_file> function which has a more "
17035 "complex interface."
17040 #: ../src/guestfs-actions.pod:5495
17041 msgid "guestfs_readdir"
17046 #: ../src/guestfs-actions.pod:5497
17049 " struct guestfs_dirent_list *\n"
17050 " guestfs_readdir (guestfs_h *g,\n"
17051 " const char *dir);\n"
17057 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
17058 msgid "This returns the list of directory entries in directory C<dir>."
17063 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
17065 "All entries in the directory are returned, including C<.> and C<..>. The "
17066 "entries are I<not> sorted, but returned in the same order as the underlying "
17072 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
17074 "Also this call returns basic file type information about each file. The "
17075 "C<ftyp> field will contain one of the following characters:"
17080 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
17086 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3707
17087 msgid "Block special"
17092 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3709
17098 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3711
17099 msgid "Char special"
17104 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3713
17110 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3715
17116 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3717
17122 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3719
17123 msgid "FIFO (named pipe)"
17128 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3721
17134 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3723
17135 msgid "Symbolic link"
17140 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3725
17146 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3727
17147 msgid "Regular file"
17152 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3729
17158 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3731
17164 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3733
17170 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3735
17171 msgid "Unknown file type"
17176 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3737
17182 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3739
17184 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17189 #: ../src/guestfs-actions.pod:5551
17191 "This function is primarily intended for use by programs. To get a simple "
17192 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17193 "consumption, use C<guestfs_ll>."
17198 #: ../src/guestfs-actions.pod:5555
17200 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17201 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17206 #: ../src/guestfs-actions.pod:5561
17207 msgid "guestfs_readlink"
17212 #: ../src/guestfs-actions.pod:5563
17216 " guestfs_readlink (guestfs_h *g,\n"
17217 " const char *path);\n"
17223 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3752
17224 msgid "This command reads the target of a symbolic link."
17229 #: ../src/guestfs-actions.pod:5574
17230 msgid "guestfs_readlinklist"
17235 #: ../src/guestfs-actions.pod:5576
17239 " guestfs_readlinklist (guestfs_h *g,\n"
17240 " const char *path,\n"
17241 " char *const *names);\n"
17247 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3758
17249 "This call allows you to do a C<readlink> operation on multiple files, where "
17250 "all files are in the directory C<path>. C<names> is the list of files from "
17256 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3762
17258 "On return you get a list of strings, with a one-to-one correspondence to the "
17259 "C<names> list. Each string is the value of the symbolic link."
17264 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3766
17266 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17267 "result string is the empty string C<\"\">. However the whole operation is "
17268 "completed even if there were C<readlink(2)> errors, and so you can call this "
17269 "function with names where you don't know if they are symbolic links already "
17270 "(albeit slightly less efficient)."
17275 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3773
17277 "This call is intended for programs that want to efficiently list a directory "
17278 "contents without making many round-trips. Very long directory listings "
17279 "might cause the protocol message size to be exceeded, causing this call to "
17280 "fail. The caller must split up such requests into smaller groups of names."
17285 #: ../src/guestfs-actions.pod:5609
17286 msgid "guestfs_realpath"
17291 #: ../src/guestfs-actions.pod:5611
17295 " guestfs_realpath (guestfs_h *g,\n"
17296 " const char *path);\n"
17302 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3784
17304 "Return the canonicalized absolute pathname of C<path>. The returned path "
17305 "has no C<.>, C<..> or symbolic link path elements."
17310 #: ../src/guestfs-actions.pod:5623
17311 msgid "guestfs_removexattr"
17316 #: ../src/guestfs-actions.pod:5625
17320 " guestfs_removexattr (guestfs_h *g,\n"
17321 " const char *xattr,\n"
17322 " const char *path);\n"
17328 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3791
17330 "This call removes the extended attribute named C<xattr> of the file C<path>."
17335 #: ../src/guestfs-actions.pod:5633
17336 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17341 #: ../src/guestfs-actions.pod:5639
17342 msgid "guestfs_resize2fs"
17347 #: ../src/guestfs-actions.pod:5641
17351 " guestfs_resize2fs (guestfs_h *g,\n"
17352 " const char *device);\n"
17358 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3800
17360 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17361 "underlying device."
17366 #: ../src/guestfs-actions.pod:5648
17368 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17369 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17370 "sometimes gives an error about this and sometimes not. In any case, it is "
17371 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17375 #: ../src/guestfs-actions.pod:5658
17376 msgid "guestfs_resize2fs_M"
17380 #: ../src/guestfs-actions.pod:5660
17384 " guestfs_resize2fs_M (guestfs_h *g,\n"
17385 " const char *device);\n"
17390 #: ../src/guestfs-actions.pod:5664
17392 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17393 "resized to its minimum size. This works like the I<-M> option to the "
17394 "C<resize2fs> command."
17398 #: ../src/guestfs-actions.pod:5668
17400 "To get the resulting size of the filesystem you should call "
17401 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17402 "These two numbers, multiplied together, give the resulting size of the "
17403 "minimal filesystem in bytes."
17408 #: ../src/guestfs-actions.pod:5675
17409 msgid "guestfs_resize2fs_size"
17414 #: ../src/guestfs-actions.pod:5677
17418 " guestfs_resize2fs_size (guestfs_h *g,\n"
17419 " const char *device,\n"
17420 " int64_t size);\n"
17426 #: ../src/guestfs-actions.pod:5682
17428 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17429 "to specify the new size (in bytes) explicitly."
17434 #: ../src/guestfs-actions.pod:5689
17440 #: ../src/guestfs-actions.pod:5691
17444 " guestfs_rm (guestfs_h *g,\n"
17445 " const char *path);\n"
17451 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3833
17452 msgid "Remove the single file C<path>."
17457 #: ../src/guestfs-actions.pod:5701
17458 msgid "guestfs_rm_rf"
17463 #: ../src/guestfs-actions.pod:5703
17467 " guestfs_rm_rf (guestfs_h *g,\n"
17468 " const char *path);\n"
17474 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3839
17476 "Remove the file or directory C<path>, recursively removing the contents if "
17477 "its a directory. This is like the C<rm -rf> shell command."
17482 #: ../src/guestfs-actions.pod:5715
17483 msgid "guestfs_rmdir"
17488 #: ../src/guestfs-actions.pod:5717
17492 " guestfs_rmdir (guestfs_h *g,\n"
17493 " const char *path);\n"
17499 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3847
17500 msgid "Remove the single directory C<path>."
17505 #: ../src/guestfs-actions.pod:5727
17506 msgid "guestfs_rmmountpoint"
17511 #: ../src/guestfs-actions.pod:5729
17515 " guestfs_rmmountpoint (guestfs_h *g,\n"
17516 " const char *exemptpath);\n"
17522 #: ../src/guestfs-actions.pod:5733
17524 "This calls removes a mountpoint that was previously created with "
17525 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17530 #: ../src/guestfs-actions.pod:5741
17531 msgid "guestfs_scrub_device"
17536 #: ../src/guestfs-actions.pod:5743
17540 " guestfs_scrub_device (guestfs_h *g,\n"
17541 " const char *device);\n"
17547 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3861
17549 "This command writes patterns over C<device> to make data retrieval more "
17555 #: ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5771
17556 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3864
17557 #: ../fish/guestfish-actions.pod:3879 ../fish/guestfish-actions.pod:3892
17559 "It is an interface to the L<scrub(1)> program. See that manual page for "
17565 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5776
17566 #: ../src/guestfs-actions.pod:5795
17567 msgid "(Added in 1.0.52)"
17572 #: ../src/guestfs-actions.pod:5760
17573 msgid "guestfs_scrub_file"
17578 #: ../src/guestfs-actions.pod:5762
17582 " guestfs_scrub_file (guestfs_h *g,\n"
17583 " const char *file);\n"
17589 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3874
17591 "This command writes patterns over a file to make data retrieval more "
17597 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3877
17598 msgid "The file is I<removed> after scrubbing."
17603 #: ../src/guestfs-actions.pod:5778
17604 msgid "guestfs_scrub_freespace"
17609 #: ../src/guestfs-actions.pod:5780
17613 " guestfs_scrub_freespace (guestfs_h *g,\n"
17614 " const char *dir);\n"
17620 #: ../src/guestfs-actions.pod:5784
17622 "This command creates the directory C<dir> and then fills it with files until "
17623 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17624 "and deletes them. The intention is to scrub any free space on the partition "
17625 "containing C<dir>."
17630 #: ../src/guestfs-actions.pod:5797
17631 msgid "guestfs_set_append"
17636 #: ../src/guestfs-actions.pod:5799
17640 " guestfs_set_append (guestfs_h *g,\n"
17641 " const char *append);\n"
17647 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3901
17649 "This function is used to add additional options to the guest kernel command "
17655 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3904
17657 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17658 "environment variable."
17663 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3907
17665 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17666 "(libguestfs always adds a few of its own)."
17670 #: ../src/guestfs-actions.pod:5816
17671 msgid "guestfs_set_attach_method"
17675 #: ../src/guestfs-actions.pod:5818
17679 " guestfs_set_attach_method (guestfs_h *g,\n"
17680 " const char *attachmethod);\n"
17685 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3916
17687 "Set the method that libguestfs uses to connect to the back end guestfsd "
17688 "daemon. Possible methods are:"
17692 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3923
17694 "Launch an appliance and connect to it. This is the ordinary method and the "
17699 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3926
17700 msgid "C<unix:I<path>>"
17704 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
17705 msgid "Connect to the Unix domain socket I<path>."
17709 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3930
17711 "This method lets you connect to an existing daemon or (using virtio-serial) "
17712 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17713 "RUNNING DAEMONS>."
17718 #: ../src/guestfs-actions.pod:5844
17719 msgid "guestfs_set_autosync"
17724 #: ../src/guestfs-actions.pod:5846
17728 " guestfs_set_autosync (guestfs_h *g,\n"
17729 " int autosync);\n"
17734 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3942
17736 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17737 "effort attempt to make filesystems consistent and synchronized when the "
17738 "handle is closed (also if the program exits without closing handles)."
17743 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
17745 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17746 "disabled by default)."
17751 #: ../src/guestfs-actions.pod:5862
17752 msgid "guestfs_set_direct"
17757 #: ../src/guestfs-actions.pod:5864
17761 " guestfs_set_direct (guestfs_h *g,\n"
17768 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3956
17770 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17771 "passed directly through to the appliance once it is launched."
17776 #: ../src/guestfs-actions.pod:5872
17778 "One consequence of this is that log messages aren't caught by the library "
17779 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17785 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3964
17786 msgid "You probably don't want to use this unless you know what you are doing."
17791 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3967
17792 msgid "The default is disabled."
17797 #: ../src/guestfs-actions.pod:5885
17798 msgid "guestfs_set_e2label"
17803 #: ../src/guestfs-actions.pod:5887
17807 " guestfs_set_e2label (guestfs_h *g,\n"
17808 " const char *device,\n"
17809 " const char *label);\n"
17815 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3973
17817 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17818 "C<label>. Filesystem labels are limited to 16 characters."
17823 #: ../src/guestfs-actions.pod:5896
17825 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17826 "the existing label on a filesystem."
17831 #: ../src/guestfs-actions.pod:5903
17832 msgid "guestfs_set_e2uuid"
17837 #: ../src/guestfs-actions.pod:5905
17841 " guestfs_set_e2uuid (guestfs_h *g,\n"
17842 " const char *device,\n"
17843 " const char *uuid);\n"
17849 #: ../src/guestfs-actions.pod:5910 ../fish/guestfish-actions.pod:3984
17851 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17852 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17853 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17858 #: ../src/guestfs-actions.pod:5915
17860 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17861 "the existing UUID of a filesystem."
17866 #: ../src/guestfs-actions.pod:5922
17867 msgid "guestfs_set_memsize"
17872 #: ../src/guestfs-actions.pod:5924
17876 " guestfs_set_memsize (guestfs_h *g,\n"
17883 #: ../src/guestfs-actions.pod:5928
17885 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17886 "This only has any effect if called before C<guestfs_launch>."
17891 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:4002
17893 "You can also change this by setting the environment variable "
17894 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17899 #: ../src/guestfs-actions.pod:5943
17900 msgid "guestfs_set_network"
17905 #: ../src/guestfs-actions.pod:5945
17909 " guestfs_set_network (guestfs_h *g,\n"
17916 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4015
17918 "If C<network> is true, then the network is enabled in the libguestfs "
17919 "appliance. The default is false."
17924 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4018
17926 "This affects whether commands are able to access the network (see L<guestfs"
17927 "(3)/RUNNING COMMANDS>)."
17932 #: ../src/guestfs-actions.pod:5955
17934 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17940 #: ../src/guestfs-actions.pod:5962
17941 msgid "guestfs_set_path"
17946 #: ../src/guestfs-actions.pod:5964
17950 " guestfs_set_path (guestfs_h *g,\n"
17951 " const char *searchpath);\n"
17957 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4030
17958 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17963 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:4032
17965 "The default is C<$libdir/guestfs> unless overridden by setting "
17966 "C<LIBGUESTFS_PATH> environment variable."
17971 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
17972 msgid "Setting C<path> to C<NULL> restores the default path."
17977 #: ../src/guestfs-actions.pod:5979
17978 msgid "guestfs_set_qemu"
17983 #: ../src/guestfs-actions.pod:5981
17987 " guestfs_set_qemu (guestfs_h *g,\n"
17988 " const char *qemu);\n"
17994 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4043
17995 msgid "Set the qemu binary that we will use."
18000 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:4045
18002 "The default is chosen when the library was compiled by the configure script."
18007 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
18009 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18015 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4051
18016 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18021 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
18023 "Note that you should call this function as early as possible after creating "
18024 "the handle. This is because some pre-launch operations depend on testing "
18025 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18026 "don't retest features, and so you might see inconsistent results. Using the "
18027 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18028 "the qemu binary at the same time as the handle is created."
18033 #: ../src/guestfs-actions.pod:6007
18034 msgid "guestfs_set_recovery_proc"
18039 #: ../src/guestfs-actions.pod:6009
18043 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18044 " int recoveryproc);\n"
18050 #: ../src/guestfs-actions.pod:6013
18052 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18053 "not create a recovery process. The purpose of the recovery process is to "
18054 "stop runaway qemu processes in the case where the main program aborts "
18060 #: ../src/guestfs-actions.pod:6018
18062 "This only has any effect if called before C<guestfs_launch>, and the default "
18068 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4075
18070 "About the only time when you would want to disable this is if the main "
18071 "process will fork itself into the background (\"daemonize\" itself). In "
18072 "this case the recovery process thinks that the main program has disappeared "
18073 "and so kills qemu, which is not very helpful."
18078 #: ../src/guestfs-actions.pod:6031
18079 msgid "guestfs_set_selinux"
18084 #: ../src/guestfs-actions.pod:6033
18088 " guestfs_set_selinux (guestfs_h *g,\n"
18095 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4087
18097 "This sets the selinux flag that is passed to the appliance at boot time. "
18098 "The default is C<selinux=0> (disabled)."
18103 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4090
18105 "Note that if SELinux is enabled, it is always in Permissive mode "
18106 "(C<enforcing=0>)."
18111 #: ../src/guestfs-actions.pod:6050
18112 msgid "guestfs_set_trace"
18117 #: ../src/guestfs-actions.pod:6052
18121 " guestfs_set_trace (guestfs_h *g,\n"
18127 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4102
18129 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18130 "return values are traced."
18135 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4105
18137 "If you want to trace C API calls into libguestfs (and other libraries) then "
18138 "possibly a better way is to use the external ltrace(1) command."
18143 #: ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:4109
18145 "Command traces are disabled unless the environment variable "
18146 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18150 #: ../src/guestfs-actions.pod:6066
18152 "Trace messages are normally sent to C<stderr>, unless you register a "
18153 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18158 #: ../src/guestfs-actions.pod:6074
18159 msgid "guestfs_set_verbose"
18164 #: ../src/guestfs-actions.pod:6076
18168 " guestfs_set_verbose (guestfs_h *g,\n"
18174 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4122
18175 msgid "If C<verbose> is true, this turns on verbose messages."
18180 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4124
18182 "Verbose messages are disabled unless the environment variable "
18183 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18187 #: ../src/guestfs-actions.pod:6085
18189 "Verbose messages are normally sent to C<stderr>, unless you register a "
18190 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18195 #: ../src/guestfs-actions.pod:6093
18196 msgid "guestfs_setcon"
18201 #: ../src/guestfs-actions.pod:6095
18205 " guestfs_setcon (guestfs_h *g,\n"
18206 " const char *context);\n"
18212 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4135
18214 "This sets the SELinux security context of the daemon to the string "
18220 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4138
18221 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18226 #: ../src/guestfs-actions.pod:6108
18227 msgid "guestfs_setxattr"
18232 #: ../src/guestfs-actions.pod:6110
18236 " guestfs_setxattr (guestfs_h *g,\n"
18237 " const char *xattr,\n"
18238 " const char *val,\n"
18240 " const char *path);\n"
18246 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4144
18248 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18249 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18254 #: ../src/guestfs-actions.pod:6121
18255 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18260 #: ../src/guestfs-actions.pod:6127
18261 msgid "guestfs_sfdisk"
18266 #: ../src/guestfs-actions.pod:6129
18270 " guestfs_sfdisk (guestfs_h *g,\n"
18271 " const char *device,\n"
18275 " char *const *lines);\n"
18281 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
18283 "This is a direct interface to the L<sfdisk(8)> program for creating "
18284 "partitions on block devices."
18289 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
18290 msgid "C<device> should be a block device, for example C</dev/sda>."
18295 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
18297 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18298 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18299 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18300 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18301 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18302 "the kernel) cannot work out the right geometry and you will need to tell it."
18307 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4167
18309 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18310 "refer to the L<sfdisk(8)> manpage."
18315 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4170
18317 "To create a single partition occupying the whole disk, you would pass "
18318 "C<lines> as a single element list, when the single element being the string "
18324 #: ../src/guestfs-actions.pod:6157
18326 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18330 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195
18331 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4180
18332 #: ../fish/guestfish-actions.pod:4203 ../fish/guestfish-actions.pod:4225
18334 "This function is deprecated. In new code, use the C<part_add> call instead."
18339 #: ../src/guestfs-actions.pod:6174
18340 msgid "guestfs_sfdiskM"
18345 #: ../src/guestfs-actions.pod:6176
18349 " guestfs_sfdiskM (guestfs_h *g,\n"
18350 " const char *device,\n"
18351 " char *const *lines);\n"
18357 #: ../src/guestfs-actions.pod:6181
18359 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18360 "partition sizes are specified in megabytes only (rounded to the nearest "
18361 "cylinder) and you don't need to specify the cyls, heads and sectors "
18362 "parameters which were rarely if ever used anyway."
18367 #: ../src/guestfs-actions.pod:6187
18369 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18370 "C<guestfs_part_disk>"
18375 #: ../src/guestfs-actions.pod:6204
18376 msgid "guestfs_sfdisk_N"
18381 #: ../src/guestfs-actions.pod:6206
18385 " guestfs_sfdisk_N (guestfs_h *g,\n"
18386 " const char *device,\n"
18391 " const char *line);\n"
18397 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4214
18399 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18400 "(note: C<n> counts from 1)."
18405 #: ../src/guestfs-actions.pod:6218
18407 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18408 "for the cyls/heads/sectors parameters."
18413 #: ../src/guestfs-actions.pod:6221
18414 msgid "See also: C<guestfs_part_add>"
18419 #: ../src/guestfs-actions.pod:6237
18420 msgid "guestfs_sfdisk_disk_geometry"
18425 #: ../src/guestfs-actions.pod:6239
18429 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18430 " const char *device);\n"
18436 #: ../src/guestfs-actions.pod:6243
18438 "This displays the disk geometry of C<device> read from the partition table. "
18439 "Especially in the case where the underlying block device has been resized, "
18440 "this can be different from the kernel's idea of the geometry (see "
18441 "C<guestfs_sfdisk_kernel_geometry>)."
18446 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6264
18447 #: ../fish/guestfish-actions.pod:4241 ../fish/guestfish-actions.pod:4250
18448 msgid "The result is in human-readable format, and not designed to be parsed."
18453 #: ../src/guestfs-actions.pod:6256
18454 msgid "guestfs_sfdisk_kernel_geometry"
18459 #: ../src/guestfs-actions.pod:6258
18463 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18464 " const char *device);\n"
18470 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4248
18471 msgid "This displays the kernel's idea of the geometry of C<device>."
18476 #: ../src/guestfs-actions.pod:6272
18477 msgid "guestfs_sfdisk_l"
18482 #: ../src/guestfs-actions.pod:6274
18486 " guestfs_sfdisk_l (guestfs_h *g,\n"
18487 " const char *device);\n"
18493 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4257
18495 "This displays the partition table on C<device>, in the human-readable output "
18496 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18501 #: ../src/guestfs-actions.pod:6282
18502 msgid "See also: C<guestfs_part_list>"
18506 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4263
18508 "This function is deprecated. In new code, use the C<part_list> call instead."
18513 #: ../src/guestfs-actions.pod:6296
18519 #: ../src/guestfs-actions.pod:6298
18523 " guestfs_sh (guestfs_h *g,\n"
18524 " const char *command);\n"
18530 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4274
18532 "This call runs a command from the guest filesystem via the guest's C</bin/"
18538 #: ../src/guestfs-actions.pod:6305
18539 msgid "This is like C<guestfs_command>, but passes the command to:"
18544 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
18547 " /bin/sh -c \"command\"\n"
18553 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4281
18555 "Depending on the guest's shell, this usually results in wildcards being "
18556 "expanded, shell expressions being interpolated and so on."
18561 #: ../src/guestfs-actions.pod:6313
18562 msgid "All the provisos about C<guestfs_command> apply to this call."
18567 #: ../src/guestfs-actions.pod:6320
18568 msgid "guestfs_sh_lines"
18573 #: ../src/guestfs-actions.pod:6322
18577 " guestfs_sh_lines (guestfs_h *g,\n"
18578 " const char *command);\n"
18584 #: ../src/guestfs-actions.pod:6326
18586 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18592 #: ../src/guestfs-actions.pod:6329
18593 msgid "See also: C<guestfs_command_lines>"
18598 #: ../src/guestfs-actions.pod:6337
18599 msgid "guestfs_sleep"
18604 #: ../src/guestfs-actions.pod:6339
18608 " guestfs_sleep (guestfs_h *g,\n"
18615 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4300
18616 msgid "Sleep for C<secs> seconds."
18621 #: ../src/guestfs-actions.pod:6347
18622 msgid "(Added in 1.0.41)"
18627 #: ../src/guestfs-actions.pod:6349 ../src/guestfs-structs.pod:109
18628 msgid "guestfs_stat"
18633 #: ../src/guestfs-actions.pod:6351
18636 " struct guestfs_stat *\n"
18637 " guestfs_stat (guestfs_h *g,\n"
18638 " const char *path);\n"
18644 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4308
18645 msgid "This is the same as the C<stat(2)> system call."
18650 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-structs.pod:135
18651 msgid "guestfs_statvfs"
18656 #: ../src/guestfs-actions.pod:6367
18659 " struct guestfs_statvfs *\n"
18660 " guestfs_statvfs (guestfs_h *g,\n"
18661 " const char *path);\n"
18667 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4314
18669 "Returns file system statistics for any mounted file system. C<path> should "
18670 "be a file or directory in the mounted file system (typically it is the mount "
18671 "point itself, but it doesn't need to be)."
18676 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4318
18677 msgid "This is the same as the C<statvfs(2)> system call."
18682 #: ../src/guestfs-actions.pod:6377
18684 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18685 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18690 #: ../src/guestfs-actions.pod:6383
18691 msgid "guestfs_strings"
18696 #: ../src/guestfs-actions.pod:6385
18700 " guestfs_strings (guestfs_h *g,\n"
18701 " const char *path);\n"
18707 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4324
18709 "This runs the L<strings(1)> command on a file and returns the list of "
18710 "printable strings found."
18715 #: ../src/guestfs-actions.pod:6401
18716 msgid "guestfs_strings_e"
18721 #: ../src/guestfs-actions.pod:6403
18725 " guestfs_strings_e (guestfs_h *g,\n"
18726 " const char *encoding,\n"
18727 " const char *path);\n"
18733 #: ../src/guestfs-actions.pod:6408
18735 "This is like the C<guestfs_strings> command, but allows you to specify the "
18736 "encoding of strings that are looked for in the source file C<path>."
18741 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4338
18742 msgid "Allowed encodings are:"
18747 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4342
18753 #: ../src/guestfs-actions.pod:6418
18755 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18756 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18761 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
18767 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4349
18768 msgid "Single 8-bit-byte characters."
18773 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4351
18779 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4353
18780 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18785 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
18786 msgid "l (lower case letter L)"
18791 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
18793 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18794 "examining binaries in Windows guests."
18799 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
18805 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
18806 msgid "32-bit big endian such as UCS-4BE."
18811 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4365
18817 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4367
18818 msgid "32-bit little endian such as UCS-4LE."
18823 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4371
18824 msgid "The returned strings are transcoded to UTF-8."
18829 #: ../src/guestfs-actions.pod:6456
18830 msgid "guestfs_swapoff_device"
18835 #: ../src/guestfs-actions.pod:6458
18839 " guestfs_swapoff_device (guestfs_h *g,\n"
18840 " const char *device);\n"
18846 #: ../src/guestfs-actions.pod:6462
18848 "This command disables the libguestfs appliance swap device or partition "
18849 "named C<device>. See C<guestfs_swapon_device>."
18854 #: ../src/guestfs-actions.pod:6470
18855 msgid "guestfs_swapoff_file"
18860 #: ../src/guestfs-actions.pod:6472
18864 " guestfs_swapoff_file (guestfs_h *g,\n"
18865 " const char *file);\n"
18871 #: ../src/guestfs-actions.pod:6476 ../fish/guestfish-actions.pod:4388
18872 msgid "This command disables the libguestfs appliance swap on file."
18877 #: ../src/guestfs-actions.pod:6482
18878 msgid "guestfs_swapoff_label"
18883 #: ../src/guestfs-actions.pod:6484
18887 " guestfs_swapoff_label (guestfs_h *g,\n"
18888 " const char *label);\n"
18894 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4394
18896 "This command disables the libguestfs appliance swap on labeled swap "
18902 #: ../src/guestfs-actions.pod:6495
18903 msgid "guestfs_swapoff_uuid"
18908 #: ../src/guestfs-actions.pod:6497
18912 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18913 " const char *uuid);\n"
18919 #: ../src/guestfs-actions.pod:6501 ../fish/guestfish-actions.pod:4401
18921 "This command disables the libguestfs appliance swap partition with the given "
18927 #: ../src/guestfs-actions.pod:6508
18928 msgid "guestfs_swapon_device"
18933 #: ../src/guestfs-actions.pod:6510
18937 " guestfs_swapon_device (guestfs_h *g,\n"
18938 " const char *device);\n"
18944 #: ../src/guestfs-actions.pod:6514
18946 "This command enables the libguestfs appliance to use the swap device or "
18947 "partition named C<device>. The increased memory is made available for all "
18948 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18953 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4413
18955 "Note that you should not swap to existing guest swap partitions unless you "
18956 "know what you are doing. They may contain hibernation information, or other "
18957 "information that the guest doesn't want you to trash. You also risk leaking "
18958 "information about the host to the guest this way. Instead, attach a new "
18959 "host device to the guest and swap on that."
18964 #: ../src/guestfs-actions.pod:6530
18965 msgid "guestfs_swapon_file"
18970 #: ../src/guestfs-actions.pod:6532
18974 " guestfs_swapon_file (guestfs_h *g,\n"
18975 " const char *file);\n"
18981 #: ../src/guestfs-actions.pod:6536
18983 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18989 #: ../src/guestfs-actions.pod:6543
18990 msgid "guestfs_swapon_label"
18995 #: ../src/guestfs-actions.pod:6545
18999 " guestfs_swapon_label (guestfs_h *g,\n"
19000 " const char *label);\n"
19006 #: ../src/guestfs-actions.pod:6549
19008 "This command enables swap to a labeled swap partition. See "
19009 "C<guestfs_swapon_device> for other notes."
19014 #: ../src/guestfs-actions.pod:6556
19015 msgid "guestfs_swapon_uuid"
19020 #: ../src/guestfs-actions.pod:6558
19024 " guestfs_swapon_uuid (guestfs_h *g,\n"
19025 " const char *uuid);\n"
19031 #: ../src/guestfs-actions.pod:6562
19033 "This command enables swap to a swap partition with the given UUID. See "
19034 "C<guestfs_swapon_device> for other notes."
19039 #: ../src/guestfs-actions.pod:6569
19040 msgid "guestfs_sync"
19045 #: ../src/guestfs-actions.pod:6571
19049 " guestfs_sync (guestfs_h *g);\n"
19055 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4445
19057 "This syncs the disk, so that any writes are flushed through to the "
19058 "underlying disk image."
19063 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4448
19065 "You should always call this if you have modified a disk image, before "
19066 "closing the handle."
19071 #: ../src/guestfs-actions.pod:6584
19072 msgid "guestfs_tail"
19077 #: ../src/guestfs-actions.pod:6586
19081 " guestfs_tail (guestfs_h *g,\n"
19082 " const char *path);\n"
19088 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4455
19090 "This command returns up to the last 10 lines of a file as a list of strings."
19095 #: ../src/guestfs-actions.pod:6602
19096 msgid "guestfs_tail_n"
19101 #: ../src/guestfs-actions.pod:6604
19105 " guestfs_tail_n (guestfs_h *g,\n"
19107 " const char *path);\n"
19113 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4465
19115 "If the parameter C<nrlines> is a positive number, this returns the last "
19116 "C<nrlines> lines of the file C<path>."
19121 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4468
19123 "If the parameter C<nrlines> is a negative number, this returns lines from "
19124 "the file C<path>, starting with the C<-nrlines>th line."
19129 #: ../src/guestfs-actions.pod:6626
19130 msgid "guestfs_tar_in"
19135 #: ../src/guestfs-actions.pod:6628
19139 " guestfs_tar_in (guestfs_h *g,\n"
19140 " const char *tarfile,\n"
19141 " const char *directory);\n"
19147 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4480
19149 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19150 "tar file) into C<directory>."
19155 #: ../src/guestfs-actions.pod:6636
19157 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19162 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6658
19163 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6690
19164 msgid "(Added in 1.0.3)"
19169 #: ../src/guestfs-actions.pod:6643
19170 msgid "guestfs_tar_out"
19175 #: ../src/guestfs-actions.pod:6645
19179 " guestfs_tar_out (guestfs_h *g,\n"
19180 " const char *directory,\n"
19181 " const char *tarfile);\n"
19187 #: ../src/guestfs-actions.pod:6650 ../fish/guestfish-actions.pod:4492
19189 "This command packs the contents of C<directory> and downloads it to local "
19195 #: ../src/guestfs-actions.pod:6653
19197 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19198 "C<guestfs_txz_out>."
19203 #: ../src/guestfs-actions.pod:6660
19204 msgid "guestfs_tgz_in"
19209 #: ../src/guestfs-actions.pod:6662
19213 " guestfs_tgz_in (guestfs_h *g,\n"
19214 " const char *tarball,\n"
19215 " const char *directory);\n"
19221 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4504
19223 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19224 "tar file) into C<directory>."
19229 #: ../src/guestfs-actions.pod:6670
19230 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19235 #: ../src/guestfs-actions.pod:6676
19236 msgid "guestfs_tgz_out"
19241 #: ../src/guestfs-actions.pod:6678
19245 " guestfs_tgz_out (guestfs_h *g,\n"
19246 " const char *directory,\n"
19247 " const char *tarball);\n"
19253 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4515
19255 "This command packs the contents of C<directory> and downloads it to local "
19261 #: ../src/guestfs-actions.pod:6686
19262 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19267 #: ../src/guestfs-actions.pod:6692
19268 msgid "guestfs_touch"
19273 #: ../src/guestfs-actions.pod:6694
19277 " guestfs_touch (guestfs_h *g,\n"
19278 " const char *path);\n"
19284 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4526
19286 "Touch acts like the L<touch(1)> command. It can be used to update the "
19287 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19293 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4530
19295 "This command only works on regular files, and will fail on other file types "
19296 "such as directories, symbolic links, block special etc."
19301 #: ../src/guestfs-actions.pod:6709
19302 msgid "guestfs_truncate"
19307 #: ../src/guestfs-actions.pod:6711
19311 " guestfs_truncate (guestfs_h *g,\n"
19312 " const char *path);\n"
19318 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4537
19320 "This command truncates C<path> to a zero-length file. The file must exist "
19326 #: ../src/guestfs-actions.pod:6722
19327 msgid "guestfs_truncate_size"
19332 #: ../src/guestfs-actions.pod:6724
19336 " guestfs_truncate_size (guestfs_h *g,\n"
19337 " const char *path,\n"
19338 " int64_t size);\n"
19344 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4544
19346 "This command truncates C<path> to size C<size> bytes. The file must exist "
19352 #: ../src/guestfs-actions.pod:6732
19354 "If the current file size is less than C<size> then the file is extended to "
19355 "the required size with zero bytes. This creates a sparse file (ie. disk "
19356 "blocks are not allocated for the file until you write to it). To create a "
19357 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19362 #: ../src/guestfs-actions.pod:6742
19363 msgid "guestfs_tune2fs_l"
19368 #: ../src/guestfs-actions.pod:6744
19372 " guestfs_tune2fs_l (guestfs_h *g,\n"
19373 " const char *device);\n"
19379 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4557
19381 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19387 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4560
19389 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19390 "for more details. The list of fields returned isn't clearly defined, and "
19391 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19392 "and the filesystem itself."
19397 #: ../src/guestfs-actions.pod:6764
19398 msgid "guestfs_txz_in"
19403 #: ../src/guestfs-actions.pod:6766
19407 " guestfs_txz_in (guestfs_h *g,\n"
19408 " const char *tarball,\n"
19409 " const char *directory);\n"
19415 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4569
19417 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19418 "tar file) into C<directory>."
19423 #: ../src/guestfs-actions.pod:6778
19424 msgid "guestfs_txz_out"
19429 #: ../src/guestfs-actions.pod:6780
19433 " guestfs_txz_out (guestfs_h *g,\n"
19434 " const char *directory,\n"
19435 " const char *tarball);\n"
19441 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4578
19443 "This command packs the contents of C<directory> and downloads it to local "
19444 "file C<tarball> (as an xz compressed tar archive)."
19449 #: ../src/guestfs-actions.pod:6792
19450 msgid "guestfs_umask"
19455 #: ../src/guestfs-actions.pod:6794
19459 " guestfs_umask (guestfs_h *g,\n"
19466 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4587
19468 "This function sets the mask used for creating new files and device nodes to "
19474 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4590
19476 "Typical umask values would be C<022> which creates new files with "
19477 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19478 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19483 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
19485 "The default umask is C<022>. This is important because it means that "
19486 "directories and device nodes will be created with C<0644> or C<0755> mode "
19487 "even if you specify C<0777>."
19492 #: ../src/guestfs-actions.pod:6810
19494 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19495 "C<guestfs_mkdir>."
19500 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4602
19501 msgid "This call returns the previous umask."
19506 #: ../src/guestfs-actions.pod:6819
19507 msgid "guestfs_umount"
19512 #: ../src/guestfs-actions.pod:6821
19516 " guestfs_umount (guestfs_h *g,\n"
19517 " const char *pathordevice);\n"
19523 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4610
19525 "This unmounts the given filesystem. The filesystem may be specified either "
19526 "by its mountpoint (path) or the device which contains the filesystem."
19531 #: ../src/guestfs-actions.pod:6833
19532 msgid "guestfs_umount_all"
19537 #: ../src/guestfs-actions.pod:6835
19541 " guestfs_umount_all (guestfs_h *g);\n"
19547 #: ../src/guestfs-actions.pod:6838 ../fish/guestfish-actions.pod:4620
19548 msgid "This unmounts all mounted filesystems."
19553 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4622
19554 msgid "Some internal mounts are not unmounted by this call."
19559 #: ../src/guestfs-actions.pod:6846
19560 msgid "guestfs_upload"
19565 #: ../src/guestfs-actions.pod:6848
19569 " guestfs_upload (guestfs_h *g,\n"
19570 " const char *filename,\n"
19571 " const char *remotefilename);\n"
19577 #: ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6877
19578 #: ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4641
19579 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19584 #: ../src/guestfs-actions.pod:6858
19585 msgid "See also C<guestfs_download>."
19590 #: ../src/guestfs-actions.pod:6869
19591 msgid "guestfs_upload_offset"
19596 #: ../src/guestfs-actions.pod:6871
19600 " guestfs_upload_offset (guestfs_h *g,\n"
19601 " const char *filename,\n"
19602 " const char *remotefilename,\n"
19603 " int64_t offset);\n"
19609 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4644
19611 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19612 "The intention is to overwrite parts of existing files or devices, although "
19613 "if a non-existant file is specified then it is created with a \"hole\" "
19614 "before C<offset>. The size of the data written is implicit in the size of "
19615 "the source C<filename>."
19620 #: ../src/guestfs-actions.pod:6887
19622 "Note that there is no limit on the amount of data that can be uploaded with "
19623 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19624 "full amount unless an error occurs."
19629 #: ../src/guestfs-actions.pod:6892
19630 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19635 #: ../src/guestfs-actions.pod:6903
19636 msgid "guestfs_utimens"
19641 #: ../src/guestfs-actions.pod:6905
19645 " guestfs_utimens (guestfs_h *g,\n"
19646 " const char *path,\n"
19647 " int64_t atsecs,\n"
19648 " int64_t atnsecs,\n"
19649 " int64_t mtsecs,\n"
19650 " int64_t mtnsecs);\n"
19656 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4664
19657 msgid "This command sets the timestamps of a file with nanosecond precision."
19662 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4667
19664 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19670 #: ../src/guestfs-actions.pod:6919 ../fish/guestfish-actions.pod:4670
19672 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19673 "nanoseconds from the epoch."
19678 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4673
19680 "If the C<*nsecs> field contains the special value C<-1> then the "
19681 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19682 "ignored in this case)."
19687 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4677
19689 "If the C<*nsecs> field contains the special value C<-2> then the "
19690 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19696 #: ../src/guestfs-actions.pod:6934 ../src/guestfs-structs.pod:175
19697 msgid "guestfs_version"
19702 #: ../src/guestfs-actions.pod:6936
19705 " struct guestfs_version *\n"
19706 " guestfs_version (guestfs_h *g);\n"
19712 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4685
19714 "Return the libguestfs version number that the program is linked against."
19719 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4688
19721 "Note that because of dynamic linking this is not necessarily the version of "
19722 "libguestfs that you compiled against. You can compile the program, and then "
19723 "at runtime dynamically link against a completely different C<libguestfs.so> "
19729 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
19731 "This call was added in version C<1.0.58>. In previous versions of "
19732 "libguestfs there was no way to get the version number. From C code you can "
19733 "use dynamic linker functions to find out if this symbol exists (if it "
19734 "doesn't, then it's an earlier version)."
19739 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4699
19741 "The call returns a structure with four elements. The first three (C<major>, "
19742 "C<minor> and C<release>) are numbers and correspond to the usual version "
19743 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19744 "but may be used for distro-specific information."
19749 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4705
19751 "To construct the original version string: C<$major.$minor.$release$extra>"
19756 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4708
19757 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19762 #: ../src/guestfs-actions.pod:6964
19764 "I<Note:> Don't use this call to test for availability of features. In "
19765 "enterprise distributions we backport features from later versions into "
19766 "earlier versions, making this an unreliable way to test for features. Use "
19767 "C<guestfs_available> instead."
19772 #: ../src/guestfs-actions.pod:6970
19774 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19775 "error. I<The caller must call C<guestfs_free_version> after use>."
19780 #: ../src/guestfs-actions.pod:6974
19781 msgid "(Added in 1.0.58)"
19786 #: ../src/guestfs-actions.pod:6976
19787 msgid "guestfs_vfs_label"
19792 #: ../src/guestfs-actions.pod:6978
19796 " guestfs_vfs_label (guestfs_h *g,\n"
19797 " const char *device);\n"
19803 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4720
19804 msgid "This returns the filesystem label of the filesystem on C<device>."
19809 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4723
19810 msgid "If the filesystem is unlabeled, this returns the empty string."
19815 #: ../src/guestfs-actions.pod:6987
19816 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19821 #: ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7029
19822 msgid "(Added in 1.3.18)"
19827 #: ../src/guestfs-actions.pod:6994
19828 msgid "guestfs_vfs_type"
19833 #: ../src/guestfs-actions.pod:6996
19837 " guestfs_vfs_type (guestfs_h *g,\n"
19838 " const char *device);\n"
19844 #: ../src/guestfs-actions.pod:7000 ../fish/guestfish-actions.pod:4731
19846 "This command gets the filesystem type corresponding to the filesystem on "
19852 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4734
19854 "For most filesystems, the result is the name of the Linux VFS module which "
19855 "would be used to mount this filesystem if you mounted it without specifying "
19856 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19861 #: ../src/guestfs-actions.pod:7013
19862 msgid "guestfs_vfs_uuid"
19867 #: ../src/guestfs-actions.pod:7015
19871 " guestfs_vfs_uuid (guestfs_h *g,\n"
19872 " const char *device);\n"
19878 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4743
19879 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19884 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4746
19885 msgid "If the filesystem does not have a UUID, this returns the empty string."
19890 #: ../src/guestfs-actions.pod:7024
19891 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19896 #: ../src/guestfs-actions.pod:7031
19897 msgid "guestfs_vg_activate"
19902 #: ../src/guestfs-actions.pod:7033
19906 " guestfs_vg_activate (guestfs_h *g,\n"
19908 " char *const *volgroups);\n"
19914 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4754
19916 "This command activates or (if C<activate> is false) deactivates all logical "
19917 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19918 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19919 "deactivated, then those devices disappear."
19924 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4760
19925 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19930 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4762
19932 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19933 "activated or deactivated."
19938 #: ../src/guestfs-actions.pod:7053
19939 msgid "guestfs_vg_activate_all"
19944 #: ../src/guestfs-actions.pod:7055
19948 " guestfs_vg_activate_all (guestfs_h *g,\n"
19949 " int activate);\n"
19955 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4769
19957 "This command activates or (if C<activate> is false) deactivates all logical "
19958 "volumes in all volume groups. If activated, then they are made known to the "
19959 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19960 "those devices disappear."
19965 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4775
19966 msgid "This command is the same as running C<vgchange -a y|n>"
19971 #: ../src/guestfs-actions.pod:7071
19972 msgid "guestfs_vgcreate"
19977 #: ../src/guestfs-actions.pod:7073
19981 " guestfs_vgcreate (guestfs_h *g,\n"
19982 " const char *volgroup,\n"
19983 " char *const *physvols);\n"
19989 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4781
19991 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19992 "of physical volumes C<physvols>."
19997 #: ../src/guestfs-actions.pod:7085
19998 msgid "guestfs_vglvuuids"
20003 #: ../src/guestfs-actions.pod:7087
20007 " guestfs_vglvuuids (guestfs_h *g,\n"
20008 " const char *vgname);\n"
20014 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4788
20016 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20017 "volumes created in this volume group."
20022 #: ../src/guestfs-actions.pod:7094
20024 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20025 "associate logical volumes and volume groups."
20030 #: ../src/guestfs-actions.pod:7097
20031 msgid "See also C<guestfs_vgpvuuids>."
20036 #: ../src/guestfs-actions.pod:7105
20037 msgid "guestfs_vgpvuuids"
20042 #: ../src/guestfs-actions.pod:7107
20046 " guestfs_vgpvuuids (guestfs_h *g,\n"
20047 " const char *vgname);\n"
20053 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4800
20055 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20056 "volumes that this volume group resides on."
20061 #: ../src/guestfs-actions.pod:7114
20063 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20064 "associate physical volumes and volume groups."
20069 #: ../src/guestfs-actions.pod:7117
20070 msgid "See also C<guestfs_vglvuuids>."
20075 #: ../src/guestfs-actions.pod:7125
20076 msgid "guestfs_vgremove"
20081 #: ../src/guestfs-actions.pod:7127
20085 " guestfs_vgremove (guestfs_h *g,\n"
20086 " const char *vgname);\n"
20092 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4812
20093 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20098 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4814
20100 "This also forcibly removes all logical volumes in the volume group (if any)."
20105 #: ../src/guestfs-actions.pod:7140
20106 msgid "guestfs_vgrename"
20111 #: ../src/guestfs-actions.pod:7142
20115 " guestfs_vgrename (guestfs_h *g,\n"
20116 " const char *volgroup,\n"
20117 " const char *newvolgroup);\n"
20123 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4821
20124 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20129 #: ../src/guestfs-actions.pod:7153
20130 msgid "guestfs_vgs"
20135 #: ../src/guestfs-actions.pod:7155
20139 " guestfs_vgs (guestfs_h *g);\n"
20145 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4827
20147 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20153 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4830
20155 "This returns a list of just the volume group names that were detected (eg. "
20161 #: ../src/guestfs-actions.pod:7164
20162 msgid "See also C<guestfs_vgs_full>."
20167 #: ../src/guestfs-actions.pod:7172
20168 msgid "guestfs_vgs_full"
20173 #: ../src/guestfs-actions.pod:7174
20176 " struct guestfs_lvm_vg_list *\n"
20177 " guestfs_vgs_full (guestfs_h *g);\n"
20183 #: ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:4839
20185 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20186 "> command. The \"full\" version includes all fields."
20191 #: ../src/guestfs-actions.pod:7180
20193 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20194 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20199 #: ../src/guestfs-actions.pod:7186
20200 msgid "guestfs_vgscan"
20205 #: ../src/guestfs-actions.pod:7188
20209 " guestfs_vgscan (guestfs_h *g);\n"
20215 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4846
20217 "This rescans all block devices and rebuilds the list of LVM physical "
20218 "volumes, volume groups and logical volumes."
20223 #: ../src/guestfs-actions.pod:7198
20224 msgid "guestfs_vguuid"
20229 #: ../src/guestfs-actions.pod:7200
20233 " guestfs_vguuid (guestfs_h *g,\n"
20234 " const char *vgname);\n"
20240 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4853
20241 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20246 #: ../src/guestfs-actions.pod:7211
20247 msgid "guestfs_wait_ready"
20252 #: ../src/guestfs-actions.pod:7213
20256 " guestfs_wait_ready (guestfs_h *g);\n"
20262 #: ../src/guestfs-actions.pod:7216
20263 msgid "This function is a no op."
20268 #: ../src/guestfs-actions.pod:7218
20270 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20271 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20272 "is no longer necessary because C<guestfs_launch> now does the waiting."
20277 #: ../src/guestfs-actions.pod:7223
20279 "If you see any calls to this function in code then you can just remove them, "
20280 "unless you want to retain compatibility with older versions of the API."
20284 #: ../src/guestfs-actions.pod:7229
20286 "This function is deprecated. In new code, use the C<launch> call instead."
20291 #: ../src/guestfs-actions.pod:7238
20292 msgid "guestfs_wc_c"
20297 #: ../src/guestfs-actions.pod:7240
20301 " guestfs_wc_c (guestfs_h *g,\n"
20302 " const char *path);\n"
20308 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4859
20310 "This command counts the characters in a file, using the C<wc -c> external "
20316 #: ../src/guestfs-actions.pod:7251
20317 msgid "guestfs_wc_l"
20322 #: ../src/guestfs-actions.pod:7253
20326 " guestfs_wc_l (guestfs_h *g,\n"
20327 " const char *path);\n"
20333 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4866
20335 "This command counts the lines in a file, using the C<wc -l> external command."
20340 #: ../src/guestfs-actions.pod:7264
20341 msgid "guestfs_wc_w"
20346 #: ../src/guestfs-actions.pod:7266
20350 " guestfs_wc_w (guestfs_h *g,\n"
20351 " const char *path);\n"
20357 #: ../src/guestfs-actions.pod:7270 ../fish/guestfish-actions.pod:4873
20359 "This command counts the words in a file, using the C<wc -w> external command."
20364 #: ../src/guestfs-actions.pod:7277
20365 msgid "guestfs_write"
20370 #: ../src/guestfs-actions.pod:7279
20374 " guestfs_write (guestfs_h *g,\n"
20375 " const char *path,\n"
20376 " const char *content,\n"
20377 " size_t content_size);\n"
20383 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4880
20385 "This call creates a file called C<path>. The content of the file is the "
20386 "string C<content> (which can contain any 8 bit data)."
20391 #: ../src/guestfs-actions.pod:7295
20392 msgid "guestfs_write_file"
20397 #: ../src/guestfs-actions.pod:7297
20401 " guestfs_write_file (guestfs_h *g,\n"
20402 " const char *path,\n"
20403 " const char *content,\n"
20410 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4890
20412 "This call creates a file called C<path>. The contents of the file is the "
20413 "string C<content> (which can contain any 8 bit data), with length C<size>."
20418 #: ../src/guestfs-actions.pod:7307 ../fish/guestfish-actions.pod:4894
20420 "As a special case, if C<size> is C<0> then the length is calculated using "
20421 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20426 #: ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:4898
20428 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20429 "I<not> work, even if the length is specified."
20434 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4904
20436 "This function is deprecated. In new code, use the C<write> call instead."
20441 #: ../src/guestfs-actions.pod:7328
20442 msgid "guestfs_zegrep"
20447 #: ../src/guestfs-actions.pod:7330
20451 " guestfs_zegrep (guestfs_h *g,\n"
20452 " const char *regex,\n"
20453 " const char *path);\n"
20459 #: ../src/guestfs-actions.pod:7335 ../fish/guestfish-actions.pod:4915
20461 "This calls the external C<zegrep> program and returns the matching lines."
20466 #: ../src/guestfs-actions.pod:7347
20467 msgid "guestfs_zegrepi"
20472 #: ../src/guestfs-actions.pod:7349
20476 " guestfs_zegrepi (guestfs_h *g,\n"
20477 " const char *regex,\n"
20478 " const char *path);\n"
20484 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:4925
20486 "This calls the external C<zegrep -i> program and returns the matching lines."
20491 #: ../src/guestfs-actions.pod:7366
20492 msgid "guestfs_zero"
20497 #: ../src/guestfs-actions.pod:7368
20501 " guestfs_zero (guestfs_h *g,\n"
20502 " const char *device);\n"
20508 #: ../src/guestfs-actions.pod:7372 ../fish/guestfish-actions.pod:4935
20509 msgid "This command writes zeroes over the first few blocks of C<device>."
20514 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4937
20516 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20517 "securely wipe the device). It should be sufficient to remove any partition "
20518 "tables, filesystem superblocks and so on."
20523 #: ../src/guestfs-actions.pod:7378
20524 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20529 #: ../src/guestfs-actions.pod:7389
20530 msgid "guestfs_zero_device"
20535 #: ../src/guestfs-actions.pod:7391
20539 " guestfs_zero_device (guestfs_h *g,\n"
20540 " const char *device);\n"
20546 #: ../src/guestfs-actions.pod:7395
20548 "This command writes zeroes over the entire C<device>. Compare with "
20549 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20554 #: ../src/guestfs-actions.pod:7409
20555 msgid "(Added in 1.3.1)"
20560 #: ../src/guestfs-actions.pod:7411
20561 msgid "guestfs_zerofree"
20566 #: ../src/guestfs-actions.pod:7413
20570 " guestfs_zerofree (guestfs_h *g,\n"
20571 " const char *device);\n"
20577 #: ../src/guestfs-actions.pod:7417 ../fish/guestfish-actions.pod:4958
20579 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20580 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20581 "possible to compress the filesystem more effectively."
20586 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
20587 msgid "You should B<not> run this program if the filesystem is mounted."
20592 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4966
20594 "It is possible that using this program can damage the filesystem or data on "
20600 #: ../src/guestfs-actions.pod:7432
20601 msgid "guestfs_zfgrep"
20606 #: ../src/guestfs-actions.pod:7434
20610 " guestfs_zfgrep (guestfs_h *g,\n"
20611 " const char *pattern,\n"
20612 " const char *path);\n"
20618 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4973
20620 "This calls the external C<zfgrep> program and returns the matching lines."
20625 #: ../src/guestfs-actions.pod:7451
20626 msgid "guestfs_zfgrepi"
20631 #: ../src/guestfs-actions.pod:7453
20635 " guestfs_zfgrepi (guestfs_h *g,\n"
20636 " const char *pattern,\n"
20637 " const char *path);\n"
20643 #: ../src/guestfs-actions.pod:7458 ../fish/guestfish-actions.pod:4983
20645 "This calls the external C<zfgrep -i> program and returns the matching lines."
20650 #: ../src/guestfs-actions.pod:7470
20651 msgid "guestfs_zfile"
20656 #: ../src/guestfs-actions.pod:7472
20660 " guestfs_zfile (guestfs_h *g,\n"
20661 " const char *meth,\n"
20662 " const char *path);\n"
20668 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4993
20670 "This command runs C<file> after first decompressing C<path> using C<method>."
20675 #: ../src/guestfs-actions.pod:7480 ../fish/guestfish-actions.pod:4996
20676 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20681 #: ../src/guestfs-actions.pod:7482
20683 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20689 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:5001
20691 "This function is deprecated. In new code, use the C<file> call instead."
20696 #: ../src/guestfs-actions.pod:7497
20697 msgid "guestfs_zgrep"
20702 #: ../src/guestfs-actions.pod:7499
20706 " guestfs_zgrep (guestfs_h *g,\n"
20707 " const char *regex,\n"
20708 " const char *path);\n"
20714 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5012
20716 "This calls the external C<zgrep> program and returns the matching lines."
20721 #: ../src/guestfs-actions.pod:7516
20722 msgid "guestfs_zgrepi"
20727 #: ../src/guestfs-actions.pod:7518
20731 " guestfs_zgrepi (guestfs_h *g,\n"
20732 " const char *regex,\n"
20733 " const char *path);\n"
20739 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:5022
20741 "This calls the external C<zgrep -i> program and returns the matching lines."
20746 #: ../src/guestfs-availability.pod:3
20752 #: ../src/guestfs-availability.pod:5
20754 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20755 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20756 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20757 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20758 "L</guestfs_aug_save> L</guestfs_aug_set>"
20763 #: ../src/guestfs-availability.pod:21
20769 #: ../src/guestfs-availability.pod:23
20771 "The following functions: L</guestfs_inotify_add_watch> L</"
20772 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20773 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20778 #: ../src/guestfs-availability.pod:31
20779 msgid "B<linuxfsuuid>"
20784 #: ../src/guestfs-availability.pod:33
20786 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20787 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20792 #: ../src/guestfs-availability.pod:40
20793 msgid "B<linuxmodules>"
20798 #: ../src/guestfs-availability.pod:42
20799 msgid "The following functions: L</guestfs_modprobe>"
20804 #: ../src/guestfs-availability.pod:45
20805 msgid "B<linuxxattrs>"
20810 #: ../src/guestfs-availability.pod:47
20812 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20813 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20814 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20815 "guestfs_setxattr>"
20820 #: ../src/guestfs-availability.pod:58
20826 #: ../src/guestfs-availability.pod:60
20828 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20829 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20830 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20835 #: ../src/guestfs-availability.pod:69
20841 #: ../src/guestfs-availability.pod:71
20843 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20844 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20845 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20846 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20847 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20848 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20849 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20854 #: ../src/guestfs-availability.pod:94
20860 #: ../src/guestfs-availability.pod:96
20862 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20863 "guestfs_mknod_b> L</guestfs_mknod_c>"
20868 #: ../src/guestfs-availability.pod:102
20874 #: ../src/guestfs-availability.pod:104
20875 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20880 #: ../src/guestfs-availability.pod:107
20881 msgid "B<ntfsprogs>"
20886 #: ../src/guestfs-availability.pod:109
20888 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20893 #: ../src/guestfs-availability.pod:113
20894 msgid "B<realpath>"
20899 #: ../src/guestfs-availability.pod:115
20900 msgid "The following functions: L</guestfs_realpath>"
20905 #: ../src/guestfs-availability.pod:118
20911 #: ../src/guestfs-availability.pod:120
20913 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20914 "guestfs_scrub_freespace>"
20919 #: ../src/guestfs-availability.pod:125
20925 #: ../src/guestfs-availability.pod:127
20926 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20931 #: ../src/guestfs-availability.pod:131
20937 #: ../src/guestfs-availability.pod:133
20938 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20943 #: ../src/guestfs-availability.pod:137
20944 msgid "B<zerofree>"
20949 #: ../src/guestfs-availability.pod:139
20950 msgid "The following functions: L</guestfs_zerofree>"
20955 #: ../src/guestfs-structs.pod:1
20956 msgid "guestfs_int_bool"
20961 #: ../src/guestfs-structs.pod:3
20964 " struct guestfs_int_bool {\n"
20973 #: ../src/guestfs-structs.pod:8
20976 " struct guestfs_int_bool_list {\n"
20977 " uint32_t len; /* Number of elements in list. */\n"
20978 " struct guestfs_int_bool *val; /* Elements. */\n"
20985 #: ../src/guestfs-structs.pod:13
20988 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20989 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20995 #: ../src/guestfs-structs.pod:16
20996 msgid "guestfs_lvm_pv"
21001 #: ../src/guestfs-structs.pod:18
21004 " struct guestfs_lvm_pv {\n"
21005 " char *pv_name;\n"
21006 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21007 " char pv_uuid[32];\n"
21009 " uint64_t pv_size;\n"
21010 " uint64_t dev_size;\n"
21011 " uint64_t pv_free;\n"
21012 " uint64_t pv_used;\n"
21013 " char *pv_attr;\n"
21014 " int64_t pv_pe_count;\n"
21015 " int64_t pv_pe_alloc_count;\n"
21016 " char *pv_tags;\n"
21017 " uint64_t pe_start;\n"
21018 " int64_t pv_mda_count;\n"
21019 " uint64_t pv_mda_free;\n"
21026 #: ../src/guestfs-structs.pod:36
21029 " struct guestfs_lvm_pv_list {\n"
21030 " uint32_t len; /* Number of elements in list. */\n"
21031 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21038 #: ../src/guestfs-structs.pod:41
21041 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21042 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21048 #: ../src/guestfs-structs.pod:44
21049 msgid "guestfs_lvm_vg"
21054 #: ../src/guestfs-structs.pod:46
21057 " struct guestfs_lvm_vg {\n"
21058 " char *vg_name;\n"
21059 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21060 " char vg_uuid[32];\n"
21062 " char *vg_attr;\n"
21063 " uint64_t vg_size;\n"
21064 " uint64_t vg_free;\n"
21065 " char *vg_sysid;\n"
21066 " uint64_t vg_extent_size;\n"
21067 " int64_t vg_extent_count;\n"
21068 " int64_t vg_free_count;\n"
21069 " int64_t max_lv;\n"
21070 " int64_t max_pv;\n"
21071 " int64_t pv_count;\n"
21072 " int64_t lv_count;\n"
21073 " int64_t snap_count;\n"
21074 " int64_t vg_seqno;\n"
21075 " char *vg_tags;\n"
21076 " int64_t vg_mda_count;\n"
21077 " uint64_t vg_mda_free;\n"
21084 #: ../src/guestfs-structs.pod:69
21087 " struct guestfs_lvm_vg_list {\n"
21088 " uint32_t len; /* Number of elements in list. */\n"
21089 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21096 #: ../src/guestfs-structs.pod:74
21099 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21100 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21106 #: ../src/guestfs-structs.pod:77
21107 msgid "guestfs_lvm_lv"
21112 #: ../src/guestfs-structs.pod:79
21115 " struct guestfs_lvm_lv {\n"
21116 " char *lv_name;\n"
21117 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21118 " char lv_uuid[32];\n"
21119 " char *lv_attr;\n"
21120 " int64_t lv_major;\n"
21121 " int64_t lv_minor;\n"
21122 " int64_t lv_kernel_major;\n"
21123 " int64_t lv_kernel_minor;\n"
21124 " uint64_t lv_size;\n"
21125 " int64_t seg_count;\n"
21127 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21128 " float snap_percent;\n"
21129 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21130 " float copy_percent;\n"
21131 " char *move_pv;\n"
21132 " char *lv_tags;\n"
21133 " char *mirror_log;\n"
21134 " char *modules;\n"
21141 #: ../src/guestfs-structs.pod:101
21144 " struct guestfs_lvm_lv_list {\n"
21145 " uint32_t len; /* Number of elements in list. */\n"
21146 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21153 #: ../src/guestfs-structs.pod:106
21156 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21157 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21163 #: ../src/guestfs-structs.pod:111
21166 " struct guestfs_stat {\n"
21170 " int64_t nlink;\n"
21175 " int64_t blksize;\n"
21176 " int64_t blocks;\n"
21177 " int64_t atime;\n"
21178 " int64_t mtime;\n"
21179 " int64_t ctime;\n"
21186 #: ../src/guestfs-structs.pod:127
21189 " struct guestfs_stat_list {\n"
21190 " uint32_t len; /* Number of elements in list. */\n"
21191 " struct guestfs_stat *val; /* Elements. */\n"
21198 #: ../src/guestfs-structs.pod:132
21201 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21202 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21208 #: ../src/guestfs-structs.pod:137
21211 " struct guestfs_statvfs {\n"
21212 " int64_t bsize;\n"
21213 " int64_t frsize;\n"
21214 " int64_t blocks;\n"
21215 " int64_t bfree;\n"
21216 " int64_t bavail;\n"
21217 " int64_t files;\n"
21218 " int64_t ffree;\n"
21219 " int64_t favail;\n"
21222 " int64_t namemax;\n"
21229 #: ../src/guestfs-structs.pod:151
21232 " struct guestfs_statvfs_list {\n"
21233 " uint32_t len; /* Number of elements in list. */\n"
21234 " struct guestfs_statvfs *val; /* Elements. */\n"
21241 #: ../src/guestfs-structs.pod:156
21244 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21245 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21251 #: ../src/guestfs-structs.pod:159
21252 msgid "guestfs_dirent"
21257 #: ../src/guestfs-structs.pod:161
21260 " struct guestfs_dirent {\n"
21270 #: ../src/guestfs-structs.pod:167
21273 " struct guestfs_dirent_list {\n"
21274 " uint32_t len; /* Number of elements in list. */\n"
21275 " struct guestfs_dirent *val; /* Elements. */\n"
21282 #: ../src/guestfs-structs.pod:172
21285 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21286 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21292 #: ../src/guestfs-structs.pod:177
21295 " struct guestfs_version {\n"
21296 " int64_t major;\n"
21297 " int64_t minor;\n"
21298 " int64_t release;\n"
21306 #: ../src/guestfs-structs.pod:184
21309 " struct guestfs_version_list {\n"
21310 " uint32_t len; /* Number of elements in list. */\n"
21311 " struct guestfs_version *val; /* Elements. */\n"
21318 #: ../src/guestfs-structs.pod:189
21321 " void guestfs_free_version (struct guestfs_free_version *);\n"
21322 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21328 #: ../src/guestfs-structs.pod:192
21329 msgid "guestfs_xattr"
21334 #: ../src/guestfs-structs.pod:194
21337 " struct guestfs_xattr {\n"
21338 " char *attrname;\n"
21339 " /* The next two fields describe a byte array. */\n"
21340 " uint32_t attrval_len;\n"
21341 " char *attrval;\n"
21348 #: ../src/guestfs-structs.pod:201
21351 " struct guestfs_xattr_list {\n"
21352 " uint32_t len; /* Number of elements in list. */\n"
21353 " struct guestfs_xattr *val; /* Elements. */\n"
21360 #: ../src/guestfs-structs.pod:206
21363 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21364 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21370 #: ../src/guestfs-structs.pod:209
21371 msgid "guestfs_inotify_event"
21376 #: ../src/guestfs-structs.pod:211
21379 " struct guestfs_inotify_event {\n"
21380 " int64_t in_wd;\n"
21381 " uint32_t in_mask;\n"
21382 " uint32_t in_cookie;\n"
21383 " char *in_name;\n"
21390 #: ../src/guestfs-structs.pod:218
21393 " struct guestfs_inotify_event_list {\n"
21394 " uint32_t len; /* Number of elements in list. */\n"
21395 " struct guestfs_inotify_event *val; /* Elements. */\n"
21402 #: ../src/guestfs-structs.pod:223
21405 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21406 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21412 #: ../src/guestfs-structs.pod:226
21413 msgid "guestfs_partition"
21418 #: ../src/guestfs-structs.pod:228
21421 " struct guestfs_partition {\n"
21422 " int32_t part_num;\n"
21423 " uint64_t part_start;\n"
21424 " uint64_t part_end;\n"
21425 " uint64_t part_size;\n"
21432 #: ../src/guestfs-structs.pod:235
21435 " struct guestfs_partition_list {\n"
21436 " uint32_t len; /* Number of elements in list. */\n"
21437 " struct guestfs_partition *val; /* Elements. */\n"
21444 #: ../src/guestfs-structs.pod:240
21447 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21448 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21454 #: ../src/guestfs-structs.pod:243
21455 msgid "guestfs_application"
21460 #: ../src/guestfs-structs.pod:245
21463 " struct guestfs_application {\n"
21464 " char *app_name;\n"
21465 " char *app_display_name;\n"
21466 " int32_t app_epoch;\n"
21467 " char *app_version;\n"
21468 " char *app_release;\n"
21469 " char *app_install_path;\n"
21470 " char *app_trans_path;\n"
21471 " char *app_publisher;\n"
21472 " char *app_url;\n"
21473 " char *app_source_package;\n"
21474 " char *app_summary;\n"
21475 " char *app_description;\n"
21482 #: ../src/guestfs-structs.pod:260
21485 " struct guestfs_application_list {\n"
21486 " uint32_t len; /* Number of elements in list. */\n"
21487 " struct guestfs_application *val; /* Elements. */\n"
21494 #: ../src/guestfs-structs.pod:265
21497 " void guestfs_free_application (struct guestfs_free_application *);\n"
21498 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21504 #: ../fish/guestfish.pod:5
21505 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21510 #: ../fish/guestfish.pod:9
21513 " guestfish [--options] [commands]\n"
21519 #: ../fish/guestfish.pod:11
21528 #: ../fish/guestfish.pod:13
21531 " guestfish [--ro|--rw] -a disk.img\n"
21537 #: ../fish/guestfish.pod:15
21540 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21546 #: ../fish/guestfish.pod:17
21549 " guestfish -d libvirt-domain\n"
21555 #: ../fish/guestfish.pod:19
21558 " guestfish [--ro|--rw] -a disk.img -i\n"
21564 #: ../fish/guestfish.pod:21
21567 " guestfish -d libvirt-domain -i\n"
21573 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21574 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21580 #: ../fish/guestfish.pod:25
21582 "Using guestfish in read/write mode on live virtual machines can be "
21583 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21584 "option to use guestfish safely if the disk image or virtual machine might be "
21590 #: ../fish/guestfish.pod:32
21592 "Guestfish is a shell and command-line tool for examining and modifying "
21593 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21594 "functionality of the guestfs API, see L<guestfs(3)>."
21599 #: ../fish/guestfish.pod:36
21601 "Guestfish gives you structured access to the libguestfs API, from shell "
21602 "scripts or the command line or interactively. If you want to rescue a "
21603 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21609 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
21610 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21616 #: ../fish/guestfish.pod:43
21617 msgid "As an interactive shell"
21622 #: ../fish/guestfish.pod:45
21631 #: ../fish/guestfish.pod:47
21634 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21635 " editing virtual machine filesystems.\n"
21641 #: ../fish/guestfish.pod:50
21644 " Type: 'help' for a list of commands\n"
21645 " 'man' to read the manual\n"
21646 " 'quit' to quit the shell\n"
21652 #: ../fish/guestfish.pod:54
21655 " ><fs> add-ro disk.img\n"
21657 " ><fs> list-filesystems\n"
21658 " /dev/sda1: ext4\n"
21659 " /dev/vg_guest/lv_root: ext4\n"
21660 " /dev/vg_guest/lv_swap: swap\n"
21661 " ><fs> mount /dev/vg_guest/lv_root /\n"
21662 " ><fs> cat /etc/fstab\n"
21664 " # Created by anaconda\n"
21672 #: ../fish/guestfish.pod:67
21673 msgid "From shell scripts"
21678 #: ../fish/guestfish.pod:69
21679 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21684 #: ../fish/guestfish.pod:71
21687 " guestfish <<_EOF_\n"
21690 " mount /dev/vg_guest/lv_root /\n"
21691 " write /etc/motd \"Welcome, new users\"\n"
21698 #: ../fish/guestfish.pod:78
21699 msgid "List the LVM logical volumes in a disk image:"
21704 #: ../fish/guestfish.pod:80
21707 " guestfish -a disk.img --ro <<_EOF_\n"
21716 #: ../fish/guestfish.pod:85
21717 msgid "List all the filesystems in a disk image:"
21722 #: ../fish/guestfish.pod:87
21725 " guestfish -a disk.img --ro <<_EOF_\n"
21727 " list-filesystems\n"
21734 #: ../fish/guestfish.pod:92
21735 msgid "On one command line"
21740 #: ../fish/guestfish.pod:94
21741 msgid "Update C</etc/resolv.conf> in a guest:"
21746 #: ../fish/guestfish.pod:96
21750 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21751 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21757 #: ../fish/guestfish.pod:100
21758 msgid "Edit C</boot/grub/grub.conf> interactively:"
21763 #: ../fish/guestfish.pod:102
21766 " guestfish --rw --add disk.img \\\n"
21767 " --mount /dev/vg_guest/lv_root \\\n"
21768 " --mount /dev/sda1:/boot \\\n"
21769 " edit /boot/grub/grub.conf\n"
21775 #: ../fish/guestfish.pod:107
21776 msgid "Mount disks automatically"
21781 #: ../fish/guestfish.pod:109
21783 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21788 #: ../fish/guestfish.pod:112
21791 " guestfish --ro -a disk.img -i cat /etc/group\n"
21797 #: ../fish/guestfish.pod:114
21800 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21806 #: ../fish/guestfish.pod:116
21807 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21812 #: ../fish/guestfish.pod:118
21815 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21821 #: ../fish/guestfish.pod:120
21822 msgid "As a script interpreter"
21827 #: ../fish/guestfish.pod:122
21828 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21833 #: ../fish/guestfish.pod:124
21836 " #!/usr/bin/guestfish -f\n"
21837 " sparse test1.img 100M\n"
21839 " part-disk /dev/sda mbr\n"
21840 " mkfs ext2 /dev/sda1\n"
21846 #: ../fish/guestfish.pod:130
21847 msgid "Start with a prepared disk"
21852 #: ../fish/guestfish.pod:132
21854 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21855 "single ext2-formatted partition:"
21860 #: ../fish/guestfish.pod:135
21863 " guestfish -N fs\n"
21869 #: ../fish/guestfish.pod:137
21870 msgid "To list what is available do:"
21875 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
21878 " guestfish -N help | less\n"
21884 #: ../fish/guestfish.pod:141
21885 msgid "Remote control"
21890 #: ../fish/guestfish.pod:143
21893 " eval \"`guestfish --listen`\"\n"
21894 " guestfish --remote add-ro disk.img\n"
21895 " guestfish --remote run\n"
21896 " guestfish --remote lvs\n"
21902 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21903 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
21904 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21905 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21906 #: ../tools/virt-list-partitions.pl:54
21912 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
21913 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21914 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21915 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21921 #: ../fish/guestfish.pod:154
21922 msgid "Displays general help on options."
21927 #: ../fish/guestfish.pod:156
21933 #: ../fish/guestfish.pod:158
21934 msgid "B<--cmd-help>"
21939 #: ../fish/guestfish.pod:160
21940 msgid "Lists all available guestfish commands."
21945 #: ../fish/guestfish.pod:162
21951 #: ../fish/guestfish.pod:164
21952 msgid "B<--cmd-help cmd>"
21957 #: ../fish/guestfish.pod:166
21958 msgid "Displays detailed help on a single command C<cmd>."
21963 #: ../fish/guestfish.pod:168
21964 msgid "B<-a image>"
21969 #: ../fish/guestfish.pod:170
21970 msgid "B<--add image>"
21975 #: ../fish/guestfish.pod:172
21976 msgid "Add a block device or virtual machine image to the shell."
21981 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
21983 "The format of the disk image is auto-detected. To override this and force a "
21984 "particular format use the I<--format=..> option."
21988 #: ../fish/guestfish.pod:177
21990 "Using this flag is mostly equivalent to using the C<add> command, with "
21991 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21992 "the I<--format=...> flag was given."
21997 #: ../fish/guestfish.pod:181
22003 #: ../fish/guestfish.pod:183
22004 msgid "B<--connect URI>"
22009 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22011 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22012 "URI to use. The default is to use the default libvirt connection."
22017 #: ../fish/guestfish.pod:189
22023 #: ../fish/guestfish.pod:191
22025 "If using the I<--listen> option and a csh-like shell, use this option. See "
22026 "section L</REMOTE CONTROL AND CSH> below."
22031 #: ../fish/guestfish.pod:194
22032 msgid "B<-d libvirt-domain>"
22037 #: ../fish/guestfish.pod:196
22038 msgid "B<--domain libvirt-domain>"
22043 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22045 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22046 "used, then any libvirt domain can be used. However in write mode, only "
22047 "libvirt domains which are shut down can be named here."
22052 #: ../fish/guestfish.pod:202
22054 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22055 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22056 "if the I<--format:...> flag was given."
22061 #: ../fish/guestfish.pod:206
22067 #: ../fish/guestfish.pod:208
22068 msgid "B<--no-dest-paths>"
22073 #: ../fish/guestfish.pod:210
22075 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22076 "to hit the tab key to complete paths on the guest filesystem, but this "
22077 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22078 "allow this feature to be disabled."
22083 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
22084 msgid "B<--echo-keys>"
22089 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22091 "When prompting for keys and passphrases, guestfish normally turns echoing "
22092 "off so you cannot see what you are typing. If you are not worried about "
22093 "Tempest attacks and there is no one else in the room you can specify this "
22094 "flag to see what you are typing."
22099 #: ../fish/guestfish.pod:222
22105 #: ../fish/guestfish.pod:224
22106 msgid "B<--file file>"
22111 #: ../fish/guestfish.pod:226
22112 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22117 #: ../fish/guestfish.pod:229
22120 " #!/usr/bin/guestfish -f\n"
22126 #: ../fish/guestfish.pod:231
22127 msgid "B<--format=raw|qcow2|..>"
22132 #: ../fish/guestfish.pod:233
22133 msgid "B<--format>"
22138 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
22140 "The default for the I<-a> option is to auto-detect the format of the disk "
22141 "image. Using this forces the disk format for I<-a> options which follow on "
22142 "the command line. Using I<--format> with no argument switches back to auto-"
22143 "detection for subsequent I<-a> options."
22148 #: ../fish/guestfish.pod:242
22151 " guestfish --format=raw -a disk.img\n"
22157 #: ../fish/guestfish.pod:244
22158 msgid "forces raw format (no auto-detection) for C<disk.img>."
22163 #: ../fish/guestfish.pod:246
22166 " guestfish --format=raw -a disk.img --format -a another.img\n"
22172 #: ../fish/guestfish.pod:248
22174 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22175 "detection for C<another.img>."
22180 #: ../fish/guestfish.pod:251
22182 "If you have untrusted raw-format guest disk images, you should use this "
22183 "option to specify the disk format. This avoids a possible security problem "
22184 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22189 #: ../fish/guestfish.pod:256
22195 #: ../fish/guestfish.pod:258
22196 msgid "B<--inspector>"
22201 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
22203 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22204 "system and mount filesystems as they would be mounted on the real virtual "
22210 #: ../fish/guestfish.pod:264
22211 msgid "Typical usage is either:"
22216 #: ../fish/guestfish.pod:266
22219 " guestfish -d myguest -i\n"
22225 #: ../fish/guestfish.pod:268
22226 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22231 #: ../fish/guestfish.pod:270
22234 " guestfish --ro -d myguest -i\n"
22240 #: ../fish/guestfish.pod:272
22241 msgid "(for active domains, readonly), or specify the block device directly:"
22246 #: ../fish/guestfish.pod:274
22249 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22255 #: ../fish/guestfish.pod:276
22257 "Note that the command line syntax changed slightly over older versions of "
22258 "guestfish. You can still use the old syntax:"
22263 #: ../fish/guestfish.pod:279
22266 " guestfish [--ro] -i disk.img\n"
22272 #: ../fish/guestfish.pod:281
22275 " guestfish [--ro] -i libvirt-domain\n"
22281 #: ../fish/guestfish.pod:283
22283 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22284 "then using other commands to mount the filesystems that were found."
22289 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
22290 msgid "B<--keys-from-stdin>"
22295 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22297 "Read key or passphrase parameters from stdin. The default is to try to read "
22298 "passphrases from the user by opening C</dev/tty>."
22303 #: ../fish/guestfish.pod:292
22304 msgid "B<--listen>"
22309 #: ../fish/guestfish.pod:294
22311 "Fork into the background and listen for remote commands. See section L</"
22312 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22316 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
22321 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22323 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22324 "ATTACHING TO RUNNING DAEMONS>)."
22328 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
22329 msgid "B<-m dev[:mountpoint[:options]]>"
22333 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22334 msgid "B<--mount dev[:mountpoint[:options]]>"
22339 #: ../fish/guestfish.pod:306
22340 msgid "Mount the named partition or logical volume on the given mountpoint."
22345 #: ../fish/guestfish.pod:308
22346 msgid "If the mountpoint is omitted, it defaults to C</>."
22351 #: ../fish/guestfish.pod:310
22352 msgid "You have to mount something on C</> before most commands will work."
22357 #: ../fish/guestfish.pod:312
22359 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22365 #: ../fish/guestfish.pod:315
22367 "If you don't know what filesystems a disk image contains, you can either run "
22368 "guestfish without this option, then list the partitions, filesystems and LVs "
22369 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22370 "commands), or you can use the L<virt-filesystems(1)> program."
22374 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
22376 "The third (and rarely used) part of the mount parameter is the list of mount "
22377 "options used to mount the underlying filesystem. If this is not given, then "
22378 "the mount options are either the empty string or C<ro> (the latter if the "
22379 "I<--ro> flag is used). By specifying the mount options, you override this "
22380 "default choice. Probably the only time you would use this is to enable ACLs "
22381 "and/or extended attributes if the filesystem can support them:"
22385 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
22388 " -m /dev/sda1:/:acl,user_xattr\n"
22393 #: ../fish/guestfish.pod:331
22394 msgid "Using this flag is equivalent to using the C<mount-options> command."
22399 #: ../fish/guestfish.pod:333
22405 #: ../fish/guestfish.pod:335
22406 msgid "B<--no-sync>"
22411 #: ../fish/guestfish.pod:337
22413 "Disable autosync. This is enabled by default. See the discussion of "
22414 "autosync in the L<guestfs(3)> manpage."
22419 #: ../fish/guestfish.pod:340
22425 #: ../fish/guestfish.pod:342
22426 msgid "B<--new type>"
22431 #: ../fish/guestfish.pod:344
22437 #: ../fish/guestfish.pod:346
22439 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22440 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22441 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22447 #: ../fish/guestfish.pod:351
22448 msgid "B<--progress-bars>"
22453 #: ../fish/guestfish.pod:353
22454 msgid "Enable progress bars, even when guestfish is used non-interactively."
22459 #: ../fish/guestfish.pod:355
22461 "Progress bars are enabled by default when guestfish is used as an "
22462 "interactive shell."
22467 #: ../fish/guestfish.pod:358
22468 msgid "B<--no-progress-bars>"
22473 #: ../fish/guestfish.pod:360
22474 msgid "Disable progress bars."
22479 #: ../fish/guestfish.pod:362
22480 msgid "B<--remote[=pid]>"
22485 #: ../fish/guestfish.pod:364
22487 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22488 "CONTROL GUESTFISH OVER A SOCKET> below."
22493 #: ../fish/guestfish.pod:367
22499 #: ../fish/guestfish.pod:369
22505 #: ../fish/guestfish.pod:371
22507 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22508 "mounts are done read-only."
22513 #: ../fish/guestfish.pod:374
22515 "The option must always be used if the disk image or virtual machine might be "
22516 "running, and is generally recommended in cases where you don't need write "
22517 "access to the disk."
22522 #: ../fish/guestfish.pod:378
22524 "Note that prepared disk images created with I<-N> are not affected by this "
22525 "option. Also commands like C<add> are not affected - you have to specify "
22526 "the C<readonly:true> option explicitly if you need it."
22531 #: ../fish/guestfish.pod:382
22532 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22537 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
22538 msgid "B<--selinux>"
22543 #: ../fish/guestfish.pod:386
22544 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22549 #: ../fish/guestfish.pod:388
22555 #: ../fish/guestfish.pod:390
22556 msgid "B<--verbose>"
22561 #: ../fish/guestfish.pod:392
22563 "Enable very verbose messages. This is particularly useful if you find a bug."
22568 #: ../fish/guestfish.pod:395
22574 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22575 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22576 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22577 #: ../tools/virt-list-partitions.pl:70
22578 msgid "B<--version>"
22583 #: ../fish/guestfish.pod:399
22584 msgid "Display the guestfish / libguestfs version number and exit."
22589 #: ../fish/guestfish.pod:401
22595 #: ../fish/guestfish.pod:403
22600 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
22602 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22603 "mounts are done read-write."
22607 #: ../fish/guestfish.pod:408
22608 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22613 #: ../fish/guestfish.pod:410
22619 #: ../fish/guestfish.pod:412
22620 msgid "Echo each command before executing it."
22625 #: ../fish/guestfish.pod:416
22626 msgid "COMMANDS ON COMMAND LINE"
22631 #: ../fish/guestfish.pod:418
22633 "Any additional (non-option) arguments are treated as commands to execute."
22638 #: ../fish/guestfish.pod:421
22640 "Commands to execute should be separated by a colon (C<:>), where the colon "
22641 "is a separate parameter. Thus:"
22646 #: ../fish/guestfish.pod:424
22649 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22655 #: ../fish/guestfish.pod:426
22657 "If there are no additional arguments, then we enter a shell, either an "
22658 "interactive shell with a prompt (if the input is a terminal) or a non-"
22659 "interactive shell."
22664 #: ../fish/guestfish.pod:430
22666 "In either command line mode or non-interactive shell, the first command that "
22667 "gives an error causes the whole shell to exit. In interactive mode (with a "
22668 "prompt) if a command fails, you can continue to enter commands."
22673 #: ../fish/guestfish.pod:435
22674 msgid "USING launch (OR run)"
22679 #: ../fish/guestfish.pod:437
22681 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22682 "then launch it, then mount any disks you need, and finally issue actions/"
22683 "commands. So the general order of the day is:"
22688 #: ../fish/guestfish.pod:445
22689 msgid "add or -a/--add"
22694 #: ../fish/guestfish.pod:449
22695 msgid "launch (aka run)"
22700 #: ../fish/guestfish.pod:453
22701 msgid "mount or -m/--mount"
22706 #: ../fish/guestfish.pod:457
22707 msgid "any other commands"
22712 #: ../fish/guestfish.pod:461
22714 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22715 "guest before mounting or performing any other commands."
22720 #: ../fish/guestfish.pod:464
22722 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22723 "I<--new> options were given then C<run> is done automatically, simply "
22724 "because guestfish can't perform the action you asked for without doing this."
22729 #: ../fish/guestfish.pod:469
22730 msgid "OPENING DISKS FOR READ AND WRITE"
22734 #: ../fish/guestfish.pod:471
22736 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22737 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22738 "I<-i> and I<-m> open disk images read-only or for writing."
22742 #: ../fish/guestfish.pod:476
22744 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22745 "opening disk images supplied on the command line for write. To open a disk "
22746 "image read-only you have to do I<-a image --ro>."
22751 #: ../fish/guestfish.pod:480
22753 "This matters: If you accidentally open a live VM disk image writable then "
22754 "you will cause irreversible disk corruption."
22758 #: ../fish/guestfish.pod:483
22760 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22761 "images will be opened read-only. You will have to either specify "
22762 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22763 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22764 "access for disk images specified by those other command line options."
22768 #: ../fish/guestfish.pod:490
22770 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22771 "which does nothing (it is already the default). However it is highly "
22772 "recommended that you use this option to indicate that you need write access, "
22773 "and prepare your scripts for the day when this option will be required for "
22779 #: ../fish/guestfish.pod:496
22781 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22782 "other libguestfs program apart from guestfish and guestmount."
22787 #: ../fish/guestfish.pod:499
22793 #: ../fish/guestfish.pod:501
22795 "You can quote ordinary parameters using either single or double quotes. For "
22801 #: ../fish/guestfish.pod:504
22804 " add \"file with a space.img\"\n"
22810 #: ../fish/guestfish.pod:506
22813 " rm '/file name'\n"
22819 #: ../fish/guestfish.pod:508
22828 #: ../fish/guestfish.pod:510
22830 "A few commands require a list of strings to be passed. For these, use a "
22831 "whitespace-separated list, enclosed in quotes. Strings containing "
22832 "whitespace to be passed through must be enclosed in single quotes. A "
22833 "literal single quote must be escaped with a backslash."
22838 #: ../fish/guestfish.pod:515
22841 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22842 " command \"/bin/echo 'foo bar'\"\n"
22843 " command \"/bin/echo \\'foo\\'\"\n"
22849 #: ../fish/guestfish.pod:519
22850 msgid "OPTIONAL ARGUMENTS"
22855 #: ../fish/guestfish.pod:521
22857 "Some commands take optional arguments. These arguments appear in this "
22858 "documentation as C<[argname:..]>. You can use them as in these examples:"
22863 #: ../fish/guestfish.pod:525
22866 " add-drive-opts filename\n"
22872 #: ../fish/guestfish.pod:527
22875 " add-drive-opts filename readonly:true\n"
22881 #: ../fish/guestfish.pod:529
22884 " add-drive-opts filename format:qcow2 readonly:false\n"
22890 #: ../fish/guestfish.pod:531
22892 "Each optional argument can appear at most once. All optional arguments must "
22893 "appear after the required ones."
22898 #: ../fish/guestfish.pod:534
22904 #: ../fish/guestfish.pod:536
22906 "This section applies to all commands which can take integers as parameters."
22911 #: ../fish/guestfish.pod:539
22912 msgid "SIZE SUFFIX"
22917 #: ../fish/guestfish.pod:541
22919 "When the command takes a parameter measured in bytes, you can use one of the "
22920 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22925 #: ../fish/guestfish.pod:547
22926 msgid "B<k> or B<K> or B<KiB>"
22931 #: ../fish/guestfish.pod:549
22932 msgid "The size in kilobytes (multiplied by 1024)."
22937 #: ../fish/guestfish.pod:551
22943 #: ../fish/guestfish.pod:553
22944 msgid "The size in SI 1000 byte units."
22949 #: ../fish/guestfish.pod:555
22950 msgid "B<M> or B<MiB>"
22955 #: ../fish/guestfish.pod:557
22956 msgid "The size in megabytes (multiplied by 1048576)."
22961 #: ../fish/guestfish.pod:559
22967 #: ../fish/guestfish.pod:561
22968 msgid "The size in SI 1000000 byte units."
22973 #: ../fish/guestfish.pod:563
22974 msgid "B<G> or B<GiB>"
22979 #: ../fish/guestfish.pod:565
22980 msgid "The size in gigabytes (multiplied by 2**30)."
22985 #: ../fish/guestfish.pod:567
22991 #: ../fish/guestfish.pod:569
22992 msgid "The size in SI 10**9 byte units."
22997 #: ../fish/guestfish.pod:571
22998 msgid "B<T> or B<TiB>"
23003 #: ../fish/guestfish.pod:573
23004 msgid "The size in terabytes (multiplied by 2**40)."
23009 #: ../fish/guestfish.pod:575
23015 #: ../fish/guestfish.pod:577
23016 msgid "The size in SI 10**12 byte units."
23021 #: ../fish/guestfish.pod:579
23022 msgid "B<P> or B<PiB>"
23027 #: ../fish/guestfish.pod:581
23028 msgid "The size in petabytes (multiplied by 2**50)."
23033 #: ../fish/guestfish.pod:583
23039 #: ../fish/guestfish.pod:585
23040 msgid "The size in SI 10**15 byte units."
23045 #: ../fish/guestfish.pod:587
23046 msgid "B<E> or B<EiB>"
23051 #: ../fish/guestfish.pod:589
23052 msgid "The size in exabytes (multiplied by 2**60)."
23057 #: ../fish/guestfish.pod:591
23063 #: ../fish/guestfish.pod:593
23064 msgid "The size in SI 10**18 byte units."
23069 #: ../fish/guestfish.pod:595
23070 msgid "B<Z> or B<ZiB>"
23075 #: ../fish/guestfish.pod:597
23076 msgid "The size in zettabytes (multiplied by 2**70)."
23081 #: ../fish/guestfish.pod:599
23087 #: ../fish/guestfish.pod:601
23088 msgid "The size in SI 10**21 byte units."
23093 #: ../fish/guestfish.pod:603
23094 msgid "B<Y> or B<YiB>"
23099 #: ../fish/guestfish.pod:605
23100 msgid "The size in yottabytes (multiplied by 2**80)."
23105 #: ../fish/guestfish.pod:607
23111 #: ../fish/guestfish.pod:609
23112 msgid "The size in SI 10**24 byte units."
23117 #: ../fish/guestfish.pod:615
23120 " truncate-size /file 1G\n"
23126 #: ../fish/guestfish.pod:617
23127 msgid "would truncate the file to 1 gigabyte."
23132 #: ../fish/guestfish.pod:619
23134 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23135 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23136 "suffix will probably not do what you expect."
23141 #: ../fish/guestfish.pod:623
23142 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23147 #: ../fish/guestfish.pod:625
23149 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23150 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23155 #: ../fish/guestfish.pod:628
23158 " 1234 decimal number 1234\n"
23159 " 02322 octal number, equivalent to decimal 1234\n"
23160 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23166 #: ../fish/guestfish.pod:632
23168 "When using the C<chmod> command, you almost always want to specify an octal "
23169 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23170 "L<chmod(1)> program):"
23175 #: ../fish/guestfish.pod:636
23178 " chmod 0777 /public # OK\n"
23179 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23185 #: ../fish/guestfish.pod:639
23187 "Commands that return numbers usually print them in decimal, but some "
23188 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23189 "octal, preceeded by C<0>)."
23194 #: ../fish/guestfish.pod:643
23195 msgid "WILDCARDS AND GLOBBING"
23200 #: ../fish/guestfish.pod:645
23202 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23203 "(globbing) by default. So for example the following will not do what you "
23209 #: ../fish/guestfish.pod:649
23218 #: ../fish/guestfish.pod:651
23220 "Assuming you don't have a directory called literally C</home/*> then the "
23221 "above command will return an error."
23226 #: ../fish/guestfish.pod:654
23227 msgid "To perform wildcard expansion, use the C<glob> command."
23232 #: ../fish/guestfish.pod:656
23235 " glob rm-rf /home/*\n"
23241 #: ../fish/guestfish.pod:658
23243 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23244 "many times), equivalent to:"
23249 #: ../fish/guestfish.pod:661
23252 " rm-rf /home/jim\n"
23253 " rm-rf /home/joe\n"
23254 " rm-rf /home/mary\n"
23260 #: ../fish/guestfish.pod:665
23261 msgid "C<glob> only works on simple guest paths and not on device names."
23266 #: ../fish/guestfish.pod:667
23268 "If you have several parameters, each containing a wildcard, then glob will "
23269 "perform a Cartesian product."
23274 #: ../fish/guestfish.pod:670
23280 #: ../fish/guestfish.pod:672
23282 "Any line which starts with a I<#> character is treated as a comment and "
23283 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23284 "a command. For example:"
23289 #: ../fish/guestfish.pod:676
23292 " # this is a comment\n"
23293 " # this is a comment\n"
23294 " foo # NOT a comment\n"
23300 #: ../fish/guestfish.pod:680
23301 msgid "Blank lines are also ignored."
23306 #: ../fish/guestfish.pod:682
23307 msgid "RUNNING COMMANDS LOCALLY"
23312 #: ../fish/guestfish.pod:684
23314 "Any line which starts with a I<!> character is treated as a command sent to "
23315 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23320 #: ../fish/guestfish.pod:688
23324 " tgz-out /remote local/remote-data.tar.gz\n"
23330 #: ../fish/guestfish.pod:691
23332 "will create a directory C<local> on the host, and then export the contents "
23333 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23334 "(See C<tgz-out>)."
23339 #: ../fish/guestfish.pod:695
23341 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23342 "effect, due to the way that subprocesses work in Unix."
23346 #: ../fish/guestfish.pod:698
23347 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23351 #: ../fish/guestfish.pod:700
23353 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23354 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23355 "and executed as guestfish commands."
23359 #: ../fish/guestfish.pod:704
23361 "Thus you can use shell script to construct arbitrary guestfish commands "
23362 "which are then parsed by guestfish."
23366 #: ../fish/guestfish.pod:707
23368 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23369 "through C</foo.100>) using guestfish commands alone. However this is simple "
23370 "if we use a shell script to create the guestfish commands for us:"
23374 #: ../fish/guestfish.pod:712
23377 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23382 #: ../fish/guestfish.pod:714
23383 msgid "or with names like C</foo.001>:"
23387 #: ../fish/guestfish.pod:716
23390 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23395 #: ../fish/guestfish.pod:718
23397 "When using guestfish interactively it can be helpful to just run the shell "
23398 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23399 "ordinary I<!> local command), see what guestfish commands it would run, and "
23400 "when you are happy with those prepend the C<E<lt>> character to run the "
23401 "guestfish commands for real."
23406 #: ../fish/guestfish.pod:724
23412 #: ../fish/guestfish.pod:726
23414 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23415 "command (a guestfish command) to the second command (any host command). For "
23421 #: ../fish/guestfish.pod:730
23424 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23430 #: ../fish/guestfish.pod:732
23432 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23433 "program). The above command would list all accounts in the guest filesystem "
23434 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23439 #: ../fish/guestfish.pod:737
23442 " hexdump /bin/ls | head\n"
23443 " list-devices | tail -1\n"
23444 " tgz-out / - | tar ztf -\n"
23450 #: ../fish/guestfish.pod:741
23452 "The space before the pipe symbol is required, any space after the pipe "
23453 "symbol is optional. Everything after the pipe symbol is just passed "
23454 "straight to the host shell, so it can contain redirections, globs and "
23455 "anything else that makes sense on the host side."
23460 #: ../fish/guestfish.pod:746
23462 "To use a literal argument which begins with a pipe symbol, you have to quote "
23468 #: ../fish/guestfish.pod:749
23477 #: ../fish/guestfish.pod:751
23478 msgid "HOME DIRECTORIES"
23483 #: ../fish/guestfish.pod:753
23485 "If a parameter starts with the character C<~> then the tilde may be expanded "
23486 "as a home directory path (either C<~> for the current user's home directory, "
23487 "or C<~user> for another user)."
23492 #: ../fish/guestfish.pod:757
23494 "Note that home directory expansion happens for users known I<on the host>, "
23495 "not in the guest filesystem."
23500 #: ../fish/guestfish.pod:760
23502 "To use a literal argument which begins with a tilde, you have to quote it, "
23508 #: ../fish/guestfish.pod:763
23517 #: ../fish/guestfish.pod:767
23519 "Libguestfs has some support for Linux guests encrypted according to the "
23520 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23521 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23522 "LUKS is supported."
23527 #: ../fish/guestfish.pod:772
23528 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23533 #: ../fish/guestfish.pod:774
23536 " ><fs> vfs-type /dev/sda2\n"
23543 #: ../fish/guestfish.pod:777
23545 "Then open those devices using L</luks-open>. This creates a device-mapper "
23546 "device called C</dev/mapper/luksdev>."
23551 #: ../fish/guestfish.pod:780
23554 " ><fs> luks-open /dev/sda2 luksdev\n"
23555 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23561 #: ../fish/guestfish.pod:783
23563 "Finally you have to tell LVM to scan for volume groups on the newly created "
23569 #: ../fish/guestfish.pod:786
23573 " vg-activate-all true\n"
23579 #: ../fish/guestfish.pod:789
23580 msgid "The logical volume(s) can now be mounted in the usual way."
23585 #: ../fish/guestfish.pod:791
23587 "Before closing a LUKS device you must unmount any logical volumes on it and "
23588 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23589 "one. Then you can close the mapper device:"
23594 #: ../fish/guestfish.pod:795
23597 " vg-activate false /dev/VG\n"
23598 " luks-close /dev/mapper/luksdev\n"
23604 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23605 msgid "WINDOWS PATHS"
23609 #: ../fish/guestfish.pod:800
23611 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23612 "letters and paths (with some limitations). The following commands are "
23618 #: ../fish/guestfish.pod:804
23621 " file /WINDOWS/system32/config/system.LOG\n"
23627 #: ../fish/guestfish.pod:806
23630 " file win:\\windows\\system32\\config\\system.log\n"
23635 #: ../fish/guestfish.pod:808
23638 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23643 #: ../fish/guestfish.pod:810
23645 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23646 "where the drive is mounted, prepending that to the path, changing all "
23647 "backslash characters to forward slash, then resolving the result using L</"
23648 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23649 "the parameter might be rewritten like this:"
23653 #: ../fish/guestfish.pod:816
23656 " win:e:\\foo\\bar => /e/FOO/bar\n"
23661 #: ../fish/guestfish.pod:818
23662 msgid "This only works in argument positions that expect a path."
23667 #: ../fish/guestfish.pod:820
23668 msgid "UPLOADING AND DOWNLOADING FILES"
23673 #: ../fish/guestfish.pod:822
23675 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23676 "others which upload from or download to a local file, you can use the "
23677 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23682 #: ../fish/guestfish.pod:826
23691 #: ../fish/guestfish.pod:828
23693 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23698 #: ../fish/guestfish.pod:831
23701 " tar-out /etc - | tar tf -\n"
23707 #: ../fish/guestfish.pod:833
23709 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23710 "command (see L</PIPES>)."
23715 #: ../fish/guestfish.pod:836
23717 "When using C<-> to read from stdin, the input is read up to the end of "
23718 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23719 "some arbitrary end marker:"
23724 #: ../fish/guestfish.pod:840
23727 " upload -<<END /foo\n"
23737 #: ../fish/guestfish.pod:846
23739 "Any string of characters can be used instead of C<END>. The end marker must "
23740 "appear on a line of its own, without any preceeding or following characters "
23741 "(not even spaces)."
23746 #: ../fish/guestfish.pod:850
23748 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23749 "upload local files (so-called \"FileIn\" parameters in the generator)."
23754 #: ../fish/guestfish.pod:853
23755 msgid "EXIT ON ERROR BEHAVIOUR"
23760 #: ../fish/guestfish.pod:855
23762 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23763 "taking commands from a human over a tty), and will exit on the first error "
23764 "in non-interactive mode (scripts, commands given on the command line)."
23769 #: ../fish/guestfish.pod:860
23771 "If you prefix a command with a I<-> character, then that command will not "
23772 "cause guestfish to exit, even if that (one) command returns an error."
23777 #: ../fish/guestfish.pod:864
23778 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23783 #: ../fish/guestfish.pod:866
23785 "Guestfish can be remote-controlled over a socket. This is useful "
23786 "particularly in shell scripts where you want to make several different "
23787 "changes to a filesystem, but you don't want the overhead of starting up a "
23788 "guestfish process each time."
23793 #: ../fish/guestfish.pod:871
23794 msgid "Start a guestfish server process using:"
23799 #: ../fish/guestfish.pod:873
23802 " eval \"`guestfish --listen`\"\n"
23808 #: ../fish/guestfish.pod:875
23809 msgid "and then send it commands by doing:"
23814 #: ../fish/guestfish.pod:877
23817 " guestfish --remote cmd [...]\n"
23823 #: ../fish/guestfish.pod:879
23824 msgid "To cause the server to exit, send it the exit command:"
23829 #: ../fish/guestfish.pod:881
23832 " guestfish --remote exit\n"
23838 #: ../fish/guestfish.pod:883
23840 "Note that the server will normally exit if there is an error in a command. "
23841 "You can change this in the usual way. See section L</EXIT ON ERROR "
23847 #: ../fish/guestfish.pod:887
23848 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23853 #: ../fish/guestfish.pod:889
23855 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23856 "is how the I<--remote> option knows where to send the commands. You can "
23857 "have several guestfish listener processes running using:"
23862 #: ../fish/guestfish.pod:893
23865 " eval \"`guestfish --listen`\"\n"
23866 " pid1=$GUESTFISH_PID\n"
23867 " eval \"`guestfish --listen`\"\n"
23868 " pid2=$GUESTFISH_PID\n"
23870 " guestfish --remote=$pid1 cmd\n"
23871 " guestfish --remote=$pid2 cmd\n"
23877 #: ../fish/guestfish.pod:901
23878 msgid "REMOTE CONTROL AND CSH"
23883 #: ../fish/guestfish.pod:903
23885 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23891 #: ../fish/guestfish.pod:906
23894 " eval \"`guestfish --listen --csh`\"\n"
23900 #: ../fish/guestfish.pod:908
23901 msgid "REMOTE CONTROL DETAILS"
23906 #: ../fish/guestfish.pod:910
23908 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23909 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23910 "and C<$PID> is the process ID of the server."
23915 #: ../fish/guestfish.pod:914
23916 msgid "Guestfish client and server versions must match exactly."
23921 #: ../fish/guestfish.pod:916
23922 msgid "PREPARED DISK IMAGES"
23927 #: ../fish/guestfish.pod:918
23929 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23930 "preformatted disk images that guestfish can make for you to save typing. "
23931 "This is particularly useful for testing purposes. This option is used "
23932 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23933 "can be mixed with I<-a>)."
23938 #: ../fish/guestfish.pod:924
23940 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23941 "the second and so on. Existing files in the current directory are "
23947 #: ../fish/guestfish.pod:928
23949 "The type briefly describes how the disk should be sized, partitioned, how "
23950 "filesystem(s) should be created, and how content should be added. "
23951 "Optionally the type can be followed by extra parameters, separated by C<:> "
23952 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23953 "allocated disk, containing a single partition, with the partition formatted "
23954 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23960 #: ../fish/guestfish.pod:936
23961 msgid "To list the available types and any extra parameters they take, run:"
23966 #: ../fish/guestfish.pod:940
23968 "Note that the prepared filesystem is not mounted. You would usually have to "
23969 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23974 #: ../fish/guestfish.pod:944
23976 "If any I<-N> or I<--new> options are given, the guest is automatically "
23982 #: ../fish/guestfish.pod:949
23983 msgid "Create a 100MB disk with an ext4-formatted partition:"
23988 #: ../fish/guestfish.pod:951
23991 " guestfish -N fs:ext4\n"
23997 #: ../fish/guestfish.pod:953
23998 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24003 #: ../fish/guestfish.pod:955
24006 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24012 #: ../fish/guestfish.pod:957
24013 msgid "Create a blank 200MB disk:"
24018 #: ../fish/guestfish.pod:959
24021 " guestfish -N disk:200M\n"
24027 #: ../fish/guestfish.pod:961
24028 msgid "PROGRESS BARS"
24033 #: ../fish/guestfish.pod:963
24035 "Some (not all) long-running commands send progress notification messages as "
24036 "they are running. Guestfish turns these messages into progress bars."
24041 #: ../fish/guestfish.pod:967
24043 "When a command that supports progress bars takes longer than two seconds to "
24044 "run, and if progress bars are enabled, then you will see one appearing below "
24050 #: ../fish/guestfish.pod:971
24053 " ><fs> copy-size /large-file /another-file 2048M\n"
24054 " / 10% [#####-----------------------------------------] 00:30\n"
24060 #: ../fish/guestfish.pod:974
24062 "The spinner on the left hand side moves round once for every progress "
24063 "notification received from the backend. This is a (reasonably) golden "
24064 "assurance that the command is \"doing something\" even if the progress bar "
24065 "is not moving, because the command is able to send the progress "
24066 "notifications. When the bar reaches 100% and the command finishes, the "
24067 "spinner disappears."
24072 #: ../fish/guestfish.pod:981
24074 "Progress bars are enabled by default when guestfish is used interactively. "
24075 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24076 "and you can disable them completely using I<--no-progress-bars>."
24081 #: ../fish/guestfish.pod:986
24082 msgid "GUESTFISH COMMANDS"
24087 #: ../fish/guestfish.pod:988
24089 "The commands in this section are guestfish convenience commands, in other "
24090 "words, they are not part of the L<guestfs(3)> API."
24095 #: ../fish/guestfish.pod:991
24101 #: ../fish/guestfish.pod:993
24111 #: ../fish/guestfish.pod:996
24112 msgid "Without any parameter, this provides general help."
24117 #: ../fish/guestfish.pod:998
24118 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24123 #: ../fish/guestfish.pod:1000
24124 msgid "quit | exit"
24129 #: ../fish/guestfish.pod:1002
24130 msgid "This exits guestfish. You can also use C<^D> key."
24135 #: ../fish/guestfish.pod:1004
24136 msgid "@FISH_COMMANDS@"
24141 #: ../fish/guestfish.pod:1006
24147 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
24153 #: ../fish/guestfish.pod:1012
24155 "guestfish returns 0 if the commands completed without error, or 1 if there "
24161 #: ../fish/guestfish.pod:1019
24167 #: ../fish/guestfish.pod:1021
24169 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24175 #: ../fish/guestfish.pod:1024
24176 msgid "GUESTFISH_PID"
24181 #: ../fish/guestfish.pod:1026
24183 "Used with the I<--remote> option to specify the remote guestfish process to "
24184 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24189 #: ../fish/guestfish.pod:1030
24195 #: ../fish/guestfish.pod:1032
24197 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24198 "not specified, the external L<hexedit(1)> program is used."
24203 #: ../fish/guestfish.pod:1036
24209 #: ../fish/guestfish.pod:1038
24211 "If compiled with GNU readline support, various files in the home directory "
24212 "can be used. See L</FILES>."
24217 #: ../fish/guestfish.pod:1047
24219 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24220 "effect as using the B<-v> option."
24225 #: ../fish/guestfish.pod:1059
24227 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24228 "the discussion of paths in L<guestfs(3)>."
24233 #: ../fish/guestfish.pod:1070
24234 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24239 #: ../fish/guestfish.pod:1072
24245 #: ../fish/guestfish.pod:1074
24247 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24253 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:262
24258 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:266
24259 msgid "$HOME/.libguestfs-tools.rc"
24263 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
24264 msgid "/etc/libguestfs-tools.conf"
24268 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
24270 "This configuration file controls the default read-only or read-write mode "
24271 "(I<--ro> or I<--rw>)."
24275 #: ../fish/guestfish.pod:1101
24276 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24281 #: ../fish/guestfish.pod:1103
24282 msgid "$HOME/.guestfish"
24287 #: ../fish/guestfish.pod:1105
24289 "If compiled with GNU readline support, then the command history is saved in "
24295 #: ../fish/guestfish.pod:1108
24296 msgid "$HOME/.inputrc"
24301 #: ../fish/guestfish.pod:1110
24302 msgid "/etc/inputrc"
24307 #: ../fish/guestfish.pod:1112
24309 "If compiled with GNU readline support, then these files can be used to "
24310 "configure readline. For further information, please see L<readline(3)/"
24311 "INITIALIZATION FILE>."
24316 #: ../fish/guestfish.pod:1116
24317 msgid "To write rules which only apply to guestfish, use:"
24322 #: ../fish/guestfish.pod:1118
24333 #: ../fish/guestfish.pod:1122
24335 "Variables that you can set in inputrc that change the behaviour of guestfish "
24336 "in useful ways include:"
24341 #: ../fish/guestfish.pod:1127
24342 msgid "completion-ignore-case (default: on)"
24347 #: ../fish/guestfish.pod:1129
24349 "By default, guestfish will ignore case when tab-completing paths on the "
24355 #: ../fish/guestfish.pod:1132
24358 " set completion-ignore-case off\n"
24364 #: ../fish/guestfish.pod:1134
24365 msgid "to make guestfish case sensitive."
24370 #: ../fish/guestfish.pod:1138
24376 #: ../fish/guestfish.pod:1140
24377 msgid "test2.img (etc)"
24381 #: ../fish/guestfish.pod:1142
24383 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24384 "will be created in the file C<test1.img> in the current directory. The "
24385 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24386 "the same name will be overwritten."
24390 #: ../fish/guestfish.pod:1151
24392 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24393 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24394 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24395 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24396 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24397 ">, L<hexedit(1)>."
24402 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
24403 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
24404 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24405 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24406 #: ../tools/virt-list-partitions.pl:277
24408 "This program is free software; you can redistribute it and/or modify it "
24409 "under the terms of the GNU General Public License as published by the Free "
24410 "Software Foundation; either version 2 of the License, or (at your option) "
24411 "any later version."
24416 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
24417 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
24418 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24419 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24420 #: ../tools/virt-list-partitions.pl:282
24422 "This program is distributed in the hope that it will be useful, but WITHOUT "
24423 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24424 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24430 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
24431 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
24432 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24433 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24434 #: ../tools/virt-list-partitions.pl:287
24436 "You should have received a copy of the GNU General Public License along with "
24437 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24438 "Ave, Cambridge, MA 02139, USA."
24443 #: ../fish/guestfish-actions.pod:1
24449 #: ../fish/guestfish-actions.pod:3
24452 " add-cdrom filename\n"
24458 #: ../fish/guestfish-actions.pod:15
24460 "This call checks for the existence of C<filename>. This stops you from "
24461 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24462 "and C<http:> URLs. To specify those, use the general L</config> call "
24468 #: ../fish/guestfish-actions.pod:22
24470 "If you just want to add an ISO file (often you use this as an efficient way "
24471 "to transfer large files into the guest), then you should probably use L</add-"
24472 "drive-ro> instead."
24477 #: ../fish/guestfish-actions.pod:35
24483 #: ../fish/guestfish-actions.pod:37
24488 #: ../fish/guestfish-actions.pod:39
24491 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24497 #: ../fish/guestfish-actions.pod:41
24499 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24500 "It works by connecting to libvirt, requesting the domain and domain XML from "
24501 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24506 #: ../fish/guestfish-actions.pod:71
24508 "The other optional parameters are passed directly through to L</add-drive-"
24514 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24515 #: ../fish/guestfish-actions.pod:3044
24517 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24522 #: ../fish/guestfish-actions.pod:76
24528 #: ../fish/guestfish-actions.pod:78
24531 " add-drive filename\n"
24537 #: ../fish/guestfish-actions.pod:80
24539 "This function is the equivalent of calling L</add-drive-opts> with no "
24540 "optional parameters, so the disk is added writable, with the format being "
24541 "detected automatically."
24546 #: ../fish/guestfish-actions.pod:84
24548 "Automatic detection of the format opens you up to a potential security hole "
24549 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24550 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24551 "you should think about replacing calls to this function with calls to L</add-"
24552 "drive-opts>, and specifying the format."
24557 #: ../fish/guestfish-actions.pod:91
24558 msgid "add-drive-opts"
24563 #: ../fish/guestfish-actions.pod:93
24569 #: ../fish/guestfish-actions.pod:95
24572 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24578 #: ../fish/guestfish-actions.pod:122
24580 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24581 "add-drive-ro>) then the format is automatically detected. Possible formats "
24582 "include C<raw> and C<qcow2>."
24587 #: ../fish/guestfish-actions.pod:133
24589 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24590 "add-drive-with-if> call (q.v.)"
24595 #: ../fish/guestfish-actions.pod:140
24596 msgid "add-drive-ro"
24601 #: ../fish/guestfish-actions.pod:142
24607 #: ../fish/guestfish-actions.pod:144
24610 " add-drive-ro filename\n"
24616 #: ../fish/guestfish-actions.pod:146
24618 "This function is the equivalent of calling L</add-drive-opts> with the "
24619 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24620 "is added read-only, with the format being detected automatically."
24625 #: ../fish/guestfish-actions.pod:151
24626 msgid "add-drive-ro-with-if"
24631 #: ../fish/guestfish-actions.pod:153
24634 " add-drive-ro-with-if filename iface\n"
24640 #: ../fish/guestfish-actions.pod:155
24642 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24643 "interface emulation to use at run time."
24648 #: ../fish/guestfish-actions.pod:165
24649 msgid "add-drive-with-if"
24654 #: ../fish/guestfish-actions.pod:167
24657 " add-drive-with-if filename iface\n"
24663 #: ../fish/guestfish-actions.pod:169
24665 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24666 "interface emulation to use at run time."
24671 #: ../fish/guestfish-actions.pod:179
24677 #: ../fish/guestfish-actions.pod:181
24680 " aug-clear augpath\n"
24686 #: ../fish/guestfish-actions.pod:186
24692 #: ../fish/guestfish-actions.pod:188
24701 #: ../fish/guestfish-actions.pod:190
24703 "Close the current Augeas handle and free up any resources used by it. After "
24704 "calling this, you have to call L</aug-init> again before you can use any "
24705 "other Augeas functions."
24710 #: ../fish/guestfish-actions.pod:195
24711 msgid "aug-defnode"
24716 #: ../fish/guestfish-actions.pod:197
24719 " aug-defnode name expr val\n"
24725 #: ../fish/guestfish-actions.pod:202
24727 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24728 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24729 "containing that single node."
24734 #: ../fish/guestfish-actions.pod:210
24740 #: ../fish/guestfish-actions.pod:212
24743 " aug-defvar name expr\n"
24749 #: ../fish/guestfish-actions.pod:221
24755 #: ../fish/guestfish-actions.pod:223
24758 " aug-get augpath\n"
24764 #: ../fish/guestfish-actions.pod:228
24770 #: ../fish/guestfish-actions.pod:230
24773 " aug-init root flags\n"
24779 #: ../fish/guestfish-actions.pod:236
24780 msgid "You must call this before using any other L</aug-*> commands."
24785 #: ../fish/guestfish-actions.pod:271
24786 msgid "Do not load the tree in L</aug-init>."
24791 #: ../fish/guestfish-actions.pod:275
24792 msgid "To close the handle, you can call L</aug-close>."
24797 #: ../fish/guestfish-actions.pod:279
24803 #: ../fish/guestfish-actions.pod:281
24806 " aug-insert augpath label true|false\n"
24812 #: ../fish/guestfish-actions.pod:291
24818 #: ../fish/guestfish-actions.pod:293
24827 #: ../fish/guestfish-actions.pod:300
24833 #: ../fish/guestfish-actions.pod:302
24836 " aug-ls augpath\n"
24842 #: ../fish/guestfish-actions.pod:304
24844 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24845 "resulting nodes into alphabetical order."
24850 #: ../fish/guestfish-actions.pod:307
24856 #: ../fish/guestfish-actions.pod:309
24859 " aug-match augpath\n"
24865 #: ../fish/guestfish-actions.pod:315
24871 #: ../fish/guestfish-actions.pod:317
24874 " aug-mv src dest\n"
24880 #: ../fish/guestfish-actions.pod:322
24886 #: ../fish/guestfish-actions.pod:324
24889 " aug-rm augpath\n"
24895 #: ../fish/guestfish-actions.pod:330
24901 #: ../fish/guestfish-actions.pod:332
24910 #: ../fish/guestfish-actions.pod:336
24912 "The flags which were passed to L</aug-init> affect exactly how files are "
24918 #: ../fish/guestfish-actions.pod:339
24924 #: ../fish/guestfish-actions.pod:341
24927 " aug-set augpath val\n"
24933 #: ../fish/guestfish-actions.pod:345
24935 "In the Augeas API, it is possible to clear a node by setting the value to "
24936 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24937 "this call. Instead you must use the L</aug-clear> call."
24942 #: ../fish/guestfish-actions.pod:350
24948 #: ../fish/guestfish-actions.pod:352
24951 " available 'groups ...'\n"
24957 #: ../fish/guestfish-actions.pod:358
24959 "The libguestfs groups, and the functions that those groups correspond to, "
24960 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24961 "runtime by calling L</available-all-groups>."
24966 #: ../fish/guestfish-actions.pod:382
24967 msgid "You must call L</launch> before calling this function."
24972 #: ../fish/guestfish-actions.pod:404
24974 "This call was added in version C<1.0.80>. In previous versions of "
24975 "libguestfs all you could do would be to speculatively execute a command to "
24976 "find out if the daemon implemented it. See also L</version>."
24981 #: ../fish/guestfish-actions.pod:411
24982 msgid "available-all-groups"
24987 #: ../fish/guestfish-actions.pod:413
24990 " available-all-groups\n"
24996 #: ../fish/guestfish-actions.pod:415
24998 "This command returns a list of all optional groups that this daemon knows "
24999 "about. Note this returns both supported and unsupported groups. To find "
25000 "out which ones the daemon can actually support you have to call L</"
25001 "available> on each member of the returned list."
25006 #: ../fish/guestfish-actions.pod:421
25007 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25012 #: ../fish/guestfish-actions.pod:423
25018 #: ../fish/guestfish-actions.pod:425
25021 " base64-in (base64file|-) filename\n"
25027 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
25028 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
25029 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1225
25030 #: ../fish/guestfish-actions.pod:4486 ../fish/guestfish-actions.pod:4498
25031 #: ../fish/guestfish-actions.pod:4509 ../fish/guestfish-actions.pod:4520
25032 #: ../fish/guestfish-actions.pod:4572 ../fish/guestfish-actions.pod:4581
25033 #: ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4658
25034 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25039 #: ../fish/guestfish-actions.pod:432
25045 #: ../fish/guestfish-actions.pod:434
25048 " base64-out filename (base64file|-)\n"
25054 #: ../fish/guestfish-actions.pod:441
25055 msgid "blockdev-flushbufs"
25060 #: ../fish/guestfish-actions.pod:443
25063 " blockdev-flushbufs device\n"
25069 #: ../fish/guestfish-actions.pod:450
25070 msgid "blockdev-getbsz"
25075 #: ../fish/guestfish-actions.pod:452
25078 " blockdev-getbsz device\n"
25084 #: ../fish/guestfish-actions.pod:461
25085 msgid "blockdev-getro"
25090 #: ../fish/guestfish-actions.pod:463
25093 " blockdev-getro device\n"
25099 #: ../fish/guestfish-actions.pod:470
25100 msgid "blockdev-getsize64"
25105 #: ../fish/guestfish-actions.pod:472
25108 " blockdev-getsize64 device\n"
25114 #: ../fish/guestfish-actions.pod:476
25115 msgid "See also L</blockdev-getsz>."
25120 #: ../fish/guestfish-actions.pod:480
25121 msgid "blockdev-getss"
25126 #: ../fish/guestfish-actions.pod:482
25129 " blockdev-getss device\n"
25135 #: ../fish/guestfish-actions.pod:487
25137 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25142 #: ../fish/guestfish-actions.pod:492
25143 msgid "blockdev-getsz"
25148 #: ../fish/guestfish-actions.pod:494
25151 " blockdev-getsz device\n"
25157 #: ../fish/guestfish-actions.pod:499
25159 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25160 "blockdev-getsize64> for the more useful I<size in bytes>."
25165 #: ../fish/guestfish-actions.pod:505
25166 msgid "blockdev-rereadpt"
25171 #: ../fish/guestfish-actions.pod:507
25174 " blockdev-rereadpt device\n"
25180 #: ../fish/guestfish-actions.pod:513
25181 msgid "blockdev-setbsz"
25186 #: ../fish/guestfish-actions.pod:515
25189 " blockdev-setbsz device blocksize\n"
25195 #: ../fish/guestfish-actions.pod:524
25196 msgid "blockdev-setro"
25201 #: ../fish/guestfish-actions.pod:526
25204 " blockdev-setro device\n"
25210 #: ../fish/guestfish-actions.pod:532
25211 msgid "blockdev-setrw"
25216 #: ../fish/guestfish-actions.pod:534
25219 " blockdev-setrw device\n"
25225 #: ../fish/guestfish-actions.pod:540
25226 msgid "case-sensitive-path"
25231 #: ../fish/guestfish-actions.pod:542
25234 " case-sensitive-path path\n"
25240 #: ../fish/guestfish-actions.pod:566
25242 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25243 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25244 "the directories were originally created under Windows)."
25249 #: ../fish/guestfish-actions.pod:574
25250 msgid "See also L</realpath>."
25255 #: ../fish/guestfish-actions.pod:576
25261 #: ../fish/guestfish-actions.pod:578
25270 #: ../fish/guestfish-actions.pod:582
25272 "Note that this function cannot correctly handle binary files (specifically, "
25273 "files containing C<\\0> character which is treated as end of string). For "
25274 "those you need to use the L</read-file> or L</download> functions which have "
25275 "a more complex interface."
25280 #: ../fish/guestfish-actions.pod:590
25286 #: ../fish/guestfish-actions.pod:592
25289 " checksum csumtype path\n"
25295 #: ../fish/guestfish-actions.pod:635
25296 msgid "To get the checksum for a device, use L</checksum-device>."
25301 #: ../fish/guestfish-actions.pod:637
25302 msgid "To get the checksums for many files, use L</checksums-out>."
25307 #: ../fish/guestfish-actions.pod:639
25308 msgid "checksum-device"
25313 #: ../fish/guestfish-actions.pod:641
25316 " checksum-device csumtype device\n"
25322 #: ../fish/guestfish-actions.pod:643
25324 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25325 "device named C<device>. For the types of checksums supported see the L</"
25326 "checksum> command."
25331 #: ../fish/guestfish-actions.pod:647
25332 msgid "checksums-out"
25337 #: ../fish/guestfish-actions.pod:649
25340 " checksums-out csumtype directory (sumsfile|-)\n"
25346 #: ../fish/guestfish-actions.pod:665
25352 #: ../fish/guestfish-actions.pod:667
25355 " chmod mode path\n"
25361 #: ../fish/guestfish-actions.pod:678
25367 #: ../fish/guestfish-actions.pod:680
25370 " chown owner group path\n"
25376 #: ../fish/guestfish-actions.pod:688
25382 #: ../fish/guestfish-actions.pod:690
25385 " command 'arguments ...'\n"
25391 #: ../fish/guestfish-actions.pod:697
25393 "The single parameter is an argv-style list of arguments. The first element "
25394 "is the name of the program to run. Subsequent elements are parameters. The "
25395 "list must be non-empty (ie. must contain a program name). Note that the "
25396 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25401 #: ../fish/guestfish-actions.pod:725
25402 msgid "command-lines"
25407 #: ../fish/guestfish-actions.pod:727
25410 " command-lines 'arguments ...'\n"
25416 #: ../fish/guestfish-actions.pod:729
25418 "This is the same as L</command>, but splits the result into a list of lines."
25423 #: ../fish/guestfish-actions.pod:732
25424 msgid "See also: L</sh-lines>"
25429 #: ../fish/guestfish-actions.pod:737
25435 #: ../fish/guestfish-actions.pod:739
25438 " config qemuparam qemuvalue\n"
25444 #: ../fish/guestfish-actions.pod:750
25450 #: ../fish/guestfish-actions.pod:752
25453 " copy-size src dest size\n"
25459 #: ../fish/guestfish-actions.pod:760
25465 #: ../fish/guestfish-actions.pod:762
25474 #: ../fish/guestfish-actions.pod:767
25480 #: ../fish/guestfish-actions.pod:769
25489 #: ../fish/guestfish-actions.pod:774
25495 #: ../fish/guestfish-actions.pod:776
25504 #: ../fish/guestfish-actions.pod:783
25506 "If the destination is a device, it must be as large or larger than the "
25507 "source file or device, otherwise the copy will fail. This command cannot do "
25508 "partial copies (see L</copy-size>)."
25513 #: ../fish/guestfish-actions.pod:787
25519 #: ../fish/guestfish-actions.pod:789
25528 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25530 "This command is mostly useful for interactive sessions. It is I<not> "
25531 "intended that you try to parse the output string. Use L</statvfs> from "
25537 #: ../fish/guestfish-actions.pod:797
25543 #: ../fish/guestfish-actions.pod:799
25552 #: ../fish/guestfish-actions.pod:808
25558 #: ../fish/guestfish-actions.pod:810
25567 #: ../fish/guestfish-actions.pod:816
25569 "Another way to get the same information is to enable verbose messages with "
25570 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25571 "before running the program."
25576 #: ../fish/guestfish-actions.pod:821
25582 #: ../fish/guestfish-actions.pod:823
25585 " download remotefilename (filename|-)\n"
25591 #: ../fish/guestfish-actions.pod:830
25592 msgid "See also L</upload>, L</cat>."
25597 #: ../fish/guestfish-actions.pod:834
25598 msgid "download-offset"
25603 #: ../fish/guestfish-actions.pod:836
25606 " download-offset remotefilename (filename|-) offset size\n"
25612 #: ../fish/guestfish-actions.pod:844
25614 "Note that there is no limit on the amount of data that can be downloaded "
25615 "with this call, unlike with L</pread>, and this call always reads the full "
25616 "amount unless an error occurs."
25621 #: ../fish/guestfish-actions.pod:849
25622 msgid "See also L</download>, L</pread>."
25627 #: ../fish/guestfish-actions.pod:853
25628 msgid "drop-caches"
25633 #: ../fish/guestfish-actions.pod:855
25636 " drop-caches whattodrop\n"
25642 #: ../fish/guestfish-actions.pod:867
25648 #: ../fish/guestfish-actions.pod:869
25657 #: ../fish/guestfish-actions.pod:881
25663 #: ../fish/guestfish-actions.pod:883
25666 " e2fsck-f device\n"
25672 #: ../fish/guestfish-actions.pod:889
25674 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25675 "should use L</fsck>."
25680 #: ../fish/guestfish-actions.pod:892
25681 msgid "echo-daemon"
25686 #: ../fish/guestfish-actions.pod:894
25689 " echo-daemon 'words ...'\n"
25695 #: ../fish/guestfish-actions.pod:901
25696 msgid "See also L</ping-daemon>."
25701 #: ../fish/guestfish-actions.pod:903
25707 #: ../fish/guestfish-actions.pod:905
25710 " egrep regex path\n"
25716 #: ../fish/guestfish-actions.pod:913
25722 #: ../fish/guestfish-actions.pod:915
25725 " egrepi regex path\n"
25731 #: ../fish/guestfish-actions.pod:923
25737 #: ../fish/guestfish-actions.pod:925
25740 " equal file1 file2\n"
25746 #: ../fish/guestfish-actions.pod:932
25752 #: ../fish/guestfish-actions.pod:934
25761 #: ../fish/guestfish-actions.pod:939
25762 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25767 #: ../fish/guestfish-actions.pod:941
25773 #: ../fish/guestfish-actions.pod:943
25776 " fallocate path len\n"
25782 #: ../fish/guestfish-actions.pod:960
25783 msgid "fallocate64"
25788 #: ../fish/guestfish-actions.pod:962
25791 " fallocate64 path len\n"
25797 #: ../fish/guestfish-actions.pod:968
25799 "Note that this call allocates disk blocks for the file. To create a sparse "
25800 "file use L</truncate-size> instead."
25805 #: ../fish/guestfish-actions.pod:971
25807 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25808 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25809 "maximum size of files created through that call to 1GB."
25814 #: ../fish/guestfish-actions.pod:980
25820 #: ../fish/guestfish-actions.pod:982
25823 " fgrep pattern path\n"
25829 #: ../fish/guestfish-actions.pod:990
25835 #: ../fish/guestfish-actions.pod:992
25838 " fgrepi pattern path\n"
25844 #: ../fish/guestfish-actions.pod:1000
25850 #: ../fish/guestfish-actions.pod:1002
25858 #: ../fish/guestfish-actions.pod:1018
25860 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
25866 #: ../fish/guestfish-actions.pod:1021
25867 msgid "file-architecture"
25872 #: ../fish/guestfish-actions.pod:1023
25875 " file-architecture filename\n"
25881 #: ../fish/guestfish-actions.pod:1126
25887 #: ../fish/guestfish-actions.pod:1128
25896 #: ../fish/guestfish-actions.pod:1132
25898 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25899 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25904 #: ../fish/guestfish-actions.pod:1136
25910 #: ../fish/guestfish-actions.pod:1138
25913 " fill c len path\n"
25919 #: ../fish/guestfish-actions.pod:1144
25921 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25922 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25923 "L</fill-pattern>."
25928 #: ../fish/guestfish-actions.pod:1149
25929 msgid "fill-pattern"
25934 #: ../fish/guestfish-actions.pod:1151
25937 " fill-pattern pattern len path\n"
25943 #: ../fish/guestfish-actions.pod:1153
25945 "This function is like L</fill> except that it creates a new file of length "
25946 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25947 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25953 #: ../fish/guestfish-actions.pod:1158
25959 #: ../fish/guestfish-actions.pod:1160
25962 " find directory\n"
25968 #: ../fish/guestfish-actions.pod:1174
25969 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25974 #: ../fish/guestfish-actions.pod:1187
25975 msgid "See also L</find0>."
25980 #: ../fish/guestfish-actions.pod:1192
25986 #: ../fish/guestfish-actions.pod:1194
25989 " find0 directory (files|-)\n"
25995 #: ../fish/guestfish-actions.pod:1200
25997 "This command works the same way as L</find> with the following exceptions:"
26002 #: ../fish/guestfish-actions.pod:1227
26003 msgid "findfs-label"
26008 #: ../fish/guestfish-actions.pod:1229
26011 " findfs-label label\n"
26017 #: ../fish/guestfish-actions.pod:1235
26018 msgid "To find the label of a filesystem, use L</vfs-label>."
26023 #: ../fish/guestfish-actions.pod:1237
26024 msgid "findfs-uuid"
26029 #: ../fish/guestfish-actions.pod:1239
26032 " findfs-uuid uuid\n"
26038 #: ../fish/guestfish-actions.pod:1245
26039 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26044 #: ../fish/guestfish-actions.pod:1247
26050 #: ../fish/guestfish-actions.pod:1249
26053 " fsck fstype device\n"
26059 #: ../fish/guestfish-actions.pod:1279
26065 #: ../fish/guestfish-actions.pod:1281
26073 #: ../fish/guestfish-actions.pod:1288
26074 msgid "get-attach-method"
26078 #: ../fish/guestfish-actions.pod:1290
26081 " get-attach-method\n"
26086 #: ../fish/guestfish-actions.pod:1292
26087 msgid "Return the current attach method. See L</set-attach-method>."
26092 #: ../fish/guestfish-actions.pod:1294
26093 msgid "get-autosync"
26098 #: ../fish/guestfish-actions.pod:1296
26107 #: ../fish/guestfish-actions.pod:1300
26113 #: ../fish/guestfish-actions.pod:1302
26122 #: ../fish/guestfish-actions.pod:1306
26123 msgid "get-e2label"
26128 #: ../fish/guestfish-actions.pod:1308
26131 " get-e2label device\n"
26137 #: ../fish/guestfish-actions.pod:1320
26143 #: ../fish/guestfish-actions.pod:1322
26146 " get-e2uuid device\n"
26152 #: ../fish/guestfish-actions.pod:1334
26153 msgid "get-memsize"
26158 #: ../fish/guestfish-actions.pod:1336
26167 #: ../fish/guestfish-actions.pod:1341
26169 "If L</set-memsize> was not called on this handle, and if "
26170 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26171 "value for memsize."
26176 #: ../fish/guestfish-actions.pod:1348
26177 msgid "get-network"
26182 #: ../fish/guestfish-actions.pod:1350
26191 #: ../fish/guestfish-actions.pod:1354
26197 #: ../fish/guestfish-actions.pod:1356
26206 #: ../fish/guestfish-actions.pod:1363
26212 #: ../fish/guestfish-actions.pod:1365
26218 #: ../fish/guestfish-actions.pod:1367
26227 #: ../fish/guestfish-actions.pod:1374
26233 #: ../fish/guestfish-actions.pod:1376
26242 #: ../fish/guestfish-actions.pod:1383
26243 msgid "get-recovery-proc"
26248 #: ../fish/guestfish-actions.pod:1385
26251 " get-recovery-proc\n"
26257 #: ../fish/guestfish-actions.pod:1389
26258 msgid "get-selinux"
26263 #: ../fish/guestfish-actions.pod:1391
26272 #: ../fish/guestfish-actions.pod:1393
26274 "This returns the current setting of the selinux flag which is passed to the "
26275 "appliance at boot time. See L</set-selinux>."
26280 #: ../fish/guestfish-actions.pod:1399
26286 #: ../fish/guestfish-actions.pod:1401
26295 #: ../fish/guestfish-actions.pod:1408
26301 #: ../fish/guestfish-actions.pod:1410
26310 #: ../fish/guestfish-actions.pod:1414
26316 #: ../fish/guestfish-actions.pod:1416
26325 #: ../fish/guestfish-actions.pod:1418
26327 "Return the current umask. By default the umask is C<022> unless it has been "
26328 "set by calling L</umask>."
26333 #: ../fish/guestfish-actions.pod:1421
26334 msgid "get-verbose"
26339 #: ../fish/guestfish-actions.pod:1423
26348 #: ../fish/guestfish-actions.pod:1427
26354 #: ../fish/guestfish-actions.pod:1429
26363 #: ../fish/guestfish-actions.pod:1433
26364 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26369 #: ../fish/guestfish-actions.pod:1436
26375 #: ../fish/guestfish-actions.pod:1438
26378 " getxattr path name\n"
26384 #: ../fish/guestfish-actions.pod:1440
26386 "Get a single extended attribute from file C<path> named C<name>. This call "
26387 "follows symlinks. If you want to lookup an extended attribute for the "
26388 "symlink itself, use L</lgetxattr>."
26393 #: ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:2450
26395 "Normally it is better to get all extended attributes from a file in one go "
26396 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26397 "buggy and do not provide a way to list out attributes. For these "
26398 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26399 "attributes you want in advance and call this function."
26404 #: ../fish/guestfish-actions.pod:1454
26405 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26410 #: ../fish/guestfish-actions.pod:1456
26416 #: ../fish/guestfish-actions.pod:1458
26419 " getxattrs path\n"
26425 #: ../fish/guestfish-actions.pod:1466
26426 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26431 #: ../fish/guestfish-actions.pod:1468
26432 msgid "glob-expand"
26437 #: ../fish/guestfish-actions.pod:1470
26440 " glob-expand pattern\n"
26446 #: ../fish/guestfish-actions.pod:1483
26452 #: ../fish/guestfish-actions.pod:1485
26455 " grep regex path\n"
26461 #: ../fish/guestfish-actions.pod:1493
26467 #: ../fish/guestfish-actions.pod:1495
26470 " grepi regex path\n"
26476 #: ../fish/guestfish-actions.pod:1503
26477 msgid "grub-install"
26482 #: ../fish/guestfish-actions.pod:1505
26485 " grub-install root device\n"
26491 #: ../fish/guestfish-actions.pod:1521
26497 #: ../fish/guestfish-actions.pod:1523
26506 #: ../fish/guestfish-actions.pod:1531
26512 #: ../fish/guestfish-actions.pod:1533
26515 " head-n nrlines path\n"
26521 #: ../fish/guestfish-actions.pod:1546
26527 #: ../fish/guestfish-actions.pod:1548
26536 #: ../fish/guestfish-actions.pod:1556
26542 #: ../fish/guestfish-actions.pod:1558
26545 " initrd-cat initrdpath filename\n"
26551 #: ../fish/guestfish-actions.pod:1570
26552 msgid "See also L</initrd-list>."
26557 #: ../fish/guestfish-actions.pod:1575
26558 msgid "initrd-list"
26563 #: ../fish/guestfish-actions.pod:1577
26566 " initrd-list path\n"
26572 #: ../fish/guestfish-actions.pod:1589
26573 msgid "inotify-add-watch"
26578 #: ../fish/guestfish-actions.pod:1591
26581 " inotify-add-watch path mask\n"
26587 #: ../fish/guestfish-actions.pod:1603
26588 msgid "inotify-close"
26593 #: ../fish/guestfish-actions.pod:1605
26602 #: ../fish/guestfish-actions.pod:1611
26603 msgid "inotify-files"
26608 #: ../fish/guestfish-actions.pod:1613
26617 #: ../fish/guestfish-actions.pod:1615
26619 "This function is a helpful wrapper around L</inotify-read> which just "
26620 "returns a list of pathnames of objects that were touched. The returned "
26621 "pathnames are sorted and deduplicated."
26626 #: ../fish/guestfish-actions.pod:1619
26627 msgid "inotify-init"
26632 #: ../fish/guestfish-actions.pod:1621
26635 " inotify-init maxevents\n"
26641 #: ../fish/guestfish-actions.pod:1627
26643 "C<maxevents> is the maximum number of events which will be queued up between "
26644 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26645 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26646 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26647 "but records the fact that it threw them away by setting a flag "
26648 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26653 #: ../fish/guestfish-actions.pod:1637
26655 "Before any events are generated, you have to add some watches to the "
26656 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26657 "L</inotify-watch-all>."
26662 #: ../fish/guestfish-actions.pod:1643
26664 "Queued up events should be read periodically by calling L</inotify-read> (or "
26665 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26666 "If you don't read the events out often enough then you risk the internal "
26667 "queue overflowing."
26672 #: ../fish/guestfish-actions.pod:1650
26674 "The handle should be closed after use by calling L</inotify-close>. This "
26675 "also removes any watches automatically."
26680 #: ../fish/guestfish-actions.pod:1659
26681 msgid "inotify-read"
26686 #: ../fish/guestfish-actions.pod:1661
26695 #: ../fish/guestfish-actions.pod:1674
26696 msgid "inotify-rm-watch"
26701 #: ../fish/guestfish-actions.pod:1676
26704 " inotify-rm-watch wd\n"
26710 #: ../fish/guestfish-actions.pod:1678
26711 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26716 #: ../fish/guestfish-actions.pod:1681
26717 msgid "inspect-get-arch"
26722 #: ../fish/guestfish-actions.pod:1683
26725 " inspect-get-arch root\n"
26731 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1701
26732 #: ../fish/guestfish-actions.pod:1787 ../fish/guestfish-actions.pod:1823
26733 #: ../fish/guestfish-actions.pod:1841 ../fish/guestfish-actions.pod:1875
26734 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1911
26735 #: ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1959
26736 #: ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:2005
26737 #: ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2065
26738 #: ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2116
26739 #: ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2145
26740 #: ../fish/guestfish-actions.pod:2158 ../fish/guestfish-actions.pod:2173
26742 "This function should only be called with a root device string as returned by "
26748 #: ../fish/guestfish-actions.pod:1688
26750 "This returns the architecture of the inspected operating system. The "
26751 "possible return values are listed under L</file-architecture>."
26756 #: ../fish/guestfish-actions.pod:1697
26757 msgid "inspect-get-distro"
26762 #: ../fish/guestfish-actions.pod:1699
26765 " inspect-get-distro root\n"
26770 #: ../fish/guestfish-actions.pod:1783
26771 msgid "inspect-get-drive-mappings"
26775 #: ../fish/guestfish-actions.pod:1785
26778 " inspect-get-drive-mappings root\n"
26783 #: ../fish/guestfish-actions.pod:1815
26785 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26786 "get-mountpoints>, L</inspect-get-filesystems>."
26791 #: ../fish/guestfish-actions.pod:1819
26792 msgid "inspect-get-filesystems"
26797 #: ../fish/guestfish-actions.pod:1821
26800 " inspect-get-filesystems root\n"
26806 #: ../fish/guestfish-actions.pod:1834
26808 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26809 "get-mountpoints>."
26813 #: ../fish/guestfish-actions.pod:1837
26814 msgid "inspect-get-format"
26818 #: ../fish/guestfish-actions.pod:1839
26821 " inspect-get-format root\n"
26827 #: ../fish/guestfish-actions.pod:1871
26828 msgid "inspect-get-hostname"
26833 #: ../fish/guestfish-actions.pod:1873
26836 " inspect-get-hostname root\n"
26842 #: ../fish/guestfish-actions.pod:1886
26843 msgid "inspect-get-major-version"
26848 #: ../fish/guestfish-actions.pod:1888
26851 " inspect-get-major-version root\n"
26857 #: ../fish/guestfish-actions.pod:1907
26858 msgid "inspect-get-minor-version"
26863 #: ../fish/guestfish-actions.pod:1909
26866 " inspect-get-minor-version root\n"
26872 #: ../fish/guestfish-actions.pod:1919
26874 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26875 "get-major-version>."
26880 #: ../fish/guestfish-actions.pod:1922
26881 msgid "inspect-get-mountpoints"
26886 #: ../fish/guestfish-actions.pod:1924
26889 " inspect-get-mountpoints root\n"
26894 #: ../fish/guestfish-actions.pod:1946
26896 "For operating systems like Windows which still use drive letters, this call "
26897 "will only return an entry for the first drive \"mounted on\" C</>. For "
26898 "information about the mapping of drive letters to partitions, see L</inspect-"
26899 "get-drive-mappings>."
26904 #: ../fish/guestfish-actions.pod:1952
26906 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26907 "get-filesystems>."
26912 #: ../fish/guestfish-actions.pod:1955
26913 msgid "inspect-get-package-format"
26918 #: ../fish/guestfish-actions.pod:1957
26921 " inspect-get-package-format root\n"
26927 #: ../fish/guestfish-actions.pod:1962
26929 "This function and L</inspect-get-package-management> return the package "
26930 "format and package management tool used by the inspected operating system. "
26931 "For example for Fedora these functions would return C<rpm> (package format) "
26932 "and C<yum> (package management)."
26937 #: ../fish/guestfish-actions.pod:1977
26938 msgid "inspect-get-package-management"
26943 #: ../fish/guestfish-actions.pod:1979
26946 " inspect-get-package-management root\n"
26952 #: ../fish/guestfish-actions.pod:1984
26954 "L</inspect-get-package-format> and this function return the package format "
26955 "and package management tool used by the inspected operating system. For "
26956 "example for Fedora these functions would return C<rpm> (package format) and "
26957 "C<yum> (package management)."
26962 #: ../fish/guestfish-actions.pod:2001
26963 msgid "inspect-get-product-name"
26968 #: ../fish/guestfish-actions.pod:2003
26971 " inspect-get-product-name root\n"
26976 #: ../fish/guestfish-actions.pod:2018
26977 msgid "inspect-get-product-variant"
26981 #: ../fish/guestfish-actions.pod:2020
26984 " inspect-get-product-variant root\n"
26989 #: ../fish/guestfish-actions.pod:2044
26991 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26992 "get-product-name>, L</inspect-get-major-version>."
26997 #: ../fish/guestfish-actions.pod:2048
26998 msgid "inspect-get-roots"
27003 #: ../fish/guestfish-actions.pod:2050
27006 " inspect-get-roots\n"
27012 #: ../fish/guestfish-actions.pod:2052
27014 "This function is a convenient way to get the list of root devices, as "
27015 "returned from a previous call to L</inspect-os>, but without redoing the "
27016 "whole inspection process."
27021 #: ../fish/guestfish-actions.pod:2056
27023 "This returns an empty list if either no root devices were found or the "
27024 "caller has not called L</inspect-os>."
27029 #: ../fish/guestfish-actions.pod:2061
27030 msgid "inspect-get-type"
27035 #: ../fish/guestfish-actions.pod:2063
27038 " inspect-get-type root\n"
27043 #: ../fish/guestfish-actions.pod:2096
27044 msgid "inspect-get-windows-current-control-set"
27048 #: ../fish/guestfish-actions.pod:2098
27051 " inspect-get-windows-current-control-set root\n"
27057 #: ../fish/guestfish-actions.pod:2112
27058 msgid "inspect-get-windows-systemroot"
27063 #: ../fish/guestfish-actions.pod:2114
27066 " inspect-get-windows-systemroot root\n"
27071 #: ../fish/guestfish-actions.pod:2128
27072 msgid "inspect-is-live"
27076 #: ../fish/guestfish-actions.pod:2130
27079 " inspect-is-live root\n"
27084 #: ../fish/guestfish-actions.pod:2135
27086 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27087 "then this returns true if a live image was detected on the disk."
27091 #: ../fish/guestfish-actions.pod:2141
27092 msgid "inspect-is-multipart"
27096 #: ../fish/guestfish-actions.pod:2143
27099 " inspect-is-multipart root\n"
27104 #: ../fish/guestfish-actions.pod:2148
27106 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27107 "then this returns true if the disk is part of a set."
27111 #: ../fish/guestfish-actions.pod:2154
27112 msgid "inspect-is-netinst"
27116 #: ../fish/guestfish-actions.pod:2156
27119 " inspect-is-netinst root\n"
27124 #: ../fish/guestfish-actions.pod:2161
27126 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27127 "then this returns true if the disk is a network installer, ie. not a self-"
27128 "contained install CD but one which is likely to require network access to "
27129 "complete the install."
27134 #: ../fish/guestfish-actions.pod:2169
27135 msgid "inspect-list-applications"
27140 #: ../fish/guestfish-actions.pod:2171
27143 " inspect-list-applications root\n"
27149 #: ../fish/guestfish-actions.pod:2178
27151 "I<Note:> This call works differently from other parts of the inspection "
27152 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27153 "then mount up the disks, before calling this. Listing applications is a "
27154 "significantly more difficult operation which requires access to the full "
27155 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27156 "are just returning data cached in the libguestfs handle, this call actually "
27157 "reads parts of the mounted filesystems during the call."
27162 #: ../fish/guestfish-actions.pod:2268
27168 #: ../fish/guestfish-actions.pod:2270
27177 #: ../fish/guestfish-actions.pod:2285
27179 "You can pass the root string(s) returned to other L</inspect-get-*> "
27180 "functions in order to query further information about each operating system, "
27181 "such as the name and version."
27186 #: ../fish/guestfish-actions.pod:2290
27188 "This function uses other libguestfs features such as L</mount-ro> and L</"
27189 "umount-all> in order to mount and unmount filesystems and look at the "
27190 "contents. This should be called with no disks currently mounted. The "
27191 "function may also use Augeas, so any existing Augeas handle will be closed."
27196 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2478
27197 #: ../fish/guestfish-actions.pod:2524
27198 msgid "See also L</list-filesystems>."
27203 #: ../fish/guestfish-actions.pod:2304
27204 msgid "is-blockdev"
27209 #: ../fish/guestfish-actions.pod:2306
27212 " is-blockdev path\n"
27218 #: ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2329
27219 #: ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2357
27220 #: ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2401
27221 #: ../fish/guestfish-actions.pod:2410
27222 msgid "See also L</stat>."
27227 #: ../fish/guestfish-actions.pod:2313
27233 #: ../fish/guestfish-actions.pod:2315
27242 #: ../fish/guestfish-actions.pod:2322
27248 #: ../fish/guestfish-actions.pod:2324
27251 " is-chardev path\n"
27257 #: ../fish/guestfish-actions.pod:2331
27263 #: ../fish/guestfish-actions.pod:2333
27272 #: ../fish/guestfish-actions.pod:2340
27278 #: ../fish/guestfish-actions.pod:2342
27287 #: ../fish/guestfish-actions.pod:2350
27293 #: ../fish/guestfish-actions.pod:2352
27302 #: ../fish/guestfish-actions.pod:2359
27308 #: ../fish/guestfish-actions.pod:2361
27317 #: ../fish/guestfish-actions.pod:2369
27318 msgid "is-launching"
27323 #: ../fish/guestfish-actions.pod:2371
27332 #: ../fish/guestfish-actions.pod:2378
27338 #: ../fish/guestfish-actions.pod:2380
27347 #: ../fish/guestfish-actions.pod:2385
27353 #: ../fish/guestfish-actions.pod:2387
27362 #: ../fish/guestfish-actions.pod:2394
27368 #: ../fish/guestfish-actions.pod:2396
27371 " is-socket path\n"
27377 #: ../fish/guestfish-actions.pod:2403
27383 #: ../fish/guestfish-actions.pod:2405
27386 " is-symlink path\n"
27392 #: ../fish/guestfish-actions.pod:2412
27393 msgid "kill-subprocess"
27398 #: ../fish/guestfish-actions.pod:2414
27401 " kill-subprocess\n"
27407 #: ../fish/guestfish-actions.pod:2418
27413 #: ../fish/guestfish-actions.pod:2420
27419 #: ../fish/guestfish-actions.pod:2422
27428 #: ../fish/guestfish-actions.pod:2430
27434 #: ../fish/guestfish-actions.pod:2432
27437 " lchown owner group path\n"
27443 #: ../fish/guestfish-actions.pod:2434
27445 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27446 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27452 #: ../fish/guestfish-actions.pod:2442
27458 #: ../fish/guestfish-actions.pod:2444
27461 " lgetxattr path name\n"
27467 #: ../fish/guestfish-actions.pod:2460
27468 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27473 #: ../fish/guestfish-actions.pod:2462
27479 #: ../fish/guestfish-actions.pod:2464
27482 " lgetxattrs path\n"
27488 #: ../fish/guestfish-actions.pod:2466
27490 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27491 "it returns the extended attributes of the link itself."
27496 #: ../fish/guestfish-actions.pod:2470
27497 msgid "list-devices"
27502 #: ../fish/guestfish-actions.pod:2472
27511 #: ../fish/guestfish-actions.pod:2480
27512 msgid "list-filesystems"
27517 #: ../fish/guestfish-actions.pod:2482
27520 " list-filesystems\n"
27526 #: ../fish/guestfish-actions.pod:2501
27528 "This command runs other libguestfs commands, which might include L</mount> "
27529 "and L</umount>, and therefore you should use this soon after launch and only "
27530 "when nothing is mounted."
27535 #: ../fish/guestfish-actions.pod:2505
27537 "Not all of the filesystems returned will be mountable. In particular, swap "
27538 "partitions are returned in the list. Also this command does not check that "
27539 "each filesystem found is valid and mountable, and some filesystems might be "
27540 "mountable but require special options. Filesystems may not all belong to a "
27541 "single logical operating system (use L</inspect-os> to look for OSes)."
27546 #: ../fish/guestfish-actions.pod:2513
27547 msgid "list-partitions"
27552 #: ../fish/guestfish-actions.pod:2515
27555 " list-partitions\n"
27561 #: ../fish/guestfish-actions.pod:2521
27563 "This does not return logical volumes. For that you will need to call L</"
27569 #: ../fish/guestfish-actions.pod:2526
27575 #: ../fish/guestfish-actions.pod:2528
27584 #: ../fish/guestfish-actions.pod:2536
27590 #: ../fish/guestfish-actions.pod:2538
27593 " ln target linkname\n"
27599 #: ../fish/guestfish-actions.pod:2542
27605 #: ../fish/guestfish-actions.pod:2544
27608 " ln-f target linkname\n"
27614 #: ../fish/guestfish-actions.pod:2549
27620 #: ../fish/guestfish-actions.pod:2551
27623 " ln-s target linkname\n"
27629 #: ../fish/guestfish-actions.pod:2555
27635 #: ../fish/guestfish-actions.pod:2557
27638 " ln-sf target linkname\n"
27644 #: ../fish/guestfish-actions.pod:2562
27645 msgid "lremovexattr"
27650 #: ../fish/guestfish-actions.pod:2564
27653 " lremovexattr xattr path\n"
27659 #: ../fish/guestfish-actions.pod:2566
27661 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27662 "it removes an extended attribute of the link itself."
27667 #: ../fish/guestfish-actions.pod:2570
27673 #: ../fish/guestfish-actions.pod:2572
27682 #: ../fish/guestfish-actions.pod:2578
27684 "This command is mostly useful for interactive sessions. Programs should "
27685 "probably use L</readdir> instead."
27690 #: ../fish/guestfish-actions.pod:2581
27696 #: ../fish/guestfish-actions.pod:2583
27699 " lsetxattr xattr val vallen path\n"
27705 #: ../fish/guestfish-actions.pod:2585
27707 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27708 "sets an extended attribute of the link itself."
27713 #: ../fish/guestfish-actions.pod:2589
27719 #: ../fish/guestfish-actions.pod:2591
27728 #: ../fish/guestfish-actions.pod:2595
27730 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27731 "the link is stat-ed, not the file it refers to."
27736 #: ../fish/guestfish-actions.pod:2601
27742 #: ../fish/guestfish-actions.pod:2603
27745 " lstatlist path 'names ...'\n"
27751 #: ../fish/guestfish-actions.pod:2605
27753 "This call allows you to perform the L</lstat> operation on multiple files, "
27754 "where all files are in the directory C<path>. C<names> is the list of files "
27755 "from this directory."
27760 #: ../fish/guestfish-actions.pod:2614
27762 "This call is intended for programs that want to efficiently list a directory "
27763 "contents without making many round-trips. See also L</lxattrlist> for a "
27764 "similarly efficient call for getting extended attributes. Very long "
27765 "directory listings might cause the protocol message size to be exceeded, "
27766 "causing this call to fail. The caller must split up such requests into "
27767 "smaller groups of names."
27772 #: ../fish/guestfish-actions.pod:2622
27773 msgid "luks-add-key"
27778 #: ../fish/guestfish-actions.pod:2624
27781 " luks-add-key device keyslot\n"
27787 #: ../fish/guestfish-actions.pod:2631
27789 "Note that if C<keyslot> already contains a key, then this command will "
27790 "fail. You have to use L</luks-kill-slot> first to remove that key."
27795 #: ../fish/guestfish-actions.pod:2635 ../fish/guestfish-actions.pod:2657
27796 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:2684
27797 #: ../fish/guestfish-actions.pod:2707 ../fish/guestfish-actions.pod:2717
27799 "This command has one or more key or passphrase parameters. Guestfish will "
27800 "prompt for these separately."
27805 #: ../fish/guestfish-actions.pod:2638
27811 #: ../fish/guestfish-actions.pod:2640
27814 " luks-close device\n"
27820 #: ../fish/guestfish-actions.pod:2642
27822 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27823 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27824 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27830 #: ../fish/guestfish-actions.pod:2648
27831 msgid "luks-format"
27836 #: ../fish/guestfish-actions.pod:2650
27839 " luks-format device keyslot\n"
27845 #: ../fish/guestfish-actions.pod:2663
27846 msgid "luks-format-cipher"
27851 #: ../fish/guestfish-actions.pod:2665
27854 " luks-format-cipher device keyslot cipher\n"
27860 #: ../fish/guestfish-actions.pod:2667
27862 "This command is the same as L</luks-format> but it also allows you to set "
27863 "the C<cipher> used."
27868 #: ../fish/guestfish-actions.pod:2676
27869 msgid "luks-kill-slot"
27874 #: ../fish/guestfish-actions.pod:2678
27877 " luks-kill-slot device keyslot\n"
27883 #: ../fish/guestfish-actions.pod:2687
27889 #: ../fish/guestfish-actions.pod:2689
27892 " luks-open device mapname\n"
27898 #: ../fish/guestfish-actions.pod:2703
27900 "If this block device contains LVM volume groups, then calling L</vgscan> "
27901 "followed by L</vg-activate-all> will make them visible."
27906 #: ../fish/guestfish-actions.pod:2710
27907 msgid "luks-open-ro"
27912 #: ../fish/guestfish-actions.pod:2712
27915 " luks-open-ro device mapname\n"
27921 #: ../fish/guestfish-actions.pod:2714
27923 "This is the same as L</luks-open> except that a read-only mapping is created."
27928 #: ../fish/guestfish-actions.pod:2720
27934 #: ../fish/guestfish-actions.pod:2722
27937 " lvcreate logvol volgroup mbytes\n"
27943 #: ../fish/guestfish-actions.pod:2727
27944 msgid "lvm-canonical-lv-name"
27949 #: ../fish/guestfish-actions.pod:2729
27952 " lvm-canonical-lv-name lvname\n"
27958 #: ../fish/guestfish-actions.pod:2738
27959 msgid "See also L</is-lv>."
27964 #: ../fish/guestfish-actions.pod:2740
27965 msgid "lvm-clear-filter"
27970 #: ../fish/guestfish-actions.pod:2742
27973 " lvm-clear-filter\n"
27979 #: ../fish/guestfish-actions.pod:2744
27981 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27987 #: ../fish/guestfish-actions.pod:2750
27988 msgid "lvm-remove-all"
27993 #: ../fish/guestfish-actions.pod:2752
27996 " lvm-remove-all\n"
28002 #: ../fish/guestfish-actions.pod:2760
28003 msgid "lvm-set-filter"
28008 #: ../fish/guestfish-actions.pod:2762
28011 " lvm-set-filter 'devices ...'\n"
28017 #: ../fish/guestfish-actions.pod:2787
28023 #: ../fish/guestfish-actions.pod:2789
28026 " lvremove device\n"
28032 #: ../fish/guestfish-actions.pod:2797
28038 #: ../fish/guestfish-actions.pod:2799
28041 " lvrename logvol newlogvol\n"
28047 #: ../fish/guestfish-actions.pod:2803
28053 #: ../fish/guestfish-actions.pod:2805
28056 " lvresize device mbytes\n"
28062 #: ../fish/guestfish-actions.pod:2811
28063 msgid "lvresize-free"
28068 #: ../fish/guestfish-actions.pod:2813
28071 " lvresize-free lv percent\n"
28077 #: ../fish/guestfish-actions.pod:2821
28083 #: ../fish/guestfish-actions.pod:2823
28092 #: ../fish/guestfish-actions.pod:2831
28093 msgid "See also L</lvs-full>, L</list-filesystems>."
28098 #: ../fish/guestfish-actions.pod:2833
28104 #: ../fish/guestfish-actions.pod:2835
28113 #: ../fish/guestfish-actions.pod:2840
28119 #: ../fish/guestfish-actions.pod:2842
28128 #: ../fish/guestfish-actions.pod:2846
28134 #: ../fish/guestfish-actions.pod:2848
28137 " lxattrlist path 'names ...'\n"
28143 #: ../fish/guestfish-actions.pod:2864
28145 "This call is intended for programs that want to efficiently list a directory "
28146 "contents without making many round-trips. See also L</lstatlist> for a "
28147 "similarly efficient call for getting standard stats. Very long directory "
28148 "listings might cause the protocol message size to be exceeded, causing this "
28149 "call to fail. The caller must split up such requests into smaller groups of "
28155 #: ../fish/guestfish-actions.pod:2872
28161 #: ../fish/guestfish-actions.pod:2874
28170 #: ../fish/guestfish-actions.pod:2878
28176 #: ../fish/guestfish-actions.pod:2880
28179 " mkdir-mode path mode\n"
28185 #: ../fish/guestfish-actions.pod:2889
28186 msgid "See also L</mkdir>, L</umask>"
28191 #: ../fish/guestfish-actions.pod:2891
28197 #: ../fish/guestfish-actions.pod:2893
28206 #: ../fish/guestfish-actions.pod:2898
28212 #: ../fish/guestfish-actions.pod:2900
28215 " mkdtemp template\n"
28221 #: ../fish/guestfish-actions.pod:2921
28227 #: ../fish/guestfish-actions.pod:2923
28230 " mke2fs-J fstype blocksize device journal\n"
28236 #: ../fish/guestfish-actions.pod:2931
28237 msgid "See also L</mke2journal>."
28242 #: ../fish/guestfish-actions.pod:2933
28248 #: ../fish/guestfish-actions.pod:2935
28251 " mke2fs-JL fstype blocksize device label\n"
28257 #: ../fish/guestfish-actions.pod:2940
28258 msgid "See also L</mke2journal-L>."
28263 #: ../fish/guestfish-actions.pod:2942
28269 #: ../fish/guestfish-actions.pod:2944
28272 " mke2fs-JU fstype blocksize device uuid\n"
28278 #: ../fish/guestfish-actions.pod:2949
28279 msgid "See also L</mke2journal-U>."
28284 #: ../fish/guestfish-actions.pod:2951
28285 msgid "mke2journal"
28290 #: ../fish/guestfish-actions.pod:2953
28293 " mke2journal blocksize device\n"
28299 #: ../fish/guestfish-actions.pod:2960
28300 msgid "mke2journal-L"
28305 #: ../fish/guestfish-actions.pod:2962
28308 " mke2journal-L blocksize label device\n"
28314 #: ../fish/guestfish-actions.pod:2966
28315 msgid "mke2journal-U"
28320 #: ../fish/guestfish-actions.pod:2968
28323 " mke2journal-U blocksize uuid device\n"
28329 #: ../fish/guestfish-actions.pod:2972
28335 #: ../fish/guestfish-actions.pod:2974
28338 " mkfifo mode path\n"
28344 #: ../fish/guestfish-actions.pod:2976
28346 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28347 "is just a convenient wrapper around L</mknod>."
28352 #: ../fish/guestfish-actions.pod:2982
28358 #: ../fish/guestfish-actions.pod:2984
28361 " mkfs fstype device\n"
28367 #: ../fish/guestfish-actions.pod:2990
28373 #: ../fish/guestfish-actions.pod:2992
28376 " mkfs-b fstype blocksize device\n"
28382 #: ../fish/guestfish-actions.pod:2994
28384 "This call is similar to L</mkfs>, but it allows you to control the block "
28385 "size of the resulting filesystem. Supported block sizes depend on the "
28386 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28391 #: ../fish/guestfish-actions.pod:3009
28396 #: ../fish/guestfish-actions.pod:3011
28399 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28405 #: ../fish/guestfish-actions.pod:3046
28406 msgid "mkmountpoint"
28411 #: ../fish/guestfish-actions.pod:3048
28414 " mkmountpoint exemptpath\n"
28420 #: ../fish/guestfish-actions.pod:3050
28422 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28423 "to create extra mountpoints before mounting the first filesystem."
28428 #: ../fish/guestfish-actions.pod:3074
28430 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28431 "unexpected errors if you try to mix these calls. It is safest to manually "
28432 "unmount filesystems and remove mountpoints after use."
28437 #: ../fish/guestfish-actions.pod:3078
28439 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28440 "for this to work for manual mountpoints, you must ensure that the innermost "
28441 "mountpoints have the longest pathnames, as in the example code above."
28445 #: ../fish/guestfish-actions.pod:3085
28447 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28448 "L</umount-all> to be called when the handle is closed which can also trigger "
28454 #: ../fish/guestfish-actions.pod:3089
28460 #: ../fish/guestfish-actions.pod:3091
28463 " mknod mode devmajor devminor path\n"
28469 #: ../fish/guestfish-actions.pod:3101
28471 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28472 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28473 "regular file). These constants are available in the standard Linux header "
28474 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28475 "wrappers around this command which bitwise OR in the appropriate constant "
28481 #: ../fish/guestfish-actions.pod:3111
28487 #: ../fish/guestfish-actions.pod:3113
28490 " mknod-b mode devmajor devminor path\n"
28496 #: ../fish/guestfish-actions.pod:3115
28498 "This call creates a block device node called C<path> with mode C<mode> and "
28499 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28500 "wrapper around L</mknod>."
28505 #: ../fish/guestfish-actions.pod:3121
28511 #: ../fish/guestfish-actions.pod:3123
28514 " mknod-c mode devmajor devminor path\n"
28520 #: ../fish/guestfish-actions.pod:3125
28522 "This call creates a char device node called C<path> with mode C<mode> and "
28523 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28524 "wrapper around L</mknod>."
28529 #: ../fish/guestfish-actions.pod:3131
28535 #: ../fish/guestfish-actions.pod:3133
28544 #: ../fish/guestfish-actions.pod:3137
28550 #: ../fish/guestfish-actions.pod:3139
28553 " mkswap-L label device\n"
28559 #: ../fish/guestfish-actions.pod:3147
28565 #: ../fish/guestfish-actions.pod:3149
28568 " mkswap-U uuid device\n"
28574 #: ../fish/guestfish-actions.pod:3153
28575 msgid "mkswap-file"
28580 #: ../fish/guestfish-actions.pod:3155
28583 " mkswap-file path\n"
28589 #: ../fish/guestfish-actions.pod:3159
28591 "This command just writes a swap file signature to an existing file. To "
28592 "create the file itself, use something like L</fallocate>."
28597 #: ../fish/guestfish-actions.pod:3162
28603 #: ../fish/guestfish-actions.pod:3164
28606 " modprobe modulename\n"
28612 #: ../fish/guestfish-actions.pod:3171
28618 #: ../fish/guestfish-actions.pod:3173
28621 " mount device mountpoint\n"
28627 #: ../fish/guestfish-actions.pod:3189
28629 "B<Important note:> When you use this call, the filesystem options C<sync> "
28630 "and C<noatime> are set implicitly. This was originally done because we "
28631 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28632 "very large negative performance impact and negligible effect on "
28633 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28634 "code that needs performance, and instead use L</mount-options> (use an empty "
28635 "string for the first parameter if you don't want any options)."
28640 #: ../fish/guestfish-actions.pod:3206
28646 #: ../fish/guestfish-actions.pod:3208
28649 " mount-loop file mountpoint\n"
28655 #: ../fish/guestfish-actions.pod:3214
28656 msgid "mount-options"
28661 #: ../fish/guestfish-actions.pod:3216
28664 " mount-options options device mountpoint\n"
28670 #: ../fish/guestfish-actions.pod:3218
28672 "This is the same as the L</mount> command, but it allows you to set the "
28673 "mount options as for the L<mount(8)> I<-o> flag."
28678 #: ../fish/guestfish-actions.pod:3226
28684 #: ../fish/guestfish-actions.pod:3228
28687 " mount-ro device mountpoint\n"
28693 #: ../fish/guestfish-actions.pod:3230
28695 "This is the same as the L</mount> command, but it mounts the filesystem with "
28696 "the read-only (I<-o ro>) flag."
28701 #: ../fish/guestfish-actions.pod:3233
28707 #: ../fish/guestfish-actions.pod:3235
28710 " mount-vfs options vfstype device mountpoint\n"
28716 #: ../fish/guestfish-actions.pod:3237
28718 "This is the same as the L</mount> command, but it allows you to set both the "
28719 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28724 #: ../fish/guestfish-actions.pod:3241
28725 msgid "mountpoints"
28730 #: ../fish/guestfish-actions.pod:3243
28739 #: ../fish/guestfish-actions.pod:3245
28741 "This call is similar to L</mounts>. That call returns a list of devices. "
28742 "This one returns a hash table (map) of device name to directory where the "
28743 "device is mounted."
28748 #: ../fish/guestfish-actions.pod:3249
28754 #: ../fish/guestfish-actions.pod:3251
28763 #: ../fish/guestfish-actions.pod:3258
28764 msgid "See also: L</mountpoints>"
28769 #: ../fish/guestfish-actions.pod:3260
28775 #: ../fish/guestfish-actions.pod:3262
28784 #: ../fish/guestfish-actions.pod:3267
28785 msgid "ntfs-3g-probe"
28790 #: ../fish/guestfish-actions.pod:3269
28793 " ntfs-3g-probe true|false device\n"
28799 #: ../fish/guestfish-actions.pod:3283
28805 #: ../fish/guestfish-actions.pod:3285
28808 " ntfsresize device\n"
28814 #: ../fish/guestfish-actions.pod:3300
28815 msgid "ntfsresize-size"
28820 #: ../fish/guestfish-actions.pod:3302
28823 " ntfsresize-size device size\n"
28829 #: ../fish/guestfish-actions.pod:3304
28831 "This command is the same as L</ntfsresize> except that it allows you to "
28832 "specify the new size (in bytes) explicitly."
28837 #: ../fish/guestfish-actions.pod:3307
28843 #: ../fish/guestfish-actions.pod:3309
28846 " part-add device prlogex startsect endsect\n"
28852 #: ../fish/guestfish-actions.pod:3311
28854 "This command adds a partition to C<device>. If there is no partition table "
28855 "on the device, call L</part-init> first."
28860 #: ../fish/guestfish-actions.pod:3323
28862 "Creating a partition which covers the whole disk is not so easy. Use L</"
28863 "part-disk> to do that."
28868 #: ../fish/guestfish-actions.pod:3326
28874 #: ../fish/guestfish-actions.pod:3328
28877 " part-del device partnum\n"
28883 #: ../fish/guestfish-actions.pod:3336
28889 #: ../fish/guestfish-actions.pod:3338
28892 " part-disk device parttype\n"
28898 #: ../fish/guestfish-actions.pod:3340
28900 "This command is simply a combination of L</part-init> followed by L</part-"
28901 "add> to create a single primary partition covering the whole disk."
28906 #: ../fish/guestfish-actions.pod:3344
28908 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28909 "possible values are described in L</part-init>."
28914 #: ../fish/guestfish-actions.pod:3350
28915 msgid "part-get-bootable"
28920 #: ../fish/guestfish-actions.pod:3352
28923 " part-get-bootable device partnum\n"
28929 #: ../fish/guestfish-actions.pod:3357
28930 msgid "See also L</part-set-bootable>."
28935 #: ../fish/guestfish-actions.pod:3359
28936 msgid "part-get-mbr-id"
28941 #: ../fish/guestfish-actions.pod:3361
28944 " part-get-mbr-id device partnum\n"
28950 #: ../fish/guestfish-actions.pod:3366 ../fish/guestfish-actions.pod:3504
28952 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28953 "undefined results for other partition table types (see L</part-get-"
28959 #: ../fish/guestfish-actions.pod:3370
28960 msgid "part-get-parttype"
28965 #: ../fish/guestfish-actions.pod:3372
28968 " part-get-parttype device\n"
28974 #: ../fish/guestfish-actions.pod:3377
28976 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28977 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28978 "possible, although unusual. See L</part-init> for a full list."
28983 #: ../fish/guestfish-actions.pod:3382
28989 #: ../fish/guestfish-actions.pod:3384
28992 " part-init device parttype\n"
28998 #: ../fish/guestfish-actions.pod:3390
29000 "Initially there are no partitions. Following this, you should call L</part-"
29001 "add> for each partition required."
29006 #: ../fish/guestfish-actions.pod:3453
29012 #: ../fish/guestfish-actions.pod:3455
29015 " part-list device\n"
29021 #: ../fish/guestfish-actions.pod:3470
29023 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29024 "the device's sector size, see L</blockdev-getss>."
29029 #: ../fish/guestfish-actions.pod:3483
29030 msgid "part-set-bootable"
29035 #: ../fish/guestfish-actions.pod:3485
29038 " part-set-bootable device partnum true|false\n"
29044 #: ../fish/guestfish-actions.pod:3494
29045 msgid "part-set-mbr-id"
29050 #: ../fish/guestfish-actions.pod:3496
29053 " part-set-mbr-id device partnum idbyte\n"
29059 #: ../fish/guestfish-actions.pod:3508
29060 msgid "part-set-name"
29065 #: ../fish/guestfish-actions.pod:3510
29068 " part-set-name device partnum name\n"
29074 #: ../fish/guestfish-actions.pod:3518
29075 msgid "part-to-dev"
29080 #: ../fish/guestfish-actions.pod:3520
29083 " part-to-dev partition\n"
29089 #: ../fish/guestfish-actions.pod:3526
29091 "The named partition must exist, for example as a string returned from L</"
29092 "list-partitions>."
29097 #: ../fish/guestfish-actions.pod:3529
29098 msgid "ping-daemon"
29103 #: ../fish/guestfish-actions.pod:3531
29112 #: ../fish/guestfish-actions.pod:3538
29118 #: ../fish/guestfish-actions.pod:3540
29121 " pread path count offset\n"
29127 #: ../fish/guestfish-actions.pod:3548
29128 msgid "See also L</pwrite>, L</pread-device>."
29133 #: ../fish/guestfish-actions.pod:3553
29134 msgid "pread-device"
29139 #: ../fish/guestfish-actions.pod:3555
29142 " pread-device device count offset\n"
29148 #: ../fish/guestfish-actions.pod:3563
29149 msgid "See also L</pread>."
29154 #: ../fish/guestfish-actions.pod:3568
29160 #: ../fish/guestfish-actions.pod:3570
29163 " pvcreate device\n"
29169 #: ../fish/guestfish-actions.pod:3576
29175 #: ../fish/guestfish-actions.pod:3578
29178 " pvremove device\n"
29184 #: ../fish/guestfish-actions.pod:3587
29190 #: ../fish/guestfish-actions.pod:3589
29193 " pvresize device\n"
29199 #: ../fish/guestfish-actions.pod:3594
29200 msgid "pvresize-size"
29205 #: ../fish/guestfish-actions.pod:3596
29208 " pvresize-size device size\n"
29214 #: ../fish/guestfish-actions.pod:3598
29216 "This command is the same as L</pvresize> except that it allows you to "
29217 "specify the new size (in bytes) explicitly."
29222 #: ../fish/guestfish-actions.pod:3601
29228 #: ../fish/guestfish-actions.pod:3603
29237 #: ../fish/guestfish-actions.pod:3611
29238 msgid "See also L</pvs-full>."
29243 #: ../fish/guestfish-actions.pod:3613
29249 #: ../fish/guestfish-actions.pod:3615
29258 #: ../fish/guestfish-actions.pod:3620
29264 #: ../fish/guestfish-actions.pod:3622
29273 #: ../fish/guestfish-actions.pod:3626
29279 #: ../fish/guestfish-actions.pod:3628
29282 " pwrite path content offset\n"
29288 #: ../fish/guestfish-actions.pod:3639
29289 msgid "See also L</pread>, L</pwrite-device>."
29294 #: ../fish/guestfish-actions.pod:3644
29295 msgid "pwrite-device"
29300 #: ../fish/guestfish-actions.pod:3646
29303 " pwrite-device device content offset\n"
29309 #: ../fish/guestfish-actions.pod:3656
29310 msgid "See also L</pwrite>."
29315 #: ../fish/guestfish-actions.pod:3661
29321 #: ../fish/guestfish-actions.pod:3663
29324 " read-file path\n"
29330 #: ../fish/guestfish-actions.pod:3668
29332 "Unlike L</cat>, this function can correctly handle files that contain "
29333 "embedded ASCII NUL characters. However unlike L</download>, this function "
29334 "is limited in the total size of file that can be handled."
29339 #: ../fish/guestfish-actions.pod:3676
29345 #: ../fish/guestfish-actions.pod:3678
29348 " read-lines path\n"
29354 #: ../fish/guestfish-actions.pod:3685
29356 "Note that this function cannot correctly handle binary files (specifically, "
29357 "files containing C<\\0> character which is treated as end of line). For "
29358 "those you need to use the L</read-file> function which has a more complex "
29364 #: ../fish/guestfish-actions.pod:3690
29370 #: ../fish/guestfish-actions.pod:3692
29379 #: ../fish/guestfish-actions.pod:3744
29381 "This function is primarily intended for use by programs. To get a simple "
29382 "list of names, use L</ls>. To get a printable directory for human "
29383 "consumption, use L</ll>."
29388 #: ../fish/guestfish-actions.pod:3748
29394 #: ../fish/guestfish-actions.pod:3750
29403 #: ../fish/guestfish-actions.pod:3754
29404 msgid "readlinklist"
29409 #: ../fish/guestfish-actions.pod:3756
29412 " readlinklist path 'names ...'\n"
29418 #: ../fish/guestfish-actions.pod:3780
29424 #: ../fish/guestfish-actions.pod:3782
29433 #: ../fish/guestfish-actions.pod:3787
29434 msgid "removexattr"
29439 #: ../fish/guestfish-actions.pod:3789
29442 " removexattr xattr path\n"
29448 #: ../fish/guestfish-actions.pod:3794
29449 msgid "See also: L</lremovexattr>, L<attr(5)>."
29454 #: ../fish/guestfish-actions.pod:3796
29460 #: ../fish/guestfish-actions.pod:3798
29463 " resize2fs device\n"
29469 #: ../fish/guestfish-actions.pod:3803
29471 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29472 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29473 "gives an error about this and sometimes not. In any case, it is always safe "
29474 "to call L</e2fsck-f> before calling this function."
29478 #: ../fish/guestfish-actions.pod:3809
29479 msgid "resize2fs-M"
29483 #: ../fish/guestfish-actions.pod:3811
29486 " resize2fs-M device\n"
29491 #: ../fish/guestfish-actions.pod:3813
29493 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29494 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29499 #: ../fish/guestfish-actions.pod:3817
29501 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29502 "and read the C<Block size> and C<Block count> values. These two numbers, "
29503 "multiplied together, give the resulting size of the minimal filesystem in "
29509 #: ../fish/guestfish-actions.pod:3822
29510 msgid "resize2fs-size"
29515 #: ../fish/guestfish-actions.pod:3824
29518 " resize2fs-size device size\n"
29524 #: ../fish/guestfish-actions.pod:3826
29526 "This command is the same as L</resize2fs> except that it allows you to "
29527 "specify the new size (in bytes) explicitly."
29532 #: ../fish/guestfish-actions.pod:3829
29538 #: ../fish/guestfish-actions.pod:3831
29547 #: ../fish/guestfish-actions.pod:3835
29553 #: ../fish/guestfish-actions.pod:3837
29562 #: ../fish/guestfish-actions.pod:3843
29568 #: ../fish/guestfish-actions.pod:3845
29577 #: ../fish/guestfish-actions.pod:3849
29578 msgid "rmmountpoint"
29583 #: ../fish/guestfish-actions.pod:3851
29586 " rmmountpoint exemptpath\n"
29592 #: ../fish/guestfish-actions.pod:3853
29594 "This calls removes a mountpoint that was previously created with L</"
29595 "mkmountpoint>. See L</mkmountpoint> for full details."
29600 #: ../fish/guestfish-actions.pod:3857
29601 msgid "scrub-device"
29606 #: ../fish/guestfish-actions.pod:3859
29609 " scrub-device device\n"
29615 #: ../fish/guestfish-actions.pod:3870
29621 #: ../fish/guestfish-actions.pod:3872
29624 " scrub-file file\n"
29630 #: ../fish/guestfish-actions.pod:3882
29631 msgid "scrub-freespace"
29636 #: ../fish/guestfish-actions.pod:3884
29639 " scrub-freespace dir\n"
29645 #: ../fish/guestfish-actions.pod:3886
29647 "This command creates the directory C<dir> and then fills it with files until "
29648 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29649 "deletes them. The intention is to scrub any free space on the partition "
29650 "containing C<dir>."
29655 #: ../fish/guestfish-actions.pod:3895
29661 #: ../fish/guestfish-actions.pod:3897
29667 #: ../fish/guestfish-actions.pod:3899
29670 " set-append append\n"
29675 #: ../fish/guestfish-actions.pod:3910
29676 msgid "set-attach-method"
29680 #: ../fish/guestfish-actions.pod:3912
29681 msgid "attach-method"
29685 #: ../fish/guestfish-actions.pod:3914
29688 " set-attach-method attachmethod\n"
29694 #: ../fish/guestfish-actions.pod:3936
29695 msgid "set-autosync"
29700 #: ../fish/guestfish-actions.pod:3938
29706 #: ../fish/guestfish-actions.pod:3940
29709 " set-autosync true|false\n"
29715 #: ../fish/guestfish-actions.pod:3950
29721 #: ../fish/guestfish-actions.pod:3952
29727 #: ../fish/guestfish-actions.pod:3954
29730 " set-direct true|false\n"
29736 #: ../fish/guestfish-actions.pod:3960
29738 "One consequence of this is that log messages aren't caught by the library "
29739 "and handled by L</set-log-message-callback>, but go straight to stdout."
29744 #: ../fish/guestfish-actions.pod:3969
29745 msgid "set-e2label"
29750 #: ../fish/guestfish-actions.pod:3971
29753 " set-e2label device label\n"
29759 #: ../fish/guestfish-actions.pod:3977
29761 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29762 "label on a filesystem."
29767 #: ../fish/guestfish-actions.pod:3980
29773 #: ../fish/guestfish-actions.pod:3982
29776 " set-e2uuid device uuid\n"
29782 #: ../fish/guestfish-actions.pod:3989
29784 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29785 "UUID of a filesystem."
29790 #: ../fish/guestfish-actions.pod:3992
29791 msgid "set-memsize"
29796 #: ../fish/guestfish-actions.pod:3994
29802 #: ../fish/guestfish-actions.pod:3996
29805 " set-memsize memsize\n"
29811 #: ../fish/guestfish-actions.pod:3998
29813 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29814 "This only has any effect if called before L</launch>."
29819 #: ../fish/guestfish-actions.pod:4009
29820 msgid "set-network"
29825 #: ../fish/guestfish-actions.pod:4011
29831 #: ../fish/guestfish-actions.pod:4013
29834 " set-network true|false\n"
29840 #: ../fish/guestfish-actions.pod:4021
29842 "You must call this before calling L</launch>, otherwise it has no effect."
29847 #: ../fish/guestfish-actions.pod:4024
29853 #: ../fish/guestfish-actions.pod:4026
29859 #: ../fish/guestfish-actions.pod:4028
29862 " set-path searchpath\n"
29868 #: ../fish/guestfish-actions.pod:4037
29874 #: ../fish/guestfish-actions.pod:4039
29880 #: ../fish/guestfish-actions.pod:4041
29889 #: ../fish/guestfish-actions.pod:4061
29890 msgid "set-recovery-proc"
29895 #: ../fish/guestfish-actions.pod:4063
29896 msgid "recovery-proc"
29901 #: ../fish/guestfish-actions.pod:4065
29904 " set-recovery-proc true|false\n"
29910 #: ../fish/guestfish-actions.pod:4067
29912 "If this is called with the parameter C<false> then L</launch> does not "
29913 "create a recovery process. The purpose of the recovery process is to stop "
29914 "runaway qemu processes in the case where the main program aborts abruptly."
29919 #: ../fish/guestfish-actions.pod:4072
29921 "This only has any effect if called before L</launch>, and the default is "
29927 #: ../fish/guestfish-actions.pod:4081
29928 msgid "set-selinux"
29933 #: ../fish/guestfish-actions.pod:4083
29939 #: ../fish/guestfish-actions.pod:4085
29942 " set-selinux true|false\n"
29948 #: ../fish/guestfish-actions.pod:4096
29954 #: ../fish/guestfish-actions.pod:4098
29960 #: ../fish/guestfish-actions.pod:4100
29963 " set-trace true|false\n"
29968 #: ../fish/guestfish-actions.pod:4112
29970 "Trace messages are normally sent to C<stderr>, unless you register a "
29971 "callback to send them somewhere else (see L</set-event-callback>)."
29976 #: ../fish/guestfish-actions.pod:4116
29977 msgid "set-verbose"
29982 #: ../fish/guestfish-actions.pod:4118
29988 #: ../fish/guestfish-actions.pod:4120
29991 " set-verbose true|false\n"
29996 #: ../fish/guestfish-actions.pod:4127
29998 "Verbose messages are normally sent to C<stderr>, unless you register a "
29999 "callback to send them somewhere else (see L</set-event-callback>)."
30004 #: ../fish/guestfish-actions.pod:4131
30010 #: ../fish/guestfish-actions.pod:4133
30013 " setcon context\n"
30019 #: ../fish/guestfish-actions.pod:4140
30025 #: ../fish/guestfish-actions.pod:4142
30028 " setxattr xattr val vallen path\n"
30034 #: ../fish/guestfish-actions.pod:4148
30035 msgid "See also: L</lsetxattr>, L<attr(5)>."
30040 #: ../fish/guestfish-actions.pod:4150
30046 #: ../fish/guestfish-actions.pod:4152
30049 " sfdisk device cyls heads sectors 'lines ...'\n"
30055 #: ../fish/guestfish-actions.pod:4174
30056 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30061 #: ../fish/guestfish-actions.pod:4187
30067 #: ../fish/guestfish-actions.pod:4189
30070 " sfdiskM device 'lines ...'\n"
30076 #: ../fish/guestfish-actions.pod:4191
30078 "This is a simplified interface to the L</sfdisk> command, where partition "
30079 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30080 "you don't need to specify the cyls, heads and sectors parameters which were "
30081 "rarely if ever used anyway."
30086 #: ../fish/guestfish-actions.pod:4197
30087 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30092 #: ../fish/guestfish-actions.pod:4210
30098 #: ../fish/guestfish-actions.pod:4212
30101 " sfdisk-N device partnum cyls heads sectors line\n"
30107 #: ../fish/guestfish-actions.pod:4217
30109 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30110 "cyls/heads/sectors parameters."
30115 #: ../fish/guestfish-actions.pod:4220
30116 msgid "See also: L</part-add>"
30121 #: ../fish/guestfish-actions.pod:4232
30122 msgid "sfdisk-disk-geometry"
30127 #: ../fish/guestfish-actions.pod:4234
30130 " sfdisk-disk-geometry device\n"
30136 #: ../fish/guestfish-actions.pod:4236
30138 "This displays the disk geometry of C<device> read from the partition table. "
30139 "Especially in the case where the underlying block device has been resized, "
30140 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30141 "kernel-geometry>)."
30146 #: ../fish/guestfish-actions.pod:4244
30147 msgid "sfdisk-kernel-geometry"
30152 #: ../fish/guestfish-actions.pod:4246
30155 " sfdisk-kernel-geometry device\n"
30161 #: ../fish/guestfish-actions.pod:4253
30167 #: ../fish/guestfish-actions.pod:4255
30170 " sfdisk-l device\n"
30176 #: ../fish/guestfish-actions.pod:4261
30177 msgid "See also: L</part-list>"
30182 #: ../fish/guestfish-actions.pod:4270
30188 #: ../fish/guestfish-actions.pod:4272
30197 #: ../fish/guestfish-actions.pod:4277
30198 msgid "This is like L</command>, but passes the command to:"
30203 #: ../fish/guestfish-actions.pod:4285
30204 msgid "All the provisos about L</command> apply to this call."
30209 #: ../fish/guestfish-actions.pod:4287
30215 #: ../fish/guestfish-actions.pod:4289
30218 " sh-lines command\n"
30224 #: ../fish/guestfish-actions.pod:4291
30225 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30230 #: ../fish/guestfish-actions.pod:4294
30231 msgid "See also: L</command-lines>"
30236 #: ../fish/guestfish-actions.pod:4296
30242 #: ../fish/guestfish-actions.pod:4298
30251 #: ../fish/guestfish-actions.pod:4302
30257 #: ../fish/guestfish-actions.pod:4304
30266 #: ../fish/guestfish-actions.pod:4310
30272 #: ../fish/guestfish-actions.pod:4312
30281 #: ../fish/guestfish-actions.pod:4320
30287 #: ../fish/guestfish-actions.pod:4322
30296 #: ../fish/guestfish-actions.pod:4330
30302 #: ../fish/guestfish-actions.pod:4332
30305 " strings-e encoding path\n"
30311 #: ../fish/guestfish-actions.pod:4334
30313 "This is like the L</strings> command, but allows you to specify the encoding "
30314 "of strings that are looked for in the source file C<path>."
30319 #: ../fish/guestfish-actions.pod:4344
30321 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30322 "ISO-8859-X (this is what L</strings> uses)."
30327 #: ../fish/guestfish-actions.pod:4376
30328 msgid "swapoff-device"
30333 #: ../fish/guestfish-actions.pod:4378
30336 " swapoff-device device\n"
30342 #: ../fish/guestfish-actions.pod:4380
30344 "This command disables the libguestfs appliance swap device or partition "
30345 "named C<device>. See L</swapon-device>."
30350 #: ../fish/guestfish-actions.pod:4384
30351 msgid "swapoff-file"
30356 #: ../fish/guestfish-actions.pod:4386
30359 " swapoff-file file\n"
30365 #: ../fish/guestfish-actions.pod:4390
30366 msgid "swapoff-label"
30371 #: ../fish/guestfish-actions.pod:4392
30374 " swapoff-label label\n"
30380 #: ../fish/guestfish-actions.pod:4397
30381 msgid "swapoff-uuid"
30386 #: ../fish/guestfish-actions.pod:4399
30389 " swapoff-uuid uuid\n"
30395 #: ../fish/guestfish-actions.pod:4404
30396 msgid "swapon-device"
30401 #: ../fish/guestfish-actions.pod:4406
30404 " swapon-device device\n"
30410 #: ../fish/guestfish-actions.pod:4408
30412 "This command enables the libguestfs appliance to use the swap device or "
30413 "partition named C<device>. The increased memory is made available for all "
30414 "commands, for example those run using L</command> or L</sh>."
30419 #: ../fish/guestfish-actions.pod:4420
30420 msgid "swapon-file"
30425 #: ../fish/guestfish-actions.pod:4422
30428 " swapon-file file\n"
30434 #: ../fish/guestfish-actions.pod:4424
30436 "This command enables swap to a file. See L</swapon-device> for other notes."
30441 #: ../fish/guestfish-actions.pod:4427
30442 msgid "swapon-label"
30447 #: ../fish/guestfish-actions.pod:4429
30450 " swapon-label label\n"
30456 #: ../fish/guestfish-actions.pod:4431
30458 "This command enables swap to a labeled swap partition. See L</swapon-"
30459 "device> for other notes."
30464 #: ../fish/guestfish-actions.pod:4434
30465 msgid "swapon-uuid"
30470 #: ../fish/guestfish-actions.pod:4436
30473 " swapon-uuid uuid\n"
30479 #: ../fish/guestfish-actions.pod:4438
30481 "This command enables swap to a swap partition with the given UUID. See L</"
30482 "swapon-device> for other notes."
30487 #: ../fish/guestfish-actions.pod:4441
30493 #: ../fish/guestfish-actions.pod:4443
30502 #: ../fish/guestfish-actions.pod:4451
30508 #: ../fish/guestfish-actions.pod:4453
30517 #: ../fish/guestfish-actions.pod:4461
30523 #: ../fish/guestfish-actions.pod:4463
30526 " tail-n nrlines path\n"
30532 #: ../fish/guestfish-actions.pod:4476
30538 #: ../fish/guestfish-actions.pod:4478
30541 " tar-in (tarfile|-) directory\n"
30547 #: ../fish/guestfish-actions.pod:4483
30548 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30553 #: ../fish/guestfish-actions.pod:4488
30559 #: ../fish/guestfish-actions.pod:4490
30562 " tar-out directory (tarfile|-)\n"
30568 #: ../fish/guestfish-actions.pod:4495
30569 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30574 #: ../fish/guestfish-actions.pod:4500
30580 #: ../fish/guestfish-actions.pod:4502
30583 " tgz-in (tarball|-) directory\n"
30589 #: ../fish/guestfish-actions.pod:4507
30590 msgid "To upload an uncompressed tarball, use L</tar-in>."
30595 #: ../fish/guestfish-actions.pod:4511
30601 #: ../fish/guestfish-actions.pod:4513
30604 " tgz-out directory (tarball|-)\n"
30610 #: ../fish/guestfish-actions.pod:4518
30611 msgid "To download an uncompressed tarball, use L</tar-out>."
30616 #: ../fish/guestfish-actions.pod:4522
30622 #: ../fish/guestfish-actions.pod:4524
30631 #: ../fish/guestfish-actions.pod:4533
30637 #: ../fish/guestfish-actions.pod:4535
30646 #: ../fish/guestfish-actions.pod:4540
30647 msgid "truncate-size"
30652 #: ../fish/guestfish-actions.pod:4542
30655 " truncate-size path size\n"
30661 #: ../fish/guestfish-actions.pod:4547
30663 "If the current file size is less than C<size> then the file is extended to "
30664 "the required size with zero bytes. This creates a sparse file (ie. disk "
30665 "blocks are not allocated for the file until you write to it). To create a "
30666 "non-sparse file of zeroes, use L</fallocate64> instead."
30671 #: ../fish/guestfish-actions.pod:4553
30677 #: ../fish/guestfish-actions.pod:4555
30680 " tune2fs-l device\n"
30686 #: ../fish/guestfish-actions.pod:4565
30692 #: ../fish/guestfish-actions.pod:4567
30695 " txz-in (tarball|-) directory\n"
30701 #: ../fish/guestfish-actions.pod:4574
30707 #: ../fish/guestfish-actions.pod:4576
30710 " txz-out directory (tarball|-)\n"
30716 #: ../fish/guestfish-actions.pod:4583
30722 #: ../fish/guestfish-actions.pod:4585
30731 #: ../fish/guestfish-actions.pod:4599
30732 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30737 #: ../fish/guestfish-actions.pod:4604
30743 #: ../fish/guestfish-actions.pod:4606
30749 #: ../fish/guestfish-actions.pod:4608
30752 " umount pathordevice\n"
30758 #: ../fish/guestfish-actions.pod:4614
30764 #: ../fish/guestfish-actions.pod:4616
30765 msgid "unmount-all"
30770 #: ../fish/guestfish-actions.pod:4618
30779 #: ../fish/guestfish-actions.pod:4624
30785 #: ../fish/guestfish-actions.pod:4626
30788 " upload (filename|-) remotefilename\n"
30794 #: ../fish/guestfish-actions.pod:4633
30795 msgid "See also L</download>."
30800 #: ../fish/guestfish-actions.pod:4637
30801 msgid "upload-offset"
30806 #: ../fish/guestfish-actions.pod:4639
30809 " upload-offset (filename|-) remotefilename offset\n"
30815 #: ../fish/guestfish-actions.pod:4651
30817 "Note that there is no limit on the amount of data that can be uploaded with "
30818 "this call, unlike with L</pwrite>, and this call always writes the full "
30819 "amount unless an error occurs."
30824 #: ../fish/guestfish-actions.pod:4656
30825 msgid "See also L</upload>, L</pwrite>."
30830 #: ../fish/guestfish-actions.pod:4660
30836 #: ../fish/guestfish-actions.pod:4662
30839 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30845 #: ../fish/guestfish-actions.pod:4681
30851 #: ../fish/guestfish-actions.pod:4683
30860 #: ../fish/guestfish-actions.pod:4710
30862 "I<Note:> Don't use this call to test for availability of features. In "
30863 "enterprise distributions we backport features from later versions into "
30864 "earlier versions, making this an unreliable way to test for features. Use "
30865 "L</available> instead."
30870 #: ../fish/guestfish-actions.pod:4716
30876 #: ../fish/guestfish-actions.pod:4718
30879 " vfs-label device\n"
30885 #: ../fish/guestfish-actions.pod:4725
30886 msgid "To find a filesystem from the label, use L</findfs-label>."
30891 #: ../fish/guestfish-actions.pod:4727
30897 #: ../fish/guestfish-actions.pod:4729
30900 " vfs-type device\n"
30906 #: ../fish/guestfish-actions.pod:4739
30912 #: ../fish/guestfish-actions.pod:4741
30915 " vfs-uuid device\n"
30921 #: ../fish/guestfish-actions.pod:4748
30922 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30927 #: ../fish/guestfish-actions.pod:4750
30928 msgid "vg-activate"
30933 #: ../fish/guestfish-actions.pod:4752
30936 " vg-activate true|false 'volgroups ...'\n"
30942 #: ../fish/guestfish-actions.pod:4765
30943 msgid "vg-activate-all"
30948 #: ../fish/guestfish-actions.pod:4767
30951 " vg-activate-all true|false\n"
30957 #: ../fish/guestfish-actions.pod:4777
30963 #: ../fish/guestfish-actions.pod:4779
30966 " vgcreate volgroup 'physvols ...'\n"
30972 #: ../fish/guestfish-actions.pod:4784
30978 #: ../fish/guestfish-actions.pod:4786
30981 " vglvuuids vgname\n"
30987 #: ../fish/guestfish-actions.pod:4791
30989 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30990 "logical volumes and volume groups."
30995 #: ../fish/guestfish-actions.pod:4794
30996 msgid "See also L</vgpvuuids>."
31001 #: ../fish/guestfish-actions.pod:4796
31007 #: ../fish/guestfish-actions.pod:4798
31010 " vgpvuuids vgname\n"
31016 #: ../fish/guestfish-actions.pod:4803
31018 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31019 "physical volumes and volume groups."
31024 #: ../fish/guestfish-actions.pod:4806
31025 msgid "See also L</vglvuuids>."
31030 #: ../fish/guestfish-actions.pod:4808
31036 #: ../fish/guestfish-actions.pod:4810
31039 " vgremove vgname\n"
31045 #: ../fish/guestfish-actions.pod:4817
31051 #: ../fish/guestfish-actions.pod:4819
31054 " vgrename volgroup newvolgroup\n"
31060 #: ../fish/guestfish-actions.pod:4823
31066 #: ../fish/guestfish-actions.pod:4825
31075 #: ../fish/guestfish-actions.pod:4833
31076 msgid "See also L</vgs-full>."
31081 #: ../fish/guestfish-actions.pod:4835
31087 #: ../fish/guestfish-actions.pod:4837
31096 #: ../fish/guestfish-actions.pod:4842
31102 #: ../fish/guestfish-actions.pod:4844
31111 #: ../fish/guestfish-actions.pod:4849
31117 #: ../fish/guestfish-actions.pod:4851
31126 #: ../fish/guestfish-actions.pod:4855
31132 #: ../fish/guestfish-actions.pod:4857
31141 #: ../fish/guestfish-actions.pod:4862
31147 #: ../fish/guestfish-actions.pod:4864
31156 #: ../fish/guestfish-actions.pod:4869
31162 #: ../fish/guestfish-actions.pod:4871
31171 #: ../fish/guestfish-actions.pod:4876
31177 #: ../fish/guestfish-actions.pod:4878
31180 " write path content\n"
31186 #: ../fish/guestfish-actions.pod:4886
31192 #: ../fish/guestfish-actions.pod:4888
31195 " write-file path content size\n"
31201 #: ../fish/guestfish-actions.pod:4911
31207 #: ../fish/guestfish-actions.pod:4913
31210 " zegrep regex path\n"
31216 #: ../fish/guestfish-actions.pod:4921
31222 #: ../fish/guestfish-actions.pod:4923
31225 " zegrepi regex path\n"
31231 #: ../fish/guestfish-actions.pod:4931
31237 #: ../fish/guestfish-actions.pod:4933
31246 #: ../fish/guestfish-actions.pod:4941
31247 msgid "See also: L</zero-device>, L</scrub-device>."
31252 #: ../fish/guestfish-actions.pod:4943
31253 msgid "zero-device"
31258 #: ../fish/guestfish-actions.pod:4945
31261 " zero-device device\n"
31267 #: ../fish/guestfish-actions.pod:4947
31269 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31270 "which just zeroes the first few blocks of a device."
31275 #: ../fish/guestfish-actions.pod:4954
31281 #: ../fish/guestfish-actions.pod:4956
31284 " zerofree device\n"
31290 #: ../fish/guestfish-actions.pod:4969
31296 #: ../fish/guestfish-actions.pod:4971
31299 " zfgrep pattern path\n"
31305 #: ../fish/guestfish-actions.pod:4979
31311 #: ../fish/guestfish-actions.pod:4981
31314 " zfgrepi pattern path\n"
31320 #: ../fish/guestfish-actions.pod:4989
31326 #: ../fish/guestfish-actions.pod:4991
31329 " zfile meth path\n"
31335 #: ../fish/guestfish-actions.pod:4998
31337 "Since 1.0.63, use L</file> instead which can now process compressed files."
31342 #: ../fish/guestfish-actions.pod:5008
31348 #: ../fish/guestfish-actions.pod:5010
31351 " zgrep regex path\n"
31357 #: ../fish/guestfish-actions.pod:5018
31363 #: ../fish/guestfish-actions.pod:5020
31366 " zgrepi regex path\n"
31372 #: ../fish/guestfish-commands.pod:1
31378 #: ../fish/guestfish-commands.pod:3
31384 #: ../fish/guestfish-commands.pod:5
31387 " alloc filename size\n"
31393 #: ../fish/guestfish-commands.pod:7
31395 "This creates an empty (zeroed) file of the given size, and then adds so it "
31396 "can be further examined."
31401 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31402 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31407 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31408 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31413 #: ../fish/guestfish-commands.pod:14
31415 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31416 "image, see L</PREPARED DISK IMAGES>."
31421 #: ../fish/guestfish-commands.pod:17
31427 #: ../fish/guestfish-commands.pod:19
31430 " copy-in local [local ...] /remotedir\n"
31436 #: ../fish/guestfish-commands.pod:21
31438 "C<copy-in> copies local files or directories recursively into the disk "
31439 "image, placing them in the directory called C</remotedir> (which must "
31440 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31441 "other commands as necessary."
31446 #: ../fish/guestfish-commands.pod:26
31448 "Multiple local files and directories can be specified, but the last "
31449 "parameter must always be a remote directory. Wildcards cannot be used."
31454 #: ../fish/guestfish-commands.pod:30
31460 #: ../fish/guestfish-commands.pod:32
31463 " copy-out remote [remote ...] localdir\n"
31469 #: ../fish/guestfish-commands.pod:34
31471 "C<copy-out> copies remote files or directories recursively out of the disk "
31472 "image, placing them on the host disk in a local directory called C<localdir> "
31473 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31474 "download>, L</tar-out> and other commands as necessary."
31479 #: ../fish/guestfish-commands.pod:40
31481 "Multiple remote files and directories can be specified, but the last "
31482 "parameter must always be a local directory. To download to the current "
31483 "directory, use C<.> as in:"
31488 #: ../fish/guestfish-commands.pod:44
31491 " copy-out /home .\n"
31497 #: ../fish/guestfish-commands.pod:46
31499 "Wildcards cannot be used in the ordinary command, but you can use them with "
31500 "the help of L</glob> like this:"
31505 #: ../fish/guestfish-commands.pod:49
31508 " glob copy-out /home/* .\n"
31514 #: ../fish/guestfish-commands.pod:51
31520 #: ../fish/guestfish-commands.pod:53
31523 " echo [params ...]\n"
31529 #: ../fish/guestfish-commands.pod:55
31530 msgid "This echos the parameters to the terminal."
31535 #: ../fish/guestfish-commands.pod:57
31541 #: ../fish/guestfish-commands.pod:59
31547 #: ../fish/guestfish-commands.pod:61
31553 #: ../fish/guestfish-commands.pod:63
31562 #: ../fish/guestfish-commands.pod:65
31564 "This is used to edit a file. It downloads the file, edits it locally using "
31565 "your editor, then uploads the result."
31570 #: ../fish/guestfish-commands.pod:68
31572 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31573 "or C<emacs> you will get those corresponding editors."
31578 #: ../fish/guestfish-commands.pod:72
31584 #: ../fish/guestfish-commands.pod:74
31587 " glob command args...\n"
31593 #: ../fish/guestfish-commands.pod:76
31595 "Expand wildcards in any paths in the args list, and run C<command> "
31596 "repeatedly on each matching path."
31601 #: ../fish/guestfish-commands.pod:79
31602 msgid "See L</WILDCARDS AND GLOBBING>."
31607 #: ../fish/guestfish-commands.pod:81
31613 #: ../fish/guestfish-commands.pod:83
31616 " hexedit <filename|device>\n"
31617 " hexedit <filename|device> <max>\n"
31618 " hexedit <filename|device> <start> <max>\n"
31624 #: ../fish/guestfish-commands.pod:87
31626 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31632 #: ../fish/guestfish-commands.pod:90
31634 "This command works by downloading potentially the whole file or device, "
31635 "editing it locally, then uploading it. If the file or device is large, you "
31636 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31637 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31638 "usual modifiers allowed such as C<1M> (1 megabyte)."
31643 #: ../fish/guestfish-commands.pod:97
31644 msgid "For example to edit the first few sectors of a disk you might do:"
31649 #: ../fish/guestfish-commands.pod:100
31652 " hexedit /dev/sda 1M\n"
31658 #: ../fish/guestfish-commands.pod:102
31660 "which would allow you to edit anywhere within the first megabyte of the disk."
31665 #: ../fish/guestfish-commands.pod:105
31666 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31671 #: ../fish/guestfish-commands.pod:107
31674 " hexedit /dev/sda1 0x400 0x400\n"
31680 #: ../fish/guestfish-commands.pod:109
31681 msgid "(assuming the superblock is in the standard location)."
31686 #: ../fish/guestfish-commands.pod:111
31688 "This command requires the external L<hexedit(1)> program. You can specify "
31689 "another program to use by setting the C<HEXEDITOR> environment variable."
31694 #: ../fish/guestfish-commands.pod:115
31695 msgid "See also L</hexdump>."
31700 #: ../fish/guestfish-commands.pod:117
31706 #: ../fish/guestfish-commands.pod:119
31715 #: ../fish/guestfish-commands.pod:121
31717 "Change the local directory, ie. the current directory of guestfish itself."
31722 #: ../fish/guestfish-commands.pod:124
31723 msgid "Note that C<!cd> won't do what you might expect."
31728 #: ../fish/guestfish-commands.pod:126
31734 #: ../fish/guestfish-commands.pod:128
31740 #: ../fish/guestfish-commands.pod:130
31749 #: ../fish/guestfish-commands.pod:132
31750 msgid "Opens the manual page for guestfish."
31755 #: ../fish/guestfish-commands.pod:134
31761 #: ../fish/guestfish-commands.pod:136
31767 #: ../fish/guestfish-commands.pod:138
31776 #: ../fish/guestfish-commands.pod:140
31785 #: ../fish/guestfish-commands.pod:142
31786 msgid "This is used to view a file."
31791 #: ../fish/guestfish-commands.pod:144
31793 "The default viewer is C<$PAGER>. However if you use the alternate command "
31794 "C<less> you will get the C<less> command specifically."
31799 #: ../fish/guestfish-commands.pod:147
31805 #: ../fish/guestfish-commands.pod:149
31814 #: ../fish/guestfish-commands.pod:151
31816 "Close and reopen the libguestfs handle. It is not necessary to use this "
31817 "normally, because the handle is closed properly when guestfish exits. "
31818 "However this is occasionally useful for testing."
31823 #: ../fish/guestfish-commands.pod:155
31829 #: ../fish/guestfish-commands.pod:157
31832 " sparse filename size\n"
31838 #: ../fish/guestfish-commands.pod:159
31840 "This creates an empty sparse file of the given size, and then adds so it can "
31841 "be further examined."
31846 #: ../fish/guestfish-commands.pod:162
31848 "In all respects it works the same as the L</alloc> command, except that the "
31849 "image file is allocated sparsely, which means that disk blocks are not "
31850 "assigned to the file until they are needed. Sparse disk files only use "
31851 "space when written to, but they are slower and there is a danger you could "
31852 "run out of real disk space during a write operation."
31857 #: ../fish/guestfish-commands.pod:172
31863 #: ../fish/guestfish-commands.pod:174
31872 #: ../fish/guestfish-commands.pod:176
31874 "This command returns a list of the optional groups known to the daemon, and "
31875 "indicates which ones are supported by this build of the libguestfs appliance."
31880 #: ../fish/guestfish-commands.pod:180
31881 msgid "See also L<guestfs(3)/AVAILABILITY>."
31886 #: ../fish/guestfish-commands.pod:182
31892 #: ../fish/guestfish-commands.pod:184
31895 " time command args...\n"
31901 #: ../fish/guestfish-commands.pod:186
31903 "Run the command as usual, but print the elapsed time afterwards. This can "
31904 "be useful for benchmarking operations."
31909 #: ../test-tool/libguestfs-test-tool.pod:5
31910 msgid "libguestfs-test-tool - End user tests for libguestfs"
31915 #: ../test-tool/libguestfs-test-tool.pod:9
31918 " libguestfs-test-tool [--options]\n"
31924 #: ../test-tool/libguestfs-test-tool.pod:13
31926 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31927 "and developers, to allow them to check basic libguestfs functionality is "
31928 "working. This is needed because libguestfs occasionally breaks for reasons "
31929 "beyond our control: usually because of changes in the underlying qemu or "
31930 "kernel packages, or the host environment."
31935 #: ../test-tool/libguestfs-test-tool.pod:20
31936 msgid "If you suspect a problem in libguestfs, then just run:"
31941 #: ../test-tool/libguestfs-test-tool.pod:22
31944 " libguestfs-test-tool\n"
31950 #: ../test-tool/libguestfs-test-tool.pod:24
31951 msgid "It will print lots of diagnostic messages."
31956 #: ../test-tool/libguestfs-test-tool.pod:26
31957 msgid "If it runs to completion successfully, you will see this near the end:"
31962 #: ../test-tool/libguestfs-test-tool.pod:28
31965 " ===== TEST FINISHED OK =====\n"
31971 #: ../test-tool/libguestfs-test-tool.pod:30
31972 msgid "and the test tool will exit with code 0."
31977 #: ../test-tool/libguestfs-test-tool.pod:32
31979 "If it fails (and/or exits with non-zero error code), please paste the "
31980 "B<complete, unedited> output of the test tool into a bug report. More "
31981 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31987 #: ../test-tool/libguestfs-test-tool.pod:41
31993 #: ../test-tool/libguestfs-test-tool.pod:43
31994 msgid "Display short usage information and exit."
31999 #: ../test-tool/libguestfs-test-tool.pod:45
32000 msgid "I<--qemu qemu_binary>"
32005 #: ../test-tool/libguestfs-test-tool.pod:47
32007 "If you have downloaded another qemu binary, point this option at the full "
32008 "path of the binary to try it."
32013 #: ../test-tool/libguestfs-test-tool.pod:50
32014 msgid "I<--qemudir qemu_source_dir>"
32019 #: ../test-tool/libguestfs-test-tool.pod:52
32021 "If you have compiled qemu from source, point this option at the source "
32022 "directory to try it."
32027 #: ../test-tool/libguestfs-test-tool.pod:55
32028 msgid "I<--timeout N>"
32033 #: ../test-tool/libguestfs-test-tool.pod:57
32035 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32036 "does not usually need to be adjusted unless your machine is very slow."
32041 #: ../test-tool/libguestfs-test-tool.pod:63
32042 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32047 #: ../test-tool/libguestfs-test-tool.pod:65
32049 "If you have compiled another version of qemu from source and would like to "
32050 "try that, then you can use the I<--qemudir> option to point to the qemu "
32051 "source directory."
32056 #: ../test-tool/libguestfs-test-tool.pod:69
32058 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32059 "option to point to the binary."
32064 #: ../test-tool/libguestfs-test-tool.pod:72
32066 "When using an alternate qemu with libguestfs, usually you would need to "
32067 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32068 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32069 "use either of the I<--qemudir> or I<--qemu> options."
32074 #: ../test-tool/libguestfs-test-tool.pod:79
32076 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32077 "I<1> if there was an error."
32082 #: ../test-tool/libguestfs-test-tool.pod:84
32084 "For the full list of environment variables which may affect libguestfs, "
32085 "please see the L<guestfs(3)> manual page."
32090 #: ../test-tool/libguestfs-test-tool.pod:89
32091 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32096 #: ../fuse/guestmount.pod:5
32098 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32103 #: ../fuse/guestmount.pod:9
32106 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32112 #: ../fuse/guestmount.pod:11
32115 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32121 #: ../fuse/guestmount.pod:13
32124 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32130 #: ../fuse/guestmount.pod:17
32132 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32133 "machines. If you do this, you risk disk corruption in the VM."
32138 #: ../fuse/guestmount.pod:22
32140 "The guestmount program can be used to mount virtual machine filesystems and "
32141 "other disk images on the host. It uses libguestfs for access to the guest "
32142 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32143 "a mountable device."
32148 #: ../fuse/guestmount.pod:27
32150 "Along with other options, you have to give at least one device (I<-a> "
32151 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32152 "option) or use the I<-i> inspection option. How this works is better "
32153 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32159 #: ../fuse/guestmount.pod:33
32161 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32162 "by you, and the filesystem will not be visible to any other users unless you "
32163 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32164 "the filesystem, use the C<fusermount -u> command."
32169 #: ../fuse/guestmount.pod:41
32171 "For a typical Windows guest which has its main filesystem on the first "
32177 #: ../fuse/guestmount.pod:44
32180 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32186 #: ../fuse/guestmount.pod:46
32188 "For a typical Linux guest which has a /boot filesystem on the first "
32189 "partition, and the root filesystem on a logical volume:"
32194 #: ../fuse/guestmount.pod:49
32197 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32203 #: ../fuse/guestmount.pod:51
32204 msgid "To get libguestfs to detect guest mountpoints for you:"
32209 #: ../fuse/guestmount.pod:53
32212 " guestmount -a guest.img -i --ro /mnt\n"
32218 #: ../fuse/guestmount.pod:55
32219 msgid "For a libvirt guest called \"Guest\" you could do:"
32224 #: ../fuse/guestmount.pod:57
32227 " guestmount -d Guest -i --ro /mnt\n"
32233 #: ../fuse/guestmount.pod:59
32235 "If you don't know what filesystems are contained in a guest or disk image, "
32236 "use L<virt-filesystems(1)> first:"
32241 #: ../fuse/guestmount.pod:62
32244 " virt-filesystems MyGuest\n"
32250 #: ../fuse/guestmount.pod:64
32252 "If you want to trace the libguestfs calls but without excessive debugging "
32253 "information, we recommend:"
32258 #: ../fuse/guestmount.pod:67
32261 " guestmount [...] --trace /mnt\n"
32267 #: ../fuse/guestmount.pod:69
32268 msgid "If you want to debug the program, we recommend:"
32273 #: ../fuse/guestmount.pod:71
32276 " guestmount [...] --trace --verbose /mnt\n"
32281 #: ../fuse/guestmount.pod:73
32286 #: ../fuse/guestmount.pod:75
32287 msgid "Other users cannot see the filesystem by default"
32291 #: ../fuse/guestmount.pod:77
32293 "If you mount a filesystem as one user (eg. root), then other users will not "
32294 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32295 "option when mounting:"
32299 #: ../fuse/guestmount.pod:81
32302 " sudo guestmount [...] -o allow_other /mnt\n"
32308 #: ../fuse/guestmount.pod:87
32309 msgid "B<-a image> | B<--add image>"
32314 #: ../fuse/guestmount.pod:89
32315 msgid "Add a block device or virtual machine image."
32320 #: ../fuse/guestmount.pod:94
32321 msgid "B<-c URI> | B<--connect URI>"
32326 #: ../fuse/guestmount.pod:100
32327 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32332 #: ../fuse/guestmount.pod:106
32333 msgid "B<--dir-cache-timeout N>"
32338 #: ../fuse/guestmount.pod:108
32340 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32341 "seconds. The readdir cache [actually, there are several semi-independent "
32342 "caches] is populated after a readdir(2) call with the stat and extended "
32343 "attributes of the files in the directory, in anticipation that they will be "
32344 "requested soon after."
32349 #: ../fuse/guestmount.pod:114
32351 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32352 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32353 "requests, only cache existing ones."
32358 #: ../fuse/guestmount.pod:125
32359 msgid "B<--format=raw|qcow2|..> | B<--format>"
32364 #: ../fuse/guestmount.pod:132
32366 "If you have untrusted raw-format guest disk images, you should use this "
32367 "option to specify the disk format. This avoids a possible security problem "
32368 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32369 "guestfs_add_drive_opts>."
32374 #: ../fuse/guestmount.pod:137
32375 msgid "B<--fuse-help>"
32380 #: ../fuse/guestmount.pod:139
32381 msgid "Display help on special FUSE options (see I<-o> below)."
32386 #: ../fuse/guestmount.pod:143
32387 msgid "Display brief help and exit."
32392 #: ../fuse/guestmount.pod:145
32393 msgid "B<-i> | B<--inspector>"
32398 #: ../fuse/guestmount.pod:165
32400 "Mount the named partition or logical volume on the given mountpoint B<in the "
32401 "guest> (this has nothing to do with mountpoints in the host)."
32406 #: ../fuse/guestmount.pod:168
32408 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32409 "something on C</>."
32414 #: ../fuse/guestmount.pod:181
32415 msgid "B<-n> | B<--no-sync>"
32420 #: ../fuse/guestmount.pod:183
32422 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32423 "unmounted. If you specify this option, then we don't attempt to sync the "
32424 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32429 #: ../fuse/guestmount.pod:188
32430 msgid "B<-o option> | B<--option option>"
32435 #: ../fuse/guestmount.pod:190
32436 msgid "Pass extra options to FUSE."
32441 #: ../fuse/guestmount.pod:192
32443 "To get a list of all the extra options supported by FUSE, use the command "
32444 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32445 "of them are a good idea."
32450 #: ../fuse/guestmount.pod:196
32453 " guestmount --fuse-help\n"
32459 #: ../fuse/guestmount.pod:198
32460 msgid "Some potentially useful FUSE options:"
32465 #: ../fuse/guestmount.pod:202
32466 msgid "B<-o allow_other>"
32471 #: ../fuse/guestmount.pod:204
32472 msgid "Allow other users to see the filesystem."
32477 #: ../fuse/guestmount.pod:206
32478 msgid "B<-o attr_timeout=N>"
32483 #: ../fuse/guestmount.pod:208
32484 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32489 #: ../fuse/guestmount.pod:210
32490 msgid "B<-o kernel_cache>"
32495 #: ../fuse/guestmount.pod:212
32497 "Allow the kernel to cache files (reduces the number of reads that have to go "
32498 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32499 "afford the extra memory usage."
32504 #: ../fuse/guestmount.pod:216
32505 msgid "B<-o uid=N> B<-o gid=N>"
32510 #: ../fuse/guestmount.pod:218
32512 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32513 "the chosen values."
32518 #: ../fuse/guestmount.pod:223
32519 msgid "B<-r> | B<--ro>"
32524 #: ../fuse/guestmount.pod:225
32526 "Add devices and mount everything read-only. Also disallow writes and make "
32527 "the disk appear read-only to FUSE."
32532 #: ../fuse/guestmount.pod:228
32534 "This is highly recommended if you are not going to edit the guest disk. If "
32535 "the guest is running and this option is I<not> supplied, then there is a "
32536 "strong risk of disk corruption in the guest. We try to prevent this from "
32537 "happening, but it is not always possible."
32542 #: ../fuse/guestmount.pod:233
32543 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32548 #: ../fuse/guestmount.pod:237
32549 msgid "Enable SELinux support for the guest."
32554 #: ../fuse/guestmount.pod:239
32555 msgid "B<-v> | B<--verbose>"
32560 #: ../fuse/guestmount.pod:241
32561 msgid "Enable verbose messages from underlying libguestfs."
32566 #: ../fuse/guestmount.pod:243
32567 msgid "B<-V> | B<--version>"
32572 #: ../fuse/guestmount.pod:245
32573 msgid "Display the program version and exit."
32578 #: ../fuse/guestmount.pod:247
32579 msgid "B<-w> | B<--rw>"
32583 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
32584 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32589 #: ../fuse/guestmount.pod:254
32590 msgid "B<-x> | B<--trace>"
32595 #: ../fuse/guestmount.pod:256
32596 msgid "Trace libguestfs calls and entry into each FUSE function."
32601 #: ../fuse/guestmount.pod:258
32602 msgid "This also stops the daemon from forking into the background."
32607 #: ../fuse/guestmount.pod:279
32609 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32610 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32616 #: ../fuse/guestmount.pod:294
32617 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32622 #: ../tools/virt-edit.pl:34
32623 msgid "virt-edit - Edit a file in a virtual machine"
32628 #: ../tools/virt-edit.pl:38
32631 " virt-edit [--options] domname file\n"
32637 #: ../tools/virt-edit.pl:40
32640 " virt-edit [--options] disk.img [disk.img ...] file\n"
32646 #: ../tools/virt-edit.pl:42
32649 " virt-edit [domname|disk.img] file -e 'expr'\n"
32655 #: ../tools/virt-edit.pl:46
32657 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32658 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32659 "doing this, but doesn't catch all cases."
32664 #: ../tools/virt-edit.pl:52
32666 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32667 "the named virtual machine (or disk image)."
32671 #: ../tools/virt-edit.pl:55
32672 msgid "If you want to just view a file, use L<virt-cat(1)>."
32676 #: ../tools/virt-edit.pl:57
32678 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32679 "USING GUESTFISH> below)."
32683 #: ../tools/virt-edit.pl:60
32685 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32686 "files. L<guestfish(1)> can do that and much more."
32691 #: ../tools/virt-edit.pl:65
32692 msgid "Edit the named files interactively:"
32697 #: ../tools/virt-edit.pl:67
32700 " virt-edit mydomain /boot/grub/grub.conf\n"
32706 #: ../tools/virt-edit.pl:69
32709 " virt-edit mydomain /etc/passwd\n"
32714 #: ../tools/virt-edit.pl:71
32715 msgid "For Windows guests, some Windows paths are understood:"
32719 #: ../tools/virt-edit.pl:73
32722 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32728 #: ../tools/virt-edit.pl:75
32730 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32731 "below). To change the init default level to 5:"
32736 #: ../tools/virt-edit.pl:79
32739 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32745 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32746 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32747 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32748 msgid "Display brief help."
32753 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32754 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32755 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32756 msgid "Display version number and exit."
32761 #: ../tools/virt-edit.pl:105
32762 msgid "B<--backup extension> | B<-b extension>"
32767 #: ../tools/virt-edit.pl:107
32769 "Create a backup of the original file I<in the guest disk image>. The backup "
32770 "has the original filename with C<extension> added."
32775 #: ../tools/virt-edit.pl:110
32777 "Usually the first character of C<extension> would be a dot C<.> so you would "
32783 #: ../tools/virt-edit.pl:113
32786 " virt-edit -b .orig [etc]\n"
32792 #: ../tools/virt-edit.pl:115
32793 msgid "By default, no backup file is made."
32798 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32799 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32800 #: ../tools/virt-list-partitions.pl:78
32801 msgid "B<--connect URI> | B<-c URI>"
32806 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32807 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32808 #: ../tools/virt-list-partitions.pl:80
32810 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32811 "to the default libvirt hypervisor."
32816 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32817 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32818 #: ../tools/virt-list-partitions.pl:83
32820 "If you specify guest block devices directly, then libvirt is not used at all."
32825 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32826 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32827 #: ../tools/virt-list-partitions.pl:90
32828 msgid "B<--format> raw"
32833 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32834 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32835 #: ../tools/virt-list-partitions.pl:92
32837 "Specify the format of disk images given on the command line. If this is "
32838 "omitted then the format is autodetected from the content of the disk image."
32843 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32844 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32845 #: ../tools/virt-list-partitions.pl:96
32847 "If disk images are requested from libvirt, then this program asks libvirt "
32848 "for this information. In this case, the value of the format parameter is "
32854 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32855 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32856 #: ../tools/virt-list-partitions.pl:100
32858 "If working with untrusted raw-format guest disk images, you should ensure "
32859 "the format is always specified."
32864 #: ../tools/virt-edit.pl:150
32865 msgid "B<--expr EXPR> | B<-e EXPR>"
32870 #: ../tools/virt-edit.pl:152
32872 "Instead of launching the external editor, non-interactively apply the Perl "
32873 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32879 #: ../tools/virt-edit.pl:156
32881 "Be careful to properly quote the expression to prevent it from being altered "
32887 #: ../tools/virt-edit.pl:280
32888 msgid "NON-INTERACTIVE EDITING"
32893 #: ../tools/virt-edit.pl:282
32895 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32896 "administrator can interactively edit the file."
32901 #: ../tools/virt-edit.pl:285
32903 "There are two ways also to use C<virt-edit> from scripts in order to make "
32904 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32905 "like this, it's less error-prone to write scripts directly using the "
32906 "libguestfs API and Augeas for configuration file editing.)"
32911 #: ../tools/virt-edit.pl:291
32913 "The first method is to temporarily set C<$EDITOR> to any script or program "
32914 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32915 "update C<tmpfile> in place however it likes."
32919 #: ../tools/virt-edit.pl:295
32921 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
32922 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32923 "instances of C<foo> with C<bar> in a file:"
32928 #: ../tools/virt-edit.pl:299
32931 " virt-edit domname filename -e 's/foo/bar/'\n"
32937 #: ../tools/virt-edit.pl:301
32939 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32940 "For example to delete root's password you could do:"
32945 #: ../tools/virt-edit.pl:304
32948 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32954 #: ../tools/virt-edit.pl:306
32956 "What really happens is that the snippet is evaluated as a Perl expression "
32957 "for each line of the file. The line, including the final C<\\n>, is passed "
32958 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32963 #: ../tools/virt-edit.pl:311
32965 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32966 "C<apache> user account from the password file you can do:"
32971 #: ../tools/virt-edit.pl:314
32974 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32980 #: ../tools/virt-edit.pl:316
32982 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32983 "the end of the file is rather difficult this way since there is no concept "
32984 "of \"last line of the file\" - your expression just doesn't get called "
32985 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32991 #: ../tools/virt-edit.pl:322
32993 "The variable C<$lineno> contains the current line number. As is "
32994 "traditional, the first line in the file is number C<1>."
32999 #: ../tools/virt-edit.pl:325
33001 "The return value from the expression is ignored, but the expression may call "
33002 "C<die> in order to abort the whole program, leaving the original file "
33008 #: ../tools/virt-edit.pl:329
33010 "Remember when matching the end of a line that C<$_> may contain the final C<"
33011 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
33012 "newline then neither of these. Thus to match or substitute some text at the "
33013 "end of a line, use this regular expression:"
33018 #: ../tools/virt-edit.pl:334
33021 " /some text(\\r?\\n)?$/\n"
33027 #: ../tools/virt-edit.pl:336
33029 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
33030 "$_> itself (since that would remove all newlines from the file):"
33035 #: ../tools/virt-edit.pl:340
33038 " my $m = $_; chomp $m; $m =~ /some text$/\n"
33043 #: ../tools/virt-edit.pl:344
33045 "C<virt-edit> has a limited ability to understand Windows drive letters and "
33046 "paths (eg. C<E:\\foo\\bar.txt>)."
33050 #: ../tools/virt-edit.pl:347
33051 msgid "If and only if the guest is running Windows then:"
33055 #: ../tools/virt-edit.pl:353
33057 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
33058 "to the correct filesystem."
33062 #: ../tools/virt-edit.pl:358
33064 "Any backslash (C<\\>) characters in the path are replaced with forward "
33065 "slashes so that libguestfs can process it."
33069 #: ../tools/virt-edit.pl:363
33071 "The path is resolved case insensitively to locate the file that should be "
33076 #: ../tools/virt-edit.pl:368
33077 msgid "There are some known shortcomings:"
33081 #: ../tools/virt-edit.pl:374
33082 msgid "Some NTFS symbolic links may not be followed correctly."
33086 #: ../tools/virt-edit.pl:378
33087 msgid "NTFS junction points that cross filesystems are not followed."
33091 #: ../tools/virt-edit.pl:435
33092 msgid "USING GUESTFISH"
33096 #: ../tools/virt-edit.pl:437
33098 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
33099 "C<virt-edit> doesn't work."
33103 #: ../tools/virt-edit.pl:440
33104 msgid "Using C<virt-edit> is approximately equivalent to doing:"
33108 #: ../tools/virt-edit.pl:442
33111 " guestfish --rw -i -d domname edit /file\n"
33116 #: ../tools/virt-edit.pl:444
33118 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
33119 "path to the file."
33123 #: ../tools/virt-edit.pl:447
33125 "The command above uses libguestfs's guest inspection feature and so does not "
33126 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
33127 "disk images that don't contain guests. To edit a file on a disk image "
33132 #: ../tools/virt-edit.pl:452
33135 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
33140 #: ../tools/virt-edit.pl:454
33142 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
33143 "the disk image to edit, and C</file> is the full path to the file."
33147 #: ../tools/virt-edit.pl:458
33149 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
33150 "C<write> or C<upload> instead:"
33154 #: ../tools/virt-edit.pl:461
33157 " guestfish --rw -i -d domname touch /newfile\n"
33162 #: ../tools/virt-edit.pl:463
33165 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
33170 #: ../tools/virt-edit.pl:465
33173 " guestfish --rw -i -d domname upload localfile /newfile\n"
33178 #: ../tools/virt-edit.pl:467
33180 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
33184 #: ../tools/virt-edit.pl:470
33187 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
33193 #: ../tools/virt-edit.pl:480
33199 #: ../tools/virt-edit.pl:482
33201 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33207 #: ../tools/virt-edit.pl:485
33208 msgid "If not set, C<vi> is used."
33213 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33214 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
33215 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
33216 msgid "SHELL QUOTING"
33221 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33222 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
33223 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
33225 "Libvirt guest names can contain arbitrary characters, some of which have "
33226 "meaning to the shell such as C<#> and space. You may need to quote or "
33227 "escape these characters on the command line. See the shell manual page L<sh"
33228 "(1)> for details."
33232 #: ../tools/virt-edit.pl:498
33234 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33235 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33236 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33241 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33242 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33243 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33249 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33250 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33251 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33252 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33256 #: ../tools/virt-edit.pl:516
33257 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33262 #: ../tools/virt-win-reg.pl:37
33264 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33269 #: ../tools/virt-win-reg.pl:41
33272 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33278 #: ../tools/virt-win-reg.pl:43
33281 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33287 #: ../tools/virt-win-reg.pl:45
33290 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33296 #: ../tools/virt-win-reg.pl:47
33299 " virt-win-reg --merge domname [input.reg ...]\n"
33305 #: ../tools/virt-win-reg.pl:49
33308 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33313 #: ../tools/virt-win-reg.pl:53
33315 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33316 "virtual machines. If you do this, you I<will> get irreversible disk "
33317 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33318 "but doesn't catch all cases."
33322 #: ../tools/virt-win-reg.pl:58
33324 "Modifying the Windows Registry is an inherently risky operation. The format "
33325 "is deliberately obscure and undocumented, and Registry changes can leave the "
33326 "system unbootable. Therefore when using the I<--merge> option, make sure "
33327 "you have a reliable backup first."
33332 #: ../tools/virt-win-reg.pl:65
33334 "This program can export and merge Windows Registry entries from a Windows "
33340 #: ../tools/virt-win-reg.pl:68
33342 "The first parameter is the libvirt guest name or the raw disk image of a "
33347 #: ../tools/virt-win-reg.pl:71
33349 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33350 "exported (recursively). For example:"
33355 #: ../tools/virt-win-reg.pl:74
33358 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33364 #: ../tools/virt-win-reg.pl:76
33366 "You can also display single values from within registry keys, for example:"
33371 #: ../tools/virt-win-reg.pl:79
33374 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33375 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33376 " Windows 7 Enterprise\n"
33381 #: ../tools/virt-win-reg.pl:83
33383 "With I<--merge>, you can merge a textual regedit file into the Windows "
33389 #: ../tools/virt-win-reg.pl:86
33392 " $ virt-win-reg --merge Windows7 changes.reg\n"
33398 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33404 #: ../tools/virt-win-reg.pl:90
33406 "This program is only meant for simple access to the registry. If you want "
33407 "to do complicated things with the registry, we suggest you download the "
33408 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33409 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33410 "L<hivexregedit(1)>."
33415 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33421 #: ../tools/virt-win-reg.pl:122
33422 msgid "Enable debugging messages."
33427 #: ../tools/virt-win-reg.pl:157
33433 #: ../tools/virt-win-reg.pl:159
33435 "In merge mode, this merges a textual regedit file into the Windows Registry "
33436 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33437 "displays or exports Registry entries instead."
33441 #: ../tools/virt-win-reg.pl:163
33443 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33444 "result in disk corruption. However exporting (without this flag) is always "
33450 #: ../tools/virt-win-reg.pl:171
33451 msgid "B<--encoding> UTF-16LE|ASCII"
33456 #: ../tools/virt-win-reg.pl:173
33458 "When merging (only), you may need to specify the encoding for strings to be "
33459 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33460 "(3)/ENCODING STRINGS>."
33465 #: ../tools/virt-win-reg.pl:177
33467 "The default is to use UTF-16LE, which should work with recent versions of "
33473 #: ../tools/virt-win-reg.pl:402
33474 msgid "SUPPORTED SYSTEMS"
33479 #: ../tools/virt-win-reg.pl:404
33481 "The program currently supports Windows NT-derived guests starting with "
33482 "Windows XP through to at least Windows 7."
33487 #: ../tools/virt-win-reg.pl:407
33489 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33490 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33491 "and C<HKEY_USERS\\.DEFAULT>."
33496 #: ../tools/virt-win-reg.pl:411
33498 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33504 #: ../tools/virt-win-reg.pl:414
33506 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33512 #: ../tools/virt-win-reg.pl:417
33518 #: ../tools/virt-win-reg.pl:419
33520 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33521 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33522 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33523 "Windows-style line endings, you may need to reencode the whole file before "
33524 "or after processing."
33528 #: ../tools/virt-win-reg.pl:425
33530 "To reencode a file from Windows format to Linux (before processing it with "
33531 "the I<--merge> option), you would do something like this:"
33536 #: ../tools/virt-win-reg.pl:428
33539 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33545 #: ../tools/virt-win-reg.pl:430
33547 "To go in the opposite direction, after exporting and before sending the file "
33548 "to a Windows user, do something like this:"
33553 #: ../tools/virt-win-reg.pl:433
33556 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33562 #: ../tools/virt-win-reg.pl:435
33563 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33568 #: ../tools/virt-win-reg.pl:437
33570 "If you are unsure about the current encoding, use the L<file(1)> command. "
33571 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33572 "style (CRLF) line endings, like this:"
33577 #: ../tools/virt-win-reg.pl:441
33580 " $ file software.reg\n"
33581 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33582 " with CRLF line terminators\n"
33587 #: ../tools/virt-win-reg.pl:445
33588 msgid "This file would need conversion before you could I<--merge> it."
33593 #: ../tools/virt-win-reg.pl:447
33594 msgid "CurrentControlSet etc."
33599 #: ../tools/virt-win-reg.pl:449
33601 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33602 "Registry at the level of the hive file, and therefore you cannot modify "
33608 #: ../tools/virt-win-reg.pl:453
33610 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33611 "circumstances it might refer to another control set. The way to find out is "
33612 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33617 #: ../tools/virt-win-reg.pl:457
33620 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33621 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33622 " \"Current\"=dword:00000001\n"
33623 " \"Default\"=dword:00000001\n"
33624 " \"Failed\"=dword:00000000\n"
33625 " \"LastKnownGood\"=dword:00000002\n"
33631 #: ../tools/virt-win-reg.pl:464
33632 msgid "\"Current\" is the one which Windows will choose when it boots."
33637 #: ../tools/virt-win-reg.pl:466
33639 "Similarly, other C<Current...> keys in the path may need to be replaced."
33644 #: ../tools/virt-win-reg.pl:469
33645 msgid "WINDOWS TIPS"
33650 #: ../tools/virt-win-reg.pl:471
33652 "Note that some of these tips modify the guest disk image. The guest I<must> "
33653 "be shut off, else you will get disk corruption."
33658 #: ../tools/virt-win-reg.pl:474
33659 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33664 #: ../tools/virt-win-reg.pl:476
33666 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33667 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33668 "is uploaded into C<C:\\>:"
33673 #: ../tools/virt-win-reg.pl:480
33676 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33682 #: ../tools/virt-win-reg.pl:482
33683 msgid "Prepare a regedit file containing the registry change:"
33688 #: ../tools/virt-win-reg.pl:484
33691 " cat > test.reg <<'EOF'\n"
33692 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33693 " \"Test\"=\"c:\\\\test.bat\"\n"
33700 #: ../tools/virt-win-reg.pl:489
33702 "In this example we use the key C<RunOnce> which means that the script will "
33703 "run precisely once when the first user logs in. If you want it to run every "
33704 "time a user logs in, replace C<RunOnce> with C<Run>."
33709 #: ../tools/virt-win-reg.pl:493
33710 msgid "Now update the registry:"
33715 #: ../tools/virt-win-reg.pl:495
33718 " virt-win-reg --merge WindowsGuest test.reg\n"
33724 #: ../tools/virt-win-reg.pl:497
33725 msgid "INSTALLING A SERVICE"
33730 #: ../tools/virt-win-reg.pl:499
33732 "This section assumes you are familiar with Windows services, and you either "
33733 "have a program which handles the Windows Service Control Protocol directly "
33734 "or you want to run any program using a service wrapper like SrvAny or the "
33740 #: ../tools/virt-win-reg.pl:504
33742 "First upload the program and optionally the service wrapper. In this case "
33743 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33748 #: ../tools/virt-win-reg.pl:508
33751 " guestfish -i -d WindowsGuest <<EOF\n"
33752 " upload rhsrvany.exe /rhsrvany.exe\n"
33753 " upload test.exe /test.exe\n"
33760 #: ../tools/virt-win-reg.pl:513
33762 "Prepare a regedit file containing the registry changes. In this example, "
33763 "the first registry change is needed for the service itself or the service "
33764 "wrapper (if used). The second registry change is only needed because I am "
33765 "using the RHSrvAny service wrapper."
33770 #: ../tools/virt-win-reg.pl:518
33773 " cat > service.reg <<'EOF'\n"
33774 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33775 " \"Type\"=dword:00000010\n"
33776 " \"Start\"=dword:00000002\n"
33777 " \"ErrorControl\"=dword:00000001\n"
33778 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33779 " \"DisplayName\"=\"RHSrvAny\"\n"
33780 " \"ObjectName\"=\"NetworkService\"\n"
33786 #: ../tools/virt-win-reg.pl:527
33789 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33790 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33791 " \"PWD\"=\"c:\\\\Temp\"\n"
33798 #: ../tools/virt-win-reg.pl:538
33800 "For use of C<ControlSet001> see the section above in this manual page. You "
33801 "may need to adjust this according to the control set that is in use by the "
33807 #: ../tools/virt-win-reg.pl:544
33809 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33810 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33811 "privileged account."
33816 #: ../tools/virt-win-reg.pl:550
33818 "For the meaning of the magic numbers, see this Microsoft KB article: "
33819 "L<http://support.microsoft.com/kb/103000>."
33824 #: ../tools/virt-win-reg.pl:555
33825 msgid "Update the registry:"
33830 #: ../tools/virt-win-reg.pl:557
33833 " virt-win-reg --merge WindowsGuest service.reg\n"
33839 #: ../tools/virt-win-reg.pl:561
33841 "Be careful when passing parameters containing C<\\> (backslash) in the "
33842 "shell. Usually you will have to use 'single quotes' or double backslashes "
33843 "(but not both) to protect them from the shell."
33848 #: ../tools/virt-win-reg.pl:565
33849 msgid "Paths and value names are case-insensitive."
33854 #: ../tools/virt-win-reg.pl:574
33856 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33857 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33858 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33863 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33865 "When reporting bugs, please enable debugging and capture the I<complete> "
33871 #: ../tools/virt-win-reg.pl:592
33874 " export LIBGUESTFS_DEBUG=1\n"
33875 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33881 #: ../tools/virt-win-reg.pl:595
33883 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33889 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33890 msgid "Copyright (C) 2010 Red Hat Inc."
33895 #: ../tools/virt-list-filesystems.pl:32
33897 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33902 #: ../tools/virt-list-filesystems.pl:36
33905 " virt-list-filesystems [--options] domname\n"
33911 #: ../tools/virt-list-filesystems.pl:38
33914 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33920 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33922 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33928 #: ../tools/virt-list-filesystems.pl:45
33930 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33931 "are contained in a virtual machine or disk image."
33936 #: ../tools/virt-list-filesystems.pl:49
33938 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33939 "functionality. For more complex cases you should look at the L<guestfish(1)"
33945 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33946 msgid "B<-l> | B<--long>"
33951 #: ../tools/virt-list-filesystems.pl:108
33953 "With this option, C<virt-list-filesystems> displays the type of each "
33954 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33959 #: ../tools/virt-list-filesystems.pl:115
33960 msgid "B<-a> | B<--all>"
33965 #: ../tools/virt-list-filesystems.pl:117
33967 "Normally we only show mountable filesystems. If this option is given then "
33968 "swap devices are shown too."
33973 #: ../tools/virt-list-filesystems.pl:191
33975 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33976 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33977 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33982 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33983 msgid "Copyright (C) 2009 Red Hat Inc."
33988 #: ../tools/virt-tar.pl:33
33989 msgid "virt-tar - Extract or upload files to a virtual machine"
33994 #: ../tools/virt-tar.pl:37
33997 " virt-tar [--options] -x domname directory tarball\n"
34003 #: ../tools/virt-tar.pl:39
34006 " virt-tar [--options] -u domname tarball directory\n"
34012 #: ../tools/virt-tar.pl:41
34015 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34021 #: ../tools/virt-tar.pl:43
34024 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34029 #: ../tools/virt-tar.pl:47
34031 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34032 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34037 #: ../tools/virt-tar.pl:52
34038 msgid "Download C</home> from the VM into a local tarball:"
34043 #: ../tools/virt-tar.pl:54
34046 " virt-tar -x domname /home home.tar\n"
34052 #: ../tools/virt-tar.pl:56
34055 " virt-tar -zx domname /home home.tar.gz\n"
34061 #: ../tools/virt-tar.pl:58
34062 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34067 #: ../tools/virt-tar.pl:60
34070 " virt-tar -u domname uploadstuff.tar /tmp\n"
34076 #: ../tools/virt-tar.pl:62
34079 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34084 #: ../tools/virt-tar.pl:66
34086 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34087 "virtual machines. If you do this, you risk disk corruption in the VM. "
34088 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34092 #: ../tools/virt-tar.pl:71
34094 "You can use I<-x> (extract) on live virtual machines, but you might get "
34095 "inconsistent results or errors if there is filesystem activity inside the "
34096 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34097 "work, but the only way to guarantee consistent results is if the virtual "
34098 "machine is shut down."
34103 #: ../tools/virt-tar.pl:79
34105 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34106 "parts of a guest filesystem. There are many possibilities: making backups, "
34107 "uploading data files, snooping on guest activity, fixing or customizing "
34113 #: ../tools/virt-tar.pl:84
34115 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34116 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34117 "should look at the L<guestfish(1)> tool."
34121 #: ../tools/virt-tar.pl:88
34123 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34124 "its contents (recursively) from the virtual machine into a local tarball. "
34125 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34126 "virtual machine. You cannot use these two options together."
34130 #: ../tools/virt-tar.pl:94
34132 "In addition, you may need to use the I<-z> (gZip) option to enable "
34133 "compression. When uploading, you have to specify I<-z> if the upload file "
34134 "is compressed because virt-tar won't detect this on its own."
34139 #: ../tools/virt-tar.pl:98
34141 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34142 "example it cannot do PKZip files or bzip2 compression. If you want that "
34143 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34144 "the L<libguestfs(3)> API)."
34149 #: ../tools/virt-tar.pl:156
34150 msgid "B<-x> | B<--extract> | B<--download>"
34155 #: ../tools/virt-tar.pl:158
34156 msgid "B<-u> | B<--upload>"
34160 #: ../tools/virt-tar.pl:160
34162 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34167 #: ../tools/virt-tar.pl:163
34169 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34170 "Please read the L</WARNING> section above before using this option."
34175 #: ../tools/virt-tar.pl:167
34176 msgid "You must specify exactly one of these options."
34181 #: ../tools/virt-tar.pl:173
34182 msgid "B<-z> | B<--gzip>"
34187 #: ../tools/virt-tar.pl:175
34188 msgid "Specify that the input or output tarball is gzip-compressed."
34192 #: ../tools/virt-tar.pl:288
34194 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34195 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34196 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34202 #: ../tools/virt-make-fs.pl:37
34203 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34208 #: ../tools/virt-make-fs.pl:41
34211 " virt-make-fs [--options] input.tar output.img\n"
34217 #: ../tools/virt-make-fs.pl:43
34220 " virt-make-fs [--options] input.tar.gz output.img\n"
34226 #: ../tools/virt-make-fs.pl:45
34229 " virt-make-fs [--options] directory output.img\n"
34235 #: ../tools/virt-make-fs.pl:49
34237 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34238 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34239 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34240 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34241 "you want to attach these filesystems to existing virtual machines (eg. to "
34242 "import large amounts of read-only data to a VM)."
34247 #: ../tools/virt-make-fs.pl:57
34248 msgid "Basic usage is:"
34253 #: ../tools/virt-make-fs.pl:59
34256 " virt-make-fs input output\n"
34262 #: ../tools/virt-make-fs.pl:61
34264 "where C<input> is either a directory containing files that you want to add, "
34265 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34266 "C<output> is a disk image. The input type is detected automatically. The "
34267 "output disk image defaults to a raw ext2 image unless you specify extra "
34268 "flags (see L</OPTIONS> below)."
34273 #: ../tools/virt-make-fs.pl:67
34274 msgid "EXTRA SPACE"
34278 #: ../tools/virt-make-fs.pl:69
34280 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34281 "the files that it contains, but might have extra space. Depending on how "
34282 "you are going to use the output, you might think this extra space is wasted "
34283 "and want to minimize it, or you might want to leave space so that more files "
34284 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34285 "but you can use the I<--size> flag to leave space in the filesystem if you "
34290 #: ../tools/virt-make-fs.pl:77
34292 "An alternative way to leave extra space but not make the output image any "
34293 "bigger is to use an alternative disk image format (instead of the default "
34294 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34295 "image format (check your hypervisor supports this before using it). This "
34296 "allows you to choose a large I<--size> but the extra space won't actually be "
34297 "allocated in the image until you try to store something in it."
34301 #: ../tools/virt-make-fs.pl:85
34303 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34304 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34305 "to build another image from scratch."
34310 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34311 #: ../tools/virt-make-fs.pl:142
34317 #: ../tools/virt-make-fs.pl:91
34320 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34326 #: ../tools/virt-make-fs.pl:93
34327 msgid "FILESYSTEM TYPE"
34332 #: ../tools/virt-make-fs.pl:95
34334 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34335 "libguestfs supports can be used (but I<not> read-only formats like "
34336 "ISO9660). Here are some of the more common choices:"
34341 #: ../tools/virt-make-fs.pl:101
34347 #: ../tools/virt-make-fs.pl:103
34349 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34350 "you are not going to use the filesystem in a way that requires the journal, "
34351 "then this is just wasted overhead."
34356 #: ../tools/virt-make-fs.pl:107
34357 msgid "I<ntfs> or I<vfat>"
34362 #: ../tools/virt-make-fs.pl:109
34363 msgid "Useful if exporting data to a Windows guest."
34368 #: ../tools/virt-make-fs.pl:111
34370 "I<Note for vfat>: The tar archive or local directory must only contain files "
34371 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34372 "program running within libguestfs is unable to change the ownership of non-"
34373 "root files, since vfat itself does not support this."
34378 #: ../tools/virt-make-fs.pl:116
34384 #: ../tools/virt-make-fs.pl:118
34386 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34387 "total filesystem size."
34392 #: ../tools/virt-make-fs.pl:125
34395 " virt-make-fs --type=minix input minixfs.img\n"
34401 #: ../tools/virt-make-fs.pl:127
34402 msgid "TO PARTITION OR NOT TO PARTITION"
34407 #: ../tools/virt-make-fs.pl:129
34408 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34413 #: ../tools/virt-make-fs.pl:131
34415 "Adding a partition can make the disk image more compatible with certain "
34416 "virtualized operating systems which don't expect to see a filesystem "
34417 "directly located on a block device (Linux doesn't care and will happily "
34418 "handle both types)."
34423 #: ../tools/virt-make-fs.pl:136
34425 "On the other hand, if you have a partition table then the output image is no "
34426 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34427 "directly on a partitioned disk image. (However libguestfs tools such as "
34428 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34433 #: ../tools/virt-make-fs.pl:144
34434 msgid "Add an MBR partition:"
34439 #: ../tools/virt-make-fs.pl:146
34442 " virt-make-fs --partition -- input disk.img\n"
34448 #: ../tools/virt-make-fs.pl:148
34450 "If the output disk image could be terabyte-sized or larger, it's better to "
34451 "use an EFI/GPT-compatible partition table:"
34456 #: ../tools/virt-make-fs.pl:151
34459 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34465 #: ../tools/virt-make-fs.pl:179
34466 msgid "Enable debugging information."
34471 #: ../tools/virt-make-fs.pl:185
34472 msgid "B<--size=E<lt>NE<gt>>"
34477 #: ../tools/virt-make-fs.pl:187
34478 msgid "B<--size=+E<lt>NE<gt>>"
34483 #: ../tools/virt-make-fs.pl:189
34484 msgid "B<-s E<lt>NE<gt>>"
34489 #: ../tools/virt-make-fs.pl:191
34490 msgid "B<-s +E<lt>NE<gt>>"
34494 #: ../tools/virt-make-fs.pl:193
34496 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34501 #: ../tools/virt-make-fs.pl:196
34503 "If this option is I<not> given, then the output image will be just large "
34504 "enough to contain all the files, with not much wasted space."
34509 #: ../tools/virt-make-fs.pl:199
34511 "To choose a fixed size output disk, specify an absolute number followed by b/"
34512 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34513 "Petabytes or Exabytes. This must be large enough to contain all the input "
34514 "files, else you will get an error."
34518 #: ../tools/virt-make-fs.pl:204
34520 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34521 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34522 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34523 "the input files, and (approximately) an extra 200 MB free space."
34528 #: ../tools/virt-make-fs.pl:210
34530 "Note that virt-make-fs estimates free space, and therefore will not produce "
34531 "filesystems containing precisely the free space requested. (It is much more "
34532 "expensive and time-consuming to produce a filesystem which has precisely the "
34533 "desired free space)."
34538 #: ../tools/virt-make-fs.pl:219
34539 msgid "B<--format=E<lt>fmtE<gt>>"
34544 #: ../tools/virt-make-fs.pl:221
34545 msgid "B<-F E<lt>fmtE<gt>>"
34550 #: ../tools/virt-make-fs.pl:223
34551 msgid "Choose the output disk image format."
34556 #: ../tools/virt-make-fs.pl:225
34557 msgid "The default is C<raw> (raw disk image)."
34562 #: ../tools/virt-make-fs.pl:227
34564 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34565 "that would really make sense here is C<qcow2>."
34570 #: ../tools/virt-make-fs.pl:234
34571 msgid "B<--type=E<lt>fsE<gt>>"
34576 #: ../tools/virt-make-fs.pl:236
34577 msgid "B<-t E<lt>fsE<gt>>"
34582 #: ../tools/virt-make-fs.pl:238
34583 msgid "Choose the output filesystem type."
34588 #: ../tools/virt-make-fs.pl:240
34589 msgid "The default is C<ext2>."
34594 #: ../tools/virt-make-fs.pl:242
34596 "Any filesystem which is supported read-write by libguestfs can be used here."
34601 #: ../tools/virt-make-fs.pl:249
34602 msgid "B<--partition>"
34607 #: ../tools/virt-make-fs.pl:251
34608 msgid "B<--partition=E<lt>parttypeE<gt>>"
34613 #: ../tools/virt-make-fs.pl:253
34615 "If specified, this flag adds an MBR partition table to the output disk image."
34619 #: ../tools/virt-make-fs.pl:256
34621 "You can change the partition table type, eg. I<--partition=gpt> for large "
34626 #: ../tools/virt-make-fs.pl:259
34628 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34629 "might consider the next parameter to be the partition type. For example:"
34634 #: ../tools/virt-make-fs.pl:263
34637 " virt-make-fs --partition input.tar ...\n"
34642 #: ../tools/virt-make-fs.pl:265
34644 "would cause virt-make-fs to think you wanted to use a partition type of "
34645 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34646 "dash) between options and the input file argument:"
34651 #: ../tools/virt-make-fs.pl:269
34654 " virt-make-fs --partition -- input.tar ...\n"
34659 #: ../tools/virt-make-fs.pl:541
34661 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34662 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34663 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34668 #: ../tools/virt-make-fs.pl:558
34671 " export LIBGUESTFS_DEBUG=1\n"
34672 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34678 #: ../tools/virt-make-fs.pl:561
34680 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34686 #: ../tools/virt-list-partitions.pl:32
34688 "virt-list-partitions - List partitions in a virtual machine or disk image"
34693 #: ../tools/virt-list-partitions.pl:36
34696 " virt-list-partitions [--options] domname\n"
34702 #: ../tools/virt-list-partitions.pl:38
34705 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34711 #: ../tools/virt-list-partitions.pl:45
34713 "C<virt-list-partitions> is a command line tool to list the partitions that "
34714 "are contained in a virtual machine or disk image. It is mainly useful as a "
34715 "first step to using L<virt-resize(1)>."
34720 #: ../tools/virt-list-partitions.pl:50
34722 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34723 "functionality. For more complex cases you should look at the L<guestfish(1)"
34729 #: ../tools/virt-list-partitions.pl:107
34730 msgid "B<-h> | B<--human-readable>"
34735 #: ../tools/virt-list-partitions.pl:109
34736 msgid "Show sizes in human-readable form (eg. \"1G\")."
34741 #: ../tools/virt-list-partitions.pl:117
34743 "With this option, C<virt-list-partitions> displays the type and size of each "
34744 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34749 #: ../tools/virt-list-partitions.pl:124
34750 msgid "B<-t> | B<--total>"
34755 #: ../tools/virt-list-partitions.pl:126
34757 "Display the total size of each block device (as a separate row or rows)."
34762 #: ../tools/virt-list-partitions.pl:259
34764 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34765 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34766 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34771 #: ../tools/virt-list-partitions.pl:275
34772 msgid "Copyright (C) 2009-2010 Red Hat Inc."