1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-06-13 15:24+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:2962 ../src/guestfs.pod:2966 ../src/guestfs.pod:2970
927 #: ../src/guestfs.pod:2974 ../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:5818
5572 #: ../fish/guestfish-actions.pod:3912
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
5610 msgid "Outside contributions, experimental parts."
5614 #: ../src/guestfs.pod:2664
5619 #: ../src/guestfs.pod:2666
5621 "The daemon that runs inside the libguestfs appliance and carries out actions."
5625 #: ../src/guestfs.pod:2669
5630 #: ../src/guestfs.pod:2671
5631 msgid "L<virt-df(1)> command and documentation."
5635 #: ../src/guestfs.pod:2673
5640 #: ../src/guestfs.pod:2675
5641 msgid "C API example code."
5645 #: ../src/guestfs.pod:2677
5650 #: ../src/guestfs.pod:2679
5652 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5653 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5654 "L<virt-tar-out(1)>."
5658 #: ../src/guestfs.pod:2683
5663 #: ../src/guestfs.pod:2685
5665 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5669 #: ../src/guestfs.pod:2687
5670 msgid "C<generator>"
5674 #: ../src/guestfs.pod:2689
5676 "The crucially important generator, used to automatically generate large "
5677 "amounts of boilerplate C code for things like RPC and bindings."
5681 #: ../src/guestfs.pod:2692
5686 #: ../src/guestfs.pod:2694
5687 msgid "Files used by the test suite."
5691 #: ../src/guestfs.pod:2696
5692 msgid "Some \"phony\" guest images which we test against."
5696 #: ../src/guestfs.pod:2698
5697 msgid "C<inspector>"
5701 #: ../src/guestfs.pod:2700
5702 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5706 #: ../src/guestfs.pod:2702
5711 #: ../src/guestfs.pod:2704
5712 msgid "Logo used on the website. The fish is called Arthur by the way."
5716 #: ../src/guestfs.pod:2706
5721 #: ../src/guestfs.pod:2708
5722 msgid "M4 macros used by autoconf."
5726 #: ../src/guestfs.pod:2710
5731 #: ../src/guestfs.pod:2712
5732 msgid "Translations of simple gettext strings."
5736 #: ../src/guestfs.pod:2714
5741 #: ../src/guestfs.pod:2716
5743 "The build infrastructure and PO files for translations of manpages and POD "
5744 "files. Eventually this will be combined with the C<po> directory, but that "
5745 "is rather complicated."
5749 #: ../src/guestfs.pod:2720
5750 msgid "C<regressions>"
5754 #: ../src/guestfs.pod:2722
5755 msgid "Regression tests."
5759 #: ../src/guestfs.pod:2724
5764 #: ../src/guestfs.pod:2726
5765 msgid "L<virt-rescue(1)> command and documentation."
5769 #: ../src/guestfs.pod:2728
5774 #: ../src/guestfs.pod:2730
5775 msgid "Source code to the C library."
5779 #: ../src/guestfs.pod:2732
5784 #: ../src/guestfs.pod:2734
5785 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5789 #: ../src/guestfs.pod:2736
5790 msgid "C<test-tool>"
5794 #: ../src/guestfs.pod:2738
5796 "Test tool for end users to test if their qemu/kernel combination will work "
5801 #: ../src/guestfs.pod:2741
5806 #: ../src/guestfs.pod:2743
5811 #: ../src/guestfs.pod:2745
5816 #: ../src/guestfs.pod:2747
5821 #: ../src/guestfs.pod:2749
5826 #: ../src/guestfs.pod:2751
5831 #: ../src/guestfs.pod:2753
5836 #: ../src/guestfs.pod:2755
5841 #: ../src/guestfs.pod:2757
5842 msgid "Language bindings."
5846 #: ../src/guestfs.pod:2761
5852 #: ../src/guestfs.pod:2763
5853 msgid "PROTOCOL LIMITS"
5858 #: ../src/guestfs.pod:2765
5860 "Internally libguestfs uses a message-based protocol to pass API calls and "
5861 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5862 "plenty more detail about this). The maximum message size used by the "
5863 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5864 "aware of this limit. The API calls which may be affected are individually "
5865 "documented, with a link back to this section of the documentation."
5870 #: ../src/guestfs.pod:2773
5872 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5873 "a simple string. Because this string is at some point internally encoded as "
5874 "a message, the maximum size that it can return is slightly under 4 MB. If "
5875 "the requested file is larger than this then you will get an error."
5880 #: ../src/guestfs.pod:2779
5882 "In order to transfer large files into and out of the guest filesystem, you "
5883 "need to use particular calls that support this. The sections L</UPLOADING> "
5884 "and L</DOWNLOADING> document how to do this."
5889 #: ../src/guestfs.pod:2783
5891 "You might also consider mounting the disk image using our FUSE filesystem "
5892 "support (L<guestmount(1)>)."
5896 #: ../src/guestfs.pod:2786
5897 msgid "MAXIMUM NUMBER OF DISKS"
5901 #: ../src/guestfs.pod:2788
5902 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5906 #: ../src/guestfs.pod:2791
5908 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5909 "slots. However febootstrap only understands disks with names C</dev/vda> "
5910 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5915 #: ../src/guestfs.pod:2796
5917 "We are working to substantially raise this limit in future versions but it "
5918 "requires complex changes to qemu."
5922 #: ../src/guestfs.pod:2799
5924 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5925 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5926 "requires changes to qemu."
5930 #: ../src/guestfs.pod:2803
5931 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5935 #: ../src/guestfs.pod:2805
5936 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5940 #: ../src/guestfs.pod:2807
5942 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5943 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5947 #: ../src/guestfs.pod:2810
5949 "If you attach a disk with more than 15 partitions, the extra partitions are "
5950 "ignored by libguestfs."
5954 #: ../src/guestfs.pod:2813
5955 msgid "MAXIMUM SIZE OF A DISK"
5959 #: ../src/guestfs.pod:2815
5960 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5964 #: ../src/guestfs.pod:2817
5966 "We have tested block devices up to 1 exabyte (2**60 or "
5967 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5972 #: ../src/guestfs.pod:2821
5974 "Although libguestfs probably does not impose any limit, the underlying host "
5975 "storage will. If you store disk images on a host ext4 filesystem, then the "
5976 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5977 "TB). If you store disk images as host logical volumes then you are limited "
5978 "by the maximum size of an LV."
5982 #: ../src/guestfs.pod:2827
5984 "For the hugest disk image files, we recommend using XFS on the host for "
5989 #: ../src/guestfs.pod:2830
5990 msgid "MAXIMUM SIZE OF A PARTITION"
5994 #: ../src/guestfs.pod:2832
5996 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5997 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5998 "address a partition located beyond 2 TB on the disk."
6002 #: ../src/guestfs.pod:2836
6004 "It is recommended that you use GPT partitions on disks which are larger than "
6005 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6006 "which are theoretically larger than the largest disk we could support."
6010 #: ../src/guestfs.pod:2841
6011 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6015 #: ../src/guestfs.pod:2843
6017 "This depends on the filesystem type. libguestfs itself does not impose any "
6018 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6019 "what these limits are."
6023 #: ../src/guestfs.pod:2847
6024 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6028 #: ../src/guestfs.pod:2849
6030 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6031 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6032 "uploads and downloads."
6036 #: ../src/guestfs.pod:2853
6037 msgid "INSPECTION LIMITS"
6041 #: ../src/guestfs.pod:2855
6043 "The inspection code has several arbitrary limits on things like the size of "
6044 "Windows Registry hive it will read, and the length of product name. These "
6045 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6046 "memory and disk space on the host, and should not be reached in practice. "
6047 "See the source code for more information."
6052 #: ../src/guestfs.pod:2861 ../fish/guestfish.pod:1015
6053 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
6054 msgid "ENVIRONMENT VARIABLES"
6059 #: ../src/guestfs.pod:2865 ../fish/guestfish.pod:1041
6060 msgid "LIBGUESTFS_APPEND"
6065 #: ../src/guestfs.pod:2867 ../fish/guestfish.pod:1043
6066 msgid "Pass additional options to the guest kernel."
6071 #: ../src/guestfs.pod:2869 ../fish/guestfish.pod:1045
6072 msgid "LIBGUESTFS_DEBUG"
6077 #: ../src/guestfs.pod:2871
6079 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6080 "effect as calling C<guestfs_set_verbose (g, 1)>."
6085 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1050
6086 msgid "LIBGUESTFS_MEMSIZE"
6091 #: ../src/guestfs.pod:2876 ../fish/guestfish.pod:1052
6093 "Set the memory allocated to the qemu process, in megabytes. For example:"
6098 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1055
6101 " LIBGUESTFS_MEMSIZE=700\n"
6107 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1057
6108 msgid "LIBGUESTFS_PATH"
6112 #: ../src/guestfs.pod:2883
6114 "Set the path that libguestfs uses to search for a supermin appliance. See "
6115 "the discussion of paths in section L</PATH> above."
6120 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1062
6121 msgid "LIBGUESTFS_QEMU"
6126 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1064
6128 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6129 "which was found at compile time by the configure script is used."
6134 #: ../src/guestfs.pod:2892
6135 msgid "See also L</QEMU WRAPPERS> above."
6140 #: ../src/guestfs.pod:2894 ../fish/guestfish.pod:1068
6141 msgid "LIBGUESTFS_TRACE"
6146 #: ../src/guestfs.pod:2896
6148 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6149 "effect as calling C<guestfs_set_trace (g, 1)>."
6154 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1077
6159 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1079
6161 "Location of temporary directory, defaults to C</tmp> except for the cached "
6162 "supermin appliance which defaults to C</var/tmp>."
6166 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1082
6168 "If libguestfs was compiled to use the supermin appliance then the real "
6169 "appliance is cached in this directory, shared between all handles belonging "
6170 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6171 "use in case C</var/tmp> is not large enough."
6176 #: ../src/guestfs.pod:2912 ../fish/guestfish.pod:1149
6177 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
6178 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6179 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6180 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6185 #: ../src/guestfs.pod:2914
6187 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6188 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6189 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6190 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6191 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6192 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6193 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6198 #: ../src/guestfs.pod:2941
6200 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6201 "(8)>, L<disktype(1)>."
6206 #: ../src/guestfs.pod:2948 ../tools/virt-win-reg.pl:587
6207 #: ../tools/virt-make-fs.pl:553
6213 #: ../src/guestfs.pod:2950
6214 msgid "To get a list of bugs against libguestfs use this link:"
6219 #: ../src/guestfs.pod:2952
6221 "L<https://bugzilla.redhat.com/buglist.cgi?"
6222 "component=libguestfs&product=Virtualization+Tools>"
6227 #: ../src/guestfs.pod:2954
6228 msgid "To report a new bug against libguestfs use this link:"
6233 #: ../src/guestfs.pod:2956
6235 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6236 "component=libguestfs&product=Virtualization+Tools>"
6241 #: ../src/guestfs.pod:2958
6242 msgid "When reporting a bug, please check:"
6247 #: ../src/guestfs.pod:2964
6248 msgid "That the bug hasn't been reported already."
6253 #: ../src/guestfs.pod:2968
6254 msgid "That you are testing a recent version."
6259 #: ../src/guestfs.pod:2972
6260 msgid "Describe the bug accurately, and give a way to reproduce it."
6265 #: ../src/guestfs.pod:2976
6267 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6273 #: ../src/guestfs.pod:2981 ../fish/guestfish.pod:1172
6274 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
6280 #: ../src/guestfs.pod:2983 ../fish/guestfish.pod:1174
6281 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
6282 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6287 #: ../src/guestfs.pod:2985 ../fish/guestfish.pod:1176
6288 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
6289 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6290 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6291 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6296 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1178
6297 #: ../test-tool/libguestfs-test-tool.pod:99
6298 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6303 #: ../src/guestfs.pod:2990
6305 "This library is free software; you can redistribute it and/or modify it "
6306 "under the terms of the GNU Lesser General Public License as published by the "
6307 "Free Software Foundation; either version 2 of the License, or (at your "
6308 "option) any later version."
6313 #: ../src/guestfs.pod:2995
6315 "This library is distributed in the hope that it will be useful, but WITHOUT "
6316 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6317 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6323 #: ../src/guestfs.pod:3000
6325 "You should have received a copy of the GNU Lesser General Public License "
6326 "along with this library; if not, write to the Free Software Foundation, "
6327 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6332 #: ../src/guestfs-actions.pod:1
6333 msgid "guestfs_add_cdrom"
6338 #: ../src/guestfs-actions.pod:3
6342 " guestfs_add_cdrom (guestfs_h *g,\n"
6343 " const char *filename);\n"
6349 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6350 msgid "This function adds a virtual CD-ROM disk image to the guest."
6354 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6355 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6360 #: ../src/guestfs-actions.pod:17
6362 "This call checks for the existence of C<filename>. This stops you from "
6363 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6364 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6370 #: ../src/guestfs-actions.pod:24
6372 "If you just want to add an ISO file (often you use this as an efficient way "
6373 "to transfer large files into the guest), then you should probably use "
6374 "C<guestfs_add_drive_ro> instead."
6379 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6380 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6381 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6382 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6383 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6384 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6385 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6386 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6387 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6388 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6389 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6390 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6391 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6392 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6393 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6394 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6395 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6396 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6397 #: ../src/guestfs-actions.pod:1692 ../src/guestfs-actions.pod:1714
6398 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:2263
6399 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2468
6400 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3456
6401 #: ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3496
6402 #: ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3665
6403 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692
6404 #: ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3743
6405 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3835
6406 #: ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875
6407 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930
6408 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:3968
6409 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4015
6410 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4067
6411 #: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095
6412 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4205
6413 #: ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4238
6414 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4307
6415 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4341
6416 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4369
6417 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4401
6418 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4479
6419 #: ../src/guestfs-actions.pod:4552 ../src/guestfs-actions.pod:4583
6420 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4621
6421 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4650
6422 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4678
6423 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4728
6424 #: ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4770
6425 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4801
6426 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4887
6427 #: ../src/guestfs-actions.pod:4901 ../src/guestfs-actions.pod:4929
6428 #: ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4964
6429 #: ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5155
6430 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5195
6431 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5293
6432 #: ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5323
6433 #: ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:5626
6434 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5664
6435 #: ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5688
6436 #: ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5714
6437 #: ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5744
6438 #: ../src/guestfs-actions.pod:5765 ../src/guestfs-actions.pod:5784
6439 #: ../src/guestfs-actions.pod:5803 ../src/guestfs-actions.pod:5833
6440 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5872
6441 #: ../src/guestfs-actions.pod:5890 ../src/guestfs-actions.pod:5909
6442 #: ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5949
6443 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5994
6444 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6037
6445 #: ../src/guestfs-actions.pod:6061 ../src/guestfs-actions.pod:6080
6446 #: ../src/guestfs-actions.pod:6095 ../src/guestfs-actions.pod:6114
6447 #: ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6181
6448 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6336
6449 #: ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6469
6450 #: ../src/guestfs-actions.pod:6482 ../src/guestfs-actions.pod:6495
6451 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6530
6452 #: ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6556
6453 #: ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6630
6454 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6663
6455 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6696
6456 #: ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6729
6457 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6779
6458 #: ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:6833
6459 #: ../src/guestfs-actions.pod:6851 ../src/guestfs-actions.pod:6885
6460 #: ../src/guestfs-actions.pod:6921 ../src/guestfs-actions.pod:7040
6461 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7072
6462 #: ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7140
6463 #: ../src/guestfs-actions.pod:7185 ../src/guestfs-actions.pod:7218
6464 #: ../src/guestfs-actions.pod:7279 ../src/guestfs-actions.pod:7305
6465 #: ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7390
6466 #: ../src/guestfs-actions.pod:7419
6467 msgid "This function returns 0 on success or -1 on error."
6472 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6473 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6474 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6476 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6482 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6483 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6484 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962
6485 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4733
6486 #: ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6189
6487 #: ../src/guestfs-actions.pod:6222 ../src/guestfs-actions.pod:6281
6488 #: ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7313
6489 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:31
6490 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6491 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1316
6492 #: ../fish/guestfish-actions.pod:1330 ../fish/guestfish-actions.pod:3005
6493 #: ../fish/guestfish-actions.pod:3202 ../fish/guestfish-actions.pod:4174
6494 #: ../fish/guestfish-actions.pod:4197 ../fish/guestfish-actions.pod:4219
6495 #: ../fish/guestfish-actions.pod:4257 ../fish/guestfish-actions.pod:4898
6496 #: ../fish/guestfish-actions.pod:4995
6498 "Deprecated functions will not be removed from the API, but the fact that "
6499 "they are deprecated indicates that there are problems with correct use of "
6505 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6506 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1913
6507 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2114
6508 #: ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3478
6509 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5851
6510 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:6082
6511 #: ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6698
6512 #: ../src/guestfs-actions.pod:7227
6513 msgid "(Added in 0.3)"
6518 #: ../src/guestfs-actions.pod:41
6519 msgid "guestfs_add_domain"
6524 #: ../src/guestfs-actions.pod:43
6528 " guestfs_add_domain (guestfs_h *g,\n"
6529 " const char *dom,\n"
6536 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6537 #: ../src/guestfs-actions.pod:4440
6539 "You may supply a list of optional arguments to this call. Use zero or more "
6540 "of the following pairs of parameters, and terminate the list with C<-1> on "
6541 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6545 #: ../src/guestfs-actions.pod:53
6548 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6549 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6550 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6551 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6557 #: ../src/guestfs-actions.pod:58
6559 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6560 "It works by connecting to libvirt, requesting the domain and domain XML from "
6561 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6567 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6569 "The number of disks added is returned. This operation is atomic: if an "
6570 "error is returned, then no disks are added."
6575 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6577 "This function does some minimal checks to make sure the libvirt domain is "
6578 "not running (unless C<readonly> is true). In a future version we will try "
6579 "to acquire the libvirt lock on each disk."
6584 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6586 "Disks must be accessible locally. This often means that adding disks from a "
6587 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6588 "unless those disks are accessible via the same device path locally too."
6592 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6594 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6595 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6596 "libvirt URI (or one set through an environment variable, see the libvirt "
6597 "documentation for full details)."
6601 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6603 "The optional C<live> flag controls whether this call will try to connect to "
6604 "a running virtual machine C<guestfsd> process if it sees a suitable "
6605 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6606 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6607 "DAEMONS> for more information."
6612 #: ../src/guestfs-actions.pod:88
6614 "The other optional parameters are passed directly through to "
6615 "C<guestfs_add_drive_opts>."
6620 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6621 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6622 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6623 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6624 #: ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1874
6625 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2023
6626 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2101
6627 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2777
6628 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:4873
6629 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5407
6630 #: ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:6806
6631 #: ../src/guestfs-actions.pod:7238 ../src/guestfs-actions.pod:7251
6632 #: ../src/guestfs-actions.pod:7264
6633 msgid "On error this function returns -1."
6638 #: ../src/guestfs-actions.pod:93
6639 msgid "(Added in 1.7.4)"
6644 #: ../src/guestfs-actions.pod:95
6645 msgid "guestfs_add_domain_va"
6650 #: ../src/guestfs-actions.pod:97
6654 " guestfs_add_domain_va (guestfs_h *g,\n"
6655 " const char *dom,\n"
6662 #: ../src/guestfs-actions.pod:102
6663 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6668 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6669 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6670 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4505
6671 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6676 #: ../src/guestfs-actions.pod:106
6677 msgid "guestfs_add_domain_argv"
6682 #: ../src/guestfs-actions.pod:108
6686 " guestfs_add_domain_argv (guestfs_h *g,\n"
6687 " const char *dom,\n"
6688 " const struct guestfs_add_domain_argv *optargs);\n"
6694 #: ../src/guestfs-actions.pod:113
6695 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6700 #: ../src/guestfs-actions.pod:117
6701 msgid "guestfs_add_drive"
6706 #: ../src/guestfs-actions.pod:119
6710 " guestfs_add_drive (guestfs_h *g,\n"
6711 " const char *filename);\n"
6717 #: ../src/guestfs-actions.pod:123
6719 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6720 "optional parameters, so the disk is added writable, with the format being "
6721 "detected automatically."
6726 #: ../src/guestfs-actions.pod:127
6728 "Automatic detection of the format opens you up to a potential security hole "
6729 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6730 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6731 "you should think about replacing calls to this function with calls to "
6732 "C<guestfs_add_drive_opts>, and specifying the format."
6737 #: ../src/guestfs-actions.pod:138
6738 msgid "guestfs_add_drive_opts"
6743 #: ../src/guestfs-actions.pod:140
6747 " guestfs_add_drive_opts (guestfs_h *g,\n"
6748 " const char *filename,\n"
6755 #: ../src/guestfs-actions.pod:150
6758 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6759 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6760 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6766 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6768 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6769 "The first time you call this function, the disk appears as C</dev/sda>, the "
6770 "second time as C</dev/sdb>, and so on."
6775 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6777 "You don't necessarily need to be root when using libguestfs. However you "
6778 "obviously do need sufficient permissions to access the filename for whatever "
6779 "operations you want to perform (ie. read access if you just want to read the "
6780 "image or write access if you want to modify the image)."
6785 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6786 msgid "This call checks that C<filename> exists."
6791 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4451
6792 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3016
6793 msgid "The optional arguments are:"
6798 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6804 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6806 "If true then the image is treated as read-only. Writes are still allowed, "
6807 "but they are stored in a temporary snapshot overlay which is discarded at "
6808 "the end. The disk that you add is not modified."
6813 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6819 #: ../src/guestfs-actions.pod:179
6821 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6822 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6823 "Possible formats include C<raw> and C<qcow2>."
6828 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6830 "Automatic detection of the format opens you up to a potential security hole "
6831 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6832 "RHBZ#642934. Specifying the format closes this security hole."
6837 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6843 #: ../src/guestfs-actions.pod:190
6845 "This rarely-used option lets you emulate the behaviour of the deprecated "
6846 "C<guestfs_add_drive_with_if> call (q.v.)"
6851 #: ../src/guestfs-actions.pod:197
6852 msgid "(Added in 1.5.23)"
6857 #: ../src/guestfs-actions.pod:199
6858 msgid "guestfs_add_drive_opts_va"
6863 #: ../src/guestfs-actions.pod:201
6867 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6868 " const char *filename,\n"
6875 #: ../src/guestfs-actions.pod:206
6876 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6881 #: ../src/guestfs-actions.pod:210
6882 msgid "guestfs_add_drive_opts_argv"
6887 #: ../src/guestfs-actions.pod:212
6891 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6892 " const char *filename,\n"
6893 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6899 #: ../src/guestfs-actions.pod:217
6900 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6905 #: ../src/guestfs-actions.pod:221
6906 msgid "guestfs_add_drive_ro"
6911 #: ../src/guestfs-actions.pod:223
6915 " guestfs_add_drive_ro (guestfs_h *g,\n"
6916 " const char *filename);\n"
6922 #: ../src/guestfs-actions.pod:227
6924 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6925 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6926 "disk is added read-only, with the format being detected automatically."
6931 #: ../src/guestfs-actions.pod:234
6932 msgid "(Added in 1.0.38)"
6937 #: ../src/guestfs-actions.pod:236
6938 msgid "guestfs_add_drive_ro_with_if"
6943 #: ../src/guestfs-actions.pod:238
6947 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6948 " const char *filename,\n"
6949 " const char *iface);\n"
6955 #: ../src/guestfs-actions.pod:243
6957 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6958 "QEMU interface emulation to use at run time."
6963 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6964 #: ../src/guestfs-actions.pod:2353
6965 msgid "(Added in 1.0.84)"
6970 #: ../src/guestfs-actions.pod:257
6971 msgid "guestfs_add_drive_with_if"
6976 #: ../src/guestfs-actions.pod:259
6980 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6981 " const char *filename,\n"
6982 " const char *iface);\n"
6988 #: ../src/guestfs-actions.pod:264
6990 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6991 "QEMU interface emulation to use at run time."
6996 #: ../src/guestfs-actions.pod:278
6997 msgid "guestfs_aug_clear"
7002 #: ../src/guestfs-actions.pod:280
7006 " guestfs_aug_clear (guestfs_h *g,\n"
7007 " const char *augpath);\n"
7013 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
7015 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7016 "L<augtool(1)> C<clear> command."
7021 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2103
7022 msgid "(Added in 1.3.4)"
7027 #: ../src/guestfs-actions.pod:291
7028 msgid "guestfs_aug_close"
7033 #: ../src/guestfs-actions.pod:293
7037 " guestfs_aug_close (guestfs_h *g);\n"
7043 #: ../src/guestfs-actions.pod:296
7045 "Close the current Augeas handle and free up any resources used by it. After "
7046 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7047 "any other Augeas functions."
7052 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
7053 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
7054 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
7055 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
7056 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
7057 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
7058 #: ../src/guestfs-actions.pod:5484
7059 msgid "(Added in 0.7)"
7064 #: ../src/guestfs-actions.pod:305
7065 msgid "guestfs_aug_defnode"
7070 #: ../src/guestfs-actions.pod:307
7073 " struct guestfs_int_bool *\n"
7074 " guestfs_aug_defnode (guestfs_h *g,\n"
7075 " const char *name,\n"
7076 " const char *expr,\n"
7077 " const char *val);\n"
7083 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
7085 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7090 #: ../src/guestfs-actions.pod:316
7092 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7093 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7094 "containing that single node."
7099 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
7101 "On success this returns a pair containing the number of nodes in the "
7102 "nodeset, and a boolean flag if a node was created."
7107 #: ../src/guestfs-actions.pod:324
7109 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7110 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7115 #: ../src/guestfs-actions.pod:330
7116 msgid "guestfs_aug_defvar"
7121 #: ../src/guestfs-actions.pod:332
7125 " guestfs_aug_defvar (guestfs_h *g,\n"
7126 " const char *name,\n"
7127 " const char *expr);\n"
7133 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
7135 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7136 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7141 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
7143 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7144 "evaluates to something which is not a nodeset."
7149 #: ../src/guestfs-actions.pod:348
7150 msgid "guestfs_aug_get"
7155 #: ../src/guestfs-actions.pod:350
7159 " guestfs_aug_get (guestfs_h *g,\n"
7160 " const char *augpath);\n"
7166 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7168 "Look up the value associated with C<path>. If C<path> matches exactly one "
7169 "node, the C<value> is returned."
7174 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7175 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7176 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7177 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7178 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7179 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1654
7180 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1834
7181 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:1935
7182 #: ../src/guestfs-actions.pod:1956 ../src/guestfs-actions.pod:2126
7183 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2525
7184 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
7185 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:2869
7186 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2924
7187 #: ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3021
7188 #: ../src/guestfs-actions.pod:3044 ../src/guestfs-actions.pod:3065
7189 #: ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3987
7190 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4267
7191 #: ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5212
7192 #: ../src/guestfs-actions.pod:5382 ../src/guestfs-actions.pod:5560
7193 #: ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:6242
7194 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6275
7195 #: ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6980
7196 #: ../src/guestfs-actions.pod:6999 ../src/guestfs-actions.pod:7017
7197 #: ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7476
7199 "This function returns a string, or NULL on error. I<The caller must free "
7200 "the returned string after use>."
7205 #: ../src/guestfs-actions.pod:362
7206 msgid "guestfs_aug_init"
7211 #: ../src/guestfs-actions.pod:364
7215 " guestfs_aug_init (guestfs_h *g,\n"
7216 " const char *root,\n"
7223 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7225 "Create a new Augeas handle for editing configuration files. If there was "
7226 "any previous Augeas handle associated with this guestfs session, then it is "
7232 #: ../src/guestfs-actions.pod:373
7233 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7238 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7240 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7245 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7247 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7248 "logical I<or> of the following integers:"
7253 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7254 msgid "C<AUG_SAVE_BACKUP> = 1"
7259 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7260 msgid "Keep the original file with a C<.augsave> extension."
7265 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7266 msgid "C<AUG_SAVE_NEWFILE> = 2"
7271 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7273 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7274 "original. Overrides C<AUG_SAVE_BACKUP>."
7279 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7280 msgid "C<AUG_TYPE_CHECK> = 4"
7285 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7286 msgid "Typecheck lenses (can be expensive)."
7291 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7292 msgid "C<AUG_NO_STDINC> = 8"
7297 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7298 msgid "Do not use standard load path for modules."
7303 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7304 msgid "C<AUG_SAVE_NOOP> = 16"
7309 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7310 msgid "Make save a no-op, just record what would have been changed."
7315 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7316 msgid "C<AUG_NO_LOAD> = 32"
7321 #: ../src/guestfs-actions.pod:408
7322 msgid "Do not load the tree in C<guestfs_aug_init>."
7327 #: ../src/guestfs-actions.pod:412
7328 msgid "To close the handle, you can call C<guestfs_aug_close>."
7333 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7334 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7339 #: ../src/guestfs-actions.pod:420
7340 msgid "guestfs_aug_insert"
7345 #: ../src/guestfs-actions.pod:422
7349 " guestfs_aug_insert (guestfs_h *g,\n"
7350 " const char *augpath,\n"
7351 " const char *label,\n"
7358 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7360 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7361 "or after C<path> (depending on the boolean flag C<before>)."
7366 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7368 "C<path> must match exactly one existing node in the tree, and C<label> must "
7369 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7374 #: ../src/guestfs-actions.pod:440
7375 msgid "guestfs_aug_load"
7380 #: ../src/guestfs-actions.pod:442
7384 " guestfs_aug_load (guestfs_h *g);\n"
7390 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7391 msgid "Load files into the tree."
7396 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7397 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7402 #: ../src/guestfs-actions.pod:454
7403 msgid "guestfs_aug_ls"
7408 #: ../src/guestfs-actions.pod:456
7412 " guestfs_aug_ls (guestfs_h *g,\n"
7413 " const char *augpath);\n"
7419 #: ../src/guestfs-actions.pod:460
7421 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7422 "sorting the resulting nodes into alphabetical order."
7427 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7428 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7429 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7430 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7431 #: ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:2198
7432 #: ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2233
7433 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2300
7434 #: ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2420
7435 #: ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2978
7436 #: ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3557
7437 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3724
7438 #: ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4834
7439 #: ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5480
7440 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6322
7441 #: ../src/guestfs-actions.pod:6383 ../src/guestfs-actions.pod:6438
7442 #: ../src/guestfs-actions.pod:6584 ../src/guestfs-actions.pod:6608
7443 #: ../src/guestfs-actions.pod:7090 ../src/guestfs-actions.pod:7110
7444 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7329
7445 #: ../src/guestfs-actions.pod:7348 ../src/guestfs-actions.pod:7433
7446 #: ../src/guestfs-actions.pod:7452 ../src/guestfs-actions.pod:7498
7447 #: ../src/guestfs-actions.pod:7517
7449 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7450 ">), or NULL if there was an error. I<The caller must free the strings and "
7451 "the array after use>."
7456 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7457 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7458 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3376
7459 #: ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4020
7460 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4240
7461 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4838
7462 #: ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5690
7463 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5716
7464 #: ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6822
7465 #: ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:7074
7466 #: ../src/guestfs-actions.pod:7317
7467 msgid "(Added in 0.8)"
7472 #: ../src/guestfs-actions.pod:469
7473 msgid "guestfs_aug_match"
7478 #: ../src/guestfs-actions.pod:471
7482 " guestfs_aug_match (guestfs_h *g,\n"
7483 " const char *augpath);\n"
7489 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7491 "Returns a list of paths which match the path expression C<path>. The "
7492 "returned paths are sufficiently qualified so that they match exactly one "
7493 "node in the current tree."
7498 #: ../src/guestfs-actions.pod:485
7499 msgid "guestfs_aug_mv"
7504 #: ../src/guestfs-actions.pod:487
7508 " guestfs_aug_mv (guestfs_h *g,\n"
7509 " const char *src,\n"
7510 " const char *dest);\n"
7516 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7518 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7519 "C<dest> is overwritten if it exists."
7524 #: ../src/guestfs-actions.pod:499
7525 msgid "guestfs_aug_rm"
7530 #: ../src/guestfs-actions.pod:501
7534 " guestfs_aug_rm (guestfs_h *g,\n"
7535 " const char *augpath);\n"
7541 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7542 msgid "Remove C<path> and all of its children."
7547 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7548 msgid "On success this returns the number of entries which were removed."
7553 #: ../src/guestfs-actions.pod:513
7554 msgid "guestfs_aug_save"
7559 #: ../src/guestfs-actions.pod:515
7563 " guestfs_aug_save (guestfs_h *g);\n"
7569 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7570 msgid "This writes all pending changes to disk."
7575 #: ../src/guestfs-actions.pod:520
7577 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7583 #: ../src/guestfs-actions.pod:527
7584 msgid "guestfs_aug_set"
7589 #: ../src/guestfs-actions.pod:529
7593 " guestfs_aug_set (guestfs_h *g,\n"
7594 " const char *augpath,\n"
7595 " const char *val);\n"
7601 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7602 msgid "Set the value associated with C<path> to C<val>."
7607 #: ../src/guestfs-actions.pod:536
7609 "In the Augeas API, it is possible to clear a node by setting the value to "
7610 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7611 "this call. Instead you must use the C<guestfs_aug_clear> call."
7616 #: ../src/guestfs-actions.pod:545
7617 msgid "guestfs_available"
7622 #: ../src/guestfs-actions.pod:547
7626 " guestfs_available (guestfs_h *g,\n"
7627 " char *const *groups);\n"
7633 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7635 "This command is used to check the availability of some groups of "
7636 "functionality in the appliance, which not all builds of the libguestfs "
7637 "appliance will be able to provide."
7642 #: ../src/guestfs-actions.pod:555
7644 "The libguestfs groups, and the functions that those groups correspond to, "
7645 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7646 "runtime by calling C<guestfs_available_all_groups>."
7651 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7653 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7654 "\"]> would check for the availability of the Linux inotify functions and "
7655 "Augeas (configuration file editing) functions."
7660 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7661 msgid "The command returns no error if I<all> requested groups are available."
7666 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7668 "It fails with an error if one or more of the requested groups is unavailable "
7674 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7676 "If an unknown group name is included in the list of groups then an error is "
7682 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7688 #: ../src/guestfs-actions.pod:579
7689 msgid "You must call C<guestfs_launch> before calling this function."
7694 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7696 "The reason is because we don't know what groups are supported by the "
7697 "appliance/daemon until it is running and can be queried."
7702 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7704 "If a group of functions is available, this does not necessarily mean that "
7705 "they will work. You still have to check for errors when calling individual "
7706 "API functions even if they are available."
7711 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7713 "It is usually the job of distro packagers to build complete functionality "
7714 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7715 "with all requirements satisfied, will support everything."
7720 #: ../src/guestfs-actions.pod:601
7722 "This call was added in version C<1.0.80>. In previous versions of "
7723 "libguestfs all you could do would be to speculatively execute a command to "
7724 "find out if the daemon implemented it. See also C<guestfs_version>."
7729 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7730 msgid "(Added in 1.0.80)"
7735 #: ../src/guestfs-actions.pod:612
7736 msgid "guestfs_available_all_groups"
7741 #: ../src/guestfs-actions.pod:614
7745 " guestfs_available_all_groups (guestfs_h *g);\n"
7751 #: ../src/guestfs-actions.pod:617
7753 "This command returns a list of all optional groups that this daemon knows "
7754 "about. Note this returns both supported and unsupported groups. To find "
7755 "out which ones the daemon can actually support you have to call "
7756 "C<guestfs_available> on each member of the returned list."
7761 #: ../src/guestfs-actions.pod:623
7762 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7767 #: ../src/guestfs-actions.pod:629
7768 msgid "(Added in 1.3.15)"
7773 #: ../src/guestfs-actions.pod:631
7774 msgid "guestfs_base64_in"
7779 #: ../src/guestfs-actions.pod:633
7783 " guestfs_base64_in (guestfs_h *g,\n"
7784 " const char *base64file,\n"
7785 " const char *filename);\n"
7791 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7793 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7798 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7799 msgid "(Added in 1.3.5)"
7804 #: ../src/guestfs-actions.pod:645
7805 msgid "guestfs_base64_out"
7810 #: ../src/guestfs-actions.pod:647
7814 " guestfs_base64_out (guestfs_h *g,\n"
7815 " const char *filename,\n"
7816 " const char *base64file);\n"
7822 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7824 "This command downloads the contents of C<filename>, writing it out to local "
7825 "file C<base64file> encoded as base64."
7830 #: ../src/guestfs-actions.pod:659
7831 msgid "guestfs_blockdev_flushbufs"
7836 #: ../src/guestfs-actions.pod:661
7840 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7841 " const char *device);\n"
7847 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7849 "This tells the kernel to flush internal buffers associated with C<device>."
7854 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7855 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7856 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7857 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7858 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7859 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7860 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7861 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7862 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7863 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7864 msgid "This uses the L<blockdev(8)> command."
7869 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7870 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7871 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7872 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7873 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7874 msgid "(Added in 0.9.3)"
7879 #: ../src/guestfs-actions.pod:674
7880 msgid "guestfs_blockdev_getbsz"
7885 #: ../src/guestfs-actions.pod:676
7889 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7890 " const char *device);\n"
7896 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7897 msgid "This returns the block size of a device."
7902 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7903 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7905 "(Note this is different from both I<size in blocks> and I<filesystem block "
7911 #: ../src/guestfs-actions.pod:691
7912 msgid "guestfs_blockdev_getro"
7917 #: ../src/guestfs-actions.pod:693
7921 " guestfs_blockdev_getro (guestfs_h *g,\n"
7922 " const char *device);\n"
7928 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7930 "Returns a boolean indicating if the block device is read-only (true if read-"
7931 "only, false if not)."
7936 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7937 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1911
7938 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1994
7939 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2064
7940 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:2112
7941 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
7942 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3284
7943 #: ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3313
7944 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3343
7945 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3374
7946 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3401
7947 #: ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3430
7948 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:4983
7949 msgid "This function returns a C truth value on success or -1 on error."
7954 #: ../src/guestfs-actions.pod:706
7955 msgid "guestfs_blockdev_getsize64"
7960 #: ../src/guestfs-actions.pod:708
7964 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7965 " const char *device);\n"
7971 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7972 msgid "This returns the size of the device in bytes."
7977 #: ../src/guestfs-actions.pod:714
7978 msgid "See also C<guestfs_blockdev_getsz>."
7983 #: ../src/guestfs-actions.pod:722
7984 msgid "guestfs_blockdev_getss"
7989 #: ../src/guestfs-actions.pod:724
7993 " guestfs_blockdev_getss (guestfs_h *g,\n"
7994 " const char *device);\n"
8000 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
8002 "This returns the size of sectors on a block device. Usually 512, but can be "
8003 "larger for modern devices."
8008 #: ../src/guestfs-actions.pod:731
8010 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8016 #: ../src/guestfs-actions.pod:740
8017 msgid "guestfs_blockdev_getsz"
8022 #: ../src/guestfs-actions.pod:742
8026 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8027 " const char *device);\n"
8033 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
8035 "This returns the size of the device in units of 512-byte sectors (even if "
8036 "the sectorsize isn't 512 bytes ... weird)."
8041 #: ../src/guestfs-actions.pod:749
8043 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8044 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8049 #: ../src/guestfs-actions.pod:759
8050 msgid "guestfs_blockdev_rereadpt"
8055 #: ../src/guestfs-actions.pod:761
8059 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8060 " const char *device);\n"
8066 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
8067 msgid "Reread the partition table on C<device>."
8072 #: ../src/guestfs-actions.pod:773
8073 msgid "guestfs_blockdev_setbsz"
8078 #: ../src/guestfs-actions.pod:775
8082 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8083 " const char *device,\n"
8084 " int blocksize);\n"
8090 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
8091 msgid "This sets the block size of a device."
8096 #: ../src/guestfs-actions.pod:791
8097 msgid "guestfs_blockdev_setro"
8102 #: ../src/guestfs-actions.pod:793
8106 " guestfs_blockdev_setro (guestfs_h *g,\n"
8107 " const char *device);\n"
8113 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
8114 msgid "Sets the block device named C<device> to read-only."
8119 #: ../src/guestfs-actions.pod:805
8120 msgid "guestfs_blockdev_setrw"
8125 #: ../src/guestfs-actions.pod:807
8129 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8130 " const char *device);\n"
8136 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
8137 msgid "Sets the block device named C<device> to read-write."
8142 #: ../src/guestfs-actions.pod:819
8143 msgid "guestfs_case_sensitive_path"
8148 #: ../src/guestfs-actions.pod:821
8152 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8153 " const char *path);\n"
8159 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
8161 "This can be used to resolve case insensitive paths on a filesystem which is "
8162 "case sensitive. The use case is to resolve paths which you have read from "
8163 "Windows configuration files or the Windows Registry, to the true path."
8168 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8170 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8171 "(and probably others), which is that although the underlying filesystem is "
8172 "case-insensitive, the driver exports the filesystem to Linux as case-"
8178 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8180 "One consequence of this is that special directories such as C<c:\\windows> "
8181 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8182 "precise details of how they were created. In Windows itself this would not "
8188 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8190 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8196 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8198 "This function resolves the true case of each element in the path and returns "
8199 "the case-sensitive path."
8204 #: ../src/guestfs-actions.pod:847
8206 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8207 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8208 "how the directories were originally created under Windows)."
8213 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8214 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8219 #: ../src/guestfs-actions.pod:855
8220 msgid "See also C<guestfs_realpath>."
8225 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:7002
8226 msgid "(Added in 1.0.75)"
8231 #: ../src/guestfs-actions.pod:862
8237 #: ../src/guestfs-actions.pod:864
8241 " guestfs_cat (guestfs_h *g,\n"
8242 " const char *path);\n"
8248 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5470
8249 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3671
8250 msgid "Return the contents of the file named C<path>."
8255 #: ../src/guestfs-actions.pod:870
8257 "Note that this function cannot correctly handle binary files (specifically, "
8258 "files containing C<\\0> character which is treated as end of string). For "
8259 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8260 "functions which have a more complex interface."
8265 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8266 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8267 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8268 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1760
8269 #: ../src/guestfs-actions.pod:2218 ../src/guestfs-actions.pod:2237
8270 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304
8271 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2350
8272 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278
8273 #: ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5435
8274 #: ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:6387
8275 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6588
8276 #: ../src/guestfs-actions.pod:6612 ../src/guestfs-actions.pod:7281
8277 #: ../src/guestfs-actions.pod:7307 ../src/guestfs-actions.pod:7333
8278 #: ../src/guestfs-actions.pod:7352 ../src/guestfs-actions.pod:7437
8279 #: ../src/guestfs-actions.pod:7456 ../src/guestfs-actions.pod:7502
8280 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:587
8281 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8282 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8283 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8284 #: ../fish/guestfish-actions.pod:1189 ../fish/guestfish-actions.pod:1490
8285 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1528
8286 #: ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1553
8287 #: ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:3541
8288 #: ../fish/guestfish-actions.pod:3556 ../fish/guestfish-actions.pod:3632
8289 #: ../fish/guestfish-actions.pod:3649 ../fish/guestfish-actions.pod:3664
8290 #: ../fish/guestfish-actions.pod:4318 ../fish/guestfish-actions.pod:4364
8291 #: ../fish/guestfish-actions.pod:4449 ../fish/guestfish-actions.pod:4464
8292 #: ../fish/guestfish-actions.pod:4874 ../fish/guestfish-actions.pod:4892
8293 #: ../fish/guestfish-actions.pod:4909 ../fish/guestfish-actions.pod:4919
8294 #: ../fish/guestfish-actions.pod:4967 ../fish/guestfish-actions.pod:4977
8295 #: ../fish/guestfish-actions.pod:5006 ../fish/guestfish-actions.pod:5016
8297 "Because of the message protocol, there is a transfer limit of somewhere "
8298 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8303 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3561
8304 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3640
8305 #: ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4133
8306 #: ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:5358
8307 #: ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:7161
8308 #: ../src/guestfs-actions.pod:7175
8309 msgid "(Added in 0.4)"
8314 #: ../src/guestfs-actions.pod:883
8315 msgid "guestfs_checksum"
8320 #: ../src/guestfs-actions.pod:885
8324 " guestfs_checksum (guestfs_h *g,\n"
8325 " const char *csumtype,\n"
8326 " const char *path);\n"
8332 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8334 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8339 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8341 "The type of checksum to compute is given by the C<csumtype> parameter which "
8342 "must have one of the following values:"
8347 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8353 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8355 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8361 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8367 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8368 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8373 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8379 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8380 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8385 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8391 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8392 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8397 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8403 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8404 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8409 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8415 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8416 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8421 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8427 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8428 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8433 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8434 msgid "The checksum is returned as a printable string."
8439 #: ../src/guestfs-actions.pod:931
8440 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8445 #: ../src/guestfs-actions.pod:933
8446 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8451 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8452 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:3300
8453 #: ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3390
8454 #: ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:6858
8455 msgid "(Added in 1.0.2)"
8460 #: ../src/guestfs-actions.pod:940
8461 msgid "guestfs_checksum_device"
8466 #: ../src/guestfs-actions.pod:942
8470 " guestfs_checksum_device (guestfs_h *g,\n"
8471 " const char *csumtype,\n"
8472 " const char *device);\n"
8478 #: ../src/guestfs-actions.pod:947
8480 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8481 "device named C<device>. For the types of checksums supported see the "
8482 "C<guestfs_checksum> command."
8487 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4889
8488 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4985
8489 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5179
8490 #: ../src/guestfs-actions.pod:6767 ../src/guestfs-actions.pod:6781
8491 #: ../src/guestfs-actions.pod:7187
8492 msgid "(Added in 1.3.2)"
8497 #: ../src/guestfs-actions.pod:956
8498 msgid "guestfs_checksums_out"
8503 #: ../src/guestfs-actions.pod:958
8507 " guestfs_checksums_out (guestfs_h *g,\n"
8508 " const char *csumtype,\n"
8509 " const char *directory,\n"
8510 " const char *sumsfile);\n"
8516 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8518 "This command computes the checksums of all regular files in C<directory> and "
8519 "then emits a list of those checksums to the local output file C<sumsfile>."
8524 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8526 "This can be used for verifying the integrity of a virtual machine. However "
8527 "to be properly secure you should pay attention to the output of the checksum "
8528 "command (it uses the ones from GNU coreutils). In particular when the "
8529 "filename is not printable, coreutils uses a special backslash syntax. For "
8530 "more information, see the GNU coreutils info file."
8535 #: ../src/guestfs-actions.pod:978
8536 msgid "(Added in 1.3.7)"
8541 #: ../src/guestfs-actions.pod:980
8542 msgid "guestfs_chmod"
8547 #: ../src/guestfs-actions.pod:982
8551 " guestfs_chmod (guestfs_h *g,\n"
8553 " const char *path);\n"
8559 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8561 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8567 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8569 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8570 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8576 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4384
8577 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4600
8578 #: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:676
8579 #: ../fish/guestfish-actions.pod:2980 ../fish/guestfish-actions.pod:3109
8580 #: ../fish/guestfish-actions.pod:3119 ../fish/guestfish-actions.pod:3129
8581 msgid "The mode actually set is affected by the umask."
8586 #: ../src/guestfs-actions.pod:1000
8587 msgid "guestfs_chown"
8592 #: ../src/guestfs-actions.pod:1002
8596 " guestfs_chown (guestfs_h *g,\n"
8599 " const char *path);\n"
8605 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8606 msgid "Change the file owner to C<owner> and group to C<group>."
8611 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3492
8612 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2438
8614 "Only numeric uid and gid are supported. If you want to use names, you will "
8615 "need to locate and parse the password file yourself (Augeas support makes "
8616 "this relatively easy)."
8621 #: ../src/guestfs-actions.pod:1018
8622 msgid "guestfs_command"
8627 #: ../src/guestfs-actions.pod:1020
8631 " guestfs_command (guestfs_h *g,\n"
8632 " char *const *arguments);\n"
8638 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8640 "This call runs a command from the guest filesystem. The filesystem must be "
8641 "mounted, and must contain a compatible operating system (ie. something "
8642 "Linux, with the same or compatible processor architecture)."
8647 #: ../src/guestfs-actions.pod:1029
8649 "The single parameter is an argv-style list of arguments. The first element "
8650 "is the name of the program to run. Subsequent elements are parameters. The "
8651 "list must be non-empty (ie. must contain a program name). Note that the "
8652 "command runs directly, and is I<not> invoked via the shell (see "
8658 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8659 msgid "The return value is anything printed to I<stdout> by the command."
8664 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8666 "If the command returns a non-zero exit status, then this function returns an "
8667 "error message. The error message string is the content of I<stderr> from "
8673 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8675 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8676 "bin>. If you require a program from another location, you should provide "
8677 "the full path in the first parameter."
8682 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8684 "Shared libraries and data files required by the program must be available on "
8685 "filesystems which are mounted in the correct places. It is the caller's "
8686 "responsibility to ensure all filesystems that are needed are mounted at the "
8692 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8693 #: ../src/guestfs-actions.pod:1545
8694 msgid "(Added in 0.9.1)"
8699 #: ../src/guestfs-actions.pod:1062
8700 msgid "guestfs_command_lines"
8705 #: ../src/guestfs-actions.pod:1064
8709 " guestfs_command_lines (guestfs_h *g,\n"
8710 " char *const *arguments);\n"
8716 #: ../src/guestfs-actions.pod:1068
8718 "This is the same as C<guestfs_command>, but splits the result into a list of "
8724 #: ../src/guestfs-actions.pod:1071
8725 msgid "See also: C<guestfs_sh_lines>"
8730 #: ../src/guestfs-actions.pod:1082
8731 msgid "guestfs_config"
8736 #: ../src/guestfs-actions.pod:1084
8740 " guestfs_config (guestfs_h *g,\n"
8741 " const char *qemuparam,\n"
8742 " const char *qemuvalue);\n"
8747 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8749 "This can be used to add arbitrary qemu command line parameters of the form "
8750 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8751 "setting some parameters which would interfere with parameters that we use."
8756 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8757 msgid "The first character of C<param> string must be a C<-> (dash)."
8762 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8763 msgid "C<value> can be NULL."
8768 #: ../src/guestfs-actions.pod:1102
8769 msgid "guestfs_copy_size"
8774 #: ../src/guestfs-actions.pod:1104
8778 " guestfs_copy_size (guestfs_h *g,\n"
8779 " const char *src,\n"
8780 " const char *dest,\n"
8787 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8789 "This command copies exactly C<size> bytes from one source device or file "
8790 "C<src> to another destination device or file C<dest>."
8795 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8797 "Note this will fail if the source is too short or if the destination is not "
8802 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8803 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8804 #: ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1716
8805 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:6853
8806 #: ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:7373
8807 #: ../src/guestfs-actions.pod:7392
8809 "This long-running command can generate progress notification messages so "
8810 "that the caller can display a progress bar or indicator. To receive these "
8811 "messages, the caller must register a progress event callback. See L<guestfs"
8812 "(3)/GUESTFS_EVENT_PROGRESS>."
8817 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4160
8818 #: ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:7094
8819 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7200
8820 msgid "(Added in 1.0.87)"
8825 #: ../src/guestfs-actions.pod:1125
8831 #: ../src/guestfs-actions.pod:1127
8835 " guestfs_cp (guestfs_h *g,\n"
8836 " const char *src,\n"
8837 " const char *dest);\n"
8843 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8845 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8846 "destination filename or destination directory."
8851 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8852 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8853 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4852
8854 #: ../src/guestfs-actions.pod:5229
8855 msgid "(Added in 1.0.18)"
8860 #: ../src/guestfs-actions.pod:1139
8861 msgid "guestfs_cp_a"
8866 #: ../src/guestfs-actions.pod:1141
8870 " guestfs_cp_a (guestfs_h *g,\n"
8871 " const char *src,\n"
8872 " const char *dest);\n"
8878 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8880 "This copies a file or directory from C<src> to C<dest> recursively using the "
8886 #: ../src/guestfs-actions.pod:1153
8892 #: ../src/guestfs-actions.pod:1155
8896 " guestfs_dd (guestfs_h *g,\n"
8897 " const char *src,\n"
8898 " const char *dest);\n"
8904 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8906 "This command copies from one source device or file C<src> to another "
8907 "destination device or file C<dest>. Normally you would use this to copy to "
8908 "or from a device or partition, for example to duplicate a filesystem."
8913 #: ../src/guestfs-actions.pod:1165
8915 "If the destination is a device, it must be as large or larger than the "
8916 "source file or device, otherwise the copy will fail. This command cannot do "
8917 "partial copies (see C<guestfs_copy_size>)."
8922 #: ../src/guestfs-actions.pod:1173
8928 #: ../src/guestfs-actions.pod:1175
8932 " guestfs_df (guestfs_h *g);\n"
8938 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8939 msgid "This command runs the C<df> command to report disk space used."
8944 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8946 "This command is mostly useful for interactive sessions. It is I<not> "
8947 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8953 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8954 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2283
8955 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2375
8956 #: ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4752
8957 #: ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6615
8958 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7253
8959 #: ../src/guestfs-actions.pod:7266
8960 msgid "(Added in 1.0.54)"
8965 #: ../src/guestfs-actions.pod:1189
8966 msgid "guestfs_df_h"
8971 #: ../src/guestfs-actions.pod:1191
8975 " guestfs_df_h (guestfs_h *g);\n"
8981 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8983 "This command runs the C<df -h> command to report disk space used in human-"
8989 #: ../src/guestfs-actions.pod:1206
8990 msgid "guestfs_dmesg"
8995 #: ../src/guestfs-actions.pod:1208
8999 " guestfs_dmesg (guestfs_h *g);\n"
9005 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
9007 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9008 "This is sometimes useful for extended debugging of problems."
9013 #: ../src/guestfs-actions.pod:1215
9015 "Another way to get the same information is to enable verbose messages with "
9016 "C<guestfs_set_verbose> or by setting the environment variable "
9017 "C<LIBGUESTFS_DEBUG=1> before running the program."
9022 #: ../src/guestfs-actions.pod:1225
9023 msgid "guestfs_download"
9028 #: ../src/guestfs-actions.pod:1227
9032 " guestfs_download (guestfs_h *g,\n"
9033 " const char *remotefilename,\n"
9034 " const char *filename);\n"
9040 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
9041 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
9043 "Download file C<remotefilename> and save it as C<filename> on the local "
9049 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6847
9050 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4622
9051 msgid "C<filename> can also be a named pipe."
9056 #: ../src/guestfs-actions.pod:1237
9057 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9062 #: ../src/guestfs-actions.pod:1248
9063 msgid "guestfs_download_offset"
9068 #: ../src/guestfs-actions.pod:1250
9072 " guestfs_download_offset (guestfs_h *g,\n"
9073 " const char *remotefilename,\n"
9074 " const char *filename,\n"
9075 " int64_t offset,\n"
9082 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
9084 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9085 "region must be within the file or device)."
9090 #: ../src/guestfs-actions.pod:1263
9092 "Note that there is no limit on the amount of data that can be downloaded "
9093 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9094 "full amount unless an error occurs."
9099 #: ../src/guestfs-actions.pod:1268
9100 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9105 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6892
9106 msgid "(Added in 1.5.17)"
9111 #: ../src/guestfs-actions.pod:1279
9112 msgid "guestfs_drop_caches"
9117 #: ../src/guestfs-actions.pod:1281
9121 " guestfs_drop_caches (guestfs_h *g,\n"
9122 " int whattodrop);\n"
9128 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
9130 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9131 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9132 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9137 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
9138 msgid "Setting C<whattodrop> to 3 should drop everything."
9143 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
9145 "This automatically calls L<sync(2)> before the operation, so that the "
9146 "maximum guest memory is freed."
9151 #: ../src/guestfs-actions.pod:1299
9157 #: ../src/guestfs-actions.pod:1301
9161 " guestfs_du (guestfs_h *g,\n"
9162 " const char *path);\n"
9168 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9170 "This command runs the C<du -s> command to estimate file space usage for "
9176 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9178 "C<path> can be a file or a directory. If C<path> is a directory then the "
9179 "estimate includes the contents of the directory and all subdirectories "
9185 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9187 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9192 #: ../src/guestfs-actions.pod:1324
9193 msgid "guestfs_e2fsck_f"
9198 #: ../src/guestfs-actions.pod:1326
9202 " guestfs_e2fsck_f (guestfs_h *g,\n"
9203 " const char *device);\n"
9208 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9210 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9211 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9217 #: ../src/guestfs-actions.pod:1334
9219 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9220 "Normally you should use C<guestfs_fsck>."
9225 #: ../src/guestfs-actions.pod:1339
9226 msgid "(Added in 1.0.29)"
9231 #: ../src/guestfs-actions.pod:1341
9232 msgid "guestfs_echo_daemon"
9237 #: ../src/guestfs-actions.pod:1343
9241 " guestfs_echo_daemon (guestfs_h *g,\n"
9242 " char *const *words);\n"
9248 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9250 "This command concatenates the list of C<words> passed with single spaces "
9251 "between them and returns the resulting string."
9256 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9257 msgid "You can use this command to test the connection through to the daemon."
9262 #: ../src/guestfs-actions.pod:1352
9263 msgid "See also C<guestfs_ping_daemon>."
9268 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2091
9269 #: ../src/guestfs-actions.pod:6063
9270 msgid "(Added in 1.0.69)"
9275 #: ../src/guestfs-actions.pod:1359
9276 msgid "guestfs_egrep"
9281 #: ../src/guestfs-actions.pod:1361
9285 " guestfs_egrep (guestfs_h *g,\n"
9286 " const char *regex,\n"
9287 " const char *path);\n"
9293 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9295 "This calls the external C<egrep> program and returns the matching lines."
9300 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9301 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9302 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2221
9303 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2396
9304 #: ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2424
9305 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2492
9306 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:3653
9307 #: ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3680
9308 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4680
9309 #: ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5612
9310 #: ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6471
9311 #: ../src/guestfs-actions.pod:6484 ../src/guestfs-actions.pod:6497
9312 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6532
9313 #: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6558
9314 #: ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7355
9315 #: ../src/guestfs-actions.pod:7440 ../src/guestfs-actions.pod:7459
9316 #: ../src/guestfs-actions.pod:7505 ../src/guestfs-actions.pod:7524
9317 msgid "(Added in 1.0.66)"
9322 #: ../src/guestfs-actions.pod:1378
9323 msgid "guestfs_egrepi"
9328 #: ../src/guestfs-actions.pod:1380
9332 " guestfs_egrepi (guestfs_h *g,\n"
9333 " const char *regex,\n"
9334 " const char *path);\n"
9340 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9342 "This calls the external C<egrep -i> program and returns the matching lines."
9347 #: ../src/guestfs-actions.pod:1397
9348 msgid "guestfs_equal"
9353 #: ../src/guestfs-actions.pod:1399
9357 " guestfs_equal (guestfs_h *g,\n"
9358 " const char *file1,\n"
9359 " const char *file2);\n"
9365 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9367 "This compares the two files C<file1> and C<file2> and returns true if their "
9368 "content is exactly equal, or false otherwise."
9373 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9374 msgid "The external L<cmp(1)> program is used for the comparison."
9379 #: ../src/guestfs-actions.pod:1413
9380 msgid "guestfs_exists"
9385 #: ../src/guestfs-actions.pod:1415
9389 " guestfs_exists (guestfs_h *g,\n"
9390 " const char *path);\n"
9396 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9398 "This returns C<true> if and only if there is a file, directory (or anything) "
9399 "with the given C<path> name."
9404 #: ../src/guestfs-actions.pod:1422
9405 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9410 #: ../src/guestfs-actions.pod:1428
9411 msgid "guestfs_fallocate"
9416 #: ../src/guestfs-actions.pod:1430
9420 " guestfs_fallocate (guestfs_h *g,\n"
9421 " const char *path,\n"
9428 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9429 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9431 "This command preallocates a file (containing zero bytes) named C<path> of "
9432 "size C<len> bytes. If the file exists already, it is overwritten."
9437 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9439 "Do not confuse this with the guestfish-specific C<alloc> command which "
9440 "allocates a file in the host and attaches it as a device."
9445 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9447 "This function is deprecated. In new code, use the C<fallocate64> call "
9453 #: ../src/guestfs-actions.pod:1454
9454 msgid "guestfs_fallocate64"
9459 #: ../src/guestfs-actions.pod:1456
9463 " guestfs_fallocate64 (guestfs_h *g,\n"
9464 " const char *path,\n"
9471 #: ../src/guestfs-actions.pod:1465
9473 "Note that this call allocates disk blocks for the file. To create a sparse "
9474 "file use C<guestfs_truncate_size> instead."
9479 #: ../src/guestfs-actions.pod:1468
9481 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9482 "oversight it only allowed 30 bit lengths to be specified, effectively "
9483 "limiting the maximum size of files created through that call to 1GB."
9488 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9490 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9491 "commands which create a file in the host and attach it as a device."
9496 #: ../src/guestfs-actions.pod:1479
9497 msgid "(Added in 1.3.17)"
9502 #: ../src/guestfs-actions.pod:1481
9503 msgid "guestfs_fgrep"
9508 #: ../src/guestfs-actions.pod:1483
9512 " guestfs_fgrep (guestfs_h *g,\n"
9513 " const char *pattern,\n"
9514 " const char *path);\n"
9520 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9522 "This calls the external C<fgrep> program and returns the matching lines."
9527 #: ../src/guestfs-actions.pod:1500
9528 msgid "guestfs_fgrepi"
9533 #: ../src/guestfs-actions.pod:1502
9537 " guestfs_fgrepi (guestfs_h *g,\n"
9538 " const char *pattern,\n"
9539 " const char *path);\n"
9545 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9547 "This calls the external C<fgrep -i> program and returns the matching lines."
9552 #: ../src/guestfs-actions.pod:1519
9553 msgid "guestfs_file"
9558 #: ../src/guestfs-actions.pod:1521
9562 " guestfs_file (guestfs_h *g,\n"
9563 " const char *path);\n"
9569 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9571 "This call uses the standard L<file(1)> command to determine the type or "
9572 "contents of the file."
9577 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9579 "This call will also transparently look inside various types of compressed "
9584 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9586 "The exact command which runs is C<file -zb path>. Note in particular that "
9587 "the filename is not prepended to the output (the I<-b> option)."
9591 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1014
9593 "The output depends on the output of the underlying L<file(1)> command and it "
9594 "can change in future in ways beyond our control. In other words, the output "
9595 "is not guaranteed by the ABI."
9599 #: ../src/guestfs-actions.pod:1539
9601 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9602 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
9607 #: ../src/guestfs-actions.pod:1547
9608 msgid "guestfs_file_architecture"
9613 #: ../src/guestfs-actions.pod:1549
9617 " guestfs_file_architecture (guestfs_h *g,\n"
9618 " const char *filename);\n"
9624 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1025
9626 "This detects the architecture of the binary C<filename>, and returns it if "
9632 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9633 msgid "Currently defined architectures are:"
9638 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1032
9644 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1034
9646 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9647 "irrespective of the precise processor requirements of the binary."
9652 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9658 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
9659 msgid "64 bit x86-64."
9664 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1041
9670 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1043
9671 msgid "32 bit SPARC."
9676 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1045
9682 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1047
9683 msgid "64 bit SPARC V9 and above."
9688 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1049
9694 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1051
9695 msgid "Intel Itanium."
9700 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1053
9706 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1055
9707 msgid "32 bit Power PC."
9712 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1057
9718 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1059
9719 msgid "64 bit Power PC."
9724 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1063
9725 msgid "Libguestfs may return other architecture strings in future."
9730 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1065
9731 msgid "The function works on at least the following types of files:"
9736 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1071
9737 msgid "many types of Un*x and Linux binary"
9742 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1075
9743 msgid "many types of Un*x and Linux shared library"
9748 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1079
9749 msgid "Windows Win32 and Win64 binaries"
9754 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1083
9755 msgid "Windows Win32 and Win64 DLLs"
9760 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1085
9761 msgid "Win32 binaries and DLLs return C<i386>."
9766 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1087
9767 msgid "Win64 binaries and DLLs return C<x86_64>."
9772 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1091
9773 msgid "Linux kernel modules"
9778 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1095
9779 msgid "Linux new-style initrd images"
9784 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1099
9785 msgid "some non-x86 Linux vmlinuz kernels"
9790 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1103
9791 msgid "What it can't do currently:"
9796 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1109
9797 msgid "static libraries (libfoo.a)"
9802 #: ../src/guestfs-actions.pod:1641 ../fish/guestfish-actions.pod:1113
9803 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9808 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1117
9809 msgid "x86 Linux vmlinuz kernels"
9814 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1119
9816 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9817 "compressed code, and are horribly hard to unpack. If you want to find the "
9818 "architecture of a kernel, use the architecture of the associated initrd or "
9819 "kernel module(s) instead."
9824 #: ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820
9825 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:2528
9826 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2691
9827 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2800
9828 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2927
9829 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3271
9830 #: ../src/guestfs-actions.pod:3403
9831 msgid "(Added in 1.5.3)"
9836 #: ../src/guestfs-actions.pod:1659
9837 msgid "guestfs_filesize"
9842 #: ../src/guestfs-actions.pod:1661
9846 " guestfs_filesize (guestfs_h *g,\n"
9847 " const char *file);\n"
9853 #: ../src/guestfs-actions.pod:1665 ../fish/guestfish-actions.pod:1130
9854 msgid "This command returns the size of C<file> in bytes."
9859 #: ../src/guestfs-actions.pod:1667
9861 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9862 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9863 "devices, use C<guestfs_blockdev_getsize64>."
9868 #: ../src/guestfs-actions.pod:1673
9869 msgid "(Added in 1.0.82)"
9874 #: ../src/guestfs-actions.pod:1675
9875 msgid "guestfs_fill"
9880 #: ../src/guestfs-actions.pod:1677
9884 " guestfs_fill (guestfs_h *g,\n"
9887 " const char *path);\n"
9893 #: ../src/guestfs-actions.pod:1683 ../fish/guestfish-actions.pod:1140
9895 "This command creates a new file called C<path>. The initial content of the "
9896 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9902 #: ../src/guestfs-actions.pod:1687
9904 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9905 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9906 "bytes use C<guestfs_fill_pattern>."
9911 #: ../src/guestfs-actions.pod:1699
9912 msgid "(Added in 1.0.79)"
9917 #: ../src/guestfs-actions.pod:1701
9918 msgid "guestfs_fill_pattern"
9923 #: ../src/guestfs-actions.pod:1703
9927 " guestfs_fill_pattern (guestfs_h *g,\n"
9928 " const char *pattern,\n"
9930 " const char *path);\n"
9936 #: ../src/guestfs-actions.pod:1709
9938 "This function is like C<guestfs_fill> except that it creates a new file of "
9939 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9940 "pattern is truncated if necessary to ensure the length of the file is "
9941 "exactly C<len> bytes."
9946 #: ../src/guestfs-actions.pod:1721
9947 msgid "(Added in 1.3.12)"
9952 #: ../src/guestfs-actions.pod:1723
9953 msgid "guestfs_find"
9958 #: ../src/guestfs-actions.pod:1725
9962 " guestfs_find (guestfs_h *g,\n"
9963 " const char *directory);\n"
9969 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1162
9971 "This command lists out all files and directories, recursively, starting at "
9972 "C<directory>. It is essentially equivalent to running the shell command "
9973 "C<find directory -print> but some post-processing happens on the output, "
9979 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9981 "This returns a list of strings I<without any prefix>. Thus if the directory "
9987 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9998 #: ../src/guestfs-actions.pod:1741
10000 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10005 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1177
10017 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
10018 msgid "If C<directory> is not a directory, then this command returns an error."
10023 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
10024 msgid "The returned list is sorted."
10029 #: ../src/guestfs-actions.pod:1754
10030 msgid "See also C<guestfs_find0>."
10035 #: ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:4097
10036 #: ../src/guestfs-actions.pod:5647
10037 msgid "(Added in 1.0.27)"
10042 #: ../src/guestfs-actions.pod:1765
10043 msgid "guestfs_find0"
10048 #: ../src/guestfs-actions.pod:1767
10052 " guestfs_find0 (guestfs_h *g,\n"
10053 " const char *directory,\n"
10054 " const char *files);\n"
10060 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1196
10062 "This command lists out all files and directories, recursively, starting at "
10063 "C<directory>, placing the resulting list in the external file called "
10069 #: ../src/guestfs-actions.pod:1776
10071 "This command works the same way as C<guestfs_find> with the following "
10077 #: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1207
10078 msgid "The resulting list is written to an external file."
10083 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1211
10085 "Items (filenames) in the result are separated by C<\\0> characters. See "
10086 "L<find(1)> option I<-print0>."
10091 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
10092 msgid "This command is not limited in the number of names that it can return."
10097 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
10098 msgid "The result list is not sorted."
10103 #: ../src/guestfs-actions.pod:1803
10104 msgid "(Added in 1.0.74)"
10109 #: ../src/guestfs-actions.pod:1805
10110 msgid "guestfs_findfs_label"
10115 #: ../src/guestfs-actions.pod:1807
10119 " guestfs_findfs_label (guestfs_h *g,\n"
10120 " const char *label);\n"
10126 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1231
10128 "This command searches the filesystems and returns the one which has the "
10129 "given label. An error is returned if no such filesystem can be found."
10134 #: ../src/guestfs-actions.pod:1815
10135 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10140 #: ../src/guestfs-actions.pod:1822
10141 msgid "guestfs_findfs_uuid"
10146 #: ../src/guestfs-actions.pod:1824
10150 " guestfs_findfs_uuid (guestfs_h *g,\n"
10151 " const char *uuid);\n"
10157 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1241
10159 "This command searches the filesystems and returns the one which has the "
10160 "given UUID. An error is returned if no such filesystem can be found."
10165 #: ../src/guestfs-actions.pod:1832
10166 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10171 #: ../src/guestfs-actions.pod:1839
10172 msgid "guestfs_fsck"
10177 #: ../src/guestfs-actions.pod:1841
10181 " guestfs_fsck (guestfs_h *g,\n"
10182 " const char *fstype,\n"
10183 " const char *device);\n"
10189 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1251
10191 "This runs the filesystem checker (fsck) on C<device> which should have "
10192 "filesystem type C<fstype>."
10197 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10199 "The returned integer is the status. See L<fsck(8)> for the list of status "
10200 "codes from C<fsck>."
10205 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1263
10206 msgid "Multiple status codes can be summed together."
10211 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1267
10213 "A non-zero return code can mean \"success\", for example if errors have been "
10214 "corrected on the filesystem."
10219 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
10220 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10225 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
10227 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10232 #: ../src/guestfs-actions.pod:1876 ../src/guestfs-actions.pod:7378
10233 msgid "(Added in 1.0.16)"
10238 #: ../src/guestfs-actions.pod:1878
10239 msgid "guestfs_get_append"
10244 #: ../src/guestfs-actions.pod:1880
10248 " guestfs_get_append (guestfs_h *g);\n"
10254 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1283
10256 "Return the additional kernel options which are added to the guest kernel "
10262 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10263 msgid "If C<NULL> then no options are added."
10268 #: ../src/guestfs-actions.pod:1888
10270 "This function returns a string which may be NULL. There is no way to return "
10271 "an error from this function. The string is owned by the guest handle and "
10272 "must I<not> be freed."
10277 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:5325
10278 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:6226
10279 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6261
10280 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:7042
10281 #: ../src/guestfs-actions.pod:7060 ../src/guestfs-actions.pod:7421
10282 msgid "(Added in 1.0.26)"
10286 #: ../src/guestfs-actions.pod:1894
10287 msgid "guestfs_get_attach_method"
10291 #: ../src/guestfs-actions.pod:1896
10295 " guestfs_get_attach_method (guestfs_h *g);\n"
10300 #: ../src/guestfs-actions.pod:1899
10301 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10306 #: ../src/guestfs-actions.pod:1904
10307 msgid "guestfs_get_autosync"
10312 #: ../src/guestfs-actions.pod:1906
10316 " guestfs_get_autosync (guestfs_h *g);\n"
10322 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1298
10323 msgid "Get the autosync flag."
10328 #: ../src/guestfs-actions.pod:1915
10329 msgid "guestfs_get_direct"
10334 #: ../src/guestfs-actions.pod:1917
10338 " guestfs_get_direct (guestfs_h *g);\n"
10344 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1304
10345 msgid "Return the direct appliance mode flag."
10350 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:5874
10351 msgid "(Added in 1.0.72)"
10356 #: ../src/guestfs-actions.pod:1926
10357 msgid "guestfs_get_e2label"
10362 #: ../src/guestfs-actions.pod:1928
10366 " guestfs_get_e2label (guestfs_h *g,\n"
10367 " const char *device);\n"
10373 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1310
10375 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10380 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1313
10382 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10387 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:1966
10388 #: ../src/guestfs-actions.pod:5892 ../src/guestfs-actions.pod:5911
10389 msgid "(Added in 1.0.15)"
10394 #: ../src/guestfs-actions.pod:1947
10395 msgid "guestfs_get_e2uuid"
10400 #: ../src/guestfs-actions.pod:1949
10404 " guestfs_get_e2uuid (guestfs_h *g,\n"
10405 " const char *device);\n"
10411 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1324
10413 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10418 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1327
10420 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10425 #: ../src/guestfs-actions.pod:1968
10426 msgid "guestfs_get_memsize"
10431 #: ../src/guestfs-actions.pod:1970
10435 " guestfs_get_memsize (guestfs_h *g);\n"
10441 #: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1338
10443 "This gets the memory size in megabytes allocated to the qemu subprocess."
10448 #: ../src/guestfs-actions.pod:1976
10450 "If C<guestfs_set_memsize> was not called on this handle, and if "
10451 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10452 "value for memsize."
10457 #: ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2061
10458 #: ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:6034
10459 #: ../fish/guestfish-actions.pod:1345 ../fish/guestfish-actions.pod:1396
10460 #: ../fish/guestfish-actions.pod:3997 ../fish/guestfish-actions.pod:4084
10462 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10467 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:4388
10468 #: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4604
10469 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4635
10470 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4665
10471 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5932
10472 #: ../src/guestfs-actions.pod:6193 ../src/guestfs-actions.pod:6808
10473 msgid "(Added in 1.0.55)"
10478 #: ../src/guestfs-actions.pod:1987
10479 msgid "guestfs_get_network"
10484 #: ../src/guestfs-actions.pod:1989
10488 " guestfs_get_network (guestfs_h *g);\n"
10494 #: ../src/guestfs-actions.pod:1992 ../fish/guestfish-actions.pod:1352
10495 msgid "This returns the enable network flag."
10500 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:5951
10501 msgid "(Added in 1.5.4)"
10506 #: ../src/guestfs-actions.pod:1998
10507 msgid "guestfs_get_path"
10512 #: ../src/guestfs-actions.pod:2000
10516 " guestfs_get_path (guestfs_h *g);\n"
10522 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1358
10523 msgid "Return the current search path."
10528 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1360
10530 "This is always non-NULL. If it wasn't set already, then this will return "
10531 "the default path."
10536 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2037
10538 "This function returns a string, or NULL on error. The string is owned by "
10539 "the guest handle and must I<not> be freed."
10544 #: ../src/guestfs-actions.pod:2013
10545 msgid "guestfs_get_pid"
10550 #: ../src/guestfs-actions.pod:2015
10554 " guestfs_get_pid (guestfs_h *g);\n"
10560 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1369
10562 "Return the process ID of the qemu subprocess. If there is no qemu "
10563 "subprocess, then this will return an error."
10568 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10569 msgid "This is an internal call used for debugging and testing."
10574 #: ../src/guestfs-actions.pod:2025
10575 msgid "(Added in 1.0.56)"
10580 #: ../src/guestfs-actions.pod:2027
10581 msgid "guestfs_get_qemu"
10586 #: ../src/guestfs-actions.pod:2029
10590 " guestfs_get_qemu (guestfs_h *g);\n"
10596 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1378
10597 msgid "Return the current qemu binary."
10602 #: ../src/guestfs-actions.pod:2034 ../fish/guestfish-actions.pod:1380
10604 "This is always non-NULL. If it wasn't set already, then this will return "
10605 "the default qemu binary name."
10610 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:5996
10611 msgid "(Added in 1.0.6)"
10616 #: ../src/guestfs-actions.pod:2042
10617 msgid "guestfs_get_recovery_proc"
10622 #: ../src/guestfs-actions.pod:2044
10626 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10632 #: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1387
10633 msgid "Return the recovery process enabled flag."
10638 #: ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:3498
10639 #: ../src/guestfs-actions.pod:3795 ../src/guestfs-actions.pod:4195
10640 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5255
10641 #: ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:6020
10642 #: ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6731
10643 #: ../src/guestfs-actions.pod:6923
10644 msgid "(Added in 1.0.77)"
10649 #: ../src/guestfs-actions.pod:2053
10650 msgid "guestfs_get_selinux"
10655 #: ../src/guestfs-actions.pod:2055
10659 " guestfs_get_selinux (guestfs_h *g);\n"
10665 #: ../src/guestfs-actions.pod:2058
10667 "This returns the current setting of the selinux flag which is passed to the "
10668 "appliance at boot time. See C<guestfs_set_selinux>."
10673 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2129
10674 #: ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6097
10675 msgid "(Added in 1.0.67)"
10680 #: ../src/guestfs-actions.pod:2068
10681 msgid "guestfs_get_state"
10686 #: ../src/guestfs-actions.pod:2070
10690 " guestfs_get_state (guestfs_h *g);\n"
10696 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1403
10698 "This returns the current state as an opaque integer. This is only useful "
10699 "for printing debug and internal error messages."
10704 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:3296
10705 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3386
10706 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:1406
10707 #: ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2338
10708 #: ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2392
10709 msgid "For more information on states, see L<guestfs(3)>."
10714 #: ../src/guestfs-actions.pod:2082
10715 msgid "guestfs_get_trace"
10720 #: ../src/guestfs-actions.pod:2084
10724 " guestfs_get_trace (guestfs_h *g);\n"
10730 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
10731 msgid "Return the command trace flag."
10736 #: ../src/guestfs-actions.pod:2093
10737 msgid "guestfs_get_umask"
10742 #: ../src/guestfs-actions.pod:2095
10746 " guestfs_get_umask (guestfs_h *g);\n"
10752 #: ../src/guestfs-actions.pod:2098
10754 "Return the current umask. By default the umask is C<022> unless it has been "
10755 "set by calling C<guestfs_umask>."
10760 #: ../src/guestfs-actions.pod:2105
10761 msgid "guestfs_get_verbose"
10766 #: ../src/guestfs-actions.pod:2107
10770 " guestfs_get_verbose (guestfs_h *g);\n"
10776 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1425
10777 msgid "This returns the verbose messages flag."
10782 #: ../src/guestfs-actions.pod:2116
10783 msgid "guestfs_getcon"
10788 #: ../src/guestfs-actions.pod:2118
10792 " guestfs_getcon (guestfs_h *g);\n"
10798 #: ../src/guestfs-actions.pod:2121 ../fish/guestfish-actions.pod:1431
10799 msgid "This gets the SELinux security context of the daemon."
10804 #: ../src/guestfs-actions.pod:2123
10806 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10811 #: ../src/guestfs-actions.pod:2131
10812 msgid "guestfs_getxattr"
10817 #: ../src/guestfs-actions.pod:2133
10821 " guestfs_getxattr (guestfs_h *g,\n"
10822 " const char *path,\n"
10823 " const char *name,\n"
10824 " size_t *size_r);\n"
10830 #: ../src/guestfs-actions.pod:2139
10832 "Get a single extended attribute from file C<path> named C<name>. This call "
10833 "follows symlinks. If you want to lookup an extended attribute for the "
10834 "symlink itself, use C<guestfs_lgetxattr>."
10839 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:3512
10841 "Normally it is better to get all extended attributes from a file in one go "
10842 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10843 "implementations are buggy and do not provide a way to list out attributes. "
10844 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10845 "extended attributes you want in advance and call this function."
10850 #: ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:3519
10851 #: ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:2457
10853 "Extended attribute values are blobs of binary data. If there is no extended "
10854 "attribute named C<name>, this returns an error."
10859 #: ../src/guestfs-actions.pod:2153
10860 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10865 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2346
10866 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:5248
10867 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5455
10869 "This function returns a buffer, or NULL on error. The size of the returned "
10870 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10875 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
10876 msgid "(Added in 1.7.24)"
10881 #: ../src/guestfs-actions.pod:2161
10882 msgid "guestfs_getxattrs"
10887 #: ../src/guestfs-actions.pod:2163
10890 " struct guestfs_xattr_list *\n"
10891 " guestfs_getxattrs (guestfs_h *g,\n"
10892 " const char *path);\n"
10898 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1460
10900 "This call lists the extended attributes of the file or directory C<path>."
10905 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10907 "At the system call level, this is a combination of the L<listxattr(2)> and "
10908 "L<getxattr(2)> calls."
10913 #: ../src/guestfs-actions.pod:2173
10914 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10919 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:3540
10920 #: ../src/guestfs-actions.pod:4191
10922 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10923 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10928 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3544
10929 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3745
10930 #: ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:6116
10931 #: ../src/guestfs-actions.pod:7486
10932 msgid "(Added in 1.0.59)"
10937 #: ../src/guestfs-actions.pod:2181
10938 msgid "guestfs_glob_expand"
10943 #: ../src/guestfs-actions.pod:2183
10947 " guestfs_glob_expand (guestfs_h *g,\n"
10948 " const char *pattern);\n"
10954 #: ../src/guestfs-actions.pod:2187 ../fish/guestfish-actions.pod:1472
10956 "This command searches for all the pathnames matching C<pattern> according to "
10957 "the wildcard expansion rules used by the shell."
10962 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1476
10964 "If no paths match, then this returns an empty list (note: not an error)."
10969 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10971 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10972 "GLOB_BRACE>. See that manual page for more details."
10977 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:6309
10978 #: ../src/guestfs-actions.pod:6326
10979 msgid "(Added in 1.0.50)"
10984 #: ../src/guestfs-actions.pod:2204
10985 msgid "guestfs_grep"
10990 #: ../src/guestfs-actions.pod:2206
10994 " guestfs_grep (guestfs_h *g,\n"
10995 " const char *regex,\n"
10996 " const char *path);\n"
11002 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1487
11003 msgid "This calls the external C<grep> program and returns the matching lines."
11008 #: ../src/guestfs-actions.pod:2223
11009 msgid "guestfs_grepi"
11014 #: ../src/guestfs-actions.pod:2225
11018 " guestfs_grepi (guestfs_h *g,\n"
11019 " const char *regex,\n"
11020 " const char *path);\n"
11026 #: ../src/guestfs-actions.pod:2230 ../fish/guestfish-actions.pod:1497
11028 "This calls the external C<grep -i> program and returns the matching lines."
11033 #: ../src/guestfs-actions.pod:2242
11034 msgid "guestfs_grub_install"
11039 #: ../src/guestfs-actions.pod:2244
11043 " guestfs_grub_install (guestfs_h *g,\n"
11044 " const char *root,\n"
11045 " const char *device);\n"
11051 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1507
11053 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11054 "the root directory being C<root>."
11059 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
11061 "Note: If grub-install reports the error \"No suitable drive was found in the "
11062 "generated device map.\" it may be that you need to create a C</boot/grub/"
11063 "device.map> file first that contains the mapping between grub device names "
11064 "and Linux device names. It is usually sufficient to create a file "
11070 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1517
11073 " (hd0) /dev/vda\n"
11079 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1519
11080 msgid "replacing C</dev/vda> with the name of the installation device."
11085 #: ../src/guestfs-actions.pod:2265
11086 msgid "(Added in 1.0.17)"
11091 #: ../src/guestfs-actions.pod:2267
11092 msgid "guestfs_head"
11097 #: ../src/guestfs-actions.pod:2269
11101 " guestfs_head (guestfs_h *g,\n"
11102 " const char *path);\n"
11108 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1525
11110 "This command returns up to the first 10 lines of a file as a list of strings."
11115 #: ../src/guestfs-actions.pod:2285
11116 msgid "guestfs_head_n"
11121 #: ../src/guestfs-actions.pod:2287
11125 " guestfs_head_n (guestfs_h *g,\n"
11127 " const char *path);\n"
11133 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1535
11135 "If the parameter C<nrlines> is a positive number, this returns the first "
11136 "C<nrlines> lines of the file C<path>."
11141 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
11143 "If the parameter C<nrlines> is a negative number, this returns lines from "
11144 "the file C<path>, excluding the last C<nrlines> lines."
11149 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:6606
11150 #: ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:4462
11151 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11156 #: ../src/guestfs-actions.pod:2309
11157 msgid "guestfs_hexdump"
11162 #: ../src/guestfs-actions.pod:2311
11166 " guestfs_hexdump (guestfs_h *g,\n"
11167 " const char *path);\n"
11173 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1550
11175 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11176 "readable, canonical hex dump of the file."
11181 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:6390
11182 #: ../src/guestfs-actions.pod:6445
11183 msgid "(Added in 1.0.22)"
11188 #: ../src/guestfs-actions.pod:2326
11189 msgid "guestfs_initrd_cat"
11194 #: ../src/guestfs-actions.pod:2328
11198 " guestfs_initrd_cat (guestfs_h *g,\n"
11199 " const char *initrdpath,\n"
11200 " const char *filename,\n"
11201 " size_t *size_r);\n"
11207 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1560
11209 "This command unpacks the file C<filename> from the initrd file called "
11210 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11216 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1564
11218 "For example, in guestfish you could use the following command to examine the "
11219 "boot script (usually called C</init>) contained in a Linux initrd or "
11225 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1568
11228 " initrd-cat /boot/initrd-<version>.img init\n"
11234 #: ../src/guestfs-actions.pod:2344
11235 msgid "See also C<guestfs_initrd_list>."
11240 #: ../src/guestfs-actions.pod:2355
11241 msgid "guestfs_initrd_list"
11246 #: ../src/guestfs-actions.pod:2357
11250 " guestfs_initrd_list (guestfs_h *g,\n"
11251 " const char *path);\n"
11257 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1579
11258 msgid "This command lists out files contained in an initrd."
11263 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1581
11265 "The files are listed without any initial C</> character. The files are "
11266 "listed in the order they appear (not necessarily alphabetical). Directory "
11267 "names are listed as separate items."
11272 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1585
11274 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11275 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11281 #: ../src/guestfs-actions.pod:2377
11282 msgid "guestfs_inotify_add_watch"
11287 #: ../src/guestfs-actions.pod:2379
11291 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11292 " const char *path,\n"
11299 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1593
11300 msgid "Watch C<path> for the events listed in C<mask>."
11305 #: ../src/guestfs-actions.pod:2386 ../fish/guestfish-actions.pod:1595
11307 "Note that if C<path> is a directory then events within that directory are "
11308 "watched, but this does I<not> happen recursively (in subdirectories)."
11313 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1599
11315 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11316 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11321 #: ../src/guestfs-actions.pod:2398
11322 msgid "guestfs_inotify_close"
11327 #: ../src/guestfs-actions.pod:2400
11331 " guestfs_inotify_close (guestfs_h *g);\n"
11337 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1607
11339 "This closes the inotify handle which was previously opened by inotify_init. "
11340 "It removes all watches, throws away any pending events, and deallocates all "
11346 #: ../src/guestfs-actions.pod:2411
11347 msgid "guestfs_inotify_files"
11352 #: ../src/guestfs-actions.pod:2413
11356 " guestfs_inotify_files (guestfs_h *g);\n"
11362 #: ../src/guestfs-actions.pod:2416
11364 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11365 "returns a list of pathnames of objects that were touched. The returned "
11366 "pathnames are sorted and deduplicated."
11371 #: ../src/guestfs-actions.pod:2426
11372 msgid "guestfs_inotify_init"
11377 #: ../src/guestfs-actions.pod:2428
11381 " guestfs_inotify_init (guestfs_h *g,\n"
11382 " int maxevents);\n"
11388 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1623
11390 "This command creates a new inotify handle. The inotify subsystem can be "
11391 "used to notify events which happen to objects in the guest filesystem."
11396 #: ../src/guestfs-actions.pod:2436
11398 "C<maxevents> is the maximum number of events which will be queued up between "
11399 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11400 "passed as C<0>, then the kernel (or previously set) default is used. For "
11401 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11402 "throws away events, but records the fact that it threw them away by setting "
11403 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11404 "C<guestfs_inotify_read>)."
11409 #: ../src/guestfs-actions.pod:2446
11411 "Before any events are generated, you have to add some watches to the "
11412 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11413 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11418 #: ../src/guestfs-actions.pod:2452
11420 "Queued up events should be read periodically by calling "
11421 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11422 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11423 "often enough then you risk the internal queue overflowing."
11428 #: ../src/guestfs-actions.pod:2459
11430 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11431 "This also removes any watches automatically."
11436 #: ../src/guestfs-actions.pod:2463 ../fish/guestfish-actions.pod:1654
11438 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11439 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11440 "that there is one global inotify handle per libguestfs instance."
11445 #: ../src/guestfs-actions.pod:2472
11446 msgid "guestfs_inotify_read"
11451 #: ../src/guestfs-actions.pod:2474
11454 " struct guestfs_inotify_event_list *\n"
11455 " guestfs_inotify_read (guestfs_h *g);\n"
11461 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1663
11463 "Return the complete queue of events that have happened since the previous "
11469 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11470 msgid "If no events have happened, this returns an empty list."
11475 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
11477 "I<Note>: In order to make sure that all events have been read, you must call "
11478 "this function repeatedly until it returns an empty list. The reason is that "
11479 "the call will read events up to the maximum appliance-to-host message size "
11480 "and leave remaining events in the queue."
11485 #: ../src/guestfs-actions.pod:2488
11487 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11488 "there was an error. I<The caller must call "
11489 "C<guestfs_free_inotify_event_list> after use>."
11494 #: ../src/guestfs-actions.pod:2494
11495 msgid "guestfs_inotify_rm_watch"
11500 #: ../src/guestfs-actions.pod:2496
11504 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11511 #: ../src/guestfs-actions.pod:2500
11513 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11518 #: ../src/guestfs-actions.pod:2507
11519 msgid "guestfs_inspect_get_arch"
11524 #: ../src/guestfs-actions.pod:2509
11528 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11529 " const char *root);\n"
11535 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2536
11536 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2673
11537 #: ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2738
11538 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:2787
11539 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2851
11540 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2911
11541 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2990
11542 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3053
11543 #: ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3093
11544 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3129
11546 "This function should only be called with a root device string as returned by "
11547 "C<guestfs_inspect_os>."
11552 #: ../src/guestfs-actions.pod:2516
11554 "This returns the architecture of the inspected operating system. The "
11555 "possible return values are listed under C<guestfs_file_architecture>."
11560 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1692
11562 "If the architecture could not be determined, then the string C<unknown> is "
11568 #: ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2616
11569 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2747
11570 #: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2867
11571 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:2922
11572 #: ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:3019
11573 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
11574 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3100
11575 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3222
11576 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:1695
11577 #: ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869
11578 #: ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1905
11579 #: ../fish/guestfish-actions.pod:1975 ../fish/guestfish-actions.pod:1999
11580 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2059
11581 #: ../fish/guestfish-actions.pod:2094 ../fish/guestfish-actions.pod:2110
11582 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2139
11583 #: ../fish/guestfish-actions.pod:2152 ../fish/guestfish-actions.pod:2167
11584 #: ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2300
11585 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11590 #: ../src/guestfs-actions.pod:2530
11591 msgid "guestfs_inspect_get_distro"
11596 #: ../src/guestfs-actions.pod:2532
11600 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11601 " const char *root);\n"
11607 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1704
11609 "This returns the distro (distribution) of the inspected operating system."
11614 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11615 msgid "Currently defined distros are:"
11620 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1711
11621 msgid "\"archlinux\""
11626 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1713
11627 msgid "Arch Linux."
11631 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1715
11636 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1717
11642 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1719
11648 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1721
11654 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1723
11660 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1725
11666 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1727
11672 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1729
11678 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
11679 msgid "\"linuxmint\""
11684 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1733
11685 msgid "Linux Mint."
11690 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1735
11691 msgid "\"mandriva\""
11696 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1737
11702 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1739
11708 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1741
11714 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1743
11720 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1745
11726 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1747
11727 msgid "\"redhat-based\""
11732 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1749
11733 msgid "Some Red Hat-derived distro."
11738 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1751
11743 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1753
11744 msgid "Red Hat Enterprise Linux."
11748 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1755
11749 msgid "\"scientificlinux\""
11753 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1757
11754 msgid "Scientific Linux."
11758 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1759
11759 msgid "\"slackware\""
11763 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1761
11769 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1763
11775 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1765
11781 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2718
11782 #: ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:1767
11783 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:2085
11784 msgid "\"unknown\""
11789 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1769
11790 msgid "The distro could not be determined."
11795 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3002
11796 #: ../fish/guestfish-actions.pod:1771 ../fish/guestfish-actions.pod:2077
11797 msgid "\"windows\""
11802 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1773
11804 "Windows does not have distributions. This string is returned if the OS type "
11810 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
11811 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1778
11812 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:2091
11814 "Future versions of libguestfs may return other strings here. The caller "
11815 "should be prepared to handle any string."
11819 #: ../src/guestfs-actions.pod:2623
11820 msgid "guestfs_inspect_get_drive_mappings"
11824 #: ../src/guestfs-actions.pod:2625
11828 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11829 " const char *root);\n"
11834 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
11836 "This call is useful for Windows which uses a primitive system of assigning "
11837 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11838 "Windows Registry to find out how disks/partitions are mapped to drive "
11839 "letters, and returns a hash table as in the example below:"
11843 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1796
11846 " C => /dev/vda2\n"
11847 " E => /dev/vdb1\n"
11848 " F => /dev/vdc1\n"
11853 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1800
11855 "Note that keys are drive letters. For Windows, the key is case insensitive "
11856 "and just contains the drive letter, without the customary colon separator "
11861 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
11863 "In future we may support other operating systems that also used drive "
11864 "letters, but the keys for those might not be case insensitive and might be "
11865 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11870 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
11872 "For Windows guests, currently only hard drive mappings are returned. "
11873 "Removable disks (eg. DVD-ROMs) are ignored."
11877 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
11879 "For guests that do not use drive mappings, or if the drive mappings could "
11880 "not be determined, this returns an empty hash table."
11884 #: ../src/guestfs-actions.pod:2657
11886 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11887 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11892 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2837
11893 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:4814
11894 #: ../src/guestfs-actions.pod:6747
11896 "This function returns a NULL-terminated array of strings, or NULL if there "
11897 "was an error. The array of strings will always have length C<2n+1>, where "
11898 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11899 "caller must free the strings and the array after use>."
11904 #: ../src/guestfs-actions.pod:2667
11905 msgid "guestfs_inspect_get_filesystems"
11910 #: ../src/guestfs-actions.pod:2669
11914 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11915 " const char *root);\n"
11921 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
11923 "This returns a list of all the filesystems that we think are associated with "
11924 "this operating system. This includes the root filesystem, other ordinary "
11925 "filesystems, and non-mounted devices like swap partitions."
11930 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
11932 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11933 "to be shared between operating systems."
11938 #: ../src/guestfs-actions.pod:2684
11940 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11941 "C<guestfs_inspect_get_mountpoints>."
11945 #: ../src/guestfs-actions.pod:2693
11946 msgid "guestfs_inspect_get_format"
11950 #: ../src/guestfs-actions.pod:2695
11954 " guestfs_inspect_get_format (guestfs_h *g,\n"
11955 " const char *root);\n"
11960 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1844
11962 "This returns the format of the inspected operating system. You can use it "
11963 "to detect install images, live CDs and similar."
11967 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
11968 msgid "Currently defined formats are:"
11972 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1851
11973 msgid "\"installed\""
11977 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1853
11978 msgid "This is an installed operating system."
11982 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1855
11983 msgid "\"installer\""
11987 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
11989 "The disk image being inspected is not an installed operating system, but a "
11990 "I<bootable> install disk, live CD, or similar."
11994 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
11995 msgid "The format of this disk image is not known."
12000 #: ../src/guestfs-actions.pod:2732
12001 msgid "guestfs_inspect_get_hostname"
12006 #: ../src/guestfs-actions.pod:2734
12010 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12011 " const char *root);\n"
12017 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1878
12019 "This function returns the hostname of the operating system as found by "
12020 "inspection of the guest's configuration files."
12025 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
12027 "If the hostname could not be determined, then the string C<unknown> is "
12033 #: ../src/guestfs-actions.pod:2752
12034 msgid "(Added in 1.7.9)"
12039 #: ../src/guestfs-actions.pod:2754
12040 msgid "guestfs_inspect_get_major_version"
12045 #: ../src/guestfs-actions.pod:2756
12049 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12050 " const char *root);\n"
12056 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1893
12058 "This returns the major version number of the inspected operating system."
12063 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
12065 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12066 "popular public names used by the operating system. Notably the operating "
12067 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12068 "1). You can find out the real versions corresponding to releases of Windows "
12069 "by consulting Wikipedia or MSDN."
12074 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2793
12075 #: ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1917
12076 msgid "If the version could not be determined, then C<0> is returned."
12081 #: ../src/guestfs-actions.pod:2781
12082 msgid "guestfs_inspect_get_minor_version"
12087 #: ../src/guestfs-actions.pod:2783
12091 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12092 " const char *root);\n"
12098 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1914
12100 "This returns the minor version number of the inspected operating system."
12105 #: ../src/guestfs-actions.pod:2795
12107 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12108 "C<guestfs_inspect_get_major_version>."
12113 #: ../src/guestfs-actions.pod:2802
12114 msgid "guestfs_inspect_get_mountpoints"
12119 #: ../src/guestfs-actions.pod:2804
12123 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12124 " const char *root);\n"
12129 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1929
12131 "This returns a hash of where we think the filesystems associated with this "
12132 "operating system should be mounted. Callers should note that this is at "
12133 "best an educated guess made by reading configuration files such as C</etc/"
12134 "fstab>. I<In particular note> that this may return filesystems which are "
12135 "non-existent or not mountable and callers should be prepared to handle or "
12136 "ignore failures if they try to mount them."
12141 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
12143 "Each element in the returned hashtable has a key which is the path of the "
12144 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12145 "mounted there (eg. C</dev/sda1>)."
12150 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
12152 "Non-mounted devices such as swap devices are I<not> returned in this list."
12156 #: ../src/guestfs-actions.pod:2828
12158 "For operating systems like Windows which still use drive letters, this call "
12159 "will only return an entry for the first drive \"mounted on\" C</>. For "
12160 "information about the mapping of drive letters to partitions, see "
12161 "C<guestfs_inspect_get_drive_mappings>."
12166 #: ../src/guestfs-actions.pod:2834
12168 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12169 "C<guestfs_inspect_get_filesystems>."
12174 #: ../src/guestfs-actions.pod:2845
12175 msgid "guestfs_inspect_get_package_format"
12180 #: ../src/guestfs-actions.pod:2847
12184 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12185 " const char *root);\n"
12191 #: ../src/guestfs-actions.pod:2854
12193 "This function and C<guestfs_inspect_get_package_management> return the "
12194 "package format and package management tool used by the inspected operating "
12195 "system. For example for Fedora these functions would return C<rpm> (package "
12196 "format) and C<yum> (package management)."
12201 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1968
12203 "This returns the string C<unknown> if we could not determine the package "
12204 "format I<or> if the operating system does not have a real packaging system "
12210 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1972
12212 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12213 "Future versions of libguestfs may return other strings."
12218 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903
12219 msgid "(Added in 1.7.5)"
12224 #: ../src/guestfs-actions.pod:2874
12225 msgid "guestfs_inspect_get_package_management"
12230 #: ../src/guestfs-actions.pod:2876
12234 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12235 " const char *root);\n"
12241 #: ../src/guestfs-actions.pod:2883
12243 "C<guestfs_inspect_get_package_format> and this function return the package "
12244 "format and package management tool used by the inspected operating system. "
12245 "For example for Fedora these functions would return C<rpm> (package format) "
12246 "and C<yum> (package management)."
12251 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1990
12253 "This returns the string C<unknown> if we could not determine the package "
12254 "management tool I<or> if the operating system does not have a real packaging "
12255 "system (eg. Windows)."
12260 #: ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1994
12262 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12263 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12264 "libguestfs may return other strings."
12269 #: ../src/guestfs-actions.pod:2905
12270 msgid "guestfs_inspect_get_product_name"
12275 #: ../src/guestfs-actions.pod:2907
12279 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12280 " const char *root);\n"
12286 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
12288 "This returns the product name of the inspected operating system. The "
12289 "product name is generally some freeform string which can be displayed to the "
12290 "user, but should not be parsed by programs."
12295 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
12297 "If the product name could not be determined, then the string C<unknown> is "
12302 #: ../src/guestfs-actions.pod:2929
12303 msgid "guestfs_inspect_get_product_variant"
12307 #: ../src/guestfs-actions.pod:2931
12311 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12312 " const char *root);\n"
12317 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2025
12318 msgid "This returns the product variant of the inspected operating system."
12322 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
12324 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12325 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12326 "is usually a string such as C<Client> or C<Server> (other values are "
12327 "possible). This can be used to distinguish consumer and enterprise versions "
12328 "of Windows that have the same version number (for example, Windows 7 and "
12329 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12330 "the latter is C<Server>)."
12334 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2037
12336 "For enterprise Linux guests, in future we intend this to return the product "
12337 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12338 "implemented at present."
12342 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2041
12344 "If the product variant could not be determined, then the string C<unknown> "
12349 #: ../src/guestfs-actions.pod:2957
12351 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12352 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12357 #: ../src/guestfs-actions.pod:2964
12358 msgid "guestfs_inspect_get_roots"
12363 #: ../src/guestfs-actions.pod:2966
12367 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12373 #: ../src/guestfs-actions.pod:2969
12375 "This function is a convenient way to get the list of root devices, as "
12376 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12377 "the whole inspection process."
12382 #: ../src/guestfs-actions.pod:2973
12384 "This returns an empty list if either no root devices were found or the "
12385 "caller has not called C<guestfs_inspect_os>."
12390 #: ../src/guestfs-actions.pod:2982
12391 msgid "(Added in 1.7.3)"
12396 #: ../src/guestfs-actions.pod:2984
12397 msgid "guestfs_inspect_get_type"
12402 #: ../src/guestfs-actions.pod:2986
12406 " guestfs_inspect_get_type (guestfs_h *g,\n"
12407 " const char *root);\n"
12413 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
12415 "This returns the type of the inspected operating system. Currently defined "
12421 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
12427 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2075
12428 msgid "Any Linux-based operating system."
12433 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2079
12434 msgid "Any Microsoft Windows operating system."
12439 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2081
12440 msgid "\"freebsd\""
12445 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2083
12451 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2087
12452 msgid "The operating system type could not be determined."
12456 #: ../src/guestfs-actions.pod:3026
12457 msgid "guestfs_inspect_get_windows_current_control_set"
12461 #: ../src/guestfs-actions.pod:3028
12465 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12466 " const char *root);\n"
12471 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2103
12473 "This returns the Windows CurrentControlSet of the inspected guest. The "
12474 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12478 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
12480 "This call assumes that the guest is Windows and that the Registry could be "
12481 "examined by inspection. If this is not the case then an error is returned."
12486 #: ../src/guestfs-actions.pod:3047
12487 msgid "guestfs_inspect_get_windows_systemroot"
12492 #: ../src/guestfs-actions.pod:3049
12496 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12497 " const char *root);\n"
12503 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2119
12505 "This returns the Windows systemroot of the inspected guest. The systemroot "
12506 "is a directory path such as C</WINDOWS>."
12511 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
12513 "This call assumes that the guest is Windows and that the systemroot could be "
12514 "determined by inspection. If this is not the case then an error is returned."
12519 #: ../src/guestfs-actions.pod:3068
12520 msgid "(Added in 1.5.25)"
12524 #: ../src/guestfs-actions.pod:3070
12525 msgid "guestfs_inspect_is_live"
12529 #: ../src/guestfs-actions.pod:3072
12533 " guestfs_inspect_is_live (guestfs_h *g,\n"
12534 " const char *root);\n"
12539 #: ../src/guestfs-actions.pod:3079
12541 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12542 "disk), then this returns true if a live image was detected on the disk."
12546 #: ../src/guestfs-actions.pod:3087
12547 msgid "guestfs_inspect_is_multipart"
12551 #: ../src/guestfs-actions.pod:3089
12555 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12556 " const char *root);\n"
12561 #: ../src/guestfs-actions.pod:3096
12563 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12564 "disk), then this returns true if the disk is part of a set."
12568 #: ../src/guestfs-actions.pod:3104
12569 msgid "guestfs_inspect_is_netinst"
12573 #: ../src/guestfs-actions.pod:3106
12577 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12578 " const char *root);\n"
12583 #: ../src/guestfs-actions.pod:3113
12585 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12586 "disk), then this returns true if the disk is a network installer, ie. not a "
12587 "self-contained install CD but one which is likely to require network access "
12588 "to complete the install."
12593 #: ../src/guestfs-actions.pod:3123
12594 msgid "guestfs_inspect_list_applications"
12599 #: ../src/guestfs-actions.pod:3125
12602 " struct guestfs_application_list *\n"
12603 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12604 " const char *root);\n"
12610 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2176
12611 msgid "Return the list of applications installed in the operating system."
12616 #: ../src/guestfs-actions.pod:3134
12618 "I<Note:> This call works differently from other parts of the inspection "
12619 "API. You have to call C<guestfs_inspect_os>, then "
12620 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12621 "this. Listing applications is a significantly more difficult operation "
12622 "which requires access to the full filesystem. Also note that unlike the "
12623 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12624 "the libguestfs handle, this call actually reads parts of the mounted "
12625 "filesystems during the call."
12630 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2188
12632 "This returns an empty list if the inspection code was not able to determine "
12633 "the list of applications."
12638 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
12639 msgid "The application structure contains the following fields:"
12644 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
12645 msgid "C<app_name>"
12650 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
12652 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12653 "guests, this is the package name."
12658 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12659 msgid "C<app_display_name>"
12664 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
12666 "The display name of the application, sometimes localized to the install "
12667 "language of the guest operating system."
12672 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12674 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12675 "to display something can use C<app_name> instead."
12680 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12681 msgid "C<app_epoch>"
12686 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
12688 "For package managers which use epochs, this contains the epoch of the "
12689 "package (an integer). If unavailable, this is returned as C<0>."
12694 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12695 msgid "C<app_version>"
12700 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
12702 "The version string of the application or package. If unavailable this is "
12703 "returned as an empty string C<\"\">."
12708 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
12709 msgid "C<app_release>"
12714 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
12716 "The release string of the application or package, for package managers that "
12717 "use this. If unavailable this is returned as an empty string C<\"\">."
12722 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
12723 msgid "C<app_install_path>"
12728 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
12730 "The installation path of the application (on operating systems such as "
12731 "Windows which use installation paths). This path is in the format used by "
12732 "the guest operating system, it is not a libguestfs path."
12737 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
12738 msgid "If unavailable this is returned as an empty string C<\"\">."
12743 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
12744 msgid "C<app_trans_path>"
12749 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
12751 "The install path translated into a libguestfs path. If unavailable this is "
12752 "returned as an empty string C<\"\">."
12757 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
12758 msgid "C<app_publisher>"
12763 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
12765 "The name of the publisher of the application, for package managers that use "
12766 "this. If unavailable this is returned as an empty string C<\"\">."
12771 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
12777 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
12779 "The URL (eg. upstream URL) of the application. If unavailable this is "
12780 "returned as an empty string C<\"\">."
12785 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12786 msgid "C<app_source_package>"
12791 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
12793 "For packaging systems which support this, the name of the source package. "
12794 "If unavailable this is returned as an empty string C<\"\">."
12799 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12800 msgid "C<app_summary>"
12805 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
12807 "A short (usually one line) description of the application or package. If "
12808 "unavailable this is returned as an empty string C<\"\">."
12813 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
12814 msgid "C<app_description>"
12819 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
12821 "A longer description of the application or package. If unavailable this is "
12822 "returned as an empty string C<\"\">."
12827 #: ../src/guestfs-actions.pod:3224
12829 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12830 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12836 #: ../src/guestfs-actions.pod:3228
12837 msgid "(Added in 1.7.8)"
12842 #: ../src/guestfs-actions.pod:3230
12843 msgid "guestfs_inspect_os"
12848 #: ../src/guestfs-actions.pod:3232
12852 " guestfs_inspect_os (guestfs_h *g);\n"
12858 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2272
12860 "This function uses other libguestfs functions and certain heuristics to "
12861 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12862 "for operating systems."
12867 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2276
12868 msgid "The list returned is empty if no operating systems were found."
12873 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2278
12875 "If one operating system was found, then this returns a list with a single "
12876 "element, which is the name of the root filesystem of this operating system. "
12877 "It is also possible for this function to return a list containing more than "
12878 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12879 "element being the root filesystem of one of the operating systems."
12884 #: ../src/guestfs-actions.pod:3248
12886 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12887 "functions in order to query further information about each operating system, "
12888 "such as the name and version."
12893 #: ../src/guestfs-actions.pod:3253
12895 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12896 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12897 "the contents. This should be called with no disks currently mounted. The "
12898 "function may also use Augeas, so any existing Augeas handle will be closed."
12903 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2296
12905 "This function cannot decrypt encrypted disks. The caller must do that first "
12906 "(supplying the necessary keys) if the disk is encrypted."
12911 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3555
12912 #: ../src/guestfs-actions.pod:3617
12913 msgid "See also C<guestfs_list_filesystems>."
12918 #: ../src/guestfs-actions.pod:3273
12919 msgid "guestfs_is_blockdev"
12924 #: ../src/guestfs-actions.pod:3275
12928 " guestfs_is_blockdev (guestfs_h *g,\n"
12929 " const char *path);\n"
12935 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2308
12937 "This returns C<true> if and only if there is a block device with the given "
12943 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3311
12944 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:3356
12945 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3428
12946 #: ../src/guestfs-actions.pod:3443
12947 msgid "See also C<guestfs_stat>."
12952 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3315
12953 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3432
12954 #: ../src/guestfs-actions.pod:3447
12955 msgid "(Added in 1.5.10)"
12960 #: ../src/guestfs-actions.pod:3288
12961 msgid "guestfs_is_busy"
12966 #: ../src/guestfs-actions.pod:3290
12970 " guestfs_is_busy (guestfs_h *g);\n"
12976 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2317
12978 "This returns true iff this handle is busy processing a command (in the "
12984 #: ../src/guestfs-actions.pod:3302
12985 msgid "guestfs_is_chardev"
12990 #: ../src/guestfs-actions.pod:3304
12994 " guestfs_is_chardev (guestfs_h *g,\n"
12995 " const char *path);\n"
13001 #: ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:2326
13003 "This returns C<true> if and only if there is a character device with the "
13004 "given C<path> name."
13009 #: ../src/guestfs-actions.pod:3317
13010 msgid "guestfs_is_config"
13015 #: ../src/guestfs-actions.pod:3319
13019 " guestfs_is_config (guestfs_h *g);\n"
13025 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2335
13027 "This returns true iff this handle is being configured (in the C<CONFIG> "
13033 #: ../src/guestfs-actions.pod:3331
13034 msgid "guestfs_is_dir"
13039 #: ../src/guestfs-actions.pod:3333
13043 " guestfs_is_dir (guestfs_h *g,\n"
13044 " const char *path);\n"
13050 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2344
13052 "This returns C<true> if and only if there is a directory with the given "
13053 "C<path> name. Note that it returns false for other objects like files."
13058 #: ../src/guestfs-actions.pod:3347
13059 msgid "guestfs_is_fifo"
13064 #: ../src/guestfs-actions.pod:3349
13068 " guestfs_is_fifo (guestfs_h *g,\n"
13069 " const char *path);\n"
13075 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2354
13077 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13078 "given C<path> name."
13083 #: ../src/guestfs-actions.pod:3362
13084 msgid "guestfs_is_file"
13089 #: ../src/guestfs-actions.pod:3364
13093 " guestfs_is_file (guestfs_h *g,\n"
13094 " const char *path);\n"
13100 #: ../src/guestfs-actions.pod:3368 ../fish/guestfish-actions.pod:2363
13102 "This returns C<true> if and only if there is a regular file with the given "
13103 "C<path> name. Note that it returns false for other objects like directories."
13108 #: ../src/guestfs-actions.pod:3378
13109 msgid "guestfs_is_launching"
13114 #: ../src/guestfs-actions.pod:3380
13118 " guestfs_is_launching (guestfs_h *g);\n"
13124 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2373
13126 "This returns true iff this handle is launching the subprocess (in the "
13127 "C<LAUNCHING> state)."
13132 #: ../src/guestfs-actions.pod:3392
13133 msgid "guestfs_is_lv"
13138 #: ../src/guestfs-actions.pod:3394
13142 " guestfs_is_lv (guestfs_h *g,\n"
13143 " const char *device);\n"
13149 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2382
13151 "This command tests whether C<device> is a logical volume, and returns true "
13152 "iff this is the case."
13157 #: ../src/guestfs-actions.pod:3405
13158 msgid "guestfs_is_ready"
13163 #: ../src/guestfs-actions.pod:3407
13167 " guestfs_is_ready (guestfs_h *g);\n"
13173 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2389
13175 "This returns true iff this handle is ready to accept commands (in the "
13181 #: ../src/guestfs-actions.pod:3419
13182 msgid "guestfs_is_socket"
13187 #: ../src/guestfs-actions.pod:3421
13191 " guestfs_is_socket (guestfs_h *g,\n"
13192 " const char *path);\n"
13198 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2398
13200 "This returns C<true> if and only if there is a Unix domain socket with the "
13201 "given C<path> name."
13206 #: ../src/guestfs-actions.pod:3434
13207 msgid "guestfs_is_symlink"
13212 #: ../src/guestfs-actions.pod:3436
13216 " guestfs_is_symlink (guestfs_h *g,\n"
13217 " const char *path);\n"
13223 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:2407
13225 "This returns C<true> if and only if there is a symbolic link with the given "
13231 #: ../src/guestfs-actions.pod:3449
13232 msgid "guestfs_kill_subprocess"
13237 #: ../src/guestfs-actions.pod:3451
13241 " guestfs_kill_subprocess (guestfs_h *g);\n"
13247 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2416
13248 msgid "This kills the qemu subprocess. You should never need to call this."
13253 #: ../src/guestfs-actions.pod:3460
13254 msgid "guestfs_launch"
13259 #: ../src/guestfs-actions.pod:3462
13263 " guestfs_launch (guestfs_h *g);\n"
13269 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2424
13271 "Internally libguestfs is implemented by running a virtual machine using "
13277 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
13279 "You should call this after configuring the handle (eg. adding drives) but "
13280 "before performing any actions."
13285 #: ../src/guestfs-actions.pod:3480
13286 msgid "guestfs_lchown"
13291 #: ../src/guestfs-actions.pod:3482
13295 " guestfs_lchown (guestfs_h *g,\n"
13298 " const char *path);\n"
13304 #: ../src/guestfs-actions.pod:3488
13306 "Change the file owner to C<owner> and group to C<group>. This is like "
13307 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13308 "changed, not the target."
13313 #: ../src/guestfs-actions.pod:3500
13314 msgid "guestfs_lgetxattr"
13319 #: ../src/guestfs-actions.pod:3502
13323 " guestfs_lgetxattr (guestfs_h *g,\n"
13324 " const char *path,\n"
13325 " const char *name,\n"
13326 " size_t *size_r);\n"
13332 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2446
13334 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13335 "is a symlink, then this call returns an extended attribute from the symlink."
13340 #: ../src/guestfs-actions.pod:3522
13341 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13346 #: ../src/guestfs-actions.pod:3530
13347 msgid "guestfs_lgetxattrs"
13352 #: ../src/guestfs-actions.pod:3532
13355 " struct guestfs_xattr_list *\n"
13356 " guestfs_lgetxattrs (guestfs_h *g,\n"
13357 " const char *path);\n"
13363 #: ../src/guestfs-actions.pod:3536
13365 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13366 "then it returns the extended attributes of the link itself."
13371 #: ../src/guestfs-actions.pod:3546
13372 msgid "guestfs_list_devices"
13377 #: ../src/guestfs-actions.pod:3548
13381 " guestfs_list_devices (guestfs_h *g);\n"
13387 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2474
13388 msgid "List all the block devices."
13393 #: ../src/guestfs-actions.pod:3553 ../fish/guestfish-actions.pod:2476
13394 msgid "The full block device names are returned, eg. C</dev/sda>."
13399 #: ../src/guestfs-actions.pod:3563
13400 msgid "guestfs_list_filesystems"
13405 #: ../src/guestfs-actions.pod:3565
13409 " guestfs_list_filesystems (guestfs_h *g);\n"
13415 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2484
13417 "This inspection command looks for filesystems on partitions, block devices "
13418 "and logical volumes, returning a list of devices containing filesystems and "
13424 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2488
13426 "The return value is a hash, where the keys are the devices containing "
13427 "filesystems, and the values are the filesystem types. For example:"
13432 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
13435 " \"/dev/sda1\" => \"ntfs\"\n"
13436 " \"/dev/sda2\" => \"ext2\"\n"
13437 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13438 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13444 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
13446 "The value can have the special value \"unknown\", meaning the content of the "
13447 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13452 #: ../src/guestfs-actions.pod:3585
13454 "This command runs other libguestfs commands, which might include "
13455 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13456 "soon after launch and only when nothing is mounted."
13461 #: ../src/guestfs-actions.pod:3589
13463 "Not all of the filesystems returned will be mountable. In particular, swap "
13464 "partitions are returned in the list. Also this command does not check that "
13465 "each filesystem found is valid and mountable, and some filesystems might be "
13466 "mountable but require special options. Filesystems may not all belong to a "
13467 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13472 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:5215
13473 msgid "(Added in 1.5.15)"
13478 #: ../src/guestfs-actions.pod:3605
13479 msgid "guestfs_list_partitions"
13484 #: ../src/guestfs-actions.pod:3607
13488 " guestfs_list_partitions (guestfs_h *g);\n"
13494 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
13495 msgid "List all the partitions detected on all block devices."
13500 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2519
13501 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13506 #: ../src/guestfs-actions.pod:3614
13508 "This does not return logical volumes. For that you will need to call "
13514 #: ../src/guestfs-actions.pod:3625
13520 #: ../src/guestfs-actions.pod:3627
13524 " guestfs_ll (guestfs_h *g,\n"
13525 " const char *directory);\n"
13531 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2530
13533 "List the files in C<directory> (relative to the root directory, there is no "
13534 "cwd) in the format of 'ls -la'."
13539 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
13541 "This command is mostly useful for interactive sessions. It is I<not> "
13542 "intended that you try to parse the output string."
13547 #: ../src/guestfs-actions.pod:3642
13553 #: ../src/guestfs-actions.pod:3644
13557 " guestfs_ln (guestfs_h *g,\n"
13558 " const char *target,\n"
13559 " const char *linkname);\n"
13565 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2540
13566 msgid "This command creates a hard link using the C<ln> command."
13571 #: ../src/guestfs-actions.pod:3655
13572 msgid "guestfs_ln_f"
13577 #: ../src/guestfs-actions.pod:3657
13581 " guestfs_ln_f (guestfs_h *g,\n"
13582 " const char *target,\n"
13583 " const char *linkname);\n"
13588 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2546
13590 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13591 "option removes the link (C<linkname>) if it exists already."
13596 #: ../src/guestfs-actions.pod:3669
13597 msgid "guestfs_ln_s"
13602 #: ../src/guestfs-actions.pod:3671
13606 " guestfs_ln_s (guestfs_h *g,\n"
13607 " const char *target,\n"
13608 " const char *linkname);\n"
13614 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2553
13615 msgid "This command creates a symbolic link using the C<ln -s> command."
13620 #: ../src/guestfs-actions.pod:3682
13621 msgid "guestfs_ln_sf"
13626 #: ../src/guestfs-actions.pod:3684
13630 " guestfs_ln_sf (guestfs_h *g,\n"
13631 " const char *target,\n"
13632 " const char *linkname);\n"
13637 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2559
13639 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13640 "option removes the link (C<linkname>) if it exists already."
13645 #: ../src/guestfs-actions.pod:3696
13646 msgid "guestfs_lremovexattr"
13651 #: ../src/guestfs-actions.pod:3698
13655 " guestfs_lremovexattr (guestfs_h *g,\n"
13656 " const char *xattr,\n"
13657 " const char *path);\n"
13663 #: ../src/guestfs-actions.pod:3703
13665 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13666 "link, then it removes an extended attribute of the link itself."
13671 #: ../src/guestfs-actions.pod:3711
13677 #: ../src/guestfs-actions.pod:3713
13681 " guestfs_ls (guestfs_h *g,\n"
13682 " const char *directory);\n"
13688 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2574
13690 "List the files in C<directory> (relative to the root directory, there is no "
13691 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13696 #: ../src/guestfs-actions.pod:3721
13698 "This command is mostly useful for interactive sessions. Programs should "
13699 "probably use C<guestfs_readdir> instead."
13704 #: ../src/guestfs-actions.pod:3730
13705 msgid "guestfs_lsetxattr"
13710 #: ../src/guestfs-actions.pod:3732
13714 " guestfs_lsetxattr (guestfs_h *g,\n"
13715 " const char *xattr,\n"
13716 " const char *val,\n"
13718 " const char *path);\n"
13724 #: ../src/guestfs-actions.pod:3739
13726 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13727 "then it sets an extended attribute of the link itself."
13732 #: ../src/guestfs-actions.pod:3747
13733 msgid "guestfs_lstat"
13738 #: ../src/guestfs-actions.pod:3749
13741 " struct guestfs_stat *\n"
13742 " guestfs_lstat (guestfs_h *g,\n"
13743 " const char *path);\n"
13749 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:6346
13750 #: ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:4297
13751 msgid "Returns file information for the given C<path>."
13756 #: ../src/guestfs-actions.pod:3755
13758 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13759 "link, then the link is stat-ed, not the file it refers to."
13764 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2599
13765 msgid "This is the same as the C<lstat(2)> system call."
13770 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:6350
13772 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13773 "error. I<The caller must call C<guestfs_free_stat> after use>."
13778 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:6354
13779 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6753
13780 msgid "(Added in 0.9.2)"
13785 #: ../src/guestfs-actions.pod:3767
13786 msgid "guestfs_lstatlist"
13791 #: ../src/guestfs-actions.pod:3769
13794 " struct guestfs_stat_list *\n"
13795 " guestfs_lstatlist (guestfs_h *g,\n"
13796 " const char *path,\n"
13797 " char *const *names);\n"
13803 #: ../src/guestfs-actions.pod:3774
13805 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13806 "files, where all files are in the directory C<path>. C<names> is the list "
13807 "of files from this directory."
13812 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2609
13814 "On return you get a list of stat structs, with a one-to-one correspondence "
13815 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13816 "then the C<ino> field of that structure is set to C<-1>."
13821 #: ../src/guestfs-actions.pod:3783
13823 "This call is intended for programs that want to efficiently list a directory "
13824 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13825 "for a similarly efficient call for getting extended attributes. Very long "
13826 "directory listings might cause the protocol message size to be exceeded, "
13827 "causing this call to fail. The caller must split up such requests into "
13828 "smaller groups of names."
13833 #: ../src/guestfs-actions.pod:3791
13835 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13836 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13841 #: ../src/guestfs-actions.pod:3797
13842 msgid "guestfs_luks_add_key"
13847 #: ../src/guestfs-actions.pod:3799
13851 " guestfs_luks_add_key (guestfs_h *g,\n"
13852 " const char *device,\n"
13853 " const char *key,\n"
13854 " const char *newkey,\n"
13861 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2626
13863 "This command adds a new key on LUKS device C<device>. C<key> is any "
13864 "existing key, and is used to access the device. C<newkey> is the new key to "
13865 "add. C<keyslot> is the key slot that will be replaced."
13870 #: ../src/guestfs-actions.pod:3811
13872 "Note that if C<keyslot> already contains a key, then this command will "
13873 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13878 #: ../src/guestfs-actions.pod:3817 ../src/guestfs-actions.pod:3857
13879 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3900
13880 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3951
13882 "This function takes a key or passphrase parameter which could contain "
13883 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13889 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:3861
13890 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3904
13891 msgid "(Added in 1.5.2)"
13896 #: ../src/guestfs-actions.pod:3823
13897 msgid "guestfs_luks_close"
13902 #: ../src/guestfs-actions.pod:3825
13906 " guestfs_luks_close (guestfs_h *g,\n"
13907 " const char *device);\n"
13913 #: ../src/guestfs-actions.pod:3829
13915 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13916 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13917 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13918 "underlying block device."
13923 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3936
13924 #: ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:4005
13925 #: ../src/guestfs-actions.pod:4053
13926 msgid "(Added in 1.5.1)"
13931 #: ../src/guestfs-actions.pod:3839
13932 msgid "guestfs_luks_format"
13937 #: ../src/guestfs-actions.pod:3841
13941 " guestfs_luks_format (guestfs_h *g,\n"
13942 " const char *device,\n"
13943 " const char *key,\n"
13950 #: ../src/guestfs-actions.pod:3847 ../fish/guestfish-actions.pod:2652
13952 "This command erases existing data on C<device> and formats the device as a "
13953 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13954 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13959 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3877
13960 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4966
13961 #: ../src/guestfs-actions.pod:5746 ../src/guestfs-actions.pod:6153
13962 #: ../src/guestfs-actions.pod:6183 ../src/guestfs-actions.pod:6216
13963 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:2660
13964 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2757
13965 #: ../fish/guestfish-actions.pod:3338 ../fish/guestfish-actions.pod:3858
13966 #: ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4191
13967 #: ../fish/guestfish-actions.pod:4213 ../fish/guestfish-actions.pod:4942
13969 "B<This command is dangerous. Without careful use you can easily destroy all "
13975 #: ../src/guestfs-actions.pod:3863
13976 msgid "guestfs_luks_format_cipher"
13981 #: ../src/guestfs-actions.pod:3865
13985 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13986 " const char *device,\n"
13987 " const char *key,\n"
13989 " const char *cipher);\n"
13995 #: ../src/guestfs-actions.pod:3872
13997 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13998 "set the C<cipher> used."
14003 #: ../src/guestfs-actions.pod:3886
14004 msgid "guestfs_luks_kill_slot"
14009 #: ../src/guestfs-actions.pod:3888
14013 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14014 " const char *device,\n"
14015 " const char *key,\n"
14022 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2680
14024 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14025 "device C<device>. C<key> must be one of the I<other> keys."
14030 #: ../src/guestfs-actions.pod:3906
14031 msgid "guestfs_luks_open"
14036 #: ../src/guestfs-actions.pod:3908
14040 " guestfs_luks_open (guestfs_h *g,\n"
14041 " const char *device,\n"
14042 " const char *key,\n"
14043 " const char *mapname);\n"
14049 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
14051 "This command opens a block device which has been encrypted according to the "
14052 "Linux Unified Key Setup (LUKS) standard."
14057 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
14058 msgid "C<device> is the encrypted block device or partition."
14063 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
14065 "The caller must supply one of the keys associated with the LUKS block "
14066 "device, in the C<key> parameter."
14071 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
14073 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14074 "writes to this block device are decrypted from and encrypted to the "
14075 "underlying C<device> respectively."
14080 #: ../src/guestfs-actions.pod:3926
14082 "If this block device contains LVM volume groups, then calling "
14083 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14089 #: ../src/guestfs-actions.pod:3938
14090 msgid "guestfs_luks_open_ro"
14095 #: ../src/guestfs-actions.pod:3940
14099 " guestfs_luks_open_ro (guestfs_h *g,\n"
14100 " const char *device,\n"
14101 " const char *key,\n"
14102 " const char *mapname);\n"
14108 #: ../src/guestfs-actions.pod:3946
14110 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14116 #: ../src/guestfs-actions.pod:3957
14117 msgid "guestfs_lvcreate"
14122 #: ../src/guestfs-actions.pod:3959
14126 " guestfs_lvcreate (guestfs_h *g,\n"
14127 " const char *logvol,\n"
14128 " const char *volgroup,\n"
14135 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2724
14137 "This creates an LVM logical volume called C<logvol> on the volume group "
14138 "C<volgroup>, with C<size> megabytes."
14143 #: ../src/guestfs-actions.pod:3972
14144 msgid "guestfs_lvm_canonical_lv_name"
14149 #: ../src/guestfs-actions.pod:3974
14153 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14154 " const char *lvname);\n"
14160 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
14162 "This converts alternative naming schemes for LVs that you might find to the "
14163 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14169 #: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:2735
14171 "This command returns an error if the C<lvname> parameter does not refer to a "
14177 #: ../src/guestfs-actions.pod:3985
14178 msgid "See also C<guestfs_is_lv>."
14183 #: ../src/guestfs-actions.pod:3990
14184 msgid "(Added in 1.5.24)"
14189 #: ../src/guestfs-actions.pod:3992
14190 msgid "guestfs_lvm_clear_filter"
14195 #: ../src/guestfs-actions.pod:3994
14199 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14205 #: ../src/guestfs-actions.pod:3997
14207 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14208 "see every block device."
14213 #: ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4042
14214 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2778
14216 "This command also clears the LVM cache and performs a volume group scan."
14221 #: ../src/guestfs-actions.pod:4007
14222 msgid "guestfs_lvm_remove_all"
14227 #: ../src/guestfs-actions.pod:4009
14231 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14237 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2754
14239 "This command removes all LVM logical volumes, volume groups and physical "
14245 #: ../src/guestfs-actions.pod:4022
14246 msgid "guestfs_lvm_set_filter"
14251 #: ../src/guestfs-actions.pod:4024
14255 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14256 " char *const *devices);\n"
14262 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2764
14264 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14265 "block devices in the list C<devices>, and will ignore all other attached "
14271 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2768
14273 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14274 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14275 "there are two types of duplication possible: either cloned PVs/VGs which "
14276 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14277 "same name. In normal operation you cannot create this situation, but you "
14278 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14279 "inside the LVM metadata."
14284 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2781
14285 msgid "You can filter whole block devices or individual partitions."
14290 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2783
14292 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14293 "filesystem), even if you are not filtering out that VG."
14298 #: ../src/guestfs-actions.pod:4055
14299 msgid "guestfs_lvremove"
14304 #: ../src/guestfs-actions.pod:4057
14308 " guestfs_lvremove (guestfs_h *g,\n"
14309 " const char *device);\n"
14315 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2791
14317 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14318 "LV, such as C</dev/VG/LV>."
14323 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
14325 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14331 #: ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:5312
14332 #: ../src/guestfs-actions.pod:7129
14333 msgid "(Added in 1.0.13)"
14338 #: ../src/guestfs-actions.pod:4071
14339 msgid "guestfs_lvrename"
14344 #: ../src/guestfs-actions.pod:4073
14348 " guestfs_lvrename (guestfs_h *g,\n"
14349 " const char *logvol,\n"
14350 " const char *newlogvol);\n"
14356 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2801
14357 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14362 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:7142
14363 msgid "(Added in 1.0.83)"
14368 #: ../src/guestfs-actions.pod:4084
14369 msgid "guestfs_lvresize"
14374 #: ../src/guestfs-actions.pod:4086
14378 " guestfs_lvresize (guestfs_h *g,\n"
14379 " const char *device,\n"
14386 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2807
14388 "This resizes (expands or shrinks) an existing LVM logical volume to "
14389 "C<mbytes>. When reducing, data in the reduced part is lost."
14394 #: ../src/guestfs-actions.pod:4099
14395 msgid "guestfs_lvresize_free"
14400 #: ../src/guestfs-actions.pod:4101
14404 " guestfs_lvresize_free (guestfs_h *g,\n"
14405 " const char *lv,\n"
14412 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2815
14414 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14415 "remaining free space in the volume group. Commonly you would call this with "
14416 "pc = 100 which expands the logical volume as much as possible, using all "
14417 "remaining free space in the volume group."
14422 #: ../src/guestfs-actions.pod:4114
14423 msgid "(Added in 1.3.3)"
14428 #: ../src/guestfs-actions.pod:4116
14429 msgid "guestfs_lvs"
14434 #: ../src/guestfs-actions.pod:4118
14438 " guestfs_lvs (guestfs_h *g);\n"
14444 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2825
14446 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14452 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
14454 "This returns a list of the logical volume device names (eg. C</dev/"
14455 "VolGroup00/LogVol00>)."
14460 #: ../src/guestfs-actions.pod:4127
14461 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14466 #: ../src/guestfs-actions.pod:4135
14467 msgid "guestfs_lvs_full"
14472 #: ../src/guestfs-actions.pod:4137
14475 " struct guestfs_lvm_lv_list *\n"
14476 " guestfs_lvs_full (guestfs_h *g);\n"
14482 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2837
14484 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14485 "(8)> command. The \"full\" version includes all fields."
14490 #: ../src/guestfs-actions.pod:4143
14492 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14493 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14498 #: ../src/guestfs-actions.pod:4149
14499 msgid "guestfs_lvuuid"
14504 #: ../src/guestfs-actions.pod:4151
14508 " guestfs_lvuuid (guestfs_h *g,\n"
14509 " const char *device);\n"
14515 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2844
14516 msgid "This command returns the UUID of the LVM LV C<device>."
14521 #: ../src/guestfs-actions.pod:4162
14522 msgid "guestfs_lxattrlist"
14527 #: ../src/guestfs-actions.pod:4164
14530 " struct guestfs_xattr_list *\n"
14531 " guestfs_lxattrlist (guestfs_h *g,\n"
14532 " const char *path,\n"
14533 " char *const *names);\n"
14539 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2850
14541 "This call allows you to get the extended attributes of multiple files, where "
14542 "all files are in the directory C<path>. C<names> is the list of files from "
14548 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2854
14550 "On return you get a flat list of xattr structs which must be interpreted "
14551 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14552 "C<attrval> in this struct is zero-length to indicate there was an error "
14553 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14554 "number (the number of following attributes for this file, which could be C<"
14555 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14556 "for the first named file. This repeats for the second and subsequent files."
14561 #: ../src/guestfs-actions.pod:4183
14563 "This call is intended for programs that want to efficiently list a directory "
14564 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14565 "a similarly efficient call for getting standard stats. Very long directory "
14566 "listings might cause the protocol message size to be exceeded, causing this "
14567 "call to fail. The caller must split up such requests into smaller groups of "
14573 #: ../src/guestfs-actions.pod:4197
14574 msgid "guestfs_mkdir"
14579 #: ../src/guestfs-actions.pod:4199
14583 " guestfs_mkdir (guestfs_h *g,\n"
14584 " const char *path);\n"
14590 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:2876
14591 msgid "Create a directory named C<path>."
14596 #: ../src/guestfs-actions.pod:4209
14597 msgid "guestfs_mkdir_mode"
14602 #: ../src/guestfs-actions.pod:4211
14606 " guestfs_mkdir_mode (guestfs_h *g,\n"
14607 " const char *path,\n"
14614 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2882
14616 "This command creates a directory, setting the initial permissions of the "
14617 "directory to C<mode>."
14622 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
14624 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14625 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14631 #: ../src/guestfs-actions.pod:4223
14632 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14637 #: ../src/guestfs-actions.pod:4229
14638 msgid "guestfs_mkdir_p"
14643 #: ../src/guestfs-actions.pod:4231
14647 " guestfs_mkdir_p (guestfs_h *g,\n"
14648 " const char *path);\n"
14654 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2895
14656 "Create a directory named C<path>, creating any parent directories as "
14657 "necessary. This is like the C<mkdir -p> shell command."
14662 #: ../src/guestfs-actions.pod:4242
14663 msgid "guestfs_mkdtemp"
14668 #: ../src/guestfs-actions.pod:4244
14672 " guestfs_mkdtemp (guestfs_h *g,\n"
14673 " const char *template);\n"
14679 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
14681 "This command creates a temporary directory. The C<template> parameter "
14682 "should be a full pathname for the temporary directory name with the final "
14683 "six characters being \"XXXXXX\"."
14688 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
14690 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14691 "being suitable for Windows filesystems."
14696 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
14697 msgid "The name of the temporary directory that was created is returned."
14702 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
14703 msgid "The temporary directory is created with mode 0700 and is owned by root."
14708 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
14710 "The caller is responsible for deleting the temporary directory and its "
14711 "contents after use."
14716 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
14717 msgid "See also: L<mkdtemp(3)>"
14722 #: ../src/guestfs-actions.pod:4272
14723 msgid "guestfs_mke2fs_J"
14728 #: ../src/guestfs-actions.pod:4274
14732 " guestfs_mke2fs_J (guestfs_h *g,\n"
14733 " const char *fstype,\n"
14734 " int blocksize,\n"
14735 " const char *device,\n"
14736 " const char *journal);\n"
14742 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2925
14744 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14745 "C<journal>. It is equivalent to the command:"
14750 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2929
14753 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14759 #: ../src/guestfs-actions.pod:4287
14760 msgid "See also C<guestfs_mke2journal>."
14765 #: ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4309
14766 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4343
14767 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4371
14768 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4695
14769 msgid "(Added in 1.0.68)"
14774 #: ../src/guestfs-actions.pod:4293
14775 msgid "guestfs_mke2fs_JL"
14780 #: ../src/guestfs-actions.pod:4295
14784 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14785 " const char *fstype,\n"
14786 " int blocksize,\n"
14787 " const char *device,\n"
14788 " const char *label);\n"
14794 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:2937
14796 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14797 "the journal labeled C<label>."
14802 #: ../src/guestfs-actions.pod:4305
14803 msgid "See also C<guestfs_mke2journal_L>."
14808 #: ../src/guestfs-actions.pod:4311
14809 msgid "guestfs_mke2fs_JU"
14814 #: ../src/guestfs-actions.pod:4313
14818 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14819 " const char *fstype,\n"
14820 " int blocksize,\n"
14821 " const char *device,\n"
14822 " const char *uuid);\n"
14828 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2946
14830 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14831 "the journal with UUID C<uuid>."
14836 #: ../src/guestfs-actions.pod:4323
14837 msgid "See also C<guestfs_mke2journal_U>."
14842 #: ../src/guestfs-actions.pod:4329
14843 msgid "guestfs_mke2journal"
14848 #: ../src/guestfs-actions.pod:4331
14852 " guestfs_mke2journal (guestfs_h *g,\n"
14853 " int blocksize,\n"
14854 " const char *device);\n"
14860 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2955
14862 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14868 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
14871 " mke2fs -O journal_dev -b blocksize device\n"
14877 #: ../src/guestfs-actions.pod:4345
14878 msgid "guestfs_mke2journal_L"
14883 #: ../src/guestfs-actions.pod:4347
14887 " guestfs_mke2journal_L (guestfs_h *g,\n"
14888 " int blocksize,\n"
14889 " const char *label,\n"
14890 " const char *device);\n"
14896 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:2964
14897 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14902 #: ../src/guestfs-actions.pod:4359
14903 msgid "guestfs_mke2journal_U"
14908 #: ../src/guestfs-actions.pod:4361
14912 " guestfs_mke2journal_U (guestfs_h *g,\n"
14913 " int blocksize,\n"
14914 " const char *uuid,\n"
14915 " const char *device);\n"
14921 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2970
14922 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14927 #: ../src/guestfs-actions.pod:4373
14928 msgid "guestfs_mkfifo"
14933 #: ../src/guestfs-actions.pod:4375
14937 " guestfs_mkfifo (guestfs_h *g,\n"
14939 " const char *path);\n"
14945 #: ../src/guestfs-actions.pod:4380
14947 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14948 "is just a convenient wrapper around C<guestfs_mknod>."
14953 #: ../src/guestfs-actions.pod:4390
14954 msgid "guestfs_mkfs"
14959 #: ../src/guestfs-actions.pod:4392
14963 " guestfs_mkfs (guestfs_h *g,\n"
14964 " const char *fstype,\n"
14965 " const char *device);\n"
14971 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2986
14973 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14974 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14979 #: ../src/guestfs-actions.pod:4405
14980 msgid "guestfs_mkfs_b"
14985 #: ../src/guestfs-actions.pod:4407
14989 " guestfs_mkfs_b (guestfs_h *g,\n"
14990 " const char *fstype,\n"
14991 " int blocksize,\n"
14992 " const char *device);\n"
14998 #: ../src/guestfs-actions.pod:4413
15000 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15001 "block size of the resulting filesystem. Supported block sizes depend on the "
15002 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15007 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4461
15008 #: ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3026
15010 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15016 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:3002
15018 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15023 #: ../src/guestfs-actions.pod:4432
15024 msgid "guestfs_mkfs_opts"
15029 #: ../src/guestfs-actions.pod:4434
15033 " guestfs_mkfs_opts (guestfs_h *g,\n"
15034 " const char *fstype,\n"
15035 " const char *device,\n"
15041 #: ../src/guestfs-actions.pod:4445
15044 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15045 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15051 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3013
15053 "This function creates a filesystem on C<device>. The filesystem type is "
15054 "C<fstype>, for example C<ext3>."
15059 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:3020
15060 msgid "C<blocksize>"
15065 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3022
15067 "The filesystem block size. Supported block sizes depend on the filesystem "
15068 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15073 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3029
15074 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15078 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3031
15079 msgid "C<features>"
15083 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3033
15084 msgid "This passes the I<-O> parameter to the external mkfs program."
15088 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3035
15090 "For certain filesystem types, this allows extra filesystem features to be "
15091 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15095 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3039
15097 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15102 #: ../src/guestfs-actions.pod:4481
15103 msgid "(Added in 1.7.19)"
15108 #: ../src/guestfs-actions.pod:4483
15109 msgid "guestfs_mkfs_opts_va"
15114 #: ../src/guestfs-actions.pod:4485
15118 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15119 " const char *fstype,\n"
15120 " const char *device,\n"
15121 " va_list args);\n"
15127 #: ../src/guestfs-actions.pod:4491
15128 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15133 #: ../src/guestfs-actions.pod:4495
15134 msgid "guestfs_mkfs_opts_argv"
15139 #: ../src/guestfs-actions.pod:4497
15143 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15144 " const char *fstype,\n"
15145 " const char *device,\n"
15146 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15152 #: ../src/guestfs-actions.pod:4503
15153 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15158 #: ../src/guestfs-actions.pod:4507
15159 msgid "guestfs_mkmountpoint"
15164 #: ../src/guestfs-actions.pod:4509
15168 " guestfs_mkmountpoint (guestfs_h *g,\n"
15169 " const char *exemptpath);\n"
15175 #: ../src/guestfs-actions.pod:4513
15177 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15178 "that can be used to create extra mountpoints before mounting the first "
15184 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3054
15186 "These calls are I<only> necessary in some very limited circumstances, mainly "
15187 "the case where you want to mount a mix of unrelated and/or read-only "
15188 "filesystems together."
15193 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
15195 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15196 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15197 "inside that. You can unpack this as follows in guestfish:"
15202 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
15205 " add-ro Fedora-11-i686-Live.iso\n"
15207 " mkmountpoint /cd\n"
15208 " mkmountpoint /sqsh\n"
15209 " mkmountpoint /ext3fs\n"
15210 " mount /dev/sda /cd\n"
15211 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15212 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15218 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3072
15219 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15224 #: ../src/guestfs-actions.pod:4537
15226 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15227 "may get unexpected errors if you try to mix these calls. It is safest to "
15228 "manually unmount filesystems and remove mountpoints after use."
15233 #: ../src/guestfs-actions.pod:4541
15235 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15236 "first, so for this to work for manual mountpoints, you must ensure that the "
15237 "innermost mountpoints have the longest pathnames, as in the example code "
15243 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3083
15245 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15249 #: ../src/guestfs-actions.pod:4548
15251 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15252 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15253 "can also trigger these issues."
15258 #: ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4820
15259 #: ../src/guestfs-actions.pod:5730
15260 msgid "(Added in 1.0.62)"
15265 #: ../src/guestfs-actions.pod:4556
15266 msgid "guestfs_mknod"
15271 #: ../src/guestfs-actions.pod:4558
15275 " guestfs_mknod (guestfs_h *g,\n"
15279 " const char *path);\n"
15285 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3093
15287 "This call creates block or character special devices, or named pipes (FIFOs)."
15292 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
15294 "The C<mode> parameter should be the mode, using the standard constants. "
15295 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15296 "used when creating block and character special devices."
15301 #: ../src/guestfs-actions.pod:4573
15303 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15304 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15305 "regular file). These constants are available in the standard Linux header "
15306 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15307 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15308 "the appropriate constant for you."
15313 #: ../src/guestfs-actions.pod:4587
15314 msgid "guestfs_mknod_b"
15319 #: ../src/guestfs-actions.pod:4589
15323 " guestfs_mknod_b (guestfs_h *g,\n"
15327 " const char *path);\n"
15333 #: ../src/guestfs-actions.pod:4596
15335 "This call creates a block device node called C<path> with mode C<mode> and "
15336 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15337 "wrapper around C<guestfs_mknod>."
15342 #: ../src/guestfs-actions.pod:4606
15343 msgid "guestfs_mknod_c"
15348 #: ../src/guestfs-actions.pod:4608
15352 " guestfs_mknod_c (guestfs_h *g,\n"
15356 " const char *path);\n"
15362 #: ../src/guestfs-actions.pod:4615
15364 "This call creates a char device node called C<path> with mode C<mode> and "
15365 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15366 "wrapper around C<guestfs_mknod>."
15371 #: ../src/guestfs-actions.pod:4625
15372 msgid "guestfs_mkswap"
15377 #: ../src/guestfs-actions.pod:4627
15381 " guestfs_mkswap (guestfs_h *g,\n"
15382 " const char *device);\n"
15388 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3135
15389 msgid "Create a swap partition on C<device>."
15394 #: ../src/guestfs-actions.pod:4637
15395 msgid "guestfs_mkswap_L"
15400 #: ../src/guestfs-actions.pod:4639
15404 " guestfs_mkswap_L (guestfs_h *g,\n"
15405 " const char *label,\n"
15406 " const char *device);\n"
15412 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3141
15413 msgid "Create a swap partition on C<device> with label C<label>."
15418 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3143
15420 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15421 "sda>), just to a partition. This appears to be a limitation of the kernel "
15427 #: ../src/guestfs-actions.pod:4654
15428 msgid "guestfs_mkswap_U"
15433 #: ../src/guestfs-actions.pod:4656
15437 " guestfs_mkswap_U (guestfs_h *g,\n"
15438 " const char *uuid,\n"
15439 " const char *device);\n"
15445 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3151
15446 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15451 #: ../src/guestfs-actions.pod:4667
15452 msgid "guestfs_mkswap_file"
15457 #: ../src/guestfs-actions.pod:4669
15461 " guestfs_mkswap_file (guestfs_h *g,\n"
15462 " const char *path);\n"
15468 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3157
15469 msgid "Create a swap file."
15474 #: ../src/guestfs-actions.pod:4675
15476 "This command just writes a swap file signature to an existing file. To "
15477 "create the file itself, use something like C<guestfs_fallocate>."
15482 #: ../src/guestfs-actions.pod:4682
15483 msgid "guestfs_modprobe"
15488 #: ../src/guestfs-actions.pod:4684
15492 " guestfs_modprobe (guestfs_h *g,\n"
15493 " const char *modulename);\n"
15499 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3166
15500 msgid "This loads a kernel module in the appliance."
15505 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3168
15507 "The kernel module must have been whitelisted when libguestfs was built (see "
15508 "C<appliance/kmod.whitelist.in> in the source)."
15513 #: ../src/guestfs-actions.pod:4697
15514 msgid "guestfs_mount"
15519 #: ../src/guestfs-actions.pod:4699
15523 " guestfs_mount (guestfs_h *g,\n"
15524 " const char *device,\n"
15525 " const char *mountpoint);\n"
15531 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3175
15533 "Mount a guest disk at a position in the filesystem. Block devices are named "
15534 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15535 "those block devices contain partitions, they will have the usual names (eg. "
15536 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15541 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
15543 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15544 "mounted on C</> before others can be mounted. Other filesystems can only be "
15545 "mounted on directories which already exist."
15550 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
15552 "The mounted filesystem is writable, if we have sufficient permissions on the "
15553 "underlying device."
15558 #: ../src/guestfs-actions.pod:4718
15560 "B<Important note:> When you use this call, the filesystem options C<sync> "
15561 "and C<noatime> are set implicitly. This was originally done because we "
15562 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15563 "very large negative performance impact and negligible effect on "
15564 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15565 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15566 "(use an empty string for the first parameter if you don't want any options)."
15570 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3199
15572 "This function is deprecated. In new code, use the C<mount_options> call "
15578 #: ../src/guestfs-actions.pod:4739
15579 msgid "guestfs_mount_loop"
15584 #: ../src/guestfs-actions.pod:4741
15588 " guestfs_mount_loop (guestfs_h *g,\n"
15589 " const char *file,\n"
15590 " const char *mountpoint);\n"
15596 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3210
15598 "This command lets you mount C<file> (a filesystem image in a file) on a "
15599 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15605 #: ../src/guestfs-actions.pod:4754
15606 msgid "guestfs_mount_options"
15611 #: ../src/guestfs-actions.pod:4756
15615 " guestfs_mount_options (guestfs_h *g,\n"
15616 " const char *options,\n"
15617 " const char *device,\n"
15618 " const char *mountpoint);\n"
15624 #: ../src/guestfs-actions.pod:4762
15626 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15627 "the mount options as for the L<mount(8)> I<-o> flag."
15632 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3222
15634 "If the C<options> parameter is an empty string, then no options are passed "
15635 "(all options default to whatever the filesystem uses)."
15640 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4786
15641 #: ../src/guestfs-actions.pod:4803
15642 msgid "(Added in 1.0.10)"
15647 #: ../src/guestfs-actions.pod:4774
15648 msgid "guestfs_mount_ro"
15653 #: ../src/guestfs-actions.pod:4776
15657 " guestfs_mount_ro (guestfs_h *g,\n"
15658 " const char *device,\n"
15659 " const char *mountpoint);\n"
15665 #: ../src/guestfs-actions.pod:4781
15667 "This is the same as the C<guestfs_mount> command, but it mounts the "
15668 "filesystem with the read-only (I<-o ro>) flag."
15673 #: ../src/guestfs-actions.pod:4788
15674 msgid "guestfs_mount_vfs"
15679 #: ../src/guestfs-actions.pod:4790
15683 " guestfs_mount_vfs (guestfs_h *g,\n"
15684 " const char *options,\n"
15685 " const char *vfstype,\n"
15686 " const char *device,\n"
15687 " const char *mountpoint);\n"
15693 #: ../src/guestfs-actions.pod:4797
15695 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15696 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15702 #: ../src/guestfs-actions.pod:4805
15703 msgid "guestfs_mountpoints"
15708 #: ../src/guestfs-actions.pod:4807
15712 " guestfs_mountpoints (guestfs_h *g);\n"
15718 #: ../src/guestfs-actions.pod:4810
15720 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15721 "devices. This one returns a hash table (map) of device name to directory "
15722 "where the device is mounted."
15727 #: ../src/guestfs-actions.pod:4822
15728 msgid "guestfs_mounts"
15733 #: ../src/guestfs-actions.pod:4824
15737 " guestfs_mounts (guestfs_h *g);\n"
15743 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3253
15745 "This returns the list of currently mounted filesystems. It returns the list "
15746 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15751 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3256
15752 msgid "Some internal mounts are not shown."
15757 #: ../src/guestfs-actions.pod:4832
15758 msgid "See also: C<guestfs_mountpoints>"
15763 #: ../src/guestfs-actions.pod:4840
15769 #: ../src/guestfs-actions.pod:4842
15773 " guestfs_mv (guestfs_h *g,\n"
15774 " const char *src,\n"
15775 " const char *dest);\n"
15781 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3264
15783 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15784 "destination filename or destination directory."
15789 #: ../src/guestfs-actions.pod:4854
15790 msgid "guestfs_ntfs_3g_probe"
15795 #: ../src/guestfs-actions.pod:4856
15799 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15801 " const char *device);\n"
15807 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
15809 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15810 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15811 "write, and some cannot be mounted at all)."
15816 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
15818 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15819 "can be mounted read-write. Set it to false if you want to test if the "
15820 "volume can be mounted read-only."
15825 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3279
15827 "The return value is an integer which C<0> if the operation would succeed, or "
15828 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15833 #: ../src/guestfs-actions.pod:4875
15834 msgid "(Added in 1.0.43)"
15839 #: ../src/guestfs-actions.pod:4877
15840 msgid "guestfs_ntfsresize"
15845 #: ../src/guestfs-actions.pod:4879
15849 " guestfs_ntfsresize (guestfs_h *g,\n"
15850 " const char *device);\n"
15856 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3287
15858 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15859 "size of the underlying device. See also L<ntfsresize(8)>."
15864 #: ../src/guestfs-actions.pod:4891
15865 msgid "guestfs_ntfsresize_size"
15870 #: ../src/guestfs-actions.pod:4893
15874 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15875 " const char *device,\n"
15876 " int64_t size);\n"
15882 #: ../src/guestfs-actions.pod:4898
15884 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15885 "to specify the new size (in bytes) explicitly."
15890 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:5339
15891 #: ../src/guestfs-actions.pod:5412 ../src/guestfs-actions.pod:5678
15892 #: ../src/guestfs-actions.pod:7284
15893 msgid "(Added in 1.3.14)"
15898 #: ../src/guestfs-actions.pod:4905
15899 msgid "guestfs_part_add"
15904 #: ../src/guestfs-actions.pod:4907
15908 " guestfs_part_add (guestfs_h *g,\n"
15909 " const char *device,\n"
15910 " const char *prlogex,\n"
15911 " int64_t startsect,\n"
15912 " int64_t endsect);\n"
15918 #: ../src/guestfs-actions.pod:4914
15920 "This command adds a partition to C<device>. If there is no partition table "
15921 "on the device, call C<guestfs_part_init> first."
15926 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3305
15928 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15929 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15930 "C<logical>) and C<e> (or C<extended>) partition types."
15935 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3310
15937 "C<startsect> and C<endsect> are the start and end of the partition in "
15938 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15939 "from the end of the disk (C<-1> is the last sector)."
15944 #: ../src/guestfs-actions.pod:4926
15946 "Creating a partition which covers the whole disk is not so easy. Use "
15947 "C<guestfs_part_disk> to do that."
15952 #: ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4969
15953 #: ../src/guestfs-actions.pod:5022 ../src/guestfs-actions.pod:5100
15954 #: ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5157
15955 #: ../src/guestfs-actions.pod:5197
15956 msgid "(Added in 1.0.78)"
15961 #: ../src/guestfs-actions.pod:4933
15962 msgid "guestfs_part_del"
15967 #: ../src/guestfs-actions.pod:4935
15971 " guestfs_part_del (guestfs_h *g,\n"
15972 " const char *device,\n"
15979 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3321
15980 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15985 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3323
15987 "Note that in the case of MBR partitioning, deleting an extended partition "
15988 "also deletes any logical partitions it contains."
15993 #: ../src/guestfs-actions.pod:4950
15994 msgid "guestfs_part_disk"
15999 #: ../src/guestfs-actions.pod:4952
16003 " guestfs_part_disk (guestfs_h *g,\n"
16004 " const char *device,\n"
16005 " const char *parttype);\n"
16011 #: ../src/guestfs-actions.pod:4957
16013 "This command is simply a combination of C<guestfs_part_init> followed by "
16014 "C<guestfs_part_add> to create a single primary partition covering the whole "
16020 #: ../src/guestfs-actions.pod:4961
16022 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16023 "possible values are described in C<guestfs_part_init>."
16028 #: ../src/guestfs-actions.pod:4971
16029 msgid "guestfs_part_get_bootable"
16034 #: ../src/guestfs-actions.pod:4973
16038 " guestfs_part_get_bootable (guestfs_h *g,\n"
16039 " const char *device,\n"
16046 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3345
16048 "This command returns true if the partition C<partnum> on C<device> has the "
16049 "bootable flag set."
16054 #: ../src/guestfs-actions.pod:4981
16055 msgid "See also C<guestfs_part_set_bootable>."
16060 #: ../src/guestfs-actions.pod:4987
16061 msgid "guestfs_part_get_mbr_id"
16066 #: ../src/guestfs-actions.pod:4989
16070 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16071 " const char *device,\n"
16078 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3354
16080 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16081 "partition C<partnum>."
16086 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5173
16088 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16089 "undefined results for other partition table types (see "
16090 "C<guestfs_part_get_parttype>)."
16095 #: ../src/guestfs-actions.pod:5005
16096 msgid "guestfs_part_get_parttype"
16101 #: ../src/guestfs-actions.pod:5007
16105 " guestfs_part_get_parttype (guestfs_h *g,\n"
16106 " const char *device);\n"
16112 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3365
16114 "This command examines the partition table on C<device> and returns the "
16115 "partition table type (format) being used."
16120 #: ../src/guestfs-actions.pod:5014
16122 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16123 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16124 "possible, although unusual. See C<guestfs_part_init> for a full list."
16129 #: ../src/guestfs-actions.pod:5024
16130 msgid "guestfs_part_init"
16135 #: ../src/guestfs-actions.pod:5026
16139 " guestfs_part_init (guestfs_h *g,\n"
16140 " const char *device,\n"
16141 " const char *parttype);\n"
16147 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3377
16149 "This creates an empty partition table on C<device> of one of the partition "
16150 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16151 "(for large disks)."
16156 #: ../src/guestfs-actions.pod:5035
16158 "Initially there are no partitions. Following this, you should call "
16159 "C<guestfs_part_add> for each partition required."
16164 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
16165 msgid "Possible values for C<parttype> are:"
16170 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
16171 msgid "B<efi> | B<gpt>"
16176 #: ../src/guestfs-actions.pod:5044 ../fish/guestfish-actions.pod:3390
16177 msgid "Intel EFI / GPT partition table."
16182 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
16184 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16185 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16186 "the C<mbr> format."
16191 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3396
16192 msgid "B<mbr> | B<msdos>"
16197 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
16199 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16200 "Windows. This partition type will B<only> work for device sizes up to 2 "
16201 "TB. For large disks we recommend using C<gpt>."
16206 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3405
16208 "Other partition table types that may work but are not supported include:"
16213 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16219 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16220 msgid "AIX disk labels."
16225 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16226 msgid "B<amiga> | B<rdb>"
16231 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
16232 msgid "Amiga \"Rigid Disk Block\" format."
16237 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
16243 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
16244 msgid "BSD disk labels."
16249 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
16255 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16256 msgid "DASD, used on IBM mainframes."
16261 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16267 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16268 msgid "MIPS/SGI volumes."
16273 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
16279 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
16280 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16285 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
16291 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
16292 msgid "NEC PC-98 format, common in Japan apparently."
16297 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3438
16303 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3440
16304 msgid "Sun disk labels."
16309 #: ../src/guestfs-actions.pod:5102
16310 msgid "guestfs_part_list"
16315 #: ../src/guestfs-actions.pod:5104
16318 " struct guestfs_partition_list *\n"
16319 " guestfs_part_list (guestfs_h *g,\n"
16320 " const char *device);\n"
16326 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3448
16328 "This command parses the partition table on C<device> and returns the list of "
16329 "partitions found."
16334 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
16335 msgid "The fields in the returned structure are:"
16340 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
16341 msgid "B<part_num>"
16346 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3457
16347 msgid "Partition number, counting from 1."
16352 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3459
16353 msgid "B<part_start>"
16358 #: ../src/guestfs-actions.pod:5121
16360 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16361 "the device's sector size, see C<guestfs_blockdev_getss>."
16366 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
16367 msgid "B<part_end>"
16372 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
16373 msgid "End of the partition in bytes."
16378 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3468
16379 msgid "B<part_size>"
16384 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3470
16385 msgid "Size of the partition in bytes."
16390 #: ../src/guestfs-actions.pod:5134
16392 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16393 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16399 #: ../src/guestfs-actions.pod:5140
16400 msgid "guestfs_part_set_bootable"
16405 #: ../src/guestfs-actions.pod:5142
16409 " guestfs_part_set_bootable (guestfs_h *g,\n"
16410 " const char *device,\n"
16412 " int bootable);\n"
16418 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3478
16420 "This sets the bootable flag on partition numbered C<partnum> on device "
16421 "C<device>. Note that partitions are numbered from 1."
16426 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3481
16428 "The bootable flag is used by some operating systems (notably Windows) to "
16429 "determine which partition to boot from. It is by no means universally "
16435 #: ../src/guestfs-actions.pod:5159
16436 msgid "guestfs_part_set_mbr_id"
16441 #: ../src/guestfs-actions.pod:5161
16445 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16446 " const char *device,\n"
16454 #: ../src/guestfs-actions.pod:5167 ../fish/guestfish-actions.pod:3489
16456 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16457 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16458 "documentation are in fact hexadecimal numbers, but usually documented "
16459 "without any leading \"0x\" which might be confusing."
16464 #: ../src/guestfs-actions.pod:5181
16465 msgid "guestfs_part_set_name"
16470 #: ../src/guestfs-actions.pod:5183
16474 " guestfs_part_set_name (guestfs_h *g,\n"
16475 " const char *device,\n"
16477 " const char *name);\n"
16483 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3503
16485 "This sets the partition name on partition numbered C<partnum> on device "
16486 "C<device>. Note that partitions are numbered from 1."
16491 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3506
16493 "The partition name can only be set on certain types of partition table. "
16494 "This works on C<gpt> but not on C<mbr> partitions."
16499 #: ../src/guestfs-actions.pod:5199
16500 msgid "guestfs_part_to_dev"
16505 #: ../src/guestfs-actions.pod:5201
16509 " guestfs_part_to_dev (guestfs_h *g,\n"
16510 " const char *partition);\n"
16516 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3513
16518 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16519 "partition number, returning the device name (eg. \"/dev/sdb\")."
16524 #: ../src/guestfs-actions.pod:5209
16526 "The named partition must exist, for example as a string returned from "
16527 "C<guestfs_list_partitions>."
16532 #: ../src/guestfs-actions.pod:5217
16533 msgid "guestfs_ping_daemon"
16538 #: ../src/guestfs-actions.pod:5219
16542 " guestfs_ping_daemon (guestfs_h *g);\n"
16548 #: ../src/guestfs-actions.pod:5222 ../fish/guestfish-actions.pod:3524
16550 "This is a test probe into the guestfs daemon running inside the qemu "
16551 "subprocess. Calling this function checks that the daemon responds to the "
16552 "ping message, without affecting the daemon or attached block device(s) in "
16558 #: ../src/guestfs-actions.pod:5231
16559 msgid "guestfs_pread"
16564 #: ../src/guestfs-actions.pod:5233
16568 " guestfs_pread (guestfs_h *g,\n"
16569 " const char *path,\n"
16571 " int64_t offset,\n"
16572 " size_t *size_r);\n"
16578 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3533
16580 "This command lets you read part of a file. It reads C<count> bytes of the "
16581 "file, starting at C<offset>, from file C<path>."
16586 #: ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5269
16587 #: ../fish/guestfish-actions.pod:3536 ../fish/guestfish-actions.pod:3551
16589 "This may read fewer bytes than requested. For further details see the "
16590 "L<pread(2)> system call."
16595 #: ../src/guestfs-actions.pod:5246
16596 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16601 #: ../src/guestfs-actions.pod:5257
16602 msgid "guestfs_pread_device"
16607 #: ../src/guestfs-actions.pod:5259
16611 " guestfs_pread_device (guestfs_h *g,\n"
16612 " const char *device,\n"
16614 " int64_t offset,\n"
16615 " size_t *size_r);\n"
16621 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3548
16623 "This command lets you read part of a file. It reads C<count> bytes of "
16624 "C<device>, starting at C<offset>."
16629 #: ../src/guestfs-actions.pod:5272
16630 msgid "See also C<guestfs_pread>."
16635 #: ../src/guestfs-actions.pod:5281
16636 msgid "(Added in 1.5.21)"
16641 #: ../src/guestfs-actions.pod:5283
16642 msgid "guestfs_pvcreate"
16647 #: ../src/guestfs-actions.pod:5285
16651 " guestfs_pvcreate (guestfs_h *g,\n"
16652 " const char *device);\n"
16658 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3563
16660 "This creates an LVM physical volume on the named C<device>, where C<device> "
16661 "should usually be a partition name such as C</dev/sda1>."
16666 #: ../src/guestfs-actions.pod:5297
16667 msgid "guestfs_pvremove"
16672 #: ../src/guestfs-actions.pod:5299
16676 " guestfs_pvremove (guestfs_h *g,\n"
16677 " const char *device);\n"
16683 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3571
16685 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16691 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3574
16693 "The implementation uses the C<pvremove> command which refuses to wipe "
16694 "physical volumes that contain any volume groups, so you have to remove those "
16700 #: ../src/guestfs-actions.pod:5314
16701 msgid "guestfs_pvresize"
16706 #: ../src/guestfs-actions.pod:5316
16710 " guestfs_pvresize (guestfs_h *g,\n"
16711 " const char *device);\n"
16717 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3582
16719 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16720 "the new size of the underlying device."
16725 #: ../src/guestfs-actions.pod:5327
16726 msgid "guestfs_pvresize_size"
16731 #: ../src/guestfs-actions.pod:5329
16735 " guestfs_pvresize_size (guestfs_h *g,\n"
16736 " const char *device,\n"
16737 " int64_t size);\n"
16743 #: ../src/guestfs-actions.pod:5334
16745 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16746 "specify the new size (in bytes) explicitly."
16751 #: ../src/guestfs-actions.pod:5341
16752 msgid "guestfs_pvs"
16757 #: ../src/guestfs-actions.pod:5343
16761 " guestfs_pvs (guestfs_h *g);\n"
16767 #: ../src/guestfs-actions.pod:5346 ../fish/guestfish-actions.pod:3596
16769 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16775 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3599
16777 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16783 #: ../src/guestfs-actions.pod:5352
16784 msgid "See also C<guestfs_pvs_full>."
16789 #: ../src/guestfs-actions.pod:5360
16790 msgid "guestfs_pvs_full"
16795 #: ../src/guestfs-actions.pod:5362
16798 " struct guestfs_lvm_pv_list *\n"
16799 " guestfs_pvs_full (guestfs_h *g);\n"
16805 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3608
16807 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16808 "(8)> command. The \"full\" version includes all fields."
16813 #: ../src/guestfs-actions.pod:5368
16815 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16816 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16821 #: ../src/guestfs-actions.pod:5374
16822 msgid "guestfs_pvuuid"
16827 #: ../src/guestfs-actions.pod:5376
16831 " guestfs_pvuuid (guestfs_h *g,\n"
16832 " const char *device);\n"
16838 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3615
16839 msgid "This command returns the UUID of the LVM PV C<device>."
16844 #: ../src/guestfs-actions.pod:5387
16845 msgid "guestfs_pwrite"
16850 #: ../src/guestfs-actions.pod:5389
16854 " guestfs_pwrite (guestfs_h *g,\n"
16855 " const char *path,\n"
16856 " const char *content,\n"
16857 " size_t content_size,\n"
16858 " int64_t offset);\n"
16864 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3621
16866 "This command writes to part of a file. It writes the data buffer C<content> "
16867 "to the file C<path> starting at offset C<offset>."
16872 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3624
16874 "This command implements the L<pwrite(2)> system call, and like that system "
16875 "call it may not write the full data requested. The return value is the "
16876 "number of bytes that were actually written to the file. This could even be "
16877 "0, although short writes are unlikely for regular files in ordinary "
16883 #: ../src/guestfs-actions.pod:5405
16884 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16889 #: ../src/guestfs-actions.pod:5414
16890 msgid "guestfs_pwrite_device"
16895 #: ../src/guestfs-actions.pod:5416
16899 " guestfs_pwrite_device (guestfs_h *g,\n"
16900 " const char *device,\n"
16901 " const char *content,\n"
16902 " size_t content_size,\n"
16903 " int64_t offset);\n"
16909 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3639
16911 "This command writes to part of a device. It writes the data buffer "
16912 "C<content> to C<device> starting at offset C<offset>."
16917 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3642
16919 "This command implements the L<pwrite(2)> system call, and like that system "
16920 "call it may not write the full data requested (although short writes to disk "
16921 "devices and partitions are probably impossible with standard Linux kernels)."
16926 #: ../src/guestfs-actions.pod:5431
16927 msgid "See also C<guestfs_pwrite>."
16932 #: ../src/guestfs-actions.pod:5438
16933 msgid "(Added in 1.5.20)"
16938 #: ../src/guestfs-actions.pod:5440
16939 msgid "guestfs_read_file"
16944 #: ../src/guestfs-actions.pod:5442
16948 " guestfs_read_file (guestfs_h *g,\n"
16949 " const char *path,\n"
16950 " size_t *size_r);\n"
16956 #: ../src/guestfs-actions.pod:5447 ../fish/guestfish-actions.pod:3656
16957 msgid "This calls returns the contents of the file C<path> as a buffer."
16962 #: ../src/guestfs-actions.pod:5450
16964 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16965 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16966 "function is limited in the total size of file that can be handled."
16971 #: ../src/guestfs-actions.pod:5462
16972 msgid "(Added in 1.0.63)"
16977 #: ../src/guestfs-actions.pod:5464
16978 msgid "guestfs_read_lines"
16983 #: ../src/guestfs-actions.pod:5466
16987 " guestfs_read_lines (guestfs_h *g,\n"
16988 " const char *path);\n"
16994 #: ../src/guestfs-actions.pod:5472 ../fish/guestfish-actions.pod:3673
16996 "The file contents are returned as a list of lines. Trailing C<LF> and "
16997 "C<CRLF> character sequences are I<not> returned."
17002 #: ../src/guestfs-actions.pod:5475
17004 "Note that this function cannot correctly handle binary files (specifically, "
17005 "files containing C<\\0> character which is treated as end of line). For "
17006 "those you need to use the C<guestfs_read_file> function which has a more "
17007 "complex interface."
17012 #: ../src/guestfs-actions.pod:5486
17013 msgid "guestfs_readdir"
17018 #: ../src/guestfs-actions.pod:5488
17021 " struct guestfs_dirent_list *\n"
17022 " guestfs_readdir (guestfs_h *g,\n"
17023 " const char *dir);\n"
17029 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3685
17030 msgid "This returns the list of directory entries in directory C<dir>."
17035 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
17037 "All entries in the directory are returned, including C<.> and C<..>. The "
17038 "entries are I<not> sorted, but returned in the same order as the underlying "
17044 #: ../src/guestfs-actions.pod:5498 ../fish/guestfish-actions.pod:3691
17046 "Also this call returns basic file type information about each file. The "
17047 "C<ftyp> field will contain one of the following characters:"
17052 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
17058 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
17059 msgid "Block special"
17064 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
17070 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
17071 msgid "Char special"
17076 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
17082 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
17088 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
17094 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
17095 msgid "FIFO (named pipe)"
17100 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
17106 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
17107 msgid "Symbolic link"
17112 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
17118 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
17119 msgid "Regular file"
17124 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
17130 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
17136 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
17142 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
17143 msgid "Unknown file type"
17148 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3728
17154 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3730
17156 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17161 #: ../src/guestfs-actions.pod:5542
17163 "This function is primarily intended for use by programs. To get a simple "
17164 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17165 "consumption, use C<guestfs_ll>."
17170 #: ../src/guestfs-actions.pod:5546
17172 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17173 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17178 #: ../src/guestfs-actions.pod:5552
17179 msgid "guestfs_readlink"
17184 #: ../src/guestfs-actions.pod:5554
17188 " guestfs_readlink (guestfs_h *g,\n"
17189 " const char *path);\n"
17195 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3743
17196 msgid "This command reads the target of a symbolic link."
17201 #: ../src/guestfs-actions.pod:5565
17202 msgid "guestfs_readlinklist"
17207 #: ../src/guestfs-actions.pod:5567
17211 " guestfs_readlinklist (guestfs_h *g,\n"
17212 " const char *path,\n"
17213 " char *const *names);\n"
17219 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
17221 "This call allows you to do a C<readlink> operation on multiple files, where "
17222 "all files are in the directory C<path>. C<names> is the list of files from "
17228 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
17230 "On return you get a list of strings, with a one-to-one correspondence to the "
17231 "C<names> list. Each string is the value of the symbolic link."
17236 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3757
17238 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17239 "result string is the empty string C<\"\">. However the whole operation is "
17240 "completed even if there were C<readlink(2)> errors, and so you can call this "
17241 "function with names where you don't know if they are symbolic links already "
17242 "(albeit slightly less efficient)."
17247 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:3764
17249 "This call is intended for programs that want to efficiently list a directory "
17250 "contents without making many round-trips. Very long directory listings "
17251 "might cause the protocol message size to be exceeded, causing this call to "
17252 "fail. The caller must split up such requests into smaller groups of names."
17257 #: ../src/guestfs-actions.pod:5600
17258 msgid "guestfs_realpath"
17263 #: ../src/guestfs-actions.pod:5602
17267 " guestfs_realpath (guestfs_h *g,\n"
17268 " const char *path);\n"
17274 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3775
17276 "Return the canonicalized absolute pathname of C<path>. The returned path "
17277 "has no C<.>, C<..> or symbolic link path elements."
17282 #: ../src/guestfs-actions.pod:5614
17283 msgid "guestfs_removexattr"
17288 #: ../src/guestfs-actions.pod:5616
17292 " guestfs_removexattr (guestfs_h *g,\n"
17293 " const char *xattr,\n"
17294 " const char *path);\n"
17300 #: ../src/guestfs-actions.pod:5621 ../fish/guestfish-actions.pod:3782
17302 "This call removes the extended attribute named C<xattr> of the file C<path>."
17307 #: ../src/guestfs-actions.pod:5624
17308 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17313 #: ../src/guestfs-actions.pod:5630
17314 msgid "guestfs_resize2fs"
17319 #: ../src/guestfs-actions.pod:5632
17323 " guestfs_resize2fs (guestfs_h *g,\n"
17324 " const char *device);\n"
17330 #: ../src/guestfs-actions.pod:5636 ../fish/guestfish-actions.pod:3791
17332 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17333 "underlying device."
17338 #: ../src/guestfs-actions.pod:5639
17340 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17341 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17342 "sometimes gives an error about this and sometimes not. In any case, it is "
17343 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17347 #: ../src/guestfs-actions.pod:5649
17348 msgid "guestfs_resize2fs_M"
17352 #: ../src/guestfs-actions.pod:5651
17356 " guestfs_resize2fs_M (guestfs_h *g,\n"
17357 " const char *device);\n"
17362 #: ../src/guestfs-actions.pod:5655
17364 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17365 "resized to its minimum size. This works like the I<-M> option to the "
17366 "C<resize2fs> command."
17370 #: ../src/guestfs-actions.pod:5659
17372 "To get the resulting size of the filesystem you should call "
17373 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17374 "These two numbers, multiplied together, give the resulting size of the "
17375 "minimal filesystem in bytes."
17380 #: ../src/guestfs-actions.pod:5666
17381 msgid "guestfs_resize2fs_size"
17386 #: ../src/guestfs-actions.pod:5668
17390 " guestfs_resize2fs_size (guestfs_h *g,\n"
17391 " const char *device,\n"
17392 " int64_t size);\n"
17398 #: ../src/guestfs-actions.pod:5673
17400 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17401 "to specify the new size (in bytes) explicitly."
17406 #: ../src/guestfs-actions.pod:5680
17412 #: ../src/guestfs-actions.pod:5682
17416 " guestfs_rm (guestfs_h *g,\n"
17417 " const char *path);\n"
17423 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3824
17424 msgid "Remove the single file C<path>."
17429 #: ../src/guestfs-actions.pod:5692
17430 msgid "guestfs_rm_rf"
17435 #: ../src/guestfs-actions.pod:5694
17439 " guestfs_rm_rf (guestfs_h *g,\n"
17440 " const char *path);\n"
17446 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3830
17448 "Remove the file or directory C<path>, recursively removing the contents if "
17449 "its a directory. This is like the C<rm -rf> shell command."
17454 #: ../src/guestfs-actions.pod:5706
17455 msgid "guestfs_rmdir"
17460 #: ../src/guestfs-actions.pod:5708
17464 " guestfs_rmdir (guestfs_h *g,\n"
17465 " const char *path);\n"
17471 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3838
17472 msgid "Remove the single directory C<path>."
17477 #: ../src/guestfs-actions.pod:5718
17478 msgid "guestfs_rmmountpoint"
17483 #: ../src/guestfs-actions.pod:5720
17487 " guestfs_rmmountpoint (guestfs_h *g,\n"
17488 " const char *exemptpath);\n"
17494 #: ../src/guestfs-actions.pod:5724
17496 "This calls removes a mountpoint that was previously created with "
17497 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17502 #: ../src/guestfs-actions.pod:5732
17503 msgid "guestfs_scrub_device"
17508 #: ../src/guestfs-actions.pod:5734
17512 " guestfs_scrub_device (guestfs_h *g,\n"
17513 " const char *device);\n"
17519 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3852
17521 "This command writes patterns over C<device> to make data retrieval more "
17527 #: ../src/guestfs-actions.pod:5741 ../src/guestfs-actions.pod:5762
17528 #: ../src/guestfs-actions.pod:5781 ../fish/guestfish-actions.pod:3855
17529 #: ../fish/guestfish-actions.pod:3870 ../fish/guestfish-actions.pod:3883
17531 "It is an interface to the L<scrub(1)> program. See that manual page for "
17537 #: ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5767
17538 #: ../src/guestfs-actions.pod:5786
17539 msgid "(Added in 1.0.52)"
17544 #: ../src/guestfs-actions.pod:5751
17545 msgid "guestfs_scrub_file"
17550 #: ../src/guestfs-actions.pod:5753
17554 " guestfs_scrub_file (guestfs_h *g,\n"
17555 " const char *file);\n"
17561 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3865
17563 "This command writes patterns over a file to make data retrieval more "
17569 #: ../src/guestfs-actions.pod:5760 ../fish/guestfish-actions.pod:3868
17570 msgid "The file is I<removed> after scrubbing."
17575 #: ../src/guestfs-actions.pod:5769
17576 msgid "guestfs_scrub_freespace"
17581 #: ../src/guestfs-actions.pod:5771
17585 " guestfs_scrub_freespace (guestfs_h *g,\n"
17586 " const char *dir);\n"
17592 #: ../src/guestfs-actions.pod:5775
17594 "This command creates the directory C<dir> and then fills it with files until "
17595 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17596 "and deletes them. The intention is to scrub any free space on the partition "
17597 "containing C<dir>."
17602 #: ../src/guestfs-actions.pod:5788
17603 msgid "guestfs_set_append"
17608 #: ../src/guestfs-actions.pod:5790
17612 " guestfs_set_append (guestfs_h *g,\n"
17613 " const char *append);\n"
17619 #: ../src/guestfs-actions.pod:5794 ../fish/guestfish-actions.pod:3892
17621 "This function is used to add additional options to the guest kernel command "
17627 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3895
17629 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17630 "environment variable."
17635 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3898
17637 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17638 "(libguestfs always adds a few of its own)."
17642 #: ../src/guestfs-actions.pod:5807
17643 msgid "guestfs_set_attach_method"
17647 #: ../src/guestfs-actions.pod:5809
17651 " guestfs_set_attach_method (guestfs_h *g,\n"
17652 " const char *attachmethod);\n"
17657 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
17659 "Set the method that libguestfs uses to connect to the back end guestfsd "
17660 "daemon. Possible methods are:"
17664 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3914
17666 "Launch an appliance and connect to it. This is the ordinary method and the "
17671 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
17672 msgid "C<unix:I<path>>"
17676 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3919
17677 msgid "Connect to the Unix domain socket I<path>."
17681 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
17683 "This method lets you connect to an existing daemon or (using virtio-serial) "
17684 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17685 "RUNNING DAEMONS>."
17690 #: ../src/guestfs-actions.pod:5835
17691 msgid "guestfs_set_autosync"
17696 #: ../src/guestfs-actions.pod:5837
17700 " guestfs_set_autosync (guestfs_h *g,\n"
17701 " int autosync);\n"
17706 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3933
17708 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17709 "effort attempt to make filesystems consistent and synchronized when the "
17710 "handle is closed (also if the program exits without closing handles)."
17715 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3938
17717 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17718 "disabled by default)."
17723 #: ../src/guestfs-actions.pod:5853
17724 msgid "guestfs_set_direct"
17729 #: ../src/guestfs-actions.pod:5855
17733 " guestfs_set_direct (guestfs_h *g,\n"
17740 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3947
17742 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17743 "passed directly through to the appliance once it is launched."
17748 #: ../src/guestfs-actions.pod:5863
17750 "One consequence of this is that log messages aren't caught by the library "
17751 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17757 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3955
17758 msgid "You probably don't want to use this unless you know what you are doing."
17763 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3958
17764 msgid "The default is disabled."
17769 #: ../src/guestfs-actions.pod:5876
17770 msgid "guestfs_set_e2label"
17775 #: ../src/guestfs-actions.pod:5878
17779 " guestfs_set_e2label (guestfs_h *g,\n"
17780 " const char *device,\n"
17781 " const char *label);\n"
17787 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3964
17789 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17790 "C<label>. Filesystem labels are limited to 16 characters."
17795 #: ../src/guestfs-actions.pod:5887
17797 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17798 "the existing label on a filesystem."
17803 #: ../src/guestfs-actions.pod:5894
17804 msgid "guestfs_set_e2uuid"
17809 #: ../src/guestfs-actions.pod:5896
17813 " guestfs_set_e2uuid (guestfs_h *g,\n"
17814 " const char *device,\n"
17815 " const char *uuid);\n"
17821 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3975
17823 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17824 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17825 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17830 #: ../src/guestfs-actions.pod:5906
17832 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17833 "the existing UUID of a filesystem."
17838 #: ../src/guestfs-actions.pod:5913
17839 msgid "guestfs_set_memsize"
17844 #: ../src/guestfs-actions.pod:5915
17848 " guestfs_set_memsize (guestfs_h *g,\n"
17855 #: ../src/guestfs-actions.pod:5919
17857 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17858 "This only has any effect if called before C<guestfs_launch>."
17863 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3993
17865 "You can also change this by setting the environment variable "
17866 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17871 #: ../src/guestfs-actions.pod:5934
17872 msgid "guestfs_set_network"
17877 #: ../src/guestfs-actions.pod:5936
17881 " guestfs_set_network (guestfs_h *g,\n"
17888 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:4006
17890 "If C<network> is true, then the network is enabled in the libguestfs "
17891 "appliance. The default is false."
17896 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:4009
17898 "This affects whether commands are able to access the network (see L<guestfs"
17899 "(3)/RUNNING COMMANDS>)."
17904 #: ../src/guestfs-actions.pod:5946
17906 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17912 #: ../src/guestfs-actions.pod:5953
17913 msgid "guestfs_set_path"
17918 #: ../src/guestfs-actions.pod:5955
17922 " guestfs_set_path (guestfs_h *g,\n"
17923 " const char *searchpath);\n"
17929 #: ../src/guestfs-actions.pod:5959 ../fish/guestfish-actions.pod:4021
17930 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17935 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4023
17937 "The default is C<$libdir/guestfs> unless overridden by setting "
17938 "C<LIBGUESTFS_PATH> environment variable."
17943 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4026
17944 msgid "Setting C<path> to C<NULL> restores the default path."
17949 #: ../src/guestfs-actions.pod:5970
17950 msgid "guestfs_set_qemu"
17955 #: ../src/guestfs-actions.pod:5972
17959 " guestfs_set_qemu (guestfs_h *g,\n"
17960 " const char *qemu);\n"
17966 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4034
17967 msgid "Set the qemu binary that we will use."
17972 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4036
17974 "The default is chosen when the library was compiled by the configure script."
17979 #: ../src/guestfs-actions.pod:5981 ../fish/guestfish-actions.pod:4039
17981 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17987 #: ../src/guestfs-actions.pod:5984 ../fish/guestfish-actions.pod:4042
17988 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17993 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:4044
17995 "Note that you should call this function as early as possible after creating "
17996 "the handle. This is because some pre-launch operations depend on testing "
17997 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17998 "don't retest features, and so you might see inconsistent results. Using the "
17999 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18000 "the qemu binary at the same time as the handle is created."
18005 #: ../src/guestfs-actions.pod:5998
18006 msgid "guestfs_set_recovery_proc"
18011 #: ../src/guestfs-actions.pod:6000
18015 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18016 " int recoveryproc);\n"
18022 #: ../src/guestfs-actions.pod:6004
18024 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18025 "not create a recovery process. The purpose of the recovery process is to "
18026 "stop runaway qemu processes in the case where the main program aborts "
18032 #: ../src/guestfs-actions.pod:6009
18034 "This only has any effect if called before C<guestfs_launch>, and the default "
18040 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:4066
18042 "About the only time when you would want to disable this is if the main "
18043 "process will fork itself into the background (\"daemonize\" itself). In "
18044 "this case the recovery process thinks that the main program has disappeared "
18045 "and so kills qemu, which is not very helpful."
18050 #: ../src/guestfs-actions.pod:6022
18051 msgid "guestfs_set_selinux"
18056 #: ../src/guestfs-actions.pod:6024
18060 " guestfs_set_selinux (guestfs_h *g,\n"
18067 #: ../src/guestfs-actions.pod:6028 ../fish/guestfish-actions.pod:4078
18069 "This sets the selinux flag that is passed to the appliance at boot time. "
18070 "The default is C<selinux=0> (disabled)."
18075 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4081
18077 "Note that if SELinux is enabled, it is always in Permissive mode "
18078 "(C<enforcing=0>)."
18083 #: ../src/guestfs-actions.pod:6041
18084 msgid "guestfs_set_trace"
18089 #: ../src/guestfs-actions.pod:6043
18093 " guestfs_set_trace (guestfs_h *g,\n"
18099 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4093
18101 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18102 "return values are traced."
18107 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
18109 "If you want to trace C API calls into libguestfs (and other libraries) then "
18110 "possibly a better way is to use the external ltrace(1) command."
18115 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:4100
18117 "Command traces are disabled unless the environment variable "
18118 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18122 #: ../src/guestfs-actions.pod:6057
18124 "Trace messages are normally sent to C<stderr>, unless you register a "
18125 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18130 #: ../src/guestfs-actions.pod:6065
18131 msgid "guestfs_set_verbose"
18136 #: ../src/guestfs-actions.pod:6067
18140 " guestfs_set_verbose (guestfs_h *g,\n"
18146 #: ../src/guestfs-actions.pod:6071 ../fish/guestfish-actions.pod:4113
18147 msgid "If C<verbose> is true, this turns on verbose messages."
18152 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4115
18154 "Verbose messages are disabled unless the environment variable "
18155 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18159 #: ../src/guestfs-actions.pod:6076
18161 "Verbose messages are normally sent to C<stderr>, unless you register a "
18162 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18167 #: ../src/guestfs-actions.pod:6084
18168 msgid "guestfs_setcon"
18173 #: ../src/guestfs-actions.pod:6086
18177 " guestfs_setcon (guestfs_h *g,\n"
18178 " const char *context);\n"
18184 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4126
18186 "This sets the SELinux security context of the daemon to the string "
18192 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4129
18193 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18198 #: ../src/guestfs-actions.pod:6099
18199 msgid "guestfs_setxattr"
18204 #: ../src/guestfs-actions.pod:6101
18208 " guestfs_setxattr (guestfs_h *g,\n"
18209 " const char *xattr,\n"
18210 " const char *val,\n"
18212 " const char *path);\n"
18218 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4135
18220 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18221 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18226 #: ../src/guestfs-actions.pod:6112
18227 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18232 #: ../src/guestfs-actions.pod:6118
18233 msgid "guestfs_sfdisk"
18238 #: ../src/guestfs-actions.pod:6120
18242 " guestfs_sfdisk (guestfs_h *g,\n"
18243 " const char *device,\n"
18247 " char *const *lines);\n"
18253 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4145
18255 "This is a direct interface to the L<sfdisk(8)> program for creating "
18256 "partitions on block devices."
18261 #: ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:4148
18262 msgid "C<device> should be a block device, for example C</dev/sda>."
18267 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4150
18269 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18270 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18271 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18272 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18273 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18274 "the kernel) cannot work out the right geometry and you will need to tell it."
18279 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4158
18281 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18282 "refer to the L<sfdisk(8)> manpage."
18287 #: ../src/guestfs-actions.pod:6144 ../fish/guestfish-actions.pod:4161
18289 "To create a single partition occupying the whole disk, you would pass "
18290 "C<lines> as a single element list, when the single element being the string "
18296 #: ../src/guestfs-actions.pod:6148
18298 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18302 #: ../src/guestfs-actions.pod:6156 ../src/guestfs-actions.pod:6186
18303 #: ../src/guestfs-actions.pod:6219 ../fish/guestfish-actions.pod:4171
18304 #: ../fish/guestfish-actions.pod:4194 ../fish/guestfish-actions.pod:4216
18306 "This function is deprecated. In new code, use the C<part_add> call instead."
18311 #: ../src/guestfs-actions.pod:6165
18312 msgid "guestfs_sfdiskM"
18317 #: ../src/guestfs-actions.pod:6167
18321 " guestfs_sfdiskM (guestfs_h *g,\n"
18322 " const char *device,\n"
18323 " char *const *lines);\n"
18329 #: ../src/guestfs-actions.pod:6172
18331 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18332 "partition sizes are specified in megabytes only (rounded to the nearest "
18333 "cylinder) and you don't need to specify the cyls, heads and sectors "
18334 "parameters which were rarely if ever used anyway."
18339 #: ../src/guestfs-actions.pod:6178
18341 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18342 "C<guestfs_part_disk>"
18347 #: ../src/guestfs-actions.pod:6195
18348 msgid "guestfs_sfdisk_N"
18353 #: ../src/guestfs-actions.pod:6197
18357 " guestfs_sfdisk_N (guestfs_h *g,\n"
18358 " const char *device,\n"
18363 " const char *line);\n"
18369 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4205
18371 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18372 "(note: C<n> counts from 1)."
18377 #: ../src/guestfs-actions.pod:6209
18379 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18380 "for the cyls/heads/sectors parameters."
18385 #: ../src/guestfs-actions.pod:6212
18386 msgid "See also: C<guestfs_part_add>"
18391 #: ../src/guestfs-actions.pod:6228
18392 msgid "guestfs_sfdisk_disk_geometry"
18397 #: ../src/guestfs-actions.pod:6230
18401 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18402 " const char *device);\n"
18408 #: ../src/guestfs-actions.pod:6234
18410 "This displays the disk geometry of C<device> read from the partition table. "
18411 "Especially in the case where the underlying block device has been resized, "
18412 "this can be different from the kernel's idea of the geometry (see "
18413 "C<guestfs_sfdisk_kernel_geometry>)."
18418 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6255
18419 #: ../fish/guestfish-actions.pod:4232 ../fish/guestfish-actions.pod:4241
18420 msgid "The result is in human-readable format, and not designed to be parsed."
18425 #: ../src/guestfs-actions.pod:6247
18426 msgid "guestfs_sfdisk_kernel_geometry"
18431 #: ../src/guestfs-actions.pod:6249
18435 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18436 " const char *device);\n"
18442 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4239
18443 msgid "This displays the kernel's idea of the geometry of C<device>."
18448 #: ../src/guestfs-actions.pod:6263
18449 msgid "guestfs_sfdisk_l"
18454 #: ../src/guestfs-actions.pod:6265
18458 " guestfs_sfdisk_l (guestfs_h *g,\n"
18459 " const char *device);\n"
18465 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4248
18467 "This displays the partition table on C<device>, in the human-readable output "
18468 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18473 #: ../src/guestfs-actions.pod:6273
18474 msgid "See also: C<guestfs_part_list>"
18478 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4254
18480 "This function is deprecated. In new code, use the C<part_list> call instead."
18485 #: ../src/guestfs-actions.pod:6287
18491 #: ../src/guestfs-actions.pod:6289
18495 " guestfs_sh (guestfs_h *g,\n"
18496 " const char *command);\n"
18502 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4265
18504 "This call runs a command from the guest filesystem via the guest's C</bin/"
18510 #: ../src/guestfs-actions.pod:6296
18511 msgid "This is like C<guestfs_command>, but passes the command to:"
18516 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4270
18519 " /bin/sh -c \"command\"\n"
18525 #: ../src/guestfs-actions.pod:6300 ../fish/guestfish-actions.pod:4272
18527 "Depending on the guest's shell, this usually results in wildcards being "
18528 "expanded, shell expressions being interpolated and so on."
18533 #: ../src/guestfs-actions.pod:6304
18534 msgid "All the provisos about C<guestfs_command> apply to this call."
18539 #: ../src/guestfs-actions.pod:6311
18540 msgid "guestfs_sh_lines"
18545 #: ../src/guestfs-actions.pod:6313
18549 " guestfs_sh_lines (guestfs_h *g,\n"
18550 " const char *command);\n"
18556 #: ../src/guestfs-actions.pod:6317
18558 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18564 #: ../src/guestfs-actions.pod:6320
18565 msgid "See also: C<guestfs_command_lines>"
18570 #: ../src/guestfs-actions.pod:6328
18571 msgid "guestfs_sleep"
18576 #: ../src/guestfs-actions.pod:6330
18580 " guestfs_sleep (guestfs_h *g,\n"
18587 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4291
18588 msgid "Sleep for C<secs> seconds."
18593 #: ../src/guestfs-actions.pod:6338
18594 msgid "(Added in 1.0.41)"
18599 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-structs.pod:109
18600 msgid "guestfs_stat"
18605 #: ../src/guestfs-actions.pod:6342
18608 " struct guestfs_stat *\n"
18609 " guestfs_stat (guestfs_h *g,\n"
18610 " const char *path);\n"
18616 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4299
18617 msgid "This is the same as the C<stat(2)> system call."
18622 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-structs.pod:135
18623 msgid "guestfs_statvfs"
18628 #: ../src/guestfs-actions.pod:6358
18631 " struct guestfs_statvfs *\n"
18632 " guestfs_statvfs (guestfs_h *g,\n"
18633 " const char *path);\n"
18639 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4305
18641 "Returns file system statistics for any mounted file system. C<path> should "
18642 "be a file or directory in the mounted file system (typically it is the mount "
18643 "point itself, but it doesn't need to be)."
18648 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4309
18649 msgid "This is the same as the C<statvfs(2)> system call."
18654 #: ../src/guestfs-actions.pod:6368
18656 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18657 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18662 #: ../src/guestfs-actions.pod:6374
18663 msgid "guestfs_strings"
18668 #: ../src/guestfs-actions.pod:6376
18672 " guestfs_strings (guestfs_h *g,\n"
18673 " const char *path);\n"
18679 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4315
18681 "This runs the L<strings(1)> command on a file and returns the list of "
18682 "printable strings found."
18687 #: ../src/guestfs-actions.pod:6392
18688 msgid "guestfs_strings_e"
18693 #: ../src/guestfs-actions.pod:6394
18697 " guestfs_strings_e (guestfs_h *g,\n"
18698 " const char *encoding,\n"
18699 " const char *path);\n"
18705 #: ../src/guestfs-actions.pod:6399
18707 "This is like the C<guestfs_strings> command, but allows you to specify the "
18708 "encoding of strings that are looked for in the source file C<path>."
18713 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4329
18714 msgid "Allowed encodings are:"
18719 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4333
18725 #: ../src/guestfs-actions.pod:6409
18727 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18728 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18733 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4338
18739 #: ../src/guestfs-actions.pod:6414 ../fish/guestfish-actions.pod:4340
18740 msgid "Single 8-bit-byte characters."
18745 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4342
18751 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4344
18752 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18757 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
18758 msgid "l (lower case letter L)"
18763 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4349
18765 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18766 "examining binaries in Windows guests."
18771 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4352
18777 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4354
18778 msgid "32-bit big endian such as UCS-4BE."
18783 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
18789 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
18790 msgid "32-bit little endian such as UCS-4LE."
18795 #: ../src/guestfs-actions.pod:6436 ../fish/guestfish-actions.pod:4362
18796 msgid "The returned strings are transcoded to UTF-8."
18801 #: ../src/guestfs-actions.pod:6447
18802 msgid "guestfs_swapoff_device"
18807 #: ../src/guestfs-actions.pod:6449
18811 " guestfs_swapoff_device (guestfs_h *g,\n"
18812 " const char *device);\n"
18818 #: ../src/guestfs-actions.pod:6453
18820 "This command disables the libguestfs appliance swap device or partition "
18821 "named C<device>. See C<guestfs_swapon_device>."
18826 #: ../src/guestfs-actions.pod:6461
18827 msgid "guestfs_swapoff_file"
18832 #: ../src/guestfs-actions.pod:6463
18836 " guestfs_swapoff_file (guestfs_h *g,\n"
18837 " const char *file);\n"
18843 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4379
18844 msgid "This command disables the libguestfs appliance swap on file."
18849 #: ../src/guestfs-actions.pod:6473
18850 msgid "guestfs_swapoff_label"
18855 #: ../src/guestfs-actions.pod:6475
18859 " guestfs_swapoff_label (guestfs_h *g,\n"
18860 " const char *label);\n"
18866 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4385
18868 "This command disables the libguestfs appliance swap on labeled swap "
18874 #: ../src/guestfs-actions.pod:6486
18875 msgid "guestfs_swapoff_uuid"
18880 #: ../src/guestfs-actions.pod:6488
18884 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18885 " const char *uuid);\n"
18891 #: ../src/guestfs-actions.pod:6492 ../fish/guestfish-actions.pod:4392
18893 "This command disables the libguestfs appliance swap partition with the given "
18899 #: ../src/guestfs-actions.pod:6499
18900 msgid "guestfs_swapon_device"
18905 #: ../src/guestfs-actions.pod:6501
18909 " guestfs_swapon_device (guestfs_h *g,\n"
18910 " const char *device);\n"
18916 #: ../src/guestfs-actions.pod:6505
18918 "This command enables the libguestfs appliance to use the swap device or "
18919 "partition named C<device>. The increased memory is made available for all "
18920 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18925 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4404
18927 "Note that you should not swap to existing guest swap partitions unless you "
18928 "know what you are doing. They may contain hibernation information, or other "
18929 "information that the guest doesn't want you to trash. You also risk leaking "
18930 "information about the host to the guest this way. Instead, attach a new "
18931 "host device to the guest and swap on that."
18936 #: ../src/guestfs-actions.pod:6521
18937 msgid "guestfs_swapon_file"
18942 #: ../src/guestfs-actions.pod:6523
18946 " guestfs_swapon_file (guestfs_h *g,\n"
18947 " const char *file);\n"
18953 #: ../src/guestfs-actions.pod:6527
18955 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18961 #: ../src/guestfs-actions.pod:6534
18962 msgid "guestfs_swapon_label"
18967 #: ../src/guestfs-actions.pod:6536
18971 " guestfs_swapon_label (guestfs_h *g,\n"
18972 " const char *label);\n"
18978 #: ../src/guestfs-actions.pod:6540
18980 "This command enables swap to a labeled swap partition. See "
18981 "C<guestfs_swapon_device> for other notes."
18986 #: ../src/guestfs-actions.pod:6547
18987 msgid "guestfs_swapon_uuid"
18992 #: ../src/guestfs-actions.pod:6549
18996 " guestfs_swapon_uuid (guestfs_h *g,\n"
18997 " const char *uuid);\n"
19003 #: ../src/guestfs-actions.pod:6553
19005 "This command enables swap to a swap partition with the given UUID. See "
19006 "C<guestfs_swapon_device> for other notes."
19011 #: ../src/guestfs-actions.pod:6560
19012 msgid "guestfs_sync"
19017 #: ../src/guestfs-actions.pod:6562
19021 " guestfs_sync (guestfs_h *g);\n"
19027 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4436
19029 "This syncs the disk, so that any writes are flushed through to the "
19030 "underlying disk image."
19035 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4439
19037 "You should always call this if you have modified a disk image, before "
19038 "closing the handle."
19043 #: ../src/guestfs-actions.pod:6575
19044 msgid "guestfs_tail"
19049 #: ../src/guestfs-actions.pod:6577
19053 " guestfs_tail (guestfs_h *g,\n"
19054 " const char *path);\n"
19060 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4446
19062 "This command returns up to the last 10 lines of a file as a list of strings."
19067 #: ../src/guestfs-actions.pod:6593
19068 msgid "guestfs_tail_n"
19073 #: ../src/guestfs-actions.pod:6595
19077 " guestfs_tail_n (guestfs_h *g,\n"
19079 " const char *path);\n"
19085 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4456
19087 "If the parameter C<nrlines> is a positive number, this returns the last "
19088 "C<nrlines> lines of the file C<path>."
19093 #: ../src/guestfs-actions.pod:6603 ../fish/guestfish-actions.pod:4459
19095 "If the parameter C<nrlines> is a negative number, this returns lines from "
19096 "the file C<path>, starting with the C<-nrlines>th line."
19101 #: ../src/guestfs-actions.pod:6617
19102 msgid "guestfs_tar_in"
19107 #: ../src/guestfs-actions.pod:6619
19111 " guestfs_tar_in (guestfs_h *g,\n"
19112 " const char *tarfile,\n"
19113 " const char *directory);\n"
19119 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4471
19121 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19122 "tar file) into C<directory>."
19127 #: ../src/guestfs-actions.pod:6627
19129 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19134 #: ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6649
19135 #: ../src/guestfs-actions.pod:6665 ../src/guestfs-actions.pod:6681
19136 msgid "(Added in 1.0.3)"
19141 #: ../src/guestfs-actions.pod:6634
19142 msgid "guestfs_tar_out"
19147 #: ../src/guestfs-actions.pod:6636
19151 " guestfs_tar_out (guestfs_h *g,\n"
19152 " const char *directory,\n"
19153 " const char *tarfile);\n"
19159 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4483
19161 "This command packs the contents of C<directory> and downloads it to local "
19167 #: ../src/guestfs-actions.pod:6644
19169 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19170 "C<guestfs_txz_out>."
19175 #: ../src/guestfs-actions.pod:6651
19176 msgid "guestfs_tgz_in"
19181 #: ../src/guestfs-actions.pod:6653
19185 " guestfs_tgz_in (guestfs_h *g,\n"
19186 " const char *tarball,\n"
19187 " const char *directory);\n"
19193 #: ../src/guestfs-actions.pod:6658 ../fish/guestfish-actions.pod:4495
19195 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19196 "tar file) into C<directory>."
19201 #: ../src/guestfs-actions.pod:6661
19202 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19207 #: ../src/guestfs-actions.pod:6667
19208 msgid "guestfs_tgz_out"
19213 #: ../src/guestfs-actions.pod:6669
19217 " guestfs_tgz_out (guestfs_h *g,\n"
19218 " const char *directory,\n"
19219 " const char *tarball);\n"
19225 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4506
19227 "This command packs the contents of C<directory> and downloads it to local "
19233 #: ../src/guestfs-actions.pod:6677
19234 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19239 #: ../src/guestfs-actions.pod:6683
19240 msgid "guestfs_touch"
19245 #: ../src/guestfs-actions.pod:6685
19249 " guestfs_touch (guestfs_h *g,\n"
19250 " const char *path);\n"
19256 #: ../src/guestfs-actions.pod:6689 ../fish/guestfish-actions.pod:4517
19258 "Touch acts like the L<touch(1)> command. It can be used to update the "
19259 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19265 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4521
19267 "This command only works on regular files, and will fail on other file types "
19268 "such as directories, symbolic links, block special etc."
19273 #: ../src/guestfs-actions.pod:6700
19274 msgid "guestfs_truncate"
19279 #: ../src/guestfs-actions.pod:6702
19283 " guestfs_truncate (guestfs_h *g,\n"
19284 " const char *path);\n"
19290 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4528
19292 "This command truncates C<path> to a zero-length file. The file must exist "
19298 #: ../src/guestfs-actions.pod:6713
19299 msgid "guestfs_truncate_size"
19304 #: ../src/guestfs-actions.pod:6715
19308 " guestfs_truncate_size (guestfs_h *g,\n"
19309 " const char *path,\n"
19310 " int64_t size);\n"
19316 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4535
19318 "This command truncates C<path> to size C<size> bytes. The file must exist "
19324 #: ../src/guestfs-actions.pod:6723
19326 "If the current file size is less than C<size> then the file is extended to "
19327 "the required size with zero bytes. This creates a sparse file (ie. disk "
19328 "blocks are not allocated for the file until you write to it). To create a "
19329 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19334 #: ../src/guestfs-actions.pod:6733
19335 msgid "guestfs_tune2fs_l"
19340 #: ../src/guestfs-actions.pod:6735
19344 " guestfs_tune2fs_l (guestfs_h *g,\n"
19345 " const char *device);\n"
19351 #: ../src/guestfs-actions.pod:6739 ../fish/guestfish-actions.pod:4548
19353 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19359 #: ../src/guestfs-actions.pod:6742 ../fish/guestfish-actions.pod:4551
19361 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19362 "for more details. The list of fields returned isn't clearly defined, and "
19363 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19364 "and the filesystem itself."
19369 #: ../src/guestfs-actions.pod:6755
19370 msgid "guestfs_txz_in"
19375 #: ../src/guestfs-actions.pod:6757
19379 " guestfs_txz_in (guestfs_h *g,\n"
19380 " const char *tarball,\n"
19381 " const char *directory);\n"
19387 #: ../src/guestfs-actions.pod:6762 ../fish/guestfish-actions.pod:4560
19389 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19390 "tar file) into C<directory>."
19395 #: ../src/guestfs-actions.pod:6769
19396 msgid "guestfs_txz_out"
19401 #: ../src/guestfs-actions.pod:6771
19405 " guestfs_txz_out (guestfs_h *g,\n"
19406 " const char *directory,\n"
19407 " const char *tarball);\n"
19413 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4569
19415 "This command packs the contents of C<directory> and downloads it to local "
19416 "file C<tarball> (as an xz compressed tar archive)."
19421 #: ../src/guestfs-actions.pod:6783
19422 msgid "guestfs_umask"
19427 #: ../src/guestfs-actions.pod:6785
19431 " guestfs_umask (guestfs_h *g,\n"
19438 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4578
19440 "This function sets the mask used for creating new files and device nodes to "
19446 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4581
19448 "Typical umask values would be C<022> which creates new files with "
19449 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19450 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19455 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4586
19457 "The default umask is C<022>. This is important because it means that "
19458 "directories and device nodes will be created with C<0644> or C<0755> mode "
19459 "even if you specify C<0777>."
19464 #: ../src/guestfs-actions.pod:6801
19466 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19467 "C<guestfs_mkdir>."
19472 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4593
19473 msgid "This call returns the previous umask."
19478 #: ../src/guestfs-actions.pod:6810
19479 msgid "guestfs_umount"
19484 #: ../src/guestfs-actions.pod:6812
19488 " guestfs_umount (guestfs_h *g,\n"
19489 " const char *pathordevice);\n"
19495 #: ../src/guestfs-actions.pod:6816 ../fish/guestfish-actions.pod:4601
19497 "This unmounts the given filesystem. The filesystem may be specified either "
19498 "by its mountpoint (path) or the device which contains the filesystem."
19503 #: ../src/guestfs-actions.pod:6824
19504 msgid "guestfs_umount_all"
19509 #: ../src/guestfs-actions.pod:6826
19513 " guestfs_umount_all (guestfs_h *g);\n"
19519 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4611
19520 msgid "This unmounts all mounted filesystems."
19525 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4613
19526 msgid "Some internal mounts are not unmounted by this call."
19531 #: ../src/guestfs-actions.pod:6837
19532 msgid "guestfs_upload"
19537 #: ../src/guestfs-actions.pod:6839
19541 " guestfs_upload (guestfs_h *g,\n"
19542 " const char *filename,\n"
19543 " const char *remotefilename);\n"
19549 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6868
19550 #: ../fish/guestfish-actions.pod:4619 ../fish/guestfish-actions.pod:4632
19551 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19556 #: ../src/guestfs-actions.pod:6849
19557 msgid "See also C<guestfs_download>."
19562 #: ../src/guestfs-actions.pod:6860
19563 msgid "guestfs_upload_offset"
19568 #: ../src/guestfs-actions.pod:6862
19572 " guestfs_upload_offset (guestfs_h *g,\n"
19573 " const char *filename,\n"
19574 " const char *remotefilename,\n"
19575 " int64_t offset);\n"
19581 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4635
19583 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19584 "The intention is to overwrite parts of existing files or devices, although "
19585 "if a non-existant file is specified then it is created with a \"hole\" "
19586 "before C<offset>. The size of the data written is implicit in the size of "
19587 "the source C<filename>."
19592 #: ../src/guestfs-actions.pod:6878
19594 "Note that there is no limit on the amount of data that can be uploaded with "
19595 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19596 "full amount unless an error occurs."
19601 #: ../src/guestfs-actions.pod:6883
19602 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19607 #: ../src/guestfs-actions.pod:6894
19608 msgid "guestfs_utimens"
19613 #: ../src/guestfs-actions.pod:6896
19617 " guestfs_utimens (guestfs_h *g,\n"
19618 " const char *path,\n"
19619 " int64_t atsecs,\n"
19620 " int64_t atnsecs,\n"
19621 " int64_t mtsecs,\n"
19622 " int64_t mtnsecs);\n"
19628 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4655
19629 msgid "This command sets the timestamps of a file with nanosecond precision."
19634 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4658
19636 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19642 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4661
19644 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19645 "nanoseconds from the epoch."
19650 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4664
19652 "If the C<*nsecs> field contains the special value C<-1> then the "
19653 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19654 "ignored in this case)."
19659 #: ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:4668
19661 "If the C<*nsecs> field contains the special value C<-2> then the "
19662 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19668 #: ../src/guestfs-actions.pod:6925 ../src/guestfs-structs.pod:175
19669 msgid "guestfs_version"
19674 #: ../src/guestfs-actions.pod:6927
19677 " struct guestfs_version *\n"
19678 " guestfs_version (guestfs_h *g);\n"
19684 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4676
19686 "Return the libguestfs version number that the program is linked against."
19691 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4679
19693 "Note that because of dynamic linking this is not necessarily the version of "
19694 "libguestfs that you compiled against. You can compile the program, and then "
19695 "at runtime dynamically link against a completely different C<libguestfs.so> "
19701 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4684
19703 "This call was added in version C<1.0.58>. In previous versions of "
19704 "libguestfs there was no way to get the version number. From C code you can "
19705 "use dynamic linker functions to find out if this symbol exists (if it "
19706 "doesn't, then it's an earlier version)."
19711 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4690
19713 "The call returns a structure with four elements. The first three (C<major>, "
19714 "C<minor> and C<release>) are numbers and correspond to the usual version "
19715 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19716 "but may be used for distro-specific information."
19721 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4696
19723 "To construct the original version string: C<$major.$minor.$release$extra>"
19728 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4699
19729 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19734 #: ../src/guestfs-actions.pod:6955
19736 "I<Note:> Don't use this call to test for availability of features. In "
19737 "enterprise distributions we backport features from later versions into "
19738 "earlier versions, making this an unreliable way to test for features. Use "
19739 "C<guestfs_available> instead."
19744 #: ../src/guestfs-actions.pod:6961
19746 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19747 "error. I<The caller must call C<guestfs_free_version> after use>."
19752 #: ../src/guestfs-actions.pod:6965
19753 msgid "(Added in 1.0.58)"
19758 #: ../src/guestfs-actions.pod:6967
19759 msgid "guestfs_vfs_label"
19764 #: ../src/guestfs-actions.pod:6969
19768 " guestfs_vfs_label (guestfs_h *g,\n"
19769 " const char *device);\n"
19775 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4711
19776 msgid "This returns the filesystem label of the filesystem on C<device>."
19781 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4714
19782 msgid "If the filesystem is unlabeled, this returns the empty string."
19787 #: ../src/guestfs-actions.pod:6978
19788 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19793 #: ../src/guestfs-actions.pod:6983 ../src/guestfs-actions.pod:7020
19794 msgid "(Added in 1.3.18)"
19799 #: ../src/guestfs-actions.pod:6985
19800 msgid "guestfs_vfs_type"
19805 #: ../src/guestfs-actions.pod:6987
19809 " guestfs_vfs_type (guestfs_h *g,\n"
19810 " const char *device);\n"
19816 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4722
19818 "This command gets the filesystem type corresponding to the filesystem on "
19824 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4725
19826 "For most filesystems, the result is the name of the Linux VFS module which "
19827 "would be used to mount this filesystem if you mounted it without specifying "
19828 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19833 #: ../src/guestfs-actions.pod:7004
19834 msgid "guestfs_vfs_uuid"
19839 #: ../src/guestfs-actions.pod:7006
19843 " guestfs_vfs_uuid (guestfs_h *g,\n"
19844 " const char *device);\n"
19850 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4734
19851 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19856 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4737
19857 msgid "If the filesystem does not have a UUID, this returns the empty string."
19862 #: ../src/guestfs-actions.pod:7015
19863 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19868 #: ../src/guestfs-actions.pod:7022
19869 msgid "guestfs_vg_activate"
19874 #: ../src/guestfs-actions.pod:7024
19878 " guestfs_vg_activate (guestfs_h *g,\n"
19880 " char *const *volgroups);\n"
19886 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4745
19888 "This command activates or (if C<activate> is false) deactivates all logical "
19889 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19890 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19891 "deactivated, then those devices disappear."
19896 #: ../src/guestfs-actions.pod:7035 ../fish/guestfish-actions.pod:4751
19897 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19902 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4753
19904 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19905 "activated or deactivated."
19910 #: ../src/guestfs-actions.pod:7044
19911 msgid "guestfs_vg_activate_all"
19916 #: ../src/guestfs-actions.pod:7046
19920 " guestfs_vg_activate_all (guestfs_h *g,\n"
19921 " int activate);\n"
19927 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4760
19929 "This command activates or (if C<activate> is false) deactivates all logical "
19930 "volumes in all volume groups. If activated, then they are made known to the "
19931 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19932 "those devices disappear."
19937 #: ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:4766
19938 msgid "This command is the same as running C<vgchange -a y|n>"
19943 #: ../src/guestfs-actions.pod:7062
19944 msgid "guestfs_vgcreate"
19949 #: ../src/guestfs-actions.pod:7064
19953 " guestfs_vgcreate (guestfs_h *g,\n"
19954 " const char *volgroup,\n"
19955 " char *const *physvols);\n"
19961 #: ../src/guestfs-actions.pod:7069 ../fish/guestfish-actions.pod:4772
19963 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19964 "of physical volumes C<physvols>."
19969 #: ../src/guestfs-actions.pod:7076
19970 msgid "guestfs_vglvuuids"
19975 #: ../src/guestfs-actions.pod:7078
19979 " guestfs_vglvuuids (guestfs_h *g,\n"
19980 " const char *vgname);\n"
19986 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4779
19988 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19989 "volumes created in this volume group."
19994 #: ../src/guestfs-actions.pod:7085
19996 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19997 "associate logical volumes and volume groups."
20002 #: ../src/guestfs-actions.pod:7088
20003 msgid "See also C<guestfs_vgpvuuids>."
20008 #: ../src/guestfs-actions.pod:7096
20009 msgid "guestfs_vgpvuuids"
20014 #: ../src/guestfs-actions.pod:7098
20018 " guestfs_vgpvuuids (guestfs_h *g,\n"
20019 " const char *vgname);\n"
20025 #: ../src/guestfs-actions.pod:7102 ../fish/guestfish-actions.pod:4791
20027 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20028 "volumes that this volume group resides on."
20033 #: ../src/guestfs-actions.pod:7105
20035 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20036 "associate physical volumes and volume groups."
20041 #: ../src/guestfs-actions.pod:7108
20042 msgid "See also C<guestfs_vglvuuids>."
20047 #: ../src/guestfs-actions.pod:7116
20048 msgid "guestfs_vgremove"
20053 #: ../src/guestfs-actions.pod:7118
20057 " guestfs_vgremove (guestfs_h *g,\n"
20058 " const char *vgname);\n"
20064 #: ../src/guestfs-actions.pod:7122 ../fish/guestfish-actions.pod:4803
20065 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20070 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4805
20072 "This also forcibly removes all logical volumes in the volume group (if any)."
20077 #: ../src/guestfs-actions.pod:7131
20078 msgid "guestfs_vgrename"
20083 #: ../src/guestfs-actions.pod:7133
20087 " guestfs_vgrename (guestfs_h *g,\n"
20088 " const char *volgroup,\n"
20089 " const char *newvolgroup);\n"
20095 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4812
20096 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20101 #: ../src/guestfs-actions.pod:7144
20102 msgid "guestfs_vgs"
20107 #: ../src/guestfs-actions.pod:7146
20111 " guestfs_vgs (guestfs_h *g);\n"
20117 #: ../src/guestfs-actions.pod:7149 ../fish/guestfish-actions.pod:4818
20119 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20125 #: ../src/guestfs-actions.pod:7152 ../fish/guestfish-actions.pod:4821
20127 "This returns a list of just the volume group names that were detected (eg. "
20133 #: ../src/guestfs-actions.pod:7155
20134 msgid "See also C<guestfs_vgs_full>."
20139 #: ../src/guestfs-actions.pod:7163
20140 msgid "guestfs_vgs_full"
20145 #: ../src/guestfs-actions.pod:7165
20148 " struct guestfs_lvm_vg_list *\n"
20149 " guestfs_vgs_full (guestfs_h *g);\n"
20155 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4830
20157 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20158 "> command. The \"full\" version includes all fields."
20163 #: ../src/guestfs-actions.pod:7171
20165 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20166 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20171 #: ../src/guestfs-actions.pod:7177
20172 msgid "guestfs_vgscan"
20177 #: ../src/guestfs-actions.pod:7179
20181 " guestfs_vgscan (guestfs_h *g);\n"
20187 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4837
20189 "This rescans all block devices and rebuilds the list of LVM physical "
20190 "volumes, volume groups and logical volumes."
20195 #: ../src/guestfs-actions.pod:7189
20196 msgid "guestfs_vguuid"
20201 #: ../src/guestfs-actions.pod:7191
20205 " guestfs_vguuid (guestfs_h *g,\n"
20206 " const char *vgname);\n"
20212 #: ../src/guestfs-actions.pod:7195 ../fish/guestfish-actions.pod:4844
20213 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20218 #: ../src/guestfs-actions.pod:7202
20219 msgid "guestfs_wait_ready"
20224 #: ../src/guestfs-actions.pod:7204
20228 " guestfs_wait_ready (guestfs_h *g);\n"
20234 #: ../src/guestfs-actions.pod:7207
20235 msgid "This function is a no op."
20240 #: ../src/guestfs-actions.pod:7209
20242 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20243 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20244 "is no longer necessary because C<guestfs_launch> now does the waiting."
20249 #: ../src/guestfs-actions.pod:7214
20251 "If you see any calls to this function in code then you can just remove them, "
20252 "unless you want to retain compatibility with older versions of the API."
20256 #: ../src/guestfs-actions.pod:7220
20258 "This function is deprecated. In new code, use the C<launch> call instead."
20263 #: ../src/guestfs-actions.pod:7229
20264 msgid "guestfs_wc_c"
20269 #: ../src/guestfs-actions.pod:7231
20273 " guestfs_wc_c (guestfs_h *g,\n"
20274 " const char *path);\n"
20280 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4850
20282 "This command counts the characters in a file, using the C<wc -c> external "
20288 #: ../src/guestfs-actions.pod:7242
20289 msgid "guestfs_wc_l"
20294 #: ../src/guestfs-actions.pod:7244
20298 " guestfs_wc_l (guestfs_h *g,\n"
20299 " const char *path);\n"
20305 #: ../src/guestfs-actions.pod:7248 ../fish/guestfish-actions.pod:4857
20307 "This command counts the lines in a file, using the C<wc -l> external command."
20312 #: ../src/guestfs-actions.pod:7255
20313 msgid "guestfs_wc_w"
20318 #: ../src/guestfs-actions.pod:7257
20322 " guestfs_wc_w (guestfs_h *g,\n"
20323 " const char *path);\n"
20329 #: ../src/guestfs-actions.pod:7261 ../fish/guestfish-actions.pod:4864
20331 "This command counts the words in a file, using the C<wc -w> external command."
20336 #: ../src/guestfs-actions.pod:7268
20337 msgid "guestfs_write"
20342 #: ../src/guestfs-actions.pod:7270
20346 " guestfs_write (guestfs_h *g,\n"
20347 " const char *path,\n"
20348 " const char *content,\n"
20349 " size_t content_size);\n"
20355 #: ../src/guestfs-actions.pod:7276 ../fish/guestfish-actions.pod:4871
20357 "This call creates a file called C<path>. The content of the file is the "
20358 "string C<content> (which can contain any 8 bit data)."
20363 #: ../src/guestfs-actions.pod:7286
20364 msgid "guestfs_write_file"
20369 #: ../src/guestfs-actions.pod:7288
20373 " guestfs_write_file (guestfs_h *g,\n"
20374 " const char *path,\n"
20375 " const char *content,\n"
20382 #: ../src/guestfs-actions.pod:7294 ../fish/guestfish-actions.pod:4881
20384 "This call creates a file called C<path>. The contents of the file is the "
20385 "string C<content> (which can contain any 8 bit data), with length C<size>."
20390 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4885
20392 "As a special case, if C<size> is C<0> then the length is calculated using "
20393 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20398 #: ../src/guestfs-actions.pod:7302 ../fish/guestfish-actions.pod:4889
20400 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20401 "I<not> work, even if the length is specified."
20406 #: ../src/guestfs-actions.pod:7310 ../fish/guestfish-actions.pod:4895
20408 "This function is deprecated. In new code, use the C<write> call instead."
20413 #: ../src/guestfs-actions.pod:7319
20414 msgid "guestfs_zegrep"
20419 #: ../src/guestfs-actions.pod:7321
20423 " guestfs_zegrep (guestfs_h *g,\n"
20424 " const char *regex,\n"
20425 " const char *path);\n"
20431 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4906
20433 "This calls the external C<zegrep> program and returns the matching lines."
20438 #: ../src/guestfs-actions.pod:7338
20439 msgid "guestfs_zegrepi"
20444 #: ../src/guestfs-actions.pod:7340
20448 " guestfs_zegrepi (guestfs_h *g,\n"
20449 " const char *regex,\n"
20450 " const char *path);\n"
20456 #: ../src/guestfs-actions.pod:7345 ../fish/guestfish-actions.pod:4916
20458 "This calls the external C<zegrep -i> program and returns the matching lines."
20463 #: ../src/guestfs-actions.pod:7357
20464 msgid "guestfs_zero"
20469 #: ../src/guestfs-actions.pod:7359
20473 " guestfs_zero (guestfs_h *g,\n"
20474 " const char *device);\n"
20480 #: ../src/guestfs-actions.pod:7363 ../fish/guestfish-actions.pod:4926
20481 msgid "This command writes zeroes over the first few blocks of C<device>."
20486 #: ../src/guestfs-actions.pod:7365 ../fish/guestfish-actions.pod:4928
20488 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20489 "securely wipe the device). It should be sufficient to remove any partition "
20490 "tables, filesystem superblocks and so on."
20495 #: ../src/guestfs-actions.pod:7369
20496 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20501 #: ../src/guestfs-actions.pod:7380
20502 msgid "guestfs_zero_device"
20507 #: ../src/guestfs-actions.pod:7382
20511 " guestfs_zero_device (guestfs_h *g,\n"
20512 " const char *device);\n"
20518 #: ../src/guestfs-actions.pod:7386
20520 "This command writes zeroes over the entire C<device>. Compare with "
20521 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20526 #: ../src/guestfs-actions.pod:7400
20527 msgid "(Added in 1.3.1)"
20532 #: ../src/guestfs-actions.pod:7402
20533 msgid "guestfs_zerofree"
20538 #: ../src/guestfs-actions.pod:7404
20542 " guestfs_zerofree (guestfs_h *g,\n"
20543 " const char *device);\n"
20549 #: ../src/guestfs-actions.pod:7408 ../fish/guestfish-actions.pod:4949
20551 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20552 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20553 "possible to compress the filesystem more effectively."
20558 #: ../src/guestfs-actions.pod:7413 ../fish/guestfish-actions.pod:4954
20559 msgid "You should B<not> run this program if the filesystem is mounted."
20564 #: ../src/guestfs-actions.pod:7416 ../fish/guestfish-actions.pod:4957
20566 "It is possible that using this program can damage the filesystem or data on "
20572 #: ../src/guestfs-actions.pod:7423
20573 msgid "guestfs_zfgrep"
20578 #: ../src/guestfs-actions.pod:7425
20582 " guestfs_zfgrep (guestfs_h *g,\n"
20583 " const char *pattern,\n"
20584 " const char *path);\n"
20590 #: ../src/guestfs-actions.pod:7430 ../fish/guestfish-actions.pod:4964
20592 "This calls the external C<zfgrep> program and returns the matching lines."
20597 #: ../src/guestfs-actions.pod:7442
20598 msgid "guestfs_zfgrepi"
20603 #: ../src/guestfs-actions.pod:7444
20607 " guestfs_zfgrepi (guestfs_h *g,\n"
20608 " const char *pattern,\n"
20609 " const char *path);\n"
20615 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:4974
20617 "This calls the external C<zfgrep -i> program and returns the matching lines."
20622 #: ../src/guestfs-actions.pod:7461
20623 msgid "guestfs_zfile"
20628 #: ../src/guestfs-actions.pod:7463
20632 " guestfs_zfile (guestfs_h *g,\n"
20633 " const char *meth,\n"
20634 " const char *path);\n"
20640 #: ../src/guestfs-actions.pod:7468 ../fish/guestfish-actions.pod:4984
20642 "This command runs C<file> after first decompressing C<path> using C<method>."
20647 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4987
20648 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20653 #: ../src/guestfs-actions.pod:7473
20655 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20661 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4992
20663 "This function is deprecated. In new code, use the C<file> call instead."
20668 #: ../src/guestfs-actions.pod:7488
20669 msgid "guestfs_zgrep"
20674 #: ../src/guestfs-actions.pod:7490
20678 " guestfs_zgrep (guestfs_h *g,\n"
20679 " const char *regex,\n"
20680 " const char *path);\n"
20686 #: ../src/guestfs-actions.pod:7495 ../fish/guestfish-actions.pod:5003
20688 "This calls the external C<zgrep> program and returns the matching lines."
20693 #: ../src/guestfs-actions.pod:7507
20694 msgid "guestfs_zgrepi"
20699 #: ../src/guestfs-actions.pod:7509
20703 " guestfs_zgrepi (guestfs_h *g,\n"
20704 " const char *regex,\n"
20705 " const char *path);\n"
20711 #: ../src/guestfs-actions.pod:7514 ../fish/guestfish-actions.pod:5013
20713 "This calls the external C<zgrep -i> program and returns the matching lines."
20718 #: ../src/guestfs-availability.pod:3
20724 #: ../src/guestfs-availability.pod:5
20726 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20727 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20728 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20729 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20730 "L</guestfs_aug_save> L</guestfs_aug_set>"
20735 #: ../src/guestfs-availability.pod:21
20741 #: ../src/guestfs-availability.pod:23
20743 "The following functions: L</guestfs_inotify_add_watch> L</"
20744 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20745 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20750 #: ../src/guestfs-availability.pod:31
20751 msgid "B<linuxfsuuid>"
20756 #: ../src/guestfs-availability.pod:33
20758 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20759 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20764 #: ../src/guestfs-availability.pod:40
20765 msgid "B<linuxmodules>"
20770 #: ../src/guestfs-availability.pod:42
20771 msgid "The following functions: L</guestfs_modprobe>"
20776 #: ../src/guestfs-availability.pod:45
20777 msgid "B<linuxxattrs>"
20782 #: ../src/guestfs-availability.pod:47
20784 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20785 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20786 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20787 "guestfs_setxattr>"
20792 #: ../src/guestfs-availability.pod:58
20798 #: ../src/guestfs-availability.pod:60
20800 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20801 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20802 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20807 #: ../src/guestfs-availability.pod:69
20813 #: ../src/guestfs-availability.pod:71
20815 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20816 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20817 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20818 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20819 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20820 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20821 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20826 #: ../src/guestfs-availability.pod:94
20832 #: ../src/guestfs-availability.pod:96
20834 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20835 "guestfs_mknod_b> L</guestfs_mknod_c>"
20840 #: ../src/guestfs-availability.pod:102
20846 #: ../src/guestfs-availability.pod:104
20847 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20852 #: ../src/guestfs-availability.pod:107
20853 msgid "B<ntfsprogs>"
20858 #: ../src/guestfs-availability.pod:109
20860 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20865 #: ../src/guestfs-availability.pod:113
20866 msgid "B<realpath>"
20871 #: ../src/guestfs-availability.pod:115
20872 msgid "The following functions: L</guestfs_realpath>"
20877 #: ../src/guestfs-availability.pod:118
20883 #: ../src/guestfs-availability.pod:120
20885 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20886 "guestfs_scrub_freespace>"
20891 #: ../src/guestfs-availability.pod:125
20897 #: ../src/guestfs-availability.pod:127
20898 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20903 #: ../src/guestfs-availability.pod:131
20909 #: ../src/guestfs-availability.pod:133
20910 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20915 #: ../src/guestfs-availability.pod:137
20916 msgid "B<zerofree>"
20921 #: ../src/guestfs-availability.pod:139
20922 msgid "The following functions: L</guestfs_zerofree>"
20927 #: ../src/guestfs-structs.pod:1
20928 msgid "guestfs_int_bool"
20933 #: ../src/guestfs-structs.pod:3
20936 " struct guestfs_int_bool {\n"
20945 #: ../src/guestfs-structs.pod:8
20948 " struct guestfs_int_bool_list {\n"
20949 " uint32_t len; /* Number of elements in list. */\n"
20950 " struct guestfs_int_bool *val; /* Elements. */\n"
20957 #: ../src/guestfs-structs.pod:13
20960 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20961 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20967 #: ../src/guestfs-structs.pod:16
20968 msgid "guestfs_lvm_pv"
20973 #: ../src/guestfs-structs.pod:18
20976 " struct guestfs_lvm_pv {\n"
20977 " char *pv_name;\n"
20978 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20979 " char pv_uuid[32];\n"
20981 " uint64_t pv_size;\n"
20982 " uint64_t dev_size;\n"
20983 " uint64_t pv_free;\n"
20984 " uint64_t pv_used;\n"
20985 " char *pv_attr;\n"
20986 " int64_t pv_pe_count;\n"
20987 " int64_t pv_pe_alloc_count;\n"
20988 " char *pv_tags;\n"
20989 " uint64_t pe_start;\n"
20990 " int64_t pv_mda_count;\n"
20991 " uint64_t pv_mda_free;\n"
20998 #: ../src/guestfs-structs.pod:36
21001 " struct guestfs_lvm_pv_list {\n"
21002 " uint32_t len; /* Number of elements in list. */\n"
21003 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21010 #: ../src/guestfs-structs.pod:41
21013 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21014 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21020 #: ../src/guestfs-structs.pod:44
21021 msgid "guestfs_lvm_vg"
21026 #: ../src/guestfs-structs.pod:46
21029 " struct guestfs_lvm_vg {\n"
21030 " char *vg_name;\n"
21031 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21032 " char vg_uuid[32];\n"
21034 " char *vg_attr;\n"
21035 " uint64_t vg_size;\n"
21036 " uint64_t vg_free;\n"
21037 " char *vg_sysid;\n"
21038 " uint64_t vg_extent_size;\n"
21039 " int64_t vg_extent_count;\n"
21040 " int64_t vg_free_count;\n"
21041 " int64_t max_lv;\n"
21042 " int64_t max_pv;\n"
21043 " int64_t pv_count;\n"
21044 " int64_t lv_count;\n"
21045 " int64_t snap_count;\n"
21046 " int64_t vg_seqno;\n"
21047 " char *vg_tags;\n"
21048 " int64_t vg_mda_count;\n"
21049 " uint64_t vg_mda_free;\n"
21056 #: ../src/guestfs-structs.pod:69
21059 " struct guestfs_lvm_vg_list {\n"
21060 " uint32_t len; /* Number of elements in list. */\n"
21061 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21068 #: ../src/guestfs-structs.pod:74
21071 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21072 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21078 #: ../src/guestfs-structs.pod:77
21079 msgid "guestfs_lvm_lv"
21084 #: ../src/guestfs-structs.pod:79
21087 " struct guestfs_lvm_lv {\n"
21088 " char *lv_name;\n"
21089 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21090 " char lv_uuid[32];\n"
21091 " char *lv_attr;\n"
21092 " int64_t lv_major;\n"
21093 " int64_t lv_minor;\n"
21094 " int64_t lv_kernel_major;\n"
21095 " int64_t lv_kernel_minor;\n"
21096 " uint64_t lv_size;\n"
21097 " int64_t seg_count;\n"
21099 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21100 " float snap_percent;\n"
21101 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21102 " float copy_percent;\n"
21103 " char *move_pv;\n"
21104 " char *lv_tags;\n"
21105 " char *mirror_log;\n"
21106 " char *modules;\n"
21113 #: ../src/guestfs-structs.pod:101
21116 " struct guestfs_lvm_lv_list {\n"
21117 " uint32_t len; /* Number of elements in list. */\n"
21118 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21125 #: ../src/guestfs-structs.pod:106
21128 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21129 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21135 #: ../src/guestfs-structs.pod:111
21138 " struct guestfs_stat {\n"
21142 " int64_t nlink;\n"
21147 " int64_t blksize;\n"
21148 " int64_t blocks;\n"
21149 " int64_t atime;\n"
21150 " int64_t mtime;\n"
21151 " int64_t ctime;\n"
21158 #: ../src/guestfs-structs.pod:127
21161 " struct guestfs_stat_list {\n"
21162 " uint32_t len; /* Number of elements in list. */\n"
21163 " struct guestfs_stat *val; /* Elements. */\n"
21170 #: ../src/guestfs-structs.pod:132
21173 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21174 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21180 #: ../src/guestfs-structs.pod:137
21183 " struct guestfs_statvfs {\n"
21184 " int64_t bsize;\n"
21185 " int64_t frsize;\n"
21186 " int64_t blocks;\n"
21187 " int64_t bfree;\n"
21188 " int64_t bavail;\n"
21189 " int64_t files;\n"
21190 " int64_t ffree;\n"
21191 " int64_t favail;\n"
21194 " int64_t namemax;\n"
21201 #: ../src/guestfs-structs.pod:151
21204 " struct guestfs_statvfs_list {\n"
21205 " uint32_t len; /* Number of elements in list. */\n"
21206 " struct guestfs_statvfs *val; /* Elements. */\n"
21213 #: ../src/guestfs-structs.pod:156
21216 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21217 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21223 #: ../src/guestfs-structs.pod:159
21224 msgid "guestfs_dirent"
21229 #: ../src/guestfs-structs.pod:161
21232 " struct guestfs_dirent {\n"
21242 #: ../src/guestfs-structs.pod:167
21245 " struct guestfs_dirent_list {\n"
21246 " uint32_t len; /* Number of elements in list. */\n"
21247 " struct guestfs_dirent *val; /* Elements. */\n"
21254 #: ../src/guestfs-structs.pod:172
21257 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21258 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21264 #: ../src/guestfs-structs.pod:177
21267 " struct guestfs_version {\n"
21268 " int64_t major;\n"
21269 " int64_t minor;\n"
21270 " int64_t release;\n"
21278 #: ../src/guestfs-structs.pod:184
21281 " struct guestfs_version_list {\n"
21282 " uint32_t len; /* Number of elements in list. */\n"
21283 " struct guestfs_version *val; /* Elements. */\n"
21290 #: ../src/guestfs-structs.pod:189
21293 " void guestfs_free_version (struct guestfs_free_version *);\n"
21294 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21300 #: ../src/guestfs-structs.pod:192
21301 msgid "guestfs_xattr"
21306 #: ../src/guestfs-structs.pod:194
21309 " struct guestfs_xattr {\n"
21310 " char *attrname;\n"
21311 " /* The next two fields describe a byte array. */\n"
21312 " uint32_t attrval_len;\n"
21313 " char *attrval;\n"
21320 #: ../src/guestfs-structs.pod:201
21323 " struct guestfs_xattr_list {\n"
21324 " uint32_t len; /* Number of elements in list. */\n"
21325 " struct guestfs_xattr *val; /* Elements. */\n"
21332 #: ../src/guestfs-structs.pod:206
21335 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21336 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21342 #: ../src/guestfs-structs.pod:209
21343 msgid "guestfs_inotify_event"
21348 #: ../src/guestfs-structs.pod:211
21351 " struct guestfs_inotify_event {\n"
21352 " int64_t in_wd;\n"
21353 " uint32_t in_mask;\n"
21354 " uint32_t in_cookie;\n"
21355 " char *in_name;\n"
21362 #: ../src/guestfs-structs.pod:218
21365 " struct guestfs_inotify_event_list {\n"
21366 " uint32_t len; /* Number of elements in list. */\n"
21367 " struct guestfs_inotify_event *val; /* Elements. */\n"
21374 #: ../src/guestfs-structs.pod:223
21377 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21378 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21384 #: ../src/guestfs-structs.pod:226
21385 msgid "guestfs_partition"
21390 #: ../src/guestfs-structs.pod:228
21393 " struct guestfs_partition {\n"
21394 " int32_t part_num;\n"
21395 " uint64_t part_start;\n"
21396 " uint64_t part_end;\n"
21397 " uint64_t part_size;\n"
21404 #: ../src/guestfs-structs.pod:235
21407 " struct guestfs_partition_list {\n"
21408 " uint32_t len; /* Number of elements in list. */\n"
21409 " struct guestfs_partition *val; /* Elements. */\n"
21416 #: ../src/guestfs-structs.pod:240
21419 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21420 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21426 #: ../src/guestfs-structs.pod:243
21427 msgid "guestfs_application"
21432 #: ../src/guestfs-structs.pod:245
21435 " struct guestfs_application {\n"
21436 " char *app_name;\n"
21437 " char *app_display_name;\n"
21438 " int32_t app_epoch;\n"
21439 " char *app_version;\n"
21440 " char *app_release;\n"
21441 " char *app_install_path;\n"
21442 " char *app_trans_path;\n"
21443 " char *app_publisher;\n"
21444 " char *app_url;\n"
21445 " char *app_source_package;\n"
21446 " char *app_summary;\n"
21447 " char *app_description;\n"
21454 #: ../src/guestfs-structs.pod:260
21457 " struct guestfs_application_list {\n"
21458 " uint32_t len; /* Number of elements in list. */\n"
21459 " struct guestfs_application *val; /* Elements. */\n"
21466 #: ../src/guestfs-structs.pod:265
21469 " void guestfs_free_application (struct guestfs_free_application *);\n"
21470 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21476 #: ../fish/guestfish.pod:5
21477 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21482 #: ../fish/guestfish.pod:9
21485 " guestfish [--options] [commands]\n"
21491 #: ../fish/guestfish.pod:11
21500 #: ../fish/guestfish.pod:13
21503 " guestfish [--ro|--rw] -a disk.img\n"
21509 #: ../fish/guestfish.pod:15
21512 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21518 #: ../fish/guestfish.pod:17
21521 " guestfish -d libvirt-domain\n"
21527 #: ../fish/guestfish.pod:19
21530 " guestfish [--ro|--rw] -a disk.img -i\n"
21536 #: ../fish/guestfish.pod:21
21539 " guestfish -d libvirt-domain -i\n"
21545 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21546 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21552 #: ../fish/guestfish.pod:25
21554 "Using guestfish in read/write mode on live virtual machines can be "
21555 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21556 "option to use guestfish safely if the disk image or virtual machine might be "
21562 #: ../fish/guestfish.pod:32
21564 "Guestfish is a shell and command-line tool for examining and modifying "
21565 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21566 "functionality of the guestfs API, see L<guestfs(3)>."
21571 #: ../fish/guestfish.pod:36
21573 "Guestfish gives you structured access to the libguestfs API, from shell "
21574 "scripts or the command line or interactively. If you want to rescue a "
21575 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21581 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
21582 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21588 #: ../fish/guestfish.pod:43
21589 msgid "As an interactive shell"
21594 #: ../fish/guestfish.pod:45
21603 #: ../fish/guestfish.pod:47
21606 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21607 " editing virtual machine filesystems.\n"
21613 #: ../fish/guestfish.pod:50
21616 " Type: 'help' for a list of commands\n"
21617 " 'man' to read the manual\n"
21618 " 'quit' to quit the shell\n"
21624 #: ../fish/guestfish.pod:54
21627 " ><fs> add-ro disk.img\n"
21629 " ><fs> list-filesystems\n"
21630 " /dev/sda1: ext4\n"
21631 " /dev/vg_guest/lv_root: ext4\n"
21632 " /dev/vg_guest/lv_swap: swap\n"
21633 " ><fs> mount /dev/vg_guest/lv_root /\n"
21634 " ><fs> cat /etc/fstab\n"
21636 " # Created by anaconda\n"
21644 #: ../fish/guestfish.pod:67
21645 msgid "From shell scripts"
21650 #: ../fish/guestfish.pod:69
21651 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21656 #: ../fish/guestfish.pod:71
21659 " guestfish <<_EOF_\n"
21662 " mount /dev/vg_guest/lv_root /\n"
21663 " write /etc/motd \"Welcome, new users\"\n"
21670 #: ../fish/guestfish.pod:78
21671 msgid "List the LVM logical volumes in a disk image:"
21676 #: ../fish/guestfish.pod:80
21679 " guestfish -a disk.img --ro <<_EOF_\n"
21688 #: ../fish/guestfish.pod:85
21689 msgid "List all the filesystems in a disk image:"
21694 #: ../fish/guestfish.pod:87
21697 " guestfish -a disk.img --ro <<_EOF_\n"
21699 " list-filesystems\n"
21706 #: ../fish/guestfish.pod:92
21707 msgid "On one command line"
21712 #: ../fish/guestfish.pod:94
21713 msgid "Update C</etc/resolv.conf> in a guest:"
21718 #: ../fish/guestfish.pod:96
21722 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21723 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21729 #: ../fish/guestfish.pod:100
21730 msgid "Edit C</boot/grub/grub.conf> interactively:"
21735 #: ../fish/guestfish.pod:102
21738 " guestfish --rw --add disk.img \\\n"
21739 " --mount /dev/vg_guest/lv_root \\\n"
21740 " --mount /dev/sda1:/boot \\\n"
21741 " edit /boot/grub/grub.conf\n"
21747 #: ../fish/guestfish.pod:107
21748 msgid "Mount disks automatically"
21753 #: ../fish/guestfish.pod:109
21755 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21760 #: ../fish/guestfish.pod:112
21763 " guestfish --ro -a disk.img -i cat /etc/group\n"
21769 #: ../fish/guestfish.pod:114
21772 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21778 #: ../fish/guestfish.pod:116
21779 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21784 #: ../fish/guestfish.pod:118
21787 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21793 #: ../fish/guestfish.pod:120
21794 msgid "As a script interpreter"
21799 #: ../fish/guestfish.pod:122
21800 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21805 #: ../fish/guestfish.pod:124
21808 " #!/usr/bin/guestfish -f\n"
21809 " sparse test1.img 100M\n"
21811 " part-disk /dev/sda mbr\n"
21812 " mkfs ext2 /dev/sda1\n"
21818 #: ../fish/guestfish.pod:130
21819 msgid "Start with a prepared disk"
21824 #: ../fish/guestfish.pod:132
21826 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21827 "single ext2-formatted partition:"
21832 #: ../fish/guestfish.pod:135
21835 " guestfish -N fs\n"
21841 #: ../fish/guestfish.pod:137
21842 msgid "To list what is available do:"
21847 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
21850 " guestfish -N help | less\n"
21856 #: ../fish/guestfish.pod:141
21857 msgid "Remote control"
21862 #: ../fish/guestfish.pod:143
21865 " eval \"`guestfish --listen`\"\n"
21866 " guestfish --remote add-ro disk.img\n"
21867 " guestfish --remote run\n"
21868 " guestfish --remote lvs\n"
21874 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21875 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
21876 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21877 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21878 #: ../tools/virt-list-partitions.pl:54
21884 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
21885 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21886 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21887 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21893 #: ../fish/guestfish.pod:154
21894 msgid "Displays general help on options."
21899 #: ../fish/guestfish.pod:156
21905 #: ../fish/guestfish.pod:158
21906 msgid "B<--cmd-help>"
21911 #: ../fish/guestfish.pod:160
21912 msgid "Lists all available guestfish commands."
21917 #: ../fish/guestfish.pod:162
21923 #: ../fish/guestfish.pod:164
21924 msgid "B<--cmd-help cmd>"
21929 #: ../fish/guestfish.pod:166
21930 msgid "Displays detailed help on a single command C<cmd>."
21935 #: ../fish/guestfish.pod:168
21936 msgid "B<-a image>"
21941 #: ../fish/guestfish.pod:170
21942 msgid "B<--add image>"
21947 #: ../fish/guestfish.pod:172
21948 msgid "Add a block device or virtual machine image to the shell."
21953 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
21955 "The format of the disk image is auto-detected. To override this and force a "
21956 "particular format use the I<--format=..> option."
21960 #: ../fish/guestfish.pod:177
21962 "Using this flag is mostly equivalent to using the C<add> command, with "
21963 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21964 "the I<--format=...> flag was given."
21969 #: ../fish/guestfish.pod:181
21975 #: ../fish/guestfish.pod:183
21976 msgid "B<--connect URI>"
21981 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
21983 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21984 "URI to use. The default is to use the default libvirt connection."
21989 #: ../fish/guestfish.pod:189
21995 #: ../fish/guestfish.pod:191
21997 "If using the I<--listen> option and a csh-like shell, use this option. See "
21998 "section L</REMOTE CONTROL AND CSH> below."
22003 #: ../fish/guestfish.pod:194
22004 msgid "B<-d libvirt-domain>"
22009 #: ../fish/guestfish.pod:196
22010 msgid "B<--domain libvirt-domain>"
22015 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22017 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22018 "used, then any libvirt domain can be used. However in write mode, only "
22019 "libvirt domains which are shut down can be named here."
22024 #: ../fish/guestfish.pod:202
22026 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22027 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22028 "if the I<--format:...> flag was given."
22033 #: ../fish/guestfish.pod:206
22039 #: ../fish/guestfish.pod:208
22040 msgid "B<--no-dest-paths>"
22045 #: ../fish/guestfish.pod:210
22047 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22048 "to hit the tab key to complete paths on the guest filesystem, but this "
22049 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22050 "allow this feature to be disabled."
22055 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
22056 msgid "B<--echo-keys>"
22061 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22063 "When prompting for keys and passphrases, guestfish normally turns echoing "
22064 "off so you cannot see what you are typing. If you are not worried about "
22065 "Tempest attacks and there is no one else in the room you can specify this "
22066 "flag to see what you are typing."
22071 #: ../fish/guestfish.pod:222
22077 #: ../fish/guestfish.pod:224
22078 msgid "B<--file file>"
22083 #: ../fish/guestfish.pod:226
22084 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22089 #: ../fish/guestfish.pod:229
22092 " #!/usr/bin/guestfish -f\n"
22098 #: ../fish/guestfish.pod:231
22099 msgid "B<--format=raw|qcow2|..>"
22104 #: ../fish/guestfish.pod:233
22105 msgid "B<--format>"
22110 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
22112 "The default for the I<-a> option is to auto-detect the format of the disk "
22113 "image. Using this forces the disk format for I<-a> options which follow on "
22114 "the command line. Using I<--format> with no argument switches back to auto-"
22115 "detection for subsequent I<-a> options."
22120 #: ../fish/guestfish.pod:242
22123 " guestfish --format=raw -a disk.img\n"
22129 #: ../fish/guestfish.pod:244
22130 msgid "forces raw format (no auto-detection) for C<disk.img>."
22135 #: ../fish/guestfish.pod:246
22138 " guestfish --format=raw -a disk.img --format -a another.img\n"
22144 #: ../fish/guestfish.pod:248
22146 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22147 "detection for C<another.img>."
22152 #: ../fish/guestfish.pod:251
22154 "If you have untrusted raw-format guest disk images, you should use this "
22155 "option to specify the disk format. This avoids a possible security problem "
22156 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22161 #: ../fish/guestfish.pod:256
22167 #: ../fish/guestfish.pod:258
22168 msgid "B<--inspector>"
22173 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
22175 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22176 "system and mount filesystems as they would be mounted on the real virtual "
22182 #: ../fish/guestfish.pod:264
22183 msgid "Typical usage is either:"
22188 #: ../fish/guestfish.pod:266
22191 " guestfish -d myguest -i\n"
22197 #: ../fish/guestfish.pod:268
22198 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22203 #: ../fish/guestfish.pod:270
22206 " guestfish --ro -d myguest -i\n"
22212 #: ../fish/guestfish.pod:272
22213 msgid "(for active domains, readonly), or specify the block device directly:"
22218 #: ../fish/guestfish.pod:274
22221 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22227 #: ../fish/guestfish.pod:276
22229 "Note that the command line syntax changed slightly over older versions of "
22230 "guestfish. You can still use the old syntax:"
22235 #: ../fish/guestfish.pod:279
22238 " guestfish [--ro] -i disk.img\n"
22244 #: ../fish/guestfish.pod:281
22247 " guestfish [--ro] -i libvirt-domain\n"
22253 #: ../fish/guestfish.pod:283
22255 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22256 "then using other commands to mount the filesystems that were found."
22261 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
22262 msgid "B<--keys-from-stdin>"
22267 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22269 "Read key or passphrase parameters from stdin. The default is to try to read "
22270 "passphrases from the user by opening C</dev/tty>."
22275 #: ../fish/guestfish.pod:292
22276 msgid "B<--listen>"
22281 #: ../fish/guestfish.pod:294
22283 "Fork into the background and listen for remote commands. See section L</"
22284 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22288 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
22293 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22295 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22296 "ATTACHING TO RUNNING DAEMONS>)."
22300 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
22301 msgid "B<-m dev[:mountpoint[:options]]>"
22305 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22306 msgid "B<--mount dev[:mountpoint[:options]]>"
22311 #: ../fish/guestfish.pod:306
22312 msgid "Mount the named partition or logical volume on the given mountpoint."
22317 #: ../fish/guestfish.pod:308
22318 msgid "If the mountpoint is omitted, it defaults to C</>."
22323 #: ../fish/guestfish.pod:310
22324 msgid "You have to mount something on C</> before most commands will work."
22329 #: ../fish/guestfish.pod:312
22331 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22337 #: ../fish/guestfish.pod:315
22339 "If you don't know what filesystems a disk image contains, you can either run "
22340 "guestfish without this option, then list the partitions, filesystems and LVs "
22341 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22342 "commands), or you can use the L<virt-filesystems(1)> program."
22346 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
22348 "The third (and rarely used) part of the mount parameter is the list of mount "
22349 "options used to mount the underlying filesystem. If this is not given, then "
22350 "the mount options are either the empty string or C<ro> (the latter if the "
22351 "I<--ro> flag is used). By specifying the mount options, you override this "
22352 "default choice. Probably the only time you would use this is to enable ACLs "
22353 "and/or extended attributes if the filesystem can support them:"
22357 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
22360 " -m /dev/sda1:/:acl,user_xattr\n"
22365 #: ../fish/guestfish.pod:331
22366 msgid "Using this flag is equivalent to using the C<mount-options> command."
22371 #: ../fish/guestfish.pod:333
22377 #: ../fish/guestfish.pod:335
22378 msgid "B<--no-sync>"
22383 #: ../fish/guestfish.pod:337
22385 "Disable autosync. This is enabled by default. See the discussion of "
22386 "autosync in the L<guestfs(3)> manpage."
22391 #: ../fish/guestfish.pod:340
22397 #: ../fish/guestfish.pod:342
22398 msgid "B<--new type>"
22403 #: ../fish/guestfish.pod:344
22409 #: ../fish/guestfish.pod:346
22411 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22412 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22413 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22419 #: ../fish/guestfish.pod:351
22420 msgid "B<--progress-bars>"
22425 #: ../fish/guestfish.pod:353
22426 msgid "Enable progress bars, even when guestfish is used non-interactively."
22431 #: ../fish/guestfish.pod:355
22433 "Progress bars are enabled by default when guestfish is used as an "
22434 "interactive shell."
22439 #: ../fish/guestfish.pod:358
22440 msgid "B<--no-progress-bars>"
22445 #: ../fish/guestfish.pod:360
22446 msgid "Disable progress bars."
22451 #: ../fish/guestfish.pod:362
22452 msgid "B<--remote[=pid]>"
22457 #: ../fish/guestfish.pod:364
22459 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22460 "CONTROL GUESTFISH OVER A SOCKET> below."
22465 #: ../fish/guestfish.pod:367
22471 #: ../fish/guestfish.pod:369
22477 #: ../fish/guestfish.pod:371
22479 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22480 "mounts are done read-only."
22485 #: ../fish/guestfish.pod:374
22487 "The option must always be used if the disk image or virtual machine might be "
22488 "running, and is generally recommended in cases where you don't need write "
22489 "access to the disk."
22494 #: ../fish/guestfish.pod:378
22496 "Note that prepared disk images created with I<-N> are not affected by this "
22497 "option. Also commands like C<add> are not affected - you have to specify "
22498 "the C<readonly:true> option explicitly if you need it."
22503 #: ../fish/guestfish.pod:382
22504 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22509 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
22510 msgid "B<--selinux>"
22515 #: ../fish/guestfish.pod:386
22516 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22521 #: ../fish/guestfish.pod:388
22527 #: ../fish/guestfish.pod:390
22528 msgid "B<--verbose>"
22533 #: ../fish/guestfish.pod:392
22535 "Enable very verbose messages. This is particularly useful if you find a bug."
22540 #: ../fish/guestfish.pod:395
22546 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22547 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22548 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22549 #: ../tools/virt-list-partitions.pl:70
22550 msgid "B<--version>"
22555 #: ../fish/guestfish.pod:399
22556 msgid "Display the guestfish / libguestfs version number and exit."
22561 #: ../fish/guestfish.pod:401
22567 #: ../fish/guestfish.pod:403
22572 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
22574 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22575 "mounts are done read-write."
22579 #: ../fish/guestfish.pod:408
22580 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22585 #: ../fish/guestfish.pod:410
22591 #: ../fish/guestfish.pod:412
22592 msgid "Echo each command before executing it."
22597 #: ../fish/guestfish.pod:416
22598 msgid "COMMANDS ON COMMAND LINE"
22603 #: ../fish/guestfish.pod:418
22605 "Any additional (non-option) arguments are treated as commands to execute."
22610 #: ../fish/guestfish.pod:421
22612 "Commands to execute should be separated by a colon (C<:>), where the colon "
22613 "is a separate parameter. Thus:"
22618 #: ../fish/guestfish.pod:424
22621 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22627 #: ../fish/guestfish.pod:426
22629 "If there are no additional arguments, then we enter a shell, either an "
22630 "interactive shell with a prompt (if the input is a terminal) or a non-"
22631 "interactive shell."
22636 #: ../fish/guestfish.pod:430
22638 "In either command line mode or non-interactive shell, the first command that "
22639 "gives an error causes the whole shell to exit. In interactive mode (with a "
22640 "prompt) if a command fails, you can continue to enter commands."
22645 #: ../fish/guestfish.pod:435
22646 msgid "USING launch (OR run)"
22651 #: ../fish/guestfish.pod:437
22653 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22654 "then launch it, then mount any disks you need, and finally issue actions/"
22655 "commands. So the general order of the day is:"
22660 #: ../fish/guestfish.pod:445
22661 msgid "add or -a/--add"
22666 #: ../fish/guestfish.pod:449
22667 msgid "launch (aka run)"
22672 #: ../fish/guestfish.pod:453
22673 msgid "mount or -m/--mount"
22678 #: ../fish/guestfish.pod:457
22679 msgid "any other commands"
22684 #: ../fish/guestfish.pod:461
22686 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22687 "guest before mounting or performing any other commands."
22692 #: ../fish/guestfish.pod:464
22694 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22695 "I<--new> options were given then C<run> is done automatically, simply "
22696 "because guestfish can't perform the action you asked for without doing this."
22701 #: ../fish/guestfish.pod:469
22702 msgid "OPENING DISKS FOR READ AND WRITE"
22706 #: ../fish/guestfish.pod:471
22708 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22709 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22710 "I<-i> and I<-m> open disk images read-only or for writing."
22714 #: ../fish/guestfish.pod:476
22716 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22717 "opening disk images supplied on the command line for write. To open a disk "
22718 "image read-only you have to do I<-a image --ro>."
22723 #: ../fish/guestfish.pod:480
22725 "This matters: If you accidentally open a live VM disk image writable then "
22726 "you will cause irreversible disk corruption."
22730 #: ../fish/guestfish.pod:483
22732 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22733 "images will be opened read-only. You will have to either specify "
22734 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22735 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22736 "access for disk images specified by those other command line options."
22740 #: ../fish/guestfish.pod:490
22742 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22743 "which does nothing (it is already the default). However it is highly "
22744 "recommended that you use this option to indicate that you need write access, "
22745 "and prepare your scripts for the day when this option will be required for "
22751 #: ../fish/guestfish.pod:496
22753 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22754 "other libguestfs program apart from guestfish and guestmount."
22759 #: ../fish/guestfish.pod:499
22765 #: ../fish/guestfish.pod:501
22767 "You can quote ordinary parameters using either single or double quotes. For "
22773 #: ../fish/guestfish.pod:504
22776 " add \"file with a space.img\"\n"
22782 #: ../fish/guestfish.pod:506
22785 " rm '/file name'\n"
22791 #: ../fish/guestfish.pod:508
22800 #: ../fish/guestfish.pod:510
22802 "A few commands require a list of strings to be passed. For these, use a "
22803 "whitespace-separated list, enclosed in quotes. Strings containing "
22804 "whitespace to be passed through must be enclosed in single quotes. A "
22805 "literal single quote must be escaped with a backslash."
22810 #: ../fish/guestfish.pod:515
22813 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22814 " command \"/bin/echo 'foo bar'\"\n"
22815 " command \"/bin/echo \\'foo\\'\"\n"
22821 #: ../fish/guestfish.pod:519
22822 msgid "OPTIONAL ARGUMENTS"
22827 #: ../fish/guestfish.pod:521
22829 "Some commands take optional arguments. These arguments appear in this "
22830 "documentation as C<[argname:..]>. You can use them as in these examples:"
22835 #: ../fish/guestfish.pod:525
22838 " add-drive-opts filename\n"
22844 #: ../fish/guestfish.pod:527
22847 " add-drive-opts filename readonly:true\n"
22853 #: ../fish/guestfish.pod:529
22856 " add-drive-opts filename format:qcow2 readonly:false\n"
22862 #: ../fish/guestfish.pod:531
22864 "Each optional argument can appear at most once. All optional arguments must "
22865 "appear after the required ones."
22870 #: ../fish/guestfish.pod:534
22876 #: ../fish/guestfish.pod:536
22878 "This section applies to all commands which can take integers as parameters."
22883 #: ../fish/guestfish.pod:539
22884 msgid "SIZE SUFFIX"
22889 #: ../fish/guestfish.pod:541
22891 "When the command takes a parameter measured in bytes, you can use one of the "
22892 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22897 #: ../fish/guestfish.pod:547
22898 msgid "B<k> or B<K> or B<KiB>"
22903 #: ../fish/guestfish.pod:549
22904 msgid "The size in kilobytes (multiplied by 1024)."
22909 #: ../fish/guestfish.pod:551
22915 #: ../fish/guestfish.pod:553
22916 msgid "The size in SI 1000 byte units."
22921 #: ../fish/guestfish.pod:555
22922 msgid "B<M> or B<MiB>"
22927 #: ../fish/guestfish.pod:557
22928 msgid "The size in megabytes (multiplied by 1048576)."
22933 #: ../fish/guestfish.pod:559
22939 #: ../fish/guestfish.pod:561
22940 msgid "The size in SI 1000000 byte units."
22945 #: ../fish/guestfish.pod:563
22946 msgid "B<G> or B<GiB>"
22951 #: ../fish/guestfish.pod:565
22952 msgid "The size in gigabytes (multiplied by 2**30)."
22957 #: ../fish/guestfish.pod:567
22963 #: ../fish/guestfish.pod:569
22964 msgid "The size in SI 10**9 byte units."
22969 #: ../fish/guestfish.pod:571
22970 msgid "B<T> or B<TiB>"
22975 #: ../fish/guestfish.pod:573
22976 msgid "The size in terabytes (multiplied by 2**40)."
22981 #: ../fish/guestfish.pod:575
22987 #: ../fish/guestfish.pod:577
22988 msgid "The size in SI 10**12 byte units."
22993 #: ../fish/guestfish.pod:579
22994 msgid "B<P> or B<PiB>"
22999 #: ../fish/guestfish.pod:581
23000 msgid "The size in petabytes (multiplied by 2**50)."
23005 #: ../fish/guestfish.pod:583
23011 #: ../fish/guestfish.pod:585
23012 msgid "The size in SI 10**15 byte units."
23017 #: ../fish/guestfish.pod:587
23018 msgid "B<E> or B<EiB>"
23023 #: ../fish/guestfish.pod:589
23024 msgid "The size in exabytes (multiplied by 2**60)."
23029 #: ../fish/guestfish.pod:591
23035 #: ../fish/guestfish.pod:593
23036 msgid "The size in SI 10**18 byte units."
23041 #: ../fish/guestfish.pod:595
23042 msgid "B<Z> or B<ZiB>"
23047 #: ../fish/guestfish.pod:597
23048 msgid "The size in zettabytes (multiplied by 2**70)."
23053 #: ../fish/guestfish.pod:599
23059 #: ../fish/guestfish.pod:601
23060 msgid "The size in SI 10**21 byte units."
23065 #: ../fish/guestfish.pod:603
23066 msgid "B<Y> or B<YiB>"
23071 #: ../fish/guestfish.pod:605
23072 msgid "The size in yottabytes (multiplied by 2**80)."
23077 #: ../fish/guestfish.pod:607
23083 #: ../fish/guestfish.pod:609
23084 msgid "The size in SI 10**24 byte units."
23089 #: ../fish/guestfish.pod:615
23092 " truncate-size /file 1G\n"
23098 #: ../fish/guestfish.pod:617
23099 msgid "would truncate the file to 1 gigabyte."
23104 #: ../fish/guestfish.pod:619
23106 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23107 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23108 "suffix will probably not do what you expect."
23113 #: ../fish/guestfish.pod:623
23114 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23119 #: ../fish/guestfish.pod:625
23121 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23122 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23127 #: ../fish/guestfish.pod:628
23130 " 1234 decimal number 1234\n"
23131 " 02322 octal number, equivalent to decimal 1234\n"
23132 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23138 #: ../fish/guestfish.pod:632
23140 "When using the C<chmod> command, you almost always want to specify an octal "
23141 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23142 "L<chmod(1)> program):"
23147 #: ../fish/guestfish.pod:636
23150 " chmod 0777 /public # OK\n"
23151 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23157 #: ../fish/guestfish.pod:639
23159 "Commands that return numbers usually print them in decimal, but some "
23160 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23161 "octal, preceeded by C<0>)."
23166 #: ../fish/guestfish.pod:643
23167 msgid "WILDCARDS AND GLOBBING"
23172 #: ../fish/guestfish.pod:645
23174 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23175 "(globbing) by default. So for example the following will not do what you "
23181 #: ../fish/guestfish.pod:649
23190 #: ../fish/guestfish.pod:651
23192 "Assuming you don't have a directory called literally C</home/*> then the "
23193 "above command will return an error."
23198 #: ../fish/guestfish.pod:654
23199 msgid "To perform wildcard expansion, use the C<glob> command."
23204 #: ../fish/guestfish.pod:656
23207 " glob rm-rf /home/*\n"
23213 #: ../fish/guestfish.pod:658
23215 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23216 "many times), equivalent to:"
23221 #: ../fish/guestfish.pod:661
23224 " rm-rf /home/jim\n"
23225 " rm-rf /home/joe\n"
23226 " rm-rf /home/mary\n"
23232 #: ../fish/guestfish.pod:665
23233 msgid "C<glob> only works on simple guest paths and not on device names."
23238 #: ../fish/guestfish.pod:667
23240 "If you have several parameters, each containing a wildcard, then glob will "
23241 "perform a Cartesian product."
23246 #: ../fish/guestfish.pod:670
23252 #: ../fish/guestfish.pod:672
23254 "Any line which starts with a I<#> character is treated as a comment and "
23255 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23256 "a command. For example:"
23261 #: ../fish/guestfish.pod:676
23264 " # this is a comment\n"
23265 " # this is a comment\n"
23266 " foo # NOT a comment\n"
23272 #: ../fish/guestfish.pod:680
23273 msgid "Blank lines are also ignored."
23278 #: ../fish/guestfish.pod:682
23279 msgid "RUNNING COMMANDS LOCALLY"
23284 #: ../fish/guestfish.pod:684
23286 "Any line which starts with a I<!> character is treated as a command sent to "
23287 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23292 #: ../fish/guestfish.pod:688
23296 " tgz-out /remote local/remote-data.tar.gz\n"
23302 #: ../fish/guestfish.pod:691
23304 "will create a directory C<local> on the host, and then export the contents "
23305 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23306 "(See C<tgz-out>)."
23311 #: ../fish/guestfish.pod:695
23313 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23314 "effect, due to the way that subprocesses work in Unix."
23318 #: ../fish/guestfish.pod:698
23319 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23323 #: ../fish/guestfish.pod:700
23325 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23326 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23327 "and executed as guestfish commands."
23331 #: ../fish/guestfish.pod:704
23333 "Thus you can use shell script to construct arbitrary guestfish commands "
23334 "which are then parsed by guestfish."
23338 #: ../fish/guestfish.pod:707
23340 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23341 "through C</foo.100>) using guestfish commands alone. However this is simple "
23342 "if we use a shell script to create the guestfish commands for us:"
23346 #: ../fish/guestfish.pod:712
23349 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23354 #: ../fish/guestfish.pod:714
23355 msgid "or with names like C</foo.001>:"
23359 #: ../fish/guestfish.pod:716
23362 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23367 #: ../fish/guestfish.pod:718
23369 "When using guestfish interactively it can be helpful to just run the shell "
23370 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23371 "ordinary I<!> local command), see what guestfish commands it would run, and "
23372 "when you are happy with those prepend the C<E<lt>> character to run the "
23373 "guestfish commands for real."
23378 #: ../fish/guestfish.pod:724
23384 #: ../fish/guestfish.pod:726
23386 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23387 "command (a guestfish command) to the second command (any host command). For "
23393 #: ../fish/guestfish.pod:730
23396 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23402 #: ../fish/guestfish.pod:732
23404 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23405 "program). The above command would list all accounts in the guest filesystem "
23406 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23411 #: ../fish/guestfish.pod:737
23414 " hexdump /bin/ls | head\n"
23415 " list-devices | tail -1\n"
23416 " tgz-out / - | tar ztf -\n"
23422 #: ../fish/guestfish.pod:741
23424 "The space before the pipe symbol is required, any space after the pipe "
23425 "symbol is optional. Everything after the pipe symbol is just passed "
23426 "straight to the host shell, so it can contain redirections, globs and "
23427 "anything else that makes sense on the host side."
23432 #: ../fish/guestfish.pod:746
23434 "To use a literal argument which begins with a pipe symbol, you have to quote "
23440 #: ../fish/guestfish.pod:749
23449 #: ../fish/guestfish.pod:751
23450 msgid "HOME DIRECTORIES"
23455 #: ../fish/guestfish.pod:753
23457 "If a parameter starts with the character C<~> then the tilde may be expanded "
23458 "as a home directory path (either C<~> for the current user's home directory, "
23459 "or C<~user> for another user)."
23464 #: ../fish/guestfish.pod:757
23466 "Note that home directory expansion happens for users known I<on the host>, "
23467 "not in the guest filesystem."
23472 #: ../fish/guestfish.pod:760
23474 "To use a literal argument which begins with a tilde, you have to quote it, "
23480 #: ../fish/guestfish.pod:763
23489 #: ../fish/guestfish.pod:767
23491 "Libguestfs has some support for Linux guests encrypted according to the "
23492 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23493 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23494 "LUKS is supported."
23499 #: ../fish/guestfish.pod:772
23500 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23505 #: ../fish/guestfish.pod:774
23508 " ><fs> vfs-type /dev/sda2\n"
23515 #: ../fish/guestfish.pod:777
23517 "Then open those devices using L</luks-open>. This creates a device-mapper "
23518 "device called C</dev/mapper/luksdev>."
23523 #: ../fish/guestfish.pod:780
23526 " ><fs> luks-open /dev/sda2 luksdev\n"
23527 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23533 #: ../fish/guestfish.pod:783
23535 "Finally you have to tell LVM to scan for volume groups on the newly created "
23541 #: ../fish/guestfish.pod:786
23545 " vg-activate-all true\n"
23551 #: ../fish/guestfish.pod:789
23552 msgid "The logical volume(s) can now be mounted in the usual way."
23557 #: ../fish/guestfish.pod:791
23559 "Before closing a LUKS device you must unmount any logical volumes on it and "
23560 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23561 "one. Then you can close the mapper device:"
23566 #: ../fish/guestfish.pod:795
23569 " vg-activate false /dev/VG\n"
23570 " luks-close /dev/mapper/luksdev\n"
23576 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23577 msgid "WINDOWS PATHS"
23581 #: ../fish/guestfish.pod:800
23583 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23584 "letters and paths (with some limitations). The following commands are "
23590 #: ../fish/guestfish.pod:804
23593 " file /WINDOWS/system32/config/system.LOG\n"
23599 #: ../fish/guestfish.pod:806
23602 " file win:\\windows\\system32\\config\\system.log\n"
23607 #: ../fish/guestfish.pod:808
23610 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23615 #: ../fish/guestfish.pod:810
23617 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23618 "where the drive is mounted, prepending that to the path, changing all "
23619 "backslash characters to forward slash, then resolving the result using L</"
23620 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23621 "the parameter might be rewritten like this:"
23625 #: ../fish/guestfish.pod:816
23628 " win:e:\\foo\\bar => /e/FOO/bar\n"
23633 #: ../fish/guestfish.pod:818
23634 msgid "This only works in argument positions that expect a path."
23639 #: ../fish/guestfish.pod:820
23640 msgid "UPLOADING AND DOWNLOADING FILES"
23645 #: ../fish/guestfish.pod:822
23647 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23648 "others which upload from or download to a local file, you can use the "
23649 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23654 #: ../fish/guestfish.pod:826
23663 #: ../fish/guestfish.pod:828
23665 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23670 #: ../fish/guestfish.pod:831
23673 " tar-out /etc - | tar tf -\n"
23679 #: ../fish/guestfish.pod:833
23681 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23682 "command (see L</PIPES>)."
23687 #: ../fish/guestfish.pod:836
23689 "When using C<-> to read from stdin, the input is read up to the end of "
23690 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23691 "some arbitrary end marker:"
23696 #: ../fish/guestfish.pod:840
23699 " upload -<<END /foo\n"
23709 #: ../fish/guestfish.pod:846
23711 "Any string of characters can be used instead of C<END>. The end marker must "
23712 "appear on a line of its own, without any preceeding or following characters "
23713 "(not even spaces)."
23718 #: ../fish/guestfish.pod:850
23720 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23721 "upload local files (so-called \"FileIn\" parameters in the generator)."
23726 #: ../fish/guestfish.pod:853
23727 msgid "EXIT ON ERROR BEHAVIOUR"
23732 #: ../fish/guestfish.pod:855
23734 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23735 "taking commands from a human over a tty), and will exit on the first error "
23736 "in non-interactive mode (scripts, commands given on the command line)."
23741 #: ../fish/guestfish.pod:860
23743 "If you prefix a command with a I<-> character, then that command will not "
23744 "cause guestfish to exit, even if that (one) command returns an error."
23749 #: ../fish/guestfish.pod:864
23750 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23755 #: ../fish/guestfish.pod:866
23757 "Guestfish can be remote-controlled over a socket. This is useful "
23758 "particularly in shell scripts where you want to make several different "
23759 "changes to a filesystem, but you don't want the overhead of starting up a "
23760 "guestfish process each time."
23765 #: ../fish/guestfish.pod:871
23766 msgid "Start a guestfish server process using:"
23771 #: ../fish/guestfish.pod:873
23774 " eval \"`guestfish --listen`\"\n"
23780 #: ../fish/guestfish.pod:875
23781 msgid "and then send it commands by doing:"
23786 #: ../fish/guestfish.pod:877
23789 " guestfish --remote cmd [...]\n"
23795 #: ../fish/guestfish.pod:879
23796 msgid "To cause the server to exit, send it the exit command:"
23801 #: ../fish/guestfish.pod:881
23804 " guestfish --remote exit\n"
23810 #: ../fish/guestfish.pod:883
23812 "Note that the server will normally exit if there is an error in a command. "
23813 "You can change this in the usual way. See section L</EXIT ON ERROR "
23819 #: ../fish/guestfish.pod:887
23820 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23825 #: ../fish/guestfish.pod:889
23827 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23828 "is how the I<--remote> option knows where to send the commands. You can "
23829 "have several guestfish listener processes running using:"
23834 #: ../fish/guestfish.pod:893
23837 " eval \"`guestfish --listen`\"\n"
23838 " pid1=$GUESTFISH_PID\n"
23839 " eval \"`guestfish --listen`\"\n"
23840 " pid2=$GUESTFISH_PID\n"
23842 " guestfish --remote=$pid1 cmd\n"
23843 " guestfish --remote=$pid2 cmd\n"
23849 #: ../fish/guestfish.pod:901
23850 msgid "REMOTE CONTROL AND CSH"
23855 #: ../fish/guestfish.pod:903
23857 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23863 #: ../fish/guestfish.pod:906
23866 " eval \"`guestfish --listen --csh`\"\n"
23872 #: ../fish/guestfish.pod:908
23873 msgid "REMOTE CONTROL DETAILS"
23878 #: ../fish/guestfish.pod:910
23880 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23881 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23882 "and C<$PID> is the process ID of the server."
23887 #: ../fish/guestfish.pod:914
23888 msgid "Guestfish client and server versions must match exactly."
23893 #: ../fish/guestfish.pod:916
23894 msgid "PREPARED DISK IMAGES"
23899 #: ../fish/guestfish.pod:918
23901 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23902 "preformatted disk images that guestfish can make for you to save typing. "
23903 "This is particularly useful for testing purposes. This option is used "
23904 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23905 "can be mixed with I<-a>)."
23910 #: ../fish/guestfish.pod:924
23912 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23913 "the second and so on. Existing files in the current directory are "
23919 #: ../fish/guestfish.pod:928
23921 "The type briefly describes how the disk should be sized, partitioned, how "
23922 "filesystem(s) should be created, and how content should be added. "
23923 "Optionally the type can be followed by extra parameters, separated by C<:> "
23924 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23925 "allocated disk, containing a single partition, with the partition formatted "
23926 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23932 #: ../fish/guestfish.pod:936
23933 msgid "To list the available types and any extra parameters they take, run:"
23938 #: ../fish/guestfish.pod:940
23940 "Note that the prepared filesystem is not mounted. You would usually have to "
23941 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23946 #: ../fish/guestfish.pod:944
23948 "If any I<-N> or I<--new> options are given, the guest is automatically "
23954 #: ../fish/guestfish.pod:949
23955 msgid "Create a 100MB disk with an ext4-formatted partition:"
23960 #: ../fish/guestfish.pod:951
23963 " guestfish -N fs:ext4\n"
23969 #: ../fish/guestfish.pod:953
23970 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23975 #: ../fish/guestfish.pod:955
23978 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23984 #: ../fish/guestfish.pod:957
23985 msgid "Create a blank 200MB disk:"
23990 #: ../fish/guestfish.pod:959
23993 " guestfish -N disk:200M\n"
23999 #: ../fish/guestfish.pod:961
24000 msgid "PROGRESS BARS"
24005 #: ../fish/guestfish.pod:963
24007 "Some (not all) long-running commands send progress notification messages as "
24008 "they are running. Guestfish turns these messages into progress bars."
24013 #: ../fish/guestfish.pod:967
24015 "When a command that supports progress bars takes longer than two seconds to "
24016 "run, and if progress bars are enabled, then you will see one appearing below "
24022 #: ../fish/guestfish.pod:971
24025 " ><fs> copy-size /large-file /another-file 2048M\n"
24026 " / 10% [#####-----------------------------------------] 00:30\n"
24032 #: ../fish/guestfish.pod:974
24034 "The spinner on the left hand side moves round once for every progress "
24035 "notification received from the backend. This is a (reasonably) golden "
24036 "assurance that the command is \"doing something\" even if the progress bar "
24037 "is not moving, because the command is able to send the progress "
24038 "notifications. When the bar reaches 100% and the command finishes, the "
24039 "spinner disappears."
24044 #: ../fish/guestfish.pod:981
24046 "Progress bars are enabled by default when guestfish is used interactively. "
24047 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24048 "and you can disable them completely using I<--no-progress-bars>."
24053 #: ../fish/guestfish.pod:986
24054 msgid "GUESTFISH COMMANDS"
24059 #: ../fish/guestfish.pod:988
24061 "The commands in this section are guestfish convenience commands, in other "
24062 "words, they are not part of the L<guestfs(3)> API."
24067 #: ../fish/guestfish.pod:991
24073 #: ../fish/guestfish.pod:993
24083 #: ../fish/guestfish.pod:996
24084 msgid "Without any parameter, this provides general help."
24089 #: ../fish/guestfish.pod:998
24090 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24095 #: ../fish/guestfish.pod:1000
24096 msgid "quit | exit"
24101 #: ../fish/guestfish.pod:1002
24102 msgid "This exits guestfish. You can also use C<^D> key."
24107 #: ../fish/guestfish.pod:1004
24108 msgid "@FISH_COMMANDS@"
24113 #: ../fish/guestfish.pod:1006
24119 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
24125 #: ../fish/guestfish.pod:1012
24127 "guestfish returns 0 if the commands completed without error, or 1 if there "
24133 #: ../fish/guestfish.pod:1019
24139 #: ../fish/guestfish.pod:1021
24141 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24147 #: ../fish/guestfish.pod:1024
24148 msgid "GUESTFISH_PID"
24153 #: ../fish/guestfish.pod:1026
24155 "Used with the I<--remote> option to specify the remote guestfish process to "
24156 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24161 #: ../fish/guestfish.pod:1030
24167 #: ../fish/guestfish.pod:1032
24169 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24170 "not specified, the external L<hexedit(1)> program is used."
24175 #: ../fish/guestfish.pod:1036
24181 #: ../fish/guestfish.pod:1038
24183 "If compiled with GNU readline support, various files in the home directory "
24184 "can be used. See L</FILES>."
24189 #: ../fish/guestfish.pod:1047
24191 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24192 "effect as using the B<-v> option."
24197 #: ../fish/guestfish.pod:1059
24199 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24200 "the discussion of paths in L<guestfs(3)>."
24205 #: ../fish/guestfish.pod:1070
24206 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24211 #: ../fish/guestfish.pod:1072
24217 #: ../fish/guestfish.pod:1074
24219 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24225 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:262
24230 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:266
24231 msgid "$HOME/.libguestfs-tools.rc"
24235 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
24236 msgid "/etc/libguestfs-tools.conf"
24240 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
24242 "This configuration file controls the default read-only or read-write mode "
24243 "(I<--ro> or I<--rw>)."
24247 #: ../fish/guestfish.pod:1101
24248 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24253 #: ../fish/guestfish.pod:1103
24254 msgid "$HOME/.guestfish"
24259 #: ../fish/guestfish.pod:1105
24261 "If compiled with GNU readline support, then the command history is saved in "
24267 #: ../fish/guestfish.pod:1108
24268 msgid "$HOME/.inputrc"
24273 #: ../fish/guestfish.pod:1110
24274 msgid "/etc/inputrc"
24279 #: ../fish/guestfish.pod:1112
24281 "If compiled with GNU readline support, then these files can be used to "
24282 "configure readline. For further information, please see L<readline(3)/"
24283 "INITIALIZATION FILE>."
24288 #: ../fish/guestfish.pod:1116
24289 msgid "To write rules which only apply to guestfish, use:"
24294 #: ../fish/guestfish.pod:1118
24305 #: ../fish/guestfish.pod:1122
24307 "Variables that you can set in inputrc that change the behaviour of guestfish "
24308 "in useful ways include:"
24313 #: ../fish/guestfish.pod:1127
24314 msgid "completion-ignore-case (default: on)"
24319 #: ../fish/guestfish.pod:1129
24321 "By default, guestfish will ignore case when tab-completing paths on the "
24327 #: ../fish/guestfish.pod:1132
24330 " set completion-ignore-case off\n"
24336 #: ../fish/guestfish.pod:1134
24337 msgid "to make guestfish case sensitive."
24342 #: ../fish/guestfish.pod:1138
24348 #: ../fish/guestfish.pod:1140
24349 msgid "test2.img (etc)"
24353 #: ../fish/guestfish.pod:1142
24355 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24356 "will be created in the file C<test1.img> in the current directory. The "
24357 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24358 "the same name will be overwritten."
24362 #: ../fish/guestfish.pod:1151
24364 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24365 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24366 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24367 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24368 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24369 ">, L<hexedit(1)>."
24374 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
24375 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
24376 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24377 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24378 #: ../tools/virt-list-partitions.pl:277
24380 "This program is free software; you can redistribute it and/or modify it "
24381 "under the terms of the GNU General Public License as published by the Free "
24382 "Software Foundation; either version 2 of the License, or (at your option) "
24383 "any later version."
24388 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
24389 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
24390 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24391 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24392 #: ../tools/virt-list-partitions.pl:282
24394 "This program is distributed in the hope that it will be useful, but WITHOUT "
24395 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24396 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24402 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
24403 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
24404 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24405 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24406 #: ../tools/virt-list-partitions.pl:287
24408 "You should have received a copy of the GNU General Public License along with "
24409 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24410 "Ave, Cambridge, MA 02139, USA."
24415 #: ../fish/guestfish-actions.pod:1
24421 #: ../fish/guestfish-actions.pod:3
24424 " add-cdrom filename\n"
24430 #: ../fish/guestfish-actions.pod:15
24432 "This call checks for the existence of C<filename>. This stops you from "
24433 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24434 "and C<http:> URLs. To specify those, use the general L</config> call "
24440 #: ../fish/guestfish-actions.pod:22
24442 "If you just want to add an ISO file (often you use this as an efficient way "
24443 "to transfer large files into the guest), then you should probably use L</add-"
24444 "drive-ro> instead."
24449 #: ../fish/guestfish-actions.pod:35
24455 #: ../fish/guestfish-actions.pod:37
24460 #: ../fish/guestfish-actions.pod:39
24463 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24469 #: ../fish/guestfish-actions.pod:41
24471 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24472 "It works by connecting to libvirt, requesting the domain and domain XML from "
24473 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24478 #: ../fish/guestfish-actions.pod:71
24480 "The other optional parameters are passed directly through to L</add-drive-"
24486 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24487 #: ../fish/guestfish-actions.pod:3044
24489 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24494 #: ../fish/guestfish-actions.pod:76
24500 #: ../fish/guestfish-actions.pod:78
24503 " add-drive filename\n"
24509 #: ../fish/guestfish-actions.pod:80
24511 "This function is the equivalent of calling L</add-drive-opts> with no "
24512 "optional parameters, so the disk is added writable, with the format being "
24513 "detected automatically."
24518 #: ../fish/guestfish-actions.pod:84
24520 "Automatic detection of the format opens you up to a potential security hole "
24521 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24522 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24523 "you should think about replacing calls to this function with calls to L</add-"
24524 "drive-opts>, and specifying the format."
24529 #: ../fish/guestfish-actions.pod:91
24530 msgid "add-drive-opts"
24535 #: ../fish/guestfish-actions.pod:93
24541 #: ../fish/guestfish-actions.pod:95
24544 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24550 #: ../fish/guestfish-actions.pod:122
24552 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24553 "add-drive-ro>) then the format is automatically detected. Possible formats "
24554 "include C<raw> and C<qcow2>."
24559 #: ../fish/guestfish-actions.pod:133
24561 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24562 "add-drive-with-if> call (q.v.)"
24567 #: ../fish/guestfish-actions.pod:140
24568 msgid "add-drive-ro"
24573 #: ../fish/guestfish-actions.pod:142
24579 #: ../fish/guestfish-actions.pod:144
24582 " add-drive-ro filename\n"
24588 #: ../fish/guestfish-actions.pod:146
24590 "This function is the equivalent of calling L</add-drive-opts> with the "
24591 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24592 "is added read-only, with the format being detected automatically."
24597 #: ../fish/guestfish-actions.pod:151
24598 msgid "add-drive-ro-with-if"
24603 #: ../fish/guestfish-actions.pod:153
24606 " add-drive-ro-with-if filename iface\n"
24612 #: ../fish/guestfish-actions.pod:155
24614 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24615 "interface emulation to use at run time."
24620 #: ../fish/guestfish-actions.pod:165
24621 msgid "add-drive-with-if"
24626 #: ../fish/guestfish-actions.pod:167
24629 " add-drive-with-if filename iface\n"
24635 #: ../fish/guestfish-actions.pod:169
24637 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24638 "interface emulation to use at run time."
24643 #: ../fish/guestfish-actions.pod:179
24649 #: ../fish/guestfish-actions.pod:181
24652 " aug-clear augpath\n"
24658 #: ../fish/guestfish-actions.pod:186
24664 #: ../fish/guestfish-actions.pod:188
24673 #: ../fish/guestfish-actions.pod:190
24675 "Close the current Augeas handle and free up any resources used by it. After "
24676 "calling this, you have to call L</aug-init> again before you can use any "
24677 "other Augeas functions."
24682 #: ../fish/guestfish-actions.pod:195
24683 msgid "aug-defnode"
24688 #: ../fish/guestfish-actions.pod:197
24691 " aug-defnode name expr val\n"
24697 #: ../fish/guestfish-actions.pod:202
24699 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24700 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24701 "containing that single node."
24706 #: ../fish/guestfish-actions.pod:210
24712 #: ../fish/guestfish-actions.pod:212
24715 " aug-defvar name expr\n"
24721 #: ../fish/guestfish-actions.pod:221
24727 #: ../fish/guestfish-actions.pod:223
24730 " aug-get augpath\n"
24736 #: ../fish/guestfish-actions.pod:228
24742 #: ../fish/guestfish-actions.pod:230
24745 " aug-init root flags\n"
24751 #: ../fish/guestfish-actions.pod:236
24752 msgid "You must call this before using any other L</aug-*> commands."
24757 #: ../fish/guestfish-actions.pod:271
24758 msgid "Do not load the tree in L</aug-init>."
24763 #: ../fish/guestfish-actions.pod:275
24764 msgid "To close the handle, you can call L</aug-close>."
24769 #: ../fish/guestfish-actions.pod:279
24775 #: ../fish/guestfish-actions.pod:281
24778 " aug-insert augpath label true|false\n"
24784 #: ../fish/guestfish-actions.pod:291
24790 #: ../fish/guestfish-actions.pod:293
24799 #: ../fish/guestfish-actions.pod:300
24805 #: ../fish/guestfish-actions.pod:302
24808 " aug-ls augpath\n"
24814 #: ../fish/guestfish-actions.pod:304
24816 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24817 "resulting nodes into alphabetical order."
24822 #: ../fish/guestfish-actions.pod:307
24828 #: ../fish/guestfish-actions.pod:309
24831 " aug-match augpath\n"
24837 #: ../fish/guestfish-actions.pod:315
24843 #: ../fish/guestfish-actions.pod:317
24846 " aug-mv src dest\n"
24852 #: ../fish/guestfish-actions.pod:322
24858 #: ../fish/guestfish-actions.pod:324
24861 " aug-rm augpath\n"
24867 #: ../fish/guestfish-actions.pod:330
24873 #: ../fish/guestfish-actions.pod:332
24882 #: ../fish/guestfish-actions.pod:336
24884 "The flags which were passed to L</aug-init> affect exactly how files are "
24890 #: ../fish/guestfish-actions.pod:339
24896 #: ../fish/guestfish-actions.pod:341
24899 " aug-set augpath val\n"
24905 #: ../fish/guestfish-actions.pod:345
24907 "In the Augeas API, it is possible to clear a node by setting the value to "
24908 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24909 "this call. Instead you must use the L</aug-clear> call."
24914 #: ../fish/guestfish-actions.pod:350
24920 #: ../fish/guestfish-actions.pod:352
24923 " available 'groups ...'\n"
24929 #: ../fish/guestfish-actions.pod:358
24931 "The libguestfs groups, and the functions that those groups correspond to, "
24932 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24933 "runtime by calling L</available-all-groups>."
24938 #: ../fish/guestfish-actions.pod:382
24939 msgid "You must call L</launch> before calling this function."
24944 #: ../fish/guestfish-actions.pod:404
24946 "This call was added in version C<1.0.80>. In previous versions of "
24947 "libguestfs all you could do would be to speculatively execute a command to "
24948 "find out if the daemon implemented it. See also L</version>."
24953 #: ../fish/guestfish-actions.pod:411
24954 msgid "available-all-groups"
24959 #: ../fish/guestfish-actions.pod:413
24962 " available-all-groups\n"
24968 #: ../fish/guestfish-actions.pod:415
24970 "This command returns a list of all optional groups that this daemon knows "
24971 "about. Note this returns both supported and unsupported groups. To find "
24972 "out which ones the daemon can actually support you have to call L</"
24973 "available> on each member of the returned list."
24978 #: ../fish/guestfish-actions.pod:421
24979 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24984 #: ../fish/guestfish-actions.pod:423
24990 #: ../fish/guestfish-actions.pod:425
24993 " base64-in (base64file|-) filename\n"
24999 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
25000 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
25001 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1225
25002 #: ../fish/guestfish-actions.pod:4477 ../fish/guestfish-actions.pod:4489
25003 #: ../fish/guestfish-actions.pod:4500 ../fish/guestfish-actions.pod:4511
25004 #: ../fish/guestfish-actions.pod:4563 ../fish/guestfish-actions.pod:4572
25005 #: ../fish/guestfish-actions.pod:4626 ../fish/guestfish-actions.pod:4649
25006 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25011 #: ../fish/guestfish-actions.pod:432
25017 #: ../fish/guestfish-actions.pod:434
25020 " base64-out filename (base64file|-)\n"
25026 #: ../fish/guestfish-actions.pod:441
25027 msgid "blockdev-flushbufs"
25032 #: ../fish/guestfish-actions.pod:443
25035 " blockdev-flushbufs device\n"
25041 #: ../fish/guestfish-actions.pod:450
25042 msgid "blockdev-getbsz"
25047 #: ../fish/guestfish-actions.pod:452
25050 " blockdev-getbsz device\n"
25056 #: ../fish/guestfish-actions.pod:461
25057 msgid "blockdev-getro"
25062 #: ../fish/guestfish-actions.pod:463
25065 " blockdev-getro device\n"
25071 #: ../fish/guestfish-actions.pod:470
25072 msgid "blockdev-getsize64"
25077 #: ../fish/guestfish-actions.pod:472
25080 " blockdev-getsize64 device\n"
25086 #: ../fish/guestfish-actions.pod:476
25087 msgid "See also L</blockdev-getsz>."
25092 #: ../fish/guestfish-actions.pod:480
25093 msgid "blockdev-getss"
25098 #: ../fish/guestfish-actions.pod:482
25101 " blockdev-getss device\n"
25107 #: ../fish/guestfish-actions.pod:487
25109 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25114 #: ../fish/guestfish-actions.pod:492
25115 msgid "blockdev-getsz"
25120 #: ../fish/guestfish-actions.pod:494
25123 " blockdev-getsz device\n"
25129 #: ../fish/guestfish-actions.pod:499
25131 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25132 "blockdev-getsize64> for the more useful I<size in bytes>."
25137 #: ../fish/guestfish-actions.pod:505
25138 msgid "blockdev-rereadpt"
25143 #: ../fish/guestfish-actions.pod:507
25146 " blockdev-rereadpt device\n"
25152 #: ../fish/guestfish-actions.pod:513
25153 msgid "blockdev-setbsz"
25158 #: ../fish/guestfish-actions.pod:515
25161 " blockdev-setbsz device blocksize\n"
25167 #: ../fish/guestfish-actions.pod:524
25168 msgid "blockdev-setro"
25173 #: ../fish/guestfish-actions.pod:526
25176 " blockdev-setro device\n"
25182 #: ../fish/guestfish-actions.pod:532
25183 msgid "blockdev-setrw"
25188 #: ../fish/guestfish-actions.pod:534
25191 " blockdev-setrw device\n"
25197 #: ../fish/guestfish-actions.pod:540
25198 msgid "case-sensitive-path"
25203 #: ../fish/guestfish-actions.pod:542
25206 " case-sensitive-path path\n"
25212 #: ../fish/guestfish-actions.pod:566
25214 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25215 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25216 "the directories were originally created under Windows)."
25221 #: ../fish/guestfish-actions.pod:574
25222 msgid "See also L</realpath>."
25227 #: ../fish/guestfish-actions.pod:576
25233 #: ../fish/guestfish-actions.pod:578
25242 #: ../fish/guestfish-actions.pod:582
25244 "Note that this function cannot correctly handle binary files (specifically, "
25245 "files containing C<\\0> character which is treated as end of string). For "
25246 "those you need to use the L</read-file> or L</download> functions which have "
25247 "a more complex interface."
25252 #: ../fish/guestfish-actions.pod:590
25258 #: ../fish/guestfish-actions.pod:592
25261 " checksum csumtype path\n"
25267 #: ../fish/guestfish-actions.pod:635
25268 msgid "To get the checksum for a device, use L</checksum-device>."
25273 #: ../fish/guestfish-actions.pod:637
25274 msgid "To get the checksums for many files, use L</checksums-out>."
25279 #: ../fish/guestfish-actions.pod:639
25280 msgid "checksum-device"
25285 #: ../fish/guestfish-actions.pod:641
25288 " checksum-device csumtype device\n"
25294 #: ../fish/guestfish-actions.pod:643
25296 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25297 "device named C<device>. For the types of checksums supported see the L</"
25298 "checksum> command."
25303 #: ../fish/guestfish-actions.pod:647
25304 msgid "checksums-out"
25309 #: ../fish/guestfish-actions.pod:649
25312 " checksums-out csumtype directory (sumsfile|-)\n"
25318 #: ../fish/guestfish-actions.pod:665
25324 #: ../fish/guestfish-actions.pod:667
25327 " chmod mode path\n"
25333 #: ../fish/guestfish-actions.pod:678
25339 #: ../fish/guestfish-actions.pod:680
25342 " chown owner group path\n"
25348 #: ../fish/guestfish-actions.pod:688
25354 #: ../fish/guestfish-actions.pod:690
25357 " command 'arguments ...'\n"
25363 #: ../fish/guestfish-actions.pod:697
25365 "The single parameter is an argv-style list of arguments. The first element "
25366 "is the name of the program to run. Subsequent elements are parameters. The "
25367 "list must be non-empty (ie. must contain a program name). Note that the "
25368 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25373 #: ../fish/guestfish-actions.pod:725
25374 msgid "command-lines"
25379 #: ../fish/guestfish-actions.pod:727
25382 " command-lines 'arguments ...'\n"
25388 #: ../fish/guestfish-actions.pod:729
25390 "This is the same as L</command>, but splits the result into a list of lines."
25395 #: ../fish/guestfish-actions.pod:732
25396 msgid "See also: L</sh-lines>"
25401 #: ../fish/guestfish-actions.pod:737
25407 #: ../fish/guestfish-actions.pod:739
25410 " config qemuparam qemuvalue\n"
25416 #: ../fish/guestfish-actions.pod:750
25422 #: ../fish/guestfish-actions.pod:752
25425 " copy-size src dest size\n"
25431 #: ../fish/guestfish-actions.pod:760
25437 #: ../fish/guestfish-actions.pod:762
25446 #: ../fish/guestfish-actions.pod:767
25452 #: ../fish/guestfish-actions.pod:769
25461 #: ../fish/guestfish-actions.pod:774
25467 #: ../fish/guestfish-actions.pod:776
25476 #: ../fish/guestfish-actions.pod:783
25478 "If the destination is a device, it must be as large or larger than the "
25479 "source file or device, otherwise the copy will fail. This command cannot do "
25480 "partial copies (see L</copy-size>)."
25485 #: ../fish/guestfish-actions.pod:787
25491 #: ../fish/guestfish-actions.pod:789
25500 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25502 "This command is mostly useful for interactive sessions. It is I<not> "
25503 "intended that you try to parse the output string. Use L</statvfs> from "
25509 #: ../fish/guestfish-actions.pod:797
25515 #: ../fish/guestfish-actions.pod:799
25524 #: ../fish/guestfish-actions.pod:808
25530 #: ../fish/guestfish-actions.pod:810
25539 #: ../fish/guestfish-actions.pod:816
25541 "Another way to get the same information is to enable verbose messages with "
25542 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25543 "before running the program."
25548 #: ../fish/guestfish-actions.pod:821
25554 #: ../fish/guestfish-actions.pod:823
25557 " download remotefilename (filename|-)\n"
25563 #: ../fish/guestfish-actions.pod:830
25564 msgid "See also L</upload>, L</cat>."
25569 #: ../fish/guestfish-actions.pod:834
25570 msgid "download-offset"
25575 #: ../fish/guestfish-actions.pod:836
25578 " download-offset remotefilename (filename|-) offset size\n"
25584 #: ../fish/guestfish-actions.pod:844
25586 "Note that there is no limit on the amount of data that can be downloaded "
25587 "with this call, unlike with L</pread>, and this call always reads the full "
25588 "amount unless an error occurs."
25593 #: ../fish/guestfish-actions.pod:849
25594 msgid "See also L</download>, L</pread>."
25599 #: ../fish/guestfish-actions.pod:853
25600 msgid "drop-caches"
25605 #: ../fish/guestfish-actions.pod:855
25608 " drop-caches whattodrop\n"
25614 #: ../fish/guestfish-actions.pod:867
25620 #: ../fish/guestfish-actions.pod:869
25629 #: ../fish/guestfish-actions.pod:881
25635 #: ../fish/guestfish-actions.pod:883
25638 " e2fsck-f device\n"
25644 #: ../fish/guestfish-actions.pod:889
25646 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25647 "should use L</fsck>."
25652 #: ../fish/guestfish-actions.pod:892
25653 msgid "echo-daemon"
25658 #: ../fish/guestfish-actions.pod:894
25661 " echo-daemon 'words ...'\n"
25667 #: ../fish/guestfish-actions.pod:901
25668 msgid "See also L</ping-daemon>."
25673 #: ../fish/guestfish-actions.pod:903
25679 #: ../fish/guestfish-actions.pod:905
25682 " egrep regex path\n"
25688 #: ../fish/guestfish-actions.pod:913
25694 #: ../fish/guestfish-actions.pod:915
25697 " egrepi regex path\n"
25703 #: ../fish/guestfish-actions.pod:923
25709 #: ../fish/guestfish-actions.pod:925
25712 " equal file1 file2\n"
25718 #: ../fish/guestfish-actions.pod:932
25724 #: ../fish/guestfish-actions.pod:934
25733 #: ../fish/guestfish-actions.pod:939
25734 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25739 #: ../fish/guestfish-actions.pod:941
25745 #: ../fish/guestfish-actions.pod:943
25748 " fallocate path len\n"
25754 #: ../fish/guestfish-actions.pod:960
25755 msgid "fallocate64"
25760 #: ../fish/guestfish-actions.pod:962
25763 " fallocate64 path len\n"
25769 #: ../fish/guestfish-actions.pod:968
25771 "Note that this call allocates disk blocks for the file. To create a sparse "
25772 "file use L</truncate-size> instead."
25777 #: ../fish/guestfish-actions.pod:971
25779 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25780 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25781 "maximum size of files created through that call to 1GB."
25786 #: ../fish/guestfish-actions.pod:980
25792 #: ../fish/guestfish-actions.pod:982
25795 " fgrep pattern path\n"
25801 #: ../fish/guestfish-actions.pod:990
25807 #: ../fish/guestfish-actions.pod:992
25810 " fgrepi pattern path\n"
25816 #: ../fish/guestfish-actions.pod:1000
25822 #: ../fish/guestfish-actions.pod:1002
25830 #: ../fish/guestfish-actions.pod:1018
25832 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
25838 #: ../fish/guestfish-actions.pod:1021
25839 msgid "file-architecture"
25844 #: ../fish/guestfish-actions.pod:1023
25847 " file-architecture filename\n"
25853 #: ../fish/guestfish-actions.pod:1126
25859 #: ../fish/guestfish-actions.pod:1128
25868 #: ../fish/guestfish-actions.pod:1132
25870 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25871 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25876 #: ../fish/guestfish-actions.pod:1136
25882 #: ../fish/guestfish-actions.pod:1138
25885 " fill c len path\n"
25891 #: ../fish/guestfish-actions.pod:1144
25893 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25894 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25895 "L</fill-pattern>."
25900 #: ../fish/guestfish-actions.pod:1149
25901 msgid "fill-pattern"
25906 #: ../fish/guestfish-actions.pod:1151
25909 " fill-pattern pattern len path\n"
25915 #: ../fish/guestfish-actions.pod:1153
25917 "This function is like L</fill> except that it creates a new file of length "
25918 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25919 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25925 #: ../fish/guestfish-actions.pod:1158
25931 #: ../fish/guestfish-actions.pod:1160
25934 " find directory\n"
25940 #: ../fish/guestfish-actions.pod:1174
25941 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25946 #: ../fish/guestfish-actions.pod:1187
25947 msgid "See also L</find0>."
25952 #: ../fish/guestfish-actions.pod:1192
25958 #: ../fish/guestfish-actions.pod:1194
25961 " find0 directory (files|-)\n"
25967 #: ../fish/guestfish-actions.pod:1200
25969 "This command works the same way as L</find> with the following exceptions:"
25974 #: ../fish/guestfish-actions.pod:1227
25975 msgid "findfs-label"
25980 #: ../fish/guestfish-actions.pod:1229
25983 " findfs-label label\n"
25989 #: ../fish/guestfish-actions.pod:1235
25990 msgid "To find the label of a filesystem, use L</vfs-label>."
25995 #: ../fish/guestfish-actions.pod:1237
25996 msgid "findfs-uuid"
26001 #: ../fish/guestfish-actions.pod:1239
26004 " findfs-uuid uuid\n"
26010 #: ../fish/guestfish-actions.pod:1245
26011 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26016 #: ../fish/guestfish-actions.pod:1247
26022 #: ../fish/guestfish-actions.pod:1249
26025 " fsck fstype device\n"
26031 #: ../fish/guestfish-actions.pod:1279
26037 #: ../fish/guestfish-actions.pod:1281
26045 #: ../fish/guestfish-actions.pod:1288
26046 msgid "get-attach-method"
26050 #: ../fish/guestfish-actions.pod:1290
26053 " get-attach-method\n"
26058 #: ../fish/guestfish-actions.pod:1292
26059 msgid "Return the current attach method. See L</set-attach-method>."
26064 #: ../fish/guestfish-actions.pod:1294
26065 msgid "get-autosync"
26070 #: ../fish/guestfish-actions.pod:1296
26079 #: ../fish/guestfish-actions.pod:1300
26085 #: ../fish/guestfish-actions.pod:1302
26094 #: ../fish/guestfish-actions.pod:1306
26095 msgid "get-e2label"
26100 #: ../fish/guestfish-actions.pod:1308
26103 " get-e2label device\n"
26109 #: ../fish/guestfish-actions.pod:1320
26115 #: ../fish/guestfish-actions.pod:1322
26118 " get-e2uuid device\n"
26124 #: ../fish/guestfish-actions.pod:1334
26125 msgid "get-memsize"
26130 #: ../fish/guestfish-actions.pod:1336
26139 #: ../fish/guestfish-actions.pod:1341
26141 "If L</set-memsize> was not called on this handle, and if "
26142 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26143 "value for memsize."
26148 #: ../fish/guestfish-actions.pod:1348
26149 msgid "get-network"
26154 #: ../fish/guestfish-actions.pod:1350
26163 #: ../fish/guestfish-actions.pod:1354
26169 #: ../fish/guestfish-actions.pod:1356
26178 #: ../fish/guestfish-actions.pod:1363
26184 #: ../fish/guestfish-actions.pod:1365
26190 #: ../fish/guestfish-actions.pod:1367
26199 #: ../fish/guestfish-actions.pod:1374
26205 #: ../fish/guestfish-actions.pod:1376
26214 #: ../fish/guestfish-actions.pod:1383
26215 msgid "get-recovery-proc"
26220 #: ../fish/guestfish-actions.pod:1385
26223 " get-recovery-proc\n"
26229 #: ../fish/guestfish-actions.pod:1389
26230 msgid "get-selinux"
26235 #: ../fish/guestfish-actions.pod:1391
26244 #: ../fish/guestfish-actions.pod:1393
26246 "This returns the current setting of the selinux flag which is passed to the "
26247 "appliance at boot time. See L</set-selinux>."
26252 #: ../fish/guestfish-actions.pod:1399
26258 #: ../fish/guestfish-actions.pod:1401
26267 #: ../fish/guestfish-actions.pod:1408
26273 #: ../fish/guestfish-actions.pod:1410
26282 #: ../fish/guestfish-actions.pod:1414
26288 #: ../fish/guestfish-actions.pod:1416
26297 #: ../fish/guestfish-actions.pod:1418
26299 "Return the current umask. By default the umask is C<022> unless it has been "
26300 "set by calling L</umask>."
26305 #: ../fish/guestfish-actions.pod:1421
26306 msgid "get-verbose"
26311 #: ../fish/guestfish-actions.pod:1423
26320 #: ../fish/guestfish-actions.pod:1427
26326 #: ../fish/guestfish-actions.pod:1429
26335 #: ../fish/guestfish-actions.pod:1433
26336 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26341 #: ../fish/guestfish-actions.pod:1436
26347 #: ../fish/guestfish-actions.pod:1438
26350 " getxattr path name\n"
26356 #: ../fish/guestfish-actions.pod:1440
26358 "Get a single extended attribute from file C<path> named C<name>. This call "
26359 "follows symlinks. If you want to lookup an extended attribute for the "
26360 "symlink itself, use L</lgetxattr>."
26365 #: ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:2450
26367 "Normally it is better to get all extended attributes from a file in one go "
26368 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26369 "buggy and do not provide a way to list out attributes. For these "
26370 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26371 "attributes you want in advance and call this function."
26376 #: ../fish/guestfish-actions.pod:1454
26377 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26382 #: ../fish/guestfish-actions.pod:1456
26388 #: ../fish/guestfish-actions.pod:1458
26391 " getxattrs path\n"
26397 #: ../fish/guestfish-actions.pod:1466
26398 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26403 #: ../fish/guestfish-actions.pod:1468
26404 msgid "glob-expand"
26409 #: ../fish/guestfish-actions.pod:1470
26412 " glob-expand pattern\n"
26418 #: ../fish/guestfish-actions.pod:1483
26424 #: ../fish/guestfish-actions.pod:1485
26427 " grep regex path\n"
26433 #: ../fish/guestfish-actions.pod:1493
26439 #: ../fish/guestfish-actions.pod:1495
26442 " grepi regex path\n"
26448 #: ../fish/guestfish-actions.pod:1503
26449 msgid "grub-install"
26454 #: ../fish/guestfish-actions.pod:1505
26457 " grub-install root device\n"
26463 #: ../fish/guestfish-actions.pod:1521
26469 #: ../fish/guestfish-actions.pod:1523
26478 #: ../fish/guestfish-actions.pod:1531
26484 #: ../fish/guestfish-actions.pod:1533
26487 " head-n nrlines path\n"
26493 #: ../fish/guestfish-actions.pod:1546
26499 #: ../fish/guestfish-actions.pod:1548
26508 #: ../fish/guestfish-actions.pod:1556
26514 #: ../fish/guestfish-actions.pod:1558
26517 " initrd-cat initrdpath filename\n"
26523 #: ../fish/guestfish-actions.pod:1570
26524 msgid "See also L</initrd-list>."
26529 #: ../fish/guestfish-actions.pod:1575
26530 msgid "initrd-list"
26535 #: ../fish/guestfish-actions.pod:1577
26538 " initrd-list path\n"
26544 #: ../fish/guestfish-actions.pod:1589
26545 msgid "inotify-add-watch"
26550 #: ../fish/guestfish-actions.pod:1591
26553 " inotify-add-watch path mask\n"
26559 #: ../fish/guestfish-actions.pod:1603
26560 msgid "inotify-close"
26565 #: ../fish/guestfish-actions.pod:1605
26574 #: ../fish/guestfish-actions.pod:1611
26575 msgid "inotify-files"
26580 #: ../fish/guestfish-actions.pod:1613
26589 #: ../fish/guestfish-actions.pod:1615
26591 "This function is a helpful wrapper around L</inotify-read> which just "
26592 "returns a list of pathnames of objects that were touched. The returned "
26593 "pathnames are sorted and deduplicated."
26598 #: ../fish/guestfish-actions.pod:1619
26599 msgid "inotify-init"
26604 #: ../fish/guestfish-actions.pod:1621
26607 " inotify-init maxevents\n"
26613 #: ../fish/guestfish-actions.pod:1627
26615 "C<maxevents> is the maximum number of events which will be queued up between "
26616 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26617 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26618 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26619 "but records the fact that it threw them away by setting a flag "
26620 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26625 #: ../fish/guestfish-actions.pod:1637
26627 "Before any events are generated, you have to add some watches to the "
26628 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26629 "L</inotify-watch-all>."
26634 #: ../fish/guestfish-actions.pod:1643
26636 "Queued up events should be read periodically by calling L</inotify-read> (or "
26637 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26638 "If you don't read the events out often enough then you risk the internal "
26639 "queue overflowing."
26644 #: ../fish/guestfish-actions.pod:1650
26646 "The handle should be closed after use by calling L</inotify-close>. This "
26647 "also removes any watches automatically."
26652 #: ../fish/guestfish-actions.pod:1659
26653 msgid "inotify-read"
26658 #: ../fish/guestfish-actions.pod:1661
26667 #: ../fish/guestfish-actions.pod:1674
26668 msgid "inotify-rm-watch"
26673 #: ../fish/guestfish-actions.pod:1676
26676 " inotify-rm-watch wd\n"
26682 #: ../fish/guestfish-actions.pod:1678
26683 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26688 #: ../fish/guestfish-actions.pod:1681
26689 msgid "inspect-get-arch"
26694 #: ../fish/guestfish-actions.pod:1683
26697 " inspect-get-arch root\n"
26703 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1701
26704 #: ../fish/guestfish-actions.pod:1787 ../fish/guestfish-actions.pod:1823
26705 #: ../fish/guestfish-actions.pod:1841 ../fish/guestfish-actions.pod:1875
26706 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1911
26707 #: ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1959
26708 #: ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:2005
26709 #: ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2065
26710 #: ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2116
26711 #: ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2145
26712 #: ../fish/guestfish-actions.pod:2158 ../fish/guestfish-actions.pod:2173
26714 "This function should only be called with a root device string as returned by "
26720 #: ../fish/guestfish-actions.pod:1688
26722 "This returns the architecture of the inspected operating system. The "
26723 "possible return values are listed under L</file-architecture>."
26728 #: ../fish/guestfish-actions.pod:1697
26729 msgid "inspect-get-distro"
26734 #: ../fish/guestfish-actions.pod:1699
26737 " inspect-get-distro root\n"
26742 #: ../fish/guestfish-actions.pod:1783
26743 msgid "inspect-get-drive-mappings"
26747 #: ../fish/guestfish-actions.pod:1785
26750 " inspect-get-drive-mappings root\n"
26755 #: ../fish/guestfish-actions.pod:1815
26757 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26758 "get-mountpoints>, L</inspect-get-filesystems>."
26763 #: ../fish/guestfish-actions.pod:1819
26764 msgid "inspect-get-filesystems"
26769 #: ../fish/guestfish-actions.pod:1821
26772 " inspect-get-filesystems root\n"
26778 #: ../fish/guestfish-actions.pod:1834
26780 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26781 "get-mountpoints>."
26785 #: ../fish/guestfish-actions.pod:1837
26786 msgid "inspect-get-format"
26790 #: ../fish/guestfish-actions.pod:1839
26793 " inspect-get-format root\n"
26799 #: ../fish/guestfish-actions.pod:1871
26800 msgid "inspect-get-hostname"
26805 #: ../fish/guestfish-actions.pod:1873
26808 " inspect-get-hostname root\n"
26814 #: ../fish/guestfish-actions.pod:1886
26815 msgid "inspect-get-major-version"
26820 #: ../fish/guestfish-actions.pod:1888
26823 " inspect-get-major-version root\n"
26829 #: ../fish/guestfish-actions.pod:1907
26830 msgid "inspect-get-minor-version"
26835 #: ../fish/guestfish-actions.pod:1909
26838 " inspect-get-minor-version root\n"
26844 #: ../fish/guestfish-actions.pod:1919
26846 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26847 "get-major-version>."
26852 #: ../fish/guestfish-actions.pod:1922
26853 msgid "inspect-get-mountpoints"
26858 #: ../fish/guestfish-actions.pod:1924
26861 " inspect-get-mountpoints root\n"
26866 #: ../fish/guestfish-actions.pod:1946
26868 "For operating systems like Windows which still use drive letters, this call "
26869 "will only return an entry for the first drive \"mounted on\" C</>. For "
26870 "information about the mapping of drive letters to partitions, see L</inspect-"
26871 "get-drive-mappings>."
26876 #: ../fish/guestfish-actions.pod:1952
26878 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26879 "get-filesystems>."
26884 #: ../fish/guestfish-actions.pod:1955
26885 msgid "inspect-get-package-format"
26890 #: ../fish/guestfish-actions.pod:1957
26893 " inspect-get-package-format root\n"
26899 #: ../fish/guestfish-actions.pod:1962
26901 "This function and L</inspect-get-package-management> return the package "
26902 "format and package management tool used by the inspected operating system. "
26903 "For example for Fedora these functions would return C<rpm> (package format) "
26904 "and C<yum> (package management)."
26909 #: ../fish/guestfish-actions.pod:1977
26910 msgid "inspect-get-package-management"
26915 #: ../fish/guestfish-actions.pod:1979
26918 " inspect-get-package-management root\n"
26924 #: ../fish/guestfish-actions.pod:1984
26926 "L</inspect-get-package-format> and this function return the package format "
26927 "and package management tool used by the inspected operating system. For "
26928 "example for Fedora these functions would return C<rpm> (package format) and "
26929 "C<yum> (package management)."
26934 #: ../fish/guestfish-actions.pod:2001
26935 msgid "inspect-get-product-name"
26940 #: ../fish/guestfish-actions.pod:2003
26943 " inspect-get-product-name root\n"
26948 #: ../fish/guestfish-actions.pod:2018
26949 msgid "inspect-get-product-variant"
26953 #: ../fish/guestfish-actions.pod:2020
26956 " inspect-get-product-variant root\n"
26961 #: ../fish/guestfish-actions.pod:2044
26963 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26964 "get-product-name>, L</inspect-get-major-version>."
26969 #: ../fish/guestfish-actions.pod:2048
26970 msgid "inspect-get-roots"
26975 #: ../fish/guestfish-actions.pod:2050
26978 " inspect-get-roots\n"
26984 #: ../fish/guestfish-actions.pod:2052
26986 "This function is a convenient way to get the list of root devices, as "
26987 "returned from a previous call to L</inspect-os>, but without redoing the "
26988 "whole inspection process."
26993 #: ../fish/guestfish-actions.pod:2056
26995 "This returns an empty list if either no root devices were found or the "
26996 "caller has not called L</inspect-os>."
27001 #: ../fish/guestfish-actions.pod:2061
27002 msgid "inspect-get-type"
27007 #: ../fish/guestfish-actions.pod:2063
27010 " inspect-get-type root\n"
27015 #: ../fish/guestfish-actions.pod:2096
27016 msgid "inspect-get-windows-current-control-set"
27020 #: ../fish/guestfish-actions.pod:2098
27023 " inspect-get-windows-current-control-set root\n"
27029 #: ../fish/guestfish-actions.pod:2112
27030 msgid "inspect-get-windows-systemroot"
27035 #: ../fish/guestfish-actions.pod:2114
27038 " inspect-get-windows-systemroot root\n"
27043 #: ../fish/guestfish-actions.pod:2128
27044 msgid "inspect-is-live"
27048 #: ../fish/guestfish-actions.pod:2130
27051 " inspect-is-live root\n"
27056 #: ../fish/guestfish-actions.pod:2135
27058 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27059 "then this returns true if a live image was detected on the disk."
27063 #: ../fish/guestfish-actions.pod:2141
27064 msgid "inspect-is-multipart"
27068 #: ../fish/guestfish-actions.pod:2143
27071 " inspect-is-multipart root\n"
27076 #: ../fish/guestfish-actions.pod:2148
27078 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27079 "then this returns true if the disk is part of a set."
27083 #: ../fish/guestfish-actions.pod:2154
27084 msgid "inspect-is-netinst"
27088 #: ../fish/guestfish-actions.pod:2156
27091 " inspect-is-netinst root\n"
27096 #: ../fish/guestfish-actions.pod:2161
27098 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27099 "then this returns true if the disk is a network installer, ie. not a self-"
27100 "contained install CD but one which is likely to require network access to "
27101 "complete the install."
27106 #: ../fish/guestfish-actions.pod:2169
27107 msgid "inspect-list-applications"
27112 #: ../fish/guestfish-actions.pod:2171
27115 " inspect-list-applications root\n"
27121 #: ../fish/guestfish-actions.pod:2178
27123 "I<Note:> This call works differently from other parts of the inspection "
27124 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27125 "then mount up the disks, before calling this. Listing applications is a "
27126 "significantly more difficult operation which requires access to the full "
27127 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27128 "are just returning data cached in the libguestfs handle, this call actually "
27129 "reads parts of the mounted filesystems during the call."
27134 #: ../fish/guestfish-actions.pod:2268
27140 #: ../fish/guestfish-actions.pod:2270
27149 #: ../fish/guestfish-actions.pod:2285
27151 "You can pass the root string(s) returned to other L</inspect-get-*> "
27152 "functions in order to query further information about each operating system, "
27153 "such as the name and version."
27158 #: ../fish/guestfish-actions.pod:2290
27160 "This function uses other libguestfs features such as L</mount-ro> and L</"
27161 "umount-all> in order to mount and unmount filesystems and look at the "
27162 "contents. This should be called with no disks currently mounted. The "
27163 "function may also use Augeas, so any existing Augeas handle will be closed."
27168 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2478
27169 #: ../fish/guestfish-actions.pod:2524
27170 msgid "See also L</list-filesystems>."
27175 #: ../fish/guestfish-actions.pod:2304
27176 msgid "is-blockdev"
27181 #: ../fish/guestfish-actions.pod:2306
27184 " is-blockdev path\n"
27190 #: ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2329
27191 #: ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2357
27192 #: ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2401
27193 #: ../fish/guestfish-actions.pod:2410
27194 msgid "See also L</stat>."
27199 #: ../fish/guestfish-actions.pod:2313
27205 #: ../fish/guestfish-actions.pod:2315
27214 #: ../fish/guestfish-actions.pod:2322
27220 #: ../fish/guestfish-actions.pod:2324
27223 " is-chardev path\n"
27229 #: ../fish/guestfish-actions.pod:2331
27235 #: ../fish/guestfish-actions.pod:2333
27244 #: ../fish/guestfish-actions.pod:2340
27250 #: ../fish/guestfish-actions.pod:2342
27259 #: ../fish/guestfish-actions.pod:2350
27265 #: ../fish/guestfish-actions.pod:2352
27274 #: ../fish/guestfish-actions.pod:2359
27280 #: ../fish/guestfish-actions.pod:2361
27289 #: ../fish/guestfish-actions.pod:2369
27290 msgid "is-launching"
27295 #: ../fish/guestfish-actions.pod:2371
27304 #: ../fish/guestfish-actions.pod:2378
27310 #: ../fish/guestfish-actions.pod:2380
27319 #: ../fish/guestfish-actions.pod:2385
27325 #: ../fish/guestfish-actions.pod:2387
27334 #: ../fish/guestfish-actions.pod:2394
27340 #: ../fish/guestfish-actions.pod:2396
27343 " is-socket path\n"
27349 #: ../fish/guestfish-actions.pod:2403
27355 #: ../fish/guestfish-actions.pod:2405
27358 " is-symlink path\n"
27364 #: ../fish/guestfish-actions.pod:2412
27365 msgid "kill-subprocess"
27370 #: ../fish/guestfish-actions.pod:2414
27373 " kill-subprocess\n"
27379 #: ../fish/guestfish-actions.pod:2418
27385 #: ../fish/guestfish-actions.pod:2420
27391 #: ../fish/guestfish-actions.pod:2422
27400 #: ../fish/guestfish-actions.pod:2430
27406 #: ../fish/guestfish-actions.pod:2432
27409 " lchown owner group path\n"
27415 #: ../fish/guestfish-actions.pod:2434
27417 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27418 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27424 #: ../fish/guestfish-actions.pod:2442
27430 #: ../fish/guestfish-actions.pod:2444
27433 " lgetxattr path name\n"
27439 #: ../fish/guestfish-actions.pod:2460
27440 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27445 #: ../fish/guestfish-actions.pod:2462
27451 #: ../fish/guestfish-actions.pod:2464
27454 " lgetxattrs path\n"
27460 #: ../fish/guestfish-actions.pod:2466
27462 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27463 "it returns the extended attributes of the link itself."
27468 #: ../fish/guestfish-actions.pod:2470
27469 msgid "list-devices"
27474 #: ../fish/guestfish-actions.pod:2472
27483 #: ../fish/guestfish-actions.pod:2480
27484 msgid "list-filesystems"
27489 #: ../fish/guestfish-actions.pod:2482
27492 " list-filesystems\n"
27498 #: ../fish/guestfish-actions.pod:2501
27500 "This command runs other libguestfs commands, which might include L</mount> "
27501 "and L</umount>, and therefore you should use this soon after launch and only "
27502 "when nothing is mounted."
27507 #: ../fish/guestfish-actions.pod:2505
27509 "Not all of the filesystems returned will be mountable. In particular, swap "
27510 "partitions are returned in the list. Also this command does not check that "
27511 "each filesystem found is valid and mountable, and some filesystems might be "
27512 "mountable but require special options. Filesystems may not all belong to a "
27513 "single logical operating system (use L</inspect-os> to look for OSes)."
27518 #: ../fish/guestfish-actions.pod:2513
27519 msgid "list-partitions"
27524 #: ../fish/guestfish-actions.pod:2515
27527 " list-partitions\n"
27533 #: ../fish/guestfish-actions.pod:2521
27535 "This does not return logical volumes. For that you will need to call L</"
27541 #: ../fish/guestfish-actions.pod:2526
27547 #: ../fish/guestfish-actions.pod:2528
27556 #: ../fish/guestfish-actions.pod:2536
27562 #: ../fish/guestfish-actions.pod:2538
27565 " ln target linkname\n"
27571 #: ../fish/guestfish-actions.pod:2542
27577 #: ../fish/guestfish-actions.pod:2544
27580 " ln-f target linkname\n"
27586 #: ../fish/guestfish-actions.pod:2549
27592 #: ../fish/guestfish-actions.pod:2551
27595 " ln-s target linkname\n"
27601 #: ../fish/guestfish-actions.pod:2555
27607 #: ../fish/guestfish-actions.pod:2557
27610 " ln-sf target linkname\n"
27616 #: ../fish/guestfish-actions.pod:2562
27617 msgid "lremovexattr"
27622 #: ../fish/guestfish-actions.pod:2564
27625 " lremovexattr xattr path\n"
27631 #: ../fish/guestfish-actions.pod:2566
27633 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27634 "it removes an extended attribute of the link itself."
27639 #: ../fish/guestfish-actions.pod:2570
27645 #: ../fish/guestfish-actions.pod:2572
27654 #: ../fish/guestfish-actions.pod:2578
27656 "This command is mostly useful for interactive sessions. Programs should "
27657 "probably use L</readdir> instead."
27662 #: ../fish/guestfish-actions.pod:2581
27668 #: ../fish/guestfish-actions.pod:2583
27671 " lsetxattr xattr val vallen path\n"
27677 #: ../fish/guestfish-actions.pod:2585
27679 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27680 "sets an extended attribute of the link itself."
27685 #: ../fish/guestfish-actions.pod:2589
27691 #: ../fish/guestfish-actions.pod:2591
27700 #: ../fish/guestfish-actions.pod:2595
27702 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27703 "the link is stat-ed, not the file it refers to."
27708 #: ../fish/guestfish-actions.pod:2601
27714 #: ../fish/guestfish-actions.pod:2603
27717 " lstatlist path 'names ...'\n"
27723 #: ../fish/guestfish-actions.pod:2605
27725 "This call allows you to perform the L</lstat> operation on multiple files, "
27726 "where all files are in the directory C<path>. C<names> is the list of files "
27727 "from this directory."
27732 #: ../fish/guestfish-actions.pod:2614
27734 "This call is intended for programs that want to efficiently list a directory "
27735 "contents without making many round-trips. See also L</lxattrlist> for a "
27736 "similarly efficient call for getting extended attributes. Very long "
27737 "directory listings might cause the protocol message size to be exceeded, "
27738 "causing this call to fail. The caller must split up such requests into "
27739 "smaller groups of names."
27744 #: ../fish/guestfish-actions.pod:2622
27745 msgid "luks-add-key"
27750 #: ../fish/guestfish-actions.pod:2624
27753 " luks-add-key device keyslot\n"
27759 #: ../fish/guestfish-actions.pod:2631
27761 "Note that if C<keyslot> already contains a key, then this command will "
27762 "fail. You have to use L</luks-kill-slot> first to remove that key."
27767 #: ../fish/guestfish-actions.pod:2635 ../fish/guestfish-actions.pod:2657
27768 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:2684
27769 #: ../fish/guestfish-actions.pod:2707 ../fish/guestfish-actions.pod:2717
27771 "This command has one or more key or passphrase parameters. Guestfish will "
27772 "prompt for these separately."
27777 #: ../fish/guestfish-actions.pod:2638
27783 #: ../fish/guestfish-actions.pod:2640
27786 " luks-close device\n"
27792 #: ../fish/guestfish-actions.pod:2642
27794 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27795 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27796 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27802 #: ../fish/guestfish-actions.pod:2648
27803 msgid "luks-format"
27808 #: ../fish/guestfish-actions.pod:2650
27811 " luks-format device keyslot\n"
27817 #: ../fish/guestfish-actions.pod:2663
27818 msgid "luks-format-cipher"
27823 #: ../fish/guestfish-actions.pod:2665
27826 " luks-format-cipher device keyslot cipher\n"
27832 #: ../fish/guestfish-actions.pod:2667
27834 "This command is the same as L</luks-format> but it also allows you to set "
27835 "the C<cipher> used."
27840 #: ../fish/guestfish-actions.pod:2676
27841 msgid "luks-kill-slot"
27846 #: ../fish/guestfish-actions.pod:2678
27849 " luks-kill-slot device keyslot\n"
27855 #: ../fish/guestfish-actions.pod:2687
27861 #: ../fish/guestfish-actions.pod:2689
27864 " luks-open device mapname\n"
27870 #: ../fish/guestfish-actions.pod:2703
27872 "If this block device contains LVM volume groups, then calling L</vgscan> "
27873 "followed by L</vg-activate-all> will make them visible."
27878 #: ../fish/guestfish-actions.pod:2710
27879 msgid "luks-open-ro"
27884 #: ../fish/guestfish-actions.pod:2712
27887 " luks-open-ro device mapname\n"
27893 #: ../fish/guestfish-actions.pod:2714
27895 "This is the same as L</luks-open> except that a read-only mapping is created."
27900 #: ../fish/guestfish-actions.pod:2720
27906 #: ../fish/guestfish-actions.pod:2722
27909 " lvcreate logvol volgroup mbytes\n"
27915 #: ../fish/guestfish-actions.pod:2727
27916 msgid "lvm-canonical-lv-name"
27921 #: ../fish/guestfish-actions.pod:2729
27924 " lvm-canonical-lv-name lvname\n"
27930 #: ../fish/guestfish-actions.pod:2738
27931 msgid "See also L</is-lv>."
27936 #: ../fish/guestfish-actions.pod:2740
27937 msgid "lvm-clear-filter"
27942 #: ../fish/guestfish-actions.pod:2742
27945 " lvm-clear-filter\n"
27951 #: ../fish/guestfish-actions.pod:2744
27953 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27959 #: ../fish/guestfish-actions.pod:2750
27960 msgid "lvm-remove-all"
27965 #: ../fish/guestfish-actions.pod:2752
27968 " lvm-remove-all\n"
27974 #: ../fish/guestfish-actions.pod:2760
27975 msgid "lvm-set-filter"
27980 #: ../fish/guestfish-actions.pod:2762
27983 " lvm-set-filter 'devices ...'\n"
27989 #: ../fish/guestfish-actions.pod:2787
27995 #: ../fish/guestfish-actions.pod:2789
27998 " lvremove device\n"
28004 #: ../fish/guestfish-actions.pod:2797
28010 #: ../fish/guestfish-actions.pod:2799
28013 " lvrename logvol newlogvol\n"
28019 #: ../fish/guestfish-actions.pod:2803
28025 #: ../fish/guestfish-actions.pod:2805
28028 " lvresize device mbytes\n"
28034 #: ../fish/guestfish-actions.pod:2811
28035 msgid "lvresize-free"
28040 #: ../fish/guestfish-actions.pod:2813
28043 " lvresize-free lv percent\n"
28049 #: ../fish/guestfish-actions.pod:2821
28055 #: ../fish/guestfish-actions.pod:2823
28064 #: ../fish/guestfish-actions.pod:2831
28065 msgid "See also L</lvs-full>, L</list-filesystems>."
28070 #: ../fish/guestfish-actions.pod:2833
28076 #: ../fish/guestfish-actions.pod:2835
28085 #: ../fish/guestfish-actions.pod:2840
28091 #: ../fish/guestfish-actions.pod:2842
28100 #: ../fish/guestfish-actions.pod:2846
28106 #: ../fish/guestfish-actions.pod:2848
28109 " lxattrlist path 'names ...'\n"
28115 #: ../fish/guestfish-actions.pod:2864
28117 "This call is intended for programs that want to efficiently list a directory "
28118 "contents without making many round-trips. See also L</lstatlist> for a "
28119 "similarly efficient call for getting standard stats. Very long directory "
28120 "listings might cause the protocol message size to be exceeded, causing this "
28121 "call to fail. The caller must split up such requests into smaller groups of "
28127 #: ../fish/guestfish-actions.pod:2872
28133 #: ../fish/guestfish-actions.pod:2874
28142 #: ../fish/guestfish-actions.pod:2878
28148 #: ../fish/guestfish-actions.pod:2880
28151 " mkdir-mode path mode\n"
28157 #: ../fish/guestfish-actions.pod:2889
28158 msgid "See also L</mkdir>, L</umask>"
28163 #: ../fish/guestfish-actions.pod:2891
28169 #: ../fish/guestfish-actions.pod:2893
28178 #: ../fish/guestfish-actions.pod:2898
28184 #: ../fish/guestfish-actions.pod:2900
28187 " mkdtemp template\n"
28193 #: ../fish/guestfish-actions.pod:2921
28199 #: ../fish/guestfish-actions.pod:2923
28202 " mke2fs-J fstype blocksize device journal\n"
28208 #: ../fish/guestfish-actions.pod:2931
28209 msgid "See also L</mke2journal>."
28214 #: ../fish/guestfish-actions.pod:2933
28220 #: ../fish/guestfish-actions.pod:2935
28223 " mke2fs-JL fstype blocksize device label\n"
28229 #: ../fish/guestfish-actions.pod:2940
28230 msgid "See also L</mke2journal-L>."
28235 #: ../fish/guestfish-actions.pod:2942
28241 #: ../fish/guestfish-actions.pod:2944
28244 " mke2fs-JU fstype blocksize device uuid\n"
28250 #: ../fish/guestfish-actions.pod:2949
28251 msgid "See also L</mke2journal-U>."
28256 #: ../fish/guestfish-actions.pod:2951
28257 msgid "mke2journal"
28262 #: ../fish/guestfish-actions.pod:2953
28265 " mke2journal blocksize device\n"
28271 #: ../fish/guestfish-actions.pod:2960
28272 msgid "mke2journal-L"
28277 #: ../fish/guestfish-actions.pod:2962
28280 " mke2journal-L blocksize label device\n"
28286 #: ../fish/guestfish-actions.pod:2966
28287 msgid "mke2journal-U"
28292 #: ../fish/guestfish-actions.pod:2968
28295 " mke2journal-U blocksize uuid device\n"
28301 #: ../fish/guestfish-actions.pod:2972
28307 #: ../fish/guestfish-actions.pod:2974
28310 " mkfifo mode path\n"
28316 #: ../fish/guestfish-actions.pod:2976
28318 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28319 "is just a convenient wrapper around L</mknod>."
28324 #: ../fish/guestfish-actions.pod:2982
28330 #: ../fish/guestfish-actions.pod:2984
28333 " mkfs fstype device\n"
28339 #: ../fish/guestfish-actions.pod:2990
28345 #: ../fish/guestfish-actions.pod:2992
28348 " mkfs-b fstype blocksize device\n"
28354 #: ../fish/guestfish-actions.pod:2994
28356 "This call is similar to L</mkfs>, but it allows you to control the block "
28357 "size of the resulting filesystem. Supported block sizes depend on the "
28358 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28363 #: ../fish/guestfish-actions.pod:3009
28368 #: ../fish/guestfish-actions.pod:3011
28371 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28377 #: ../fish/guestfish-actions.pod:3046
28378 msgid "mkmountpoint"
28383 #: ../fish/guestfish-actions.pod:3048
28386 " mkmountpoint exemptpath\n"
28392 #: ../fish/guestfish-actions.pod:3050
28394 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28395 "to create extra mountpoints before mounting the first filesystem."
28400 #: ../fish/guestfish-actions.pod:3074
28402 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28403 "unexpected errors if you try to mix these calls. It is safest to manually "
28404 "unmount filesystems and remove mountpoints after use."
28409 #: ../fish/guestfish-actions.pod:3078
28411 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28412 "for this to work for manual mountpoints, you must ensure that the innermost "
28413 "mountpoints have the longest pathnames, as in the example code above."
28417 #: ../fish/guestfish-actions.pod:3085
28419 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28420 "L</umount-all> to be called when the handle is closed which can also trigger "
28426 #: ../fish/guestfish-actions.pod:3089
28432 #: ../fish/guestfish-actions.pod:3091
28435 " mknod mode devmajor devminor path\n"
28441 #: ../fish/guestfish-actions.pod:3101
28443 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28444 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28445 "regular file). These constants are available in the standard Linux header "
28446 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28447 "wrappers around this command which bitwise OR in the appropriate constant "
28453 #: ../fish/guestfish-actions.pod:3111
28459 #: ../fish/guestfish-actions.pod:3113
28462 " mknod-b mode devmajor devminor path\n"
28468 #: ../fish/guestfish-actions.pod:3115
28470 "This call creates a block device node called C<path> with mode C<mode> and "
28471 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28472 "wrapper around L</mknod>."
28477 #: ../fish/guestfish-actions.pod:3121
28483 #: ../fish/guestfish-actions.pod:3123
28486 " mknod-c mode devmajor devminor path\n"
28492 #: ../fish/guestfish-actions.pod:3125
28494 "This call creates a char device node called C<path> with mode C<mode> and "
28495 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28496 "wrapper around L</mknod>."
28501 #: ../fish/guestfish-actions.pod:3131
28507 #: ../fish/guestfish-actions.pod:3133
28516 #: ../fish/guestfish-actions.pod:3137
28522 #: ../fish/guestfish-actions.pod:3139
28525 " mkswap-L label device\n"
28531 #: ../fish/guestfish-actions.pod:3147
28537 #: ../fish/guestfish-actions.pod:3149
28540 " mkswap-U uuid device\n"
28546 #: ../fish/guestfish-actions.pod:3153
28547 msgid "mkswap-file"
28552 #: ../fish/guestfish-actions.pod:3155
28555 " mkswap-file path\n"
28561 #: ../fish/guestfish-actions.pod:3159
28563 "This command just writes a swap file signature to an existing file. To "
28564 "create the file itself, use something like L</fallocate>."
28569 #: ../fish/guestfish-actions.pod:3162
28575 #: ../fish/guestfish-actions.pod:3164
28578 " modprobe modulename\n"
28584 #: ../fish/guestfish-actions.pod:3171
28590 #: ../fish/guestfish-actions.pod:3173
28593 " mount device mountpoint\n"
28599 #: ../fish/guestfish-actions.pod:3189
28601 "B<Important note:> When you use this call, the filesystem options C<sync> "
28602 "and C<noatime> are set implicitly. This was originally done because we "
28603 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28604 "very large negative performance impact and negligible effect on "
28605 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28606 "code that needs performance, and instead use L</mount-options> (use an empty "
28607 "string for the first parameter if you don't want any options)."
28612 #: ../fish/guestfish-actions.pod:3206
28618 #: ../fish/guestfish-actions.pod:3208
28621 " mount-loop file mountpoint\n"
28627 #: ../fish/guestfish-actions.pod:3214
28628 msgid "mount-options"
28633 #: ../fish/guestfish-actions.pod:3216
28636 " mount-options options device mountpoint\n"
28642 #: ../fish/guestfish-actions.pod:3218
28644 "This is the same as the L</mount> command, but it allows you to set the "
28645 "mount options as for the L<mount(8)> I<-o> flag."
28650 #: ../fish/guestfish-actions.pod:3226
28656 #: ../fish/guestfish-actions.pod:3228
28659 " mount-ro device mountpoint\n"
28665 #: ../fish/guestfish-actions.pod:3230
28667 "This is the same as the L</mount> command, but it mounts the filesystem with "
28668 "the read-only (I<-o ro>) flag."
28673 #: ../fish/guestfish-actions.pod:3233
28679 #: ../fish/guestfish-actions.pod:3235
28682 " mount-vfs options vfstype device mountpoint\n"
28688 #: ../fish/guestfish-actions.pod:3237
28690 "This is the same as the L</mount> command, but it allows you to set both the "
28691 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28696 #: ../fish/guestfish-actions.pod:3241
28697 msgid "mountpoints"
28702 #: ../fish/guestfish-actions.pod:3243
28711 #: ../fish/guestfish-actions.pod:3245
28713 "This call is similar to L</mounts>. That call returns a list of devices. "
28714 "This one returns a hash table (map) of device name to directory where the "
28715 "device is mounted."
28720 #: ../fish/guestfish-actions.pod:3249
28726 #: ../fish/guestfish-actions.pod:3251
28735 #: ../fish/guestfish-actions.pod:3258
28736 msgid "See also: L</mountpoints>"
28741 #: ../fish/guestfish-actions.pod:3260
28747 #: ../fish/guestfish-actions.pod:3262
28756 #: ../fish/guestfish-actions.pod:3267
28757 msgid "ntfs-3g-probe"
28762 #: ../fish/guestfish-actions.pod:3269
28765 " ntfs-3g-probe true|false device\n"
28771 #: ../fish/guestfish-actions.pod:3283
28777 #: ../fish/guestfish-actions.pod:3285
28780 " ntfsresize device\n"
28786 #: ../fish/guestfish-actions.pod:3291
28787 msgid "ntfsresize-size"
28792 #: ../fish/guestfish-actions.pod:3293
28795 " ntfsresize-size device size\n"
28801 #: ../fish/guestfish-actions.pod:3295
28803 "This command is the same as L</ntfsresize> except that it allows you to "
28804 "specify the new size (in bytes) explicitly."
28809 #: ../fish/guestfish-actions.pod:3298
28815 #: ../fish/guestfish-actions.pod:3300
28818 " part-add device prlogex startsect endsect\n"
28824 #: ../fish/guestfish-actions.pod:3302
28826 "This command adds a partition to C<device>. If there is no partition table "
28827 "on the device, call L</part-init> first."
28832 #: ../fish/guestfish-actions.pod:3314
28834 "Creating a partition which covers the whole disk is not so easy. Use L</"
28835 "part-disk> to do that."
28840 #: ../fish/guestfish-actions.pod:3317
28846 #: ../fish/guestfish-actions.pod:3319
28849 " part-del device partnum\n"
28855 #: ../fish/guestfish-actions.pod:3327
28861 #: ../fish/guestfish-actions.pod:3329
28864 " part-disk device parttype\n"
28870 #: ../fish/guestfish-actions.pod:3331
28872 "This command is simply a combination of L</part-init> followed by L</part-"
28873 "add> to create a single primary partition covering the whole disk."
28878 #: ../fish/guestfish-actions.pod:3335
28880 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28881 "possible values are described in L</part-init>."
28886 #: ../fish/guestfish-actions.pod:3341
28887 msgid "part-get-bootable"
28892 #: ../fish/guestfish-actions.pod:3343
28895 " part-get-bootable device partnum\n"
28901 #: ../fish/guestfish-actions.pod:3348
28902 msgid "See also L</part-set-bootable>."
28907 #: ../fish/guestfish-actions.pod:3350
28908 msgid "part-get-mbr-id"
28913 #: ../fish/guestfish-actions.pod:3352
28916 " part-get-mbr-id device partnum\n"
28922 #: ../fish/guestfish-actions.pod:3357 ../fish/guestfish-actions.pod:3495
28924 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28925 "undefined results for other partition table types (see L</part-get-"
28931 #: ../fish/guestfish-actions.pod:3361
28932 msgid "part-get-parttype"
28937 #: ../fish/guestfish-actions.pod:3363
28940 " part-get-parttype device\n"
28946 #: ../fish/guestfish-actions.pod:3368
28948 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28949 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28950 "possible, although unusual. See L</part-init> for a full list."
28955 #: ../fish/guestfish-actions.pod:3373
28961 #: ../fish/guestfish-actions.pod:3375
28964 " part-init device parttype\n"
28970 #: ../fish/guestfish-actions.pod:3381
28972 "Initially there are no partitions. Following this, you should call L</part-"
28973 "add> for each partition required."
28978 #: ../fish/guestfish-actions.pod:3444
28984 #: ../fish/guestfish-actions.pod:3446
28987 " part-list device\n"
28993 #: ../fish/guestfish-actions.pod:3461
28995 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28996 "the device's sector size, see L</blockdev-getss>."
29001 #: ../fish/guestfish-actions.pod:3474
29002 msgid "part-set-bootable"
29007 #: ../fish/guestfish-actions.pod:3476
29010 " part-set-bootable device partnum true|false\n"
29016 #: ../fish/guestfish-actions.pod:3485
29017 msgid "part-set-mbr-id"
29022 #: ../fish/guestfish-actions.pod:3487
29025 " part-set-mbr-id device partnum idbyte\n"
29031 #: ../fish/guestfish-actions.pod:3499
29032 msgid "part-set-name"
29037 #: ../fish/guestfish-actions.pod:3501
29040 " part-set-name device partnum name\n"
29046 #: ../fish/guestfish-actions.pod:3509
29047 msgid "part-to-dev"
29052 #: ../fish/guestfish-actions.pod:3511
29055 " part-to-dev partition\n"
29061 #: ../fish/guestfish-actions.pod:3517
29063 "The named partition must exist, for example as a string returned from L</"
29064 "list-partitions>."
29069 #: ../fish/guestfish-actions.pod:3520
29070 msgid "ping-daemon"
29075 #: ../fish/guestfish-actions.pod:3522
29084 #: ../fish/guestfish-actions.pod:3529
29090 #: ../fish/guestfish-actions.pod:3531
29093 " pread path count offset\n"
29099 #: ../fish/guestfish-actions.pod:3539
29100 msgid "See also L</pwrite>, L</pread-device>."
29105 #: ../fish/guestfish-actions.pod:3544
29106 msgid "pread-device"
29111 #: ../fish/guestfish-actions.pod:3546
29114 " pread-device device count offset\n"
29120 #: ../fish/guestfish-actions.pod:3554
29121 msgid "See also L</pread>."
29126 #: ../fish/guestfish-actions.pod:3559
29132 #: ../fish/guestfish-actions.pod:3561
29135 " pvcreate device\n"
29141 #: ../fish/guestfish-actions.pod:3567
29147 #: ../fish/guestfish-actions.pod:3569
29150 " pvremove device\n"
29156 #: ../fish/guestfish-actions.pod:3578
29162 #: ../fish/guestfish-actions.pod:3580
29165 " pvresize device\n"
29171 #: ../fish/guestfish-actions.pod:3585
29172 msgid "pvresize-size"
29177 #: ../fish/guestfish-actions.pod:3587
29180 " pvresize-size device size\n"
29186 #: ../fish/guestfish-actions.pod:3589
29188 "This command is the same as L</pvresize> except that it allows you to "
29189 "specify the new size (in bytes) explicitly."
29194 #: ../fish/guestfish-actions.pod:3592
29200 #: ../fish/guestfish-actions.pod:3594
29209 #: ../fish/guestfish-actions.pod:3602
29210 msgid "See also L</pvs-full>."
29215 #: ../fish/guestfish-actions.pod:3604
29221 #: ../fish/guestfish-actions.pod:3606
29230 #: ../fish/guestfish-actions.pod:3611
29236 #: ../fish/guestfish-actions.pod:3613
29245 #: ../fish/guestfish-actions.pod:3617
29251 #: ../fish/guestfish-actions.pod:3619
29254 " pwrite path content offset\n"
29260 #: ../fish/guestfish-actions.pod:3630
29261 msgid "See also L</pread>, L</pwrite-device>."
29266 #: ../fish/guestfish-actions.pod:3635
29267 msgid "pwrite-device"
29272 #: ../fish/guestfish-actions.pod:3637
29275 " pwrite-device device content offset\n"
29281 #: ../fish/guestfish-actions.pod:3647
29282 msgid "See also L</pwrite>."
29287 #: ../fish/guestfish-actions.pod:3652
29293 #: ../fish/guestfish-actions.pod:3654
29296 " read-file path\n"
29302 #: ../fish/guestfish-actions.pod:3659
29304 "Unlike L</cat>, this function can correctly handle files that contain "
29305 "embedded ASCII NUL characters. However unlike L</download>, this function "
29306 "is limited in the total size of file that can be handled."
29311 #: ../fish/guestfish-actions.pod:3667
29317 #: ../fish/guestfish-actions.pod:3669
29320 " read-lines path\n"
29326 #: ../fish/guestfish-actions.pod:3676
29328 "Note that this function cannot correctly handle binary files (specifically, "
29329 "files containing C<\\0> character which is treated as end of line). For "
29330 "those you need to use the L</read-file> function which has a more complex "
29336 #: ../fish/guestfish-actions.pod:3681
29342 #: ../fish/guestfish-actions.pod:3683
29351 #: ../fish/guestfish-actions.pod:3735
29353 "This function is primarily intended for use by programs. To get a simple "
29354 "list of names, use L</ls>. To get a printable directory for human "
29355 "consumption, use L</ll>."
29360 #: ../fish/guestfish-actions.pod:3739
29366 #: ../fish/guestfish-actions.pod:3741
29375 #: ../fish/guestfish-actions.pod:3745
29376 msgid "readlinklist"
29381 #: ../fish/guestfish-actions.pod:3747
29384 " readlinklist path 'names ...'\n"
29390 #: ../fish/guestfish-actions.pod:3771
29396 #: ../fish/guestfish-actions.pod:3773
29405 #: ../fish/guestfish-actions.pod:3778
29406 msgid "removexattr"
29411 #: ../fish/guestfish-actions.pod:3780
29414 " removexattr xattr path\n"
29420 #: ../fish/guestfish-actions.pod:3785
29421 msgid "See also: L</lremovexattr>, L<attr(5)>."
29426 #: ../fish/guestfish-actions.pod:3787
29432 #: ../fish/guestfish-actions.pod:3789
29435 " resize2fs device\n"
29441 #: ../fish/guestfish-actions.pod:3794
29443 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29444 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29445 "gives an error about this and sometimes not. In any case, it is always safe "
29446 "to call L</e2fsck-f> before calling this function."
29450 #: ../fish/guestfish-actions.pod:3800
29451 msgid "resize2fs-M"
29455 #: ../fish/guestfish-actions.pod:3802
29458 " resize2fs-M device\n"
29463 #: ../fish/guestfish-actions.pod:3804
29465 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29466 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29471 #: ../fish/guestfish-actions.pod:3808
29473 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29474 "and read the C<Block size> and C<Block count> values. These two numbers, "
29475 "multiplied together, give the resulting size of the minimal filesystem in "
29481 #: ../fish/guestfish-actions.pod:3813
29482 msgid "resize2fs-size"
29487 #: ../fish/guestfish-actions.pod:3815
29490 " resize2fs-size device size\n"
29496 #: ../fish/guestfish-actions.pod:3817
29498 "This command is the same as L</resize2fs> except that it allows you to "
29499 "specify the new size (in bytes) explicitly."
29504 #: ../fish/guestfish-actions.pod:3820
29510 #: ../fish/guestfish-actions.pod:3822
29519 #: ../fish/guestfish-actions.pod:3826
29525 #: ../fish/guestfish-actions.pod:3828
29534 #: ../fish/guestfish-actions.pod:3834
29540 #: ../fish/guestfish-actions.pod:3836
29549 #: ../fish/guestfish-actions.pod:3840
29550 msgid "rmmountpoint"
29555 #: ../fish/guestfish-actions.pod:3842
29558 " rmmountpoint exemptpath\n"
29564 #: ../fish/guestfish-actions.pod:3844
29566 "This calls removes a mountpoint that was previously created with L</"
29567 "mkmountpoint>. See L</mkmountpoint> for full details."
29572 #: ../fish/guestfish-actions.pod:3848
29573 msgid "scrub-device"
29578 #: ../fish/guestfish-actions.pod:3850
29581 " scrub-device device\n"
29587 #: ../fish/guestfish-actions.pod:3861
29593 #: ../fish/guestfish-actions.pod:3863
29596 " scrub-file file\n"
29602 #: ../fish/guestfish-actions.pod:3873
29603 msgid "scrub-freespace"
29608 #: ../fish/guestfish-actions.pod:3875
29611 " scrub-freespace dir\n"
29617 #: ../fish/guestfish-actions.pod:3877
29619 "This command creates the directory C<dir> and then fills it with files until "
29620 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29621 "deletes them. The intention is to scrub any free space on the partition "
29622 "containing C<dir>."
29627 #: ../fish/guestfish-actions.pod:3886
29633 #: ../fish/guestfish-actions.pod:3888
29639 #: ../fish/guestfish-actions.pod:3890
29642 " set-append append\n"
29647 #: ../fish/guestfish-actions.pod:3901
29648 msgid "set-attach-method"
29652 #: ../fish/guestfish-actions.pod:3903
29653 msgid "attach-method"
29657 #: ../fish/guestfish-actions.pod:3905
29660 " set-attach-method attachmethod\n"
29666 #: ../fish/guestfish-actions.pod:3927
29667 msgid "set-autosync"
29672 #: ../fish/guestfish-actions.pod:3929
29678 #: ../fish/guestfish-actions.pod:3931
29681 " set-autosync true|false\n"
29687 #: ../fish/guestfish-actions.pod:3941
29693 #: ../fish/guestfish-actions.pod:3943
29699 #: ../fish/guestfish-actions.pod:3945
29702 " set-direct true|false\n"
29708 #: ../fish/guestfish-actions.pod:3951
29710 "One consequence of this is that log messages aren't caught by the library "
29711 "and handled by L</set-log-message-callback>, but go straight to stdout."
29716 #: ../fish/guestfish-actions.pod:3960
29717 msgid "set-e2label"
29722 #: ../fish/guestfish-actions.pod:3962
29725 " set-e2label device label\n"
29731 #: ../fish/guestfish-actions.pod:3968
29733 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29734 "label on a filesystem."
29739 #: ../fish/guestfish-actions.pod:3971
29745 #: ../fish/guestfish-actions.pod:3973
29748 " set-e2uuid device uuid\n"
29754 #: ../fish/guestfish-actions.pod:3980
29756 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29757 "UUID of a filesystem."
29762 #: ../fish/guestfish-actions.pod:3983
29763 msgid "set-memsize"
29768 #: ../fish/guestfish-actions.pod:3985
29774 #: ../fish/guestfish-actions.pod:3987
29777 " set-memsize memsize\n"
29783 #: ../fish/guestfish-actions.pod:3989
29785 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29786 "This only has any effect if called before L</launch>."
29791 #: ../fish/guestfish-actions.pod:4000
29792 msgid "set-network"
29797 #: ../fish/guestfish-actions.pod:4002
29803 #: ../fish/guestfish-actions.pod:4004
29806 " set-network true|false\n"
29812 #: ../fish/guestfish-actions.pod:4012
29814 "You must call this before calling L</launch>, otherwise it has no effect."
29819 #: ../fish/guestfish-actions.pod:4015
29825 #: ../fish/guestfish-actions.pod:4017
29831 #: ../fish/guestfish-actions.pod:4019
29834 " set-path searchpath\n"
29840 #: ../fish/guestfish-actions.pod:4028
29846 #: ../fish/guestfish-actions.pod:4030
29852 #: ../fish/guestfish-actions.pod:4032
29861 #: ../fish/guestfish-actions.pod:4052
29862 msgid "set-recovery-proc"
29867 #: ../fish/guestfish-actions.pod:4054
29868 msgid "recovery-proc"
29873 #: ../fish/guestfish-actions.pod:4056
29876 " set-recovery-proc true|false\n"
29882 #: ../fish/guestfish-actions.pod:4058
29884 "If this is called with the parameter C<false> then L</launch> does not "
29885 "create a recovery process. The purpose of the recovery process is to stop "
29886 "runaway qemu processes in the case where the main program aborts abruptly."
29891 #: ../fish/guestfish-actions.pod:4063
29893 "This only has any effect if called before L</launch>, and the default is "
29899 #: ../fish/guestfish-actions.pod:4072
29900 msgid "set-selinux"
29905 #: ../fish/guestfish-actions.pod:4074
29911 #: ../fish/guestfish-actions.pod:4076
29914 " set-selinux true|false\n"
29920 #: ../fish/guestfish-actions.pod:4087
29926 #: ../fish/guestfish-actions.pod:4089
29932 #: ../fish/guestfish-actions.pod:4091
29935 " set-trace true|false\n"
29940 #: ../fish/guestfish-actions.pod:4103
29942 "Trace messages are normally sent to C<stderr>, unless you register a "
29943 "callback to send them somewhere else (see L</set-event-callback>)."
29948 #: ../fish/guestfish-actions.pod:4107
29949 msgid "set-verbose"
29954 #: ../fish/guestfish-actions.pod:4109
29960 #: ../fish/guestfish-actions.pod:4111
29963 " set-verbose true|false\n"
29968 #: ../fish/guestfish-actions.pod:4118
29970 "Verbose 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:4122
29982 #: ../fish/guestfish-actions.pod:4124
29985 " setcon context\n"
29991 #: ../fish/guestfish-actions.pod:4131
29997 #: ../fish/guestfish-actions.pod:4133
30000 " setxattr xattr val vallen path\n"
30006 #: ../fish/guestfish-actions.pod:4139
30007 msgid "See also: L</lsetxattr>, L<attr(5)>."
30012 #: ../fish/guestfish-actions.pod:4141
30018 #: ../fish/guestfish-actions.pod:4143
30021 " sfdisk device cyls heads sectors 'lines ...'\n"
30027 #: ../fish/guestfish-actions.pod:4165
30028 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30033 #: ../fish/guestfish-actions.pod:4178
30039 #: ../fish/guestfish-actions.pod:4180
30042 " sfdiskM device 'lines ...'\n"
30048 #: ../fish/guestfish-actions.pod:4182
30050 "This is a simplified interface to the L</sfdisk> command, where partition "
30051 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30052 "you don't need to specify the cyls, heads and sectors parameters which were "
30053 "rarely if ever used anyway."
30058 #: ../fish/guestfish-actions.pod:4188
30059 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30064 #: ../fish/guestfish-actions.pod:4201
30070 #: ../fish/guestfish-actions.pod:4203
30073 " sfdisk-N device partnum cyls heads sectors line\n"
30079 #: ../fish/guestfish-actions.pod:4208
30081 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30082 "cyls/heads/sectors parameters."
30087 #: ../fish/guestfish-actions.pod:4211
30088 msgid "See also: L</part-add>"
30093 #: ../fish/guestfish-actions.pod:4223
30094 msgid "sfdisk-disk-geometry"
30099 #: ../fish/guestfish-actions.pod:4225
30102 " sfdisk-disk-geometry device\n"
30108 #: ../fish/guestfish-actions.pod:4227
30110 "This displays the disk geometry of C<device> read from the partition table. "
30111 "Especially in the case where the underlying block device has been resized, "
30112 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30113 "kernel-geometry>)."
30118 #: ../fish/guestfish-actions.pod:4235
30119 msgid "sfdisk-kernel-geometry"
30124 #: ../fish/guestfish-actions.pod:4237
30127 " sfdisk-kernel-geometry device\n"
30133 #: ../fish/guestfish-actions.pod:4244
30139 #: ../fish/guestfish-actions.pod:4246
30142 " sfdisk-l device\n"
30148 #: ../fish/guestfish-actions.pod:4252
30149 msgid "See also: L</part-list>"
30154 #: ../fish/guestfish-actions.pod:4261
30160 #: ../fish/guestfish-actions.pod:4263
30169 #: ../fish/guestfish-actions.pod:4268
30170 msgid "This is like L</command>, but passes the command to:"
30175 #: ../fish/guestfish-actions.pod:4276
30176 msgid "All the provisos about L</command> apply to this call."
30181 #: ../fish/guestfish-actions.pod:4278
30187 #: ../fish/guestfish-actions.pod:4280
30190 " sh-lines command\n"
30196 #: ../fish/guestfish-actions.pod:4282
30197 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30202 #: ../fish/guestfish-actions.pod:4285
30203 msgid "See also: L</command-lines>"
30208 #: ../fish/guestfish-actions.pod:4287
30214 #: ../fish/guestfish-actions.pod:4289
30223 #: ../fish/guestfish-actions.pod:4293
30229 #: ../fish/guestfish-actions.pod:4295
30238 #: ../fish/guestfish-actions.pod:4301
30244 #: ../fish/guestfish-actions.pod:4303
30253 #: ../fish/guestfish-actions.pod:4311
30259 #: ../fish/guestfish-actions.pod:4313
30268 #: ../fish/guestfish-actions.pod:4321
30274 #: ../fish/guestfish-actions.pod:4323
30277 " strings-e encoding path\n"
30283 #: ../fish/guestfish-actions.pod:4325
30285 "This is like the L</strings> command, but allows you to specify the encoding "
30286 "of strings that are looked for in the source file C<path>."
30291 #: ../fish/guestfish-actions.pod:4335
30293 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30294 "ISO-8859-X (this is what L</strings> uses)."
30299 #: ../fish/guestfish-actions.pod:4367
30300 msgid "swapoff-device"
30305 #: ../fish/guestfish-actions.pod:4369
30308 " swapoff-device device\n"
30314 #: ../fish/guestfish-actions.pod:4371
30316 "This command disables the libguestfs appliance swap device or partition "
30317 "named C<device>. See L</swapon-device>."
30322 #: ../fish/guestfish-actions.pod:4375
30323 msgid "swapoff-file"
30328 #: ../fish/guestfish-actions.pod:4377
30331 " swapoff-file file\n"
30337 #: ../fish/guestfish-actions.pod:4381
30338 msgid "swapoff-label"
30343 #: ../fish/guestfish-actions.pod:4383
30346 " swapoff-label label\n"
30352 #: ../fish/guestfish-actions.pod:4388
30353 msgid "swapoff-uuid"
30358 #: ../fish/guestfish-actions.pod:4390
30361 " swapoff-uuid uuid\n"
30367 #: ../fish/guestfish-actions.pod:4395
30368 msgid "swapon-device"
30373 #: ../fish/guestfish-actions.pod:4397
30376 " swapon-device device\n"
30382 #: ../fish/guestfish-actions.pod:4399
30384 "This command enables the libguestfs appliance to use the swap device or "
30385 "partition named C<device>. The increased memory is made available for all "
30386 "commands, for example those run using L</command> or L</sh>."
30391 #: ../fish/guestfish-actions.pod:4411
30392 msgid "swapon-file"
30397 #: ../fish/guestfish-actions.pod:4413
30400 " swapon-file file\n"
30406 #: ../fish/guestfish-actions.pod:4415
30408 "This command enables swap to a file. See L</swapon-device> for other notes."
30413 #: ../fish/guestfish-actions.pod:4418
30414 msgid "swapon-label"
30419 #: ../fish/guestfish-actions.pod:4420
30422 " swapon-label label\n"
30428 #: ../fish/guestfish-actions.pod:4422
30430 "This command enables swap to a labeled swap partition. See L</swapon-"
30431 "device> for other notes."
30436 #: ../fish/guestfish-actions.pod:4425
30437 msgid "swapon-uuid"
30442 #: ../fish/guestfish-actions.pod:4427
30445 " swapon-uuid uuid\n"
30451 #: ../fish/guestfish-actions.pod:4429
30453 "This command enables swap to a swap partition with the given UUID. See L</"
30454 "swapon-device> for other notes."
30459 #: ../fish/guestfish-actions.pod:4432
30465 #: ../fish/guestfish-actions.pod:4434
30474 #: ../fish/guestfish-actions.pod:4442
30480 #: ../fish/guestfish-actions.pod:4444
30489 #: ../fish/guestfish-actions.pod:4452
30495 #: ../fish/guestfish-actions.pod:4454
30498 " tail-n nrlines path\n"
30504 #: ../fish/guestfish-actions.pod:4467
30510 #: ../fish/guestfish-actions.pod:4469
30513 " tar-in (tarfile|-) directory\n"
30519 #: ../fish/guestfish-actions.pod:4474
30520 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30525 #: ../fish/guestfish-actions.pod:4479
30531 #: ../fish/guestfish-actions.pod:4481
30534 " tar-out directory (tarfile|-)\n"
30540 #: ../fish/guestfish-actions.pod:4486
30541 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30546 #: ../fish/guestfish-actions.pod:4491
30552 #: ../fish/guestfish-actions.pod:4493
30555 " tgz-in (tarball|-) directory\n"
30561 #: ../fish/guestfish-actions.pod:4498
30562 msgid "To upload an uncompressed tarball, use L</tar-in>."
30567 #: ../fish/guestfish-actions.pod:4502
30573 #: ../fish/guestfish-actions.pod:4504
30576 " tgz-out directory (tarball|-)\n"
30582 #: ../fish/guestfish-actions.pod:4509
30583 msgid "To download an uncompressed tarball, use L</tar-out>."
30588 #: ../fish/guestfish-actions.pod:4513
30594 #: ../fish/guestfish-actions.pod:4515
30603 #: ../fish/guestfish-actions.pod:4524
30609 #: ../fish/guestfish-actions.pod:4526
30618 #: ../fish/guestfish-actions.pod:4531
30619 msgid "truncate-size"
30624 #: ../fish/guestfish-actions.pod:4533
30627 " truncate-size path size\n"
30633 #: ../fish/guestfish-actions.pod:4538
30635 "If the current file size is less than C<size> then the file is extended to "
30636 "the required size with zero bytes. This creates a sparse file (ie. disk "
30637 "blocks are not allocated for the file until you write to it). To create a "
30638 "non-sparse file of zeroes, use L</fallocate64> instead."
30643 #: ../fish/guestfish-actions.pod:4544
30649 #: ../fish/guestfish-actions.pod:4546
30652 " tune2fs-l device\n"
30658 #: ../fish/guestfish-actions.pod:4556
30664 #: ../fish/guestfish-actions.pod:4558
30667 " txz-in (tarball|-) directory\n"
30673 #: ../fish/guestfish-actions.pod:4565
30679 #: ../fish/guestfish-actions.pod:4567
30682 " txz-out directory (tarball|-)\n"
30688 #: ../fish/guestfish-actions.pod:4574
30694 #: ../fish/guestfish-actions.pod:4576
30703 #: ../fish/guestfish-actions.pod:4590
30704 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30709 #: ../fish/guestfish-actions.pod:4595
30715 #: ../fish/guestfish-actions.pod:4597
30721 #: ../fish/guestfish-actions.pod:4599
30724 " umount pathordevice\n"
30730 #: ../fish/guestfish-actions.pod:4605
30736 #: ../fish/guestfish-actions.pod:4607
30737 msgid "unmount-all"
30742 #: ../fish/guestfish-actions.pod:4609
30751 #: ../fish/guestfish-actions.pod:4615
30757 #: ../fish/guestfish-actions.pod:4617
30760 " upload (filename|-) remotefilename\n"
30766 #: ../fish/guestfish-actions.pod:4624
30767 msgid "See also L</download>."
30772 #: ../fish/guestfish-actions.pod:4628
30773 msgid "upload-offset"
30778 #: ../fish/guestfish-actions.pod:4630
30781 " upload-offset (filename|-) remotefilename offset\n"
30787 #: ../fish/guestfish-actions.pod:4642
30789 "Note that there is no limit on the amount of data that can be uploaded with "
30790 "this call, unlike with L</pwrite>, and this call always writes the full "
30791 "amount unless an error occurs."
30796 #: ../fish/guestfish-actions.pod:4647
30797 msgid "See also L</upload>, L</pwrite>."
30802 #: ../fish/guestfish-actions.pod:4651
30808 #: ../fish/guestfish-actions.pod:4653
30811 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30817 #: ../fish/guestfish-actions.pod:4672
30823 #: ../fish/guestfish-actions.pod:4674
30832 #: ../fish/guestfish-actions.pod:4701
30834 "I<Note:> Don't use this call to test for availability of features. In "
30835 "enterprise distributions we backport features from later versions into "
30836 "earlier versions, making this an unreliable way to test for features. Use "
30837 "L</available> instead."
30842 #: ../fish/guestfish-actions.pod:4707
30848 #: ../fish/guestfish-actions.pod:4709
30851 " vfs-label device\n"
30857 #: ../fish/guestfish-actions.pod:4716
30858 msgid "To find a filesystem from the label, use L</findfs-label>."
30863 #: ../fish/guestfish-actions.pod:4718
30869 #: ../fish/guestfish-actions.pod:4720
30872 " vfs-type device\n"
30878 #: ../fish/guestfish-actions.pod:4730
30884 #: ../fish/guestfish-actions.pod:4732
30887 " vfs-uuid device\n"
30893 #: ../fish/guestfish-actions.pod:4739
30894 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30899 #: ../fish/guestfish-actions.pod:4741
30900 msgid "vg-activate"
30905 #: ../fish/guestfish-actions.pod:4743
30908 " vg-activate true|false 'volgroups ...'\n"
30914 #: ../fish/guestfish-actions.pod:4756
30915 msgid "vg-activate-all"
30920 #: ../fish/guestfish-actions.pod:4758
30923 " vg-activate-all true|false\n"
30929 #: ../fish/guestfish-actions.pod:4768
30935 #: ../fish/guestfish-actions.pod:4770
30938 " vgcreate volgroup 'physvols ...'\n"
30944 #: ../fish/guestfish-actions.pod:4775
30950 #: ../fish/guestfish-actions.pod:4777
30953 " vglvuuids vgname\n"
30959 #: ../fish/guestfish-actions.pod:4782
30961 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30962 "logical volumes and volume groups."
30967 #: ../fish/guestfish-actions.pod:4785
30968 msgid "See also L</vgpvuuids>."
30973 #: ../fish/guestfish-actions.pod:4787
30979 #: ../fish/guestfish-actions.pod:4789
30982 " vgpvuuids vgname\n"
30988 #: ../fish/guestfish-actions.pod:4794
30990 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30991 "physical volumes and volume groups."
30996 #: ../fish/guestfish-actions.pod:4797
30997 msgid "See also L</vglvuuids>."
31002 #: ../fish/guestfish-actions.pod:4799
31008 #: ../fish/guestfish-actions.pod:4801
31011 " vgremove vgname\n"
31017 #: ../fish/guestfish-actions.pod:4808
31023 #: ../fish/guestfish-actions.pod:4810
31026 " vgrename volgroup newvolgroup\n"
31032 #: ../fish/guestfish-actions.pod:4814
31038 #: ../fish/guestfish-actions.pod:4816
31047 #: ../fish/guestfish-actions.pod:4824
31048 msgid "See also L</vgs-full>."
31053 #: ../fish/guestfish-actions.pod:4826
31059 #: ../fish/guestfish-actions.pod:4828
31068 #: ../fish/guestfish-actions.pod:4833
31074 #: ../fish/guestfish-actions.pod:4835
31083 #: ../fish/guestfish-actions.pod:4840
31089 #: ../fish/guestfish-actions.pod:4842
31098 #: ../fish/guestfish-actions.pod:4846
31104 #: ../fish/guestfish-actions.pod:4848
31113 #: ../fish/guestfish-actions.pod:4853
31119 #: ../fish/guestfish-actions.pod:4855
31128 #: ../fish/guestfish-actions.pod:4860
31134 #: ../fish/guestfish-actions.pod:4862
31143 #: ../fish/guestfish-actions.pod:4867
31149 #: ../fish/guestfish-actions.pod:4869
31152 " write path content\n"
31158 #: ../fish/guestfish-actions.pod:4877
31164 #: ../fish/guestfish-actions.pod:4879
31167 " write-file path content size\n"
31173 #: ../fish/guestfish-actions.pod:4902
31179 #: ../fish/guestfish-actions.pod:4904
31182 " zegrep regex path\n"
31188 #: ../fish/guestfish-actions.pod:4912
31194 #: ../fish/guestfish-actions.pod:4914
31197 " zegrepi regex path\n"
31203 #: ../fish/guestfish-actions.pod:4922
31209 #: ../fish/guestfish-actions.pod:4924
31218 #: ../fish/guestfish-actions.pod:4932
31219 msgid "See also: L</zero-device>, L</scrub-device>."
31224 #: ../fish/guestfish-actions.pod:4934
31225 msgid "zero-device"
31230 #: ../fish/guestfish-actions.pod:4936
31233 " zero-device device\n"
31239 #: ../fish/guestfish-actions.pod:4938
31241 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31242 "which just zeroes the first few blocks of a device."
31247 #: ../fish/guestfish-actions.pod:4945
31253 #: ../fish/guestfish-actions.pod:4947
31256 " zerofree device\n"
31262 #: ../fish/guestfish-actions.pod:4960
31268 #: ../fish/guestfish-actions.pod:4962
31271 " zfgrep pattern path\n"
31277 #: ../fish/guestfish-actions.pod:4970
31283 #: ../fish/guestfish-actions.pod:4972
31286 " zfgrepi pattern path\n"
31292 #: ../fish/guestfish-actions.pod:4980
31298 #: ../fish/guestfish-actions.pod:4982
31301 " zfile meth path\n"
31307 #: ../fish/guestfish-actions.pod:4989
31309 "Since 1.0.63, use L</file> instead which can now process compressed files."
31314 #: ../fish/guestfish-actions.pod:4999
31320 #: ../fish/guestfish-actions.pod:5001
31323 " zgrep regex path\n"
31329 #: ../fish/guestfish-actions.pod:5009
31335 #: ../fish/guestfish-actions.pod:5011
31338 " zgrepi regex path\n"
31344 #: ../fish/guestfish-commands.pod:1
31350 #: ../fish/guestfish-commands.pod:3
31356 #: ../fish/guestfish-commands.pod:5
31359 " alloc filename size\n"
31365 #: ../fish/guestfish-commands.pod:7
31367 "This creates an empty (zeroed) file of the given size, and then adds so it "
31368 "can be further examined."
31373 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31374 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31379 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31380 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31385 #: ../fish/guestfish-commands.pod:14
31387 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31388 "image, see L</PREPARED DISK IMAGES>."
31393 #: ../fish/guestfish-commands.pod:17
31399 #: ../fish/guestfish-commands.pod:19
31402 " copy-in local [local ...] /remotedir\n"
31408 #: ../fish/guestfish-commands.pod:21
31410 "C<copy-in> copies local files or directories recursively into the disk "
31411 "image, placing them in the directory called C</remotedir> (which must "
31412 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31413 "other commands as necessary."
31418 #: ../fish/guestfish-commands.pod:26
31420 "Multiple local files and directories can be specified, but the last "
31421 "parameter must always be a remote directory. Wildcards cannot be used."
31426 #: ../fish/guestfish-commands.pod:30
31432 #: ../fish/guestfish-commands.pod:32
31435 " copy-out remote [remote ...] localdir\n"
31441 #: ../fish/guestfish-commands.pod:34
31443 "C<copy-out> copies remote files or directories recursively out of the disk "
31444 "image, placing them on the host disk in a local directory called C<localdir> "
31445 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31446 "download>, L</tar-out> and other commands as necessary."
31451 #: ../fish/guestfish-commands.pod:40
31453 "Multiple remote files and directories can be specified, but the last "
31454 "parameter must always be a local directory. To download to the current "
31455 "directory, use C<.> as in:"
31460 #: ../fish/guestfish-commands.pod:44
31463 " copy-out /home .\n"
31469 #: ../fish/guestfish-commands.pod:46
31471 "Wildcards cannot be used in the ordinary command, but you can use them with "
31472 "the help of L</glob> like this:"
31477 #: ../fish/guestfish-commands.pod:49
31480 " glob copy-out /home/* .\n"
31486 #: ../fish/guestfish-commands.pod:51
31492 #: ../fish/guestfish-commands.pod:53
31495 " echo [params ...]\n"
31501 #: ../fish/guestfish-commands.pod:55
31502 msgid "This echos the parameters to the terminal."
31507 #: ../fish/guestfish-commands.pod:57
31513 #: ../fish/guestfish-commands.pod:59
31519 #: ../fish/guestfish-commands.pod:61
31525 #: ../fish/guestfish-commands.pod:63
31534 #: ../fish/guestfish-commands.pod:65
31536 "This is used to edit a file. It downloads the file, edits it locally using "
31537 "your editor, then uploads the result."
31542 #: ../fish/guestfish-commands.pod:68
31544 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31545 "or C<emacs> you will get those corresponding editors."
31550 #: ../fish/guestfish-commands.pod:72
31556 #: ../fish/guestfish-commands.pod:74
31559 " glob command args...\n"
31565 #: ../fish/guestfish-commands.pod:76
31567 "Expand wildcards in any paths in the args list, and run C<command> "
31568 "repeatedly on each matching path."
31573 #: ../fish/guestfish-commands.pod:79
31574 msgid "See L</WILDCARDS AND GLOBBING>."
31579 #: ../fish/guestfish-commands.pod:81
31585 #: ../fish/guestfish-commands.pod:83
31588 " hexedit <filename|device>\n"
31589 " hexedit <filename|device> <max>\n"
31590 " hexedit <filename|device> <start> <max>\n"
31596 #: ../fish/guestfish-commands.pod:87
31598 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31604 #: ../fish/guestfish-commands.pod:90
31606 "This command works by downloading potentially the whole file or device, "
31607 "editing it locally, then uploading it. If the file or device is large, you "
31608 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31609 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31610 "usual modifiers allowed such as C<1M> (1 megabyte)."
31615 #: ../fish/guestfish-commands.pod:97
31616 msgid "For example to edit the first few sectors of a disk you might do:"
31621 #: ../fish/guestfish-commands.pod:100
31624 " hexedit /dev/sda 1M\n"
31630 #: ../fish/guestfish-commands.pod:102
31632 "which would allow you to edit anywhere within the first megabyte of the disk."
31637 #: ../fish/guestfish-commands.pod:105
31638 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31643 #: ../fish/guestfish-commands.pod:107
31646 " hexedit /dev/sda1 0x400 0x400\n"
31652 #: ../fish/guestfish-commands.pod:109
31653 msgid "(assuming the superblock is in the standard location)."
31658 #: ../fish/guestfish-commands.pod:111
31660 "This command requires the external L<hexedit(1)> program. You can specify "
31661 "another program to use by setting the C<HEXEDITOR> environment variable."
31666 #: ../fish/guestfish-commands.pod:115
31667 msgid "See also L</hexdump>."
31672 #: ../fish/guestfish-commands.pod:117
31678 #: ../fish/guestfish-commands.pod:119
31687 #: ../fish/guestfish-commands.pod:121
31689 "Change the local directory, ie. the current directory of guestfish itself."
31694 #: ../fish/guestfish-commands.pod:124
31695 msgid "Note that C<!cd> won't do what you might expect."
31700 #: ../fish/guestfish-commands.pod:126
31706 #: ../fish/guestfish-commands.pod:128
31712 #: ../fish/guestfish-commands.pod:130
31721 #: ../fish/guestfish-commands.pod:132
31722 msgid "Opens the manual page for guestfish."
31727 #: ../fish/guestfish-commands.pod:134
31733 #: ../fish/guestfish-commands.pod:136
31739 #: ../fish/guestfish-commands.pod:138
31748 #: ../fish/guestfish-commands.pod:140
31757 #: ../fish/guestfish-commands.pod:142
31758 msgid "This is used to view a file."
31763 #: ../fish/guestfish-commands.pod:144
31765 "The default viewer is C<$PAGER>. However if you use the alternate command "
31766 "C<less> you will get the C<less> command specifically."
31771 #: ../fish/guestfish-commands.pod:147
31777 #: ../fish/guestfish-commands.pod:149
31786 #: ../fish/guestfish-commands.pod:151
31788 "Close and reopen the libguestfs handle. It is not necessary to use this "
31789 "normally, because the handle is closed properly when guestfish exits. "
31790 "However this is occasionally useful for testing."
31795 #: ../fish/guestfish-commands.pod:155
31801 #: ../fish/guestfish-commands.pod:157
31804 " sparse filename size\n"
31810 #: ../fish/guestfish-commands.pod:159
31812 "This creates an empty sparse file of the given size, and then adds so it can "
31813 "be further examined."
31818 #: ../fish/guestfish-commands.pod:162
31820 "In all respects it works the same as the L</alloc> command, except that the "
31821 "image file is allocated sparsely, which means that disk blocks are not "
31822 "assigned to the file until they are needed. Sparse disk files only use "
31823 "space when written to, but they are slower and there is a danger you could "
31824 "run out of real disk space during a write operation."
31829 #: ../fish/guestfish-commands.pod:172
31835 #: ../fish/guestfish-commands.pod:174
31844 #: ../fish/guestfish-commands.pod:176
31846 "This command returns a list of the optional groups known to the daemon, and "
31847 "indicates which ones are supported by this build of the libguestfs appliance."
31852 #: ../fish/guestfish-commands.pod:180
31853 msgid "See also L<guestfs(3)/AVAILABILITY>."
31858 #: ../fish/guestfish-commands.pod:182
31864 #: ../fish/guestfish-commands.pod:184
31867 " time command args...\n"
31873 #: ../fish/guestfish-commands.pod:186
31875 "Run the command as usual, but print the elapsed time afterwards. This can "
31876 "be useful for benchmarking operations."
31881 #: ../test-tool/libguestfs-test-tool.pod:5
31882 msgid "libguestfs-test-tool - End user tests for libguestfs"
31887 #: ../test-tool/libguestfs-test-tool.pod:9
31890 " libguestfs-test-tool [--options]\n"
31896 #: ../test-tool/libguestfs-test-tool.pod:13
31898 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31899 "and developers, to allow them to check basic libguestfs functionality is "
31900 "working. This is needed because libguestfs occasionally breaks for reasons "
31901 "beyond our control: usually because of changes in the underlying qemu or "
31902 "kernel packages, or the host environment."
31907 #: ../test-tool/libguestfs-test-tool.pod:20
31908 msgid "If you suspect a problem in libguestfs, then just run:"
31913 #: ../test-tool/libguestfs-test-tool.pod:22
31916 " libguestfs-test-tool\n"
31922 #: ../test-tool/libguestfs-test-tool.pod:24
31923 msgid "It will print lots of diagnostic messages."
31928 #: ../test-tool/libguestfs-test-tool.pod:26
31929 msgid "If it runs to completion successfully, you will see this near the end:"
31934 #: ../test-tool/libguestfs-test-tool.pod:28
31937 " ===== TEST FINISHED OK =====\n"
31943 #: ../test-tool/libguestfs-test-tool.pod:30
31944 msgid "and the test tool will exit with code 0."
31949 #: ../test-tool/libguestfs-test-tool.pod:32
31951 "If it fails (and/or exits with non-zero error code), please paste the "
31952 "B<complete, unedited> output of the test tool into a bug report. More "
31953 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31959 #: ../test-tool/libguestfs-test-tool.pod:41
31965 #: ../test-tool/libguestfs-test-tool.pod:43
31966 msgid "Display short usage information and exit."
31971 #: ../test-tool/libguestfs-test-tool.pod:45
31972 msgid "I<--qemu qemu_binary>"
31977 #: ../test-tool/libguestfs-test-tool.pod:47
31979 "If you have downloaded another qemu binary, point this option at the full "
31980 "path of the binary to try it."
31985 #: ../test-tool/libguestfs-test-tool.pod:50
31986 msgid "I<--qemudir qemu_source_dir>"
31991 #: ../test-tool/libguestfs-test-tool.pod:52
31993 "If you have compiled qemu from source, point this option at the source "
31994 "directory to try it."
31999 #: ../test-tool/libguestfs-test-tool.pod:55
32000 msgid "I<--timeout N>"
32005 #: ../test-tool/libguestfs-test-tool.pod:57
32007 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32008 "does not usually need to be adjusted unless your machine is very slow."
32013 #: ../test-tool/libguestfs-test-tool.pod:63
32014 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32019 #: ../test-tool/libguestfs-test-tool.pod:65
32021 "If you have compiled another version of qemu from source and would like to "
32022 "try that, then you can use the I<--qemudir> option to point to the qemu "
32023 "source directory."
32028 #: ../test-tool/libguestfs-test-tool.pod:69
32030 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32031 "option to point to the binary."
32036 #: ../test-tool/libguestfs-test-tool.pod:72
32038 "When using an alternate qemu with libguestfs, usually you would need to "
32039 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32040 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32041 "use either of the I<--qemudir> or I<--qemu> options."
32046 #: ../test-tool/libguestfs-test-tool.pod:79
32048 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32049 "I<1> if there was an error."
32054 #: ../test-tool/libguestfs-test-tool.pod:84
32056 "For the full list of environment variables which may affect libguestfs, "
32057 "please see the L<guestfs(3)> manual page."
32062 #: ../test-tool/libguestfs-test-tool.pod:89
32063 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32068 #: ../fuse/guestmount.pod:5
32070 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32075 #: ../fuse/guestmount.pod:9
32078 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32084 #: ../fuse/guestmount.pod:11
32087 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32093 #: ../fuse/guestmount.pod:13
32096 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32102 #: ../fuse/guestmount.pod:17
32104 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32105 "machines. If you do this, you risk disk corruption in the VM."
32110 #: ../fuse/guestmount.pod:22
32112 "The guestmount program can be used to mount virtual machine filesystems and "
32113 "other disk images on the host. It uses libguestfs for access to the guest "
32114 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32115 "a mountable device."
32120 #: ../fuse/guestmount.pod:27
32122 "Along with other options, you have to give at least one device (I<-a> "
32123 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32124 "option) or use the I<-i> inspection option. How this works is better "
32125 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32131 #: ../fuse/guestmount.pod:33
32133 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32134 "by you, and the filesystem will not be visible to any other users unless you "
32135 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32136 "the filesystem, use the C<fusermount -u> command."
32141 #: ../fuse/guestmount.pod:41
32143 "For a typical Windows guest which has its main filesystem on the first "
32149 #: ../fuse/guestmount.pod:44
32152 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32158 #: ../fuse/guestmount.pod:46
32160 "For a typical Linux guest which has a /boot filesystem on the first "
32161 "partition, and the root filesystem on a logical volume:"
32166 #: ../fuse/guestmount.pod:49
32169 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32175 #: ../fuse/guestmount.pod:51
32176 msgid "To get libguestfs to detect guest mountpoints for you:"
32181 #: ../fuse/guestmount.pod:53
32184 " guestmount -a guest.img -i --ro /mnt\n"
32190 #: ../fuse/guestmount.pod:55
32191 msgid "For a libvirt guest called \"Guest\" you could do:"
32196 #: ../fuse/guestmount.pod:57
32199 " guestmount -d Guest -i --ro /mnt\n"
32205 #: ../fuse/guestmount.pod:59
32207 "If you don't know what filesystems are contained in a guest or disk image, "
32208 "use L<virt-filesystems(1)> first:"
32213 #: ../fuse/guestmount.pod:62
32216 " virt-filesystems MyGuest\n"
32222 #: ../fuse/guestmount.pod:64
32224 "If you want to trace the libguestfs calls but without excessive debugging "
32225 "information, we recommend:"
32230 #: ../fuse/guestmount.pod:67
32233 " guestmount [...] --trace /mnt\n"
32239 #: ../fuse/guestmount.pod:69
32240 msgid "If you want to debug the program, we recommend:"
32245 #: ../fuse/guestmount.pod:71
32248 " guestmount [...] --trace --verbose /mnt\n"
32253 #: ../fuse/guestmount.pod:73
32258 #: ../fuse/guestmount.pod:75
32259 msgid "Other users cannot see the filesystem by default"
32263 #: ../fuse/guestmount.pod:77
32265 "If you mount a filesystem as one user (eg. root), then other users will not "
32266 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32267 "option when mounting:"
32271 #: ../fuse/guestmount.pod:81
32274 " sudo guestmount [...] -o allow_other /mnt\n"
32280 #: ../fuse/guestmount.pod:87
32281 msgid "B<-a image> | B<--add image>"
32286 #: ../fuse/guestmount.pod:89
32287 msgid "Add a block device or virtual machine image."
32292 #: ../fuse/guestmount.pod:94
32293 msgid "B<-c URI> | B<--connect URI>"
32298 #: ../fuse/guestmount.pod:100
32299 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32304 #: ../fuse/guestmount.pod:106
32305 msgid "B<--dir-cache-timeout N>"
32310 #: ../fuse/guestmount.pod:108
32312 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32313 "seconds. The readdir cache [actually, there are several semi-independent "
32314 "caches] is populated after a readdir(2) call with the stat and extended "
32315 "attributes of the files in the directory, in anticipation that they will be "
32316 "requested soon after."
32321 #: ../fuse/guestmount.pod:114
32323 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32324 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32325 "requests, only cache existing ones."
32330 #: ../fuse/guestmount.pod:125
32331 msgid "B<--format=raw|qcow2|..> | B<--format>"
32336 #: ../fuse/guestmount.pod:132
32338 "If you have untrusted raw-format guest disk images, you should use this "
32339 "option to specify the disk format. This avoids a possible security problem "
32340 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32341 "guestfs_add_drive_opts>."
32346 #: ../fuse/guestmount.pod:137
32347 msgid "B<--fuse-help>"
32352 #: ../fuse/guestmount.pod:139
32353 msgid "Display help on special FUSE options (see I<-o> below)."
32358 #: ../fuse/guestmount.pod:143
32359 msgid "Display brief help and exit."
32364 #: ../fuse/guestmount.pod:145
32365 msgid "B<-i> | B<--inspector>"
32370 #: ../fuse/guestmount.pod:165
32372 "Mount the named partition or logical volume on the given mountpoint B<in the "
32373 "guest> (this has nothing to do with mountpoints in the host)."
32378 #: ../fuse/guestmount.pod:168
32380 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32381 "something on C</>."
32386 #: ../fuse/guestmount.pod:181
32387 msgid "B<-n> | B<--no-sync>"
32392 #: ../fuse/guestmount.pod:183
32394 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32395 "unmounted. If you specify this option, then we don't attempt to sync the "
32396 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32401 #: ../fuse/guestmount.pod:188
32402 msgid "B<-o option> | B<--option option>"
32407 #: ../fuse/guestmount.pod:190
32408 msgid "Pass extra options to FUSE."
32413 #: ../fuse/guestmount.pod:192
32415 "To get a list of all the extra options supported by FUSE, use the command "
32416 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32417 "of them are a good idea."
32422 #: ../fuse/guestmount.pod:196
32425 " guestmount --fuse-help\n"
32431 #: ../fuse/guestmount.pod:198
32432 msgid "Some potentially useful FUSE options:"
32437 #: ../fuse/guestmount.pod:202
32438 msgid "B<-o allow_other>"
32443 #: ../fuse/guestmount.pod:204
32444 msgid "Allow other users to see the filesystem."
32449 #: ../fuse/guestmount.pod:206
32450 msgid "B<-o attr_timeout=N>"
32455 #: ../fuse/guestmount.pod:208
32456 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32461 #: ../fuse/guestmount.pod:210
32462 msgid "B<-o kernel_cache>"
32467 #: ../fuse/guestmount.pod:212
32469 "Allow the kernel to cache files (reduces the number of reads that have to go "
32470 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32471 "afford the extra memory usage."
32476 #: ../fuse/guestmount.pod:216
32477 msgid "B<-o uid=N> B<-o gid=N>"
32482 #: ../fuse/guestmount.pod:218
32484 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32485 "the chosen values."
32490 #: ../fuse/guestmount.pod:223
32491 msgid "B<-r> | B<--ro>"
32496 #: ../fuse/guestmount.pod:225
32498 "Add devices and mount everything read-only. Also disallow writes and make "
32499 "the disk appear read-only to FUSE."
32504 #: ../fuse/guestmount.pod:228
32506 "This is highly recommended if you are not going to edit the guest disk. If "
32507 "the guest is running and this option is I<not> supplied, then there is a "
32508 "strong risk of disk corruption in the guest. We try to prevent this from "
32509 "happening, but it is not always possible."
32514 #: ../fuse/guestmount.pod:233
32515 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32520 #: ../fuse/guestmount.pod:237
32521 msgid "Enable SELinux support for the guest."
32526 #: ../fuse/guestmount.pod:239
32527 msgid "B<-v> | B<--verbose>"
32532 #: ../fuse/guestmount.pod:241
32533 msgid "Enable verbose messages from underlying libguestfs."
32538 #: ../fuse/guestmount.pod:243
32539 msgid "B<-V> | B<--version>"
32544 #: ../fuse/guestmount.pod:245
32545 msgid "Display the program version and exit."
32550 #: ../fuse/guestmount.pod:247
32551 msgid "B<-w> | B<--rw>"
32555 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
32556 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32561 #: ../fuse/guestmount.pod:254
32562 msgid "B<-x> | B<--trace>"
32567 #: ../fuse/guestmount.pod:256
32568 msgid "Trace libguestfs calls and entry into each FUSE function."
32573 #: ../fuse/guestmount.pod:258
32574 msgid "This also stops the daemon from forking into the background."
32579 #: ../fuse/guestmount.pod:279
32581 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32582 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32588 #: ../fuse/guestmount.pod:294
32589 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32594 #: ../tools/virt-edit.pl:34
32595 msgid "virt-edit - Edit a file in a virtual machine"
32600 #: ../tools/virt-edit.pl:38
32603 " virt-edit [--options] domname file\n"
32609 #: ../tools/virt-edit.pl:40
32612 " virt-edit [--options] disk.img [disk.img ...] file\n"
32618 #: ../tools/virt-edit.pl:42
32621 " virt-edit [domname|disk.img] file -e 'expr'\n"
32627 #: ../tools/virt-edit.pl:46
32629 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32630 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32631 "doing this, but doesn't catch all cases."
32636 #: ../tools/virt-edit.pl:52
32638 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32639 "the named virtual machine (or disk image)."
32643 #: ../tools/virt-edit.pl:55
32644 msgid "If you want to just view a file, use L<virt-cat(1)>."
32648 #: ../tools/virt-edit.pl:57
32650 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32651 "USING GUESTFISH> below)."
32655 #: ../tools/virt-edit.pl:60
32657 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32658 "files. L<guestfish(1)> can do that and much more."
32663 #: ../tools/virt-edit.pl:65
32664 msgid "Edit the named files interactively:"
32669 #: ../tools/virt-edit.pl:67
32672 " virt-edit mydomain /boot/grub/grub.conf\n"
32678 #: ../tools/virt-edit.pl:69
32681 " virt-edit mydomain /etc/passwd\n"
32686 #: ../tools/virt-edit.pl:71
32687 msgid "For Windows guests, some Windows paths are understood:"
32691 #: ../tools/virt-edit.pl:73
32694 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32700 #: ../tools/virt-edit.pl:75
32702 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32703 "below). To change the init default level to 5:"
32708 #: ../tools/virt-edit.pl:79
32711 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32717 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32718 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32719 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32720 msgid "Display brief help."
32725 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32726 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32727 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32728 msgid "Display version number and exit."
32733 #: ../tools/virt-edit.pl:105
32734 msgid "B<--backup extension> | B<-b extension>"
32739 #: ../tools/virt-edit.pl:107
32741 "Create a backup of the original file I<in the guest disk image>. The backup "
32742 "has the original filename with C<extension> added."
32747 #: ../tools/virt-edit.pl:110
32749 "Usually the first character of C<extension> would be a dot C<.> so you would "
32755 #: ../tools/virt-edit.pl:113
32758 " virt-edit -b .orig [etc]\n"
32764 #: ../tools/virt-edit.pl:115
32765 msgid "By default, no backup file is made."
32770 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32771 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32772 #: ../tools/virt-list-partitions.pl:78
32773 msgid "B<--connect URI> | B<-c URI>"
32778 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32779 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32780 #: ../tools/virt-list-partitions.pl:80
32782 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32783 "to the default libvirt hypervisor."
32788 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32789 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32790 #: ../tools/virt-list-partitions.pl:83
32792 "If you specify guest block devices directly, then libvirt is not used at all."
32797 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32798 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32799 #: ../tools/virt-list-partitions.pl:90
32800 msgid "B<--format> raw"
32805 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32806 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32807 #: ../tools/virt-list-partitions.pl:92
32809 "Specify the format of disk images given on the command line. If this is "
32810 "omitted then the format is autodetected from the content of the disk image."
32815 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32816 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32817 #: ../tools/virt-list-partitions.pl:96
32819 "If disk images are requested from libvirt, then this program asks libvirt "
32820 "for this information. In this case, the value of the format parameter is "
32826 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32827 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32828 #: ../tools/virt-list-partitions.pl:100
32830 "If working with untrusted raw-format guest disk images, you should ensure "
32831 "the format is always specified."
32836 #: ../tools/virt-edit.pl:150
32837 msgid "B<--expr EXPR> | B<-e EXPR>"
32842 #: ../tools/virt-edit.pl:152
32844 "Instead of launching the external editor, non-interactively apply the Perl "
32845 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32851 #: ../tools/virt-edit.pl:156
32853 "Be careful to properly quote the expression to prevent it from being altered "
32859 #: ../tools/virt-edit.pl:280
32860 msgid "NON-INTERACTIVE EDITING"
32865 #: ../tools/virt-edit.pl:282
32867 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32868 "administrator can interactively edit the file."
32873 #: ../tools/virt-edit.pl:285
32875 "There are two ways also to use C<virt-edit> from scripts in order to make "
32876 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32877 "like this, it's less error-prone to write scripts directly using the "
32878 "libguestfs API and Augeas for configuration file editing.)"
32883 #: ../tools/virt-edit.pl:291
32885 "The first method is to temporarily set C<$EDITOR> to any script or program "
32886 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32887 "update C<tmpfile> in place however it likes."
32891 #: ../tools/virt-edit.pl:295
32893 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
32894 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32895 "instances of C<foo> with C<bar> in a file:"
32900 #: ../tools/virt-edit.pl:299
32903 " virt-edit domname filename -e 's/foo/bar/'\n"
32909 #: ../tools/virt-edit.pl:301
32911 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32912 "For example to delete root's password you could do:"
32917 #: ../tools/virt-edit.pl:304
32920 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32926 #: ../tools/virt-edit.pl:306
32928 "What really happens is that the snippet is evaluated as a Perl expression "
32929 "for each line of the file. The line, including the final C<\\n>, is passed "
32930 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32935 #: ../tools/virt-edit.pl:311
32937 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32938 "C<apache> user account from the password file you can do:"
32943 #: ../tools/virt-edit.pl:314
32946 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32952 #: ../tools/virt-edit.pl:316
32954 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32955 "the end of the file is rather difficult this way since there is no concept "
32956 "of \"last line of the file\" - your expression just doesn't get called "
32957 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32963 #: ../tools/virt-edit.pl:322
32965 "The variable C<$lineno> contains the current line number. As is "
32966 "traditional, the first line in the file is number C<1>."
32971 #: ../tools/virt-edit.pl:325
32973 "The return value from the expression is ignored, but the expression may call "
32974 "C<die> in order to abort the whole program, leaving the original file "
32980 #: ../tools/virt-edit.pl:329
32982 "Remember when matching the end of a line that C<$_> may contain the final C<"
32983 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32984 "newline then neither of these. Thus to match or substitute some text at the "
32985 "end of a line, use this regular expression:"
32990 #: ../tools/virt-edit.pl:334
32993 " /some text(\\r?\\n)?$/\n"
32999 #: ../tools/virt-edit.pl:336
33001 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
33002 "$_> itself (since that would remove all newlines from the file):"
33007 #: ../tools/virt-edit.pl:340
33010 " my $m = $_; chomp $m; $m =~ /some text$/\n"
33015 #: ../tools/virt-edit.pl:344
33017 "C<virt-edit> has a limited ability to understand Windows drive letters and "
33018 "paths (eg. C<E:\\foo\\bar.txt>)."
33022 #: ../tools/virt-edit.pl:347
33023 msgid "If and only if the guest is running Windows then:"
33027 #: ../tools/virt-edit.pl:353
33029 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
33030 "to the correct filesystem."
33034 #: ../tools/virt-edit.pl:358
33036 "Any backslash (C<\\>) characters in the path are replaced with forward "
33037 "slashes so that libguestfs can process it."
33041 #: ../tools/virt-edit.pl:363
33043 "The path is resolved case insensitively to locate the file that should be "
33048 #: ../tools/virt-edit.pl:368
33049 msgid "There are some known shortcomings:"
33053 #: ../tools/virt-edit.pl:374
33054 msgid "Some NTFS symbolic links may not be followed correctly."
33058 #: ../tools/virt-edit.pl:378
33059 msgid "NTFS junction points that cross filesystems are not followed."
33063 #: ../tools/virt-edit.pl:435
33064 msgid "USING GUESTFISH"
33068 #: ../tools/virt-edit.pl:437
33070 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
33071 "C<virt-edit> doesn't work."
33075 #: ../tools/virt-edit.pl:440
33076 msgid "Using C<virt-edit> is approximately equivalent to doing:"
33080 #: ../tools/virt-edit.pl:442
33083 " guestfish --rw -i -d domname edit /file\n"
33088 #: ../tools/virt-edit.pl:444
33090 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
33091 "path to the file."
33095 #: ../tools/virt-edit.pl:447
33097 "The command above uses libguestfs's guest inspection feature and so does not "
33098 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
33099 "disk images that don't contain guests. To edit a file on a disk image "
33104 #: ../tools/virt-edit.pl:452
33107 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
33112 #: ../tools/virt-edit.pl:454
33114 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
33115 "the disk image to edit, and C</file> is the full path to the file."
33119 #: ../tools/virt-edit.pl:458
33121 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
33122 "C<write> or C<upload> instead:"
33126 #: ../tools/virt-edit.pl:461
33129 " guestfish --rw -i -d domname touch /newfile\n"
33134 #: ../tools/virt-edit.pl:463
33137 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
33142 #: ../tools/virt-edit.pl:465
33145 " guestfish --rw -i -d domname upload localfile /newfile\n"
33150 #: ../tools/virt-edit.pl:467
33152 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
33156 #: ../tools/virt-edit.pl:470
33159 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
33165 #: ../tools/virt-edit.pl:480
33171 #: ../tools/virt-edit.pl:482
33173 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33179 #: ../tools/virt-edit.pl:485
33180 msgid "If not set, C<vi> is used."
33185 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33186 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
33187 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
33188 msgid "SHELL QUOTING"
33193 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33194 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
33195 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
33197 "Libvirt guest names can contain arbitrary characters, some of which have "
33198 "meaning to the shell such as C<#> and space. You may need to quote or "
33199 "escape these characters on the command line. See the shell manual page L<sh"
33200 "(1)> for details."
33204 #: ../tools/virt-edit.pl:498
33206 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33207 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33208 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33213 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33214 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33215 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33221 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33222 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33223 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33224 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33228 #: ../tools/virt-edit.pl:516
33229 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33234 #: ../tools/virt-win-reg.pl:37
33236 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33241 #: ../tools/virt-win-reg.pl:41
33244 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33250 #: ../tools/virt-win-reg.pl:43
33253 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33259 #: ../tools/virt-win-reg.pl:45
33262 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33268 #: ../tools/virt-win-reg.pl:47
33271 " virt-win-reg --merge domname [input.reg ...]\n"
33277 #: ../tools/virt-win-reg.pl:49
33280 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33285 #: ../tools/virt-win-reg.pl:53
33287 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33288 "virtual machines. If you do this, you I<will> get irreversible disk "
33289 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33290 "but doesn't catch all cases."
33294 #: ../tools/virt-win-reg.pl:58
33296 "Modifying the Windows Registry is an inherently risky operation. The format "
33297 "is deliberately obscure and undocumented, and Registry changes can leave the "
33298 "system unbootable. Therefore when using the I<--merge> option, make sure "
33299 "you have a reliable backup first."
33304 #: ../tools/virt-win-reg.pl:65
33306 "This program can export and merge Windows Registry entries from a Windows "
33312 #: ../tools/virt-win-reg.pl:68
33314 "The first parameter is the libvirt guest name or the raw disk image of a "
33319 #: ../tools/virt-win-reg.pl:71
33321 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33322 "exported (recursively). For example:"
33327 #: ../tools/virt-win-reg.pl:74
33330 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33336 #: ../tools/virt-win-reg.pl:76
33338 "You can also display single values from within registry keys, for example:"
33343 #: ../tools/virt-win-reg.pl:79
33346 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33347 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33348 " Windows 7 Enterprise\n"
33353 #: ../tools/virt-win-reg.pl:83
33355 "With I<--merge>, you can merge a textual regedit file into the Windows "
33361 #: ../tools/virt-win-reg.pl:86
33364 " $ virt-win-reg --merge Windows7 changes.reg\n"
33370 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33376 #: ../tools/virt-win-reg.pl:90
33378 "This program is only meant for simple access to the registry. If you want "
33379 "to do complicated things with the registry, we suggest you download the "
33380 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33381 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33382 "L<hivexregedit(1)>."
33387 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33393 #: ../tools/virt-win-reg.pl:122
33394 msgid "Enable debugging messages."
33399 #: ../tools/virt-win-reg.pl:157
33405 #: ../tools/virt-win-reg.pl:159
33407 "In merge mode, this merges a textual regedit file into the Windows Registry "
33408 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33409 "displays or exports Registry entries instead."
33413 #: ../tools/virt-win-reg.pl:163
33415 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33416 "result in disk corruption. However exporting (without this flag) is always "
33422 #: ../tools/virt-win-reg.pl:171
33423 msgid "B<--encoding> UTF-16LE|ASCII"
33428 #: ../tools/virt-win-reg.pl:173
33430 "When merging (only), you may need to specify the encoding for strings to be "
33431 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33432 "(3)/ENCODING STRINGS>."
33437 #: ../tools/virt-win-reg.pl:177
33439 "The default is to use UTF-16LE, which should work with recent versions of "
33445 #: ../tools/virt-win-reg.pl:402
33446 msgid "SUPPORTED SYSTEMS"
33451 #: ../tools/virt-win-reg.pl:404
33453 "The program currently supports Windows NT-derived guests starting with "
33454 "Windows XP through to at least Windows 7."
33459 #: ../tools/virt-win-reg.pl:407
33461 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33462 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33463 "and C<HKEY_USERS\\.DEFAULT>."
33468 #: ../tools/virt-win-reg.pl:411
33470 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33476 #: ../tools/virt-win-reg.pl:414
33478 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33484 #: ../tools/virt-win-reg.pl:417
33490 #: ../tools/virt-win-reg.pl:419
33492 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33493 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33494 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33495 "Windows-style line endings, you may need to reencode the whole file before "
33496 "or after processing."
33500 #: ../tools/virt-win-reg.pl:425
33502 "To reencode a file from Windows format to Linux (before processing it with "
33503 "the I<--merge> option), you would do something like this:"
33508 #: ../tools/virt-win-reg.pl:428
33511 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33517 #: ../tools/virt-win-reg.pl:430
33519 "To go in the opposite direction, after exporting and before sending the file "
33520 "to a Windows user, do something like this:"
33525 #: ../tools/virt-win-reg.pl:433
33528 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33534 #: ../tools/virt-win-reg.pl:435
33535 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33540 #: ../tools/virt-win-reg.pl:437
33542 "If you are unsure about the current encoding, use the L<file(1)> command. "
33543 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33544 "style (CRLF) line endings, like this:"
33549 #: ../tools/virt-win-reg.pl:441
33552 " $ file software.reg\n"
33553 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33554 " with CRLF line terminators\n"
33559 #: ../tools/virt-win-reg.pl:445
33560 msgid "This file would need conversion before you could I<--merge> it."
33565 #: ../tools/virt-win-reg.pl:447
33566 msgid "CurrentControlSet etc."
33571 #: ../tools/virt-win-reg.pl:449
33573 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33574 "Registry at the level of the hive file, and therefore you cannot modify "
33580 #: ../tools/virt-win-reg.pl:453
33582 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33583 "circumstances it might refer to another control set. The way to find out is "
33584 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33589 #: ../tools/virt-win-reg.pl:457
33592 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33593 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33594 " \"Current\"=dword:00000001\n"
33595 " \"Default\"=dword:00000001\n"
33596 " \"Failed\"=dword:00000000\n"
33597 " \"LastKnownGood\"=dword:00000002\n"
33603 #: ../tools/virt-win-reg.pl:464
33604 msgid "\"Current\" is the one which Windows will choose when it boots."
33609 #: ../tools/virt-win-reg.pl:466
33611 "Similarly, other C<Current...> keys in the path may need to be replaced."
33616 #: ../tools/virt-win-reg.pl:469
33617 msgid "WINDOWS TIPS"
33622 #: ../tools/virt-win-reg.pl:471
33624 "Note that some of these tips modify the guest disk image. The guest I<must> "
33625 "be shut off, else you will get disk corruption."
33630 #: ../tools/virt-win-reg.pl:474
33631 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33636 #: ../tools/virt-win-reg.pl:476
33638 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33639 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33640 "is uploaded into C<C:\\>:"
33645 #: ../tools/virt-win-reg.pl:480
33648 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33654 #: ../tools/virt-win-reg.pl:482
33655 msgid "Prepare a regedit file containing the registry change:"
33660 #: ../tools/virt-win-reg.pl:484
33663 " cat > test.reg <<'EOF'\n"
33664 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33665 " \"Test\"=\"c:\\\\test.bat\"\n"
33672 #: ../tools/virt-win-reg.pl:489
33674 "In this example we use the key C<RunOnce> which means that the script will "
33675 "run precisely once when the first user logs in. If you want it to run every "
33676 "time a user logs in, replace C<RunOnce> with C<Run>."
33681 #: ../tools/virt-win-reg.pl:493
33682 msgid "Now update the registry:"
33687 #: ../tools/virt-win-reg.pl:495
33690 " virt-win-reg --merge WindowsGuest test.reg\n"
33696 #: ../tools/virt-win-reg.pl:497
33697 msgid "INSTALLING A SERVICE"
33702 #: ../tools/virt-win-reg.pl:499
33704 "This section assumes you are familiar with Windows services, and you either "
33705 "have a program which handles the Windows Service Control Protocol directly "
33706 "or you want to run any program using a service wrapper like SrvAny or the "
33712 #: ../tools/virt-win-reg.pl:504
33714 "First upload the program and optionally the service wrapper. In this case "
33715 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33720 #: ../tools/virt-win-reg.pl:508
33723 " guestfish -i -d WindowsGuest <<EOF\n"
33724 " upload rhsrvany.exe /rhsrvany.exe\n"
33725 " upload test.exe /test.exe\n"
33732 #: ../tools/virt-win-reg.pl:513
33734 "Prepare a regedit file containing the registry changes. In this example, "
33735 "the first registry change is needed for the service itself or the service "
33736 "wrapper (if used). The second registry change is only needed because I am "
33737 "using the RHSrvAny service wrapper."
33742 #: ../tools/virt-win-reg.pl:518
33745 " cat > service.reg <<'EOF'\n"
33746 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33747 " \"Type\"=dword:00000010\n"
33748 " \"Start\"=dword:00000002\n"
33749 " \"ErrorControl\"=dword:00000001\n"
33750 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33751 " \"DisplayName\"=\"RHSrvAny\"\n"
33752 " \"ObjectName\"=\"NetworkService\"\n"
33758 #: ../tools/virt-win-reg.pl:527
33761 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33762 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33763 " \"PWD\"=\"c:\\\\Temp\"\n"
33770 #: ../tools/virt-win-reg.pl:538
33772 "For use of C<ControlSet001> see the section above in this manual page. You "
33773 "may need to adjust this according to the control set that is in use by the "
33779 #: ../tools/virt-win-reg.pl:544
33781 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33782 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33783 "privileged account."
33788 #: ../tools/virt-win-reg.pl:550
33790 "For the meaning of the magic numbers, see this Microsoft KB article: "
33791 "L<http://support.microsoft.com/kb/103000>."
33796 #: ../tools/virt-win-reg.pl:555
33797 msgid "Update the registry:"
33802 #: ../tools/virt-win-reg.pl:557
33805 " virt-win-reg --merge WindowsGuest service.reg\n"
33811 #: ../tools/virt-win-reg.pl:561
33813 "Be careful when passing parameters containing C<\\> (backslash) in the "
33814 "shell. Usually you will have to use 'single quotes' or double backslashes "
33815 "(but not both) to protect them from the shell."
33820 #: ../tools/virt-win-reg.pl:565
33821 msgid "Paths and value names are case-insensitive."
33826 #: ../tools/virt-win-reg.pl:574
33828 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33829 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33830 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33835 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33837 "When reporting bugs, please enable debugging and capture the I<complete> "
33843 #: ../tools/virt-win-reg.pl:592
33846 " export LIBGUESTFS_DEBUG=1\n"
33847 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33853 #: ../tools/virt-win-reg.pl:595
33855 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33861 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33862 msgid "Copyright (C) 2010 Red Hat Inc."
33867 #: ../tools/virt-list-filesystems.pl:32
33869 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33874 #: ../tools/virt-list-filesystems.pl:36
33877 " virt-list-filesystems [--options] domname\n"
33883 #: ../tools/virt-list-filesystems.pl:38
33886 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33892 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33894 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33900 #: ../tools/virt-list-filesystems.pl:45
33902 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33903 "are contained in a virtual machine or disk image."
33908 #: ../tools/virt-list-filesystems.pl:49
33910 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33911 "functionality. For more complex cases you should look at the L<guestfish(1)"
33917 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33918 msgid "B<-l> | B<--long>"
33923 #: ../tools/virt-list-filesystems.pl:108
33925 "With this option, C<virt-list-filesystems> displays the type of each "
33926 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33931 #: ../tools/virt-list-filesystems.pl:115
33932 msgid "B<-a> | B<--all>"
33937 #: ../tools/virt-list-filesystems.pl:117
33939 "Normally we only show mountable filesystems. If this option is given then "
33940 "swap devices are shown too."
33945 #: ../tools/virt-list-filesystems.pl:191
33947 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33948 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33949 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33954 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33955 msgid "Copyright (C) 2009 Red Hat Inc."
33960 #: ../tools/virt-tar.pl:33
33961 msgid "virt-tar - Extract or upload files to a virtual machine"
33966 #: ../tools/virt-tar.pl:37
33969 " virt-tar [--options] -x domname directory tarball\n"
33975 #: ../tools/virt-tar.pl:39
33978 " virt-tar [--options] -u domname tarball directory\n"
33984 #: ../tools/virt-tar.pl:41
33987 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33993 #: ../tools/virt-tar.pl:43
33996 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34001 #: ../tools/virt-tar.pl:47
34003 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34004 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34009 #: ../tools/virt-tar.pl:52
34010 msgid "Download C</home> from the VM into a local tarball:"
34015 #: ../tools/virt-tar.pl:54
34018 " virt-tar -x domname /home home.tar\n"
34024 #: ../tools/virt-tar.pl:56
34027 " virt-tar -zx domname /home home.tar.gz\n"
34033 #: ../tools/virt-tar.pl:58
34034 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34039 #: ../tools/virt-tar.pl:60
34042 " virt-tar -u domname uploadstuff.tar /tmp\n"
34048 #: ../tools/virt-tar.pl:62
34051 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34056 #: ../tools/virt-tar.pl:66
34058 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34059 "virtual machines. If you do this, you risk disk corruption in the VM. "
34060 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34064 #: ../tools/virt-tar.pl:71
34066 "You can use I<-x> (extract) on live virtual machines, but you might get "
34067 "inconsistent results or errors if there is filesystem activity inside the "
34068 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34069 "work, but the only way to guarantee consistent results is if the virtual "
34070 "machine is shut down."
34075 #: ../tools/virt-tar.pl:79
34077 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34078 "parts of a guest filesystem. There are many possibilities: making backups, "
34079 "uploading data files, snooping on guest activity, fixing or customizing "
34085 #: ../tools/virt-tar.pl:84
34087 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34088 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34089 "should look at the L<guestfish(1)> tool."
34093 #: ../tools/virt-tar.pl:88
34095 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34096 "its contents (recursively) from the virtual machine into a local tarball. "
34097 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34098 "virtual machine. You cannot use these two options together."
34102 #: ../tools/virt-tar.pl:94
34104 "In addition, you may need to use the I<-z> (gZip) option to enable "
34105 "compression. When uploading, you have to specify I<-z> if the upload file "
34106 "is compressed because virt-tar won't detect this on its own."
34111 #: ../tools/virt-tar.pl:98
34113 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34114 "example it cannot do PKZip files or bzip2 compression. If you want that "
34115 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34116 "the L<libguestfs(3)> API)."
34121 #: ../tools/virt-tar.pl:156
34122 msgid "B<-x> | B<--extract> | B<--download>"
34127 #: ../tools/virt-tar.pl:158
34128 msgid "B<-u> | B<--upload>"
34132 #: ../tools/virt-tar.pl:160
34134 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34139 #: ../tools/virt-tar.pl:163
34141 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34142 "Please read the L</WARNING> section above before using this option."
34147 #: ../tools/virt-tar.pl:167
34148 msgid "You must specify exactly one of these options."
34153 #: ../tools/virt-tar.pl:173
34154 msgid "B<-z> | B<--gzip>"
34159 #: ../tools/virt-tar.pl:175
34160 msgid "Specify that the input or output tarball is gzip-compressed."
34164 #: ../tools/virt-tar.pl:288
34166 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34167 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34168 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34174 #: ../tools/virt-make-fs.pl:37
34175 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34180 #: ../tools/virt-make-fs.pl:41
34183 " virt-make-fs [--options] input.tar output.img\n"
34189 #: ../tools/virt-make-fs.pl:43
34192 " virt-make-fs [--options] input.tar.gz output.img\n"
34198 #: ../tools/virt-make-fs.pl:45
34201 " virt-make-fs [--options] directory output.img\n"
34207 #: ../tools/virt-make-fs.pl:49
34209 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34210 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34211 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34212 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34213 "you want to attach these filesystems to existing virtual machines (eg. to "
34214 "import large amounts of read-only data to a VM)."
34219 #: ../tools/virt-make-fs.pl:57
34220 msgid "Basic usage is:"
34225 #: ../tools/virt-make-fs.pl:59
34228 " virt-make-fs input output\n"
34234 #: ../tools/virt-make-fs.pl:61
34236 "where C<input> is either a directory containing files that you want to add, "
34237 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34238 "C<output> is a disk image. The input type is detected automatically. The "
34239 "output disk image defaults to a raw ext2 image unless you specify extra "
34240 "flags (see L</OPTIONS> below)."
34245 #: ../tools/virt-make-fs.pl:67
34246 msgid "EXTRA SPACE"
34250 #: ../tools/virt-make-fs.pl:69
34252 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34253 "the files that it contains, but might have extra space. Depending on how "
34254 "you are going to use the output, you might think this extra space is wasted "
34255 "and want to minimize it, or you might want to leave space so that more files "
34256 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34257 "but you can use the I<--size> flag to leave space in the filesystem if you "
34262 #: ../tools/virt-make-fs.pl:77
34264 "An alternative way to leave extra space but not make the output image any "
34265 "bigger is to use an alternative disk image format (instead of the default "
34266 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34267 "image format (check your hypervisor supports this before using it). This "
34268 "allows you to choose a large I<--size> but the extra space won't actually be "
34269 "allocated in the image until you try to store something in it."
34273 #: ../tools/virt-make-fs.pl:85
34275 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34276 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34277 "to build another image from scratch."
34282 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34283 #: ../tools/virt-make-fs.pl:142
34289 #: ../tools/virt-make-fs.pl:91
34292 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34298 #: ../tools/virt-make-fs.pl:93
34299 msgid "FILESYSTEM TYPE"
34304 #: ../tools/virt-make-fs.pl:95
34306 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34307 "libguestfs supports can be used (but I<not> read-only formats like "
34308 "ISO9660). Here are some of the more common choices:"
34313 #: ../tools/virt-make-fs.pl:101
34319 #: ../tools/virt-make-fs.pl:103
34321 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34322 "you are not going to use the filesystem in a way that requires the journal, "
34323 "then this is just wasted overhead."
34328 #: ../tools/virt-make-fs.pl:107
34329 msgid "I<ntfs> or I<vfat>"
34334 #: ../tools/virt-make-fs.pl:109
34335 msgid "Useful if exporting data to a Windows guest."
34340 #: ../tools/virt-make-fs.pl:111
34342 "I<Note for vfat>: The tar archive or local directory must only contain files "
34343 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34344 "program running within libguestfs is unable to change the ownership of non-"
34345 "root files, since vfat itself does not support this."
34350 #: ../tools/virt-make-fs.pl:116
34356 #: ../tools/virt-make-fs.pl:118
34358 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34359 "total filesystem size."
34364 #: ../tools/virt-make-fs.pl:125
34367 " virt-make-fs --type=minix input minixfs.img\n"
34373 #: ../tools/virt-make-fs.pl:127
34374 msgid "TO PARTITION OR NOT TO PARTITION"
34379 #: ../tools/virt-make-fs.pl:129
34380 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34385 #: ../tools/virt-make-fs.pl:131
34387 "Adding a partition can make the disk image more compatible with certain "
34388 "virtualized operating systems which don't expect to see a filesystem "
34389 "directly located on a block device (Linux doesn't care and will happily "
34390 "handle both types)."
34395 #: ../tools/virt-make-fs.pl:136
34397 "On the other hand, if you have a partition table then the output image is no "
34398 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34399 "directly on a partitioned disk image. (However libguestfs tools such as "
34400 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34405 #: ../tools/virt-make-fs.pl:144
34406 msgid "Add an MBR partition:"
34411 #: ../tools/virt-make-fs.pl:146
34414 " virt-make-fs --partition -- input disk.img\n"
34420 #: ../tools/virt-make-fs.pl:148
34422 "If the output disk image could be terabyte-sized or larger, it's better to "
34423 "use an EFI/GPT-compatible partition table:"
34428 #: ../tools/virt-make-fs.pl:151
34431 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34437 #: ../tools/virt-make-fs.pl:179
34438 msgid "Enable debugging information."
34443 #: ../tools/virt-make-fs.pl:185
34444 msgid "B<--size=E<lt>NE<gt>>"
34449 #: ../tools/virt-make-fs.pl:187
34450 msgid "B<--size=+E<lt>NE<gt>>"
34455 #: ../tools/virt-make-fs.pl:189
34456 msgid "B<-s E<lt>NE<gt>>"
34461 #: ../tools/virt-make-fs.pl:191
34462 msgid "B<-s +E<lt>NE<gt>>"
34466 #: ../tools/virt-make-fs.pl:193
34468 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34473 #: ../tools/virt-make-fs.pl:196
34475 "If this option is I<not> given, then the output image will be just large "
34476 "enough to contain all the files, with not much wasted space."
34481 #: ../tools/virt-make-fs.pl:199
34483 "To choose a fixed size output disk, specify an absolute number followed by b/"
34484 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34485 "Petabytes or Exabytes. This must be large enough to contain all the input "
34486 "files, else you will get an error."
34490 #: ../tools/virt-make-fs.pl:204
34492 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34493 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34494 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34495 "the input files, and (approximately) an extra 200 MB free space."
34500 #: ../tools/virt-make-fs.pl:210
34502 "Note that virt-make-fs estimates free space, and therefore will not produce "
34503 "filesystems containing precisely the free space requested. (It is much more "
34504 "expensive and time-consuming to produce a filesystem which has precisely the "
34505 "desired free space)."
34510 #: ../tools/virt-make-fs.pl:219
34511 msgid "B<--format=E<lt>fmtE<gt>>"
34516 #: ../tools/virt-make-fs.pl:221
34517 msgid "B<-F E<lt>fmtE<gt>>"
34522 #: ../tools/virt-make-fs.pl:223
34523 msgid "Choose the output disk image format."
34528 #: ../tools/virt-make-fs.pl:225
34529 msgid "The default is C<raw> (raw disk image)."
34534 #: ../tools/virt-make-fs.pl:227
34536 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34537 "that would really make sense here is C<qcow2>."
34542 #: ../tools/virt-make-fs.pl:234
34543 msgid "B<--type=E<lt>fsE<gt>>"
34548 #: ../tools/virt-make-fs.pl:236
34549 msgid "B<-t E<lt>fsE<gt>>"
34554 #: ../tools/virt-make-fs.pl:238
34555 msgid "Choose the output filesystem type."
34560 #: ../tools/virt-make-fs.pl:240
34561 msgid "The default is C<ext2>."
34566 #: ../tools/virt-make-fs.pl:242
34568 "Any filesystem which is supported read-write by libguestfs can be used here."
34573 #: ../tools/virt-make-fs.pl:249
34574 msgid "B<--partition>"
34579 #: ../tools/virt-make-fs.pl:251
34580 msgid "B<--partition=E<lt>parttypeE<gt>>"
34585 #: ../tools/virt-make-fs.pl:253
34587 "If specified, this flag adds an MBR partition table to the output disk image."
34591 #: ../tools/virt-make-fs.pl:256
34593 "You can change the partition table type, eg. I<--partition=gpt> for large "
34598 #: ../tools/virt-make-fs.pl:259
34600 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34601 "might consider the next parameter to be the partition type. For example:"
34606 #: ../tools/virt-make-fs.pl:263
34609 " virt-make-fs --partition input.tar ...\n"
34614 #: ../tools/virt-make-fs.pl:265
34616 "would cause virt-make-fs to think you wanted to use a partition type of "
34617 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34618 "dash) between options and the input file argument:"
34623 #: ../tools/virt-make-fs.pl:269
34626 " virt-make-fs --partition -- input.tar ...\n"
34631 #: ../tools/virt-make-fs.pl:541
34633 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34634 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34635 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34640 #: ../tools/virt-make-fs.pl:558
34643 " export LIBGUESTFS_DEBUG=1\n"
34644 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34650 #: ../tools/virt-make-fs.pl:561
34652 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34658 #: ../tools/virt-list-partitions.pl:32
34660 "virt-list-partitions - List partitions in a virtual machine or disk image"
34665 #: ../tools/virt-list-partitions.pl:36
34668 " virt-list-partitions [--options] domname\n"
34674 #: ../tools/virt-list-partitions.pl:38
34677 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34683 #: ../tools/virt-list-partitions.pl:45
34685 "C<virt-list-partitions> is a command line tool to list the partitions that "
34686 "are contained in a virtual machine or disk image. It is mainly useful as a "
34687 "first step to using L<virt-resize(1)>."
34692 #: ../tools/virt-list-partitions.pl:50
34694 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34695 "functionality. For more complex cases you should look at the L<guestfish(1)"
34701 #: ../tools/virt-list-partitions.pl:107
34702 msgid "B<-h> | B<--human-readable>"
34707 #: ../tools/virt-list-partitions.pl:109
34708 msgid "Show sizes in human-readable form (eg. \"1G\")."
34713 #: ../tools/virt-list-partitions.pl:117
34715 "With this option, C<virt-list-partitions> displays the type and size of each "
34716 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34721 #: ../tools/virt-list-partitions.pl:124
34722 msgid "B<-t> | B<--total>"
34727 #: ../tools/virt-list-partitions.pl:126
34729 "Display the total size of each block device (as a separate row or rows)."
34734 #: ../tools/virt-list-partitions.pl:259
34736 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34737 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34738 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34743 #: ../tools/virt-list-partitions.pl:275
34744 msgid "Copyright (C) 2009-2010 Red Hat Inc."