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-08-17 13:55+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
25 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
37 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
38 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
39 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
40 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
41 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
56 #: ../src/guestfs.pod:11
59 " guestfs_h *g = guestfs_create ();\n"
60 " guestfs_add_drive (g, \"guest.img\");\n"
61 " guestfs_launch (g);\n"
62 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
63 " guestfs_touch (g, \"/hello\");\n"
64 " guestfs_umount (g, \"/\");\n"
65 " guestfs_close (g);\n"
71 #: ../src/guestfs.pod:19
74 " cc prog.c -o prog -lguestfs\n"
76 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
82 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
83 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
84 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
85 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
86 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
92 #: ../src/guestfs.pod:25
94 "Libguestfs is a library for accessing and modifying guest disk images. "
95 "Amongst the things this is good for: making batch configuration changes to "
96 "guests, getting disk used/free statistics (see also: virt-df), migrating "
97 "between virtualization systems (see also: virt-p2v), performing partial "
98 "backups, performing partial guest clones, cloning guests and changing "
99 "registry/UUID/hostname info, and much else besides."
104 #: ../src/guestfs.pod:33
106 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
107 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
108 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
114 #: ../src/guestfs.pod:38
116 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
117 "what filesystem is in each LV, etc.). It can also run commands in the "
118 "context of the guest. Also you can access filesystems over FUSE."
123 #: ../src/guestfs.pod:43
125 "Libguestfs is a library that can be linked with C and C++ management "
126 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
127 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
133 #: ../src/guestfs.pod:48
135 "You don't need to be root to use libguestfs, although obviously you do need "
136 "enough permissions to access the disk images."
141 #: ../src/guestfs.pod:51
143 "Libguestfs is a large API because it can do many things. For a gentle "
144 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:54
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
157 #: ../src/guestfs.pod:57
163 #: ../src/guestfs.pod:59
165 "This section provides a gentler overview of the libguestfs API. We also try "
166 "to group API calls together, where that may not be obvious from reading "
167 "about the individual calls in the main section of this manual."
172 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
189 #: ../src/guestfs.pod:73
190 msgid "The general structure of all libguestfs-using programs looks like this:"
195 #: ../src/guestfs.pod:76
198 " guestfs_h *g = guestfs_create ();\n"
204 #: ../src/guestfs.pod:78
207 " /* Call guestfs_add_drive additional times if there are\n"
208 " * multiple disk images.\n"
210 " guestfs_add_drive (g, \"guest.img\");\n"
216 #: ../src/guestfs.pod:83
219 " /* Most manipulation calls won't work until you've launched\n"
220 " * the handle 'g'. You have to do this _after_ adding drives\n"
221 " * and _before_ other commands.\n"
223 " guestfs_launch (g);\n"
229 #: ../src/guestfs.pod:89
232 " /* Now you can examine what partitions, LVs etc are available.\n"
234 " char **partitions = guestfs_list_partitions (g);\n"
235 " char **logvols = guestfs_lvs (g);\n"
241 #: ../src/guestfs.pod:94
244 " /* To access a filesystem in the image, you must mount it.\n"
246 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 " /* Now you can perform filesystem actions on the guest\n"
257 " guestfs_touch (g, \"/hello\");\n"
263 #: ../src/guestfs.pod:103
266 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
267 " * it is done automatically when you close the handle. See\n"
268 " * discussion of autosync in this page.\n"
270 " guestfs_sync (g);\n"
276 #: ../src/guestfs.pod:109
279 " /* Close the handle 'g'. */\n"
280 " guestfs_close (g);\n"
286 #: ../src/guestfs.pod:112
288 "The code above doesn't include any error checking. In real code you should "
289 "check return values carefully for errors. In general all functions that "
290 "return integers return C<-1> on error, and all functions that return "
291 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
292 "how to handle errors, and consult the documentation for each function call "
293 "below to see precisely how they return error indications. See L<guestfs-"
294 "examples(3)> for fully worked examples."
299 #: ../src/guestfs.pod:121
305 #: ../src/guestfs.pod:123
307 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
308 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
309 "actual block device, or simply an empty file of zeroes that you have created "
310 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
316 #: ../src/guestfs.pod:129
318 "The call you should use in modern code for adding drives is L</"
319 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
320 "specifying that the format is raw, do:"
325 #: ../src/guestfs.pod:133
328 " guestfs_add_drive_opts (g, filename,\n"
329 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
336 #: ../src/guestfs.pod:137
337 msgid "You can add a disk read-only using:"
342 #: ../src/guestfs.pod:139
345 " guestfs_add_drive_opts (g, filename,\n"
346 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
347 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
354 #: ../src/guestfs.pod:144
356 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
357 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
371 #: ../src/guestfs.pod:151
373 "You must add at least one disk image, and you may add multiple disk images. "
374 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
375 "first one you added), C</dev/sdb> (for the second one you added), etc."
380 #: ../src/guestfs.pod:156
382 "Once L</guestfs_launch> has been called you cannot add any more images. You "
383 "can call L</guestfs_list_devices> to get a list of the device names, in the "
384 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
389 #: ../src/guestfs.pod:161
394 #: ../src/guestfs.pod:163
396 "Before you can read or write files, create directories and so on in a disk "
397 "image that contains filesystems, you have to mount those filesystems using "
398 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
399 "a disk image contains (for example) one partition with a filesystem on that "
400 "partition, then you can mount it directly:"
404 #: ../src/guestfs.pod:170
407 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
412 #: ../src/guestfs.pod:172
414 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
415 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
416 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
417 "that these are libguestfs virtual devices, and are nothing to do with host "
422 #: ../src/guestfs.pod:178
424 "If you are given a disk image and you don't know what it contains then you "
425 "have to find out. Libguestfs can do that too: use L</"
426 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
427 "LVs, and either try mounting each to see what is mountable, or else examine "
428 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
429 "filesystems, use L</guestfs_list_filesystems>."
433 #: ../src/guestfs.pod:186
435 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
436 "L</INSPECTION> below). But you might find it easier to look at higher level "
437 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
441 #: ../src/guestfs.pod:191
443 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
444 "several other variations of the C<guestfs_mount_*> call."
449 #: ../src/guestfs.pod:194
450 msgid "FILESYSTEM ACCESS AND MODIFICATION"
455 #: ../src/guestfs.pod:196
457 "The majority of the libguestfs API consists of fairly low-level calls for "
458 "accessing and modifying the files, directories, symlinks etc on mounted "
459 "filesystems. There are over a hundred such calls which you can find listed "
460 "in detail below in this man page, and we don't even pretend to cover them "
461 "all in this overview."
466 #: ../src/guestfs.pod:202
468 "Specify filenames as full paths, starting with C<\"/\"> and including the "
474 #: ../src/guestfs.pod:205
476 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
477 "the file called C<\"etc/passwd\"> then you could do:"
482 #: ../src/guestfs.pod:208
485 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
491 #: ../src/guestfs.pod:210
493 "This would return C<data> as a newly allocated buffer containing the full "
494 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
495 "or C<NULL> if there was an error."
500 #: ../src/guestfs.pod:214
502 "As another example, to create a top-level directory on that filesystem "
503 "called C<\"var\"> you would do:"
508 #: ../src/guestfs.pod:217
511 " guestfs_mkdir (g, \"/var\");\n"
517 #: ../src/guestfs.pod:219
518 msgid "To create a symlink you could do:"
523 #: ../src/guestfs.pod:221
526 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
527 " \"/etc/rc3.d/S30portmap\");\n"
533 #: ../src/guestfs.pod:224
535 "Libguestfs will reject attempts to use relative paths and there is no "
536 "concept of a current working directory."
541 #: ../src/guestfs.pod:227
543 "Libguestfs can return errors in many situations: for example if the "
544 "filesystem isn't writable, or if a file or directory that you requested "
545 "doesn't exist. If you are using the C API (documented here) you have to "
546 "check for those error conditions after each call. (Other language bindings "
547 "turn these errors into exceptions)."
552 #: ../src/guestfs.pod:233
554 "File writes are affected by the per-handle umask, set by calling L</"
555 "guestfs_umask> and defaulting to 022. See L</UMASK>."
560 #: ../src/guestfs.pod:236
566 #: ../src/guestfs.pod:238
568 "Libguestfs contains API calls to read, create and modify partition tables on "
574 #: ../src/guestfs.pod:241
576 "In the common case where you want to create a single partition covering the "
577 "whole disk, you should use the L</guestfs_part_disk> call:"
582 #: ../src/guestfs.pod:245
585 " const char *parttype = \"mbr\";\n"
586 " if (disk_is_larger_than_2TB)\n"
587 " parttype = \"gpt\";\n"
588 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
594 #: ../src/guestfs.pod:250
596 "Obviously this effectively wipes anything that was on that disk image before."
601 #: ../src/guestfs.pod:253
607 #: ../src/guestfs.pod:255
609 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
610 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
611 "you familiarize yourself with the concepts of physical volumes, volume "
612 "groups and logical volumes."
617 #: ../src/guestfs.pod:260
619 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
620 "tldp.org/HOWTO/LVM-HOWTO/>."
625 #: ../src/guestfs.pod:263
630 #: ../src/guestfs.pod:265
632 "Use L</guestfs_cat> to download small, text only files. This call is "
633 "limited to files which are less than 2 MB and which cannot contain any ASCII "
634 "NUL (C<\\0>) characters. However the API is very simple to use."
639 #: ../src/guestfs.pod:269
641 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
642 "bit data, since it returns a (pointer, size) pair. However it is still "
643 "limited to \"small\" files, less than 2 MB."
648 #: ../src/guestfs.pod:273
650 "L</guestfs_download> can be used to download any file, with no limits on "
651 "content or size (even files larger than 4 GB)."
656 #: ../src/guestfs.pod:276
658 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
663 #: ../src/guestfs.pod:279
669 #: ../src/guestfs.pod:281
671 "It's often the case that you want to write a file or files to the disk image."
676 #: ../src/guestfs.pod:284
678 "To write a small file with fixed content, use L</guestfs_write>. To create "
679 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
680 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
681 "of other functions for creating test files, for example L</guestfs_fill> and "
682 "L</guestfs_fill_pattern>."
687 #: ../src/guestfs.pod:290
689 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
690 "file content or size (even files larger than 4 GB)."
695 #: ../src/guestfs.pod:293
697 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
702 #: ../src/guestfs.pod:295
704 "However the fastest way to upload I<large numbers of arbitrary files> is to "
705 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
706 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
707 "in a predictable way (eg. adding it last after all other drives) then you "
708 "can get the device name from L</guestfs_list_devices> and mount it directly "
709 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
710 "portable between kernel versions, and they don't support labels or UUIDs. "
711 "If you want to pre-build an image or you need to mount it using a label or "
712 "UUID, use an ISO image instead."
717 #: ../src/guestfs.pod:306
723 #: ../src/guestfs.pod:308
725 "There are various different commands for copying between files and devices "
726 "and in and out of the guest filesystem. These are summarised in the table "
732 #: ../src/guestfs.pod:314
733 msgid "B<file> to B<file>"
738 #: ../src/guestfs.pod:316
740 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
741 "directories recursively."
746 #: ../src/guestfs.pod:319
747 msgid "B<file or device> to B<file or device>"
752 #: ../src/guestfs.pod:321
754 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
755 "devices in the guest."
760 #: ../src/guestfs.pod:324
761 msgid "Example: duplicate the contents of an LV:"
766 #: ../src/guestfs.pod:326
769 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
775 #: ../src/guestfs.pod:328
777 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
778 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
779 "guestfs_copy_size>."
784 #: ../src/guestfs.pod:332
785 msgid "B<file on the host> to B<file or device>"
790 #: ../src/guestfs.pod:334
791 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
796 #: ../src/guestfs.pod:336
797 msgid "B<file or device> to B<file on the host>"
802 #: ../src/guestfs.pod:338
803 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
808 #: ../src/guestfs.pod:342
809 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
814 #: ../src/guestfs.pod:344
816 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
817 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
818 "appears you can only upload and download to files. However many Un*x-like "
819 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
820 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
821 "and arbitrary file descriptor N."
826 #: ../src/guestfs.pod:352
827 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
831 #: ../src/guestfs.pod:355
834 " guestfs_download (g, filename, \"/dev/stdout\");\n"
839 #: ../src/guestfs.pod:357
840 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
844 #: ../src/guestfs.pod:359
848 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
849 " guestfs_tar_out (g, \"/\", devfd);\n"
855 #: ../src/guestfs.pod:363
856 msgid "LISTING FILES"
861 #: ../src/guestfs.pod:365
863 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
864 "L<guestfish(1)>-equivalent command C<ll>)."
869 #: ../src/guestfs.pod:368
871 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
872 "programs, as a flat list of strings."
877 #: ../src/guestfs.pod:371
879 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
880 "directory, plus additional information about each one. It is more "
881 "equivalent to using the L<readdir(3)> call on a local filesystem."
886 #: ../src/guestfs.pod:375
888 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
893 #: ../src/guestfs.pod:378
894 msgid "RUNNING COMMANDS"
899 #: ../src/guestfs.pod:380
901 "Although libguestfs is primarily an API for manipulating files inside guest "
902 "images, we also provide some limited facilities for running commands inside "
908 #: ../src/guestfs.pod:384
909 msgid "There are many limitations to this:"
914 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
915 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
916 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
917 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
918 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
919 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
920 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
921 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
922 #: ../src/guestfs.pod:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762
923 #: ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
924 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380
925 #: ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397
926 #: ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976
927 #: ../src/guestfs.pod:2980 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:582
929 #: ../src/guestfs-actions.pod:590 ../src/guestfs-actions.pod:597
930 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1602
931 #: ../src/guestfs-actions.pod:1606 ../src/guestfs-actions.pod:1610
932 #: ../src/guestfs-actions.pod:1614 ../src/guestfs-actions.pod:1622
933 #: ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630
934 #: ../src/guestfs-actions.pod:1640 ../src/guestfs-actions.pod:1644
935 #: ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1786
936 #: ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1795
937 #: ../src/guestfs-actions.pod:1800 ../src/guestfs-actions.pod:1861
938 #: ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1870
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:385 ../fish/guestfish-actions.pod:393
943 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
944 #: ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1078
945 #: ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086
946 #: ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098
947 #: ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112
948 #: ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120
949 #: ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214
950 #: ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224
951 #: ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270
952 #: ../fish/guestfish-actions.pod:1275 ../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"
3207 #: ../src/guestfs.pod:1454
3210 " typedef void (*guestfs_abort_cb) (void);\n"
3211 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3212 " guestfs_abort_cb);\n"
3218 #: ../src/guestfs.pod:1458
3220 "The callback C<cb> will be called if there is an out of memory situation. "
3221 "I<Note this callback must not return>."
3226 #: ../src/guestfs.pod:1461
3227 msgid "The default is to call L<abort(3)>."
3232 #: ../src/guestfs.pod:1463
3234 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3239 #: ../src/guestfs.pod:1466
3240 msgid "guestfs_get_out_of_memory_handler"
3245 #: ../src/guestfs.pod:1468
3248 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3254 #: ../src/guestfs.pod:1470
3255 msgid "This returns the current out of memory handler."
3260 #: ../src/guestfs.pod:1472
3266 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1019
3272 #: ../src/guestfs.pod:1476
3278 #: ../src/guestfs.pod:1478
3284 #: ../src/guestfs.pod:1480
3285 msgid "AVAILABILITY"
3290 #: ../src/guestfs.pod:1482
3291 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3296 #: ../src/guestfs.pod:1484
3298 "Using L</guestfs_available> you can test availability of the following "
3299 "groups of functions. This test queries the appliance to see if the "
3300 "appliance you are currently using supports the functionality."
3305 #: ../src/guestfs.pod:1489
3306 msgid "@AVAILABILITY@"
3311 #: ../src/guestfs.pod:1491
3312 msgid "GUESTFISH supported COMMAND"
3317 #: ../src/guestfs.pod:1493
3319 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3320 "prints out the available groups and whether they are supported by this build "
3321 "of libguestfs. Note however that you have to do C<run> first."
3326 #: ../src/guestfs.pod:1498
3327 msgid "SINGLE CALLS AT COMPILE TIME"
3332 #: ../src/guestfs.pod:1500
3334 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3335 "function, such as:"
3340 #: ../src/guestfs.pod:1503
3343 " #define LIBGUESTFS_HAVE_DD 1\n"
3349 #: ../src/guestfs.pod:1505
3350 msgid "if L</guestfs_dd> is available."
3355 #: ../src/guestfs.pod:1507
3357 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3358 "function is available at compile time, we recommended using build tools such "
3359 "as autoconf or cmake. For example in autotools you could use:"
3364 #: ../src/guestfs.pod:1512
3367 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3368 " AC_CHECK_FUNCS([guestfs_dd])\n"
3374 #: ../src/guestfs.pod:1515
3376 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3382 #: ../src/guestfs.pod:1518
3383 msgid "SINGLE CALLS AT RUN TIME"
3388 #: ../src/guestfs.pod:1520
3390 "Testing at compile time doesn't guarantee that a function really exists in "
3391 "the library. The reason is that you might be dynamically linked against a "
3392 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3393 "This situation unfortunately results in a segmentation fault, which is a "
3394 "shortcoming of the C dynamic linking system itself."
3399 #: ../src/guestfs.pod:1527
3401 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3402 "in this example program (note that you still need the compile time check as "
3408 #: ../src/guestfs.pod:1531
3411 " #include <stdio.h>\n"
3412 " #include <stdlib.h>\n"
3413 " #include <unistd.h>\n"
3414 " #include <dlfcn.h>\n"
3415 " #include <guestfs.h>\n"
3421 #: ../src/guestfs.pod:1537
3426 " #ifdef LIBGUESTFS_HAVE_DD\n"
3428 " int has_function;\n"
3434 #: ../src/guestfs.pod:1543
3437 " /* Test if the function guestfs_dd is really available. */\n"
3438 " dl = dlopen (NULL, RTLD_LAZY);\n"
3440 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3441 " exit (EXIT_FAILURE);\n"
3443 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3450 #: ../src/guestfs.pod:1552
3453 " if (!has_function)\n"
3454 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3456 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3457 " /* Now it's safe to call\n"
3458 " guestfs_dd (g, \"foo\", \"bar\");\n"
3462 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3470 #: ../src/guestfs.pod:1565
3472 "You may think the above is an awful lot of hassle, and it is. There are "
3473 "other ways outside of the C linking system to ensure that this kind of "
3474 "incompatibility never arises, such as using package versioning:"
3479 #: ../src/guestfs.pod:1570
3482 " Requires: libguestfs >= 1.0.80\n"
3488 #: ../src/guestfs.pod:1572
3489 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3494 #: ../src/guestfs.pod:1574
3496 "A recent feature of the API is the introduction of calls which take optional "
3497 "arguments. In C these are declared 3 ways. The main way is as a call which "
3498 "takes variable arguments (ie. C<...>), as in this example:"
3503 #: ../src/guestfs.pod:1579
3506 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3512 #: ../src/guestfs.pod:1581
3514 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3515 "call with no optional arguments specified:"
3520 #: ../src/guestfs.pod:1584
3523 " guestfs_add_drive_opts (g, filename, -1);\n"
3529 #: ../src/guestfs.pod:1586
3530 msgid "With a single optional argument:"
3535 #: ../src/guestfs.pod:1588
3538 " guestfs_add_drive_opts (g, filename,\n"
3539 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3546 #: ../src/guestfs.pod:1592
3552 #: ../src/guestfs.pod:1594
3555 " guestfs_add_drive_opts (g, filename,\n"
3556 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3557 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3564 #: ../src/guestfs.pod:1599
3566 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3572 #: ../src/guestfs.pod:1602
3573 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3578 #: ../src/guestfs.pod:1604
3580 "The second variant has the same name with the suffix C<_va>, which works the "
3581 "same way but takes a C<va_list>. See the C manual for details. For the "
3582 "example function, this is declared:"
3587 #: ../src/guestfs.pod:1608
3590 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3597 #: ../src/guestfs.pod:1611
3598 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3603 #: ../src/guestfs.pod:1613
3605 "The third variant is useful where you need to construct these calls. You "
3606 "pass in a structure where you fill in the optional fields. The structure "
3607 "has a bitmask as the first element which you must set to indicate which "
3608 "fields you have filled in. For our example function the structure and call "
3614 #: ../src/guestfs.pod:1619
3617 " struct guestfs_add_drive_opts_argv {\n"
3618 " uint64_t bitmask;\n"
3620 " const char *format;\n"
3623 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3624 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3630 #: ../src/guestfs.pod:1628
3631 msgid "You could call it like this:"
3636 #: ../src/guestfs.pod:1630
3639 " struct guestfs_add_drive_opts_argv optargs = {\n"
3640 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3641 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3643 " .format = \"qcow2\"\n"
3650 #: ../src/guestfs.pod:1637
3653 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3659 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3660 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:9
3661 #: ../fish/guestfish-actions.pod:1262 ../tools/virt-win-reg.pl:532
3667 #: ../src/guestfs.pod:1645
3668 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3673 #: ../src/guestfs.pod:1650
3674 msgid "You do not need to fill in all fields of the structure."
3679 #: ../src/guestfs.pod:1654
3681 "There must be a one-to-one correspondence between fields of the structure "
3682 "that are filled in, and bits set in the bitmask."
3687 #: ../src/guestfs.pod:1659
3688 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3693 #: ../src/guestfs.pod:1661
3695 "In other languages, optional arguments are expressed in the way that is "
3696 "natural for that language. We refer you to the language-specific "
3697 "documentation for more details on that."
3702 #: ../src/guestfs.pod:1665
3703 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3708 #: ../src/guestfs.pod:1667
3709 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3713 #: ../src/guestfs.pod:1669
3715 "B<Note:> This section documents the generic event mechanism introduced in "
3716 "libguestfs 1.10, which you should use in new code if possible. The old "
3717 "functions C<guestfs_set_log_message_callback>, "
3718 "C<guestfs_set_subprocess_quit_callback>, "
3719 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3720 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3725 #: ../src/guestfs.pod:1677
3727 "Handles generate events when certain things happen, such as log messages "
3728 "being generated, progress messages during long-running operations, or the "
3729 "handle being closed. The API calls described below let you register a "
3730 "callback to be called when events happen. You can register multiple "
3731 "callbacks (for the same, different or overlapping sets of events), and "
3732 "individually remove callbacks. If callbacks are not removed, then they "
3733 "remain in force until the handle is closed."
3737 #: ../src/guestfs.pod:1685
3739 "In the current implementation, events are only generated synchronously: that "
3740 "means that events (and hence callbacks) can only happen while you are in the "
3741 "middle of making another libguestfs call. The callback is called in the "
3746 #: ../src/guestfs.pod:1690
3748 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3749 "unsigned integers, or a message buffer. Payloads are discussed later on."
3753 #: ../src/guestfs.pod:1694
3754 msgid "CLASSES OF EVENTS"
3758 #: ../src/guestfs.pod:1698
3759 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3763 #: ../src/guestfs.pod:1701
3765 "The callback function will be called while the handle is being closed "
3766 "(synchronously from L</guestfs_close>)."
3771 #: ../src/guestfs.pod:1704
3773 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3774 "handles that are open when the program exits. This means that this callback "
3775 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3776 "problems in higher-level languages (eg. if your HLL interpreter has already "
3777 "been cleaned up by the time this is called, and if your callback then jumps "
3778 "into some HLL function)."
3782 #: ../src/guestfs.pod:1711
3784 "If no callback is registered: the handle is closed without any callback "
3789 #: ../src/guestfs.pod:1714
3790 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3794 #: ../src/guestfs.pod:1717
3796 "The callback function will be called when the child process quits, either "
3797 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3798 "corresponds to a transition from any state to the CONFIG state)."
3802 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3803 msgid "If no callback is registered: the event is ignored."
3807 #: ../src/guestfs.pod:1723
3808 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3812 #: ../src/guestfs.pod:1726
3814 "The callback function will be called when the child process becomes ready "
3815 "first time after it has been launched. (This corresponds to a transition "
3816 "from LAUNCHING to the READY state)."
3820 #: ../src/guestfs.pod:1732
3821 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3826 #: ../src/guestfs.pod:1735
3828 "Some long-running operations can generate progress messages. If this "
3829 "callback is registered, then it will be called each time a progress message "
3830 "is generated (usually two seconds after the operation started, and three "
3831 "times per second thereafter until it completes, although the frequency may "
3832 "change in future versions)."
3836 #: ../src/guestfs.pod:1741
3838 "The callback receives in the payload four unsigned 64 bit numbers which are "
3839 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3843 #: ../src/guestfs.pod:1744
3845 "The units of C<total> are not defined, although for some operations C<total> "
3846 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3847 "or megabytes), and C<position> may be the portion which has been transferred."
3852 #: ../src/guestfs.pod:1749
3853 msgid "The only defined and stable parts of the API are:"
3858 #: ../src/guestfs.pod:1755
3860 "The callback can display to the user some type of progress bar or indicator "
3861 "which shows the ratio of C<position>:C<total>."
3866 #: ../src/guestfs.pod:1760
3867 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3871 #: ../src/guestfs.pod:1764
3873 "If any progress notification is sent during a call, then a final progress "
3874 "notification is always sent when C<position> = C<total> (I<unless> the call "
3875 "fails with an error)."
3880 #: ../src/guestfs.pod:1768
3882 "This is to simplify caller code, so callers can easily set the progress "
3883 "indicator to \"100%\" at the end of the operation, without requiring special "
3884 "code to detect this case."
3888 #: ../src/guestfs.pod:1774
3890 "For some calls we are unable to estimate the progress of the call, but we "
3891 "can still generate progress messages to indicate activity. This is known as "
3892 "\"pulse mode\", and is directly supported by certain progress bar "
3893 "implementations (eg. GtkProgressBar)."
3897 #: ../src/guestfs.pod:1779
3899 "For these calls, zero or more progress messages are generated with "
3900 "C<position = 0> and C<total = 1>, followed by a final message with "
3901 "C<position = total = 1>."
3905 #: ../src/guestfs.pod:1783
3907 "As noted above, if the call fails with an error then the final message may "
3912 #: ../src/guestfs.pod:1788
3914 "The callback also receives the procedure number (C<proc_nr>) and serial "
3915 "number (C<serial>) of the call. These are only useful for debugging "
3916 "protocol issues, and the callback can normally ignore them. The callback "
3917 "may want to print these numbers in error messages or debugging messages."
3921 #: ../src/guestfs.pod:1794
3922 msgid "If no callback is registered: progress messages are discarded."
3926 #: ../src/guestfs.pod:1796
3927 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3931 #: ../src/guestfs.pod:1799
3933 "The callback function is called whenever a log message is generated by qemu, "
3934 "the appliance kernel, guestfsd (daemon), or utility programs."
3938 #: ../src/guestfs.pod:1802
3940 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3941 "guestfs_launch>) then additional debug messages are generated."
3945 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3947 "If no callback is registered: the messages are discarded unless the verbose "
3948 "flag is set in which case they are sent to stderr. You can override the "
3949 "printing of verbose messages to stderr by setting up a callback."
3953 #: ../src/guestfs.pod:1810
3954 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3958 #: ../src/guestfs.pod:1813
3960 "The callback function is called whenever a log message is generated by the "
3961 "library part of libguestfs."
3965 #: ../src/guestfs.pod:1816
3967 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3968 "messages are generated."
3972 #: ../src/guestfs.pod:1824
3973 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3977 #: ../src/guestfs.pod:1827
3979 "The callback function is called whenever a trace message is generated. This "
3980 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3984 #: ../src/guestfs.pod:1830
3986 "If no callback is registered: the messages are sent to stderr. You can "
3987 "override the printing of trace messages to stderr by setting up a callback."
3991 #: ../src/guestfs.pod:1836
3992 msgid "guestfs_set_event_callback"
3996 #: ../src/guestfs.pod:1838
3999 " int guestfs_set_event_callback (guestfs_h *g,\n"
4000 " guestfs_event_callback cb,\n"
4001 " uint64_t event_bitmask,\n"
4008 #: ../src/guestfs.pod:1844
4010 "This function registers a callback (C<cb>) for all event classes in the "
4015 #: ../src/guestfs.pod:1847
4017 "For example, to register for all log message events, you could call this "
4018 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4019 "To register a single callback for all possible classes of events, use "
4020 "C<GUESTFS_EVENT_ALL>."
4024 #: ../src/guestfs.pod:1853
4025 msgid "C<flags> should always be passed as 0."
4029 #: ../src/guestfs.pod:1855
4031 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4032 "it for any purpose."
4036 #: ../src/guestfs.pod:1858
4038 "The return value is the event handle (an integer) which you can use to "
4039 "delete the callback (see below)."
4043 #: ../src/guestfs.pod:1861
4045 "If there is an error, this function returns C<-1>, and sets the error in the "
4046 "handle in the usual way (see L</guestfs_last_error> etc.)"
4050 #: ../src/guestfs.pod:1864
4052 "Callbacks remain in effect until they are deleted, or until the handle is "
4057 #: ../src/guestfs.pod:1867
4059 "In the case where multiple callbacks are registered for a particular event "
4060 "class, all of the callbacks are called. The order in which multiple "
4061 "callbacks are called is not defined."
4065 #: ../src/guestfs.pod:1871
4066 msgid "guestfs_delete_event_callback"
4070 #: ../src/guestfs.pod:1873
4073 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4078 #: ../src/guestfs.pod:1875
4080 "Delete a callback that was previously registered. C<event_handle> should be "
4081 "the integer that was returned by a previous call to "
4082 "C<guestfs_set_event_callback> on the same handle."
4086 #: ../src/guestfs.pod:1879
4087 msgid "guestfs_event_callback"
4091 #: ../src/guestfs.pod:1881
4094 " typedef void (*guestfs_event_callback) (\n"
4097 " uint64_t event,\n"
4098 " int event_handle,\n"
4100 " const char *buf, size_t buf_len,\n"
4101 " const uint64_t *array, size_t array_len);\n"
4106 #: ../src/guestfs.pod:1890
4108 "This is the type of the event callback function that you have to provide."
4112 #: ../src/guestfs.pod:1893
4114 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4115 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4116 "handle, and C<flags> which in the current API you should ignore."
4120 #: ../src/guestfs.pod:1897
4122 "The remaining parameters contain the event payload (if any). Each event may "
4123 "contain a payload, which usually relates to the event class, but for future "
4124 "proofing your code should be written to handle any payload for any event "
4129 #: ../src/guestfs.pod:1902
4131 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4132 "there is no message buffer). Note that this message buffer can contain "
4133 "arbitrary 8 bit data, including NUL bytes."
4137 #: ../src/guestfs.pod:1906
4139 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4140 "moment this is only used for progress messages."
4144 #: ../src/guestfs.pod:1909
4145 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4149 #: ../src/guestfs.pod:1911
4151 "One motivation for the generic event API was to allow GUI programs to "
4152 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4153 "unconditionally to C<stderr>."
4157 #: ../src/guestfs.pod:1915
4159 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4160 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4161 "messages are not events; you must capture error messages separately)."
4165 #: ../src/guestfs.pod:1920
4167 "Programs have to set up a callback to capture the classes of events of "
4172 #: ../src/guestfs.pod:1923
4176 " guestfs_set_event_callback\n"
4177 " (g, message_callback,\n"
4178 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4179 " GUESTFS_EVENT_TRACE,\n"
4180 " 0, NULL) == -1)\n"
4181 " if (eh == -1) {\n"
4182 " // handle error in the usual way\n"
4188 #: ../src/guestfs.pod:1933
4190 "The callback can then direct messages to the appropriate place. In this "
4191 "example, messages are directed to syslog:"
4195 #: ../src/guestfs.pod:1936
4199 " message_callback (\n"
4202 " uint64_t event,\n"
4203 " int event_handle,\n"
4205 " const char *buf, size_t buf_len,\n"
4206 " const uint64_t *array, size_t array_len)\n"
4208 " const int priority = LOG_USER|LOG_INFO;\n"
4209 " if (buf_len > 0)\n"
4210 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4217 #: ../src/guestfs.pod:1951
4218 msgid "PRIVATE DATA AREA"
4222 #: ../src/guestfs.pod:1953
4224 "You can attach named pieces of private data to the libguestfs handle, fetch "
4225 "them by name, and walk over them, for the lifetime of the handle. This is "
4226 "called the private data area and is only available from the C API."
4231 #: ../src/guestfs.pod:1958
4232 msgid "To attach a named piece of data, use the following call:"
4237 #: ../src/guestfs.pod:1960
4240 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4245 #: ../src/guestfs.pod:1962
4247 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4248 "pointer (which can be C<NULL>). Any previous item with the same key is "
4253 #: ../src/guestfs.pod:1966
4255 "You can use any C<key> you want, but your key should I<not> start with an "
4256 "underscore character. Keys beginning with an underscore character are "
4257 "reserved for internal libguestfs purposes (eg. for implementing language "
4258 "bindings). It is recommended that you prefix the key with some unique "
4259 "string to avoid collisions with other users."
4264 #: ../src/guestfs.pod:1972
4265 msgid "To retrieve the pointer, use:"
4270 #: ../src/guestfs.pod:1974
4273 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4279 #: ../src/guestfs.pod:1976
4281 "This function returns C<NULL> if either no data is found associated with "
4282 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4287 #: ../src/guestfs.pod:1980
4289 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4290 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4291 "all. In particular, libguestfs does I<not> try to free the data when the "
4292 "handle is closed. If the data must be freed, then the caller must either "
4293 "free it before calling L</guestfs_close> or must set up a close callback to "
4294 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4298 #: ../src/guestfs.pod:1987
4299 msgid "To walk over all entries, use these two functions:"
4303 #: ../src/guestfs.pod:1989
4306 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4311 #: ../src/guestfs.pod:1991
4314 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4319 #: ../src/guestfs.pod:1993
4321 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4322 "not have any particular meaning -- keys are not returned in any defined "
4323 "order). A pointer to the key is returned in C<*key_rtn> and the "
4324 "corresponding data pointer is returned from the function. C<NULL> is "
4325 "returned if there are no keys stored in the handle."
4329 #: ../src/guestfs.pod:1999
4331 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4332 "value of this function is also C<NULL> is there are no further entries to "
4337 #: ../src/guestfs.pod:2003
4338 msgid "Notes about walking over entries:"
4342 #: ../src/guestfs.pod:2009
4344 "You must not call C<guestfs_set_private> while walking over the entries."
4348 #: ../src/guestfs.pod:2014
4350 "The handle maintains an internal iterator which is reset when you call "
4351 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4352 "call C<guestfs_set_private>."
4356 #: ../src/guestfs.pod:2020
4357 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4361 #: ../src/guestfs.pod:2022
4364 " guestfs_set_private (g, key, NULL);\n"
4369 #: ../src/guestfs.pod:2024
4370 msgid "then that C<key> is not returned when walking."
4374 #: ../src/guestfs.pod:2028
4376 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4377 "C<guestfs_next_private> or C<guestfs_set_private>."
4381 #: ../src/guestfs.pod:2034
4383 "The following example code shows how to print all keys and data pointers "
4384 "that are associated with the handle C<g>:"
4388 #: ../src/guestfs.pod:2037
4391 " const char *key;\n"
4392 " void *data = guestfs_first_private (g, &key);\n"
4393 " while (data != NULL)\n"
4395 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4396 " data = guestfs_next_private (g, &key);\n"
4402 #: ../src/guestfs.pod:2045
4404 "More commonly you are only interested in keys that begin with an application-"
4405 "specific prefix C<foo_>. Modify the loop like so:"
4409 #: ../src/guestfs.pod:2048
4412 " const char *key;\n"
4413 " void *data = guestfs_first_private (g, &key);\n"
4414 " while (data != NULL)\n"
4416 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4417 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4418 " data = guestfs_next_private (g, &key);\n"
4424 #: ../src/guestfs.pod:2057
4426 "If you need to modify keys while walking, then you have to jump back to the "
4427 "beginning of the loop. For example, to delete all keys prefixed with "
4432 #: ../src/guestfs.pod:2061
4435 " const char *key;\n"
4438 " data = guestfs_first_private (g, &key);\n"
4439 " while (data != NULL)\n"
4441 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4443 " guestfs_set_private (g, key, NULL);\n"
4444 " /* note that 'key' pointer is now invalid, and so is\n"
4445 " the internal iterator */\n"
4448 " data = guestfs_next_private (g, &key);\n"
4454 #: ../src/guestfs.pod:2077
4456 "Note that the above loop is guaranteed to terminate because the keys are "
4457 "being deleted, but other manipulations of keys within the loop might not "
4458 "terminate unless you also maintain an indication of which keys have been "
4464 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4470 #: ../src/guestfs.pod:2084
4472 "<!-- old anchor for the next section --> <a name="
4473 "\"state_machine_and_low_level_event_api\"/>"
4478 #: ../src/guestfs.pod:2089
4479 msgid "ARCHITECTURE"
4484 #: ../src/guestfs.pod:2091
4486 "Internally, libguestfs is implemented by running an appliance (a special "
4487 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4488 "process of the main program."
4493 #: ../src/guestfs.pod:2095
4496 " ___________________\n"
4498 " | main program |\n"
4500 " | | child process / appliance\n"
4501 " | | __________________________\n"
4503 " +-------------------+ RPC | +-----------------+ |\n"
4504 " | libguestfs <--------------------> guestfsd | |\n"
4505 " | | | +-----------------+ |\n"
4506 " \\___________________/ | | Linux kernel | |\n"
4507 " | +--^--------------+ |\n"
4508 " \\_________|________________/\n"
4514 " \\______________/\n"
4520 #: ../src/guestfs.pod:2115
4522 "The library, linked to the main program, creates the child process and hence "
4523 "the appliance in the L</guestfs_launch> function."
4528 #: ../src/guestfs.pod:2118
4530 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4531 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4532 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4533 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4534 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4535 "attached to the qemu process which translates device access by the "
4536 "appliance's Linux kernel into accesses to the image."
4541 #: ../src/guestfs.pod:2127
4543 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4544 "Although the disk image you are attached to might also be used by some "
4545 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4546 "care if both libguestfs's qemu process and your virtual machine are trying "
4547 "to update the disk image at the same time, since these usually results in "
4548 "massive disk corruption)."
4553 #: ../src/guestfs.pod:2134
4554 msgid "STATE MACHINE"
4559 #: ../src/guestfs.pod:2136
4560 msgid "libguestfs uses a state machine to model the child process:"
4565 #: ../src/guestfs.pod:2138
4577 " / | \\ \\ guestfs_launch\n"
4578 " / | _\\__V______\n"
4580 " / | | LAUNCHING |\n"
4581 " / | \\___________/\n"
4583 " / | guestfs_launch\n"
4585 " ______ / __|____V\n"
4586 " / \\ ------> / \\\n"
4587 " | BUSY | | READY |\n"
4588 " \\______/ <------ \\________/\n"
4594 #: ../src/guestfs.pod:2160
4596 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4597 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4598 "(3) alternating between READY and BUSY as commands are issued to, and "
4599 "carried out by, the child process."
4604 #: ../src/guestfs.pod:2165
4606 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4607 "asynchronously at any time (eg. due to some internal error), and that causes "
4608 "the state to transition back to CONFIG."
4613 #: ../src/guestfs.pod:2169
4615 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4616 "issued when in the CONFIG state."
4621 #: ../src/guestfs.pod:2172
4623 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4624 "L</guestfs_launch> blocks until the child process is READY to accept "
4625 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4626 "moves the state from CONFIG to LAUNCHING while it is running."
4631 #: ../src/guestfs.pod:2178
4633 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4634 "state. These API calls block waiting for the command to be carried out (ie. "
4635 "the state to transition to BUSY and then back to READY). There are no non-"
4636 "blocking versions, and no way to issue more than one command per handle at "
4642 #: ../src/guestfs.pod:2184
4644 "Finally, the child process sends asynchronous messages back to the main "
4645 "program, such as kernel log messages. You can register a callback to "
4646 "receive these messages."
4651 #: ../src/guestfs.pod:2188
4657 #: ../src/guestfs.pod:2190
4658 msgid "COMMUNICATION PROTOCOL"
4663 #: ../src/guestfs.pod:2192
4665 "Don't rely on using this protocol directly. This section documents how it "
4666 "currently works, but it may change at any time."
4671 #: ../src/guestfs.pod:2195
4673 "The protocol used to talk between the library and the daemon running inside "
4674 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4675 "1014, RFC 1832, RFC 4506)."
4680 #: ../src/guestfs.pod:2199
4682 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4683 "this file is automatically generated)."
4688 #: ../src/guestfs.pod:2202
4690 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4691 "and C<FileOut> parameters, which are handled with very simple request/reply "
4692 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4693 "parameters, which use the same request and reply messages, but they may also "
4694 "be followed by files sent using a chunked encoding."
4699 #: ../src/guestfs.pod:2209
4700 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4705 #: ../src/guestfs.pod:2211
4706 msgid "For ordinary functions, the request message is:"
4711 #: ../src/guestfs.pod:2213
4714 " total length (header + arguments,\n"
4715 " but not including the length word itself)\n"
4716 " struct guestfs_message_header (encoded as XDR)\n"
4717 " struct guestfs_<foo>_args (encoded as XDR)\n"
4723 #: ../src/guestfs.pod:2218
4725 "The total length field allows the daemon to allocate a fixed size buffer "
4726 "into which it slurps the rest of the message. As a result, the total length "
4727 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4728 "effective size of any request is limited to somewhere under this size."
4733 #: ../src/guestfs.pod:2224
4735 "Note also that many functions don't take any arguments, in which case the "
4736 "C<guestfs_I<foo>_args> is completely omitted."
4741 #: ../src/guestfs.pod:2227
4743 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4744 "receiver knows what type of args structure to expect, or none at all."
4749 #: ../src/guestfs.pod:2231
4751 "For functions that take optional arguments, the optional arguments are "
4752 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4753 "arguments. A bitmask in the header indicates which optional arguments are "
4754 "meaningful. The bitmask is also checked to see if it contains bits set "
4755 "which the daemon does not know about (eg. if more optional arguments were "
4756 "added in a later version of the library), and this causes the call to be "
4762 #: ../src/guestfs.pod:2239
4763 msgid "The reply message for ordinary functions is:"
4768 #: ../src/guestfs.pod:2241
4771 " total length (header + ret,\n"
4772 " but not including the length word itself)\n"
4773 " struct guestfs_message_header (encoded as XDR)\n"
4774 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4780 #: ../src/guestfs.pod:2246
4782 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4783 "functions that return no formal return values."
4788 #: ../src/guestfs.pod:2249
4790 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4795 #: ../src/guestfs.pod:2252
4797 "In the case of an error, a flag is set in the header, and the reply message "
4798 "is slightly changed:"
4803 #: ../src/guestfs.pod:2255
4806 " total length (header + error,\n"
4807 " but not including the length word itself)\n"
4808 " struct guestfs_message_header (encoded as XDR)\n"
4809 " struct guestfs_message_error (encoded as XDR)\n"
4815 #: ../src/guestfs.pod:2260
4817 "The C<guestfs_message_error> structure contains the error message as a "
4823 #: ../src/guestfs.pod:2263
4824 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4829 #: ../src/guestfs.pod:2265
4831 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4832 "The normal request message is sent (see above). However this is followed by "
4833 "a sequence of file chunks."
4838 #: ../src/guestfs.pod:2269
4841 " total length (header + arguments,\n"
4842 " but not including the length word itself,\n"
4843 " and not including the chunks)\n"
4844 " struct guestfs_message_header (encoded as XDR)\n"
4845 " struct guestfs_<foo>_args (encoded as XDR)\n"
4846 " sequence of chunks for FileIn param #0\n"
4847 " sequence of chunks for FileIn param #1 etc.\n"
4853 #: ../src/guestfs.pod:2277
4854 msgid "The \"sequence of chunks\" is:"
4859 #: ../src/guestfs.pod:2279
4862 " length of chunk (not including length word itself)\n"
4863 " struct guestfs_chunk (encoded as XDR)\n"
4864 " length of chunk\n"
4865 " struct guestfs_chunk (encoded as XDR)\n"
4867 " length of chunk\n"
4868 " struct guestfs_chunk (with data.data_len == 0)\n"
4874 #: ../src/guestfs.pod:2287
4876 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4877 "is set in the final chunk to indicate either successful completion or early "
4883 #: ../src/guestfs.pod:2291
4885 "At time of writing there are no functions that have more than one FileIn "
4886 "parameter. However this is (theoretically) supported, by sending the "
4887 "sequence of chunks for each FileIn parameter one after another (from left to "
4893 #: ../src/guestfs.pod:2296
4895 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4896 "transfer. The library does this by sending a chunk with a special flag set "
4897 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4898 "RPC, does I<not> send any reply, and goes back to reading the next request."
4903 #: ../src/guestfs.pod:2302
4905 "The daemon may also cancel. It does this by writing a special word "
4906 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4907 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4908 "cancel chunk). The special word is chosen so that even if cancellation "
4909 "happens right at the end of the transfer (after the library has finished "
4910 "writing and has started listening for the reply), the \"spurious\" cancel "
4911 "flag will not be confused with the reply message."
4916 #: ../src/guestfs.pod:2311
4918 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4919 "limit), and also files where the size is not known in advance (eg. from "
4920 "pipes or sockets). However the chunks are rather small "
4921 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4922 "to keep much in memory."
4927 #: ../src/guestfs.pod:2317
4928 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4933 #: ../src/guestfs.pod:2319
4935 "The protocol for FileOut parameters is exactly the same as for FileIn "
4936 "parameters, but with the roles of daemon and library reversed."
4941 #: ../src/guestfs.pod:2322
4944 " total length (header + ret,\n"
4945 " but not including the length word itself,\n"
4946 " and not including the chunks)\n"
4947 " struct guestfs_message_header (encoded as XDR)\n"
4948 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4949 " sequence of chunks for FileOut param #0\n"
4950 " sequence of chunks for FileOut param #1 etc.\n"
4956 #: ../src/guestfs.pod:2330
4957 msgid "INITIAL MESSAGE"
4962 #: ../src/guestfs.pod:2332
4964 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4965 "which indicates that the guest and daemon is alive. This is what L</"
4966 "guestfs_launch> waits for."
4971 #: ../src/guestfs.pod:2336
4972 msgid "PROGRESS NOTIFICATION MESSAGES"
4977 #: ../src/guestfs.pod:2338
4979 "The daemon may send progress notification messages at any time. These are "
4980 "distinguished by the normal length word being replaced by "
4981 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4985 #: ../src/guestfs.pod:2342
4987 "The library turns them into progress callbacks (see L</"
4988 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4994 #: ../src/guestfs.pod:2346
4996 "The daemon self-limits the frequency of progress messages it sends (see "
4997 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5003 #: ../src/guestfs.pod:2350
5004 msgid "LIBGUESTFS VERSION NUMBERS"
5009 #: ../src/guestfs.pod:2352
5011 "Since April 2010, libguestfs has started to make separate development and "
5012 "stable releases, along with corresponding branches in our git repository. "
5013 "These separate releases can be identified by version number:"
5018 #: ../src/guestfs.pod:2357
5021 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5022 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5028 " | `-------- sub-version\n"
5030 " `------ always '1' because we don't change the ABI\n"
5036 #: ../src/guestfs.pod:2368
5037 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5042 #: ../src/guestfs.pod:2370
5044 "As time passes we cherry pick fixes from the development branch and backport "
5045 "those into the stable branch, the effect being that the stable branch should "
5046 "get more stable and less buggy over time. So the stable releases are ideal "
5047 "for people who don't need new features but would just like the software to "
5053 #: ../src/guestfs.pod:2376
5054 msgid "Our criteria for backporting changes are:"
5059 #: ../src/guestfs.pod:2382
5061 "Documentation changes which don't affect any code are backported unless the "
5062 "documentation refers to a future feature which is not in stable."
5067 #: ../src/guestfs.pod:2388
5069 "Bug fixes which are not controversial, fix obvious problems, and have been "
5070 "well tested are backported."
5075 #: ../src/guestfs.pod:2393
5077 "Simple rearrangements of code which shouldn't affect how it works get "
5078 "backported. This is so that the code in the two branches doesn't get too "
5079 "far out of step, allowing us to backport future fixes more easily."
5084 #: ../src/guestfs.pod:2399
5086 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5087 "exceptional case: the new feature is required in order to implement an "
5088 "important bug fix."
5093 #: ../src/guestfs.pod:2405
5095 "A new stable branch starts when we think the new features in development are "
5096 "substantial and compelling enough over the current stable branch to warrant "
5097 "it. When that happens we create new stable and development versions 1.N.0 "
5098 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5099 "stable at this point, but by backporting fixes from development, that branch "
5100 "will stabilize over time."
5104 #: ../src/guestfs.pod:2413
5105 msgid "EXTENDING LIBGUESTFS"
5109 #: ../src/guestfs.pod:2415
5110 msgid "ADDING A NEW API ACTION"
5114 #: ../src/guestfs.pod:2417
5116 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5117 "documentation) are generated, and this makes it easy to extend the "
5122 #: ../src/guestfs.pod:2421
5123 msgid "To add a new API action there are two changes:"
5127 #: ../src/guestfs.pod:2427
5129 "You need to add a description of the call (name, parameters, return type, "
5130 "tests, documentation) to C<generator/generator_actions.ml>."
5134 #: ../src/guestfs.pod:2430
5136 "There are two sorts of API action, depending on whether the call goes "
5137 "through to the daemon in the appliance, or is serviced entirely by the "
5138 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5139 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5140 "an example of the latter, since a trace flag is maintained in the handle and "
5141 "all tracing is done on the library side."
5145 #: ../src/guestfs.pod:2438
5147 "Most new actions are of the first type, and get added to the "
5148 "C<daemon_functions> list. Each function has a unique procedure number used "
5149 "in the RPC protocol which is assigned to that action when we publish "
5150 "libguestfs and cannot be reused. Take the latest procedure number and "
5155 #: ../src/guestfs.pod:2444
5157 "For library-only actions of the second type, add to the "
5158 "C<non_daemon_functions> list. Since these functions are serviced by the "
5159 "library and do not travel over the RPC mechanism to the daemon, these "
5160 "functions do not need a procedure number, and so the procedure number is set "
5165 #: ../src/guestfs.pod:2452
5166 msgid "Implement the action (in C):"
5170 #: ../src/guestfs.pod:2454
5172 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5173 "C<daemon/> directory."
5177 #: ../src/guestfs.pod:2457
5179 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5180 "(note: double underscore) in the C<src/> directory."
5184 #: ../src/guestfs.pod:2460
5185 msgid "In either case, use another function as an example of what to do."
5189 #: ../src/guestfs.pod:2464
5190 msgid "After making these changes, use C<make> to compile."
5194 #: ../src/guestfs.pod:2466
5196 "Note that you don't need to implement the RPC, language bindings, manual "
5197 "pages or anything else. It's all automatically generated from the OCaml "
5202 #: ../src/guestfs.pod:2470
5203 msgid "ADDING TESTS FOR AN API ACTION"
5207 #: ../src/guestfs.pod:2472
5209 "You can supply zero or as many tests as you want per API call. The tests "
5210 "can either be added as part of the API description (C<generator/"
5211 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5212 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5213 "slower, so if possible use the first method."
5217 #: ../src/guestfs.pod:2478
5219 "The following describes the test environment used when you add an API test "
5220 "in C<generator_actions.ml>."
5224 #: ../src/guestfs.pod:2481
5225 msgid "The test environment has 4 block devices:"
5229 #: ../src/guestfs.pod:2485
5230 msgid "C</dev/sda> 500MB"
5234 #: ../src/guestfs.pod:2487
5235 msgid "General block device for testing."
5239 #: ../src/guestfs.pod:2489
5240 msgid "C</dev/sdb> 50MB"
5244 #: ../src/guestfs.pod:2491
5246 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5251 #: ../src/guestfs.pod:2494
5252 msgid "C</dev/sdc> 10MB"
5256 #: ../src/guestfs.pod:2496
5257 msgid "Used in a few tests where two block devices are needed."
5261 #: ../src/guestfs.pod:2498
5266 #: ../src/guestfs.pod:2500
5267 msgid "ISO with fixed content (see C<images/test.iso>)."
5271 #: ../src/guestfs.pod:2504
5273 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5274 "appliance and block devices are reused between tests. So don't try testing "
5275 "L</guestfs_kill_subprocess> :-x"
5279 #: ../src/guestfs.pod:2508
5281 "Each test starts with an initial scenario, selected using one of the "
5282 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5283 "initialize the disks mentioned above in a particular way as documented in "
5284 "C<generator_types.ml>. You should not assume anything about the previous "
5285 "contents of other disks that are not initialized."
5289 #: ../src/guestfs.pod:2514
5291 "You can add a prerequisite clause to any individual test. This is a run-"
5292 "time check, which, if it fails, causes the test to be skipped. Useful if "
5293 "testing a command which might not work on all variations of libguestfs "
5294 "builds. A test that has prerequisite of C<Always> means to run "
5299 #: ../src/guestfs.pod:2520
5301 "In addition, packagers can skip individual tests by setting environment "
5302 "variables before running C<make check>."
5306 #: ../src/guestfs.pod:2523
5309 " SKIP_TEST_<CMD>_<NUM>=1\n"
5314 #: ../src/guestfs.pod:2525
5315 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5319 #: ../src/guestfs.pod:2527
5324 #: ../src/guestfs.pod:2529
5327 " SKIP_TEST_<CMD>=1\n"
5332 #: ../src/guestfs.pod:2531
5333 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5337 #: ../src/guestfs.pod:2533
5338 msgid "Packagers can run only certain tests by setting for example:"
5342 #: ../src/guestfs.pod:2535
5345 " TEST_ONLY=\"vfs_type zerofree\"\n"
5350 #: ../src/guestfs.pod:2537
5352 "See C<capitests/tests.c> for more details of how these environment variables "
5357 #: ../src/guestfs.pod:2540
5358 msgid "DEBUGGING NEW API ACTIONS"
5362 #: ../src/guestfs.pod:2542
5363 msgid "Test new actions work before submitting them."
5367 #: ../src/guestfs.pod:2544
5368 msgid "You can use guestfish to try out new commands."
5372 #: ../src/guestfs.pod:2546
5374 "Debugging the daemon is a problem because it runs inside a minimal "
5375 "environment. However you can fprintf messages in the daemon to stderr, and "
5376 "they will show up if you use C<guestfish -v>."
5380 #: ../src/guestfs.pod:2550
5381 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5385 #: ../src/guestfs.pod:2552
5387 "Our C source code generally adheres to some basic code-formatting "
5388 "conventions. The existing code base is not totally consistent on this "
5389 "front, but we do prefer that contributed code be formatted similarly. In "
5390 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5391 "indentation level, and other than that, follow the K&R style."
5395 #: ../src/guestfs.pod:2558
5397 "If you use Emacs, add the following to one of one of your start-up files (e."
5398 "g., ~/.emacs), to help ensure that you get indentation right:"
5402 #: ../src/guestfs.pod:2561
5405 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5406 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5407 " (add-hook 'find-file-hook\n"
5408 " '(lambda () (if (and buffer-file-name\n"
5409 " (string-match \"/libguestfs\\\\>\"\n"
5410 " (buffer-file-name))\n"
5411 " (not (string-equal mode-name \"Change Log\"))\n"
5412 " (not (string-equal mode-name \"Makefile\")))\n"
5413 " (setq indent-tabs-mode nil))))\n"
5418 #: ../src/guestfs.pod:2571
5421 " ;;; When editing C sources in libguestfs, use this style.\n"
5422 " (defun libguestfs-c-mode ()\n"
5423 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5425 " (c-set-style \"K&R\")\n"
5426 " (setq c-indent-level 2)\n"
5427 " (setq c-basic-offset 2))\n"
5428 " (add-hook 'c-mode-hook\n"
5429 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5430 " (buffer-file-name))\n"
5431 " (libguestfs-c-mode))))\n"
5436 #: ../src/guestfs.pod:2583
5437 msgid "Enable warnings when compiling (and fix any problems this finds):"
5441 #: ../src/guestfs.pod:2586
5444 " ./configure --enable-gcc-warnings\n"
5449 #: ../src/guestfs.pod:2588
5450 msgid "Useful targets are:"
5454 #: ../src/guestfs.pod:2590
5457 " make syntax-check # checks the syntax of the C code\n"
5458 " make check # runs the test suite\n"
5463 #: ../src/guestfs.pod:2593
5464 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5468 #: ../src/guestfs.pod:2595
5470 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5471 "which are used to do shell quoting."
5475 #: ../src/guestfs.pod:2600
5480 #: ../src/guestfs.pod:2602
5482 "Simple shell quoted string. Any spaces or other shell characters are "
5487 #: ../src/guestfs.pod:2605
5492 #: ../src/guestfs.pod:2607
5494 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5500 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5501 msgid "For example:"
5505 #: ../src/guestfs.pod:2614
5508 " asprintf (&cmd, \"cat %R\", path);\n"
5513 #: ../src/guestfs.pod:2616
5514 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5518 #: ../src/guestfs.pod:2618
5520 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5521 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5522 "they are not passed via the shell (instead, straight to exec). You probably "
5523 "want to use the C<sysroot_path()> function however."
5527 #: ../src/guestfs.pod:2624
5528 msgid "SUBMITTING YOUR NEW API ACTIONS"
5532 #: ../src/guestfs.pod:2626
5534 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5535 "libguestfs> and CC to L<rjones@redhat.com>."
5539 #: ../src/guestfs.pod:2630
5540 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5544 #: ../src/guestfs.pod:2632
5545 msgid "We support i18n (gettext anyhow) in the library."
5549 #: ../src/guestfs.pod:2634
5551 "However many messages come from the daemon, and we don't translate those at "
5552 "the moment. One reason is that the appliance generally has all locale files "
5553 "removed from it, because they take up a lot of space. So we'd have to readd "
5554 "some of those, as well as copying our PO files into the appliance."
5558 #: ../src/guestfs.pod:2640
5560 "Debugging messages are never translated, since they are intended for the "
5565 #: ../src/guestfs.pod:2643
5566 msgid "SOURCE CODE SUBDIRECTORIES"
5570 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5832
5571 #: ../fish/guestfish-actions.pod:3926
5572 msgid "C<appliance>"
5576 #: ../src/guestfs.pod:2649
5577 msgid "The libguestfs appliance, build scripts and so on."
5581 #: ../src/guestfs.pod:2651
5582 msgid "C<capitests>"
5586 #: ../src/guestfs.pod:2653
5587 msgid "Automated tests of the C API."
5591 #: ../src/guestfs.pod:2655
5596 #: ../src/guestfs.pod:2657
5598 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5603 #: ../src/guestfs.pod:2660
5608 #: ../src/guestfs.pod:2662
5610 "Safety and liveness tests of components that libguestfs depends upon (not of "
5611 "libguestfs itself). Mainly this is for qemu and the kernel."
5615 #: ../src/guestfs.pod:2665
5620 #: ../src/guestfs.pod:2667
5621 msgid "Outside contributions, experimental parts."
5625 #: ../src/guestfs.pod:2669
5630 #: ../src/guestfs.pod:2671
5632 "The daemon that runs inside the libguestfs appliance and carries out actions."
5636 #: ../src/guestfs.pod:2674
5641 #: ../src/guestfs.pod:2676
5642 msgid "L<virt-df(1)> command and documentation."
5646 #: ../src/guestfs.pod:2678
5651 #: ../src/guestfs.pod:2680
5652 msgid "C API example code."
5656 #: ../src/guestfs.pod:2682
5661 #: ../src/guestfs.pod:2684
5663 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5664 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5665 "L<virt-tar-out(1)>."
5669 #: ../src/guestfs.pod:2688
5674 #: ../src/guestfs.pod:2690
5676 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5680 #: ../src/guestfs.pod:2692
5681 msgid "C<generator>"
5685 #: ../src/guestfs.pod:2694
5687 "The crucially important generator, used to automatically generate large "
5688 "amounts of boilerplate C code for things like RPC and bindings."
5692 #: ../src/guestfs.pod:2697
5697 #: ../src/guestfs.pod:2699
5698 msgid "Files used by the test suite."
5702 #: ../src/guestfs.pod:2701
5703 msgid "Some \"phony\" guest images which we test against."
5707 #: ../src/guestfs.pod:2703
5708 msgid "C<inspector>"
5712 #: ../src/guestfs.pod:2705
5713 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5717 #: ../src/guestfs.pod:2707
5722 #: ../src/guestfs.pod:2709
5723 msgid "Logo used on the website. The fish is called Arthur by the way."
5727 #: ../src/guestfs.pod:2711
5732 #: ../src/guestfs.pod:2713
5733 msgid "M4 macros used by autoconf."
5737 #: ../src/guestfs.pod:2715
5742 #: ../src/guestfs.pod:2717
5743 msgid "Translations of simple gettext strings."
5747 #: ../src/guestfs.pod:2719
5752 #: ../src/guestfs.pod:2721
5754 "The build infrastructure and PO files for translations of manpages and POD "
5755 "files. Eventually this will be combined with the C<po> directory, but that "
5756 "is rather complicated."
5760 #: ../src/guestfs.pod:2725
5761 msgid "C<regressions>"
5765 #: ../src/guestfs.pod:2727
5766 msgid "Regression tests."
5770 #: ../src/guestfs.pod:2729
5775 #: ../src/guestfs.pod:2731
5776 msgid "L<virt-rescue(1)> command and documentation."
5780 #: ../src/guestfs.pod:2733
5785 #: ../src/guestfs.pod:2735
5786 msgid "Source code to the C library."
5790 #: ../src/guestfs.pod:2737
5795 #: ../src/guestfs.pod:2739
5796 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5800 #: ../src/guestfs.pod:2741
5801 msgid "C<test-tool>"
5805 #: ../src/guestfs.pod:2743
5807 "Test tool for end users to test if their qemu/kernel combination will work "
5812 #: ../src/guestfs.pod:2746
5817 #: ../src/guestfs.pod:2748
5822 #: ../src/guestfs.pod:2750
5827 #: ../src/guestfs.pod:2752
5832 #: ../src/guestfs.pod:2754
5837 #: ../src/guestfs.pod:2756
5842 #: ../src/guestfs.pod:2758
5847 #: ../src/guestfs.pod:2760
5852 #: ../src/guestfs.pod:2762
5853 msgid "Language bindings."
5857 #: ../src/guestfs.pod:2766
5863 #: ../src/guestfs.pod:2768
5864 msgid "PROTOCOL LIMITS"
5869 #: ../src/guestfs.pod:2770
5871 "Internally libguestfs uses a message-based protocol to pass API calls and "
5872 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5873 "plenty more detail about this). The maximum message size used by the "
5874 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5875 "aware of this limit. The API calls which may be affected are individually "
5876 "documented, with a link back to this section of the documentation."
5881 #: ../src/guestfs.pod:2778
5883 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5884 "a simple string. Because this string is at some point internally encoded as "
5885 "a message, the maximum size that it can return is slightly under 4 MB. If "
5886 "the requested file is larger than this then you will get an error."
5891 #: ../src/guestfs.pod:2784
5893 "In order to transfer large files into and out of the guest filesystem, you "
5894 "need to use particular calls that support this. The sections L</UPLOADING> "
5895 "and L</DOWNLOADING> document how to do this."
5900 #: ../src/guestfs.pod:2788
5902 "You might also consider mounting the disk image using our FUSE filesystem "
5903 "support (L<guestmount(1)>)."
5907 #: ../src/guestfs.pod:2791
5908 msgid "MAXIMUM NUMBER OF DISKS"
5912 #: ../src/guestfs.pod:2793
5913 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5917 #: ../src/guestfs.pod:2796
5919 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5920 "slots. However febootstrap only understands disks with names C</dev/vda> "
5921 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5926 #: ../src/guestfs.pod:2801
5928 "We are working to substantially raise this limit in future versions but it "
5929 "requires complex changes to qemu."
5933 #: ../src/guestfs.pod:2804
5935 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5936 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5937 "requires changes to qemu."
5941 #: ../src/guestfs.pod:2808
5942 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5946 #: ../src/guestfs.pod:2810
5947 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5951 #: ../src/guestfs.pod:2812
5953 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5954 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5958 #: ../src/guestfs.pod:2815
5960 "If you attach a disk with more than 15 partitions, the extra partitions are "
5961 "ignored by libguestfs."
5965 #: ../src/guestfs.pod:2818
5966 msgid "MAXIMUM SIZE OF A DISK"
5970 #: ../src/guestfs.pod:2820
5971 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5975 #: ../src/guestfs.pod:2822
5977 "We have tested block devices up to 1 exabyte (2**60 or "
5978 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5983 #: ../src/guestfs.pod:2826
5985 "Although libguestfs probably does not impose any limit, the underlying host "
5986 "storage will. If you store disk images on a host ext4 filesystem, then the "
5987 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5988 "TB). If you store disk images as host logical volumes then you are limited "
5989 "by the maximum size of an LV."
5993 #: ../src/guestfs.pod:2832
5995 "For the hugest disk image files, we recommend using XFS on the host for "
6000 #: ../src/guestfs.pod:2835
6001 msgid "MAXIMUM SIZE OF A PARTITION"
6005 #: ../src/guestfs.pod:2837
6007 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
6008 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
6009 "address a partition located beyond 2 TB on the disk."
6013 #: ../src/guestfs.pod:2841
6015 "It is recommended that you use GPT partitions on disks which are larger than "
6016 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6017 "which are theoretically larger than the largest disk we could support."
6021 #: ../src/guestfs.pod:2846
6022 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6026 #: ../src/guestfs.pod:2848
6028 "This depends on the filesystem type. libguestfs itself does not impose any "
6029 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6030 "what these limits are."
6034 #: ../src/guestfs.pod:2852
6035 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6039 #: ../src/guestfs.pod:2854
6041 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6042 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6043 "uploads and downloads."
6047 #: ../src/guestfs.pod:2858
6048 msgid "INSPECTION LIMITS"
6052 #: ../src/guestfs.pod:2860
6054 "The inspection code has several arbitrary limits on things like the size of "
6055 "Windows Registry hive it will read, and the length of product name. These "
6056 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6057 "memory and disk space on the host, and should not be reached in practice. "
6058 "See the source code for more information."
6063 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1026
6064 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
6065 msgid "ENVIRONMENT VARIABLES"
6070 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1052
6071 msgid "LIBGUESTFS_APPEND"
6076 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1054
6077 msgid "Pass additional options to the guest kernel."
6082 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1056
6083 msgid "LIBGUESTFS_DEBUG"
6088 #: ../src/guestfs.pod:2876
6090 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6091 "effect as calling C<guestfs_set_verbose (g, 1)>."
6096 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1061
6097 msgid "LIBGUESTFS_MEMSIZE"
6102 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1063
6104 "Set the memory allocated to the qemu process, in megabytes. For example:"
6109 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1066
6112 " LIBGUESTFS_MEMSIZE=700\n"
6118 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1068
6119 msgid "LIBGUESTFS_PATH"
6123 #: ../src/guestfs.pod:2888
6125 "Set the path that libguestfs uses to search for a supermin appliance. See "
6126 "the discussion of paths in section L</PATH> above."
6131 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1073
6132 msgid "LIBGUESTFS_QEMU"
6137 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1075
6139 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6140 "which was found at compile time by the configure script is used."
6145 #: ../src/guestfs.pod:2897
6146 msgid "See also L</QEMU WRAPPERS> above."
6151 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1079
6152 msgid "LIBGUESTFS_TRACE"
6157 #: ../src/guestfs.pod:2901
6159 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6160 "effect as calling C<guestfs_set_trace (g, 1)>."
6165 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1088
6170 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1090
6172 "Location of temporary directory, defaults to C</tmp> except for the cached "
6173 "supermin appliance which defaults to C</var/tmp>."
6177 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1093
6179 "If libguestfs was compiled to use the supermin appliance then the real "
6180 "appliance is cached in this directory, shared between all handles belonging "
6181 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6182 "use in case C</var/tmp> is not large enough."
6187 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1160
6188 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
6189 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6190 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6191 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6196 #: ../src/guestfs.pod:2919
6198 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
6199 "python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat"
6200 "(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)"
6201 ">, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)"
6202 ">, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
6203 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
6204 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs."
6210 #: ../src/guestfs.pod:2947
6212 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6213 "(8)>, L<disktype(1)>."
6218 #: ../src/guestfs.pod:2954 ../tools/virt-win-reg.pl:587
6219 #: ../tools/virt-make-fs.pl:553
6225 #: ../src/guestfs.pod:2956
6226 msgid "To get a list of bugs against libguestfs use this link:"
6231 #: ../src/guestfs.pod:2958
6233 "L<https://bugzilla.redhat.com/buglist.cgi?"
6234 "component=libguestfs&product=Virtualization+Tools>"
6239 #: ../src/guestfs.pod:2960
6240 msgid "To report a new bug against libguestfs use this link:"
6245 #: ../src/guestfs.pod:2962
6247 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6248 "component=libguestfs&product=Virtualization+Tools>"
6253 #: ../src/guestfs.pod:2964
6254 msgid "When reporting a bug, please check:"
6259 #: ../src/guestfs.pod:2970
6260 msgid "That the bug hasn't been reported already."
6265 #: ../src/guestfs.pod:2974
6266 msgid "That you are testing a recent version."
6271 #: ../src/guestfs.pod:2978
6272 msgid "Describe the bug accurately, and give a way to reproduce it."
6277 #: ../src/guestfs.pod:2982
6279 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6285 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1183
6286 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
6292 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1185
6293 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
6294 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6299 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1187
6300 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
6301 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6302 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6303 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6308 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1189
6309 #: ../test-tool/libguestfs-test-tool.pod:99
6310 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6315 #: ../src/guestfs.pod:2996
6317 "This library is free software; you can redistribute it and/or modify it "
6318 "under the terms of the GNU Lesser General Public License as published by the "
6319 "Free Software Foundation; either version 2 of the License, or (at your "
6320 "option) any later version."
6325 #: ../src/guestfs.pod:3001
6327 "This library is distributed in the hope that it will be useful, but WITHOUT "
6328 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6329 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6335 #: ../src/guestfs.pod:3006
6337 "You should have received a copy of the GNU Lesser General Public License "
6338 "along with this library; if not, write to the Free Software Foundation, "
6339 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6344 #: ../src/guestfs-actions.pod:1
6345 msgid "guestfs_add_cdrom"
6350 #: ../src/guestfs-actions.pod:3
6354 " guestfs_add_cdrom (guestfs_h *g,\n"
6355 " const char *filename);\n"
6361 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6362 msgid "This function adds a virtual CD-ROM disk image to the guest."
6366 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6367 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6372 #: ../src/guestfs-actions.pod:17
6374 "This call checks for the existence of C<filename>. This stops you from "
6375 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6376 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6382 #: ../src/guestfs-actions.pod:24
6384 "If you just want to add an ISO file (often you use this as an efficient way "
6385 "to transfer large files into the guest), then you should probably use "
6386 "C<guestfs_add_drive_ro> instead."
6391 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6392 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6393 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6394 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6395 #: ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:441
6396 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:500
6397 #: ../src/guestfs-actions.pod:528 ../src/guestfs-actions.pod:546
6398 #: ../src/guestfs-actions.pod:613 ../src/guestfs-actions.pod:646
6399 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:675
6400 #: ../src/guestfs-actions.pod:774 ../src/guestfs-actions.pod:792
6401 #: ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:820
6402 #: ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:1001
6403 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:1103
6404 #: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1140
6405 #: ../src/guestfs-actions.pod:1154 ../src/guestfs-actions.pod:1174
6406 #: ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1275
6407 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:1342
6408 #: ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1482
6409 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
6410 #: ../src/guestfs-actions.pod:1806 ../src/guestfs-actions.pod:2268
6411 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2473
6412 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3461
6413 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3501
6414 #: ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3670
6415 #: ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:3697
6416 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
6417 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3840
6418 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
6419 #: ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3935
6420 #: ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:3973
6421 #: ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4020
6422 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4072
6423 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4100
6424 #: ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4210
6425 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4243
6426 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
6427 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
6428 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
6429 #: ../src/guestfs-actions.pod:4391 ../src/guestfs-actions.pod:4406
6430 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4484
6431 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4588
6432 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4626
6433 #: ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4655
6434 #: ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4683
6435 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4733
6436 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4775
6437 #: ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:4806
6438 #: ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4901
6439 #: ../src/guestfs-actions.pod:4915 ../src/guestfs-actions.pod:4943
6440 #: ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4978
6441 #: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5169
6442 #: ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5209
6443 #: ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5307
6444 #: ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337
6445 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5640
6446 #: ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5678
6447 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
6448 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5728
6449 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:5758
6450 #: ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:5798
6451 #: ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5847
6452 #: ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5886
6453 #: ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:5923
6454 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5963
6455 #: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:6008
6456 #: ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6051
6457 #: ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6094
6458 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6128
6459 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195
6460 #: ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6350
6461 #: ../src/guestfs-actions.pod:6471 ../src/guestfs-actions.pod:6483
6462 #: ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6509
6463 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6544
6464 #: ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6570
6465 #: ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6644
6466 #: ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6677
6467 #: ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6710
6468 #: ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6743
6469 #: ../src/guestfs-actions.pod:6779 ../src/guestfs-actions.pod:6793
6470 #: ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6847
6471 #: ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6899
6472 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:7054
6473 #: ../src/guestfs-actions.pod:7072 ../src/guestfs-actions.pod:7086
6474 #: ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7154
6475 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7232
6476 #: ../src/guestfs-actions.pod:7293 ../src/guestfs-actions.pod:7319
6477 #: ../src/guestfs-actions.pod:7385 ../src/guestfs-actions.pod:7404
6478 #: ../src/guestfs-actions.pod:7433
6479 msgid "This function returns 0 on success or -1 on error."
6483 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6484 #: ../src/guestfs-actions.pod:269
6486 "This function is deprecated. In new code, use the L</"
6487 "guestfs_add_drive_opts> call instead."
6492 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6493 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1453
6494 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:1967
6495 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4738
6496 #: ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6203
6497 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6295
6498 #: ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7327
6499 #: ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:31
6500 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6501 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6502 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3010
6503 #: ../fish/guestfish-actions.pod:3207 ../fish/guestfish-actions.pod:4188
6504 #: ../fish/guestfish-actions.pod:4211 ../fish/guestfish-actions.pod:4233
6505 #: ../fish/guestfish-actions.pod:4271 ../fish/guestfish-actions.pod:4912
6506 #: ../fish/guestfish-actions.pod:5009
6508 "Deprecated functions will not be removed from the API, but the fact that "
6509 "they are deprecated indicates that there are problems with correct use of "
6515 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6516 #: ../src/guestfs-actions.pod:1105 ../src/guestfs-actions.pod:1918
6517 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2119
6518 #: ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3483
6519 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:5865
6520 #: ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6096
6521 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6712
6522 #: ../src/guestfs-actions.pod:7241
6523 msgid "(Added in 0.3)"
6528 #: ../src/guestfs-actions.pod:41
6529 msgid "guestfs_add_domain"
6534 #: ../src/guestfs-actions.pod:43
6538 " guestfs_add_domain (guestfs_h *g,\n"
6539 " const char *dom,\n"
6546 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6547 #: ../src/guestfs-actions.pod:4445
6549 "You may supply a list of optional arguments to this call. Use zero or more "
6550 "of the following pairs of parameters, and terminate the list with C<-1> on "
6551 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6555 #: ../src/guestfs-actions.pod:53
6558 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6559 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6560 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6561 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6567 #: ../src/guestfs-actions.pod:58
6569 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6570 "It works by connecting to libvirt, requesting the domain and domain XML from "
6571 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6577 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6579 "The number of disks added is returned. This operation is atomic: if an "
6580 "error is returned, then no disks are added."
6585 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6587 "This function does some minimal checks to make sure the libvirt domain is "
6588 "not running (unless C<readonly> is true). In a future version we will try "
6589 "to acquire the libvirt lock on each disk."
6594 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6596 "Disks must be accessible locally. This often means that adding disks from a "
6597 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6598 "unless those disks are accessible via the same device path locally too."
6602 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6604 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6605 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6606 "libvirt URI (or one set through an environment variable, see the libvirt "
6607 "documentation for full details)."
6611 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6613 "The optional C<live> flag controls whether this call will try to connect to "
6614 "a running virtual machine C<guestfsd> process if it sees a suitable "
6615 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6616 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6617 "DAEMONS> for more information."
6622 #: ../src/guestfs-actions.pod:88
6624 "The other optional parameters are passed directly through to "
6625 "C<guestfs_add_drive_opts>."
6630 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6631 #: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:692
6632 #: ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:741
6633 #: ../src/guestfs-actions.pod:760 ../src/guestfs-actions.pod:1320
6634 #: ../src/guestfs-actions.pod:1676 ../src/guestfs-actions.pod:1879
6635 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2028
6636 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2106
6637 #: ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2782
6638 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:4878
6639 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5421
6640 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6820
6641 #: ../src/guestfs-actions.pod:7252 ../src/guestfs-actions.pod:7265
6642 #: ../src/guestfs-actions.pod:7278
6643 msgid "On error this function returns -1."
6648 #: ../src/guestfs-actions.pod:93
6649 msgid "(Added in 1.7.4)"
6654 #: ../src/guestfs-actions.pod:95
6655 msgid "guestfs_add_domain_va"
6660 #: ../src/guestfs-actions.pod:97
6664 " guestfs_add_domain_va (guestfs_h *g,\n"
6665 " const char *dom,\n"
6672 #: ../src/guestfs-actions.pod:102
6673 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6678 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6679 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6680 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4510
6681 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6686 #: ../src/guestfs-actions.pod:106
6687 msgid "guestfs_add_domain_argv"
6692 #: ../src/guestfs-actions.pod:108
6696 " guestfs_add_domain_argv (guestfs_h *g,\n"
6697 " const char *dom,\n"
6698 " const struct guestfs_add_domain_argv *optargs);\n"
6704 #: ../src/guestfs-actions.pod:113
6705 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6710 #: ../src/guestfs-actions.pod:117
6711 msgid "guestfs_add_drive"
6716 #: ../src/guestfs-actions.pod:119
6720 " guestfs_add_drive (guestfs_h *g,\n"
6721 " const char *filename);\n"
6727 #: ../src/guestfs-actions.pod:123
6729 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6730 "optional parameters, so the disk is added writable, with the format being "
6731 "detected automatically."
6736 #: ../src/guestfs-actions.pod:127
6738 "Automatic detection of the format opens you up to a potential security hole "
6739 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6740 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6741 "you should think about replacing calls to this function with calls to "
6742 "C<guestfs_add_drive_opts>, and specifying the format."
6747 #: ../src/guestfs-actions.pod:138
6748 msgid "guestfs_add_drive_opts"
6753 #: ../src/guestfs-actions.pod:140
6757 " guestfs_add_drive_opts (guestfs_h *g,\n"
6758 " const char *filename,\n"
6765 #: ../src/guestfs-actions.pod:150
6768 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6769 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6770 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6776 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6778 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6779 "The first time you call this function, the disk appears as C</dev/sda>, the "
6780 "second time as C</dev/sdb>, and so on."
6785 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6787 "You don't necessarily need to be root when using libguestfs. However you "
6788 "obviously do need sufficient permissions to access the filename for whatever "
6789 "operations you want to perform (ie. read access if you just want to read the "
6790 "image or write access if you want to modify the image)."
6795 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6796 msgid "This call checks that C<filename> exists."
6801 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4456
6802 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3021
6803 msgid "The optional arguments are:"
6808 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6814 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6816 "If true then the image is treated as read-only. Writes are still allowed, "
6817 "but they are stored in a temporary snapshot overlay which is discarded at "
6818 "the end. The disk that you add is not modified."
6823 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6829 #: ../src/guestfs-actions.pod:179
6831 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6832 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6833 "Possible formats include C<raw> and C<qcow2>."
6838 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6840 "Automatic detection of the format opens you up to a potential security hole "
6841 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6842 "RHBZ#642934. Specifying the format closes this security hole."
6847 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6853 #: ../src/guestfs-actions.pod:190
6855 "This rarely-used option lets you emulate the behaviour of the deprecated "
6856 "C<guestfs_add_drive_with_if> call (q.v.)"
6861 #: ../src/guestfs-actions.pod:197
6862 msgid "(Added in 1.5.23)"
6867 #: ../src/guestfs-actions.pod:199
6868 msgid "guestfs_add_drive_opts_va"
6873 #: ../src/guestfs-actions.pod:201
6877 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6878 " const char *filename,\n"
6885 #: ../src/guestfs-actions.pod:206
6886 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6891 #: ../src/guestfs-actions.pod:210
6892 msgid "guestfs_add_drive_opts_argv"
6897 #: ../src/guestfs-actions.pod:212
6901 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6902 " const char *filename,\n"
6903 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6909 #: ../src/guestfs-actions.pod:217
6910 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6915 #: ../src/guestfs-actions.pod:221
6916 msgid "guestfs_add_drive_ro"
6921 #: ../src/guestfs-actions.pod:223
6925 " guestfs_add_drive_ro (guestfs_h *g,\n"
6926 " const char *filename);\n"
6932 #: ../src/guestfs-actions.pod:227
6934 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6935 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6936 "disk is added read-only, with the format being detected automatically."
6941 #: ../src/guestfs-actions.pod:234
6942 msgid "(Added in 1.0.38)"
6947 #: ../src/guestfs-actions.pod:236
6948 msgid "guestfs_add_drive_ro_with_if"
6953 #: ../src/guestfs-actions.pod:238
6957 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6958 " const char *filename,\n"
6959 " const char *iface);\n"
6965 #: ../src/guestfs-actions.pod:243
6967 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6968 "QEMU interface emulation to use at run time."
6973 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6974 #: ../src/guestfs-actions.pod:2358
6975 msgid "(Added in 1.0.84)"
6980 #: ../src/guestfs-actions.pod:257
6981 msgid "guestfs_add_drive_with_if"
6986 #: ../src/guestfs-actions.pod:259
6990 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6991 " const char *filename,\n"
6992 " const char *iface);\n"
6998 #: ../src/guestfs-actions.pod:264
7000 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
7001 "QEMU interface emulation to use at run time."
7006 #: ../src/guestfs-actions.pod:278
7007 msgid "guestfs_aug_clear"
7012 #: ../src/guestfs-actions.pod:280
7016 " guestfs_aug_clear (guestfs_h *g,\n"
7017 " const char *augpath);\n"
7023 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
7025 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7026 "L<augtool(1)> C<clear> command."
7031 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2108
7032 msgid "(Added in 1.3.4)"
7037 #: ../src/guestfs-actions.pod:291
7038 msgid "guestfs_aug_close"
7043 #: ../src/guestfs-actions.pod:293
7047 " guestfs_aug_close (guestfs_h *g);\n"
7053 #: ../src/guestfs-actions.pod:296
7055 "Close the current Augeas handle and free up any resources used by it. After "
7056 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7057 "any other Augeas functions."
7062 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
7063 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
7064 #: ../src/guestfs-actions.pod:423 ../src/guestfs-actions.pod:443
7065 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:488
7066 #: ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516
7067 #: ../src/guestfs-actions.pod:530 ../src/guestfs-actions.pod:548
7068 #: ../src/guestfs-actions.pod:5498
7069 msgid "(Added in 0.7)"
7074 #: ../src/guestfs-actions.pod:305
7075 msgid "guestfs_aug_defnode"
7080 #: ../src/guestfs-actions.pod:307
7083 " struct guestfs_int_bool *\n"
7084 " guestfs_aug_defnode (guestfs_h *g,\n"
7085 " const char *name,\n"
7086 " const char *expr,\n"
7087 " const char *val);\n"
7093 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
7095 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7100 #: ../src/guestfs-actions.pod:316
7102 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7103 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7104 "containing that single node."
7109 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
7111 "On success this returns a pair containing the number of nodes in the "
7112 "nodeset, and a boolean flag if a node was created."
7117 #: ../src/guestfs-actions.pod:324
7119 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7120 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7125 #: ../src/guestfs-actions.pod:330
7126 msgid "guestfs_aug_defvar"
7131 #: ../src/guestfs-actions.pod:332
7135 " guestfs_aug_defvar (guestfs_h *g,\n"
7136 " const char *name,\n"
7137 " const char *expr);\n"
7143 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
7145 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7146 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7151 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
7153 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7154 "evaluates to something which is not a nodeset."
7159 #: ../src/guestfs-actions.pod:348
7160 msgid "guestfs_aug_get"
7165 #: ../src/guestfs-actions.pod:350
7169 " guestfs_aug_get (guestfs_h *g,\n"
7170 " const char *augpath);\n"
7176 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7178 "Look up the value associated with C<path>. If C<path> matches exactly one "
7179 "node, the C<value> is returned."
7184 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:862
7185 #: ../src/guestfs-actions.pod:880 ../src/guestfs-actions.pod:940
7186 #: ../src/guestfs-actions.pod:956 ../src/guestfs-actions.pod:1059
7187 #: ../src/guestfs-actions.pod:1189 ../src/guestfs-actions.pod:1206
7188 #: ../src/guestfs-actions.pod:1225 ../src/guestfs-actions.pod:1359
7189 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1659
7190 #: ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1839
7191 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:1940
7192 #: ../src/guestfs-actions.pod:1961 ../src/guestfs-actions.pod:2131
7193 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2530
7194 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2734
7195 #: ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2874
7196 #: ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2929
7197 #: ../src/guestfs-actions.pod:2966 ../src/guestfs-actions.pod:3026
7198 #: ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3070
7199 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3992
7200 #: ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4272
7201 #: ../src/guestfs-actions.pod:5033 ../src/guestfs-actions.pod:5226
7202 #: ../src/guestfs-actions.pod:5396 ../src/guestfs-actions.pod:5574
7203 #: ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:6256
7204 #: ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6289
7205 #: ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6994
7206 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7031
7207 #: ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7490
7209 "This function returns a string, or NULL on error. I<The caller must free "
7210 "the returned string after use>."
7215 #: ../src/guestfs-actions.pod:362
7216 msgid "guestfs_aug_init"
7221 #: ../src/guestfs-actions.pod:364
7225 " guestfs_aug_init (guestfs_h *g,\n"
7226 " const char *root,\n"
7233 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7235 "Create a new Augeas handle for editing configuration files. If there was "
7236 "any previous Augeas handle associated with this guestfs session, then it is "
7242 #: ../src/guestfs-actions.pod:373
7243 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7248 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7250 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7255 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7257 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7258 "logical I<or> of the following integers:"
7263 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7264 msgid "C<AUG_SAVE_BACKUP> = 1"
7269 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7270 msgid "Keep the original file with a C<.augsave> extension."
7275 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7276 msgid "C<AUG_SAVE_NEWFILE> = 2"
7281 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7283 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7284 "original. Overrides C<AUG_SAVE_BACKUP>."
7289 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7290 msgid "C<AUG_TYPE_CHECK> = 4"
7294 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7295 msgid "Typecheck lenses."
7299 #: ../src/guestfs-actions.pod:398
7301 "This option is only useful when debugging Augeas lenses. Use of this option "
7302 "may require additional memory for the libguestfs appliance. You may need to "
7303 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
7304 "C<guestfs_set_memsize>."
7309 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:266
7310 msgid "C<AUG_NO_STDINC> = 8"
7315 #: ../src/guestfs-actions.pod:405 ../fish/guestfish-actions.pod:268
7316 msgid "Do not use standard load path for modules."
7321 #: ../src/guestfs-actions.pod:407 ../fish/guestfish-actions.pod:270
7322 msgid "C<AUG_SAVE_NOOP> = 16"
7327 #: ../src/guestfs-actions.pod:409 ../fish/guestfish-actions.pod:272
7328 msgid "Make save a no-op, just record what would have been changed."
7333 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:274
7334 msgid "C<AUG_NO_LOAD> = 32"
7339 #: ../src/guestfs-actions.pod:413
7340 msgid "Do not load the tree in C<guestfs_aug_init>."
7345 #: ../src/guestfs-actions.pod:417
7346 msgid "To close the handle, you can call C<guestfs_aug_close>."
7351 #: ../src/guestfs-actions.pod:419 ../fish/guestfish-actions.pod:282
7352 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7357 #: ../src/guestfs-actions.pod:425
7358 msgid "guestfs_aug_insert"
7363 #: ../src/guestfs-actions.pod:427
7367 " guestfs_aug_insert (guestfs_h *g,\n"
7368 " const char *augpath,\n"
7369 " const char *label,\n"
7376 #: ../src/guestfs-actions.pod:433 ../fish/guestfish-actions.pod:288
7378 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7379 "or after C<path> (depending on the boolean flag C<before>)."
7384 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:292
7386 "C<path> must match exactly one existing node in the tree, and C<label> must "
7387 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7392 #: ../src/guestfs-actions.pod:445
7393 msgid "guestfs_aug_load"
7398 #: ../src/guestfs-actions.pod:447
7402 " guestfs_aug_load (guestfs_h *g);\n"
7408 #: ../src/guestfs-actions.pod:450 ../fish/guestfish-actions.pod:300
7409 msgid "Load files into the tree."
7414 #: ../src/guestfs-actions.pod:452 ../fish/guestfish-actions.pod:302
7415 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7420 #: ../src/guestfs-actions.pod:459
7421 msgid "guestfs_aug_ls"
7426 #: ../src/guestfs-actions.pod:461
7430 " guestfs_aug_ls (guestfs_h *g,\n"
7431 " const char *augpath);\n"
7437 #: ../src/guestfs-actions.pod:465
7439 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7440 "sorting the resulting nodes into alphabetical order."
7445 #: ../src/guestfs-actions.pod:468 ../src/guestfs-actions.pod:484
7446 #: ../src/guestfs-actions.pod:630 ../src/guestfs-actions.pod:1078
7447 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393
7448 #: ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1515
7449 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:2203
7450 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2238
7451 #: ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2305
7452 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2425
7453 #: ../src/guestfs-actions.pod:2692 ../src/guestfs-actions.pod:2983
7454 #: ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3562
7455 #: ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:3729
7456 #: ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4839
7457 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5494
7458 #: ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:6336
7459 #: ../src/guestfs-actions.pod:6397 ../src/guestfs-actions.pod:6452
7460 #: ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6622
7461 #: ../src/guestfs-actions.pod:7104 ../src/guestfs-actions.pod:7124
7462 #: ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7343
7463 #: ../src/guestfs-actions.pod:7362 ../src/guestfs-actions.pod:7447
7464 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7512
7465 #: ../src/guestfs-actions.pod:7531
7467 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7468 ">), or NULL if there was an error. I<The caller must free the strings and "
7469 "the array after use>."
7474 #: ../src/guestfs-actions.pod:472 ../src/guestfs-actions.pod:1003
7475 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1431
7476 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3381
7477 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4025
7478 #: ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4245
7479 #: ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4843
7480 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5704
7481 #: ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:5730
7482 #: ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6836
7483 #: ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:7088
7484 #: ../src/guestfs-actions.pod:7331
7485 msgid "(Added in 0.8)"
7490 #: ../src/guestfs-actions.pod:474
7491 msgid "guestfs_aug_match"
7496 #: ../src/guestfs-actions.pod:476
7500 " guestfs_aug_match (guestfs_h *g,\n"
7501 " const char *augpath);\n"
7507 #: ../src/guestfs-actions.pod:480 ../fish/guestfish-actions.pod:316
7509 "Returns a list of paths which match the path expression C<path>. The "
7510 "returned paths are sufficiently qualified so that they match exactly one "
7511 "node in the current tree."
7516 #: ../src/guestfs-actions.pod:490
7517 msgid "guestfs_aug_mv"
7522 #: ../src/guestfs-actions.pod:492
7526 " guestfs_aug_mv (guestfs_h *g,\n"
7527 " const char *src,\n"
7528 " const char *dest);\n"
7534 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:324
7536 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7537 "C<dest> is overwritten if it exists."
7542 #: ../src/guestfs-actions.pod:504
7543 msgid "guestfs_aug_rm"
7548 #: ../src/guestfs-actions.pod:506
7552 " guestfs_aug_rm (guestfs_h *g,\n"
7553 " const char *augpath);\n"
7559 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:331
7560 msgid "Remove C<path> and all of its children."
7565 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:333
7566 msgid "On success this returns the number of entries which were removed."
7571 #: ../src/guestfs-actions.pod:518
7572 msgid "guestfs_aug_save"
7577 #: ../src/guestfs-actions.pod:520
7581 " guestfs_aug_save (guestfs_h *g);\n"
7587 #: ../src/guestfs-actions.pod:523 ../fish/guestfish-actions.pod:339
7588 msgid "This writes all pending changes to disk."
7593 #: ../src/guestfs-actions.pod:525
7595 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7601 #: ../src/guestfs-actions.pod:532
7602 msgid "guestfs_aug_set"
7607 #: ../src/guestfs-actions.pod:534
7611 " guestfs_aug_set (guestfs_h *g,\n"
7612 " const char *augpath,\n"
7613 " const char *val);\n"
7619 #: ../src/guestfs-actions.pod:539 ../fish/guestfish-actions.pod:348
7620 msgid "Set the value associated with C<path> to C<val>."
7625 #: ../src/guestfs-actions.pod:541
7627 "In the Augeas API, it is possible to clear a node by setting the value to "
7628 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7629 "this call. Instead you must use the C<guestfs_aug_clear> call."
7634 #: ../src/guestfs-actions.pod:550
7635 msgid "guestfs_available"
7640 #: ../src/guestfs-actions.pod:552
7644 " guestfs_available (guestfs_h *g,\n"
7645 " char *const *groups);\n"
7651 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:359
7653 "This command is used to check the availability of some groups of "
7654 "functionality in the appliance, which not all builds of the libguestfs "
7655 "appliance will be able to provide."
7660 #: ../src/guestfs-actions.pod:560
7662 "The libguestfs groups, and the functions that those groups correspond to, "
7663 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7664 "runtime by calling C<guestfs_available_all_groups>."
7669 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7671 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7672 "\"]> would check for the availability of the Linux inotify functions and "
7673 "Augeas (configuration file editing) functions."
7678 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7679 msgid "The command returns no error if I<all> requested groups are available."
7684 #: ../src/guestfs-actions.pod:572 ../fish/guestfish-actions.pod:375
7686 "It fails with an error if one or more of the requested groups is unavailable "
7692 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:378
7694 "If an unknown group name is included in the list of groups then an error is "
7700 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:381
7706 #: ../src/guestfs-actions.pod:584
7707 msgid "You must call C<guestfs_launch> before calling this function."
7712 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:389
7714 "The reason is because we don't know what groups are supported by the "
7715 "appliance/daemon until it is running and can be queried."
7720 #: ../src/guestfs-actions.pod:592 ../fish/guestfish-actions.pod:395
7722 "If a group of functions is available, this does not necessarily mean that "
7723 "they will work. You still have to check for errors when calling individual "
7724 "API functions even if they are available."
7729 #: ../src/guestfs-actions.pod:599 ../fish/guestfish-actions.pod:402
7731 "It is usually the job of distro packagers to build complete functionality "
7732 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7733 "with all requirements satisfied, will support everything."
7738 #: ../src/guestfs-actions.pod:606
7740 "This call was added in version C<1.0.80>. In previous versions of "
7741 "libguestfs all you could do would be to speculatively execute a command to "
7742 "find out if the daemon implemented it. See also C<guestfs_version>."
7747 #: ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:1176
7748 msgid "(Added in 1.0.80)"
7753 #: ../src/guestfs-actions.pod:617
7754 msgid "guestfs_available_all_groups"
7759 #: ../src/guestfs-actions.pod:619
7763 " guestfs_available_all_groups (guestfs_h *g);\n"
7769 #: ../src/guestfs-actions.pod:622
7771 "This command returns a list of all optional groups that this daemon knows "
7772 "about. Note this returns both supported and unsupported groups. To find "
7773 "out which ones the daemon can actually support you have to call "
7774 "C<guestfs_available> on each member of the returned list."
7779 #: ../src/guestfs-actions.pod:628
7780 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7785 #: ../src/guestfs-actions.pod:634
7786 msgid "(Added in 1.3.15)"
7791 #: ../src/guestfs-actions.pod:636
7792 msgid "guestfs_base64_in"
7797 #: ../src/guestfs-actions.pod:638
7801 " guestfs_base64_in (guestfs_h *g,\n"
7802 " const char *base64file,\n"
7803 " const char *filename);\n"
7809 #: ../src/guestfs-actions.pod:643 ../fish/guestfish-actions.pod:432
7811 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7816 #: ../src/guestfs-actions.pod:648 ../src/guestfs-actions.pod:662
7817 msgid "(Added in 1.3.5)"
7822 #: ../src/guestfs-actions.pod:650
7823 msgid "guestfs_base64_out"
7828 #: ../src/guestfs-actions.pod:652
7832 " guestfs_base64_out (guestfs_h *g,\n"
7833 " const char *filename,\n"
7834 " const char *base64file);\n"
7840 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:441
7842 "This command downloads the contents of C<filename>, writing it out to local "
7843 "file C<base64file> encoded as base64."
7848 #: ../src/guestfs-actions.pod:664
7849 msgid "guestfs_blockdev_flushbufs"
7854 #: ../src/guestfs-actions.pod:666
7858 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7859 " const char *device);\n"
7865 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:450
7867 "This tells the kernel to flush internal buffers associated with C<device>."
7872 #: ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:690
7873 #: ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:721
7874 #: ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:758
7875 #: ../src/guestfs-actions.pod:772 ../src/guestfs-actions.pod:790
7876 #: ../src/guestfs-actions.pod:804 ../src/guestfs-actions.pod:818
7877 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7878 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7879 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7880 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7881 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7882 msgid "This uses the L<blockdev(8)> command."
7887 #: ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:694
7888 #: ../src/guestfs-actions.pod:709 ../src/guestfs-actions.pod:725
7889 #: ../src/guestfs-actions.pod:743 ../src/guestfs-actions.pod:762
7890 #: ../src/guestfs-actions.pod:776 ../src/guestfs-actions.pod:794
7891 #: ../src/guestfs-actions.pod:808 ../src/guestfs-actions.pod:822
7892 msgid "(Added in 0.9.3)"
7897 #: ../src/guestfs-actions.pod:679
7898 msgid "guestfs_blockdev_getbsz"
7903 #: ../src/guestfs-actions.pod:681
7907 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7908 " const char *device);\n"
7914 #: ../src/guestfs-actions.pod:685 ../fish/guestfish-actions.pod:459
7915 msgid "This returns the block size of a device."
7920 #: ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:787
7921 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7923 "(Note this is different from both I<size in blocks> and I<filesystem block "
7929 #: ../src/guestfs-actions.pod:696
7930 msgid "guestfs_blockdev_getro"
7935 #: ../src/guestfs-actions.pod:698
7939 " guestfs_blockdev_getro (guestfs_h *g,\n"
7940 " const char *device);\n"
7946 #: ../src/guestfs-actions.pod:702 ../fish/guestfish-actions.pod:470
7948 "Returns a boolean indicating if the block device is read-only (true if read-"
7949 "only, false if not)."
7954 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:1414
7955 #: ../src/guestfs-actions.pod:1429 ../src/guestfs-actions.pod:1916
7956 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1999
7957 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:2069
7958 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2117
7959 #: ../src/guestfs-actions.pod:3090 ../src/guestfs-actions.pod:3107
7960 #: ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3289
7961 #: ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3318
7962 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3348
7963 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3379
7964 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3406
7965 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3435
7966 #: ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:4997
7967 msgid "This function returns a C truth value on success or -1 on error."
7972 #: ../src/guestfs-actions.pod:711
7973 msgid "guestfs_blockdev_getsize64"
7978 #: ../src/guestfs-actions.pod:713
7982 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7983 " const char *device);\n"
7989 #: ../src/guestfs-actions.pod:717 ../fish/guestfish-actions.pod:479
7990 msgid "This returns the size of the device in bytes."
7995 #: ../src/guestfs-actions.pod:719
7996 msgid "See also C<guestfs_blockdev_getsz>."
8001 #: ../src/guestfs-actions.pod:727
8002 msgid "guestfs_blockdev_getss"
8007 #: ../src/guestfs-actions.pod:729
8011 " guestfs_blockdev_getss (guestfs_h *g,\n"
8012 " const char *device);\n"
8018 #: ../src/guestfs-actions.pod:733 ../fish/guestfish-actions.pod:489
8020 "This returns the size of sectors on a block device. Usually 512, but can be "
8021 "larger for modern devices."
8026 #: ../src/guestfs-actions.pod:736
8028 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8034 #: ../src/guestfs-actions.pod:745
8035 msgid "guestfs_blockdev_getsz"
8040 #: ../src/guestfs-actions.pod:747
8044 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8045 " const char *device);\n"
8051 #: ../src/guestfs-actions.pod:751 ../fish/guestfish-actions.pod:501
8053 "This returns the size of the device in units of 512-byte sectors (even if "
8054 "the sectorsize isn't 512 bytes ... weird)."
8059 #: ../src/guestfs-actions.pod:754
8061 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8062 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8067 #: ../src/guestfs-actions.pod:764
8068 msgid "guestfs_blockdev_rereadpt"
8073 #: ../src/guestfs-actions.pod:766
8077 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8078 " const char *device);\n"
8084 #: ../src/guestfs-actions.pod:770 ../fish/guestfish-actions.pod:514
8085 msgid "Reread the partition table on C<device>."
8090 #: ../src/guestfs-actions.pod:778
8091 msgid "guestfs_blockdev_setbsz"
8096 #: ../src/guestfs-actions.pod:780
8100 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8101 " const char *device,\n"
8102 " int blocksize);\n"
8108 #: ../src/guestfs-actions.pod:785 ../fish/guestfish-actions.pod:522
8109 msgid "This sets the block size of a device."
8114 #: ../src/guestfs-actions.pod:796
8115 msgid "guestfs_blockdev_setro"
8120 #: ../src/guestfs-actions.pod:798
8124 " guestfs_blockdev_setro (guestfs_h *g,\n"
8125 " const char *device);\n"
8131 #: ../src/guestfs-actions.pod:802 ../fish/guestfish-actions.pod:533
8132 msgid "Sets the block device named C<device> to read-only."
8137 #: ../src/guestfs-actions.pod:810
8138 msgid "guestfs_blockdev_setrw"
8143 #: ../src/guestfs-actions.pod:812
8147 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8148 " const char *device);\n"
8154 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:541
8155 msgid "Sets the block device named C<device> to read-write."
8160 #: ../src/guestfs-actions.pod:824
8161 msgid "guestfs_case_sensitive_path"
8166 #: ../src/guestfs-actions.pod:826
8170 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8171 " const char *path);\n"
8177 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8179 "This can be used to resolve case insensitive paths on a filesystem which is "
8180 "case sensitive. The use case is to resolve paths which you have read from "
8181 "Windows configuration files or the Windows Registry, to the true path."
8186 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8188 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8189 "(and probably others), which is that although the underlying filesystem is "
8190 "case-insensitive, the driver exports the filesystem to Linux as case-"
8196 #: ../src/guestfs-actions.pod:840 ../fish/guestfish-actions.pod:559
8198 "One consequence of this is that special directories such as C<c:\\windows> "
8199 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8200 "precise details of how they were created. In Windows itself this would not "
8206 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:565
8208 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8214 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:568
8216 "This function resolves the true case of each element in the path and returns "
8217 "the case-sensitive path."
8222 #: ../src/guestfs-actions.pod:852
8224 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8225 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8226 "how the directories were originally created under Windows)."
8231 #: ../src/guestfs-actions.pod:857 ../fish/guestfish-actions.pod:576
8232 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8237 #: ../src/guestfs-actions.pod:860
8238 msgid "See also C<guestfs_realpath>."
8243 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:7016
8244 msgid "(Added in 1.0.75)"
8249 #: ../src/guestfs-actions.pod:867
8255 #: ../src/guestfs-actions.pod:869
8259 " guestfs_cat (guestfs_h *g,\n"
8260 " const char *path);\n"
8266 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:5484
8267 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3685
8268 msgid "Return the contents of the file named C<path>."
8273 #: ../src/guestfs-actions.pod:875
8275 "Note that this function cannot correctly handle binary files (specifically, "
8276 "files containing C<\\0> character which is treated as end of string). For "
8277 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8278 "functions which have a more complex interface."
8283 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:1062
8284 #: ../src/guestfs-actions.pod:1082 ../src/guestfs-actions.pod:1378
8285 #: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1500
8286 #: ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:1765
8287 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
8288 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
8289 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2355
8290 #: ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5292
8291 #: ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5449
8292 #: ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:6401
8293 #: ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6602
8294 #: ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:7295
8295 #: ../src/guestfs-actions.pod:7321 ../src/guestfs-actions.pod:7347
8296 #: ../src/guestfs-actions.pod:7366 ../src/guestfs-actions.pod:7451
8297 #: ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7516
8298 #: ../src/guestfs-actions.pod:7535 ../fish/guestfish-actions.pod:592
8299 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8300 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8301 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8302 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
8303 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
8304 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
8305 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3555
8306 #: ../fish/guestfish-actions.pod:3570 ../fish/guestfish-actions.pod:3646
8307 #: ../fish/guestfish-actions.pod:3663 ../fish/guestfish-actions.pod:3678
8308 #: ../fish/guestfish-actions.pod:4332 ../fish/guestfish-actions.pod:4378
8309 #: ../fish/guestfish-actions.pod:4463 ../fish/guestfish-actions.pod:4478
8310 #: ../fish/guestfish-actions.pod:4888 ../fish/guestfish-actions.pod:4906
8311 #: ../fish/guestfish-actions.pod:4923 ../fish/guestfish-actions.pod:4933
8312 #: ../fish/guestfish-actions.pod:4981 ../fish/guestfish-actions.pod:4991
8313 #: ../fish/guestfish-actions.pod:5020 ../fish/guestfish-actions.pod:5030
8315 "Because of the message protocol, there is a transfer limit of somewhere "
8316 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8321 #: ../src/guestfs-actions.pod:886 ../src/guestfs-actions.pod:3566
8322 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3645
8323 #: ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:4138
8324 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:5372
8325 #: ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:7175
8326 #: ../src/guestfs-actions.pod:7189
8327 msgid "(Added in 0.4)"
8332 #: ../src/guestfs-actions.pod:888
8333 msgid "guestfs_checksum"
8338 #: ../src/guestfs-actions.pod:890
8342 " guestfs_checksum (guestfs_h *g,\n"
8343 " const char *csumtype,\n"
8344 " const char *path);\n"
8350 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:599
8352 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8357 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8359 "The type of checksum to compute is given by the C<csumtype> parameter which "
8360 "must have one of the following values:"
8365 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8371 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8373 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8379 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:612
8385 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:614
8386 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8391 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:616
8397 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:618
8398 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8403 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:620
8409 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:622
8410 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8415 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:624
8421 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:626
8422 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8427 #: ../src/guestfs-actions.pod:924 ../fish/guestfish-actions.pod:628
8433 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:630
8434 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8439 #: ../src/guestfs-actions.pod:928 ../fish/guestfish-actions.pod:632
8445 #: ../src/guestfs-actions.pod:930 ../fish/guestfish-actions.pod:634
8446 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8451 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:638
8452 msgid "The checksum is returned as a printable string."
8457 #: ../src/guestfs-actions.pod:936
8458 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8463 #: ../src/guestfs-actions.pod:938
8464 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8469 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1251
8470 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
8471 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
8472 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:6872
8473 msgid "(Added in 1.0.2)"
8478 #: ../src/guestfs-actions.pod:945
8479 msgid "guestfs_checksum_device"
8484 #: ../src/guestfs-actions.pod:947
8488 " guestfs_checksum_device (guestfs_h *g,\n"
8489 " const char *csumtype,\n"
8490 " const char *device);\n"
8496 #: ../src/guestfs-actions.pod:952
8498 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8499 "device named C<device>. For the types of checksums supported see the "
8500 "C<guestfs_checksum> command."
8505 #: ../src/guestfs-actions.pod:959 ../src/guestfs-actions.pod:4903
8506 #: ../src/guestfs-actions.pod:4962 ../src/guestfs-actions.pod:4999
8507 #: ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5193
8508 #: ../src/guestfs-actions.pod:6781 ../src/guestfs-actions.pod:6795
8509 #: ../src/guestfs-actions.pod:7201
8510 msgid "(Added in 1.3.2)"
8515 #: ../src/guestfs-actions.pod:961
8516 msgid "guestfs_checksums_out"
8521 #: ../src/guestfs-actions.pod:963
8525 " guestfs_checksums_out (guestfs_h *g,\n"
8526 " const char *csumtype,\n"
8527 " const char *directory,\n"
8528 " const char *sumsfile);\n"
8534 #: ../src/guestfs-actions.pod:969 ../fish/guestfish-actions.pod:656
8536 "This command computes the checksums of all regular files in C<directory> and "
8537 "then emits a list of those checksums to the local output file C<sumsfile>."
8542 #: ../src/guestfs-actions.pod:973 ../fish/guestfish-actions.pod:660
8544 "This can be used for verifying the integrity of a virtual machine. However "
8545 "to be properly secure you should pay attention to the output of the checksum "
8546 "command (it uses the ones from GNU coreutils). In particular when the "
8547 "filename is not printable, coreutils uses a special backslash syntax. For "
8548 "more information, see the GNU coreutils info file."
8553 #: ../src/guestfs-actions.pod:983
8554 msgid "(Added in 1.3.7)"
8559 #: ../src/guestfs-actions.pod:985
8560 msgid "guestfs_chmod"
8565 #: ../src/guestfs-actions.pod:987
8569 " guestfs_chmod (guestfs_h *g,\n"
8571 " const char *path);\n"
8577 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:674
8579 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8585 #: ../src/guestfs-actions.pod:995 ../fish/guestfish-actions.pod:677
8587 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8588 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8594 #: ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:4389
8595 #: ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4605
8596 #: ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:681
8597 #: ../fish/guestfish-actions.pod:2985 ../fish/guestfish-actions.pod:3114
8598 #: ../fish/guestfish-actions.pod:3124 ../fish/guestfish-actions.pod:3134
8599 msgid "The mode actually set is affected by the umask."
8604 #: ../src/guestfs-actions.pod:1005
8605 msgid "guestfs_chown"
8610 #: ../src/guestfs-actions.pod:1007
8614 " guestfs_chown (guestfs_h *g,\n"
8617 " const char *path);\n"
8623 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:687
8624 msgid "Change the file owner to C<owner> and group to C<group>."
8629 #: ../src/guestfs-actions.pod:1015 ../src/guestfs-actions.pod:3497
8630 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2443
8632 "Only numeric uid and gid are supported. If you want to use names, you will "
8633 "need to locate and parse the password file yourself (Augeas support makes "
8634 "this relatively easy)."
8639 #: ../src/guestfs-actions.pod:1023
8640 msgid "guestfs_command"
8645 #: ../src/guestfs-actions.pod:1025
8649 " guestfs_command (guestfs_h *g,\n"
8650 " char *const *arguments);\n"
8656 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:697
8658 "This call runs a command from the guest filesystem. The filesystem must be "
8659 "mounted, and must contain a compatible operating system (ie. something "
8660 "Linux, with the same or compatible processor architecture)."
8665 #: ../src/guestfs-actions.pod:1034
8667 "The single parameter is an argv-style list of arguments. The first element "
8668 "is the name of the program to run. Subsequent elements are parameters. The "
8669 "list must be non-empty (ie. must contain a program name). Note that the "
8670 "command runs directly, and is I<not> invoked via the shell (see "
8676 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:709
8677 msgid "The return value is anything printed to I<stdout> by the command."
8682 #: ../src/guestfs-actions.pod:1044 ../fish/guestfish-actions.pod:712
8684 "If the command returns a non-zero exit status, then this function returns an "
8685 "error message. The error message string is the content of I<stderr> from "
8691 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8693 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8694 "bin>. If you require a program from another location, you should provide "
8695 "the full path in the first parameter."
8700 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:721
8702 "Shared libraries and data files required by the program must be available on "
8703 "filesystems which are mounted in the correct places. It is the caller's "
8704 "responsibility to ensure all filesystems that are needed are mounted at the "
8710 #: ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1085
8711 #: ../src/guestfs-actions.pod:1550
8712 msgid "(Added in 0.9.1)"
8717 #: ../src/guestfs-actions.pod:1067
8718 msgid "guestfs_command_lines"
8723 #: ../src/guestfs-actions.pod:1069
8727 " guestfs_command_lines (guestfs_h *g,\n"
8728 " char *const *arguments);\n"
8734 #: ../src/guestfs-actions.pod:1073
8736 "This is the same as C<guestfs_command>, but splits the result into a list of "
8742 #: ../src/guestfs-actions.pod:1076
8743 msgid "See also: C<guestfs_sh_lines>"
8748 #: ../src/guestfs-actions.pod:1087
8749 msgid "guestfs_config"
8754 #: ../src/guestfs-actions.pod:1089
8758 " guestfs_config (guestfs_h *g,\n"
8759 " const char *qemuparam,\n"
8760 " const char *qemuvalue);\n"
8765 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8767 "This can be used to add arbitrary qemu command line parameters of the form "
8768 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8769 "setting some parameters which would interfere with parameters that we use."
8774 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:751
8775 msgid "The first character of C<param> string must be a C<-> (dash)."
8780 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:753
8781 msgid "C<value> can be NULL."
8786 #: ../src/guestfs-actions.pod:1107
8787 msgid "guestfs_copy_size"
8792 #: ../src/guestfs-actions.pod:1109
8796 " guestfs_copy_size (guestfs_h *g,\n"
8797 " const char *src,\n"
8798 " const char *dest,\n"
8805 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:759
8807 "This command copies exactly C<size> bytes from one source device or file "
8808 "C<src> to another destination device or file C<dest>."
8813 #: ../src/guestfs-actions.pod:1118 ../fish/guestfish-actions.pod:762
8815 "Note this will fail if the source is too short or if the destination is not "
8820 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1246
8821 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1322
8822 #: ../src/guestfs-actions.pod:1699 ../src/guestfs-actions.pod:1721
8823 #: ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:6867
8824 #: ../src/guestfs-actions.pod:6901 ../src/guestfs-actions.pod:7387
8825 #: ../src/guestfs-actions.pod:7406
8827 "This long-running command can generate progress notification messages so "
8828 "that the caller can display a progress bar or indicator. To receive these "
8829 "messages, the caller must register a progress event callback. See L<guestfs"
8830 "(3)/GUESTFS_EVENT_PROGRESS>."
8835 #: ../src/guestfs-actions.pod:1128 ../src/guestfs-actions.pod:4165
8836 #: ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:7108
8837 #: ../src/guestfs-actions.pod:7128 ../src/guestfs-actions.pod:7214
8838 msgid "(Added in 1.0.87)"
8843 #: ../src/guestfs-actions.pod:1130
8849 #: ../src/guestfs-actions.pod:1132
8853 " guestfs_cp (guestfs_h *g,\n"
8854 " const char *src,\n"
8855 " const char *dest);\n"
8861 #: ../src/guestfs-actions.pod:1137 ../fish/guestfish-actions.pod:769
8863 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8864 "destination filename or destination directory."
8869 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1156
8870 #: ../src/guestfs-actions.pod:1228 ../src/guestfs-actions.pod:1302
8871 #: ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:4857
8872 #: ../src/guestfs-actions.pod:5243
8873 msgid "(Added in 1.0.18)"
8878 #: ../src/guestfs-actions.pod:1144
8879 msgid "guestfs_cp_a"
8884 #: ../src/guestfs-actions.pod:1146
8888 " guestfs_cp_a (guestfs_h *g,\n"
8889 " const char *src,\n"
8890 " const char *dest);\n"
8896 #: ../src/guestfs-actions.pod:1151 ../fish/guestfish-actions.pod:776
8898 "This copies a file or directory from C<src> to C<dest> recursively using the "
8904 #: ../src/guestfs-actions.pod:1158
8910 #: ../src/guestfs-actions.pod:1160
8914 " guestfs_dd (guestfs_h *g,\n"
8915 " const char *src,\n"
8916 " const char *dest);\n"
8922 #: ../src/guestfs-actions.pod:1165 ../fish/guestfish-actions.pod:783
8924 "This command copies from one source device or file C<src> to another "
8925 "destination device or file C<dest>. Normally you would use this to copy to "
8926 "or from a device or partition, for example to duplicate a filesystem."
8931 #: ../src/guestfs-actions.pod:1170
8933 "If the destination is a device, it must be as large or larger than the "
8934 "source file or device, otherwise the copy will fail. This command cannot do "
8935 "partial copies (see C<guestfs_copy_size>)."
8940 #: ../src/guestfs-actions.pod:1178
8946 #: ../src/guestfs-actions.pod:1180
8950 " guestfs_df (guestfs_h *g);\n"
8956 #: ../src/guestfs-actions.pod:1183 ../fish/guestfish-actions.pod:796
8957 msgid "This command runs the C<df> command to report disk space used."
8962 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1202
8964 "This command is mostly useful for interactive sessions. It is I<not> "
8965 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8971 #: ../src/guestfs-actions.pod:1192 ../src/guestfs-actions.pod:1209
8972 #: ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:2288
8973 #: ../src/guestfs-actions.pod:2312 ../src/guestfs-actions.pod:2380
8974 #: ../src/guestfs-actions.pod:4275 ../src/guestfs-actions.pod:4757
8975 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6629
8976 #: ../src/guestfs-actions.pod:7254 ../src/guestfs-actions.pod:7267
8977 #: ../src/guestfs-actions.pod:7280
8978 msgid "(Added in 1.0.54)"
8983 #: ../src/guestfs-actions.pod:1194
8984 msgid "guestfs_df_h"
8989 #: ../src/guestfs-actions.pod:1196
8993 " guestfs_df_h (guestfs_h *g);\n"
8999 #: ../src/guestfs-actions.pod:1199 ../fish/guestfish-actions.pod:806
9001 "This command runs the C<df -h> command to report disk space used in human-"
9007 #: ../src/guestfs-actions.pod:1211
9008 msgid "guestfs_dmesg"
9013 #: ../src/guestfs-actions.pod:1213
9017 " guestfs_dmesg (guestfs_h *g);\n"
9023 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:817
9025 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9026 "This is sometimes useful for extended debugging of problems."
9031 #: ../src/guestfs-actions.pod:1220
9033 "Another way to get the same information is to enable verbose messages with "
9034 "C<guestfs_set_verbose> or by setting the environment variable "
9035 "C<LIBGUESTFS_DEBUG=1> before running the program."
9040 #: ../src/guestfs-actions.pod:1230
9041 msgid "guestfs_download"
9046 #: ../src/guestfs-actions.pod:1232
9050 " guestfs_download (guestfs_h *g,\n"
9051 " const char *remotefilename,\n"
9052 " const char *filename);\n"
9058 #: ../src/guestfs-actions.pod:1237 ../src/guestfs-actions.pod:1262
9059 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9061 "Download file C<remotefilename> and save it as C<filename> on the local "
9067 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6861
9068 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4636
9069 msgid "C<filename> can also be a named pipe."
9074 #: ../src/guestfs-actions.pod:1242
9075 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9080 #: ../src/guestfs-actions.pod:1253
9081 msgid "guestfs_download_offset"
9086 #: ../src/guestfs-actions.pod:1255
9090 " guestfs_download_offset (guestfs_h *g,\n"
9091 " const char *remotefilename,\n"
9092 " const char *filename,\n"
9093 " int64_t offset,\n"
9100 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:846
9102 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9103 "region must be within the file or device)."
9108 #: ../src/guestfs-actions.pod:1268
9110 "Note that there is no limit on the amount of data that can be downloaded "
9111 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9112 "full amount unless an error occurs."
9117 #: ../src/guestfs-actions.pod:1273
9118 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9123 #: ../src/guestfs-actions.pod:1282 ../src/guestfs-actions.pod:6906
9124 msgid "(Added in 1.5.17)"
9129 #: ../src/guestfs-actions.pod:1284
9130 msgid "guestfs_drop_caches"
9135 #: ../src/guestfs-actions.pod:1286
9139 " guestfs_drop_caches (guestfs_h *g,\n"
9140 " int whattodrop);\n"
9146 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
9148 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9149 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9150 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9155 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:867
9156 msgid "Setting C<whattodrop> to 3 should drop everything."
9161 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:869
9163 "This automatically calls L<sync(2)> before the operation, so that the "
9164 "maximum guest memory is freed."
9169 #: ../src/guestfs-actions.pod:1304
9175 #: ../src/guestfs-actions.pod:1306
9179 " guestfs_du (guestfs_h *g,\n"
9180 " const char *path);\n"
9186 #: ../src/guestfs-actions.pod:1310 ../fish/guestfish-actions.pod:876
9188 "This command runs the C<du -s> command to estimate file space usage for "
9194 #: ../src/guestfs-actions.pod:1313 ../fish/guestfish-actions.pod:879
9196 "C<path> can be a file or a directory. If C<path> is a directory then the "
9197 "estimate includes the contents of the directory and all subdirectories "
9203 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:883
9205 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9210 #: ../src/guestfs-actions.pod:1329
9211 msgid "guestfs_e2fsck_f"
9216 #: ../src/guestfs-actions.pod:1331
9220 " guestfs_e2fsck_f (guestfs_h *g,\n"
9221 " const char *device);\n"
9226 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:890
9228 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9229 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9235 #: ../src/guestfs-actions.pod:1339
9237 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9238 "Normally you should use C<guestfs_fsck>."
9243 #: ../src/guestfs-actions.pod:1344
9244 msgid "(Added in 1.0.29)"
9249 #: ../src/guestfs-actions.pod:1346
9250 msgid "guestfs_echo_daemon"
9255 #: ../src/guestfs-actions.pod:1348
9259 " guestfs_echo_daemon (guestfs_h *g,\n"
9260 " char *const *words);\n"
9266 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:901
9268 "This command concatenates the list of C<words> passed with single spaces "
9269 "between them and returns the resulting string."
9274 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:904
9275 msgid "You can use this command to test the connection through to the daemon."
9280 #: ../src/guestfs-actions.pod:1357
9281 msgid "See also C<guestfs_ping_daemon>."
9286 #: ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:2096
9287 #: ../src/guestfs-actions.pod:6077
9288 msgid "(Added in 1.0.69)"
9293 #: ../src/guestfs-actions.pod:1364
9294 msgid "guestfs_egrep"
9299 #: ../src/guestfs-actions.pod:1366
9303 " guestfs_egrep (guestfs_h *g,\n"
9304 " const char *regex,\n"
9305 " const char *path);\n"
9311 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:912
9313 "This calls the external C<egrep> program and returns the matching lines."
9318 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1400
9319 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1503
9320 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:2226
9321 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2401
9322 #: ../src/guestfs-actions.pod:2414 ../src/guestfs-actions.pod:2429
9323 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2497
9324 #: ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:3658
9325 #: ../src/guestfs-actions.pod:3672 ../src/guestfs-actions.pod:3685
9326 #: ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:4685
9327 #: ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:5626
9328 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6485
9329 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6511
9330 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6546
9331 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6572
9332 #: ../src/guestfs-actions.pod:7350 ../src/guestfs-actions.pod:7369
9333 #: ../src/guestfs-actions.pod:7454 ../src/guestfs-actions.pod:7473
9334 #: ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7538
9335 msgid "(Added in 1.0.66)"
9340 #: ../src/guestfs-actions.pod:1383
9341 msgid "guestfs_egrepi"
9346 #: ../src/guestfs-actions.pod:1385
9350 " guestfs_egrepi (guestfs_h *g,\n"
9351 " const char *regex,\n"
9352 " const char *path);\n"
9358 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:922
9360 "This calls the external C<egrep -i> program and returns the matching lines."
9365 #: ../src/guestfs-actions.pod:1402
9366 msgid "guestfs_equal"
9371 #: ../src/guestfs-actions.pod:1404
9375 " guestfs_equal (guestfs_h *g,\n"
9376 " const char *file1,\n"
9377 " const char *file2);\n"
9383 #: ../src/guestfs-actions.pod:1409 ../fish/guestfish-actions.pod:932
9385 "This compares the two files C<file1> and C<file2> and returns true if their "
9386 "content is exactly equal, or false otherwise."
9391 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:935
9392 msgid "The external L<cmp(1)> program is used for the comparison."
9397 #: ../src/guestfs-actions.pod:1418
9398 msgid "guestfs_exists"
9403 #: ../src/guestfs-actions.pod:1420
9407 " guestfs_exists (guestfs_h *g,\n"
9408 " const char *path);\n"
9414 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:941
9416 "This returns C<true> if and only if there is a file, directory (or anything) "
9417 "with the given C<path> name."
9422 #: ../src/guestfs-actions.pod:1427
9423 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9428 #: ../src/guestfs-actions.pod:1433
9429 msgid "guestfs_fallocate"
9434 #: ../src/guestfs-actions.pod:1435
9438 " guestfs_fallocate (guestfs_h *g,\n"
9439 " const char *path,\n"
9446 #: ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1466
9447 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9449 "This command preallocates a file (containing zero bytes) named C<path> of "
9450 "size C<len> bytes. If the file exists already, it is overwritten."
9455 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:954
9457 "Do not confuse this with the guestfish-specific C<alloc> command which "
9458 "allocates a file in the host and attaches it as a device."
9462 #: ../src/guestfs-actions.pod:1450
9464 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
9470 #: ../src/guestfs-actions.pod:1459
9471 msgid "guestfs_fallocate64"
9476 #: ../src/guestfs-actions.pod:1461
9480 " guestfs_fallocate64 (guestfs_h *g,\n"
9481 " const char *path,\n"
9488 #: ../src/guestfs-actions.pod:1470
9490 "Note that this call allocates disk blocks for the file. To create a sparse "
9491 "file use C<guestfs_truncate_size> instead."
9496 #: ../src/guestfs-actions.pod:1473
9498 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9499 "oversight it only allowed 30 bit lengths to be specified, effectively "
9500 "limiting the maximum size of files created through that call to 1GB."
9505 #: ../src/guestfs-actions.pod:1478 ../fish/guestfish-actions.pod:981
9507 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9508 "commands which create a file in the host and attach it as a device."
9513 #: ../src/guestfs-actions.pod:1484
9514 msgid "(Added in 1.3.17)"
9519 #: ../src/guestfs-actions.pod:1486
9520 msgid "guestfs_fgrep"
9525 #: ../src/guestfs-actions.pod:1488
9529 " guestfs_fgrep (guestfs_h *g,\n"
9530 " const char *pattern,\n"
9531 " const char *path);\n"
9537 #: ../src/guestfs-actions.pod:1493 ../fish/guestfish-actions.pod:989
9539 "This calls the external C<fgrep> program and returns the matching lines."
9544 #: ../src/guestfs-actions.pod:1505
9545 msgid "guestfs_fgrepi"
9550 #: ../src/guestfs-actions.pod:1507
9554 " guestfs_fgrepi (guestfs_h *g,\n"
9555 " const char *pattern,\n"
9556 " const char *path);\n"
9562 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
9564 "This calls the external C<fgrep -i> program and returns the matching lines."
9569 #: ../src/guestfs-actions.pod:1524
9570 msgid "guestfs_file"
9575 #: ../src/guestfs-actions.pod:1526
9579 " guestfs_file (guestfs_h *g,\n"
9580 " const char *path);\n"
9586 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1009
9588 "This call uses the standard L<file(1)> command to determine the type or "
9589 "contents of the file."
9594 #: ../src/guestfs-actions.pod:1533 ../fish/guestfish-actions.pod:1012
9596 "This call will also transparently look inside various types of compressed "
9601 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1015
9603 "The exact command which runs is C<file -zb path>. Note in particular that "
9604 "the filename is not prepended to the output (the I<-b> option)."
9608 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9610 "The output depends on the output of the underlying L<file(1)> command and it "
9611 "can change in future in ways beyond our control. In other words, the output "
9612 "is not guaranteed by the ABI."
9616 #: ../src/guestfs-actions.pod:1544
9618 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9619 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
9624 #: ../src/guestfs-actions.pod:1552
9625 msgid "guestfs_file_architecture"
9630 #: ../src/guestfs-actions.pod:1554
9634 " guestfs_file_architecture (guestfs_h *g,\n"
9635 " const char *filename);\n"
9641 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1030
9643 "This detects the architecture of the binary C<filename>, and returns it if "
9649 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1033
9650 msgid "Currently defined architectures are:"
9655 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9661 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
9663 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9664 "irrespective of the precise processor requirements of the binary."
9669 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9675 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9676 msgid "64 bit x86-64."
9681 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9687 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9688 msgid "32 bit SPARC."
9693 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9699 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9700 msgid "64 bit SPARC V9 and above."
9705 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9711 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9712 msgid "Intel Itanium."
9717 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9723 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9724 msgid "32 bit Power PC."
9729 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9735 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1064
9736 msgid "64 bit Power PC."
9741 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9742 msgid "Libguestfs may return other architecture strings in future."
9747 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1070
9748 msgid "The function works on at least the following types of files:"
9753 #: ../src/guestfs-actions.pod:1604 ../fish/guestfish-actions.pod:1076
9754 msgid "many types of Un*x and Linux binary"
9759 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1080
9760 msgid "many types of Un*x and Linux shared library"
9765 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1084
9766 msgid "Windows Win32 and Win64 binaries"
9771 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9772 msgid "Windows Win32 and Win64 DLLs"
9777 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9778 msgid "Win32 binaries and DLLs return C<i386>."
9783 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1092
9784 msgid "Win64 binaries and DLLs return C<x86_64>."
9789 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1096
9790 msgid "Linux kernel modules"
9795 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1100
9796 msgid "Linux new-style initrd images"
9801 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1104
9802 msgid "some non-x86 Linux vmlinuz kernels"
9807 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1108
9808 msgid "What it can't do currently:"
9813 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1114
9814 msgid "static libraries (libfoo.a)"
9819 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1118
9820 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9825 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9826 msgid "x86 Linux vmlinuz kernels"
9831 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1124
9833 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9834 "compressed code, and are horribly hard to unpack. If you want to find the "
9835 "architecture of a kernel, use the architecture of the associated initrd or "
9836 "kernel module(s) instead."
9841 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1825
9842 #: ../src/guestfs-actions.pod:1842 ../src/guestfs-actions.pod:2533
9843 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2696
9844 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2805
9845 #: ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2932
9846 #: ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3276
9847 #: ../src/guestfs-actions.pod:3408
9848 msgid "(Added in 1.5.3)"
9853 #: ../src/guestfs-actions.pod:1664
9854 msgid "guestfs_filesize"
9859 #: ../src/guestfs-actions.pod:1666
9863 " guestfs_filesize (guestfs_h *g,\n"
9864 " const char *file);\n"
9870 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1135
9871 msgid "This command returns the size of C<file> in bytes."
9876 #: ../src/guestfs-actions.pod:1672
9878 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9879 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9880 "devices, use C<guestfs_blockdev_getsize64>."
9885 #: ../src/guestfs-actions.pod:1678
9886 msgid "(Added in 1.0.82)"
9891 #: ../src/guestfs-actions.pod:1680
9892 msgid "guestfs_fill"
9897 #: ../src/guestfs-actions.pod:1682
9901 " guestfs_fill (guestfs_h *g,\n"
9904 " const char *path);\n"
9910 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1145
9912 "This command creates a new file called C<path>. The initial content of the "
9913 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9919 #: ../src/guestfs-actions.pod:1692
9921 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9922 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9923 "bytes use C<guestfs_fill_pattern>."
9928 #: ../src/guestfs-actions.pod:1704
9929 msgid "(Added in 1.0.79)"
9934 #: ../src/guestfs-actions.pod:1706
9935 msgid "guestfs_fill_pattern"
9940 #: ../src/guestfs-actions.pod:1708
9944 " guestfs_fill_pattern (guestfs_h *g,\n"
9945 " const char *pattern,\n"
9947 " const char *path);\n"
9953 #: ../src/guestfs-actions.pod:1714
9955 "This function is like C<guestfs_fill> except that it creates a new file of "
9956 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9957 "pattern is truncated if necessary to ensure the length of the file is "
9958 "exactly C<len> bytes."
9963 #: ../src/guestfs-actions.pod:1726
9964 msgid "(Added in 1.3.12)"
9969 #: ../src/guestfs-actions.pod:1728
9970 msgid "guestfs_find"
9975 #: ../src/guestfs-actions.pod:1730
9979 " guestfs_find (guestfs_h *g,\n"
9980 " const char *directory);\n"
9986 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9988 "This command lists out all files and directories, recursively, starting at "
9989 "C<directory>. It is essentially equivalent to running the shell command "
9990 "C<find directory -print> but some post-processing happens on the output, "
9996 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1172
9998 "This returns a list of strings I<without any prefix>. Thus if the directory "
10004 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1175
10015 #: ../src/guestfs-actions.pod:1746
10017 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10022 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
10034 #: ../src/guestfs-actions.pod:1754 ../fish/guestfish-actions.pod:1187
10035 msgid "If C<directory> is not a directory, then this command returns an error."
10040 #: ../src/guestfs-actions.pod:1757 ../fish/guestfish-actions.pod:1190
10041 msgid "The returned list is sorted."
10046 #: ../src/guestfs-actions.pod:1759
10047 msgid "See also C<guestfs_find0>."
10052 #: ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:4102
10053 #: ../src/guestfs-actions.pod:5661
10054 msgid "(Added in 1.0.27)"
10059 #: ../src/guestfs-actions.pod:1770
10060 msgid "guestfs_find0"
10065 #: ../src/guestfs-actions.pod:1772
10069 " guestfs_find0 (guestfs_h *g,\n"
10070 " const char *directory,\n"
10071 " const char *files);\n"
10077 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1201
10079 "This command lists out all files and directories, recursively, starting at "
10080 "C<directory>, placing the resulting list in the external file called "
10086 #: ../src/guestfs-actions.pod:1781
10088 "This command works the same way as C<guestfs_find> with the following "
10094 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1212
10095 msgid "The resulting list is written to an external file."
10100 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
10102 "Items (filenames) in the result are separated by C<\\0> characters. See "
10103 "L<find(1)> option I<-print0>."
10108 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
10109 msgid "This command is not limited in the number of names that it can return."
10114 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1226
10115 msgid "The result list is not sorted."
10120 #: ../src/guestfs-actions.pod:1808
10121 msgid "(Added in 1.0.74)"
10126 #: ../src/guestfs-actions.pod:1810
10127 msgid "guestfs_findfs_label"
10132 #: ../src/guestfs-actions.pod:1812
10136 " guestfs_findfs_label (guestfs_h *g,\n"
10137 " const char *label);\n"
10143 #: ../src/guestfs-actions.pod:1816 ../fish/guestfish-actions.pod:1236
10145 "This command searches the filesystems and returns the one which has the "
10146 "given label. An error is returned if no such filesystem can be found."
10151 #: ../src/guestfs-actions.pod:1820
10152 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10157 #: ../src/guestfs-actions.pod:1827
10158 msgid "guestfs_findfs_uuid"
10163 #: ../src/guestfs-actions.pod:1829
10167 " guestfs_findfs_uuid (guestfs_h *g,\n"
10168 " const char *uuid);\n"
10174 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1246
10176 "This command searches the filesystems and returns the one which has the "
10177 "given UUID. An error is returned if no such filesystem can be found."
10182 #: ../src/guestfs-actions.pod:1837
10183 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10188 #: ../src/guestfs-actions.pod:1844
10189 msgid "guestfs_fsck"
10194 #: ../src/guestfs-actions.pod:1846
10198 " guestfs_fsck (guestfs_h *g,\n"
10199 " const char *fstype,\n"
10200 " const char *device);\n"
10206 #: ../src/guestfs-actions.pod:1851 ../fish/guestfish-actions.pod:1256
10208 "This runs the filesystem checker (fsck) on C<device> which should have "
10209 "filesystem type C<fstype>."
10214 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1259
10216 "The returned integer is the status. See L<fsck(8)> for the list of status "
10217 "codes from C<fsck>."
10222 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish-actions.pod:1268
10223 msgid "Multiple status codes can be summed together."
10228 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
10230 "A non-zero return code can mean \"success\", for example if errors have been "
10231 "corrected on the filesystem."
10236 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
10237 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10242 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1282
10244 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10249 #: ../src/guestfs-actions.pod:1881 ../src/guestfs-actions.pod:7392
10250 msgid "(Added in 1.0.16)"
10255 #: ../src/guestfs-actions.pod:1883
10256 msgid "guestfs_get_append"
10261 #: ../src/guestfs-actions.pod:1885
10265 " guestfs_get_append (guestfs_h *g);\n"
10271 #: ../src/guestfs-actions.pod:1888 ../fish/guestfish-actions.pod:1288
10273 "Return the additional kernel options which are added to the guest kernel "
10279 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1291
10280 msgid "If C<NULL> then no options are added."
10285 #: ../src/guestfs-actions.pod:1893
10287 "This function returns a string which may be NULL. There is no way to return "
10288 "an error from this function. The string is owned by the guest handle and "
10289 "must I<not> be freed."
10294 #: ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:5339
10295 #: ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:6240
10296 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6275
10297 #: ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:7056
10298 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7435
10299 msgid "(Added in 1.0.26)"
10303 #: ../src/guestfs-actions.pod:1899
10304 msgid "guestfs_get_attach_method"
10308 #: ../src/guestfs-actions.pod:1901
10312 " guestfs_get_attach_method (guestfs_h *g);\n"
10317 #: ../src/guestfs-actions.pod:1904
10318 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10323 #: ../src/guestfs-actions.pod:1909
10324 msgid "guestfs_get_autosync"
10329 #: ../src/guestfs-actions.pod:1911
10333 " guestfs_get_autosync (guestfs_h *g);\n"
10339 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1303
10340 msgid "Get the autosync flag."
10345 #: ../src/guestfs-actions.pod:1920
10346 msgid "guestfs_get_direct"
10351 #: ../src/guestfs-actions.pod:1922
10355 " guestfs_get_direct (guestfs_h *g);\n"
10361 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1309
10362 msgid "Return the direct appliance mode flag."
10367 #: ../src/guestfs-actions.pod:1929 ../src/guestfs-actions.pod:5888
10368 msgid "(Added in 1.0.72)"
10373 #: ../src/guestfs-actions.pod:1931
10374 msgid "guestfs_get_e2label"
10379 #: ../src/guestfs-actions.pod:1933
10383 " guestfs_get_e2label (guestfs_h *g,\n"
10384 " const char *device);\n"
10390 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1315
10392 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10396 #: ../src/guestfs-actions.pod:1943
10398 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
10404 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
10405 #: ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5925
10406 msgid "(Added in 1.0.15)"
10411 #: ../src/guestfs-actions.pod:1952
10412 msgid "guestfs_get_e2uuid"
10417 #: ../src/guestfs-actions.pod:1954
10421 " guestfs_get_e2uuid (guestfs_h *g,\n"
10422 " const char *device);\n"
10428 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1329
10430 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10434 #: ../src/guestfs-actions.pod:1964
10436 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
10442 #: ../src/guestfs-actions.pod:1973
10443 msgid "guestfs_get_memsize"
10448 #: ../src/guestfs-actions.pod:1975
10452 " guestfs_get_memsize (guestfs_h *g);\n"
10458 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1343
10460 "This gets the memory size in megabytes allocated to the qemu subprocess."
10465 #: ../src/guestfs-actions.pod:1981
10467 "If C<guestfs_set_memsize> was not called on this handle, and if "
10468 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10469 "value for memsize."
10474 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2066
10475 #: ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6048
10476 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
10477 #: ../fish/guestfish-actions.pod:4011 ../fish/guestfish-actions.pod:4098
10479 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10484 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:4393
10485 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
10486 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4640
10487 #: ../src/guestfs-actions.pod:4657 ../src/guestfs-actions.pod:4670
10488 #: ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5946
10489 #: ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6822
10490 msgid "(Added in 1.0.55)"
10495 #: ../src/guestfs-actions.pod:1992
10496 msgid "guestfs_get_network"
10501 #: ../src/guestfs-actions.pod:1994
10505 " guestfs_get_network (guestfs_h *g);\n"
10511 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1357
10512 msgid "This returns the enable network flag."
10517 #: ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:5965
10518 msgid "(Added in 1.5.4)"
10523 #: ../src/guestfs-actions.pod:2003
10524 msgid "guestfs_get_path"
10529 #: ../src/guestfs-actions.pod:2005
10533 " guestfs_get_path (guestfs_h *g);\n"
10539 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10540 msgid "Return the current search path."
10545 #: ../src/guestfs-actions.pod:2010 ../fish/guestfish-actions.pod:1365
10547 "This is always non-NULL. If it wasn't set already, then this will return "
10548 "the default path."
10553 #: ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2042
10555 "This function returns a string, or NULL on error. The string is owned by "
10556 "the guest handle and must I<not> be freed."
10561 #: ../src/guestfs-actions.pod:2018
10562 msgid "guestfs_get_pid"
10567 #: ../src/guestfs-actions.pod:2020
10571 " guestfs_get_pid (guestfs_h *g);\n"
10577 #: ../src/guestfs-actions.pod:2023 ../fish/guestfish-actions.pod:1374
10579 "Return the process ID of the qemu subprocess. If there is no qemu "
10580 "subprocess, then this will return an error."
10585 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1377
10586 msgid "This is an internal call used for debugging and testing."
10591 #: ../src/guestfs-actions.pod:2030
10592 msgid "(Added in 1.0.56)"
10597 #: ../src/guestfs-actions.pod:2032
10598 msgid "guestfs_get_qemu"
10603 #: ../src/guestfs-actions.pod:2034
10607 " guestfs_get_qemu (guestfs_h *g);\n"
10613 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10614 msgid "Return the current qemu binary."
10619 #: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1385
10621 "This is always non-NULL. If it wasn't set already, then this will return "
10622 "the default qemu binary name."
10627 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:6010
10628 msgid "(Added in 1.0.6)"
10633 #: ../src/guestfs-actions.pod:2047
10634 msgid "guestfs_get_recovery_proc"
10639 #: ../src/guestfs-actions.pod:2049
10643 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10649 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1392
10650 msgid "Return the recovery process enabled flag."
10655 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3503
10656 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:4200
10657 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5269
10658 #: ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:6034
10659 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6745
10660 #: ../src/guestfs-actions.pod:6937
10661 msgid "(Added in 1.0.77)"
10666 #: ../src/guestfs-actions.pod:2058
10667 msgid "guestfs_get_selinux"
10672 #: ../src/guestfs-actions.pod:2060
10676 " guestfs_get_selinux (guestfs_h *g);\n"
10682 #: ../src/guestfs-actions.pod:2063
10684 "This returns the current setting of the selinux flag which is passed to the "
10685 "appliance at boot time. See C<guestfs_set_selinux>."
10690 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2134
10691 #: ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6111
10692 msgid "(Added in 1.0.67)"
10697 #: ../src/guestfs-actions.pod:2073
10698 msgid "guestfs_get_state"
10703 #: ../src/guestfs-actions.pod:2075
10707 " guestfs_get_state (guestfs_h *g);\n"
10713 #: ../src/guestfs-actions.pod:2078 ../fish/guestfish-actions.pod:1408
10715 "This returns the current state as an opaque integer. This is only useful "
10716 "for printing debug and internal error messages."
10721 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:3301
10722 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3391
10723 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:1411
10724 #: ../fish/guestfish-actions.pod:2325 ../fish/guestfish-actions.pod:2343
10725 #: ../fish/guestfish-actions.pod:2381 ../fish/guestfish-actions.pod:2397
10726 msgid "For more information on states, see L<guestfs(3)>."
10731 #: ../src/guestfs-actions.pod:2087
10732 msgid "guestfs_get_trace"
10737 #: ../src/guestfs-actions.pod:2089
10741 " guestfs_get_trace (guestfs_h *g);\n"
10747 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
10748 msgid "Return the command trace flag."
10753 #: ../src/guestfs-actions.pod:2098
10754 msgid "guestfs_get_umask"
10759 #: ../src/guestfs-actions.pod:2100
10763 " guestfs_get_umask (guestfs_h *g);\n"
10769 #: ../src/guestfs-actions.pod:2103
10771 "Return the current umask. By default the umask is C<022> unless it has been "
10772 "set by calling C<guestfs_umask>."
10777 #: ../src/guestfs-actions.pod:2110
10778 msgid "guestfs_get_verbose"
10783 #: ../src/guestfs-actions.pod:2112
10787 " guestfs_get_verbose (guestfs_h *g);\n"
10793 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1430
10794 msgid "This returns the verbose messages flag."
10799 #: ../src/guestfs-actions.pod:2121
10800 msgid "guestfs_getcon"
10805 #: ../src/guestfs-actions.pod:2123
10809 " guestfs_getcon (guestfs_h *g);\n"
10815 #: ../src/guestfs-actions.pod:2126 ../fish/guestfish-actions.pod:1436
10816 msgid "This gets the SELinux security context of the daemon."
10821 #: ../src/guestfs-actions.pod:2128
10823 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10828 #: ../src/guestfs-actions.pod:2136
10829 msgid "guestfs_getxattr"
10834 #: ../src/guestfs-actions.pod:2138
10838 " guestfs_getxattr (guestfs_h *g,\n"
10839 " const char *path,\n"
10840 " const char *name,\n"
10841 " size_t *size_r);\n"
10847 #: ../src/guestfs-actions.pod:2144
10849 "Get a single extended attribute from file C<path> named C<name>. This call "
10850 "follows symlinks. If you want to lookup an extended attribute for the "
10851 "symlink itself, use C<guestfs_lgetxattr>."
10856 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3517
10858 "Normally it is better to get all extended attributes from a file in one go "
10859 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10860 "implementations are buggy and do not provide a way to list out attributes. "
10861 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10862 "extended attributes you want in advance and call this function."
10867 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3524
10868 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2462
10870 "Extended attribute values are blobs of binary data. If there is no extended "
10871 "attribute named C<name>, this returns an error."
10876 #: ../src/guestfs-actions.pod:2158
10877 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10882 #: ../src/guestfs-actions.pod:2160 ../src/guestfs-actions.pod:2351
10883 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:5262
10884 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5469
10886 "This function returns a buffer, or NULL on error. The size of the returned "
10887 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10892 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:3533
10893 msgid "(Added in 1.7.24)"
10898 #: ../src/guestfs-actions.pod:2166
10899 msgid "guestfs_getxattrs"
10904 #: ../src/guestfs-actions.pod:2168
10907 " struct guestfs_xattr_list *\n"
10908 " guestfs_getxattrs (guestfs_h *g,\n"
10909 " const char *path);\n"
10915 #: ../src/guestfs-actions.pod:2172 ../fish/guestfish-actions.pod:1465
10917 "This call lists the extended attributes of the file or directory C<path>."
10922 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1468
10924 "At the system call level, this is a combination of the L<listxattr(2)> and "
10925 "L<getxattr(2)> calls."
10930 #: ../src/guestfs-actions.pod:2178
10931 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10936 #: ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:3545
10937 #: ../src/guestfs-actions.pod:4196
10939 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10940 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10945 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
10946 #: ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3750
10947 #: ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:6130
10948 #: ../src/guestfs-actions.pod:7500
10949 msgid "(Added in 1.0.59)"
10954 #: ../src/guestfs-actions.pod:2186
10955 msgid "guestfs_glob_expand"
10960 #: ../src/guestfs-actions.pod:2188
10964 " guestfs_glob_expand (guestfs_h *g,\n"
10965 " const char *pattern);\n"
10971 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1477
10973 "This command searches for all the pathnames matching C<pattern> according to "
10974 "the wildcard expansion rules used by the shell."
10979 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1481
10981 "If no paths match, then this returns an empty list (note: not an error)."
10986 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1484
10988 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10989 "GLOB_BRACE>. See that manual page for more details."
10994 #: ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:6323
10995 #: ../src/guestfs-actions.pod:6340
10996 msgid "(Added in 1.0.50)"
11001 #: ../src/guestfs-actions.pod:2209
11002 msgid "guestfs_grep"
11007 #: ../src/guestfs-actions.pod:2211
11011 " guestfs_grep (guestfs_h *g,\n"
11012 " const char *regex,\n"
11013 " const char *path);\n"
11019 #: ../src/guestfs-actions.pod:2216 ../fish/guestfish-actions.pod:1492
11020 msgid "This calls the external C<grep> program and returns the matching lines."
11025 #: ../src/guestfs-actions.pod:2228
11026 msgid "guestfs_grepi"
11031 #: ../src/guestfs-actions.pod:2230
11035 " guestfs_grepi (guestfs_h *g,\n"
11036 " const char *regex,\n"
11037 " const char *path);\n"
11043 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1502
11045 "This calls the external C<grep -i> program and returns the matching lines."
11050 #: ../src/guestfs-actions.pod:2247
11051 msgid "guestfs_grub_install"
11056 #: ../src/guestfs-actions.pod:2249
11060 " guestfs_grub_install (guestfs_h *g,\n"
11061 " const char *root,\n"
11062 " const char *device);\n"
11068 #: ../src/guestfs-actions.pod:2254 ../fish/guestfish-actions.pod:1512
11070 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11071 "the root directory being C<root>."
11076 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1515
11078 "Note: If grub-install reports the error \"No suitable drive was found in the "
11079 "generated device map.\" it may be that you need to create a C</boot/grub/"
11080 "device.map> file first that contains the mapping between grub device names "
11081 "and Linux device names. It is usually sufficient to create a file "
11087 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
11090 " (hd0) /dev/vda\n"
11096 #: ../src/guestfs-actions.pod:2266 ../fish/guestfish-actions.pod:1524
11097 msgid "replacing C</dev/vda> with the name of the installation device."
11102 #: ../src/guestfs-actions.pod:2270
11103 msgid "(Added in 1.0.17)"
11108 #: ../src/guestfs-actions.pod:2272
11109 msgid "guestfs_head"
11114 #: ../src/guestfs-actions.pod:2274
11118 " guestfs_head (guestfs_h *g,\n"
11119 " const char *path);\n"
11125 #: ../src/guestfs-actions.pod:2278 ../fish/guestfish-actions.pod:1530
11127 "This command returns up to the first 10 lines of a file as a list of strings."
11132 #: ../src/guestfs-actions.pod:2290
11133 msgid "guestfs_head_n"
11138 #: ../src/guestfs-actions.pod:2292
11142 " guestfs_head_n (guestfs_h *g,\n"
11144 " const char *path);\n"
11150 #: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1540
11152 "If the parameter C<nrlines> is a positive number, this returns the first "
11153 "C<nrlines> lines of the file C<path>."
11158 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1543
11160 "If the parameter C<nrlines> is a negative number, this returns lines from "
11161 "the file C<path>, excluding the last C<nrlines> lines."
11166 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:6620
11167 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4476
11168 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11173 #: ../src/guestfs-actions.pod:2314
11174 msgid "guestfs_hexdump"
11179 #: ../src/guestfs-actions.pod:2316
11183 " guestfs_hexdump (guestfs_h *g,\n"
11184 " const char *path);\n"
11190 #: ../src/guestfs-actions.pod:2320 ../fish/guestfish-actions.pod:1555
11192 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11193 "readable, canonical hex dump of the file."
11198 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:6404
11199 #: ../src/guestfs-actions.pod:6459
11200 msgid "(Added in 1.0.22)"
11205 #: ../src/guestfs-actions.pod:2331
11206 msgid "guestfs_initrd_cat"
11211 #: ../src/guestfs-actions.pod:2333
11215 " guestfs_initrd_cat (guestfs_h *g,\n"
11216 " const char *initrdpath,\n"
11217 " const char *filename,\n"
11218 " size_t *size_r);\n"
11224 #: ../src/guestfs-actions.pod:2339 ../fish/guestfish-actions.pod:1565
11226 "This command unpacks the file C<filename> from the initrd file called "
11227 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11233 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1569
11235 "For example, in guestfish you could use the following command to examine the "
11236 "boot script (usually called C</init>) contained in a Linux initrd or "
11242 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1573
11245 " initrd-cat /boot/initrd-<version>.img init\n"
11251 #: ../src/guestfs-actions.pod:2349
11252 msgid "See also C<guestfs_initrd_list>."
11257 #: ../src/guestfs-actions.pod:2360
11258 msgid "guestfs_initrd_list"
11263 #: ../src/guestfs-actions.pod:2362
11267 " guestfs_initrd_list (guestfs_h *g,\n"
11268 " const char *path);\n"
11274 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11275 msgid "This command lists out files contained in an initrd."
11280 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1586
11282 "The files are listed without any initial C</> character. The files are "
11283 "listed in the order they appear (not necessarily alphabetical). Directory "
11284 "names are listed as separate items."
11289 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1590
11291 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11292 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11298 #: ../src/guestfs-actions.pod:2382
11299 msgid "guestfs_inotify_add_watch"
11304 #: ../src/guestfs-actions.pod:2384
11308 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11309 " const char *path,\n"
11316 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11317 msgid "Watch C<path> for the events listed in C<mask>."
11322 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1600
11324 "Note that if C<path> is a directory then events within that directory are "
11325 "watched, but this does I<not> happen recursively (in subdirectories)."
11330 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1604
11332 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11333 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11338 #: ../src/guestfs-actions.pod:2403
11339 msgid "guestfs_inotify_close"
11344 #: ../src/guestfs-actions.pod:2405
11348 " guestfs_inotify_close (guestfs_h *g);\n"
11354 #: ../src/guestfs-actions.pod:2408 ../fish/guestfish-actions.pod:1612
11356 "This closes the inotify handle which was previously opened by inotify_init. "
11357 "It removes all watches, throws away any pending events, and deallocates all "
11363 #: ../src/guestfs-actions.pod:2416
11364 msgid "guestfs_inotify_files"
11369 #: ../src/guestfs-actions.pod:2418
11373 " guestfs_inotify_files (guestfs_h *g);\n"
11379 #: ../src/guestfs-actions.pod:2421
11381 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11382 "returns a list of pathnames of objects that were touched. The returned "
11383 "pathnames are sorted and deduplicated."
11388 #: ../src/guestfs-actions.pod:2431
11389 msgid "guestfs_inotify_init"
11394 #: ../src/guestfs-actions.pod:2433
11398 " guestfs_inotify_init (guestfs_h *g,\n"
11399 " int maxevents);\n"
11405 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1628
11407 "This command creates a new inotify handle. The inotify subsystem can be "
11408 "used to notify events which happen to objects in the guest filesystem."
11413 #: ../src/guestfs-actions.pod:2441
11415 "C<maxevents> is the maximum number of events which will be queued up between "
11416 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11417 "passed as C<0>, then the kernel (or previously set) default is used. For "
11418 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11419 "throws away events, but records the fact that it threw them away by setting "
11420 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11421 "C<guestfs_inotify_read>)."
11426 #: ../src/guestfs-actions.pod:2451
11428 "Before any events are generated, you have to add some watches to the "
11429 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11430 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11435 #: ../src/guestfs-actions.pod:2457
11437 "Queued up events should be read periodically by calling "
11438 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11439 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11440 "often enough then you risk the internal queue overflowing."
11445 #: ../src/guestfs-actions.pod:2464
11447 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11448 "This also removes any watches automatically."
11453 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1659
11455 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11456 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11457 "that there is one global inotify handle per libguestfs instance."
11462 #: ../src/guestfs-actions.pod:2477
11463 msgid "guestfs_inotify_read"
11468 #: ../src/guestfs-actions.pod:2479
11471 " struct guestfs_inotify_event_list *\n"
11472 " guestfs_inotify_read (guestfs_h *g);\n"
11478 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
11480 "Return the complete queue of events that have happened since the previous "
11486 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11487 msgid "If no events have happened, this returns an empty list."
11492 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1673
11494 "I<Note>: In order to make sure that all events have been read, you must call "
11495 "this function repeatedly until it returns an empty list. The reason is that "
11496 "the call will read events up to the maximum appliance-to-host message size "
11497 "and leave remaining events in the queue."
11502 #: ../src/guestfs-actions.pod:2493
11504 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11505 "there was an error. I<The caller must call "
11506 "C<guestfs_free_inotify_event_list> after use>."
11511 #: ../src/guestfs-actions.pod:2499
11512 msgid "guestfs_inotify_rm_watch"
11517 #: ../src/guestfs-actions.pod:2501
11521 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11528 #: ../src/guestfs-actions.pod:2505
11530 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11535 #: ../src/guestfs-actions.pod:2512
11536 msgid "guestfs_inspect_get_arch"
11541 #: ../src/guestfs-actions.pod:2514
11545 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11546 " const char *root);\n"
11552 #: ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2541
11553 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2678
11554 #: ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2743
11555 #: ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2792
11556 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:2856
11557 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2916
11558 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2995
11559 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
11560 #: ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3098
11561 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3134
11563 "This function should only be called with a root device string as returned by "
11564 "C<guestfs_inspect_os>."
11569 #: ../src/guestfs-actions.pod:2521
11571 "This returns the architecture of the inspected operating system. The "
11572 "possible return values are listed under C<guestfs_file_architecture>."
11577 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1697
11579 "If the architecture could not be determined, then the string C<unknown> is "
11585 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2621
11586 #: ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2752
11587 #: ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2872
11588 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
11589 #: ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:3024
11590 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
11591 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
11592 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3227
11593 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:1700
11594 #: ../fish/guestfish-actions.pod:1786 ../fish/guestfish-actions.pod:1874
11595 #: ../fish/guestfish-actions.pod:1889 ../fish/guestfish-actions.pod:1910
11596 #: ../fish/guestfish-actions.pod:1980 ../fish/guestfish-actions.pod:2004
11597 #: ../fish/guestfish-actions.pod:2021 ../fish/guestfish-actions.pod:2064
11598 #: ../fish/guestfish-actions.pod:2099 ../fish/guestfish-actions.pod:2115
11599 #: ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2144
11600 #: ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2172
11601 #: ../fish/guestfish-actions.pod:2271 ../fish/guestfish-actions.pod:2305
11602 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11607 #: ../src/guestfs-actions.pod:2535
11608 msgid "guestfs_inspect_get_distro"
11613 #: ../src/guestfs-actions.pod:2537
11617 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11618 " const char *root);\n"
11624 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1709
11626 "This returns the distro (distribution) of the inspected operating system."
11631 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1712
11632 msgid "Currently defined distros are:"
11637 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11638 msgid "\"archlinux\""
11643 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11644 msgid "Arch Linux."
11648 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11653 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11659 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11665 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11671 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11677 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11683 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11689 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11695 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11696 msgid "\"linuxmint\""
11701 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11702 msgid "Linux Mint."
11707 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11708 msgid "\"mandriva\""
11713 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11719 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11725 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11731 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11737 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11743 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11744 msgid "\"redhat-based\""
11749 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11750 msgid "Some Red Hat-derived distro."
11755 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11760 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11761 msgid "Red Hat Enterprise Linux."
11765 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11766 msgid "\"scientificlinux\""
11770 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
11771 msgid "Scientific Linux."
11775 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11776 msgid "\"slackware\""
11780 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
11786 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11792 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1770
11798 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2723
11799 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:1772
11800 #: ../fish/guestfish-actions.pod:1865 ../fish/guestfish-actions.pod:2090
11801 msgid "\"unknown\""
11806 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1774
11807 msgid "The distro could not be determined."
11812 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:3007
11813 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:2082
11814 msgid "\"windows\""
11819 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1778
11821 "Windows does not have distributions. This string is returned if the OS type "
11827 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
11828 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:1783
11829 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:2096
11831 "Future versions of libguestfs may return other strings here. The caller "
11832 "should be prepared to handle any string."
11836 #: ../src/guestfs-actions.pod:2628
11837 msgid "guestfs_inspect_get_drive_mappings"
11841 #: ../src/guestfs-actions.pod:2630
11845 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11846 " const char *root);\n"
11851 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
11853 "This call is useful for Windows which uses a primitive system of assigning "
11854 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11855 "Windows Registry to find out how disks/partitions are mapped to drive "
11856 "letters, and returns a hash table as in the example below:"
11860 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1801
11863 " C => /dev/vda2\n"
11864 " E => /dev/vdb1\n"
11865 " F => /dev/vdc1\n"
11870 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1805
11872 "Note that keys are drive letters. For Windows, the key is case insensitive "
11873 "and just contains the drive letter, without the customary colon separator "
11878 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
11880 "In future we may support other operating systems that also used drive "
11881 "letters, but the keys for those might not be case insensitive and might be "
11882 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11887 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1814
11889 "For Windows guests, currently only hard drive mappings are returned. "
11890 "Removable disks (eg. DVD-ROMs) are ignored."
11894 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1817
11896 "For guests that do not use drive mappings, or if the drive mappings could "
11897 "not be determined, this returns an empty hash table."
11901 #: ../src/guestfs-actions.pod:2662
11903 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11904 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11909 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2842
11910 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:4819
11911 #: ../src/guestfs-actions.pod:6761
11913 "This function returns a NULL-terminated array of strings, or NULL if there "
11914 "was an error. The array of strings will always have length C<2n+1>, where "
11915 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11916 "caller must free the strings and the array after use>."
11921 #: ../src/guestfs-actions.pod:2672
11922 msgid "guestfs_inspect_get_filesystems"
11927 #: ../src/guestfs-actions.pod:2674
11931 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11932 " const char *root);\n"
11938 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
11940 "This returns a list of all the filesystems that we think are associated with "
11941 "this operating system. This includes the root filesystem, other ordinary "
11942 "filesystems, and non-mounted devices like swap partitions."
11947 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
11949 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11950 "to be shared between operating systems."
11955 #: ../src/guestfs-actions.pod:2689
11957 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11958 "C<guestfs_inspect_get_mountpoints>."
11962 #: ../src/guestfs-actions.pod:2698
11963 msgid "guestfs_inspect_get_format"
11967 #: ../src/guestfs-actions.pod:2700
11971 " guestfs_inspect_get_format (guestfs_h *g,\n"
11972 " const char *root);\n"
11977 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1849
11979 "This returns the format of the inspected operating system. You can use it "
11980 "to detect install images, live CDs and similar."
11984 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
11985 msgid "Currently defined formats are:"
11989 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
11990 msgid "\"installed\""
11994 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
11995 msgid "This is an installed operating system."
11999 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
12000 msgid "\"installer\""
12004 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
12006 "The disk image being inspected is not an installed operating system, but a "
12007 "I<bootable> install disk, live CD, or similar."
12011 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1867
12012 msgid "The format of this disk image is not known."
12017 #: ../src/guestfs-actions.pod:2737
12018 msgid "guestfs_inspect_get_hostname"
12023 #: ../src/guestfs-actions.pod:2739
12027 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12028 " const char *root);\n"
12034 #: ../src/guestfs-actions.pod:2746 ../fish/guestfish-actions.pod:1883
12036 "This function returns the hostname of the operating system as found by "
12037 "inspection of the guest's configuration files."
12042 #: ../src/guestfs-actions.pod:2749 ../fish/guestfish-actions.pod:1886
12044 "If the hostname could not be determined, then the string C<unknown> is "
12050 #: ../src/guestfs-actions.pod:2757
12051 msgid "(Added in 1.7.9)"
12056 #: ../src/guestfs-actions.pod:2759
12057 msgid "guestfs_inspect_get_major_version"
12062 #: ../src/guestfs-actions.pod:2761
12066 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12067 " const char *root);\n"
12073 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1898
12075 "This returns the major version number of the inspected operating system."
12080 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1901
12082 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12083 "popular public names used by the operating system. Notably the operating "
12084 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12085 "1). You can find out the real versions corresponding to releases of Windows "
12086 "by consulting Wikipedia or MSDN."
12091 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2798
12092 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1922
12093 msgid "If the version could not be determined, then C<0> is returned."
12098 #: ../src/guestfs-actions.pod:2786
12099 msgid "guestfs_inspect_get_minor_version"
12104 #: ../src/guestfs-actions.pod:2788
12108 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12109 " const char *root);\n"
12115 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1919
12117 "This returns the minor version number of the inspected operating system."
12122 #: ../src/guestfs-actions.pod:2800
12124 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12125 "C<guestfs_inspect_get_major_version>."
12130 #: ../src/guestfs-actions.pod:2807
12131 msgid "guestfs_inspect_get_mountpoints"
12136 #: ../src/guestfs-actions.pod:2809
12140 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12141 " const char *root);\n"
12146 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1934
12148 "This returns a hash of where we think the filesystems associated with this "
12149 "operating system should be mounted. Callers should note that this is at "
12150 "best an educated guess made by reading configuration files such as C</etc/"
12151 "fstab>. I<In particular note> that this may return filesystems which are "
12152 "non-existent or not mountable and callers should be prepared to handle or "
12153 "ignore failures if they try to mount them."
12158 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
12160 "Each element in the returned hashtable has a key which is the path of the "
12161 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12162 "mounted there (eg. C</dev/sda1>)."
12167 #: ../src/guestfs-actions.pod:2830 ../fish/guestfish-actions.pod:1948
12169 "Non-mounted devices such as swap devices are I<not> returned in this list."
12173 #: ../src/guestfs-actions.pod:2833
12175 "For operating systems like Windows which still use drive letters, this call "
12176 "will only return an entry for the first drive \"mounted on\" C</>. For "
12177 "information about the mapping of drive letters to partitions, see "
12178 "C<guestfs_inspect_get_drive_mappings>."
12183 #: ../src/guestfs-actions.pod:2839
12185 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12186 "C<guestfs_inspect_get_filesystems>."
12191 #: ../src/guestfs-actions.pod:2850
12192 msgid "guestfs_inspect_get_package_format"
12197 #: ../src/guestfs-actions.pod:2852
12201 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12202 " const char *root);\n"
12208 #: ../src/guestfs-actions.pod:2859
12210 "This function and C<guestfs_inspect_get_package_management> return the "
12211 "package format and package management tool used by the inspected operating "
12212 "system. For example for Fedora these functions would return C<rpm> (package "
12213 "format) and C<yum> (package management)."
12218 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1973
12220 "This returns the string C<unknown> if we could not determine the package "
12221 "format I<or> if the operating system does not have a real packaging system "
12227 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1977
12229 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12230 "Future versions of libguestfs may return other strings."
12235 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2908
12236 msgid "(Added in 1.7.5)"
12241 #: ../src/guestfs-actions.pod:2879
12242 msgid "guestfs_inspect_get_package_management"
12247 #: ../src/guestfs-actions.pod:2881
12251 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12252 " const char *root);\n"
12258 #: ../src/guestfs-actions.pod:2888
12260 "C<guestfs_inspect_get_package_format> and this function return the package "
12261 "format and package management tool used by the inspected operating system. "
12262 "For example for Fedora these functions would return C<rpm> (package format) "
12263 "and C<yum> (package management)."
12268 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1995
12270 "This returns the string C<unknown> if we could not determine the package "
12271 "management tool I<or> if the operating system does not have a real packaging "
12272 "system (eg. Windows)."
12277 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1999
12279 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12280 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12281 "libguestfs may return other strings."
12286 #: ../src/guestfs-actions.pod:2910
12287 msgid "guestfs_inspect_get_product_name"
12292 #: ../src/guestfs-actions.pod:2912
12296 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12297 " const char *root);\n"
12303 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
12305 "This returns the product name of the inspected operating system. The "
12306 "product name is generally some freeform string which can be displayed to the "
12307 "user, but should not be parsed by programs."
12312 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2018
12314 "If the product name could not be determined, then the string C<unknown> is "
12319 #: ../src/guestfs-actions.pod:2934
12320 msgid "guestfs_inspect_get_product_variant"
12324 #: ../src/guestfs-actions.pod:2936
12328 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12329 " const char *root);\n"
12334 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2030
12335 msgid "This returns the product variant of the inspected operating system."
12339 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2033
12341 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12342 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12343 "is usually a string such as C<Client> or C<Server> (other values are "
12344 "possible). This can be used to distinguish consumer and enterprise versions "
12345 "of Windows that have the same version number (for example, Windows 7 and "
12346 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12347 "the latter is C<Server>)."
12351 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2042
12353 "For enterprise Linux guests, in future we intend this to return the product "
12354 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12355 "implemented at present."
12359 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2046
12361 "If the product variant could not be determined, then the string C<unknown> "
12366 #: ../src/guestfs-actions.pod:2962
12368 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12369 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12374 #: ../src/guestfs-actions.pod:2969
12375 msgid "guestfs_inspect_get_roots"
12380 #: ../src/guestfs-actions.pod:2971
12384 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12390 #: ../src/guestfs-actions.pod:2974
12392 "This function is a convenient way to get the list of root devices, as "
12393 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12394 "the whole inspection process."
12399 #: ../src/guestfs-actions.pod:2978
12401 "This returns an empty list if either no root devices were found or the "
12402 "caller has not called C<guestfs_inspect_os>."
12407 #: ../src/guestfs-actions.pod:2987
12408 msgid "(Added in 1.7.3)"
12413 #: ../src/guestfs-actions.pod:2989
12414 msgid "guestfs_inspect_get_type"
12419 #: ../src/guestfs-actions.pod:2991
12423 " guestfs_inspect_get_type (guestfs_h *g,\n"
12424 " const char *root);\n"
12430 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
12432 "This returns the type of the inspected operating system. Currently defined "
12438 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
12444 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2080
12445 msgid "Any Linux-based operating system."
12450 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
12451 msgid "Any Microsoft Windows operating system."
12456 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
12457 msgid "\"freebsd\""
12462 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2088
12468 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2092
12469 msgid "The operating system type could not be determined."
12473 #: ../src/guestfs-actions.pod:3031
12474 msgid "guestfs_inspect_get_windows_current_control_set"
12478 #: ../src/guestfs-actions.pod:3033
12482 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12483 " const char *root);\n"
12488 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2108
12490 "This returns the Windows CurrentControlSet of the inspected guest. The "
12491 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12495 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2111
12497 "This call assumes that the guest is Windows and that the Registry could be "
12498 "examined by inspection. If this is not the case then an error is returned."
12503 #: ../src/guestfs-actions.pod:3052
12504 msgid "guestfs_inspect_get_windows_systemroot"
12509 #: ../src/guestfs-actions.pod:3054
12513 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12514 " const char *root);\n"
12520 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2124
12522 "This returns the Windows systemroot of the inspected guest. The systemroot "
12523 "is a directory path such as C</WINDOWS>."
12528 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2127
12530 "This call assumes that the guest is Windows and that the systemroot could be "
12531 "determined by inspection. If this is not the case then an error is returned."
12536 #: ../src/guestfs-actions.pod:3073
12537 msgid "(Added in 1.5.25)"
12541 #: ../src/guestfs-actions.pod:3075
12542 msgid "guestfs_inspect_is_live"
12546 #: ../src/guestfs-actions.pod:3077
12550 " guestfs_inspect_is_live (guestfs_h *g,\n"
12551 " const char *root);\n"
12556 #: ../src/guestfs-actions.pod:3084
12558 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12559 "disk), then this returns true if a live image was detected on the disk."
12563 #: ../src/guestfs-actions.pod:3092
12564 msgid "guestfs_inspect_is_multipart"
12568 #: ../src/guestfs-actions.pod:3094
12572 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12573 " const char *root);\n"
12578 #: ../src/guestfs-actions.pod:3101
12580 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12581 "disk), then this returns true if the disk is part of a set."
12585 #: ../src/guestfs-actions.pod:3109
12586 msgid "guestfs_inspect_is_netinst"
12590 #: ../src/guestfs-actions.pod:3111
12594 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12595 " const char *root);\n"
12600 #: ../src/guestfs-actions.pod:3118
12602 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12603 "disk), then this returns true if the disk is a network installer, ie. not a "
12604 "self-contained install CD but one which is likely to require network access "
12605 "to complete the install."
12610 #: ../src/guestfs-actions.pod:3128
12611 msgid "guestfs_inspect_list_applications"
12616 #: ../src/guestfs-actions.pod:3130
12619 " struct guestfs_application_list *\n"
12620 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12621 " const char *root);\n"
12627 #: ../src/guestfs-actions.pod:3137 ../fish/guestfish-actions.pod:2181
12628 msgid "Return the list of applications installed in the operating system."
12633 #: ../src/guestfs-actions.pod:3139
12635 "I<Note:> This call works differently from other parts of the inspection "
12636 "API. You have to call C<guestfs_inspect_os>, then "
12637 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12638 "this. Listing applications is a significantly more difficult operation "
12639 "which requires access to the full filesystem. Also note that unlike the "
12640 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12641 "the libguestfs handle, this call actually reads parts of the mounted "
12642 "filesystems during the call."
12647 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2193
12649 "This returns an empty list if the inspection code was not able to determine "
12650 "the list of applications."
12655 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2196
12656 msgid "The application structure contains the following fields:"
12661 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12662 msgid "C<app_name>"
12667 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
12669 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12670 "guests, this is the package name."
12675 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12676 msgid "C<app_display_name>"
12681 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2207
12683 "The display name of the application, sometimes localized to the install "
12684 "language of the guest operating system."
12689 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
12691 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12692 "to display something can use C<app_name> instead."
12697 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12698 msgid "C<app_epoch>"
12703 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
12705 "For package managers which use epochs, this contains the epoch of the "
12706 "package (an integer). If unavailable, this is returned as C<0>."
12711 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
12712 msgid "C<app_version>"
12717 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
12719 "The version string of the application or package. If unavailable this is "
12720 "returned as an empty string C<\"\">."
12725 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
12726 msgid "C<app_release>"
12731 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2225
12733 "The release string of the application or package, for package managers that "
12734 "use this. If unavailable this is returned as an empty string C<\"\">."
12739 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
12740 msgid "C<app_install_path>"
12745 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
12747 "The installation path of the application (on operating systems such as "
12748 "Windows which use installation paths). This path is in the format used by "
12749 "the guest operating system, it is not a libguestfs path."
12754 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
12755 msgid "If unavailable this is returned as an empty string C<\"\">."
12760 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
12761 msgid "C<app_trans_path>"
12766 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
12768 "The install path translated into a libguestfs path. If unavailable this is "
12769 "returned as an empty string C<\"\">."
12774 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
12775 msgid "C<app_publisher>"
12780 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2245
12782 "The name of the publisher of the application, for package managers that use "
12783 "this. If unavailable this is returned as an empty string C<\"\">."
12788 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12794 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
12796 "The URL (eg. upstream URL) of the application. If unavailable this is "
12797 "returned as an empty string C<\"\">."
12802 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12803 msgid "C<app_source_package>"
12808 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
12810 "For packaging systems which support this, the name of the source package. "
12811 "If unavailable this is returned as an empty string C<\"\">."
12816 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
12817 msgid "C<app_summary>"
12822 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
12824 "A short (usually one line) description of the application or package. If "
12825 "unavailable this is returned as an empty string C<\"\">."
12830 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
12831 msgid "C<app_description>"
12836 #: ../src/guestfs-actions.pod:3222 ../fish/guestfish-actions.pod:2266
12838 "A longer description of the application or package. If unavailable this is "
12839 "returned as an empty string C<\"\">."
12844 #: ../src/guestfs-actions.pod:3229
12846 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12847 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12853 #: ../src/guestfs-actions.pod:3233
12854 msgid "(Added in 1.7.8)"
12859 #: ../src/guestfs-actions.pod:3235
12860 msgid "guestfs_inspect_os"
12865 #: ../src/guestfs-actions.pod:3237
12869 " guestfs_inspect_os (guestfs_h *g);\n"
12875 #: ../src/guestfs-actions.pod:3240 ../fish/guestfish-actions.pod:2277
12877 "This function uses other libguestfs functions and certain heuristics to "
12878 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12879 "for operating systems."
12884 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
12885 msgid "The list returned is empty if no operating systems were found."
12890 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2283
12892 "If one operating system was found, then this returns a list with a single "
12893 "element, which is the name of the root filesystem of this operating system. "
12894 "It is also possible for this function to return a list containing more than "
12895 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12896 "element being the root filesystem of one of the operating systems."
12901 #: ../src/guestfs-actions.pod:3253
12903 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12904 "functions in order to query further information about each operating system, "
12905 "such as the name and version."
12910 #: ../src/guestfs-actions.pod:3258
12912 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12913 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12914 "the contents. This should be called with no disks currently mounted. The "
12915 "function may also use Augeas, so any existing Augeas handle will be closed."
12920 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2301
12922 "This function cannot decrypt encrypted disks. The caller must do that first "
12923 "(supplying the necessary keys) if the disk is encrypted."
12928 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
12929 #: ../src/guestfs-actions.pod:3622
12930 msgid "See also C<guestfs_list_filesystems>."
12935 #: ../src/guestfs-actions.pod:3278
12936 msgid "guestfs_is_blockdev"
12941 #: ../src/guestfs-actions.pod:3280
12945 " guestfs_is_blockdev (guestfs_h *g,\n"
12946 " const char *path);\n"
12952 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2313
12954 "This returns C<true> if and only if there is a block device with the given "
12960 #: ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3316
12961 #: ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3361
12962 #: ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3433
12963 #: ../src/guestfs-actions.pod:3448
12964 msgid "See also C<guestfs_stat>."
12969 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
12970 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3437
12971 #: ../src/guestfs-actions.pod:3452
12972 msgid "(Added in 1.5.10)"
12977 #: ../src/guestfs-actions.pod:3293
12978 msgid "guestfs_is_busy"
12983 #: ../src/guestfs-actions.pod:3295
12987 " guestfs_is_busy (guestfs_h *g);\n"
12993 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2322
12995 "This returns true iff this handle is busy processing a command (in the "
13001 #: ../src/guestfs-actions.pod:3307
13002 msgid "guestfs_is_chardev"
13007 #: ../src/guestfs-actions.pod:3309
13011 " guestfs_is_chardev (guestfs_h *g,\n"
13012 " const char *path);\n"
13018 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2331
13020 "This returns C<true> if and only if there is a character device with the "
13021 "given C<path> name."
13026 #: ../src/guestfs-actions.pod:3322
13027 msgid "guestfs_is_config"
13032 #: ../src/guestfs-actions.pod:3324
13036 " guestfs_is_config (guestfs_h *g);\n"
13042 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2340
13044 "This returns true iff this handle is being configured (in the C<CONFIG> "
13050 #: ../src/guestfs-actions.pod:3336
13051 msgid "guestfs_is_dir"
13056 #: ../src/guestfs-actions.pod:3338
13060 " guestfs_is_dir (guestfs_h *g,\n"
13061 " const char *path);\n"
13067 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2349
13069 "This returns C<true> if and only if there is a directory with the given "
13070 "C<path> name. Note that it returns false for other objects like files."
13075 #: ../src/guestfs-actions.pod:3352
13076 msgid "guestfs_is_fifo"
13081 #: ../src/guestfs-actions.pod:3354
13085 " guestfs_is_fifo (guestfs_h *g,\n"
13086 " const char *path);\n"
13092 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2359
13094 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13095 "given C<path> name."
13100 #: ../src/guestfs-actions.pod:3367
13101 msgid "guestfs_is_file"
13106 #: ../src/guestfs-actions.pod:3369
13110 " guestfs_is_file (guestfs_h *g,\n"
13111 " const char *path);\n"
13117 #: ../src/guestfs-actions.pod:3373 ../fish/guestfish-actions.pod:2368
13119 "This returns C<true> if and only if there is a regular file with the given "
13120 "C<path> name. Note that it returns false for other objects like directories."
13125 #: ../src/guestfs-actions.pod:3383
13126 msgid "guestfs_is_launching"
13131 #: ../src/guestfs-actions.pod:3385
13135 " guestfs_is_launching (guestfs_h *g);\n"
13141 #: ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:2378
13143 "This returns true iff this handle is launching the subprocess (in the "
13144 "C<LAUNCHING> state)."
13149 #: ../src/guestfs-actions.pod:3397
13150 msgid "guestfs_is_lv"
13155 #: ../src/guestfs-actions.pod:3399
13159 " guestfs_is_lv (guestfs_h *g,\n"
13160 " const char *device);\n"
13166 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2387
13168 "This command tests whether C<device> is a logical volume, and returns true "
13169 "iff this is the case."
13174 #: ../src/guestfs-actions.pod:3410
13175 msgid "guestfs_is_ready"
13180 #: ../src/guestfs-actions.pod:3412
13184 " guestfs_is_ready (guestfs_h *g);\n"
13190 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2394
13192 "This returns true iff this handle is ready to accept commands (in the "
13198 #: ../src/guestfs-actions.pod:3424
13199 msgid "guestfs_is_socket"
13204 #: ../src/guestfs-actions.pod:3426
13208 " guestfs_is_socket (guestfs_h *g,\n"
13209 " const char *path);\n"
13215 #: ../src/guestfs-actions.pod:3430 ../fish/guestfish-actions.pod:2403
13217 "This returns C<true> if and only if there is a Unix domain socket with the "
13218 "given C<path> name."
13223 #: ../src/guestfs-actions.pod:3439
13224 msgid "guestfs_is_symlink"
13229 #: ../src/guestfs-actions.pod:3441
13233 " guestfs_is_symlink (guestfs_h *g,\n"
13234 " const char *path);\n"
13240 #: ../src/guestfs-actions.pod:3445 ../fish/guestfish-actions.pod:2412
13242 "This returns C<true> if and only if there is a symbolic link with the given "
13248 #: ../src/guestfs-actions.pod:3454
13249 msgid "guestfs_kill_subprocess"
13254 #: ../src/guestfs-actions.pod:3456
13258 " guestfs_kill_subprocess (guestfs_h *g);\n"
13264 #: ../src/guestfs-actions.pod:3459 ../fish/guestfish-actions.pod:2421
13265 msgid "This kills the qemu subprocess. You should never need to call this."
13270 #: ../src/guestfs-actions.pod:3465
13271 msgid "guestfs_launch"
13276 #: ../src/guestfs-actions.pod:3467
13280 " guestfs_launch (guestfs_h *g);\n"
13286 #: ../src/guestfs-actions.pod:3470 ../fish/guestfish-actions.pod:2429
13288 "Internally libguestfs is implemented by running a virtual machine using "
13294 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2432
13296 "You should call this after configuring the handle (eg. adding drives) but "
13297 "before performing any actions."
13302 #: ../src/guestfs-actions.pod:3485
13303 msgid "guestfs_lchown"
13308 #: ../src/guestfs-actions.pod:3487
13312 " guestfs_lchown (guestfs_h *g,\n"
13315 " const char *path);\n"
13321 #: ../src/guestfs-actions.pod:3493
13323 "Change the file owner to C<owner> and group to C<group>. This is like "
13324 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13325 "changed, not the target."
13330 #: ../src/guestfs-actions.pod:3505
13331 msgid "guestfs_lgetxattr"
13336 #: ../src/guestfs-actions.pod:3507
13340 " guestfs_lgetxattr (guestfs_h *g,\n"
13341 " const char *path,\n"
13342 " const char *name,\n"
13343 " size_t *size_r);\n"
13349 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2451
13351 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13352 "is a symlink, then this call returns an extended attribute from the symlink."
13357 #: ../src/guestfs-actions.pod:3527
13358 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13363 #: ../src/guestfs-actions.pod:3535
13364 msgid "guestfs_lgetxattrs"
13369 #: ../src/guestfs-actions.pod:3537
13372 " struct guestfs_xattr_list *\n"
13373 " guestfs_lgetxattrs (guestfs_h *g,\n"
13374 " const char *path);\n"
13380 #: ../src/guestfs-actions.pod:3541
13382 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13383 "then it returns the extended attributes of the link itself."
13388 #: ../src/guestfs-actions.pod:3551
13389 msgid "guestfs_list_devices"
13394 #: ../src/guestfs-actions.pod:3553
13398 " guestfs_list_devices (guestfs_h *g);\n"
13404 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
13405 msgid "List all the block devices."
13410 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2481
13411 msgid "The full block device names are returned, eg. C</dev/sda>."
13416 #: ../src/guestfs-actions.pod:3568
13417 msgid "guestfs_list_filesystems"
13422 #: ../src/guestfs-actions.pod:3570
13426 " guestfs_list_filesystems (guestfs_h *g);\n"
13432 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2489
13434 "This inspection command looks for filesystems on partitions, block devices "
13435 "and logical volumes, returning a list of devices containing filesystems and "
13441 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2493
13443 "The return value is a hash, where the keys are the devices containing "
13444 "filesystems, and the values are the filesystem types. For example:"
13449 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
13452 " \"/dev/sda1\" => \"ntfs\"\n"
13453 " \"/dev/sda2\" => \"ext2\"\n"
13454 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13455 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13461 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2502
13463 "The value can have the special value \"unknown\", meaning the content of the "
13464 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13469 #: ../src/guestfs-actions.pod:3590
13471 "This command runs other libguestfs commands, which might include "
13472 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13473 "soon after launch and only when nothing is mounted."
13478 #: ../src/guestfs-actions.pod:3594
13480 "Not all of the filesystems returned will be mountable. In particular, swap "
13481 "partitions are returned in the list. Also this command does not check that "
13482 "each filesystem found is valid and mountable, and some filesystems might be "
13483 "mountable but require special options. Filesystems may not all belong to a "
13484 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13489 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:5229
13490 msgid "(Added in 1.5.15)"
13495 #: ../src/guestfs-actions.pod:3610
13496 msgid "guestfs_list_partitions"
13501 #: ../src/guestfs-actions.pod:3612
13505 " guestfs_list_partitions (guestfs_h *g);\n"
13511 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
13512 msgid "List all the partitions detected on all block devices."
13517 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2524
13518 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13523 #: ../src/guestfs-actions.pod:3619
13525 "This does not return logical volumes. For that you will need to call "
13531 #: ../src/guestfs-actions.pod:3630
13537 #: ../src/guestfs-actions.pod:3632
13541 " guestfs_ll (guestfs_h *g,\n"
13542 " const char *directory);\n"
13548 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2535
13550 "List the files in C<directory> (relative to the root directory, there is no "
13551 "cwd) in the format of 'ls -la'."
13556 #: ../src/guestfs-actions.pod:3639 ../fish/guestfish-actions.pod:2538
13558 "This command is mostly useful for interactive sessions. It is I<not> "
13559 "intended that you try to parse the output string."
13564 #: ../src/guestfs-actions.pod:3647
13570 #: ../src/guestfs-actions.pod:3649
13574 " guestfs_ln (guestfs_h *g,\n"
13575 " const char *target,\n"
13576 " const char *linkname);\n"
13582 #: ../src/guestfs-actions.pod:3654 ../fish/guestfish-actions.pod:2545
13583 msgid "This command creates a hard link using the C<ln> command."
13588 #: ../src/guestfs-actions.pod:3660
13589 msgid "guestfs_ln_f"
13594 #: ../src/guestfs-actions.pod:3662
13598 " guestfs_ln_f (guestfs_h *g,\n"
13599 " const char *target,\n"
13600 " const char *linkname);\n"
13605 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2551
13607 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13608 "option removes the link (C<linkname>) if it exists already."
13613 #: ../src/guestfs-actions.pod:3674
13614 msgid "guestfs_ln_s"
13619 #: ../src/guestfs-actions.pod:3676
13623 " guestfs_ln_s (guestfs_h *g,\n"
13624 " const char *target,\n"
13625 " const char *linkname);\n"
13631 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2558
13632 msgid "This command creates a symbolic link using the C<ln -s> command."
13637 #: ../src/guestfs-actions.pod:3687
13638 msgid "guestfs_ln_sf"
13643 #: ../src/guestfs-actions.pod:3689
13647 " guestfs_ln_sf (guestfs_h *g,\n"
13648 " const char *target,\n"
13649 " const char *linkname);\n"
13654 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2564
13656 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13657 "option removes the link (C<linkname>) if it exists already."
13662 #: ../src/guestfs-actions.pod:3701
13663 msgid "guestfs_lremovexattr"
13668 #: ../src/guestfs-actions.pod:3703
13672 " guestfs_lremovexattr (guestfs_h *g,\n"
13673 " const char *xattr,\n"
13674 " const char *path);\n"
13680 #: ../src/guestfs-actions.pod:3708
13682 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13683 "link, then it removes an extended attribute of the link itself."
13688 #: ../src/guestfs-actions.pod:3716
13694 #: ../src/guestfs-actions.pod:3718
13698 " guestfs_ls (guestfs_h *g,\n"
13699 " const char *directory);\n"
13705 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2579
13707 "List the files in C<directory> (relative to the root directory, there is no "
13708 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13713 #: ../src/guestfs-actions.pod:3726
13715 "This command is mostly useful for interactive sessions. Programs should "
13716 "probably use C<guestfs_readdir> instead."
13721 #: ../src/guestfs-actions.pod:3735
13722 msgid "guestfs_lsetxattr"
13727 #: ../src/guestfs-actions.pod:3737
13731 " guestfs_lsetxattr (guestfs_h *g,\n"
13732 " const char *xattr,\n"
13733 " const char *val,\n"
13735 " const char *path);\n"
13741 #: ../src/guestfs-actions.pod:3744
13743 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13744 "then it sets an extended attribute of the link itself."
13749 #: ../src/guestfs-actions.pod:3752
13750 msgid "guestfs_lstat"
13755 #: ../src/guestfs-actions.pod:3754
13758 " struct guestfs_stat *\n"
13759 " guestfs_lstat (guestfs_h *g,\n"
13760 " const char *path);\n"
13766 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:6360
13767 #: ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:4311
13768 msgid "Returns file information for the given C<path>."
13773 #: ../src/guestfs-actions.pod:3760
13775 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13776 "link, then the link is stat-ed, not the file it refers to."
13781 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2604
13782 msgid "This is the same as the C<lstat(2)> system call."
13787 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:6364
13789 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13790 "error. I<The caller must call C<guestfs_free_stat> after use>."
13795 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6368
13796 #: ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6767
13797 msgid "(Added in 0.9.2)"
13802 #: ../src/guestfs-actions.pod:3772
13803 msgid "guestfs_lstatlist"
13808 #: ../src/guestfs-actions.pod:3774
13811 " struct guestfs_stat_list *\n"
13812 " guestfs_lstatlist (guestfs_h *g,\n"
13813 " const char *path,\n"
13814 " char *const *names);\n"
13820 #: ../src/guestfs-actions.pod:3779
13822 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13823 "files, where all files are in the directory C<path>. C<names> is the list "
13824 "of files from this directory."
13829 #: ../src/guestfs-actions.pod:3783 ../fish/guestfish-actions.pod:2614
13831 "On return you get a list of stat structs, with a one-to-one correspondence "
13832 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13833 "then the C<ino> field of that structure is set to C<-1>."
13838 #: ../src/guestfs-actions.pod:3788
13840 "This call is intended for programs that want to efficiently list a directory "
13841 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13842 "for a similarly efficient call for getting extended attributes. Very long "
13843 "directory listings might cause the protocol message size to be exceeded, "
13844 "causing this call to fail. The caller must split up such requests into "
13845 "smaller groups of names."
13850 #: ../src/guestfs-actions.pod:3796
13852 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13853 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13858 #: ../src/guestfs-actions.pod:3802
13859 msgid "guestfs_luks_add_key"
13864 #: ../src/guestfs-actions.pod:3804
13868 " guestfs_luks_add_key (guestfs_h *g,\n"
13869 " const char *device,\n"
13870 " const char *key,\n"
13871 " const char *newkey,\n"
13878 #: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2631
13880 "This command adds a new key on LUKS device C<device>. C<key> is any "
13881 "existing key, and is used to access the device. C<newkey> is the new key to "
13882 "add. C<keyslot> is the key slot that will be replaced."
13887 #: ../src/guestfs-actions.pod:3816
13889 "Note that if C<keyslot> already contains a key, then this command will "
13890 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13895 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3862
13896 #: ../src/guestfs-actions.pod:3885 ../src/guestfs-actions.pod:3905
13897 #: ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3956
13899 "This function takes a key or passphrase parameter which could contain "
13900 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13906 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
13907 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
13908 msgid "(Added in 1.5.2)"
13913 #: ../src/guestfs-actions.pod:3828
13914 msgid "guestfs_luks_close"
13919 #: ../src/guestfs-actions.pod:3830
13923 " guestfs_luks_close (guestfs_h *g,\n"
13924 " const char *device);\n"
13930 #: ../src/guestfs-actions.pod:3834
13932 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13933 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13934 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13935 "underlying block device."
13940 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3941
13941 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:4010
13942 #: ../src/guestfs-actions.pod:4058
13943 msgid "(Added in 1.5.1)"
13948 #: ../src/guestfs-actions.pod:3844
13949 msgid "guestfs_luks_format"
13954 #: ../src/guestfs-actions.pod:3846
13958 " guestfs_luks_format (guestfs_h *g,\n"
13959 " const char *device,\n"
13960 " const char *key,\n"
13967 #: ../src/guestfs-actions.pod:3852 ../fish/guestfish-actions.pod:2657
13969 "This command erases existing data on C<device> and formats the device as a "
13970 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13971 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13976 #: ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3882
13977 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4980
13978 #: ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:6167
13979 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6230
13980 #: ../src/guestfs-actions.pod:7411 ../fish/guestfish-actions.pod:2665
13981 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2762
13982 #: ../fish/guestfish-actions.pod:3352 ../fish/guestfish-actions.pod:3872
13983 #: ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4205
13984 #: ../fish/guestfish-actions.pod:4227 ../fish/guestfish-actions.pod:4956
13986 "B<This command is dangerous. Without careful use you can easily destroy all "
13992 #: ../src/guestfs-actions.pod:3868
13993 msgid "guestfs_luks_format_cipher"
13998 #: ../src/guestfs-actions.pod:3870
14002 " guestfs_luks_format_cipher (guestfs_h *g,\n"
14003 " const char *device,\n"
14004 " const char *key,\n"
14006 " const char *cipher);\n"
14012 #: ../src/guestfs-actions.pod:3877
14014 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14015 "set the C<cipher> used."
14020 #: ../src/guestfs-actions.pod:3891
14021 msgid "guestfs_luks_kill_slot"
14026 #: ../src/guestfs-actions.pod:3893
14030 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14031 " const char *device,\n"
14032 " const char *key,\n"
14039 #: ../src/guestfs-actions.pod:3899 ../fish/guestfish-actions.pod:2685
14041 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14042 "device C<device>. C<key> must be one of the I<other> keys."
14047 #: ../src/guestfs-actions.pod:3911
14048 msgid "guestfs_luks_open"
14053 #: ../src/guestfs-actions.pod:3913
14057 " guestfs_luks_open (guestfs_h *g,\n"
14058 " const char *device,\n"
14059 " const char *key,\n"
14060 " const char *mapname);\n"
14066 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
14068 "This command opens a block device which has been encrypted according to the "
14069 "Linux Unified Key Setup (LUKS) standard."
14074 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
14075 msgid "C<device> is the encrypted block device or partition."
14080 #: ../src/guestfs-actions.pod:3924 ../fish/guestfish-actions.pod:2701
14082 "The caller must supply one of the keys associated with the LUKS block "
14083 "device, in the C<key> parameter."
14088 #: ../src/guestfs-actions.pod:3927 ../fish/guestfish-actions.pod:2704
14090 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14091 "writes to this block device are decrypted from and encrypted to the "
14092 "underlying C<device> respectively."
14097 #: ../src/guestfs-actions.pod:3931
14099 "If this block device contains LVM volume groups, then calling "
14100 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14106 #: ../src/guestfs-actions.pod:3943
14107 msgid "guestfs_luks_open_ro"
14112 #: ../src/guestfs-actions.pod:3945
14116 " guestfs_luks_open_ro (guestfs_h *g,\n"
14117 " const char *device,\n"
14118 " const char *key,\n"
14119 " const char *mapname);\n"
14125 #: ../src/guestfs-actions.pod:3951
14127 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14133 #: ../src/guestfs-actions.pod:3962
14134 msgid "guestfs_lvcreate"
14139 #: ../src/guestfs-actions.pod:3964
14143 " guestfs_lvcreate (guestfs_h *g,\n"
14144 " const char *logvol,\n"
14145 " const char *volgroup,\n"
14152 #: ../src/guestfs-actions.pod:3970 ../fish/guestfish-actions.pod:2729
14154 "This creates an LVM logical volume called C<logvol> on the volume group "
14155 "C<volgroup>, with C<size> megabytes."
14160 #: ../src/guestfs-actions.pod:3977
14161 msgid "guestfs_lvm_canonical_lv_name"
14166 #: ../src/guestfs-actions.pod:3979
14170 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14171 " const char *lvname);\n"
14177 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2736
14179 "This converts alternative naming schemes for LVs that you might find to the "
14180 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14186 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2740
14188 "This command returns an error if the C<lvname> parameter does not refer to a "
14194 #: ../src/guestfs-actions.pod:3990
14195 msgid "See also C<guestfs_is_lv>."
14200 #: ../src/guestfs-actions.pod:3995
14201 msgid "(Added in 1.5.24)"
14206 #: ../src/guestfs-actions.pod:3997
14207 msgid "guestfs_lvm_clear_filter"
14212 #: ../src/guestfs-actions.pod:3999
14216 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14222 #: ../src/guestfs-actions.pod:4002
14224 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14225 "see every block device."
14230 #: ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4047
14231 #: ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2783
14233 "This command also clears the LVM cache and performs a volume group scan."
14238 #: ../src/guestfs-actions.pod:4012
14239 msgid "guestfs_lvm_remove_all"
14244 #: ../src/guestfs-actions.pod:4014
14248 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14254 #: ../src/guestfs-actions.pod:4017 ../fish/guestfish-actions.pod:2759
14256 "This command removes all LVM logical volumes, volume groups and physical "
14262 #: ../src/guestfs-actions.pod:4027
14263 msgid "guestfs_lvm_set_filter"
14268 #: ../src/guestfs-actions.pod:4029
14272 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14273 " char *const *devices);\n"
14279 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2769
14281 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14282 "block devices in the list C<devices>, and will ignore all other attached "
14288 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2773
14290 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14291 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14292 "there are two types of duplication possible: either cloned PVs/VGs which "
14293 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14294 "same name. In normal operation you cannot create this situation, but you "
14295 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14296 "inside the LVM metadata."
14301 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
14302 msgid "You can filter whole block devices or individual partitions."
14307 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:2788
14309 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14310 "filesystem), even if you are not filtering out that VG."
14315 #: ../src/guestfs-actions.pod:4060
14316 msgid "guestfs_lvremove"
14321 #: ../src/guestfs-actions.pod:4062
14325 " guestfs_lvremove (guestfs_h *g,\n"
14326 " const char *device);\n"
14332 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:2796
14334 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14335 "LV, such as C</dev/VG/LV>."
14340 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2799
14342 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14348 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:5326
14349 #: ../src/guestfs-actions.pod:7143
14350 msgid "(Added in 1.0.13)"
14355 #: ../src/guestfs-actions.pod:4076
14356 msgid "guestfs_lvrename"
14361 #: ../src/guestfs-actions.pod:4078
14365 " guestfs_lvrename (guestfs_h *g,\n"
14366 " const char *logvol,\n"
14367 " const char *newlogvol);\n"
14373 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2806
14374 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14379 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:7156
14380 msgid "(Added in 1.0.83)"
14385 #: ../src/guestfs-actions.pod:4089
14386 msgid "guestfs_lvresize"
14391 #: ../src/guestfs-actions.pod:4091
14395 " guestfs_lvresize (guestfs_h *g,\n"
14396 " const char *device,\n"
14403 #: ../src/guestfs-actions.pod:4096 ../fish/guestfish-actions.pod:2812
14405 "This resizes (expands or shrinks) an existing LVM logical volume to "
14406 "C<mbytes>. When reducing, data in the reduced part is lost."
14411 #: ../src/guestfs-actions.pod:4104
14412 msgid "guestfs_lvresize_free"
14417 #: ../src/guestfs-actions.pod:4106
14421 " guestfs_lvresize_free (guestfs_h *g,\n"
14422 " const char *lv,\n"
14429 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2820
14431 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14432 "remaining free space in the volume group. Commonly you would call this with "
14433 "pc = 100 which expands the logical volume as much as possible, using all "
14434 "remaining free space in the volume group."
14439 #: ../src/guestfs-actions.pod:4119
14440 msgid "(Added in 1.3.3)"
14445 #: ../src/guestfs-actions.pod:4121
14446 msgid "guestfs_lvs"
14451 #: ../src/guestfs-actions.pod:4123
14455 " guestfs_lvs (guestfs_h *g);\n"
14461 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2830
14463 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14469 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2833
14471 "This returns a list of the logical volume device names (eg. C</dev/"
14472 "VolGroup00/LogVol00>)."
14477 #: ../src/guestfs-actions.pod:4132
14478 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14483 #: ../src/guestfs-actions.pod:4140
14484 msgid "guestfs_lvs_full"
14489 #: ../src/guestfs-actions.pod:4142
14492 " struct guestfs_lvm_lv_list *\n"
14493 " guestfs_lvs_full (guestfs_h *g);\n"
14499 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2842
14501 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14502 "(8)> command. The \"full\" version includes all fields."
14507 #: ../src/guestfs-actions.pod:4148
14509 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14510 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14515 #: ../src/guestfs-actions.pod:4154
14516 msgid "guestfs_lvuuid"
14521 #: ../src/guestfs-actions.pod:4156
14525 " guestfs_lvuuid (guestfs_h *g,\n"
14526 " const char *device);\n"
14532 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2849
14533 msgid "This command returns the UUID of the LVM LV C<device>."
14538 #: ../src/guestfs-actions.pod:4167
14539 msgid "guestfs_lxattrlist"
14544 #: ../src/guestfs-actions.pod:4169
14547 " struct guestfs_xattr_list *\n"
14548 " guestfs_lxattrlist (guestfs_h *g,\n"
14549 " const char *path,\n"
14550 " char *const *names);\n"
14556 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2855
14558 "This call allows you to get the extended attributes of multiple files, where "
14559 "all files are in the directory C<path>. C<names> is the list of files from "
14565 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2859
14567 "On return you get a flat list of xattr structs which must be interpreted "
14568 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14569 "C<attrval> in this struct is zero-length to indicate there was an error "
14570 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14571 "number (the number of following attributes for this file, which could be C<"
14572 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14573 "for the first named file. This repeats for the second and subsequent files."
14578 #: ../src/guestfs-actions.pod:4188
14580 "This call is intended for programs that want to efficiently list a directory "
14581 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14582 "a similarly efficient call for getting standard stats. Very long directory "
14583 "listings might cause the protocol message size to be exceeded, causing this "
14584 "call to fail. The caller must split up such requests into smaller groups of "
14590 #: ../src/guestfs-actions.pod:4202
14591 msgid "guestfs_mkdir"
14596 #: ../src/guestfs-actions.pod:4204
14600 " guestfs_mkdir (guestfs_h *g,\n"
14601 " const char *path);\n"
14607 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2881
14608 msgid "Create a directory named C<path>."
14613 #: ../src/guestfs-actions.pod:4214
14614 msgid "guestfs_mkdir_mode"
14619 #: ../src/guestfs-actions.pod:4216
14623 " guestfs_mkdir_mode (guestfs_h *g,\n"
14624 " const char *path,\n"
14631 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2887
14633 "This command creates a directory, setting the initial permissions of the "
14634 "directory to C<mode>."
14639 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:2890
14641 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14642 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14648 #: ../src/guestfs-actions.pod:4228
14649 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14654 #: ../src/guestfs-actions.pod:4234
14655 msgid "guestfs_mkdir_p"
14660 #: ../src/guestfs-actions.pod:4236
14664 " guestfs_mkdir_p (guestfs_h *g,\n"
14665 " const char *path);\n"
14671 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2900
14673 "Create a directory named C<path>, creating any parent directories as "
14674 "necessary. This is like the C<mkdir -p> shell command."
14679 #: ../src/guestfs-actions.pod:4247
14680 msgid "guestfs_mkdtemp"
14685 #: ../src/guestfs-actions.pod:4249
14689 " guestfs_mkdtemp (guestfs_h *g,\n"
14690 " const char *template);\n"
14696 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
14698 "This command creates a temporary directory. The C<template> parameter "
14699 "should be a full pathname for the temporary directory name with the final "
14700 "six characters being \"XXXXXX\"."
14705 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2912
14707 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14708 "being suitable for Windows filesystems."
14713 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2915
14714 msgid "The name of the temporary directory that was created is returned."
14719 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2918
14720 msgid "The temporary directory is created with mode 0700 and is owned by root."
14725 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2921
14727 "The caller is responsible for deleting the temporary directory and its "
14728 "contents after use."
14733 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2924
14734 msgid "See also: L<mkdtemp(3)>"
14739 #: ../src/guestfs-actions.pod:4277
14740 msgid "guestfs_mke2fs_J"
14745 #: ../src/guestfs-actions.pod:4279
14749 " guestfs_mke2fs_J (guestfs_h *g,\n"
14750 " const char *fstype,\n"
14751 " int blocksize,\n"
14752 " const char *device,\n"
14753 " const char *journal);\n"
14759 #: ../src/guestfs-actions.pod:4286 ../fish/guestfish-actions.pod:2930
14761 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14762 "C<journal>. It is equivalent to the command:"
14767 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2934
14770 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14776 #: ../src/guestfs-actions.pod:4292
14777 msgid "See also C<guestfs_mke2journal>."
14782 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4314
14783 #: ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4348
14784 #: ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:4376
14785 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:4700
14786 msgid "(Added in 1.0.68)"
14791 #: ../src/guestfs-actions.pod:4298
14792 msgid "guestfs_mke2fs_JL"
14797 #: ../src/guestfs-actions.pod:4300
14801 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14802 " const char *fstype,\n"
14803 " int blocksize,\n"
14804 " const char *device,\n"
14805 " const char *label);\n"
14811 #: ../src/guestfs-actions.pod:4307 ../fish/guestfish-actions.pod:2942
14813 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14814 "the journal labeled C<label>."
14819 #: ../src/guestfs-actions.pod:4310
14820 msgid "See also C<guestfs_mke2journal_L>."
14825 #: ../src/guestfs-actions.pod:4316
14826 msgid "guestfs_mke2fs_JU"
14831 #: ../src/guestfs-actions.pod:4318
14835 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14836 " const char *fstype,\n"
14837 " int blocksize,\n"
14838 " const char *device,\n"
14839 " const char *uuid);\n"
14845 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2951
14847 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14848 "the journal with UUID C<uuid>."
14853 #: ../src/guestfs-actions.pod:4328
14854 msgid "See also C<guestfs_mke2journal_U>."
14859 #: ../src/guestfs-actions.pod:4334
14860 msgid "guestfs_mke2journal"
14865 #: ../src/guestfs-actions.pod:4336
14869 " guestfs_mke2journal (guestfs_h *g,\n"
14870 " int blocksize,\n"
14871 " const char *device);\n"
14877 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2960
14879 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14885 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2963
14888 " mke2fs -O journal_dev -b blocksize device\n"
14894 #: ../src/guestfs-actions.pod:4350
14895 msgid "guestfs_mke2journal_L"
14900 #: ../src/guestfs-actions.pod:4352
14904 " guestfs_mke2journal_L (guestfs_h *g,\n"
14905 " int blocksize,\n"
14906 " const char *label,\n"
14907 " const char *device);\n"
14913 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2969
14914 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14919 #: ../src/guestfs-actions.pod:4364
14920 msgid "guestfs_mke2journal_U"
14925 #: ../src/guestfs-actions.pod:4366
14929 " guestfs_mke2journal_U (guestfs_h *g,\n"
14930 " int blocksize,\n"
14931 " const char *uuid,\n"
14932 " const char *device);\n"
14938 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:2975
14939 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14944 #: ../src/guestfs-actions.pod:4378
14945 msgid "guestfs_mkfifo"
14950 #: ../src/guestfs-actions.pod:4380
14954 " guestfs_mkfifo (guestfs_h *g,\n"
14956 " const char *path);\n"
14962 #: ../src/guestfs-actions.pod:4385
14964 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14965 "is just a convenient wrapper around C<guestfs_mknod>."
14970 #: ../src/guestfs-actions.pod:4395
14971 msgid "guestfs_mkfs"
14976 #: ../src/guestfs-actions.pod:4397
14980 " guestfs_mkfs (guestfs_h *g,\n"
14981 " const char *fstype,\n"
14982 " const char *device);\n"
14988 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:2991
14990 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14991 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14996 #: ../src/guestfs-actions.pod:4410
14997 msgid "guestfs_mkfs_b"
15002 #: ../src/guestfs-actions.pod:4412
15006 " guestfs_mkfs_b (guestfs_h *g,\n"
15007 " const char *fstype,\n"
15008 " int blocksize,\n"
15009 " const char *device);\n"
15015 #: ../src/guestfs-actions.pod:4418
15017 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15018 "block size of the resulting filesystem. Supported block sizes depend on the "
15019 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15024 #: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:4466
15025 #: ../fish/guestfish-actions.pod:3004 ../fish/guestfish-actions.pod:3031
15027 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15032 #: ../src/guestfs-actions.pod:4428
15034 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
15040 #: ../src/guestfs-actions.pod:4437
15041 msgid "guestfs_mkfs_opts"
15046 #: ../src/guestfs-actions.pod:4439
15050 " guestfs_mkfs_opts (guestfs_h *g,\n"
15051 " const char *fstype,\n"
15052 " const char *device,\n"
15058 #: ../src/guestfs-actions.pod:4450
15061 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15062 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15068 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:3018
15070 "This function creates a filesystem on C<device>. The filesystem type is "
15071 "C<fstype>, for example C<ext3>."
15076 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
15077 msgid "C<blocksize>"
15082 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:3027
15084 "The filesystem block size. Supported block sizes depend on the filesystem "
15085 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15090 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
15091 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15095 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
15096 msgid "C<features>"
15100 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
15101 msgid "This passes the I<-O> parameter to the external mkfs program."
15105 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3040
15107 "For certain filesystem types, this allows extra filesystem features to be "
15108 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15112 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3044
15114 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15119 #: ../src/guestfs-actions.pod:4486
15120 msgid "(Added in 1.7.19)"
15125 #: ../src/guestfs-actions.pod:4488
15126 msgid "guestfs_mkfs_opts_va"
15131 #: ../src/guestfs-actions.pod:4490
15135 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15136 " const char *fstype,\n"
15137 " const char *device,\n"
15138 " va_list args);\n"
15144 #: ../src/guestfs-actions.pod:4496
15145 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15150 #: ../src/guestfs-actions.pod:4500
15151 msgid "guestfs_mkfs_opts_argv"
15156 #: ../src/guestfs-actions.pod:4502
15160 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15161 " const char *fstype,\n"
15162 " const char *device,\n"
15163 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15169 #: ../src/guestfs-actions.pod:4508
15170 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15175 #: ../src/guestfs-actions.pod:4512
15176 msgid "guestfs_mkmountpoint"
15181 #: ../src/guestfs-actions.pod:4514
15185 " guestfs_mkmountpoint (guestfs_h *g,\n"
15186 " const char *exemptpath);\n"
15192 #: ../src/guestfs-actions.pod:4518
15194 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15195 "that can be used to create extra mountpoints before mounting the first "
15201 #: ../src/guestfs-actions.pod:4522 ../fish/guestfish-actions.pod:3059
15203 "These calls are I<only> necessary in some very limited circumstances, mainly "
15204 "the case where you want to mount a mix of unrelated and/or read-only "
15205 "filesystems together."
15210 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
15212 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15213 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15214 "inside that. You can unpack this as follows in guestfish:"
15219 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3068
15222 " add-ro Fedora-11-i686-Live.iso\n"
15224 " mkmountpoint /cd\n"
15225 " mkmountpoint /sqsh\n"
15226 " mkmountpoint /ext3fs\n"
15227 " mount /dev/sda /cd\n"
15228 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15229 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15235 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3077
15236 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15241 #: ../src/guestfs-actions.pod:4542
15243 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15244 "may get unexpected errors if you try to mix these calls. It is safest to "
15245 "manually unmount filesystems and remove mountpoints after use."
15250 #: ../src/guestfs-actions.pod:4546
15252 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15253 "first, so for this to work for manual mountpoints, you must ensure that the "
15254 "innermost mountpoints have the longest pathnames, as in the example code "
15260 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3088
15262 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15266 #: ../src/guestfs-actions.pod:4553
15268 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15269 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15270 "can also trigger these issues."
15275 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4825
15276 #: ../src/guestfs-actions.pod:5744
15277 msgid "(Added in 1.0.62)"
15282 #: ../src/guestfs-actions.pod:4561
15283 msgid "guestfs_mknod"
15288 #: ../src/guestfs-actions.pod:4563
15292 " guestfs_mknod (guestfs_h *g,\n"
15296 " const char *path);\n"
15302 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3098
15304 "This call creates block or character special devices, or named pipes (FIFOs)."
15309 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3101
15311 "The C<mode> parameter should be the mode, using the standard constants. "
15312 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15313 "used when creating block and character special devices."
15318 #: ../src/guestfs-actions.pod:4578
15320 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15321 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15322 "regular file). These constants are available in the standard Linux header "
15323 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15324 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15325 "the appropriate constant for you."
15330 #: ../src/guestfs-actions.pod:4592
15331 msgid "guestfs_mknod_b"
15336 #: ../src/guestfs-actions.pod:4594
15340 " guestfs_mknod_b (guestfs_h *g,\n"
15344 " const char *path);\n"
15350 #: ../src/guestfs-actions.pod:4601
15352 "This call creates a block device node called C<path> with mode C<mode> and "
15353 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15354 "wrapper around C<guestfs_mknod>."
15359 #: ../src/guestfs-actions.pod:4611
15360 msgid "guestfs_mknod_c"
15365 #: ../src/guestfs-actions.pod:4613
15369 " guestfs_mknod_c (guestfs_h *g,\n"
15373 " const char *path);\n"
15379 #: ../src/guestfs-actions.pod:4620
15381 "This call creates a char device node called C<path> with mode C<mode> and "
15382 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15383 "wrapper around C<guestfs_mknod>."
15388 #: ../src/guestfs-actions.pod:4630
15389 msgid "guestfs_mkswap"
15394 #: ../src/guestfs-actions.pod:4632
15398 " guestfs_mkswap (guestfs_h *g,\n"
15399 " const char *device);\n"
15405 #: ../src/guestfs-actions.pod:4636 ../fish/guestfish-actions.pod:3140
15406 msgid "Create a swap partition on C<device>."
15411 #: ../src/guestfs-actions.pod:4642
15412 msgid "guestfs_mkswap_L"
15417 #: ../src/guestfs-actions.pod:4644
15421 " guestfs_mkswap_L (guestfs_h *g,\n"
15422 " const char *label,\n"
15423 " const char *device);\n"
15429 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
15430 msgid "Create a swap partition on C<device> with label C<label>."
15435 #: ../src/guestfs-actions.pod:4651 ../fish/guestfish-actions.pod:3148
15437 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15438 "sda>), just to a partition. This appears to be a limitation of the kernel "
15444 #: ../src/guestfs-actions.pod:4659
15445 msgid "guestfs_mkswap_U"
15450 #: ../src/guestfs-actions.pod:4661
15454 " guestfs_mkswap_U (guestfs_h *g,\n"
15455 " const char *uuid,\n"
15456 " const char *device);\n"
15462 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3156
15463 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15468 #: ../src/guestfs-actions.pod:4672
15469 msgid "guestfs_mkswap_file"
15474 #: ../src/guestfs-actions.pod:4674
15478 " guestfs_mkswap_file (guestfs_h *g,\n"
15479 " const char *path);\n"
15485 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3162
15486 msgid "Create a swap file."
15491 #: ../src/guestfs-actions.pod:4680
15493 "This command just writes a swap file signature to an existing file. To "
15494 "create the file itself, use something like C<guestfs_fallocate>."
15499 #: ../src/guestfs-actions.pod:4687
15500 msgid "guestfs_modprobe"
15505 #: ../src/guestfs-actions.pod:4689
15509 " guestfs_modprobe (guestfs_h *g,\n"
15510 " const char *modulename);\n"
15516 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
15517 msgid "This loads a kernel module in the appliance."
15522 #: ../src/guestfs-actions.pod:4695 ../fish/guestfish-actions.pod:3173
15524 "The kernel module must have been whitelisted when libguestfs was built (see "
15525 "C<appliance/kmod.whitelist.in> in the source)."
15530 #: ../src/guestfs-actions.pod:4702
15531 msgid "guestfs_mount"
15536 #: ../src/guestfs-actions.pod:4704
15540 " guestfs_mount (guestfs_h *g,\n"
15541 " const char *device,\n"
15542 " const char *mountpoint);\n"
15548 #: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3180
15550 "Mount a guest disk at a position in the filesystem. Block devices are named "
15551 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15552 "those block devices contain partitions, they will have the usual names (eg. "
15553 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15558 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
15560 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15561 "mounted on C</> before others can be mounted. Other filesystems can only be "
15562 "mounted on directories which already exist."
15567 #: ../src/guestfs-actions.pod:4720 ../fish/guestfish-actions.pod:3191
15569 "The mounted filesystem is writable, if we have sufficient permissions on the "
15570 "underlying device."
15575 #: ../src/guestfs-actions.pod:4723
15577 "B<Important note:> When you use this call, the filesystem options C<sync> "
15578 "and C<noatime> are set implicitly. This was originally done because we "
15579 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15580 "very large negative performance impact and negligible effect on "
15581 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15582 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15583 "(use an empty string for the first parameter if you don't want any options)."
15587 #: ../src/guestfs-actions.pod:4735
15589 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
15595 #: ../src/guestfs-actions.pod:4744
15596 msgid "guestfs_mount_loop"
15601 #: ../src/guestfs-actions.pod:4746
15605 " guestfs_mount_loop (guestfs_h *g,\n"
15606 " const char *file,\n"
15607 " const char *mountpoint);\n"
15613 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3215
15615 "This command lets you mount C<file> (a filesystem image in a file) on a "
15616 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15622 #: ../src/guestfs-actions.pod:4759
15623 msgid "guestfs_mount_options"
15628 #: ../src/guestfs-actions.pod:4761
15632 " guestfs_mount_options (guestfs_h *g,\n"
15633 " const char *options,\n"
15634 " const char *device,\n"
15635 " const char *mountpoint);\n"
15641 #: ../src/guestfs-actions.pod:4767
15643 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15644 "the mount options as for the L<mount(8)> I<-o> flag."
15649 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3227
15651 "If the C<options> parameter is an empty string, then no options are passed "
15652 "(all options default to whatever the filesystem uses)."
15657 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4791
15658 #: ../src/guestfs-actions.pod:4808
15659 msgid "(Added in 1.0.10)"
15664 #: ../src/guestfs-actions.pod:4779
15665 msgid "guestfs_mount_ro"
15670 #: ../src/guestfs-actions.pod:4781
15674 " guestfs_mount_ro (guestfs_h *g,\n"
15675 " const char *device,\n"
15676 " const char *mountpoint);\n"
15682 #: ../src/guestfs-actions.pod:4786
15684 "This is the same as the C<guestfs_mount> command, but it mounts the "
15685 "filesystem with the read-only (I<-o ro>) flag."
15690 #: ../src/guestfs-actions.pod:4793
15691 msgid "guestfs_mount_vfs"
15696 #: ../src/guestfs-actions.pod:4795
15700 " guestfs_mount_vfs (guestfs_h *g,\n"
15701 " const char *options,\n"
15702 " const char *vfstype,\n"
15703 " const char *device,\n"
15704 " const char *mountpoint);\n"
15710 #: ../src/guestfs-actions.pod:4802
15712 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15713 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15719 #: ../src/guestfs-actions.pod:4810
15720 msgid "guestfs_mountpoints"
15725 #: ../src/guestfs-actions.pod:4812
15729 " guestfs_mountpoints (guestfs_h *g);\n"
15735 #: ../src/guestfs-actions.pod:4815
15737 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15738 "devices. This one returns a hash table (map) of device name to directory "
15739 "where the device is mounted."
15744 #: ../src/guestfs-actions.pod:4827
15745 msgid "guestfs_mounts"
15750 #: ../src/guestfs-actions.pod:4829
15754 " guestfs_mounts (guestfs_h *g);\n"
15760 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3258
15762 "This returns the list of currently mounted filesystems. It returns the list "
15763 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15768 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3261
15769 msgid "Some internal mounts are not shown."
15774 #: ../src/guestfs-actions.pod:4837
15775 msgid "See also: C<guestfs_mountpoints>"
15780 #: ../src/guestfs-actions.pod:4845
15786 #: ../src/guestfs-actions.pod:4847
15790 " guestfs_mv (guestfs_h *g,\n"
15791 " const char *src,\n"
15792 " const char *dest);\n"
15798 #: ../src/guestfs-actions.pod:4852 ../fish/guestfish-actions.pod:3269
15800 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15801 "destination filename or destination directory."
15806 #: ../src/guestfs-actions.pod:4859
15807 msgid "guestfs_ntfs_3g_probe"
15812 #: ../src/guestfs-actions.pod:4861
15816 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15818 " const char *device);\n"
15824 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3276
15826 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15827 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15828 "write, and some cannot be mounted at all)."
15833 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3280
15835 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15836 "can be mounted read-write. Set it to false if you want to test if the "
15837 "volume can be mounted read-only."
15842 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3284
15844 "The return value is an integer which C<0> if the operation would succeed, or "
15845 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15850 #: ../src/guestfs-actions.pod:4880
15851 msgid "(Added in 1.0.43)"
15856 #: ../src/guestfs-actions.pod:4882
15857 msgid "guestfs_ntfsresize"
15862 #: ../src/guestfs-actions.pod:4884
15866 " guestfs_ntfsresize (guestfs_h *g,\n"
15867 " const char *device);\n"
15872 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3292
15874 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15875 "size of the underlying device."
15879 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3295
15881 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
15882 "consistency check (for safety). You have to boot into Windows to perform "
15883 "this check and clear this condition. Furthermore, ntfsresize refuses to "
15884 "resize filesystems which have been marked in this way. So in effect it is "
15885 "not possible to call ntfsresize multiple times on a single filesystem "
15886 "without booting into Windows between each resize."
15890 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3303
15891 msgid "See also L<ntfsresize(8)>."
15896 #: ../src/guestfs-actions.pod:4905
15897 msgid "guestfs_ntfsresize_size"
15902 #: ../src/guestfs-actions.pod:4907
15906 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15907 " const char *device,\n"
15908 " int64_t size);\n"
15914 #: ../src/guestfs-actions.pod:4912
15916 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15917 "to specify the new size (in bytes) explicitly."
15922 #: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:5353
15923 #: ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5692
15924 #: ../src/guestfs-actions.pod:7298
15925 msgid "(Added in 1.3.14)"
15930 #: ../src/guestfs-actions.pod:4919
15931 msgid "guestfs_part_add"
15936 #: ../src/guestfs-actions.pod:4921
15940 " guestfs_part_add (guestfs_h *g,\n"
15941 " const char *device,\n"
15942 " const char *prlogex,\n"
15943 " int64_t startsect,\n"
15944 " int64_t endsect);\n"
15950 #: ../src/guestfs-actions.pod:4928
15952 "This command adds a partition to C<device>. If there is no partition table "
15953 "on the device, call C<guestfs_part_init> first."
15958 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
15960 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15961 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15962 "C<logical>) and C<e> (or C<extended>) partition types."
15967 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3324
15969 "C<startsect> and C<endsect> are the start and end of the partition in "
15970 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15971 "from the end of the disk (C<-1> is the last sector)."
15976 #: ../src/guestfs-actions.pod:4940
15978 "Creating a partition which covers the whole disk is not so easy. Use "
15979 "C<guestfs_part_disk> to do that."
15984 #: ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:4983
15985 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5114
15986 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5171
15987 #: ../src/guestfs-actions.pod:5211
15988 msgid "(Added in 1.0.78)"
15993 #: ../src/guestfs-actions.pod:4947
15994 msgid "guestfs_part_del"
15999 #: ../src/guestfs-actions.pod:4949
16003 " guestfs_part_del (guestfs_h *g,\n"
16004 " const char *device,\n"
16011 #: ../src/guestfs-actions.pod:4954 ../fish/guestfish-actions.pod:3335
16012 msgid "This command deletes the partition numbered C<partnum> on C<device>."
16017 #: ../src/guestfs-actions.pod:4956 ../fish/guestfish-actions.pod:3337
16019 "Note that in the case of MBR partitioning, deleting an extended partition "
16020 "also deletes any logical partitions it contains."
16025 #: ../src/guestfs-actions.pod:4964
16026 msgid "guestfs_part_disk"
16031 #: ../src/guestfs-actions.pod:4966
16035 " guestfs_part_disk (guestfs_h *g,\n"
16036 " const char *device,\n"
16037 " const char *parttype);\n"
16043 #: ../src/guestfs-actions.pod:4971
16045 "This command is simply a combination of C<guestfs_part_init> followed by "
16046 "C<guestfs_part_add> to create a single primary partition covering the whole "
16052 #: ../src/guestfs-actions.pod:4975
16054 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16055 "possible values are described in C<guestfs_part_init>."
16060 #: ../src/guestfs-actions.pod:4985
16061 msgid "guestfs_part_get_bootable"
16066 #: ../src/guestfs-actions.pod:4987
16070 " guestfs_part_get_bootable (guestfs_h *g,\n"
16071 " const char *device,\n"
16078 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3359
16080 "This command returns true if the partition C<partnum> on C<device> has the "
16081 "bootable flag set."
16086 #: ../src/guestfs-actions.pod:4995
16087 msgid "See also C<guestfs_part_set_bootable>."
16092 #: ../src/guestfs-actions.pod:5001
16093 msgid "guestfs_part_get_mbr_id"
16098 #: ../src/guestfs-actions.pod:5003
16102 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16103 " const char *device,\n"
16110 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3368
16112 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16113 "partition C<partnum>."
16118 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5187
16120 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16121 "undefined results for other partition table types (see "
16122 "C<guestfs_part_get_parttype>)."
16127 #: ../src/guestfs-actions.pod:5019
16128 msgid "guestfs_part_get_parttype"
16133 #: ../src/guestfs-actions.pod:5021
16137 " guestfs_part_get_parttype (guestfs_h *g,\n"
16138 " const char *device);\n"
16144 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3379
16146 "This command examines the partition table on C<device> and returns the "
16147 "partition table type (format) being used."
16152 #: ../src/guestfs-actions.pod:5028
16154 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16155 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16156 "possible, although unusual. See C<guestfs_part_init> for a full list."
16161 #: ../src/guestfs-actions.pod:5038
16162 msgid "guestfs_part_init"
16167 #: ../src/guestfs-actions.pod:5040
16171 " guestfs_part_init (guestfs_h *g,\n"
16172 " const char *device,\n"
16173 " const char *parttype);\n"
16179 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3391
16181 "This creates an empty partition table on C<device> of one of the partition "
16182 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16183 "(for large disks)."
16188 #: ../src/guestfs-actions.pod:5049
16190 "Initially there are no partitions. Following this, you should call "
16191 "C<guestfs_part_add> for each partition required."
16196 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
16197 msgid "Possible values for C<parttype> are:"
16202 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
16203 msgid "B<efi> | B<gpt>"
16208 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
16209 msgid "Intel EFI / GPT partition table."
16214 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
16216 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16217 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16218 "the C<mbr> format."
16223 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16224 msgid "B<mbr> | B<msdos>"
16229 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16231 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16232 "Windows. This partition type will B<only> work for device sizes up to 2 "
16233 "TB. For large disks we recommend using C<gpt>."
16238 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
16240 "Other partition table types that may work but are not supported include:"
16245 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16251 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16252 msgid "AIX disk labels."
16257 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16258 msgid "B<amiga> | B<rdb>"
16263 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
16264 msgid "Amiga \"Rigid Disk Block\" format."
16269 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
16275 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
16276 msgid "BSD disk labels."
16281 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
16287 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3438
16288 msgid "DASD, used on IBM mainframes."
16293 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3440
16299 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3442
16300 msgid "MIPS/SGI volumes."
16305 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3444
16311 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3446
16312 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16317 #: ../src/guestfs-actions.pod:5102 ../fish/guestfish-actions.pod:3448
16323 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3450
16324 msgid "NEC PC-98 format, common in Japan apparently."
16329 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3452
16335 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3454
16336 msgid "Sun disk labels."
16341 #: ../src/guestfs-actions.pod:5116
16342 msgid "guestfs_part_list"
16347 #: ../src/guestfs-actions.pod:5118
16350 " struct guestfs_partition_list *\n"
16351 " guestfs_part_list (guestfs_h *g,\n"
16352 " const char *device);\n"
16358 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
16360 "This command parses the partition table on C<device> and returns the list of "
16361 "partitions found."
16366 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3465
16367 msgid "The fields in the returned structure are:"
16372 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3469
16373 msgid "B<part_num>"
16378 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3471
16379 msgid "Partition number, counting from 1."
16384 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
16385 msgid "B<part_start>"
16390 #: ../src/guestfs-actions.pod:5135
16392 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16393 "the device's sector size, see C<guestfs_blockdev_getss>."
16398 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3478
16399 msgid "B<part_end>"
16404 #: ../src/guestfs-actions.pod:5140 ../fish/guestfish-actions.pod:3480
16405 msgid "End of the partition in bytes."
16410 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3482
16411 msgid "B<part_size>"
16416 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3484
16417 msgid "Size of the partition in bytes."
16422 #: ../src/guestfs-actions.pod:5148
16424 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16425 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16431 #: ../src/guestfs-actions.pod:5154
16432 msgid "guestfs_part_set_bootable"
16437 #: ../src/guestfs-actions.pod:5156
16441 " guestfs_part_set_bootable (guestfs_h *g,\n"
16442 " const char *device,\n"
16444 " int bootable);\n"
16450 #: ../src/guestfs-actions.pod:5162 ../fish/guestfish-actions.pod:3492
16452 "This sets the bootable flag on partition numbered C<partnum> on device "
16453 "C<device>. Note that partitions are numbered from 1."
16458 #: ../src/guestfs-actions.pod:5165 ../fish/guestfish-actions.pod:3495
16460 "The bootable flag is used by some operating systems (notably Windows) to "
16461 "determine which partition to boot from. It is by no means universally "
16467 #: ../src/guestfs-actions.pod:5173
16468 msgid "guestfs_part_set_mbr_id"
16473 #: ../src/guestfs-actions.pod:5175
16477 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16478 " const char *device,\n"
16486 #: ../src/guestfs-actions.pod:5181 ../fish/guestfish-actions.pod:3503
16488 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16489 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16490 "documentation are in fact hexadecimal numbers, but usually documented "
16491 "without any leading \"0x\" which might be confusing."
16496 #: ../src/guestfs-actions.pod:5195
16497 msgid "guestfs_part_set_name"
16502 #: ../src/guestfs-actions.pod:5197
16506 " guestfs_part_set_name (guestfs_h *g,\n"
16507 " const char *device,\n"
16509 " const char *name);\n"
16515 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3517
16517 "This sets the partition name on partition numbered C<partnum> on device "
16518 "C<device>. Note that partitions are numbered from 1."
16523 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3520
16525 "The partition name can only be set on certain types of partition table. "
16526 "This works on C<gpt> but not on C<mbr> partitions."
16531 #: ../src/guestfs-actions.pod:5213
16532 msgid "guestfs_part_to_dev"
16537 #: ../src/guestfs-actions.pod:5215
16541 " guestfs_part_to_dev (guestfs_h *g,\n"
16542 " const char *partition);\n"
16548 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3527
16550 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16551 "partition number, returning the device name (eg. \"/dev/sdb\")."
16556 #: ../src/guestfs-actions.pod:5223
16558 "The named partition must exist, for example as a string returned from "
16559 "C<guestfs_list_partitions>."
16564 #: ../src/guestfs-actions.pod:5231
16565 msgid "guestfs_ping_daemon"
16570 #: ../src/guestfs-actions.pod:5233
16574 " guestfs_ping_daemon (guestfs_h *g);\n"
16580 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3538
16582 "This is a test probe into the guestfs daemon running inside the qemu "
16583 "subprocess. Calling this function checks that the daemon responds to the "
16584 "ping message, without affecting the daemon or attached block device(s) in "
16590 #: ../src/guestfs-actions.pod:5245
16591 msgid "guestfs_pread"
16596 #: ../src/guestfs-actions.pod:5247
16600 " guestfs_pread (guestfs_h *g,\n"
16601 " const char *path,\n"
16603 " int64_t offset,\n"
16604 " size_t *size_r);\n"
16610 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3547
16612 "This command lets you read part of a file. It reads C<count> bytes of the "
16613 "file, starting at C<offset>, from file C<path>."
16618 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283
16619 #: ../fish/guestfish-actions.pod:3550 ../fish/guestfish-actions.pod:3565
16621 "This may read fewer bytes than requested. For further details see the "
16622 "L<pread(2)> system call."
16627 #: ../src/guestfs-actions.pod:5260
16628 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16633 #: ../src/guestfs-actions.pod:5271
16634 msgid "guestfs_pread_device"
16639 #: ../src/guestfs-actions.pod:5273
16643 " guestfs_pread_device (guestfs_h *g,\n"
16644 " const char *device,\n"
16646 " int64_t offset,\n"
16647 " size_t *size_r);\n"
16653 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3562
16655 "This command lets you read part of a file. It reads C<count> bytes of "
16656 "C<device>, starting at C<offset>."
16661 #: ../src/guestfs-actions.pod:5286
16662 msgid "See also C<guestfs_pread>."
16667 #: ../src/guestfs-actions.pod:5295
16668 msgid "(Added in 1.5.21)"
16673 #: ../src/guestfs-actions.pod:5297
16674 msgid "guestfs_pvcreate"
16679 #: ../src/guestfs-actions.pod:5299
16683 " guestfs_pvcreate (guestfs_h *g,\n"
16684 " const char *device);\n"
16690 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3577
16692 "This creates an LVM physical volume on the named C<device>, where C<device> "
16693 "should usually be a partition name such as C</dev/sda1>."
16698 #: ../src/guestfs-actions.pod:5311
16699 msgid "guestfs_pvremove"
16704 #: ../src/guestfs-actions.pod:5313
16708 " guestfs_pvremove (guestfs_h *g,\n"
16709 " const char *device);\n"
16715 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3585
16717 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16723 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3588
16725 "The implementation uses the C<pvremove> command which refuses to wipe "
16726 "physical volumes that contain any volume groups, so you have to remove those "
16732 #: ../src/guestfs-actions.pod:5328
16733 msgid "guestfs_pvresize"
16738 #: ../src/guestfs-actions.pod:5330
16742 " guestfs_pvresize (guestfs_h *g,\n"
16743 " const char *device);\n"
16749 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3596
16751 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16752 "the new size of the underlying device."
16757 #: ../src/guestfs-actions.pod:5341
16758 msgid "guestfs_pvresize_size"
16763 #: ../src/guestfs-actions.pod:5343
16767 " guestfs_pvresize_size (guestfs_h *g,\n"
16768 " const char *device,\n"
16769 " int64_t size);\n"
16775 #: ../src/guestfs-actions.pod:5348
16777 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16778 "specify the new size (in bytes) explicitly."
16783 #: ../src/guestfs-actions.pod:5355
16784 msgid "guestfs_pvs"
16789 #: ../src/guestfs-actions.pod:5357
16793 " guestfs_pvs (guestfs_h *g);\n"
16799 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3610
16801 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16807 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3613
16809 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16815 #: ../src/guestfs-actions.pod:5366
16816 msgid "See also C<guestfs_pvs_full>."
16821 #: ../src/guestfs-actions.pod:5374
16822 msgid "guestfs_pvs_full"
16827 #: ../src/guestfs-actions.pod:5376
16830 " struct guestfs_lvm_pv_list *\n"
16831 " guestfs_pvs_full (guestfs_h *g);\n"
16837 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3622
16839 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16840 "(8)> command. The \"full\" version includes all fields."
16845 #: ../src/guestfs-actions.pod:5382
16847 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16848 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16853 #: ../src/guestfs-actions.pod:5388
16854 msgid "guestfs_pvuuid"
16859 #: ../src/guestfs-actions.pod:5390
16863 " guestfs_pvuuid (guestfs_h *g,\n"
16864 " const char *device);\n"
16870 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3629
16871 msgid "This command returns the UUID of the LVM PV C<device>."
16876 #: ../src/guestfs-actions.pod:5401
16877 msgid "guestfs_pwrite"
16882 #: ../src/guestfs-actions.pod:5403
16886 " guestfs_pwrite (guestfs_h *g,\n"
16887 " const char *path,\n"
16888 " const char *content,\n"
16889 " size_t content_size,\n"
16890 " int64_t offset);\n"
16896 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3635
16898 "This command writes to part of a file. It writes the data buffer C<content> "
16899 "to the file C<path> starting at offset C<offset>."
16904 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3638
16906 "This command implements the L<pwrite(2)> system call, and like that system "
16907 "call it may not write the full data requested. The return value is the "
16908 "number of bytes that were actually written to the file. This could even be "
16909 "0, although short writes are unlikely for regular files in ordinary "
16915 #: ../src/guestfs-actions.pod:5419
16916 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16921 #: ../src/guestfs-actions.pod:5428
16922 msgid "guestfs_pwrite_device"
16927 #: ../src/guestfs-actions.pod:5430
16931 " guestfs_pwrite_device (guestfs_h *g,\n"
16932 " const char *device,\n"
16933 " const char *content,\n"
16934 " size_t content_size,\n"
16935 " int64_t offset);\n"
16941 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3653
16943 "This command writes to part of a device. It writes the data buffer "
16944 "C<content> to C<device> starting at offset C<offset>."
16949 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
16951 "This command implements the L<pwrite(2)> system call, and like that system "
16952 "call it may not write the full data requested (although short writes to disk "
16953 "devices and partitions are probably impossible with standard Linux kernels)."
16958 #: ../src/guestfs-actions.pod:5445
16959 msgid "See also C<guestfs_pwrite>."
16964 #: ../src/guestfs-actions.pod:5452
16965 msgid "(Added in 1.5.20)"
16970 #: ../src/guestfs-actions.pod:5454
16971 msgid "guestfs_read_file"
16976 #: ../src/guestfs-actions.pod:5456
16980 " guestfs_read_file (guestfs_h *g,\n"
16981 " const char *path,\n"
16982 " size_t *size_r);\n"
16988 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3670
16989 msgid "This calls returns the contents of the file C<path> as a buffer."
16994 #: ../src/guestfs-actions.pod:5464
16996 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16997 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16998 "function is limited in the total size of file that can be handled."
17003 #: ../src/guestfs-actions.pod:5476
17004 msgid "(Added in 1.0.63)"
17009 #: ../src/guestfs-actions.pod:5478
17010 msgid "guestfs_read_lines"
17015 #: ../src/guestfs-actions.pod:5480
17019 " guestfs_read_lines (guestfs_h *g,\n"
17020 " const char *path);\n"
17026 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3687
17028 "The file contents are returned as a list of lines. Trailing C<LF> and "
17029 "C<CRLF> character sequences are I<not> returned."
17034 #: ../src/guestfs-actions.pod:5489
17036 "Note that this function cannot correctly handle binary files (specifically, "
17037 "files containing C<\\0> character which is treated as end of line). For "
17038 "those you need to use the C<guestfs_read_file> function which has a more "
17039 "complex interface."
17044 #: ../src/guestfs-actions.pod:5500
17045 msgid "guestfs_readdir"
17050 #: ../src/guestfs-actions.pod:5502
17053 " struct guestfs_dirent_list *\n"
17054 " guestfs_readdir (guestfs_h *g,\n"
17055 " const char *dir);\n"
17061 #: ../src/guestfs-actions.pod:5506 ../fish/guestfish-actions.pod:3699
17062 msgid "This returns the list of directory entries in directory C<dir>."
17067 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3701
17069 "All entries in the directory are returned, including C<.> and C<..>. The "
17070 "entries are I<not> sorted, but returned in the same order as the underlying "
17076 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
17078 "Also this call returns basic file type information about each file. The "
17079 "C<ftyp> field will contain one of the following characters:"
17084 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
17090 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
17091 msgid "Block special"
17096 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
17102 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
17103 msgid "Char special"
17108 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
17114 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
17120 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
17126 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
17127 msgid "FIFO (named pipe)"
17132 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
17138 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3728
17139 msgid "Symbolic link"
17144 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3730
17150 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3732
17151 msgid "Regular file"
17156 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3734
17162 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3736
17168 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3738
17174 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3740
17175 msgid "Unknown file type"
17180 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3742
17186 #: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3744
17188 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17193 #: ../src/guestfs-actions.pod:5556
17195 "This function is primarily intended for use by programs. To get a simple "
17196 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17197 "consumption, use C<guestfs_ll>."
17202 #: ../src/guestfs-actions.pod:5560
17204 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17205 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17210 #: ../src/guestfs-actions.pod:5566
17211 msgid "guestfs_readlink"
17216 #: ../src/guestfs-actions.pod:5568
17220 " guestfs_readlink (guestfs_h *g,\n"
17221 " const char *path);\n"
17227 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3757
17228 msgid "This command reads the target of a symbolic link."
17233 #: ../src/guestfs-actions.pod:5579
17234 msgid "guestfs_readlinklist"
17239 #: ../src/guestfs-actions.pod:5581
17243 " guestfs_readlinklist (guestfs_h *g,\n"
17244 " const char *path,\n"
17245 " char *const *names);\n"
17251 #: ../src/guestfs-actions.pod:5586 ../fish/guestfish-actions.pod:3763
17253 "This call allows you to do a C<readlink> operation on multiple files, where "
17254 "all files are in the directory C<path>. C<names> is the list of files from "
17260 #: ../src/guestfs-actions.pod:5590 ../fish/guestfish-actions.pod:3767
17262 "On return you get a list of strings, with a one-to-one correspondence to the "
17263 "C<names> list. Each string is the value of the symbolic link."
17268 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3771
17270 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17271 "result string is the empty string C<\"\">. However the whole operation is "
17272 "completed even if there were C<readlink(2)> errors, and so you can call this "
17273 "function with names where you don't know if they are symbolic links already "
17274 "(albeit slightly less efficient)."
17279 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3778
17281 "This call is intended for programs that want to efficiently list a directory "
17282 "contents without making many round-trips. Very long directory listings "
17283 "might cause the protocol message size to be exceeded, causing this call to "
17284 "fail. The caller must split up such requests into smaller groups of names."
17289 #: ../src/guestfs-actions.pod:5614
17290 msgid "guestfs_realpath"
17295 #: ../src/guestfs-actions.pod:5616
17299 " guestfs_realpath (guestfs_h *g,\n"
17300 " const char *path);\n"
17306 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3789
17308 "Return the canonicalized absolute pathname of C<path>. The returned path "
17309 "has no C<.>, C<..> or symbolic link path elements."
17314 #: ../src/guestfs-actions.pod:5628
17315 msgid "guestfs_removexattr"
17320 #: ../src/guestfs-actions.pod:5630
17324 " guestfs_removexattr (guestfs_h *g,\n"
17325 " const char *xattr,\n"
17326 " const char *path);\n"
17332 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3796
17334 "This call removes the extended attribute named C<xattr> of the file C<path>."
17339 #: ../src/guestfs-actions.pod:5638
17340 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17345 #: ../src/guestfs-actions.pod:5644
17346 msgid "guestfs_resize2fs"
17351 #: ../src/guestfs-actions.pod:5646
17355 " guestfs_resize2fs (guestfs_h *g,\n"
17356 " const char *device);\n"
17362 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3805
17364 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17365 "underlying device."
17370 #: ../src/guestfs-actions.pod:5653
17372 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17373 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17374 "sometimes gives an error about this and sometimes not. In any case, it is "
17375 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17379 #: ../src/guestfs-actions.pod:5663
17380 msgid "guestfs_resize2fs_M"
17384 #: ../src/guestfs-actions.pod:5665
17388 " guestfs_resize2fs_M (guestfs_h *g,\n"
17389 " const char *device);\n"
17394 #: ../src/guestfs-actions.pod:5669
17396 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17397 "resized to its minimum size. This works like the I<-M> option to the "
17398 "C<resize2fs> command."
17402 #: ../src/guestfs-actions.pod:5673
17404 "To get the resulting size of the filesystem you should call "
17405 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17406 "These two numbers, multiplied together, give the resulting size of the "
17407 "minimal filesystem in bytes."
17412 #: ../src/guestfs-actions.pod:5680
17413 msgid "guestfs_resize2fs_size"
17418 #: ../src/guestfs-actions.pod:5682
17422 " guestfs_resize2fs_size (guestfs_h *g,\n"
17423 " const char *device,\n"
17424 " int64_t size);\n"
17430 #: ../src/guestfs-actions.pod:5687
17432 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17433 "to specify the new size (in bytes) explicitly."
17438 #: ../src/guestfs-actions.pod:5694
17444 #: ../src/guestfs-actions.pod:5696
17448 " guestfs_rm (guestfs_h *g,\n"
17449 " const char *path);\n"
17455 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3838
17456 msgid "Remove the single file C<path>."
17461 #: ../src/guestfs-actions.pod:5706
17462 msgid "guestfs_rm_rf"
17467 #: ../src/guestfs-actions.pod:5708
17471 " guestfs_rm_rf (guestfs_h *g,\n"
17472 " const char *path);\n"
17478 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3844
17480 "Remove the file or directory C<path>, recursively removing the contents if "
17481 "its a directory. This is like the C<rm -rf> shell command."
17486 #: ../src/guestfs-actions.pod:5720
17487 msgid "guestfs_rmdir"
17492 #: ../src/guestfs-actions.pod:5722
17496 " guestfs_rmdir (guestfs_h *g,\n"
17497 " const char *path);\n"
17503 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3852
17504 msgid "Remove the single directory C<path>."
17509 #: ../src/guestfs-actions.pod:5732
17510 msgid "guestfs_rmmountpoint"
17515 #: ../src/guestfs-actions.pod:5734
17519 " guestfs_rmmountpoint (guestfs_h *g,\n"
17520 " const char *exemptpath);\n"
17526 #: ../src/guestfs-actions.pod:5738
17528 "This calls removes a mountpoint that was previously created with "
17529 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17534 #: ../src/guestfs-actions.pod:5746
17535 msgid "guestfs_scrub_device"
17540 #: ../src/guestfs-actions.pod:5748
17544 " guestfs_scrub_device (guestfs_h *g,\n"
17545 " const char *device);\n"
17551 #: ../src/guestfs-actions.pod:5752 ../fish/guestfish-actions.pod:3866
17553 "This command writes patterns over C<device> to make data retrieval more "
17559 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:5776
17560 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3869
17561 #: ../fish/guestfish-actions.pod:3884 ../fish/guestfish-actions.pod:3897
17563 "It is an interface to the L<scrub(1)> program. See that manual page for "
17569 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5781
17570 #: ../src/guestfs-actions.pod:5800
17571 msgid "(Added in 1.0.52)"
17576 #: ../src/guestfs-actions.pod:5765
17577 msgid "guestfs_scrub_file"
17582 #: ../src/guestfs-actions.pod:5767
17586 " guestfs_scrub_file (guestfs_h *g,\n"
17587 " const char *file);\n"
17593 #: ../src/guestfs-actions.pod:5771 ../fish/guestfish-actions.pod:3879
17595 "This command writes patterns over a file to make data retrieval more "
17601 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3882
17602 msgid "The file is I<removed> after scrubbing."
17607 #: ../src/guestfs-actions.pod:5783
17608 msgid "guestfs_scrub_freespace"
17613 #: ../src/guestfs-actions.pod:5785
17617 " guestfs_scrub_freespace (guestfs_h *g,\n"
17618 " const char *dir);\n"
17624 #: ../src/guestfs-actions.pod:5789
17626 "This command creates the directory C<dir> and then fills it with files until "
17627 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17628 "and deletes them. The intention is to scrub any free space on the partition "
17629 "containing C<dir>."
17634 #: ../src/guestfs-actions.pod:5802
17635 msgid "guestfs_set_append"
17640 #: ../src/guestfs-actions.pod:5804
17644 " guestfs_set_append (guestfs_h *g,\n"
17645 " const char *append);\n"
17651 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3906
17653 "This function is used to add additional options to the guest kernel command "
17659 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3909
17661 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17662 "environment variable."
17667 #: ../src/guestfs-actions.pod:5814 ../fish/guestfish-actions.pod:3912
17669 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17670 "(libguestfs always adds a few of its own)."
17674 #: ../src/guestfs-actions.pod:5821
17675 msgid "guestfs_set_attach_method"
17679 #: ../src/guestfs-actions.pod:5823
17683 " guestfs_set_attach_method (guestfs_h *g,\n"
17684 " const char *attachmethod);\n"
17689 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
17691 "Set the method that libguestfs uses to connect to the back end guestfsd "
17692 "daemon. Possible methods are:"
17696 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
17698 "Launch an appliance and connect to it. This is the ordinary method and the "
17703 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3931
17704 msgid "C<unix:I<path>>"
17708 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3933
17709 msgid "Connect to the Unix domain socket I<path>."
17713 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3935
17715 "This method lets you connect to an existing daemon or (using virtio-serial) "
17716 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17717 "RUNNING DAEMONS>."
17722 #: ../src/guestfs-actions.pod:5849
17723 msgid "guestfs_set_autosync"
17728 #: ../src/guestfs-actions.pod:5851
17732 " guestfs_set_autosync (guestfs_h *g,\n"
17733 " int autosync);\n"
17738 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
17740 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17741 "effort attempt to make filesystems consistent and synchronized when the "
17742 "handle is closed (also if the program exits without closing handles)."
17747 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3952
17749 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17750 "disabled by default)."
17755 #: ../src/guestfs-actions.pod:5867
17756 msgid "guestfs_set_direct"
17761 #: ../src/guestfs-actions.pod:5869
17765 " guestfs_set_direct (guestfs_h *g,\n"
17772 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3961
17774 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17775 "passed directly through to the appliance once it is launched."
17780 #: ../src/guestfs-actions.pod:5877
17782 "One consequence of this is that log messages aren't caught by the library "
17783 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17789 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3969
17790 msgid "You probably don't want to use this unless you know what you are doing."
17795 #: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3972
17796 msgid "The default is disabled."
17801 #: ../src/guestfs-actions.pod:5890
17802 msgid "guestfs_set_e2label"
17807 #: ../src/guestfs-actions.pod:5892
17811 " guestfs_set_e2label (guestfs_h *g,\n"
17812 " const char *device,\n"
17813 " const char *label);\n"
17819 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3978
17821 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17822 "C<label>. Filesystem labels are limited to 16 characters."
17827 #: ../src/guestfs-actions.pod:5901
17829 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17830 "the existing label on a filesystem."
17835 #: ../src/guestfs-actions.pod:5908
17836 msgid "guestfs_set_e2uuid"
17841 #: ../src/guestfs-actions.pod:5910
17845 " guestfs_set_e2uuid (guestfs_h *g,\n"
17846 " const char *device,\n"
17847 " const char *uuid);\n"
17853 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3989
17855 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17856 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17857 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17862 #: ../src/guestfs-actions.pod:5920
17864 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17865 "the existing UUID of a filesystem."
17870 #: ../src/guestfs-actions.pod:5927
17871 msgid "guestfs_set_memsize"
17876 #: ../src/guestfs-actions.pod:5929
17880 " guestfs_set_memsize (guestfs_h *g,\n"
17887 #: ../src/guestfs-actions.pod:5933
17889 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17890 "This only has any effect if called before C<guestfs_launch>."
17895 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:4007
17897 "You can also change this by setting the environment variable "
17898 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17903 #: ../src/guestfs-actions.pod:5948
17904 msgid "guestfs_set_network"
17909 #: ../src/guestfs-actions.pod:5950
17913 " guestfs_set_network (guestfs_h *g,\n"
17920 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4020
17922 "If C<network> is true, then the network is enabled in the libguestfs "
17923 "appliance. The default is false."
17928 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4023
17930 "This affects whether commands are able to access the network (see L<guestfs"
17931 "(3)/RUNNING COMMANDS>)."
17936 #: ../src/guestfs-actions.pod:5960
17938 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17944 #: ../src/guestfs-actions.pod:5967
17945 msgid "guestfs_set_path"
17950 #: ../src/guestfs-actions.pod:5969
17954 " guestfs_set_path (guestfs_h *g,\n"
17955 " const char *searchpath);\n"
17961 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
17962 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17967 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:4037
17969 "The default is C<$libdir/guestfs> unless overridden by setting "
17970 "C<LIBGUESTFS_PATH> environment variable."
17975 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4040
17976 msgid "Setting C<path> to C<NULL> restores the default path."
17981 #: ../src/guestfs-actions.pod:5984
17982 msgid "guestfs_set_qemu"
17987 #: ../src/guestfs-actions.pod:5986
17991 " guestfs_set_qemu (guestfs_h *g,\n"
17992 " const char *qemu);\n"
17998 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
17999 msgid "Set the qemu binary that we will use."
18004 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4050
18006 "The default is chosen when the library was compiled by the configure script."
18011 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
18013 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
18019 #: ../src/guestfs-actions.pod:5998 ../fish/guestfish-actions.pod:4056
18020 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
18025 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4058
18027 "Note that you should call this function as early as possible after creating "
18028 "the handle. This is because some pre-launch operations depend on testing "
18029 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
18030 "don't retest features, and so you might see inconsistent results. Using the "
18031 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18032 "the qemu binary at the same time as the handle is created."
18037 #: ../src/guestfs-actions.pod:6012
18038 msgid "guestfs_set_recovery_proc"
18043 #: ../src/guestfs-actions.pod:6014
18047 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18048 " int recoveryproc);\n"
18054 #: ../src/guestfs-actions.pod:6018
18056 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18057 "not create a recovery process. The purpose of the recovery process is to "
18058 "stop runaway qemu processes in the case where the main program aborts "
18064 #: ../src/guestfs-actions.pod:6023
18066 "This only has any effect if called before C<guestfs_launch>, and the default "
18072 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:4080
18074 "About the only time when you would want to disable this is if the main "
18075 "process will fork itself into the background (\"daemonize\" itself). In "
18076 "this case the recovery process thinks that the main program has disappeared "
18077 "and so kills qemu, which is not very helpful."
18082 #: ../src/guestfs-actions.pod:6036
18083 msgid "guestfs_set_selinux"
18088 #: ../src/guestfs-actions.pod:6038
18092 " guestfs_set_selinux (guestfs_h *g,\n"
18099 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4092
18101 "This sets the selinux flag that is passed to the appliance at boot time. "
18102 "The default is C<selinux=0> (disabled)."
18107 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4095
18109 "Note that if SELinux is enabled, it is always in Permissive mode "
18110 "(C<enforcing=0>)."
18115 #: ../src/guestfs-actions.pod:6055
18116 msgid "guestfs_set_trace"
18121 #: ../src/guestfs-actions.pod:6057
18125 " guestfs_set_trace (guestfs_h *g,\n"
18131 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4107
18133 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18134 "return values are traced."
18139 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4110
18141 "If you want to trace C API calls into libguestfs (and other libraries) then "
18142 "possibly a better way is to use the external ltrace(1) command."
18147 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:4114
18149 "Command traces are disabled unless the environment variable "
18150 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18154 #: ../src/guestfs-actions.pod:6071
18156 "Trace messages are normally sent to C<stderr>, unless you register a "
18157 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18162 #: ../src/guestfs-actions.pod:6079
18163 msgid "guestfs_set_verbose"
18168 #: ../src/guestfs-actions.pod:6081
18172 " guestfs_set_verbose (guestfs_h *g,\n"
18178 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4127
18179 msgid "If C<verbose> is true, this turns on verbose messages."
18184 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4129
18186 "Verbose messages are disabled unless the environment variable "
18187 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18191 #: ../src/guestfs-actions.pod:6090
18193 "Verbose messages are normally sent to C<stderr>, unless you register a "
18194 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18199 #: ../src/guestfs-actions.pod:6098
18200 msgid "guestfs_setcon"
18205 #: ../src/guestfs-actions.pod:6100
18209 " guestfs_setcon (guestfs_h *g,\n"
18210 " const char *context);\n"
18216 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4140
18218 "This sets the SELinux security context of the daemon to the string "
18224 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4143
18225 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18230 #: ../src/guestfs-actions.pod:6113
18231 msgid "guestfs_setxattr"
18236 #: ../src/guestfs-actions.pod:6115
18240 " guestfs_setxattr (guestfs_h *g,\n"
18241 " const char *xattr,\n"
18242 " const char *val,\n"
18244 " const char *path);\n"
18250 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4149
18252 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18253 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18258 #: ../src/guestfs-actions.pod:6126
18259 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18264 #: ../src/guestfs-actions.pod:6132
18265 msgid "guestfs_sfdisk"
18270 #: ../src/guestfs-actions.pod:6134
18274 " guestfs_sfdisk (guestfs_h *g,\n"
18275 " const char *device,\n"
18279 " char *const *lines);\n"
18285 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
18287 "This is a direct interface to the L<sfdisk(8)> program for creating "
18288 "partitions on block devices."
18293 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4162
18294 msgid "C<device> should be a block device, for example C</dev/sda>."
18299 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4164
18301 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18302 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18303 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18304 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18305 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18306 "the kernel) cannot work out the right geometry and you will need to tell it."
18311 #: ../src/guestfs-actions.pod:6155 ../fish/guestfish-actions.pod:4172
18313 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18314 "refer to the L<sfdisk(8)> manpage."
18319 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4175
18321 "To create a single partition occupying the whole disk, you would pass "
18322 "C<lines> as a single element list, when the single element being the string "
18328 #: ../src/guestfs-actions.pod:6162
18330 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18334 #: ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6200
18335 #: ../src/guestfs-actions.pod:6233
18337 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
18343 #: ../src/guestfs-actions.pod:6179
18344 msgid "guestfs_sfdiskM"
18349 #: ../src/guestfs-actions.pod:6181
18353 " guestfs_sfdiskM (guestfs_h *g,\n"
18354 " const char *device,\n"
18355 " char *const *lines);\n"
18361 #: ../src/guestfs-actions.pod:6186
18363 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18364 "partition sizes are specified in megabytes only (rounded to the nearest "
18365 "cylinder) and you don't need to specify the cyls, heads and sectors "
18366 "parameters which were rarely if ever used anyway."
18371 #: ../src/guestfs-actions.pod:6192
18373 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18374 "C<guestfs_part_disk>"
18379 #: ../src/guestfs-actions.pod:6209
18380 msgid "guestfs_sfdisk_N"
18385 #: ../src/guestfs-actions.pod:6211
18389 " guestfs_sfdisk_N (guestfs_h *g,\n"
18390 " const char *device,\n"
18395 " const char *line);\n"
18401 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4219
18403 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18404 "(note: C<n> counts from 1)."
18409 #: ../src/guestfs-actions.pod:6223
18411 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18412 "for the cyls/heads/sectors parameters."
18417 #: ../src/guestfs-actions.pod:6226
18418 msgid "See also: C<guestfs_part_add>"
18423 #: ../src/guestfs-actions.pod:6242
18424 msgid "guestfs_sfdisk_disk_geometry"
18429 #: ../src/guestfs-actions.pod:6244
18433 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18434 " const char *device);\n"
18440 #: ../src/guestfs-actions.pod:6248
18442 "This displays the disk geometry of C<device> read from the partition table. "
18443 "Especially in the case where the underlying block device has been resized, "
18444 "this can be different from the kernel's idea of the geometry (see "
18445 "C<guestfs_sfdisk_kernel_geometry>)."
18450 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6269
18451 #: ../fish/guestfish-actions.pod:4246 ../fish/guestfish-actions.pod:4255
18452 msgid "The result is in human-readable format, and not designed to be parsed."
18457 #: ../src/guestfs-actions.pod:6261
18458 msgid "guestfs_sfdisk_kernel_geometry"
18463 #: ../src/guestfs-actions.pod:6263
18467 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18468 " const char *device);\n"
18474 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4253
18475 msgid "This displays the kernel's idea of the geometry of C<device>."
18480 #: ../src/guestfs-actions.pod:6277
18481 msgid "guestfs_sfdisk_l"
18486 #: ../src/guestfs-actions.pod:6279
18490 " guestfs_sfdisk_l (guestfs_h *g,\n"
18491 " const char *device);\n"
18497 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4262
18499 "This displays the partition table on C<device>, in the human-readable output "
18500 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18505 #: ../src/guestfs-actions.pod:6287
18506 msgid "See also: C<guestfs_part_list>"
18510 #: ../src/guestfs-actions.pod:6292
18512 "This function is deprecated. In new code, use the L</guestfs_part_list> "
18518 #: ../src/guestfs-actions.pod:6301
18524 #: ../src/guestfs-actions.pod:6303
18528 " guestfs_sh (guestfs_h *g,\n"
18529 " const char *command);\n"
18535 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
18537 "This call runs a command from the guest filesystem via the guest's C</bin/"
18543 #: ../src/guestfs-actions.pod:6310
18544 msgid "This is like C<guestfs_command>, but passes the command to:"
18549 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4284
18552 " /bin/sh -c \"command\"\n"
18558 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4286
18560 "Depending on the guest's shell, this usually results in wildcards being "
18561 "expanded, shell expressions being interpolated and so on."
18566 #: ../src/guestfs-actions.pod:6318
18567 msgid "All the provisos about C<guestfs_command> apply to this call."
18572 #: ../src/guestfs-actions.pod:6325
18573 msgid "guestfs_sh_lines"
18578 #: ../src/guestfs-actions.pod:6327
18582 " guestfs_sh_lines (guestfs_h *g,\n"
18583 " const char *command);\n"
18589 #: ../src/guestfs-actions.pod:6331
18591 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18597 #: ../src/guestfs-actions.pod:6334
18598 msgid "See also: C<guestfs_command_lines>"
18603 #: ../src/guestfs-actions.pod:6342
18604 msgid "guestfs_sleep"
18609 #: ../src/guestfs-actions.pod:6344
18613 " guestfs_sleep (guestfs_h *g,\n"
18620 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4305
18621 msgid "Sleep for C<secs> seconds."
18626 #: ../src/guestfs-actions.pod:6352
18627 msgid "(Added in 1.0.41)"
18632 #: ../src/guestfs-actions.pod:6354 ../src/guestfs-structs.pod:109
18633 msgid "guestfs_stat"
18638 #: ../src/guestfs-actions.pod:6356
18641 " struct guestfs_stat *\n"
18642 " guestfs_stat (guestfs_h *g,\n"
18643 " const char *path);\n"
18649 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4313
18650 msgid "This is the same as the C<stat(2)> system call."
18655 #: ../src/guestfs-actions.pod:6370 ../src/guestfs-structs.pod:135
18656 msgid "guestfs_statvfs"
18661 #: ../src/guestfs-actions.pod:6372
18664 " struct guestfs_statvfs *\n"
18665 " guestfs_statvfs (guestfs_h *g,\n"
18666 " const char *path);\n"
18672 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4319
18674 "Returns file system statistics for any mounted file system. C<path> should "
18675 "be a file or directory in the mounted file system (typically it is the mount "
18676 "point itself, but it doesn't need to be)."
18681 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4323
18682 msgid "This is the same as the C<statvfs(2)> system call."
18687 #: ../src/guestfs-actions.pod:6382
18689 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18690 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18695 #: ../src/guestfs-actions.pod:6388
18696 msgid "guestfs_strings"
18701 #: ../src/guestfs-actions.pod:6390
18705 " guestfs_strings (guestfs_h *g,\n"
18706 " const char *path);\n"
18712 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4329
18714 "This runs the L<strings(1)> command on a file and returns the list of "
18715 "printable strings found."
18720 #: ../src/guestfs-actions.pod:6406
18721 msgid "guestfs_strings_e"
18726 #: ../src/guestfs-actions.pod:6408
18730 " guestfs_strings_e (guestfs_h *g,\n"
18731 " const char *encoding,\n"
18732 " const char *path);\n"
18738 #: ../src/guestfs-actions.pod:6413
18740 "This is like the C<guestfs_strings> command, but allows you to specify the "
18741 "encoding of strings that are looked for in the source file C<path>."
18746 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4343
18747 msgid "Allowed encodings are:"
18752 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
18758 #: ../src/guestfs-actions.pod:6423
18760 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18761 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18766 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4352
18772 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4354
18773 msgid "Single 8-bit-byte characters."
18778 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
18784 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
18785 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18790 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
18791 msgid "l (lower case letter L)"
18796 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
18798 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18799 "examining binaries in Windows guests."
18804 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4366
18810 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4368
18811 msgid "32-bit big endian such as UCS-4BE."
18816 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4370
18822 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4372
18823 msgid "32-bit little endian such as UCS-4LE."
18828 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4376
18829 msgid "The returned strings are transcoded to UTF-8."
18834 #: ../src/guestfs-actions.pod:6461
18835 msgid "guestfs_swapoff_device"
18840 #: ../src/guestfs-actions.pod:6463
18844 " guestfs_swapoff_device (guestfs_h *g,\n"
18845 " const char *device);\n"
18851 #: ../src/guestfs-actions.pod:6467
18853 "This command disables the libguestfs appliance swap device or partition "
18854 "named C<device>. See C<guestfs_swapon_device>."
18859 #: ../src/guestfs-actions.pod:6475
18860 msgid "guestfs_swapoff_file"
18865 #: ../src/guestfs-actions.pod:6477
18869 " guestfs_swapoff_file (guestfs_h *g,\n"
18870 " const char *file);\n"
18876 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4393
18877 msgid "This command disables the libguestfs appliance swap on file."
18882 #: ../src/guestfs-actions.pod:6487
18883 msgid "guestfs_swapoff_label"
18888 #: ../src/guestfs-actions.pod:6489
18892 " guestfs_swapoff_label (guestfs_h *g,\n"
18893 " const char *label);\n"
18899 #: ../src/guestfs-actions.pod:6493 ../fish/guestfish-actions.pod:4399
18901 "This command disables the libguestfs appliance swap on labeled swap "
18907 #: ../src/guestfs-actions.pod:6500
18908 msgid "guestfs_swapoff_uuid"
18913 #: ../src/guestfs-actions.pod:6502
18917 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18918 " const char *uuid);\n"
18924 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4406
18926 "This command disables the libguestfs appliance swap partition with the given "
18932 #: ../src/guestfs-actions.pod:6513
18933 msgid "guestfs_swapon_device"
18938 #: ../src/guestfs-actions.pod:6515
18942 " guestfs_swapon_device (guestfs_h *g,\n"
18943 " const char *device);\n"
18949 #: ../src/guestfs-actions.pod:6519
18951 "This command enables the libguestfs appliance to use the swap device or "
18952 "partition named C<device>. The increased memory is made available for all "
18953 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18958 #: ../src/guestfs-actions.pod:6524 ../fish/guestfish-actions.pod:4418
18960 "Note that you should not swap to existing guest swap partitions unless you "
18961 "know what you are doing. They may contain hibernation information, or other "
18962 "information that the guest doesn't want you to trash. You also risk leaking "
18963 "information about the host to the guest this way. Instead, attach a new "
18964 "host device to the guest and swap on that."
18969 #: ../src/guestfs-actions.pod:6535
18970 msgid "guestfs_swapon_file"
18975 #: ../src/guestfs-actions.pod:6537
18979 " guestfs_swapon_file (guestfs_h *g,\n"
18980 " const char *file);\n"
18986 #: ../src/guestfs-actions.pod:6541
18988 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18994 #: ../src/guestfs-actions.pod:6548
18995 msgid "guestfs_swapon_label"
19000 #: ../src/guestfs-actions.pod:6550
19004 " guestfs_swapon_label (guestfs_h *g,\n"
19005 " const char *label);\n"
19011 #: ../src/guestfs-actions.pod:6554
19013 "This command enables swap to a labeled swap partition. See "
19014 "C<guestfs_swapon_device> for other notes."
19019 #: ../src/guestfs-actions.pod:6561
19020 msgid "guestfs_swapon_uuid"
19025 #: ../src/guestfs-actions.pod:6563
19029 " guestfs_swapon_uuid (guestfs_h *g,\n"
19030 " const char *uuid);\n"
19036 #: ../src/guestfs-actions.pod:6567
19038 "This command enables swap to a swap partition with the given UUID. See "
19039 "C<guestfs_swapon_device> for other notes."
19044 #: ../src/guestfs-actions.pod:6574
19045 msgid "guestfs_sync"
19050 #: ../src/guestfs-actions.pod:6576
19054 " guestfs_sync (guestfs_h *g);\n"
19060 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4450
19062 "This syncs the disk, so that any writes are flushed through to the "
19063 "underlying disk image."
19068 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4453
19070 "You should always call this if you have modified a disk image, before "
19071 "closing the handle."
19076 #: ../src/guestfs-actions.pod:6589
19077 msgid "guestfs_tail"
19082 #: ../src/guestfs-actions.pod:6591
19086 " guestfs_tail (guestfs_h *g,\n"
19087 " const char *path);\n"
19093 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4460
19095 "This command returns up to the last 10 lines of a file as a list of strings."
19100 #: ../src/guestfs-actions.pod:6607
19101 msgid "guestfs_tail_n"
19106 #: ../src/guestfs-actions.pod:6609
19110 " guestfs_tail_n (guestfs_h *g,\n"
19112 " const char *path);\n"
19118 #: ../src/guestfs-actions.pod:6614 ../fish/guestfish-actions.pod:4470
19120 "If the parameter C<nrlines> is a positive number, this returns the last "
19121 "C<nrlines> lines of the file C<path>."
19126 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4473
19128 "If the parameter C<nrlines> is a negative number, this returns lines from "
19129 "the file C<path>, starting with the C<-nrlines>th line."
19134 #: ../src/guestfs-actions.pod:6631
19135 msgid "guestfs_tar_in"
19140 #: ../src/guestfs-actions.pod:6633
19144 " guestfs_tar_in (guestfs_h *g,\n"
19145 " const char *tarfile,\n"
19146 " const char *directory);\n"
19152 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4485
19154 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19155 "tar file) into C<directory>."
19160 #: ../src/guestfs-actions.pod:6641
19162 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19167 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6663
19168 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6695
19169 msgid "(Added in 1.0.3)"
19174 #: ../src/guestfs-actions.pod:6648
19175 msgid "guestfs_tar_out"
19180 #: ../src/guestfs-actions.pod:6650
19184 " guestfs_tar_out (guestfs_h *g,\n"
19185 " const char *directory,\n"
19186 " const char *tarfile);\n"
19192 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4497
19194 "This command packs the contents of C<directory> and downloads it to local "
19200 #: ../src/guestfs-actions.pod:6658
19202 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19203 "C<guestfs_txz_out>."
19208 #: ../src/guestfs-actions.pod:6665
19209 msgid "guestfs_tgz_in"
19214 #: ../src/guestfs-actions.pod:6667
19218 " guestfs_tgz_in (guestfs_h *g,\n"
19219 " const char *tarball,\n"
19220 " const char *directory);\n"
19226 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4509
19228 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19229 "tar file) into C<directory>."
19234 #: ../src/guestfs-actions.pod:6675
19235 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19240 #: ../src/guestfs-actions.pod:6681
19241 msgid "guestfs_tgz_out"
19246 #: ../src/guestfs-actions.pod:6683
19250 " guestfs_tgz_out (guestfs_h *g,\n"
19251 " const char *directory,\n"
19252 " const char *tarball);\n"
19258 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4520
19260 "This command packs the contents of C<directory> and downloads it to local "
19266 #: ../src/guestfs-actions.pod:6691
19267 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19272 #: ../src/guestfs-actions.pod:6697
19273 msgid "guestfs_touch"
19278 #: ../src/guestfs-actions.pod:6699
19282 " guestfs_touch (guestfs_h *g,\n"
19283 " const char *path);\n"
19289 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4531
19291 "Touch acts like the L<touch(1)> command. It can be used to update the "
19292 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19298 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4535
19300 "This command only works on regular files, and will fail on other file types "
19301 "such as directories, symbolic links, block special etc."
19306 #: ../src/guestfs-actions.pod:6714
19307 msgid "guestfs_truncate"
19312 #: ../src/guestfs-actions.pod:6716
19316 " guestfs_truncate (guestfs_h *g,\n"
19317 " const char *path);\n"
19323 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4542
19325 "This command truncates C<path> to a zero-length file. The file must exist "
19331 #: ../src/guestfs-actions.pod:6727
19332 msgid "guestfs_truncate_size"
19337 #: ../src/guestfs-actions.pod:6729
19341 " guestfs_truncate_size (guestfs_h *g,\n"
19342 " const char *path,\n"
19343 " int64_t size);\n"
19349 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4549
19351 "This command truncates C<path> to size C<size> bytes. The file must exist "
19357 #: ../src/guestfs-actions.pod:6737
19359 "If the current file size is less than C<size> then the file is extended to "
19360 "the required size with zero bytes. This creates a sparse file (ie. disk "
19361 "blocks are not allocated for the file until you write to it). To create a "
19362 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19367 #: ../src/guestfs-actions.pod:6747
19368 msgid "guestfs_tune2fs_l"
19373 #: ../src/guestfs-actions.pod:6749
19377 " guestfs_tune2fs_l (guestfs_h *g,\n"
19378 " const char *device);\n"
19384 #: ../src/guestfs-actions.pod:6753 ../fish/guestfish-actions.pod:4562
19386 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19392 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4565
19394 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19395 "for more details. The list of fields returned isn't clearly defined, and "
19396 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19397 "and the filesystem itself."
19402 #: ../src/guestfs-actions.pod:6769
19403 msgid "guestfs_txz_in"
19408 #: ../src/guestfs-actions.pod:6771
19412 " guestfs_txz_in (guestfs_h *g,\n"
19413 " const char *tarball,\n"
19414 " const char *directory);\n"
19420 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4574
19422 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19423 "tar file) into C<directory>."
19428 #: ../src/guestfs-actions.pod:6783
19429 msgid "guestfs_txz_out"
19434 #: ../src/guestfs-actions.pod:6785
19438 " guestfs_txz_out (guestfs_h *g,\n"
19439 " const char *directory,\n"
19440 " const char *tarball);\n"
19446 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4583
19448 "This command packs the contents of C<directory> and downloads it to local "
19449 "file C<tarball> (as an xz compressed tar archive)."
19454 #: ../src/guestfs-actions.pod:6797
19455 msgid "guestfs_umask"
19460 #: ../src/guestfs-actions.pod:6799
19464 " guestfs_umask (guestfs_h *g,\n"
19471 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4592
19473 "This function sets the mask used for creating new files and device nodes to "
19479 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
19481 "Typical umask values would be C<022> which creates new files with "
19482 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19483 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19488 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4600
19490 "The default umask is C<022>. This is important because it means that "
19491 "directories and device nodes will be created with C<0644> or C<0755> mode "
19492 "even if you specify C<0777>."
19497 #: ../src/guestfs-actions.pod:6815
19499 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19500 "C<guestfs_mkdir>."
19505 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4607
19506 msgid "This call returns the previous umask."
19511 #: ../src/guestfs-actions.pod:6824
19512 msgid "guestfs_umount"
19517 #: ../src/guestfs-actions.pod:6826
19521 " guestfs_umount (guestfs_h *g,\n"
19522 " const char *pathordevice);\n"
19528 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4615
19530 "This unmounts the given filesystem. The filesystem may be specified either "
19531 "by its mountpoint (path) or the device which contains the filesystem."
19536 #: ../src/guestfs-actions.pod:6838
19537 msgid "guestfs_umount_all"
19542 #: ../src/guestfs-actions.pod:6840
19546 " guestfs_umount_all (guestfs_h *g);\n"
19552 #: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4625
19553 msgid "This unmounts all mounted filesystems."
19558 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4627
19559 msgid "Some internal mounts are not unmounted by this call."
19564 #: ../src/guestfs-actions.pod:6851
19565 msgid "guestfs_upload"
19570 #: ../src/guestfs-actions.pod:6853
19574 " guestfs_upload (guestfs_h *g,\n"
19575 " const char *filename,\n"
19576 " const char *remotefilename);\n"
19582 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6882
19583 #: ../fish/guestfish-actions.pod:4633 ../fish/guestfish-actions.pod:4646
19584 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19589 #: ../src/guestfs-actions.pod:6863
19590 msgid "See also C<guestfs_download>."
19595 #: ../src/guestfs-actions.pod:6874
19596 msgid "guestfs_upload_offset"
19601 #: ../src/guestfs-actions.pod:6876
19605 " guestfs_upload_offset (guestfs_h *g,\n"
19606 " const char *filename,\n"
19607 " const char *remotefilename,\n"
19608 " int64_t offset);\n"
19614 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4649
19616 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19617 "The intention is to overwrite parts of existing files or devices, although "
19618 "if a non-existant file is specified then it is created with a \"hole\" "
19619 "before C<offset>. The size of the data written is implicit in the size of "
19620 "the source C<filename>."
19625 #: ../src/guestfs-actions.pod:6892
19627 "Note that there is no limit on the amount of data that can be uploaded with "
19628 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19629 "full amount unless an error occurs."
19634 #: ../src/guestfs-actions.pod:6897
19635 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19640 #: ../src/guestfs-actions.pod:6908
19641 msgid "guestfs_utimens"
19646 #: ../src/guestfs-actions.pod:6910
19650 " guestfs_utimens (guestfs_h *g,\n"
19651 " const char *path,\n"
19652 " int64_t atsecs,\n"
19653 " int64_t atnsecs,\n"
19654 " int64_t mtsecs,\n"
19655 " int64_t mtnsecs);\n"
19661 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4669
19662 msgid "This command sets the timestamps of a file with nanosecond precision."
19667 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4672
19669 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19675 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4675
19677 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19678 "nanoseconds from the epoch."
19683 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4678
19685 "If the C<*nsecs> field contains the special value C<-1> then the "
19686 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19687 "ignored in this case)."
19692 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4682
19694 "If the C<*nsecs> field contains the special value C<-2> then the "
19695 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19701 #: ../src/guestfs-actions.pod:6939 ../src/guestfs-structs.pod:175
19702 msgid "guestfs_version"
19707 #: ../src/guestfs-actions.pod:6941
19710 " struct guestfs_version *\n"
19711 " guestfs_version (guestfs_h *g);\n"
19717 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4690
19719 "Return the libguestfs version number that the program is linked against."
19724 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
19726 "Note that because of dynamic linking this is not necessarily the version of "
19727 "libguestfs that you compiled against. You can compile the program, and then "
19728 "at runtime dynamically link against a completely different C<libguestfs.so> "
19734 #: ../src/guestfs-actions.pod:6952 ../fish/guestfish-actions.pod:4698
19736 "This call was added in version C<1.0.58>. In previous versions of "
19737 "libguestfs there was no way to get the version number. From C code you can "
19738 "use dynamic linker functions to find out if this symbol exists (if it "
19739 "doesn't, then it's an earlier version)."
19744 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4704
19746 "The call returns a structure with four elements. The first three (C<major>, "
19747 "C<minor> and C<release>) are numbers and correspond to the usual version "
19748 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19749 "but may be used for distro-specific information."
19754 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4710
19756 "To construct the original version string: C<$major.$minor.$release$extra>"
19761 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4713
19762 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19767 #: ../src/guestfs-actions.pod:6969
19769 "I<Note:> Don't use this call to test for availability of features. In "
19770 "enterprise distributions we backport features from later versions into "
19771 "earlier versions, making this an unreliable way to test for features. Use "
19772 "C<guestfs_available> instead."
19777 #: ../src/guestfs-actions.pod:6975
19779 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19780 "error. I<The caller must call C<guestfs_free_version> after use>."
19785 #: ../src/guestfs-actions.pod:6979
19786 msgid "(Added in 1.0.58)"
19791 #: ../src/guestfs-actions.pod:6981
19792 msgid "guestfs_vfs_label"
19797 #: ../src/guestfs-actions.pod:6983
19801 " guestfs_vfs_label (guestfs_h *g,\n"
19802 " const char *device);\n"
19808 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4725
19809 msgid "This returns the filesystem label of the filesystem on C<device>."
19814 #: ../src/guestfs-actions.pod:6990 ../fish/guestfish-actions.pod:4728
19815 msgid "If the filesystem is unlabeled, this returns the empty string."
19820 #: ../src/guestfs-actions.pod:6992
19821 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19826 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7034
19827 msgid "(Added in 1.3.18)"
19832 #: ../src/guestfs-actions.pod:6999
19833 msgid "guestfs_vfs_type"
19838 #: ../src/guestfs-actions.pod:7001
19842 " guestfs_vfs_type (guestfs_h *g,\n"
19843 " const char *device);\n"
19849 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4736
19851 "This command gets the filesystem type corresponding to the filesystem on "
19857 #: ../src/guestfs-actions.pod:7008 ../fish/guestfish-actions.pod:4739
19859 "For most filesystems, the result is the name of the Linux VFS module which "
19860 "would be used to mount this filesystem if you mounted it without specifying "
19861 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19866 #: ../src/guestfs-actions.pod:7018
19867 msgid "guestfs_vfs_uuid"
19872 #: ../src/guestfs-actions.pod:7020
19876 " guestfs_vfs_uuid (guestfs_h *g,\n"
19877 " const char *device);\n"
19883 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4748
19884 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19889 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4751
19890 msgid "If the filesystem does not have a UUID, this returns the empty string."
19895 #: ../src/guestfs-actions.pod:7029
19896 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19901 #: ../src/guestfs-actions.pod:7036
19902 msgid "guestfs_vg_activate"
19907 #: ../src/guestfs-actions.pod:7038
19911 " guestfs_vg_activate (guestfs_h *g,\n"
19913 " char *const *volgroups);\n"
19919 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4759
19921 "This command activates or (if C<activate> is false) deactivates all logical "
19922 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19923 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19924 "deactivated, then those devices disappear."
19929 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4765
19930 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19935 #: ../src/guestfs-actions.pod:7051 ../fish/guestfish-actions.pod:4767
19937 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19938 "activated or deactivated."
19943 #: ../src/guestfs-actions.pod:7058
19944 msgid "guestfs_vg_activate_all"
19949 #: ../src/guestfs-actions.pod:7060
19953 " guestfs_vg_activate_all (guestfs_h *g,\n"
19954 " int activate);\n"
19960 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4774
19962 "This command activates or (if C<activate> is false) deactivates all logical "
19963 "volumes in all volume groups. If activated, then they are made known to the "
19964 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19965 "those devices disappear."
19970 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4780
19971 msgid "This command is the same as running C<vgchange -a y|n>"
19976 #: ../src/guestfs-actions.pod:7076
19977 msgid "guestfs_vgcreate"
19982 #: ../src/guestfs-actions.pod:7078
19986 " guestfs_vgcreate (guestfs_h *g,\n"
19987 " const char *volgroup,\n"
19988 " char *const *physvols);\n"
19994 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4786
19996 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19997 "of physical volumes C<physvols>."
20002 #: ../src/guestfs-actions.pod:7090
20003 msgid "guestfs_vglvuuids"
20008 #: ../src/guestfs-actions.pod:7092
20012 " guestfs_vglvuuids (guestfs_h *g,\n"
20013 " const char *vgname);\n"
20019 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4793
20021 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
20022 "volumes created in this volume group."
20027 #: ../src/guestfs-actions.pod:7099
20029 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
20030 "associate logical volumes and volume groups."
20035 #: ../src/guestfs-actions.pod:7102
20036 msgid "See also C<guestfs_vgpvuuids>."
20041 #: ../src/guestfs-actions.pod:7110
20042 msgid "guestfs_vgpvuuids"
20047 #: ../src/guestfs-actions.pod:7112
20051 " guestfs_vgpvuuids (guestfs_h *g,\n"
20052 " const char *vgname);\n"
20058 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4805
20060 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20061 "volumes that this volume group resides on."
20066 #: ../src/guestfs-actions.pod:7119
20068 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20069 "associate physical volumes and volume groups."
20074 #: ../src/guestfs-actions.pod:7122
20075 msgid "See also C<guestfs_vglvuuids>."
20080 #: ../src/guestfs-actions.pod:7130
20081 msgid "guestfs_vgremove"
20086 #: ../src/guestfs-actions.pod:7132
20090 " guestfs_vgremove (guestfs_h *g,\n"
20091 " const char *vgname);\n"
20097 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4817
20098 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20103 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4819
20105 "This also forcibly removes all logical volumes in the volume group (if any)."
20110 #: ../src/guestfs-actions.pod:7145
20111 msgid "guestfs_vgrename"
20116 #: ../src/guestfs-actions.pod:7147
20120 " guestfs_vgrename (guestfs_h *g,\n"
20121 " const char *volgroup,\n"
20122 " const char *newvolgroup);\n"
20128 #: ../src/guestfs-actions.pod:7152 ../fish/guestfish-actions.pod:4826
20129 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20134 #: ../src/guestfs-actions.pod:7158
20135 msgid "guestfs_vgs"
20140 #: ../src/guestfs-actions.pod:7160
20144 " guestfs_vgs (guestfs_h *g);\n"
20150 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4832
20152 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20158 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4835
20160 "This returns a list of just the volume group names that were detected (eg. "
20166 #: ../src/guestfs-actions.pod:7169
20167 msgid "See also C<guestfs_vgs_full>."
20172 #: ../src/guestfs-actions.pod:7177
20173 msgid "guestfs_vgs_full"
20178 #: ../src/guestfs-actions.pod:7179
20181 " struct guestfs_lvm_vg_list *\n"
20182 " guestfs_vgs_full (guestfs_h *g);\n"
20188 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4844
20190 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20191 "> command. The \"full\" version includes all fields."
20196 #: ../src/guestfs-actions.pod:7185
20198 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20199 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20204 #: ../src/guestfs-actions.pod:7191
20205 msgid "guestfs_vgscan"
20210 #: ../src/guestfs-actions.pod:7193
20214 " guestfs_vgscan (guestfs_h *g);\n"
20220 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4851
20222 "This rescans all block devices and rebuilds the list of LVM physical "
20223 "volumes, volume groups and logical volumes."
20228 #: ../src/guestfs-actions.pod:7203
20229 msgid "guestfs_vguuid"
20234 #: ../src/guestfs-actions.pod:7205
20238 " guestfs_vguuid (guestfs_h *g,\n"
20239 " const char *vgname);\n"
20245 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4858
20246 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20251 #: ../src/guestfs-actions.pod:7216
20252 msgid "guestfs_wait_ready"
20257 #: ../src/guestfs-actions.pod:7218
20261 " guestfs_wait_ready (guestfs_h *g);\n"
20267 #: ../src/guestfs-actions.pod:7221
20268 msgid "This function is a no op."
20273 #: ../src/guestfs-actions.pod:7223
20275 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20276 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20277 "is no longer necessary because C<guestfs_launch> now does the waiting."
20282 #: ../src/guestfs-actions.pod:7228
20284 "If you see any calls to this function in code then you can just remove them, "
20285 "unless you want to retain compatibility with older versions of the API."
20289 #: ../src/guestfs-actions.pod:7234
20291 "This function is deprecated. In new code, use the L</guestfs_launch> call "
20297 #: ../src/guestfs-actions.pod:7243
20298 msgid "guestfs_wc_c"
20303 #: ../src/guestfs-actions.pod:7245
20307 " guestfs_wc_c (guestfs_h *g,\n"
20308 " const char *path);\n"
20314 #: ../src/guestfs-actions.pod:7249 ../fish/guestfish-actions.pod:4864
20316 "This command counts the characters in a file, using the C<wc -c> external "
20322 #: ../src/guestfs-actions.pod:7256
20323 msgid "guestfs_wc_l"
20328 #: ../src/guestfs-actions.pod:7258
20332 " guestfs_wc_l (guestfs_h *g,\n"
20333 " const char *path);\n"
20339 #: ../src/guestfs-actions.pod:7262 ../fish/guestfish-actions.pod:4871
20341 "This command counts the lines in a file, using the C<wc -l> external command."
20346 #: ../src/guestfs-actions.pod:7269
20347 msgid "guestfs_wc_w"
20352 #: ../src/guestfs-actions.pod:7271
20356 " guestfs_wc_w (guestfs_h *g,\n"
20357 " const char *path);\n"
20363 #: ../src/guestfs-actions.pod:7275 ../fish/guestfish-actions.pod:4878
20365 "This command counts the words in a file, using the C<wc -w> external command."
20370 #: ../src/guestfs-actions.pod:7282
20371 msgid "guestfs_write"
20376 #: ../src/guestfs-actions.pod:7284
20380 " guestfs_write (guestfs_h *g,\n"
20381 " const char *path,\n"
20382 " const char *content,\n"
20383 " size_t content_size);\n"
20389 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4885
20391 "This call creates a file called C<path>. The content of the file is the "
20392 "string C<content> (which can contain any 8 bit data)."
20397 #: ../src/guestfs-actions.pod:7300
20398 msgid "guestfs_write_file"
20403 #: ../src/guestfs-actions.pod:7302
20407 " guestfs_write_file (guestfs_h *g,\n"
20408 " const char *path,\n"
20409 " const char *content,\n"
20416 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4895
20418 "This call creates a file called C<path>. The contents of the file is the "
20419 "string C<content> (which can contain any 8 bit data), with length C<size>."
20424 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4899
20426 "As a special case, if C<size> is C<0> then the length is calculated using "
20427 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20432 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4903
20434 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20435 "I<not> work, even if the length is specified."
20439 #: ../src/guestfs-actions.pod:7324
20441 "This function is deprecated. In new code, use the L</guestfs_write> call "
20447 #: ../src/guestfs-actions.pod:7333
20448 msgid "guestfs_zegrep"
20453 #: ../src/guestfs-actions.pod:7335
20457 " guestfs_zegrep (guestfs_h *g,\n"
20458 " const char *regex,\n"
20459 " const char *path);\n"
20465 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4920
20467 "This calls the external C<zegrep> program and returns the matching lines."
20472 #: ../src/guestfs-actions.pod:7352
20473 msgid "guestfs_zegrepi"
20478 #: ../src/guestfs-actions.pod:7354
20482 " guestfs_zegrepi (guestfs_h *g,\n"
20483 " const char *regex,\n"
20484 " const char *path);\n"
20490 #: ../src/guestfs-actions.pod:7359 ../fish/guestfish-actions.pod:4930
20492 "This calls the external C<zegrep -i> program and returns the matching lines."
20497 #: ../src/guestfs-actions.pod:7371
20498 msgid "guestfs_zero"
20503 #: ../src/guestfs-actions.pod:7373
20507 " guestfs_zero (guestfs_h *g,\n"
20508 " const char *device);\n"
20514 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4940
20515 msgid "This command writes zeroes over the first few blocks of C<device>."
20520 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4942
20522 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20523 "securely wipe the device). It should be sufficient to remove any partition "
20524 "tables, filesystem superblocks and so on."
20529 #: ../src/guestfs-actions.pod:7383
20530 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20535 #: ../src/guestfs-actions.pod:7394
20536 msgid "guestfs_zero_device"
20541 #: ../src/guestfs-actions.pod:7396
20545 " guestfs_zero_device (guestfs_h *g,\n"
20546 " const char *device);\n"
20552 #: ../src/guestfs-actions.pod:7400
20554 "This command writes zeroes over the entire C<device>. Compare with "
20555 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20560 #: ../src/guestfs-actions.pod:7414
20561 msgid "(Added in 1.3.1)"
20566 #: ../src/guestfs-actions.pod:7416
20567 msgid "guestfs_zerofree"
20572 #: ../src/guestfs-actions.pod:7418
20576 " guestfs_zerofree (guestfs_h *g,\n"
20577 " const char *device);\n"
20583 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
20585 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20586 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20587 "possible to compress the filesystem more effectively."
20592 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4968
20593 msgid "You should B<not> run this program if the filesystem is mounted."
20598 #: ../src/guestfs-actions.pod:7430 ../fish/guestfish-actions.pod:4971
20600 "It is possible that using this program can damage the filesystem or data on "
20606 #: ../src/guestfs-actions.pod:7437
20607 msgid "guestfs_zfgrep"
20612 #: ../src/guestfs-actions.pod:7439
20616 " guestfs_zfgrep (guestfs_h *g,\n"
20617 " const char *pattern,\n"
20618 " const char *path);\n"
20624 #: ../src/guestfs-actions.pod:7444 ../fish/guestfish-actions.pod:4978
20626 "This calls the external C<zfgrep> program and returns the matching lines."
20631 #: ../src/guestfs-actions.pod:7456
20632 msgid "guestfs_zfgrepi"
20637 #: ../src/guestfs-actions.pod:7458
20641 " guestfs_zfgrepi (guestfs_h *g,\n"
20642 " const char *pattern,\n"
20643 " const char *path);\n"
20649 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4988
20651 "This calls the external C<zfgrep -i> program and returns the matching lines."
20656 #: ../src/guestfs-actions.pod:7475
20657 msgid "guestfs_zfile"
20662 #: ../src/guestfs-actions.pod:7477
20666 " guestfs_zfile (guestfs_h *g,\n"
20667 " const char *meth,\n"
20668 " const char *path);\n"
20674 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:4998
20676 "This command runs C<file> after first decompressing C<path> using C<method>."
20681 #: ../src/guestfs-actions.pod:7485 ../fish/guestfish-actions.pod:5001
20682 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20687 #: ../src/guestfs-actions.pod:7487
20689 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20694 #: ../src/guestfs-actions.pod:7493
20696 "This function is deprecated. In new code, use the L</guestfs_file> call "
20702 #: ../src/guestfs-actions.pod:7502
20703 msgid "guestfs_zgrep"
20708 #: ../src/guestfs-actions.pod:7504
20712 " guestfs_zgrep (guestfs_h *g,\n"
20713 " const char *regex,\n"
20714 " const char *path);\n"
20720 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:5017
20722 "This calls the external C<zgrep> program and returns the matching lines."
20727 #: ../src/guestfs-actions.pod:7521
20728 msgid "guestfs_zgrepi"
20733 #: ../src/guestfs-actions.pod:7523
20737 " guestfs_zgrepi (guestfs_h *g,\n"
20738 " const char *regex,\n"
20739 " const char *path);\n"
20745 #: ../src/guestfs-actions.pod:7528 ../fish/guestfish-actions.pod:5027
20747 "This calls the external C<zgrep -i> program and returns the matching lines."
20752 #: ../src/guestfs-availability.pod:3
20758 #: ../src/guestfs-availability.pod:5
20760 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20761 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20762 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20763 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20764 "L</guestfs_aug_save> L</guestfs_aug_set>"
20769 #: ../src/guestfs-availability.pod:21
20775 #: ../src/guestfs-availability.pod:23
20777 "The following functions: L</guestfs_inotify_add_watch> L</"
20778 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20779 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20784 #: ../src/guestfs-availability.pod:31
20785 msgid "B<linuxfsuuid>"
20790 #: ../src/guestfs-availability.pod:33
20792 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20793 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20798 #: ../src/guestfs-availability.pod:40
20799 msgid "B<linuxmodules>"
20804 #: ../src/guestfs-availability.pod:42
20805 msgid "The following functions: L</guestfs_modprobe>"
20810 #: ../src/guestfs-availability.pod:45
20811 msgid "B<linuxxattrs>"
20816 #: ../src/guestfs-availability.pod:47
20818 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20819 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20820 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20821 "guestfs_setxattr>"
20826 #: ../src/guestfs-availability.pod:58
20832 #: ../src/guestfs-availability.pod:60
20834 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20835 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20836 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20841 #: ../src/guestfs-availability.pod:69
20847 #: ../src/guestfs-availability.pod:71
20849 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20850 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20851 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20852 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20853 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20854 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20855 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20860 #: ../src/guestfs-availability.pod:94
20866 #: ../src/guestfs-availability.pod:96
20868 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20869 "guestfs_mknod_b> L</guestfs_mknod_c>"
20874 #: ../src/guestfs-availability.pod:102
20880 #: ../src/guestfs-availability.pod:104
20881 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20886 #: ../src/guestfs-availability.pod:107
20887 msgid "B<ntfsprogs>"
20892 #: ../src/guestfs-availability.pod:109
20894 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20899 #: ../src/guestfs-availability.pod:113
20900 msgid "B<realpath>"
20905 #: ../src/guestfs-availability.pod:115
20906 msgid "The following functions: L</guestfs_realpath>"
20911 #: ../src/guestfs-availability.pod:118
20917 #: ../src/guestfs-availability.pod:120
20919 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20920 "guestfs_scrub_freespace>"
20925 #: ../src/guestfs-availability.pod:125
20931 #: ../src/guestfs-availability.pod:127
20932 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20937 #: ../src/guestfs-availability.pod:131
20943 #: ../src/guestfs-availability.pod:133
20944 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20949 #: ../src/guestfs-availability.pod:137
20950 msgid "B<zerofree>"
20955 #: ../src/guestfs-availability.pod:139
20956 msgid "The following functions: L</guestfs_zerofree>"
20961 #: ../src/guestfs-structs.pod:1
20962 msgid "guestfs_int_bool"
20967 #: ../src/guestfs-structs.pod:3
20970 " struct guestfs_int_bool {\n"
20979 #: ../src/guestfs-structs.pod:8
20982 " struct guestfs_int_bool_list {\n"
20983 " uint32_t len; /* Number of elements in list. */\n"
20984 " struct guestfs_int_bool *val; /* Elements. */\n"
20991 #: ../src/guestfs-structs.pod:13
20994 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20995 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
21001 #: ../src/guestfs-structs.pod:16
21002 msgid "guestfs_lvm_pv"
21007 #: ../src/guestfs-structs.pod:18
21010 " struct guestfs_lvm_pv {\n"
21011 " char *pv_name;\n"
21012 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21013 " char pv_uuid[32];\n"
21015 " uint64_t pv_size;\n"
21016 " uint64_t dev_size;\n"
21017 " uint64_t pv_free;\n"
21018 " uint64_t pv_used;\n"
21019 " char *pv_attr;\n"
21020 " int64_t pv_pe_count;\n"
21021 " int64_t pv_pe_alloc_count;\n"
21022 " char *pv_tags;\n"
21023 " uint64_t pe_start;\n"
21024 " int64_t pv_mda_count;\n"
21025 " uint64_t pv_mda_free;\n"
21032 #: ../src/guestfs-structs.pod:36
21035 " struct guestfs_lvm_pv_list {\n"
21036 " uint32_t len; /* Number of elements in list. */\n"
21037 " struct guestfs_lvm_pv *val; /* Elements. */\n"
21044 #: ../src/guestfs-structs.pod:41
21047 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
21048 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21054 #: ../src/guestfs-structs.pod:44
21055 msgid "guestfs_lvm_vg"
21060 #: ../src/guestfs-structs.pod:46
21063 " struct guestfs_lvm_vg {\n"
21064 " char *vg_name;\n"
21065 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21066 " char vg_uuid[32];\n"
21068 " char *vg_attr;\n"
21069 " uint64_t vg_size;\n"
21070 " uint64_t vg_free;\n"
21071 " char *vg_sysid;\n"
21072 " uint64_t vg_extent_size;\n"
21073 " int64_t vg_extent_count;\n"
21074 " int64_t vg_free_count;\n"
21075 " int64_t max_lv;\n"
21076 " int64_t max_pv;\n"
21077 " int64_t pv_count;\n"
21078 " int64_t lv_count;\n"
21079 " int64_t snap_count;\n"
21080 " int64_t vg_seqno;\n"
21081 " char *vg_tags;\n"
21082 " int64_t vg_mda_count;\n"
21083 " uint64_t vg_mda_free;\n"
21090 #: ../src/guestfs-structs.pod:69
21093 " struct guestfs_lvm_vg_list {\n"
21094 " uint32_t len; /* Number of elements in list. */\n"
21095 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21102 #: ../src/guestfs-structs.pod:74
21105 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21106 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21112 #: ../src/guestfs-structs.pod:77
21113 msgid "guestfs_lvm_lv"
21118 #: ../src/guestfs-structs.pod:79
21121 " struct guestfs_lvm_lv {\n"
21122 " char *lv_name;\n"
21123 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21124 " char lv_uuid[32];\n"
21125 " char *lv_attr;\n"
21126 " int64_t lv_major;\n"
21127 " int64_t lv_minor;\n"
21128 " int64_t lv_kernel_major;\n"
21129 " int64_t lv_kernel_minor;\n"
21130 " uint64_t lv_size;\n"
21131 " int64_t seg_count;\n"
21133 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21134 " float snap_percent;\n"
21135 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21136 " float copy_percent;\n"
21137 " char *move_pv;\n"
21138 " char *lv_tags;\n"
21139 " char *mirror_log;\n"
21140 " char *modules;\n"
21147 #: ../src/guestfs-structs.pod:101
21150 " struct guestfs_lvm_lv_list {\n"
21151 " uint32_t len; /* Number of elements in list. */\n"
21152 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21159 #: ../src/guestfs-structs.pod:106
21162 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21163 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21169 #: ../src/guestfs-structs.pod:111
21172 " struct guestfs_stat {\n"
21176 " int64_t nlink;\n"
21181 " int64_t blksize;\n"
21182 " int64_t blocks;\n"
21183 " int64_t atime;\n"
21184 " int64_t mtime;\n"
21185 " int64_t ctime;\n"
21192 #: ../src/guestfs-structs.pod:127
21195 " struct guestfs_stat_list {\n"
21196 " uint32_t len; /* Number of elements in list. */\n"
21197 " struct guestfs_stat *val; /* Elements. */\n"
21204 #: ../src/guestfs-structs.pod:132
21207 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21208 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21214 #: ../src/guestfs-structs.pod:137
21217 " struct guestfs_statvfs {\n"
21218 " int64_t bsize;\n"
21219 " int64_t frsize;\n"
21220 " int64_t blocks;\n"
21221 " int64_t bfree;\n"
21222 " int64_t bavail;\n"
21223 " int64_t files;\n"
21224 " int64_t ffree;\n"
21225 " int64_t favail;\n"
21228 " int64_t namemax;\n"
21235 #: ../src/guestfs-structs.pod:151
21238 " struct guestfs_statvfs_list {\n"
21239 " uint32_t len; /* Number of elements in list. */\n"
21240 " struct guestfs_statvfs *val; /* Elements. */\n"
21247 #: ../src/guestfs-structs.pod:156
21250 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21251 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21257 #: ../src/guestfs-structs.pod:159
21258 msgid "guestfs_dirent"
21263 #: ../src/guestfs-structs.pod:161
21266 " struct guestfs_dirent {\n"
21276 #: ../src/guestfs-structs.pod:167
21279 " struct guestfs_dirent_list {\n"
21280 " uint32_t len; /* Number of elements in list. */\n"
21281 " struct guestfs_dirent *val; /* Elements. */\n"
21288 #: ../src/guestfs-structs.pod:172
21291 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21292 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21298 #: ../src/guestfs-structs.pod:177
21301 " struct guestfs_version {\n"
21302 " int64_t major;\n"
21303 " int64_t minor;\n"
21304 " int64_t release;\n"
21312 #: ../src/guestfs-structs.pod:184
21315 " struct guestfs_version_list {\n"
21316 " uint32_t len; /* Number of elements in list. */\n"
21317 " struct guestfs_version *val; /* Elements. */\n"
21324 #: ../src/guestfs-structs.pod:189
21327 " void guestfs_free_version (struct guestfs_free_version *);\n"
21328 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21334 #: ../src/guestfs-structs.pod:192
21335 msgid "guestfs_xattr"
21340 #: ../src/guestfs-structs.pod:194
21343 " struct guestfs_xattr {\n"
21344 " char *attrname;\n"
21345 " /* The next two fields describe a byte array. */\n"
21346 " uint32_t attrval_len;\n"
21347 " char *attrval;\n"
21354 #: ../src/guestfs-structs.pod:201
21357 " struct guestfs_xattr_list {\n"
21358 " uint32_t len; /* Number of elements in list. */\n"
21359 " struct guestfs_xattr *val; /* Elements. */\n"
21366 #: ../src/guestfs-structs.pod:206
21369 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21370 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21376 #: ../src/guestfs-structs.pod:209
21377 msgid "guestfs_inotify_event"
21382 #: ../src/guestfs-structs.pod:211
21385 " struct guestfs_inotify_event {\n"
21386 " int64_t in_wd;\n"
21387 " uint32_t in_mask;\n"
21388 " uint32_t in_cookie;\n"
21389 " char *in_name;\n"
21396 #: ../src/guestfs-structs.pod:218
21399 " struct guestfs_inotify_event_list {\n"
21400 " uint32_t len; /* Number of elements in list. */\n"
21401 " struct guestfs_inotify_event *val; /* Elements. */\n"
21408 #: ../src/guestfs-structs.pod:223
21411 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21412 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21418 #: ../src/guestfs-structs.pod:226
21419 msgid "guestfs_partition"
21424 #: ../src/guestfs-structs.pod:228
21427 " struct guestfs_partition {\n"
21428 " int32_t part_num;\n"
21429 " uint64_t part_start;\n"
21430 " uint64_t part_end;\n"
21431 " uint64_t part_size;\n"
21438 #: ../src/guestfs-structs.pod:235
21441 " struct guestfs_partition_list {\n"
21442 " uint32_t len; /* Number of elements in list. */\n"
21443 " struct guestfs_partition *val; /* Elements. */\n"
21450 #: ../src/guestfs-structs.pod:240
21453 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21454 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21460 #: ../src/guestfs-structs.pod:243
21461 msgid "guestfs_application"
21466 #: ../src/guestfs-structs.pod:245
21469 " struct guestfs_application {\n"
21470 " char *app_name;\n"
21471 " char *app_display_name;\n"
21472 " int32_t app_epoch;\n"
21473 " char *app_version;\n"
21474 " char *app_release;\n"
21475 " char *app_install_path;\n"
21476 " char *app_trans_path;\n"
21477 " char *app_publisher;\n"
21478 " char *app_url;\n"
21479 " char *app_source_package;\n"
21480 " char *app_summary;\n"
21481 " char *app_description;\n"
21488 #: ../src/guestfs-structs.pod:260
21491 " struct guestfs_application_list {\n"
21492 " uint32_t len; /* Number of elements in list. */\n"
21493 " struct guestfs_application *val; /* Elements. */\n"
21500 #: ../src/guestfs-structs.pod:265
21503 " void guestfs_free_application (struct guestfs_free_application *);\n"
21504 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21510 #: ../fish/guestfish.pod:5
21511 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21516 #: ../fish/guestfish.pod:9
21519 " guestfish [--options] [commands]\n"
21525 #: ../fish/guestfish.pod:11
21534 #: ../fish/guestfish.pod:13
21537 " guestfish [--ro|--rw] -a disk.img\n"
21543 #: ../fish/guestfish.pod:15
21546 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21552 #: ../fish/guestfish.pod:17
21555 " guestfish -d libvirt-domain\n"
21561 #: ../fish/guestfish.pod:19
21564 " guestfish [--ro|--rw] -a disk.img -i\n"
21570 #: ../fish/guestfish.pod:21
21573 " guestfish -d libvirt-domain -i\n"
21579 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21580 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21586 #: ../fish/guestfish.pod:25
21588 "Using guestfish in read/write mode on live virtual machines can be "
21589 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21590 "option to use guestfish safely if the disk image or virtual machine might be "
21596 #: ../fish/guestfish.pod:32
21598 "Guestfish is a shell and command-line tool for examining and modifying "
21599 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21600 "functionality of the guestfs API, see L<guestfs(3)>."
21605 #: ../fish/guestfish.pod:36
21607 "Guestfish gives you structured access to the libguestfs API, from shell "
21608 "scripts or the command line or interactively. If you want to rescue a "
21609 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21615 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:958
21616 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21622 #: ../fish/guestfish.pod:43
21623 msgid "As an interactive shell"
21628 #: ../fish/guestfish.pod:45
21637 #: ../fish/guestfish.pod:47
21640 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21641 " editing virtual machine filesystems.\n"
21647 #: ../fish/guestfish.pod:50
21650 " Type: 'help' for a list of commands\n"
21651 " 'man' to read the manual\n"
21652 " 'quit' to quit the shell\n"
21658 #: ../fish/guestfish.pod:54
21661 " ><fs> add-ro disk.img\n"
21663 " ><fs> list-filesystems\n"
21664 " /dev/sda1: ext4\n"
21665 " /dev/vg_guest/lv_root: ext4\n"
21666 " /dev/vg_guest/lv_swap: swap\n"
21667 " ><fs> mount /dev/vg_guest/lv_root /\n"
21668 " ><fs> cat /etc/fstab\n"
21670 " # Created by anaconda\n"
21678 #: ../fish/guestfish.pod:67
21679 msgid "From shell scripts"
21684 #: ../fish/guestfish.pod:69
21685 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21690 #: ../fish/guestfish.pod:71
21693 " guestfish <<_EOF_\n"
21696 " mount /dev/vg_guest/lv_root /\n"
21697 " write /etc/motd \"Welcome, new users\"\n"
21704 #: ../fish/guestfish.pod:78
21705 msgid "List the LVM logical volumes in a disk image:"
21710 #: ../fish/guestfish.pod:80
21713 " guestfish -a disk.img --ro <<_EOF_\n"
21722 #: ../fish/guestfish.pod:85
21723 msgid "List all the filesystems in a disk image:"
21728 #: ../fish/guestfish.pod:87
21731 " guestfish -a disk.img --ro <<_EOF_\n"
21733 " list-filesystems\n"
21740 #: ../fish/guestfish.pod:92
21741 msgid "On one command line"
21746 #: ../fish/guestfish.pod:94
21747 msgid "Update C</etc/resolv.conf> in a guest:"
21752 #: ../fish/guestfish.pod:96
21756 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21757 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21763 #: ../fish/guestfish.pod:100
21764 msgid "Edit C</boot/grub/grub.conf> interactively:"
21769 #: ../fish/guestfish.pod:102
21772 " guestfish --rw --add disk.img \\\n"
21773 " --mount /dev/vg_guest/lv_root \\\n"
21774 " --mount /dev/sda1:/boot \\\n"
21775 " edit /boot/grub/grub.conf\n"
21781 #: ../fish/guestfish.pod:107
21782 msgid "Mount disks automatically"
21787 #: ../fish/guestfish.pod:109
21789 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21794 #: ../fish/guestfish.pod:112
21797 " guestfish --ro -a disk.img -i cat /etc/group\n"
21803 #: ../fish/guestfish.pod:114
21806 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21812 #: ../fish/guestfish.pod:116
21813 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21818 #: ../fish/guestfish.pod:118
21821 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21827 #: ../fish/guestfish.pod:120
21828 msgid "As a script interpreter"
21833 #: ../fish/guestfish.pod:122
21834 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21839 #: ../fish/guestfish.pod:124
21842 " #!/usr/bin/guestfish -f\n"
21843 " sparse test1.img 100M\n"
21845 " part-disk /dev/sda mbr\n"
21846 " mkfs ext2 /dev/sda1\n"
21852 #: ../fish/guestfish.pod:130
21853 msgid "Start with a prepared disk"
21858 #: ../fish/guestfish.pod:132
21860 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21861 "single ext2-formatted partition:"
21866 #: ../fish/guestfish.pod:135
21869 " guestfish -N fs\n"
21875 #: ../fish/guestfish.pod:137
21876 msgid "To list what is available do:"
21881 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:949
21884 " guestfish -N help | less\n"
21890 #: ../fish/guestfish.pod:141
21891 msgid "Remote control"
21896 #: ../fish/guestfish.pod:143
21899 " eval \"`guestfish --listen`\"\n"
21900 " guestfish --remote add-ro disk.img\n"
21901 " guestfish --remote run\n"
21902 " guestfish --remote lvs\n"
21908 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21909 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
21910 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21911 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21912 #: ../tools/virt-list-partitions.pl:54
21918 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
21919 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21920 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21921 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21927 #: ../fish/guestfish.pod:154
21928 msgid "Displays general help on options."
21933 #: ../fish/guestfish.pod:156
21939 #: ../fish/guestfish.pod:158
21940 msgid "B<--cmd-help>"
21945 #: ../fish/guestfish.pod:160
21946 msgid "Lists all available guestfish commands."
21951 #: ../fish/guestfish.pod:162
21957 #: ../fish/guestfish.pod:164
21958 msgid "B<--cmd-help cmd>"
21963 #: ../fish/guestfish.pod:166
21964 msgid "Displays detailed help on a single command C<cmd>."
21969 #: ../fish/guestfish.pod:168
21970 msgid "B<-a image>"
21975 #: ../fish/guestfish.pod:170
21976 msgid "B<--add image>"
21981 #: ../fish/guestfish.pod:172
21982 msgid "Add a block device or virtual machine image to the shell."
21987 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
21989 "The format of the disk image is auto-detected. To override this and force a "
21990 "particular format use the I<--format=..> option."
21994 #: ../fish/guestfish.pod:177
21996 "Using this flag is mostly equivalent to using the C<add> command, with "
21997 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21998 "the I<--format=...> flag was given."
22003 #: ../fish/guestfish.pod:181
22009 #: ../fish/guestfish.pod:183
22010 msgid "B<--connect URI>"
22015 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
22017 "When used in conjunction with the I<-d> option, this specifies the libvirt "
22018 "URI to use. The default is to use the default libvirt connection."
22023 #: ../fish/guestfish.pod:189
22029 #: ../fish/guestfish.pod:191
22031 "If using the I<--listen> option and a csh-like shell, use this option. See "
22032 "section L</REMOTE CONTROL AND CSH> below."
22037 #: ../fish/guestfish.pod:194
22038 msgid "B<-d libvirt-domain>"
22043 #: ../fish/guestfish.pod:196
22044 msgid "B<--domain libvirt-domain>"
22049 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
22051 "Add disks from the named libvirt domain. If the I<--ro> option is also "
22052 "used, then any libvirt domain can be used. However in write mode, only "
22053 "libvirt domains which are shut down can be named here."
22058 #: ../fish/guestfish.pod:202
22060 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22061 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22062 "if the I<--format:...> flag was given."
22067 #: ../fish/guestfish.pod:206
22073 #: ../fish/guestfish.pod:208
22074 msgid "B<--no-dest-paths>"
22079 #: ../fish/guestfish.pod:210
22081 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22082 "to hit the tab key to complete paths on the guest filesystem, but this "
22083 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22084 "allow this feature to be disabled."
22089 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
22090 msgid "B<--echo-keys>"
22095 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
22097 "When prompting for keys and passphrases, guestfish normally turns echoing "
22098 "off so you cannot see what you are typing. If you are not worried about "
22099 "Tempest attacks and there is no one else in the room you can specify this "
22100 "flag to see what you are typing."
22105 #: ../fish/guestfish.pod:222
22111 #: ../fish/guestfish.pod:224
22112 msgid "B<--file file>"
22117 #: ../fish/guestfish.pod:226
22118 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22123 #: ../fish/guestfish.pod:229
22126 " #!/usr/bin/guestfish -f\n"
22132 #: ../fish/guestfish.pod:231
22133 msgid "B<--format=raw|qcow2|..>"
22138 #: ../fish/guestfish.pod:233
22139 msgid "B<--format>"
22144 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
22146 "The default for the I<-a> option is to auto-detect the format of the disk "
22147 "image. Using this forces the disk format for I<-a> options which follow on "
22148 "the command line. Using I<--format> with no argument switches back to auto-"
22149 "detection for subsequent I<-a> options."
22154 #: ../fish/guestfish.pod:242
22157 " guestfish --format=raw -a disk.img\n"
22163 #: ../fish/guestfish.pod:244
22164 msgid "forces raw format (no auto-detection) for C<disk.img>."
22169 #: ../fish/guestfish.pod:246
22172 " guestfish --format=raw -a disk.img --format -a another.img\n"
22178 #: ../fish/guestfish.pod:248
22180 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22181 "detection for C<another.img>."
22186 #: ../fish/guestfish.pod:251
22188 "If you have untrusted raw-format guest disk images, you should use this "
22189 "option to specify the disk format. This avoids a possible security problem "
22190 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22195 #: ../fish/guestfish.pod:256
22201 #: ../fish/guestfish.pod:258
22202 msgid "B<--inspector>"
22207 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
22209 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22210 "system and mount filesystems as they would be mounted on the real virtual "
22216 #: ../fish/guestfish.pod:264
22217 msgid "Typical usage is either:"
22222 #: ../fish/guestfish.pod:266
22225 " guestfish -d myguest -i\n"
22231 #: ../fish/guestfish.pod:268
22232 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22237 #: ../fish/guestfish.pod:270
22240 " guestfish --ro -d myguest -i\n"
22246 #: ../fish/guestfish.pod:272
22247 msgid "(for active domains, readonly), or specify the block device directly:"
22252 #: ../fish/guestfish.pod:274
22255 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22261 #: ../fish/guestfish.pod:276
22263 "Note that the command line syntax changed slightly over older versions of "
22264 "guestfish. You can still use the old syntax:"
22269 #: ../fish/guestfish.pod:279
22272 " guestfish [--ro] -i disk.img\n"
22278 #: ../fish/guestfish.pod:281
22281 " guestfish [--ro] -i libvirt-domain\n"
22287 #: ../fish/guestfish.pod:283
22289 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22290 "then using other commands to mount the filesystems that were found."
22295 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
22296 msgid "B<--keys-from-stdin>"
22301 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
22303 "Read key or passphrase parameters from stdin. The default is to try to read "
22304 "passphrases from the user by opening C</dev/tty>."
22309 #: ../fish/guestfish.pod:292
22310 msgid "B<--listen>"
22315 #: ../fish/guestfish.pod:294
22317 "Fork into the background and listen for remote commands. See section L</"
22318 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22322 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
22327 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
22329 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22330 "ATTACHING TO RUNNING DAEMONS>)."
22334 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
22335 msgid "B<-m dev[:mountpoint[:options]]>"
22339 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
22340 msgid "B<--mount dev[:mountpoint[:options]]>"
22345 #: ../fish/guestfish.pod:306
22346 msgid "Mount the named partition or logical volume on the given mountpoint."
22351 #: ../fish/guestfish.pod:308
22352 msgid "If the mountpoint is omitted, it defaults to C</>."
22357 #: ../fish/guestfish.pod:310
22358 msgid "You have to mount something on C</> before most commands will work."
22363 #: ../fish/guestfish.pod:312
22365 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22371 #: ../fish/guestfish.pod:315
22373 "If you don't know what filesystems a disk image contains, you can either run "
22374 "guestfish without this option, then list the partitions, filesystems and LVs "
22375 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22376 "commands), or you can use the L<virt-filesystems(1)> program."
22380 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
22382 "The third (and rarely used) part of the mount parameter is the list of mount "
22383 "options used to mount the underlying filesystem. If this is not given, then "
22384 "the mount options are either the empty string or C<ro> (the latter if the "
22385 "I<--ro> flag is used). By specifying the mount options, you override this "
22386 "default choice. Probably the only time you would use this is to enable ACLs "
22387 "and/or extended attributes if the filesystem can support them:"
22391 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
22394 " -m /dev/sda1:/:acl,user_xattr\n"
22399 #: ../fish/guestfish.pod:331
22400 msgid "Using this flag is equivalent to using the C<mount-options> command."
22405 #: ../fish/guestfish.pod:333
22411 #: ../fish/guestfish.pod:335
22412 msgid "B<--no-sync>"
22417 #: ../fish/guestfish.pod:337
22419 "Disable autosync. This is enabled by default. See the discussion of "
22420 "autosync in the L<guestfs(3)> manpage."
22425 #: ../fish/guestfish.pod:340
22431 #: ../fish/guestfish.pod:342
22432 msgid "B<--new type>"
22437 #: ../fish/guestfish.pod:344
22443 #: ../fish/guestfish.pod:346
22445 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22446 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22447 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22453 #: ../fish/guestfish.pod:351
22454 msgid "B<--progress-bars>"
22459 #: ../fish/guestfish.pod:353
22460 msgid "Enable progress bars, even when guestfish is used non-interactively."
22465 #: ../fish/guestfish.pod:355
22467 "Progress bars are enabled by default when guestfish is used as an "
22468 "interactive shell."
22473 #: ../fish/guestfish.pod:358
22474 msgid "B<--no-progress-bars>"
22479 #: ../fish/guestfish.pod:360
22480 msgid "Disable progress bars."
22485 #: ../fish/guestfish.pod:362
22486 msgid "B<--remote[=pid]>"
22491 #: ../fish/guestfish.pod:364
22493 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22494 "CONTROL GUESTFISH OVER A SOCKET> below."
22499 #: ../fish/guestfish.pod:367
22505 #: ../fish/guestfish.pod:369
22511 #: ../fish/guestfish.pod:371
22513 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22514 "mounts are done read-only."
22519 #: ../fish/guestfish.pod:374
22521 "The option must always be used if the disk image or virtual machine might be "
22522 "running, and is generally recommended in cases where you don't need write "
22523 "access to the disk."
22528 #: ../fish/guestfish.pod:378
22530 "Note that prepared disk images created with I<-N> are not affected by this "
22531 "option. Also commands like C<add> are not affected - you have to specify "
22532 "the C<readonly:true> option explicitly if you need it."
22537 #: ../fish/guestfish.pod:382
22538 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22543 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
22544 msgid "B<--selinux>"
22549 #: ../fish/guestfish.pod:386
22550 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22555 #: ../fish/guestfish.pod:388
22561 #: ../fish/guestfish.pod:390
22562 msgid "B<--verbose>"
22567 #: ../fish/guestfish.pod:392
22569 "Enable very verbose messages. This is particularly useful if you find a bug."
22574 #: ../fish/guestfish.pod:395
22580 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22581 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22582 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22583 #: ../tools/virt-list-partitions.pl:70
22584 msgid "B<--version>"
22589 #: ../fish/guestfish.pod:399
22590 msgid "Display the guestfish / libguestfs version number and exit."
22595 #: ../fish/guestfish.pod:401
22601 #: ../fish/guestfish.pod:403
22606 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
22608 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22609 "mounts are done read-write."
22613 #: ../fish/guestfish.pod:408
22614 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22619 #: ../fish/guestfish.pod:410
22625 #: ../fish/guestfish.pod:412
22626 msgid "Echo each command before executing it."
22631 #: ../fish/guestfish.pod:416
22632 msgid "COMMANDS ON COMMAND LINE"
22637 #: ../fish/guestfish.pod:418
22639 "Any additional (non-option) arguments are treated as commands to execute."
22644 #: ../fish/guestfish.pod:421
22646 "Commands to execute should be separated by a colon (C<:>), where the colon "
22647 "is a separate parameter. Thus:"
22652 #: ../fish/guestfish.pod:424
22655 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22661 #: ../fish/guestfish.pod:426
22663 "If there are no additional arguments, then we enter a shell, either an "
22664 "interactive shell with a prompt (if the input is a terminal) or a non-"
22665 "interactive shell."
22670 #: ../fish/guestfish.pod:430
22672 "In either command line mode or non-interactive shell, the first command that "
22673 "gives an error causes the whole shell to exit. In interactive mode (with a "
22674 "prompt) if a command fails, you can continue to enter commands."
22679 #: ../fish/guestfish.pod:435
22680 msgid "USING launch (OR run)"
22685 #: ../fish/guestfish.pod:437
22687 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22688 "then launch it, then mount any disks you need, and finally issue actions/"
22689 "commands. So the general order of the day is:"
22694 #: ../fish/guestfish.pod:445
22695 msgid "add or -a/--add"
22700 #: ../fish/guestfish.pod:449
22701 msgid "launch (aka run)"
22706 #: ../fish/guestfish.pod:453
22707 msgid "mount or -m/--mount"
22712 #: ../fish/guestfish.pod:457
22713 msgid "any other commands"
22718 #: ../fish/guestfish.pod:461
22720 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22721 "guest before mounting or performing any other commands."
22726 #: ../fish/guestfish.pod:464
22728 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22729 "I<--new> options were given then C<run> is done automatically, simply "
22730 "because guestfish can't perform the action you asked for without doing this."
22735 #: ../fish/guestfish.pod:469
22736 msgid "OPENING DISKS FOR READ AND WRITE"
22740 #: ../fish/guestfish.pod:471
22742 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22743 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22744 "I<-i> and I<-m> open disk images read-only or for writing."
22748 #: ../fish/guestfish.pod:476
22750 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22751 "opening disk images supplied on the command line for write. To open a disk "
22752 "image read-only you have to do I<-a image --ro>."
22757 #: ../fish/guestfish.pod:480
22759 "This matters: If you accidentally open a live VM disk image writable then "
22760 "you will cause irreversible disk corruption."
22764 #: ../fish/guestfish.pod:483
22766 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22767 "images will be opened read-only. You will have to either specify "
22768 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22769 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22770 "access for disk images specified by those other command line options."
22774 #: ../fish/guestfish.pod:490
22776 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22777 "which does nothing (it is already the default). However it is highly "
22778 "recommended that you use this option to indicate that you need write access, "
22779 "and prepare your scripts for the day when this option will be required for "
22785 #: ../fish/guestfish.pod:496
22787 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22788 "other libguestfs program apart from guestfish and guestmount."
22793 #: ../fish/guestfish.pod:499
22799 #: ../fish/guestfish.pod:501
22801 "You can quote ordinary parameters using either single or double quotes. For "
22807 #: ../fish/guestfish.pod:504
22810 " add \"file with a space.img\"\n"
22816 #: ../fish/guestfish.pod:506
22819 " rm '/file name'\n"
22825 #: ../fish/guestfish.pod:508
22834 #: ../fish/guestfish.pod:510
22836 "A few commands require a list of strings to be passed. For these, use a "
22837 "whitespace-separated list, enclosed in quotes. Strings containing "
22838 "whitespace to be passed through must be enclosed in single quotes. A "
22839 "literal single quote must be escaped with a backslash."
22844 #: ../fish/guestfish.pod:515
22847 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22848 " command \"/bin/echo 'foo bar'\"\n"
22849 " command \"/bin/echo \\'foo\\'\"\n"
22855 #: ../fish/guestfish.pod:519
22856 msgid "OPTIONAL ARGUMENTS"
22861 #: ../fish/guestfish.pod:521
22863 "Some commands take optional arguments. These arguments appear in this "
22864 "documentation as C<[argname:..]>. You can use them as in these examples:"
22869 #: ../fish/guestfish.pod:525
22872 " add-drive-opts filename\n"
22878 #: ../fish/guestfish.pod:527
22881 " add-drive-opts filename readonly:true\n"
22887 #: ../fish/guestfish.pod:529
22890 " add-drive-opts filename format:qcow2 readonly:false\n"
22896 #: ../fish/guestfish.pod:531
22898 "Each optional argument can appear at most once. All optional arguments must "
22899 "appear after the required ones."
22904 #: ../fish/guestfish.pod:534
22910 #: ../fish/guestfish.pod:536
22912 "This section applies to all commands which can take integers as parameters."
22917 #: ../fish/guestfish.pod:539
22918 msgid "SIZE SUFFIX"
22923 #: ../fish/guestfish.pod:541
22925 "When the command takes a parameter measured in bytes, you can use one of the "
22926 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22931 #: ../fish/guestfish.pod:547
22932 msgid "B<k> or B<K> or B<KiB>"
22937 #: ../fish/guestfish.pod:549
22938 msgid "The size in kilobytes (multiplied by 1024)."
22943 #: ../fish/guestfish.pod:551
22949 #: ../fish/guestfish.pod:553
22950 msgid "The size in SI 1000 byte units."
22955 #: ../fish/guestfish.pod:555
22956 msgid "B<M> or B<MiB>"
22961 #: ../fish/guestfish.pod:557
22962 msgid "The size in megabytes (multiplied by 1048576)."
22967 #: ../fish/guestfish.pod:559
22973 #: ../fish/guestfish.pod:561
22974 msgid "The size in SI 1000000 byte units."
22979 #: ../fish/guestfish.pod:563
22980 msgid "B<G> or B<GiB>"
22985 #: ../fish/guestfish.pod:565
22986 msgid "The size in gigabytes (multiplied by 2**30)."
22991 #: ../fish/guestfish.pod:567
22997 #: ../fish/guestfish.pod:569
22998 msgid "The size in SI 10**9 byte units."
23003 #: ../fish/guestfish.pod:571
23004 msgid "B<T> or B<TiB>"
23009 #: ../fish/guestfish.pod:573
23010 msgid "The size in terabytes (multiplied by 2**40)."
23015 #: ../fish/guestfish.pod:575
23021 #: ../fish/guestfish.pod:577
23022 msgid "The size in SI 10**12 byte units."
23027 #: ../fish/guestfish.pod:579
23028 msgid "B<P> or B<PiB>"
23033 #: ../fish/guestfish.pod:581
23034 msgid "The size in petabytes (multiplied by 2**50)."
23039 #: ../fish/guestfish.pod:583
23045 #: ../fish/guestfish.pod:585
23046 msgid "The size in SI 10**15 byte units."
23051 #: ../fish/guestfish.pod:587
23052 msgid "B<E> or B<EiB>"
23057 #: ../fish/guestfish.pod:589
23058 msgid "The size in exabytes (multiplied by 2**60)."
23063 #: ../fish/guestfish.pod:591
23069 #: ../fish/guestfish.pod:593
23070 msgid "The size in SI 10**18 byte units."
23075 #: ../fish/guestfish.pod:595
23076 msgid "B<Z> or B<ZiB>"
23081 #: ../fish/guestfish.pod:597
23082 msgid "The size in zettabytes (multiplied by 2**70)."
23087 #: ../fish/guestfish.pod:599
23093 #: ../fish/guestfish.pod:601
23094 msgid "The size in SI 10**21 byte units."
23099 #: ../fish/guestfish.pod:603
23100 msgid "B<Y> or B<YiB>"
23105 #: ../fish/guestfish.pod:605
23106 msgid "The size in yottabytes (multiplied by 2**80)."
23111 #: ../fish/guestfish.pod:607
23117 #: ../fish/guestfish.pod:609
23118 msgid "The size in SI 10**24 byte units."
23123 #: ../fish/guestfish.pod:615
23126 " truncate-size /file 1G\n"
23132 #: ../fish/guestfish.pod:617
23133 msgid "would truncate the file to 1 gigabyte."
23138 #: ../fish/guestfish.pod:619
23140 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23141 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23142 "suffix will probably not do what you expect."
23147 #: ../fish/guestfish.pod:623
23148 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23153 #: ../fish/guestfish.pod:625
23155 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23156 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23161 #: ../fish/guestfish.pod:628
23164 " 1234 decimal number 1234\n"
23165 " 02322 octal number, equivalent to decimal 1234\n"
23166 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23172 #: ../fish/guestfish.pod:632
23174 "When using the C<chmod> command, you almost always want to specify an octal "
23175 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23176 "L<chmod(1)> program):"
23181 #: ../fish/guestfish.pod:636
23184 " chmod 0777 /public # OK\n"
23185 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23191 #: ../fish/guestfish.pod:639
23193 "Commands that return numbers usually print them in decimal, but some "
23194 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23195 "octal, preceeded by C<0>)."
23200 #: ../fish/guestfish.pod:643
23201 msgid "WILDCARDS AND GLOBBING"
23206 #: ../fish/guestfish.pod:645
23208 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23209 "(globbing) by default. So for example the following will not do what you "
23215 #: ../fish/guestfish.pod:649
23224 #: ../fish/guestfish.pod:651
23226 "Assuming you don't have a directory called literally C</home/*> then the "
23227 "above command will return an error."
23232 #: ../fish/guestfish.pod:654
23233 msgid "To perform wildcard expansion, use the C<glob> command."
23238 #: ../fish/guestfish.pod:656
23241 " glob rm-rf /home/*\n"
23247 #: ../fish/guestfish.pod:658
23249 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23250 "many times), equivalent to:"
23255 #: ../fish/guestfish.pod:661
23258 " rm-rf /home/jim\n"
23259 " rm-rf /home/joe\n"
23260 " rm-rf /home/mary\n"
23266 #: ../fish/guestfish.pod:665
23267 msgid "C<glob> only works on simple guest paths and not on device names."
23272 #: ../fish/guestfish.pod:667
23274 "If you have several parameters, each containing a wildcard, then glob will "
23275 "perform a Cartesian product."
23280 #: ../fish/guestfish.pod:670
23286 #: ../fish/guestfish.pod:672
23288 "Any line which starts with a I<#> character is treated as a comment and "
23289 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23290 "a command. For example:"
23295 #: ../fish/guestfish.pod:676
23298 " # this is a comment\n"
23299 " # this is a comment\n"
23300 " foo # NOT a comment\n"
23306 #: ../fish/guestfish.pod:680
23307 msgid "Blank lines are also ignored."
23312 #: ../fish/guestfish.pod:682
23313 msgid "RUNNING COMMANDS LOCALLY"
23318 #: ../fish/guestfish.pod:684
23320 "Any line which starts with a I<!> character is treated as a command sent to "
23321 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23326 #: ../fish/guestfish.pod:688
23330 " tgz-out /remote local/remote-data.tar.gz\n"
23336 #: ../fish/guestfish.pod:691
23338 "will create a directory C<local> on the host, and then export the contents "
23339 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23340 "(See C<tgz-out>)."
23345 #: ../fish/guestfish.pod:695
23347 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23348 "effect, due to the way that subprocesses work in Unix."
23352 #: ../fish/guestfish.pod:698
23353 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23357 #: ../fish/guestfish.pod:700
23359 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23360 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23361 "and executed as guestfish commands."
23365 #: ../fish/guestfish.pod:704
23367 "Thus you can use shell script to construct arbitrary guestfish commands "
23368 "which are then parsed by guestfish."
23372 #: ../fish/guestfish.pod:707
23374 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23375 "through C</foo.100>) using guestfish commands alone. However this is simple "
23376 "if we use a shell script to create the guestfish commands for us:"
23380 #: ../fish/guestfish.pod:712
23383 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23388 #: ../fish/guestfish.pod:714
23389 msgid "or with names like C</foo.001>:"
23393 #: ../fish/guestfish.pod:716
23396 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23401 #: ../fish/guestfish.pod:718
23403 "When using guestfish interactively it can be helpful to just run the shell "
23404 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23405 "ordinary I<!> local command), see what guestfish commands it would run, and "
23406 "when you are happy with those prepend the C<E<lt>> character to run the "
23407 "guestfish commands for real."
23412 #: ../fish/guestfish.pod:724
23418 #: ../fish/guestfish.pod:726
23420 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23421 "command (a guestfish command) to the second command (any host command). For "
23427 #: ../fish/guestfish.pod:730
23430 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23436 #: ../fish/guestfish.pod:732
23438 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23439 "program). The above command would list all accounts in the guest filesystem "
23440 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23445 #: ../fish/guestfish.pod:737
23448 " hexdump /bin/ls | head\n"
23449 " list-devices | tail -1\n"
23450 " tgz-out / - | tar ztf -\n"
23456 #: ../fish/guestfish.pod:741
23458 "The space before the pipe symbol is required, any space after the pipe "
23459 "symbol is optional. Everything after the pipe symbol is just passed "
23460 "straight to the host shell, so it can contain redirections, globs and "
23461 "anything else that makes sense on the host side."
23466 #: ../fish/guestfish.pod:746
23468 "To use a literal argument which begins with a pipe symbol, you have to quote "
23474 #: ../fish/guestfish.pod:749
23483 #: ../fish/guestfish.pod:751
23484 msgid "HOME DIRECTORIES"
23489 #: ../fish/guestfish.pod:753
23491 "If a parameter starts with the character C<~> then the tilde may be expanded "
23492 "as a home directory path (either C<~> for the current user's home directory, "
23493 "or C<~user> for another user)."
23498 #: ../fish/guestfish.pod:757
23500 "Note that home directory expansion happens for users known I<on the host>, "
23501 "not in the guest filesystem."
23506 #: ../fish/guestfish.pod:760
23508 "To use a literal argument which begins with a tilde, you have to quote it, "
23514 #: ../fish/guestfish.pod:763
23523 #: ../fish/guestfish.pod:767
23525 "Libguestfs has some support for Linux guests encrypted according to the "
23526 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23527 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23528 "LUKS is supported."
23533 #: ../fish/guestfish.pod:772
23534 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23539 #: ../fish/guestfish.pod:774
23542 " ><fs> vfs-type /dev/sda2\n"
23549 #: ../fish/guestfish.pod:777
23551 "Then open those devices using L</luks-open>. This creates a device-mapper "
23552 "device called C</dev/mapper/luksdev>."
23557 #: ../fish/guestfish.pod:780
23560 " ><fs> luks-open /dev/sda2 luksdev\n"
23561 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23567 #: ../fish/guestfish.pod:783
23569 "Finally you have to tell LVM to scan for volume groups on the newly created "
23575 #: ../fish/guestfish.pod:786
23579 " vg-activate-all true\n"
23585 #: ../fish/guestfish.pod:789
23586 msgid "The logical volume(s) can now be mounted in the usual way."
23591 #: ../fish/guestfish.pod:791
23593 "Before closing a LUKS device you must unmount any logical volumes on it and "
23594 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23595 "one. Then you can close the mapper device:"
23600 #: ../fish/guestfish.pod:795
23603 " vg-activate false /dev/VG\n"
23604 " luks-close /dev/mapper/luksdev\n"
23610 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23611 msgid "WINDOWS PATHS"
23615 #: ../fish/guestfish.pod:800
23617 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23618 "letters and paths (with some limitations). The following commands are "
23624 #: ../fish/guestfish.pod:804
23627 " file /WINDOWS/system32/config/system.LOG\n"
23633 #: ../fish/guestfish.pod:806
23636 " file win:\\windows\\system32\\config\\system.log\n"
23641 #: ../fish/guestfish.pod:808
23644 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23649 #: ../fish/guestfish.pod:810
23651 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23652 "where the drive is mounted, prepending that to the path, changing all "
23653 "backslash characters to forward slash, then resolving the result using L</"
23654 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23655 "the parameter might be rewritten like this:"
23659 #: ../fish/guestfish.pod:816
23662 " win:e:\\foo\\bar => /e/FOO/bar\n"
23667 #: ../fish/guestfish.pod:818
23668 msgid "This only works in argument positions that expect a path."
23673 #: ../fish/guestfish.pod:820
23674 msgid "UPLOADING AND DOWNLOADING FILES"
23679 #: ../fish/guestfish.pod:822
23681 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23682 "others which upload from or download to a local file, you can use the "
23683 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23688 #: ../fish/guestfish.pod:826
23697 #: ../fish/guestfish.pod:828
23699 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23704 #: ../fish/guestfish.pod:831
23707 " tar-out /etc - | tar tf -\n"
23713 #: ../fish/guestfish.pod:833
23715 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23716 "command (see L</PIPES>)."
23721 #: ../fish/guestfish.pod:836
23723 "When using C<-> to read from stdin, the input is read up to the end of "
23724 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23725 "some arbitrary end marker:"
23730 #: ../fish/guestfish.pod:840
23733 " upload -<<END /foo\n"
23743 #: ../fish/guestfish.pod:846
23745 "Any string of characters can be used instead of C<END>. The end marker must "
23746 "appear on a line of its own, without any preceeding or following characters "
23747 "(not even spaces)."
23752 #: ../fish/guestfish.pod:850
23754 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23755 "upload local files (so-called \"FileIn\" parameters in the generator)."
23760 #: ../fish/guestfish.pod:853
23761 msgid "EXIT ON ERROR BEHAVIOUR"
23766 #: ../fish/guestfish.pod:855
23768 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23769 "taking commands from a human over a tty), and will exit on the first error "
23770 "in non-interactive mode (scripts, commands given on the command line)."
23775 #: ../fish/guestfish.pod:860
23777 "If you prefix a command with a I<-> character, then that command will not "
23778 "cause guestfish to exit, even if that (one) command returns an error."
23783 #: ../fish/guestfish.pod:864
23784 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23789 #: ../fish/guestfish.pod:866
23791 "Guestfish can be remote-controlled over a socket. This is useful "
23792 "particularly in shell scripts where you want to make several different "
23793 "changes to a filesystem, but you don't want the overhead of starting up a "
23794 "guestfish process each time."
23799 #: ../fish/guestfish.pod:871
23800 msgid "Start a guestfish server process using:"
23805 #: ../fish/guestfish.pod:873
23808 " eval \"`guestfish --listen`\"\n"
23814 #: ../fish/guestfish.pod:875
23815 msgid "and then send it commands by doing:"
23820 #: ../fish/guestfish.pod:877
23823 " guestfish --remote cmd [...]\n"
23829 #: ../fish/guestfish.pod:879
23830 msgid "To cause the server to exit, send it the exit command:"
23835 #: ../fish/guestfish.pod:881
23838 " guestfish --remote exit\n"
23844 #: ../fish/guestfish.pod:883
23846 "Note that the server will normally exit if there is an error in a command. "
23847 "You can change this in the usual way. See section L</EXIT ON ERROR "
23853 #: ../fish/guestfish.pod:887
23854 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23859 #: ../fish/guestfish.pod:889
23861 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23862 "is how the I<--remote> option knows where to send the commands. You can "
23863 "have several guestfish listener processes running using:"
23868 #: ../fish/guestfish.pod:893
23871 " eval \"`guestfish --listen`\"\n"
23872 " pid1=$GUESTFISH_PID\n"
23873 " eval \"`guestfish --listen`\"\n"
23874 " pid2=$GUESTFISH_PID\n"
23876 " guestfish --remote=$pid1 cmd\n"
23877 " guestfish --remote=$pid2 cmd\n"
23883 #: ../fish/guestfish.pod:901
23884 msgid "REMOTE CONTROL AND CSH"
23889 #: ../fish/guestfish.pod:903
23891 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23897 #: ../fish/guestfish.pod:906
23900 " eval \"`guestfish --listen --csh`\"\n"
23906 #: ../fish/guestfish.pod:908
23907 msgid "REMOTE CONTROL DETAILS"
23912 #: ../fish/guestfish.pod:910
23914 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23915 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23916 "and C<$PID> is the process ID of the server."
23921 #: ../fish/guestfish.pod:914
23922 msgid "Guestfish client and server versions must match exactly."
23926 #: ../fish/guestfish.pod:916
23927 msgid "REMOTE CONTROL RUN COMMAND HANGING"
23931 #: ../fish/guestfish.pod:918
23933 "Using the C<run> (or C<launch>) command remotely in a command substitution "
23934 "context hangs, ie. don't do (note the backquotes):"
23938 #: ../fish/guestfish.pod:921
23941 " a=`guestfish --remote run`\n"
23946 #: ../fish/guestfish.pod:923
23948 "Since the C<run> command produces no output on stdout, this is not useful "
23949 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
23955 #: ../fish/guestfish.pod:927
23956 msgid "PREPARED DISK IMAGES"
23961 #: ../fish/guestfish.pod:929
23963 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23964 "preformatted disk images that guestfish can make for you to save typing. "
23965 "This is particularly useful for testing purposes. This option is used "
23966 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23967 "can be mixed with I<-a>)."
23972 #: ../fish/guestfish.pod:935
23974 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23975 "the second and so on. Existing files in the current directory are "
23981 #: ../fish/guestfish.pod:939
23983 "The type briefly describes how the disk should be sized, partitioned, how "
23984 "filesystem(s) should be created, and how content should be added. "
23985 "Optionally the type can be followed by extra parameters, separated by C<:> "
23986 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23987 "allocated disk, containing a single partition, with the partition formatted "
23988 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23994 #: ../fish/guestfish.pod:947
23995 msgid "To list the available types and any extra parameters they take, run:"
24000 #: ../fish/guestfish.pod:951
24002 "Note that the prepared filesystem is not mounted. You would usually have to "
24003 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
24008 #: ../fish/guestfish.pod:955
24010 "If any I<-N> or I<--new> options are given, the guest is automatically "
24016 #: ../fish/guestfish.pod:960
24017 msgid "Create a 100MB disk with an ext4-formatted partition:"
24022 #: ../fish/guestfish.pod:962
24025 " guestfish -N fs:ext4\n"
24031 #: ../fish/guestfish.pod:964
24032 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
24037 #: ../fish/guestfish.pod:966
24040 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
24046 #: ../fish/guestfish.pod:968
24047 msgid "Create a blank 200MB disk:"
24052 #: ../fish/guestfish.pod:970
24055 " guestfish -N disk:200M\n"
24061 #: ../fish/guestfish.pod:972
24062 msgid "PROGRESS BARS"
24067 #: ../fish/guestfish.pod:974
24069 "Some (not all) long-running commands send progress notification messages as "
24070 "they are running. Guestfish turns these messages into progress bars."
24075 #: ../fish/guestfish.pod:978
24077 "When a command that supports progress bars takes longer than two seconds to "
24078 "run, and if progress bars are enabled, then you will see one appearing below "
24084 #: ../fish/guestfish.pod:982
24087 " ><fs> copy-size /large-file /another-file 2048M\n"
24088 " / 10% [#####-----------------------------------------] 00:30\n"
24094 #: ../fish/guestfish.pod:985
24096 "The spinner on the left hand side moves round once for every progress "
24097 "notification received from the backend. This is a (reasonably) golden "
24098 "assurance that the command is \"doing something\" even if the progress bar "
24099 "is not moving, because the command is able to send the progress "
24100 "notifications. When the bar reaches 100% and the command finishes, the "
24101 "spinner disappears."
24106 #: ../fish/guestfish.pod:992
24108 "Progress bars are enabled by default when guestfish is used interactively. "
24109 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24110 "and you can disable them completely using I<--no-progress-bars>."
24115 #: ../fish/guestfish.pod:997
24116 msgid "GUESTFISH COMMANDS"
24121 #: ../fish/guestfish.pod:999
24123 "The commands in this section are guestfish convenience commands, in other "
24124 "words, they are not part of the L<guestfs(3)> API."
24129 #: ../fish/guestfish.pod:1002
24135 #: ../fish/guestfish.pod:1004
24145 #: ../fish/guestfish.pod:1007
24146 msgid "Without any parameter, this provides general help."
24151 #: ../fish/guestfish.pod:1009
24152 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24157 #: ../fish/guestfish.pod:1011
24158 msgid "quit | exit"
24163 #: ../fish/guestfish.pod:1013
24164 msgid "This exits guestfish. You can also use C<^D> key."
24169 #: ../fish/guestfish.pod:1015
24170 msgid "@FISH_COMMANDS@"
24175 #: ../fish/guestfish.pod:1017
24181 #: ../fish/guestfish.pod:1021 ../test-tool/libguestfs-test-tool.pod:77
24187 #: ../fish/guestfish.pod:1023
24189 "guestfish returns 0 if the commands completed without error, or 1 if there "
24195 #: ../fish/guestfish.pod:1030
24201 #: ../fish/guestfish.pod:1032
24203 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24209 #: ../fish/guestfish.pod:1035
24210 msgid "GUESTFISH_PID"
24215 #: ../fish/guestfish.pod:1037
24217 "Used with the I<--remote> option to specify the remote guestfish process to "
24218 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24223 #: ../fish/guestfish.pod:1041
24229 #: ../fish/guestfish.pod:1043
24231 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24232 "not specified, the external L<hexedit(1)> program is used."
24237 #: ../fish/guestfish.pod:1047
24243 #: ../fish/guestfish.pod:1049
24245 "If compiled with GNU readline support, various files in the home directory "
24246 "can be used. See L</FILES>."
24251 #: ../fish/guestfish.pod:1058
24253 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24254 "effect as using the B<-v> option."
24259 #: ../fish/guestfish.pod:1070
24261 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24262 "the discussion of paths in L<guestfs(3)>."
24267 #: ../fish/guestfish.pod:1081
24268 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24273 #: ../fish/guestfish.pod:1083
24279 #: ../fish/guestfish.pod:1085
24281 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24287 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:262
24292 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:266
24293 msgid "$HOME/.libguestfs-tools.rc"
24297 #: ../fish/guestfish.pod:1107 ../fuse/guestmount.pod:268
24298 msgid "/etc/libguestfs-tools.conf"
24302 #: ../fish/guestfish.pod:1109 ../fuse/guestmount.pod:270
24304 "This configuration file controls the default read-only or read-write mode "
24305 "(I<--ro> or I<--rw>)."
24309 #: ../fish/guestfish.pod:1112
24310 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24315 #: ../fish/guestfish.pod:1114
24316 msgid "$HOME/.guestfish"
24321 #: ../fish/guestfish.pod:1116
24323 "If compiled with GNU readline support, then the command history is saved in "
24329 #: ../fish/guestfish.pod:1119
24330 msgid "$HOME/.inputrc"
24335 #: ../fish/guestfish.pod:1121
24336 msgid "/etc/inputrc"
24341 #: ../fish/guestfish.pod:1123
24343 "If compiled with GNU readline support, then these files can be used to "
24344 "configure readline. For further information, please see L<readline(3)/"
24345 "INITIALIZATION FILE>."
24350 #: ../fish/guestfish.pod:1127
24351 msgid "To write rules which only apply to guestfish, use:"
24356 #: ../fish/guestfish.pod:1129
24367 #: ../fish/guestfish.pod:1133
24369 "Variables that you can set in inputrc that change the behaviour of guestfish "
24370 "in useful ways include:"
24375 #: ../fish/guestfish.pod:1138
24376 msgid "completion-ignore-case (default: on)"
24381 #: ../fish/guestfish.pod:1140
24383 "By default, guestfish will ignore case when tab-completing paths on the "
24389 #: ../fish/guestfish.pod:1143
24392 " set completion-ignore-case off\n"
24398 #: ../fish/guestfish.pod:1145
24399 msgid "to make guestfish case sensitive."
24404 #: ../fish/guestfish.pod:1149
24410 #: ../fish/guestfish.pod:1151
24411 msgid "test2.img (etc)"
24415 #: ../fish/guestfish.pod:1153
24417 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24418 "will be created in the file C<test1.img> in the current directory. The "
24419 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24420 "the same name will be overwritten."
24424 #: ../fish/guestfish.pod:1162
24426 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24427 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24428 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24429 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24430 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24431 ">, L<hexedit(1)>."
24436 #: ../fish/guestfish.pod:1192 ../test-tool/libguestfs-test-tool.pod:102
24437 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
24438 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24439 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24440 #: ../tools/virt-list-partitions.pl:277
24442 "This program is free software; you can redistribute it and/or modify it "
24443 "under the terms of the GNU General Public License as published by the Free "
24444 "Software Foundation; either version 2 of the License, or (at your option) "
24445 "any later version."
24450 #: ../fish/guestfish.pod:1197 ../test-tool/libguestfs-test-tool.pod:107
24451 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
24452 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24453 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24454 #: ../tools/virt-list-partitions.pl:282
24456 "This program is distributed in the hope that it will be useful, but WITHOUT "
24457 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24458 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24464 #: ../fish/guestfish.pod:1202 ../test-tool/libguestfs-test-tool.pod:112
24465 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
24466 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24467 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24468 #: ../tools/virt-list-partitions.pl:287
24470 "You should have received a copy of the GNU General Public License along with "
24471 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24472 "Ave, Cambridge, MA 02139, USA."
24477 #: ../fish/guestfish-actions.pod:1
24483 #: ../fish/guestfish-actions.pod:3
24486 " add-cdrom filename\n"
24492 #: ../fish/guestfish-actions.pod:15
24494 "This call checks for the existence of C<filename>. This stops you from "
24495 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24496 "and C<http:> URLs. To specify those, use the general L</config> call "
24502 #: ../fish/guestfish-actions.pod:22
24504 "If you just want to add an ISO file (often you use this as an efficient way "
24505 "to transfer large files into the guest), then you should probably use L</add-"
24506 "drive-ro> instead."
24510 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158
24511 #: ../fish/guestfish-actions.pod:172
24513 "This function is deprecated. In new code, use the L</add_drive_opts> call "
24519 #: ../fish/guestfish-actions.pod:35
24525 #: ../fish/guestfish-actions.pod:37
24530 #: ../fish/guestfish-actions.pod:39
24533 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24539 #: ../fish/guestfish-actions.pod:41
24541 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24542 "It works by connecting to libvirt, requesting the domain and domain XML from "
24543 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24548 #: ../fish/guestfish-actions.pod:71
24550 "The other optional parameters are passed directly through to L</add-drive-"
24556 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24557 #: ../fish/guestfish-actions.pod:3049
24559 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24564 #: ../fish/guestfish-actions.pod:76
24570 #: ../fish/guestfish-actions.pod:78
24573 " add-drive filename\n"
24579 #: ../fish/guestfish-actions.pod:80
24581 "This function is the equivalent of calling L</add-drive-opts> with no "
24582 "optional parameters, so the disk is added writable, with the format being "
24583 "detected automatically."
24588 #: ../fish/guestfish-actions.pod:84
24590 "Automatic detection of the format opens you up to a potential security hole "
24591 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24592 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24593 "you should think about replacing calls to this function with calls to L</add-"
24594 "drive-opts>, and specifying the format."
24599 #: ../fish/guestfish-actions.pod:91
24600 msgid "add-drive-opts"
24605 #: ../fish/guestfish-actions.pod:93
24611 #: ../fish/guestfish-actions.pod:95
24614 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24620 #: ../fish/guestfish-actions.pod:122
24622 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24623 "add-drive-ro>) then the format is automatically detected. Possible formats "
24624 "include C<raw> and C<qcow2>."
24629 #: ../fish/guestfish-actions.pod:133
24631 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24632 "add-drive-with-if> call (q.v.)"
24637 #: ../fish/guestfish-actions.pod:140
24638 msgid "add-drive-ro"
24643 #: ../fish/guestfish-actions.pod:142
24649 #: ../fish/guestfish-actions.pod:144
24652 " add-drive-ro filename\n"
24658 #: ../fish/guestfish-actions.pod:146
24660 "This function is the equivalent of calling L</add-drive-opts> with the "
24661 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24662 "is added read-only, with the format being detected automatically."
24667 #: ../fish/guestfish-actions.pod:151
24668 msgid "add-drive-ro-with-if"
24673 #: ../fish/guestfish-actions.pod:153
24676 " add-drive-ro-with-if filename iface\n"
24682 #: ../fish/guestfish-actions.pod:155
24684 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24685 "interface emulation to use at run time."
24690 #: ../fish/guestfish-actions.pod:165
24691 msgid "add-drive-with-if"
24696 #: ../fish/guestfish-actions.pod:167
24699 " add-drive-with-if filename iface\n"
24705 #: ../fish/guestfish-actions.pod:169
24707 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24708 "interface emulation to use at run time."
24713 #: ../fish/guestfish-actions.pod:179
24719 #: ../fish/guestfish-actions.pod:181
24722 " aug-clear augpath\n"
24728 #: ../fish/guestfish-actions.pod:186
24734 #: ../fish/guestfish-actions.pod:188
24743 #: ../fish/guestfish-actions.pod:190
24745 "Close the current Augeas handle and free up any resources used by it. After "
24746 "calling this, you have to call L</aug-init> again before you can use any "
24747 "other Augeas functions."
24752 #: ../fish/guestfish-actions.pod:195
24753 msgid "aug-defnode"
24758 #: ../fish/guestfish-actions.pod:197
24761 " aug-defnode name expr val\n"
24767 #: ../fish/guestfish-actions.pod:202
24769 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24770 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24771 "containing that single node."
24776 #: ../fish/guestfish-actions.pod:210
24782 #: ../fish/guestfish-actions.pod:212
24785 " aug-defvar name expr\n"
24791 #: ../fish/guestfish-actions.pod:221
24797 #: ../fish/guestfish-actions.pod:223
24800 " aug-get augpath\n"
24806 #: ../fish/guestfish-actions.pod:228
24812 #: ../fish/guestfish-actions.pod:230
24815 " aug-init root flags\n"
24821 #: ../fish/guestfish-actions.pod:236
24822 msgid "You must call this before using any other L</aug-*> commands."
24826 #: ../fish/guestfish-actions.pod:261
24828 "This option is only useful when debugging Augeas lenses. Use of this option "
24829 "may require additional memory for the libguestfs appliance. You may need to "
24830 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
24835 #: ../fish/guestfish-actions.pod:276
24836 msgid "Do not load the tree in L</aug-init>."
24841 #: ../fish/guestfish-actions.pod:280
24842 msgid "To close the handle, you can call L</aug-close>."
24847 #: ../fish/guestfish-actions.pod:284
24853 #: ../fish/guestfish-actions.pod:286
24856 " aug-insert augpath label true|false\n"
24862 #: ../fish/guestfish-actions.pod:296
24868 #: ../fish/guestfish-actions.pod:298
24877 #: ../fish/guestfish-actions.pod:305
24883 #: ../fish/guestfish-actions.pod:307
24886 " aug-ls augpath\n"
24892 #: ../fish/guestfish-actions.pod:309
24894 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24895 "resulting nodes into alphabetical order."
24900 #: ../fish/guestfish-actions.pod:312
24906 #: ../fish/guestfish-actions.pod:314
24909 " aug-match augpath\n"
24915 #: ../fish/guestfish-actions.pod:320
24921 #: ../fish/guestfish-actions.pod:322
24924 " aug-mv src dest\n"
24930 #: ../fish/guestfish-actions.pod:327
24936 #: ../fish/guestfish-actions.pod:329
24939 " aug-rm augpath\n"
24945 #: ../fish/guestfish-actions.pod:335
24951 #: ../fish/guestfish-actions.pod:337
24960 #: ../fish/guestfish-actions.pod:341
24962 "The flags which were passed to L</aug-init> affect exactly how files are "
24968 #: ../fish/guestfish-actions.pod:344
24974 #: ../fish/guestfish-actions.pod:346
24977 " aug-set augpath val\n"
24983 #: ../fish/guestfish-actions.pod:350
24985 "In the Augeas API, it is possible to clear a node by setting the value to "
24986 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24987 "this call. Instead you must use the L</aug-clear> call."
24992 #: ../fish/guestfish-actions.pod:355
24998 #: ../fish/guestfish-actions.pod:357
25001 " available 'groups ...'\n"
25007 #: ../fish/guestfish-actions.pod:363
25009 "The libguestfs groups, and the functions that those groups correspond to, "
25010 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
25011 "runtime by calling L</available-all-groups>."
25016 #: ../fish/guestfish-actions.pod:387
25017 msgid "You must call L</launch> before calling this function."
25022 #: ../fish/guestfish-actions.pod:409
25024 "This call was added in version C<1.0.80>. In previous versions of "
25025 "libguestfs all you could do would be to speculatively execute a command to "
25026 "find out if the daemon implemented it. See also L</version>."
25031 #: ../fish/guestfish-actions.pod:416
25032 msgid "available-all-groups"
25037 #: ../fish/guestfish-actions.pod:418
25040 " available-all-groups\n"
25046 #: ../fish/guestfish-actions.pod:420
25048 "This command returns a list of all optional groups that this daemon knows "
25049 "about. Note this returns both supported and unsupported groups. To find "
25050 "out which ones the daemon can actually support you have to call L</"
25051 "available> on each member of the returned list."
25056 #: ../fish/guestfish-actions.pod:426
25057 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
25062 #: ../fish/guestfish-actions.pod:428
25068 #: ../fish/guestfish-actions.pod:430
25071 " base64-in (base64file|-) filename\n"
25077 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
25078 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
25079 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
25080 #: ../fish/guestfish-actions.pod:4491 ../fish/guestfish-actions.pod:4503
25081 #: ../fish/guestfish-actions.pod:4514 ../fish/guestfish-actions.pod:4525
25082 #: ../fish/guestfish-actions.pod:4577 ../fish/guestfish-actions.pod:4586
25083 #: ../fish/guestfish-actions.pod:4640 ../fish/guestfish-actions.pod:4663
25084 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
25089 #: ../fish/guestfish-actions.pod:437
25095 #: ../fish/guestfish-actions.pod:439
25098 " base64-out filename (base64file|-)\n"
25104 #: ../fish/guestfish-actions.pod:446
25105 msgid "blockdev-flushbufs"
25110 #: ../fish/guestfish-actions.pod:448
25113 " blockdev-flushbufs device\n"
25119 #: ../fish/guestfish-actions.pod:455
25120 msgid "blockdev-getbsz"
25125 #: ../fish/guestfish-actions.pod:457
25128 " blockdev-getbsz device\n"
25134 #: ../fish/guestfish-actions.pod:466
25135 msgid "blockdev-getro"
25140 #: ../fish/guestfish-actions.pod:468
25143 " blockdev-getro device\n"
25149 #: ../fish/guestfish-actions.pod:475
25150 msgid "blockdev-getsize64"
25155 #: ../fish/guestfish-actions.pod:477
25158 " blockdev-getsize64 device\n"
25164 #: ../fish/guestfish-actions.pod:481
25165 msgid "See also L</blockdev-getsz>."
25170 #: ../fish/guestfish-actions.pod:485
25171 msgid "blockdev-getss"
25176 #: ../fish/guestfish-actions.pod:487
25179 " blockdev-getss device\n"
25185 #: ../fish/guestfish-actions.pod:492
25187 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25192 #: ../fish/guestfish-actions.pod:497
25193 msgid "blockdev-getsz"
25198 #: ../fish/guestfish-actions.pod:499
25201 " blockdev-getsz device\n"
25207 #: ../fish/guestfish-actions.pod:504
25209 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25210 "blockdev-getsize64> for the more useful I<size in bytes>."
25215 #: ../fish/guestfish-actions.pod:510
25216 msgid "blockdev-rereadpt"
25221 #: ../fish/guestfish-actions.pod:512
25224 " blockdev-rereadpt device\n"
25230 #: ../fish/guestfish-actions.pod:518
25231 msgid "blockdev-setbsz"
25236 #: ../fish/guestfish-actions.pod:520
25239 " blockdev-setbsz device blocksize\n"
25245 #: ../fish/guestfish-actions.pod:529
25246 msgid "blockdev-setro"
25251 #: ../fish/guestfish-actions.pod:531
25254 " blockdev-setro device\n"
25260 #: ../fish/guestfish-actions.pod:537
25261 msgid "blockdev-setrw"
25266 #: ../fish/guestfish-actions.pod:539
25269 " blockdev-setrw device\n"
25275 #: ../fish/guestfish-actions.pod:545
25276 msgid "case-sensitive-path"
25281 #: ../fish/guestfish-actions.pod:547
25284 " case-sensitive-path path\n"
25290 #: ../fish/guestfish-actions.pod:571
25292 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25293 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25294 "the directories were originally created under Windows)."
25299 #: ../fish/guestfish-actions.pod:579
25300 msgid "See also L</realpath>."
25305 #: ../fish/guestfish-actions.pod:581
25311 #: ../fish/guestfish-actions.pod:583
25320 #: ../fish/guestfish-actions.pod:587
25322 "Note that this function cannot correctly handle binary files (specifically, "
25323 "files containing C<\\0> character which is treated as end of string). For "
25324 "those you need to use the L</read-file> or L</download> functions which have "
25325 "a more complex interface."
25330 #: ../fish/guestfish-actions.pod:595
25336 #: ../fish/guestfish-actions.pod:597
25339 " checksum csumtype path\n"
25345 #: ../fish/guestfish-actions.pod:640
25346 msgid "To get the checksum for a device, use L</checksum-device>."
25351 #: ../fish/guestfish-actions.pod:642
25352 msgid "To get the checksums for many files, use L</checksums-out>."
25357 #: ../fish/guestfish-actions.pod:644
25358 msgid "checksum-device"
25363 #: ../fish/guestfish-actions.pod:646
25366 " checksum-device csumtype device\n"
25372 #: ../fish/guestfish-actions.pod:648
25374 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25375 "device named C<device>. For the types of checksums supported see the L</"
25376 "checksum> command."
25381 #: ../fish/guestfish-actions.pod:652
25382 msgid "checksums-out"
25387 #: ../fish/guestfish-actions.pod:654
25390 " checksums-out csumtype directory (sumsfile|-)\n"
25396 #: ../fish/guestfish-actions.pod:670
25402 #: ../fish/guestfish-actions.pod:672
25405 " chmod mode path\n"
25411 #: ../fish/guestfish-actions.pod:683
25417 #: ../fish/guestfish-actions.pod:685
25420 " chown owner group path\n"
25426 #: ../fish/guestfish-actions.pod:693
25432 #: ../fish/guestfish-actions.pod:695
25435 " command 'arguments ...'\n"
25441 #: ../fish/guestfish-actions.pod:702
25443 "The single parameter is an argv-style list of arguments. The first element "
25444 "is the name of the program to run. Subsequent elements are parameters. The "
25445 "list must be non-empty (ie. must contain a program name). Note that the "
25446 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25451 #: ../fish/guestfish-actions.pod:730
25452 msgid "command-lines"
25457 #: ../fish/guestfish-actions.pod:732
25460 " command-lines 'arguments ...'\n"
25466 #: ../fish/guestfish-actions.pod:734
25468 "This is the same as L</command>, but splits the result into a list of lines."
25473 #: ../fish/guestfish-actions.pod:737
25474 msgid "See also: L</sh-lines>"
25479 #: ../fish/guestfish-actions.pod:742
25485 #: ../fish/guestfish-actions.pod:744
25488 " config qemuparam qemuvalue\n"
25494 #: ../fish/guestfish-actions.pod:755
25500 #: ../fish/guestfish-actions.pod:757
25503 " copy-size src dest size\n"
25509 #: ../fish/guestfish-actions.pod:765
25515 #: ../fish/guestfish-actions.pod:767
25524 #: ../fish/guestfish-actions.pod:772
25530 #: ../fish/guestfish-actions.pod:774
25539 #: ../fish/guestfish-actions.pod:779
25545 #: ../fish/guestfish-actions.pod:781
25554 #: ../fish/guestfish-actions.pod:788
25556 "If the destination is a device, it must be as large or larger than the "
25557 "source file or device, otherwise the copy will fail. This command cannot do "
25558 "partial copies (see L</copy-size>)."
25563 #: ../fish/guestfish-actions.pod:792
25569 #: ../fish/guestfish-actions.pod:794
25578 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
25580 "This command is mostly useful for interactive sessions. It is I<not> "
25581 "intended that you try to parse the output string. Use L</statvfs> from "
25587 #: ../fish/guestfish-actions.pod:802
25593 #: ../fish/guestfish-actions.pod:804
25602 #: ../fish/guestfish-actions.pod:813
25608 #: ../fish/guestfish-actions.pod:815
25617 #: ../fish/guestfish-actions.pod:821
25619 "Another way to get the same information is to enable verbose messages with "
25620 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25621 "before running the program."
25626 #: ../fish/guestfish-actions.pod:826
25632 #: ../fish/guestfish-actions.pod:828
25635 " download remotefilename (filename|-)\n"
25641 #: ../fish/guestfish-actions.pod:835
25642 msgid "See also L</upload>, L</cat>."
25647 #: ../fish/guestfish-actions.pod:839
25648 msgid "download-offset"
25653 #: ../fish/guestfish-actions.pod:841
25656 " download-offset remotefilename (filename|-) offset size\n"
25662 #: ../fish/guestfish-actions.pod:849
25664 "Note that there is no limit on the amount of data that can be downloaded "
25665 "with this call, unlike with L</pread>, and this call always reads the full "
25666 "amount unless an error occurs."
25671 #: ../fish/guestfish-actions.pod:854
25672 msgid "See also L</download>, L</pread>."
25677 #: ../fish/guestfish-actions.pod:858
25678 msgid "drop-caches"
25683 #: ../fish/guestfish-actions.pod:860
25686 " drop-caches whattodrop\n"
25692 #: ../fish/guestfish-actions.pod:872
25698 #: ../fish/guestfish-actions.pod:874
25707 #: ../fish/guestfish-actions.pod:886
25713 #: ../fish/guestfish-actions.pod:888
25716 " e2fsck-f device\n"
25722 #: ../fish/guestfish-actions.pod:894
25724 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25725 "should use L</fsck>."
25730 #: ../fish/guestfish-actions.pod:897
25731 msgid "echo-daemon"
25736 #: ../fish/guestfish-actions.pod:899
25739 " echo-daemon 'words ...'\n"
25745 #: ../fish/guestfish-actions.pod:906
25746 msgid "See also L</ping-daemon>."
25751 #: ../fish/guestfish-actions.pod:908
25757 #: ../fish/guestfish-actions.pod:910
25760 " egrep regex path\n"
25766 #: ../fish/guestfish-actions.pod:918
25772 #: ../fish/guestfish-actions.pod:920
25775 " egrepi regex path\n"
25781 #: ../fish/guestfish-actions.pod:928
25787 #: ../fish/guestfish-actions.pod:930
25790 " equal file1 file2\n"
25796 #: ../fish/guestfish-actions.pod:937
25802 #: ../fish/guestfish-actions.pod:939
25811 #: ../fish/guestfish-actions.pod:944
25812 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25817 #: ../fish/guestfish-actions.pod:946
25823 #: ../fish/guestfish-actions.pod:948
25826 " fallocate path len\n"
25831 #: ../fish/guestfish-actions.pod:958
25833 "This function is deprecated. In new code, use the L</fallocate64> call "
25839 #: ../fish/guestfish-actions.pod:965
25840 msgid "fallocate64"
25845 #: ../fish/guestfish-actions.pod:967
25848 " fallocate64 path len\n"
25854 #: ../fish/guestfish-actions.pod:973
25856 "Note that this call allocates disk blocks for the file. To create a sparse "
25857 "file use L</truncate-size> instead."
25862 #: ../fish/guestfish-actions.pod:976
25864 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25865 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25866 "maximum size of files created through that call to 1GB."
25871 #: ../fish/guestfish-actions.pod:985
25877 #: ../fish/guestfish-actions.pod:987
25880 " fgrep pattern path\n"
25886 #: ../fish/guestfish-actions.pod:995
25892 #: ../fish/guestfish-actions.pod:997
25895 " fgrepi pattern path\n"
25901 #: ../fish/guestfish-actions.pod:1005
25907 #: ../fish/guestfish-actions.pod:1007
25915 #: ../fish/guestfish-actions.pod:1023
25917 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
25923 #: ../fish/guestfish-actions.pod:1026
25924 msgid "file-architecture"
25929 #: ../fish/guestfish-actions.pod:1028
25932 " file-architecture filename\n"
25938 #: ../fish/guestfish-actions.pod:1131
25944 #: ../fish/guestfish-actions.pod:1133
25953 #: ../fish/guestfish-actions.pod:1137
25955 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25956 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25961 #: ../fish/guestfish-actions.pod:1141
25967 #: ../fish/guestfish-actions.pod:1143
25970 " fill c len path\n"
25976 #: ../fish/guestfish-actions.pod:1149
25978 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25979 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25980 "L</fill-pattern>."
25985 #: ../fish/guestfish-actions.pod:1154
25986 msgid "fill-pattern"
25991 #: ../fish/guestfish-actions.pod:1156
25994 " fill-pattern pattern len path\n"
26000 #: ../fish/guestfish-actions.pod:1158
26002 "This function is like L</fill> except that it creates a new file of length "
26003 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
26004 "is truncated if necessary to ensure the length of the file is exactly C<len> "
26010 #: ../fish/guestfish-actions.pod:1163
26016 #: ../fish/guestfish-actions.pod:1165
26019 " find directory\n"
26025 #: ../fish/guestfish-actions.pod:1179
26026 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
26031 #: ../fish/guestfish-actions.pod:1192
26032 msgid "See also L</find0>."
26037 #: ../fish/guestfish-actions.pod:1197
26043 #: ../fish/guestfish-actions.pod:1199
26046 " find0 directory (files|-)\n"
26052 #: ../fish/guestfish-actions.pod:1205
26054 "This command works the same way as L</find> with the following exceptions:"
26059 #: ../fish/guestfish-actions.pod:1232
26060 msgid "findfs-label"
26065 #: ../fish/guestfish-actions.pod:1234
26068 " findfs-label label\n"
26074 #: ../fish/guestfish-actions.pod:1240
26075 msgid "To find the label of a filesystem, use L</vfs-label>."
26080 #: ../fish/guestfish-actions.pod:1242
26081 msgid "findfs-uuid"
26086 #: ../fish/guestfish-actions.pod:1244
26089 " findfs-uuid uuid\n"
26095 #: ../fish/guestfish-actions.pod:1250
26096 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26101 #: ../fish/guestfish-actions.pod:1252
26107 #: ../fish/guestfish-actions.pod:1254
26110 " fsck fstype device\n"
26116 #: ../fish/guestfish-actions.pod:1284
26122 #: ../fish/guestfish-actions.pod:1286
26130 #: ../fish/guestfish-actions.pod:1293
26131 msgid "get-attach-method"
26135 #: ../fish/guestfish-actions.pod:1295
26138 " get-attach-method\n"
26143 #: ../fish/guestfish-actions.pod:1297
26144 msgid "Return the current attach method. See L</set-attach-method>."
26149 #: ../fish/guestfish-actions.pod:1299
26150 msgid "get-autosync"
26155 #: ../fish/guestfish-actions.pod:1301
26164 #: ../fish/guestfish-actions.pod:1305
26170 #: ../fish/guestfish-actions.pod:1307
26179 #: ../fish/guestfish-actions.pod:1311
26180 msgid "get-e2label"
26185 #: ../fish/guestfish-actions.pod:1313
26188 " get-e2label device\n"
26193 #: ../fish/guestfish-actions.pod:1318
26195 "This function is deprecated. In new code, use the L</vfs_label> call "
26201 #: ../fish/guestfish-actions.pod:1325
26207 #: ../fish/guestfish-actions.pod:1327
26210 " get-e2uuid device\n"
26215 #: ../fish/guestfish-actions.pod:1332
26217 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
26222 #: ../fish/guestfish-actions.pod:1339
26223 msgid "get-memsize"
26228 #: ../fish/guestfish-actions.pod:1341
26237 #: ../fish/guestfish-actions.pod:1346
26239 "If L</set-memsize> was not called on this handle, and if "
26240 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26241 "value for memsize."
26246 #: ../fish/guestfish-actions.pod:1353
26247 msgid "get-network"
26252 #: ../fish/guestfish-actions.pod:1355
26261 #: ../fish/guestfish-actions.pod:1359
26267 #: ../fish/guestfish-actions.pod:1361
26276 #: ../fish/guestfish-actions.pod:1368
26282 #: ../fish/guestfish-actions.pod:1370
26288 #: ../fish/guestfish-actions.pod:1372
26297 #: ../fish/guestfish-actions.pod:1379
26303 #: ../fish/guestfish-actions.pod:1381
26312 #: ../fish/guestfish-actions.pod:1388
26313 msgid "get-recovery-proc"
26318 #: ../fish/guestfish-actions.pod:1390
26321 " get-recovery-proc\n"
26327 #: ../fish/guestfish-actions.pod:1394
26328 msgid "get-selinux"
26333 #: ../fish/guestfish-actions.pod:1396
26342 #: ../fish/guestfish-actions.pod:1398
26344 "This returns the current setting of the selinux flag which is passed to the "
26345 "appliance at boot time. See L</set-selinux>."
26350 #: ../fish/guestfish-actions.pod:1404
26356 #: ../fish/guestfish-actions.pod:1406
26365 #: ../fish/guestfish-actions.pod:1413
26371 #: ../fish/guestfish-actions.pod:1415
26380 #: ../fish/guestfish-actions.pod:1419
26386 #: ../fish/guestfish-actions.pod:1421
26395 #: ../fish/guestfish-actions.pod:1423
26397 "Return the current umask. By default the umask is C<022> unless it has been "
26398 "set by calling L</umask>."
26403 #: ../fish/guestfish-actions.pod:1426
26404 msgid "get-verbose"
26409 #: ../fish/guestfish-actions.pod:1428
26418 #: ../fish/guestfish-actions.pod:1432
26424 #: ../fish/guestfish-actions.pod:1434
26433 #: ../fish/guestfish-actions.pod:1438
26434 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26439 #: ../fish/guestfish-actions.pod:1441
26445 #: ../fish/guestfish-actions.pod:1443
26448 " getxattr path name\n"
26454 #: ../fish/guestfish-actions.pod:1445
26456 "Get a single extended attribute from file C<path> named C<name>. This call "
26457 "follows symlinks. If you want to lookup an extended attribute for the "
26458 "symlink itself, use L</lgetxattr>."
26463 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2455
26465 "Normally it is better to get all extended attributes from a file in one go "
26466 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26467 "buggy and do not provide a way to list out attributes. For these "
26468 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26469 "attributes you want in advance and call this function."
26474 #: ../fish/guestfish-actions.pod:1459
26475 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26480 #: ../fish/guestfish-actions.pod:1461
26486 #: ../fish/guestfish-actions.pod:1463
26489 " getxattrs path\n"
26495 #: ../fish/guestfish-actions.pod:1471
26496 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26501 #: ../fish/guestfish-actions.pod:1473
26502 msgid "glob-expand"
26507 #: ../fish/guestfish-actions.pod:1475
26510 " glob-expand pattern\n"
26516 #: ../fish/guestfish-actions.pod:1488
26522 #: ../fish/guestfish-actions.pod:1490
26525 " grep regex path\n"
26531 #: ../fish/guestfish-actions.pod:1498
26537 #: ../fish/guestfish-actions.pod:1500
26540 " grepi regex path\n"
26546 #: ../fish/guestfish-actions.pod:1508
26547 msgid "grub-install"
26552 #: ../fish/guestfish-actions.pod:1510
26555 " grub-install root device\n"
26561 #: ../fish/guestfish-actions.pod:1526
26567 #: ../fish/guestfish-actions.pod:1528
26576 #: ../fish/guestfish-actions.pod:1536
26582 #: ../fish/guestfish-actions.pod:1538
26585 " head-n nrlines path\n"
26591 #: ../fish/guestfish-actions.pod:1551
26597 #: ../fish/guestfish-actions.pod:1553
26606 #: ../fish/guestfish-actions.pod:1561
26612 #: ../fish/guestfish-actions.pod:1563
26615 " initrd-cat initrdpath filename\n"
26621 #: ../fish/guestfish-actions.pod:1575
26622 msgid "See also L</initrd-list>."
26627 #: ../fish/guestfish-actions.pod:1580
26628 msgid "initrd-list"
26633 #: ../fish/guestfish-actions.pod:1582
26636 " initrd-list path\n"
26642 #: ../fish/guestfish-actions.pod:1594
26643 msgid "inotify-add-watch"
26648 #: ../fish/guestfish-actions.pod:1596
26651 " inotify-add-watch path mask\n"
26657 #: ../fish/guestfish-actions.pod:1608
26658 msgid "inotify-close"
26663 #: ../fish/guestfish-actions.pod:1610
26672 #: ../fish/guestfish-actions.pod:1616
26673 msgid "inotify-files"
26678 #: ../fish/guestfish-actions.pod:1618
26687 #: ../fish/guestfish-actions.pod:1620
26689 "This function is a helpful wrapper around L</inotify-read> which just "
26690 "returns a list of pathnames of objects that were touched. The returned "
26691 "pathnames are sorted and deduplicated."
26696 #: ../fish/guestfish-actions.pod:1624
26697 msgid "inotify-init"
26702 #: ../fish/guestfish-actions.pod:1626
26705 " inotify-init maxevents\n"
26711 #: ../fish/guestfish-actions.pod:1632
26713 "C<maxevents> is the maximum number of events which will be queued up between "
26714 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26715 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26716 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26717 "but records the fact that it threw them away by setting a flag "
26718 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26723 #: ../fish/guestfish-actions.pod:1642
26725 "Before any events are generated, you have to add some watches to the "
26726 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26727 "L</inotify-watch-all>."
26732 #: ../fish/guestfish-actions.pod:1648
26734 "Queued up events should be read periodically by calling L</inotify-read> (or "
26735 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26736 "If you don't read the events out often enough then you risk the internal "
26737 "queue overflowing."
26742 #: ../fish/guestfish-actions.pod:1655
26744 "The handle should be closed after use by calling L</inotify-close>. This "
26745 "also removes any watches automatically."
26750 #: ../fish/guestfish-actions.pod:1664
26751 msgid "inotify-read"
26756 #: ../fish/guestfish-actions.pod:1666
26765 #: ../fish/guestfish-actions.pod:1679
26766 msgid "inotify-rm-watch"
26771 #: ../fish/guestfish-actions.pod:1681
26774 " inotify-rm-watch wd\n"
26780 #: ../fish/guestfish-actions.pod:1683
26781 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26786 #: ../fish/guestfish-actions.pod:1686
26787 msgid "inspect-get-arch"
26792 #: ../fish/guestfish-actions.pod:1688
26795 " inspect-get-arch root\n"
26801 #: ../fish/guestfish-actions.pod:1690 ../fish/guestfish-actions.pod:1706
26802 #: ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1828
26803 #: ../fish/guestfish-actions.pod:1846 ../fish/guestfish-actions.pod:1880
26804 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1916
26805 #: ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1964
26806 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2010
26807 #: ../fish/guestfish-actions.pod:2027 ../fish/guestfish-actions.pod:2070
26808 #: ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2121
26809 #: ../fish/guestfish-actions.pod:2137 ../fish/guestfish-actions.pod:2150
26810 #: ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2178
26812 "This function should only be called with a root device string as returned by "
26818 #: ../fish/guestfish-actions.pod:1693
26820 "This returns the architecture of the inspected operating system. The "
26821 "possible return values are listed under L</file-architecture>."
26826 #: ../fish/guestfish-actions.pod:1702
26827 msgid "inspect-get-distro"
26832 #: ../fish/guestfish-actions.pod:1704
26835 " inspect-get-distro root\n"
26840 #: ../fish/guestfish-actions.pod:1788
26841 msgid "inspect-get-drive-mappings"
26845 #: ../fish/guestfish-actions.pod:1790
26848 " inspect-get-drive-mappings root\n"
26853 #: ../fish/guestfish-actions.pod:1820
26855 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26856 "get-mountpoints>, L</inspect-get-filesystems>."
26861 #: ../fish/guestfish-actions.pod:1824
26862 msgid "inspect-get-filesystems"
26867 #: ../fish/guestfish-actions.pod:1826
26870 " inspect-get-filesystems root\n"
26876 #: ../fish/guestfish-actions.pod:1839
26878 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26879 "get-mountpoints>."
26883 #: ../fish/guestfish-actions.pod:1842
26884 msgid "inspect-get-format"
26888 #: ../fish/guestfish-actions.pod:1844
26891 " inspect-get-format root\n"
26897 #: ../fish/guestfish-actions.pod:1876
26898 msgid "inspect-get-hostname"
26903 #: ../fish/guestfish-actions.pod:1878
26906 " inspect-get-hostname root\n"
26912 #: ../fish/guestfish-actions.pod:1891
26913 msgid "inspect-get-major-version"
26918 #: ../fish/guestfish-actions.pod:1893
26921 " inspect-get-major-version root\n"
26927 #: ../fish/guestfish-actions.pod:1912
26928 msgid "inspect-get-minor-version"
26933 #: ../fish/guestfish-actions.pod:1914
26936 " inspect-get-minor-version root\n"
26942 #: ../fish/guestfish-actions.pod:1924
26944 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26945 "get-major-version>."
26950 #: ../fish/guestfish-actions.pod:1927
26951 msgid "inspect-get-mountpoints"
26956 #: ../fish/guestfish-actions.pod:1929
26959 " inspect-get-mountpoints root\n"
26964 #: ../fish/guestfish-actions.pod:1951
26966 "For operating systems like Windows which still use drive letters, this call "
26967 "will only return an entry for the first drive \"mounted on\" C</>. For "
26968 "information about the mapping of drive letters to partitions, see L</inspect-"
26969 "get-drive-mappings>."
26974 #: ../fish/guestfish-actions.pod:1957
26976 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26977 "get-filesystems>."
26982 #: ../fish/guestfish-actions.pod:1960
26983 msgid "inspect-get-package-format"
26988 #: ../fish/guestfish-actions.pod:1962
26991 " inspect-get-package-format root\n"
26997 #: ../fish/guestfish-actions.pod:1967
26999 "This function and L</inspect-get-package-management> return the package "
27000 "format and package management tool used by the inspected operating system. "
27001 "For example for Fedora these functions would return C<rpm> (package format) "
27002 "and C<yum> (package management)."
27007 #: ../fish/guestfish-actions.pod:1982
27008 msgid "inspect-get-package-management"
27013 #: ../fish/guestfish-actions.pod:1984
27016 " inspect-get-package-management root\n"
27022 #: ../fish/guestfish-actions.pod:1989
27024 "L</inspect-get-package-format> and this function return the package format "
27025 "and package management tool used by the inspected operating system. For "
27026 "example for Fedora these functions would return C<rpm> (package format) and "
27027 "C<yum> (package management)."
27032 #: ../fish/guestfish-actions.pod:2006
27033 msgid "inspect-get-product-name"
27038 #: ../fish/guestfish-actions.pod:2008
27041 " inspect-get-product-name root\n"
27046 #: ../fish/guestfish-actions.pod:2023
27047 msgid "inspect-get-product-variant"
27051 #: ../fish/guestfish-actions.pod:2025
27054 " inspect-get-product-variant root\n"
27059 #: ../fish/guestfish-actions.pod:2049
27061 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
27062 "get-product-name>, L</inspect-get-major-version>."
27067 #: ../fish/guestfish-actions.pod:2053
27068 msgid "inspect-get-roots"
27073 #: ../fish/guestfish-actions.pod:2055
27076 " inspect-get-roots\n"
27082 #: ../fish/guestfish-actions.pod:2057
27084 "This function is a convenient way to get the list of root devices, as "
27085 "returned from a previous call to L</inspect-os>, but without redoing the "
27086 "whole inspection process."
27091 #: ../fish/guestfish-actions.pod:2061
27093 "This returns an empty list if either no root devices were found or the "
27094 "caller has not called L</inspect-os>."
27099 #: ../fish/guestfish-actions.pod:2066
27100 msgid "inspect-get-type"
27105 #: ../fish/guestfish-actions.pod:2068
27108 " inspect-get-type root\n"
27113 #: ../fish/guestfish-actions.pod:2101
27114 msgid "inspect-get-windows-current-control-set"
27118 #: ../fish/guestfish-actions.pod:2103
27121 " inspect-get-windows-current-control-set root\n"
27127 #: ../fish/guestfish-actions.pod:2117
27128 msgid "inspect-get-windows-systemroot"
27133 #: ../fish/guestfish-actions.pod:2119
27136 " inspect-get-windows-systemroot root\n"
27141 #: ../fish/guestfish-actions.pod:2133
27142 msgid "inspect-is-live"
27146 #: ../fish/guestfish-actions.pod:2135
27149 " inspect-is-live root\n"
27154 #: ../fish/guestfish-actions.pod:2140
27156 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27157 "then this returns true if a live image was detected on the disk."
27161 #: ../fish/guestfish-actions.pod:2146
27162 msgid "inspect-is-multipart"
27166 #: ../fish/guestfish-actions.pod:2148
27169 " inspect-is-multipart root\n"
27174 #: ../fish/guestfish-actions.pod:2153
27176 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27177 "then this returns true if the disk is part of a set."
27181 #: ../fish/guestfish-actions.pod:2159
27182 msgid "inspect-is-netinst"
27186 #: ../fish/guestfish-actions.pod:2161
27189 " inspect-is-netinst root\n"
27194 #: ../fish/guestfish-actions.pod:2166
27196 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27197 "then this returns true if the disk is a network installer, ie. not a self-"
27198 "contained install CD but one which is likely to require network access to "
27199 "complete the install."
27204 #: ../fish/guestfish-actions.pod:2174
27205 msgid "inspect-list-applications"
27210 #: ../fish/guestfish-actions.pod:2176
27213 " inspect-list-applications root\n"
27219 #: ../fish/guestfish-actions.pod:2183
27221 "I<Note:> This call works differently from other parts of the inspection "
27222 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27223 "then mount up the disks, before calling this. Listing applications is a "
27224 "significantly more difficult operation which requires access to the full "
27225 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27226 "are just returning data cached in the libguestfs handle, this call actually "
27227 "reads parts of the mounted filesystems during the call."
27232 #: ../fish/guestfish-actions.pod:2273
27238 #: ../fish/guestfish-actions.pod:2275
27247 #: ../fish/guestfish-actions.pod:2290
27249 "You can pass the root string(s) returned to other L</inspect-get-*> "
27250 "functions in order to query further information about each operating system, "
27251 "such as the name and version."
27256 #: ../fish/guestfish-actions.pod:2295
27258 "This function uses other libguestfs features such as L</mount-ro> and L</"
27259 "umount-all> in order to mount and unmount filesystems and look at the "
27260 "contents. This should be called with no disks currently mounted. The "
27261 "function may also use Augeas, so any existing Augeas handle will be closed."
27266 #: ../fish/guestfish-actions.pod:2307 ../fish/guestfish-actions.pod:2483
27267 #: ../fish/guestfish-actions.pod:2529
27268 msgid "See also L</list-filesystems>."
27273 #: ../fish/guestfish-actions.pod:2309
27274 msgid "is-blockdev"
27279 #: ../fish/guestfish-actions.pod:2311
27282 " is-blockdev path\n"
27288 #: ../fish/guestfish-actions.pod:2316 ../fish/guestfish-actions.pod:2334
27289 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2362
27290 #: ../fish/guestfish-actions.pod:2372 ../fish/guestfish-actions.pod:2406
27291 #: ../fish/guestfish-actions.pod:2415
27292 msgid "See also L</stat>."
27297 #: ../fish/guestfish-actions.pod:2318
27303 #: ../fish/guestfish-actions.pod:2320
27312 #: ../fish/guestfish-actions.pod:2327
27318 #: ../fish/guestfish-actions.pod:2329
27321 " is-chardev path\n"
27327 #: ../fish/guestfish-actions.pod:2336
27333 #: ../fish/guestfish-actions.pod:2338
27342 #: ../fish/guestfish-actions.pod:2345
27348 #: ../fish/guestfish-actions.pod:2347
27357 #: ../fish/guestfish-actions.pod:2355
27363 #: ../fish/guestfish-actions.pod:2357
27372 #: ../fish/guestfish-actions.pod:2364
27378 #: ../fish/guestfish-actions.pod:2366
27387 #: ../fish/guestfish-actions.pod:2374
27388 msgid "is-launching"
27393 #: ../fish/guestfish-actions.pod:2376
27402 #: ../fish/guestfish-actions.pod:2383
27408 #: ../fish/guestfish-actions.pod:2385
27417 #: ../fish/guestfish-actions.pod:2390
27423 #: ../fish/guestfish-actions.pod:2392
27432 #: ../fish/guestfish-actions.pod:2399
27438 #: ../fish/guestfish-actions.pod:2401
27441 " is-socket path\n"
27447 #: ../fish/guestfish-actions.pod:2408
27453 #: ../fish/guestfish-actions.pod:2410
27456 " is-symlink path\n"
27462 #: ../fish/guestfish-actions.pod:2417
27463 msgid "kill-subprocess"
27468 #: ../fish/guestfish-actions.pod:2419
27471 " kill-subprocess\n"
27477 #: ../fish/guestfish-actions.pod:2423
27483 #: ../fish/guestfish-actions.pod:2425
27489 #: ../fish/guestfish-actions.pod:2427
27498 #: ../fish/guestfish-actions.pod:2435
27504 #: ../fish/guestfish-actions.pod:2437
27507 " lchown owner group path\n"
27513 #: ../fish/guestfish-actions.pod:2439
27515 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27516 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27522 #: ../fish/guestfish-actions.pod:2447
27528 #: ../fish/guestfish-actions.pod:2449
27531 " lgetxattr path name\n"
27537 #: ../fish/guestfish-actions.pod:2465
27538 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27543 #: ../fish/guestfish-actions.pod:2467
27549 #: ../fish/guestfish-actions.pod:2469
27552 " lgetxattrs path\n"
27558 #: ../fish/guestfish-actions.pod:2471
27560 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27561 "it returns the extended attributes of the link itself."
27566 #: ../fish/guestfish-actions.pod:2475
27567 msgid "list-devices"
27572 #: ../fish/guestfish-actions.pod:2477
27581 #: ../fish/guestfish-actions.pod:2485
27582 msgid "list-filesystems"
27587 #: ../fish/guestfish-actions.pod:2487
27590 " list-filesystems\n"
27596 #: ../fish/guestfish-actions.pod:2506
27598 "This command runs other libguestfs commands, which might include L</mount> "
27599 "and L</umount>, and therefore you should use this soon after launch and only "
27600 "when nothing is mounted."
27605 #: ../fish/guestfish-actions.pod:2510
27607 "Not all of the filesystems returned will be mountable. In particular, swap "
27608 "partitions are returned in the list. Also this command does not check that "
27609 "each filesystem found is valid and mountable, and some filesystems might be "
27610 "mountable but require special options. Filesystems may not all belong to a "
27611 "single logical operating system (use L</inspect-os> to look for OSes)."
27616 #: ../fish/guestfish-actions.pod:2518
27617 msgid "list-partitions"
27622 #: ../fish/guestfish-actions.pod:2520
27625 " list-partitions\n"
27631 #: ../fish/guestfish-actions.pod:2526
27633 "This does not return logical volumes. For that you will need to call L</"
27639 #: ../fish/guestfish-actions.pod:2531
27645 #: ../fish/guestfish-actions.pod:2533
27654 #: ../fish/guestfish-actions.pod:2541
27660 #: ../fish/guestfish-actions.pod:2543
27663 " ln target linkname\n"
27669 #: ../fish/guestfish-actions.pod:2547
27675 #: ../fish/guestfish-actions.pod:2549
27678 " ln-f target linkname\n"
27684 #: ../fish/guestfish-actions.pod:2554
27690 #: ../fish/guestfish-actions.pod:2556
27693 " ln-s target linkname\n"
27699 #: ../fish/guestfish-actions.pod:2560
27705 #: ../fish/guestfish-actions.pod:2562
27708 " ln-sf target linkname\n"
27714 #: ../fish/guestfish-actions.pod:2567
27715 msgid "lremovexattr"
27720 #: ../fish/guestfish-actions.pod:2569
27723 " lremovexattr xattr path\n"
27729 #: ../fish/guestfish-actions.pod:2571
27731 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27732 "it removes an extended attribute of the link itself."
27737 #: ../fish/guestfish-actions.pod:2575
27743 #: ../fish/guestfish-actions.pod:2577
27752 #: ../fish/guestfish-actions.pod:2583
27754 "This command is mostly useful for interactive sessions. Programs should "
27755 "probably use L</readdir> instead."
27760 #: ../fish/guestfish-actions.pod:2586
27766 #: ../fish/guestfish-actions.pod:2588
27769 " lsetxattr xattr val vallen path\n"
27775 #: ../fish/guestfish-actions.pod:2590
27777 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27778 "sets an extended attribute of the link itself."
27783 #: ../fish/guestfish-actions.pod:2594
27789 #: ../fish/guestfish-actions.pod:2596
27798 #: ../fish/guestfish-actions.pod:2600
27800 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27801 "the link is stat-ed, not the file it refers to."
27806 #: ../fish/guestfish-actions.pod:2606
27812 #: ../fish/guestfish-actions.pod:2608
27815 " lstatlist path 'names ...'\n"
27821 #: ../fish/guestfish-actions.pod:2610
27823 "This call allows you to perform the L</lstat> operation on multiple files, "
27824 "where all files are in the directory C<path>. C<names> is the list of files "
27825 "from this directory."
27830 #: ../fish/guestfish-actions.pod:2619
27832 "This call is intended for programs that want to efficiently list a directory "
27833 "contents without making many round-trips. See also L</lxattrlist> for a "
27834 "similarly efficient call for getting extended attributes. Very long "
27835 "directory listings might cause the protocol message size to be exceeded, "
27836 "causing this call to fail. The caller must split up such requests into "
27837 "smaller groups of names."
27842 #: ../fish/guestfish-actions.pod:2627
27843 msgid "luks-add-key"
27848 #: ../fish/guestfish-actions.pod:2629
27851 " luks-add-key device keyslot\n"
27857 #: ../fish/guestfish-actions.pod:2636
27859 "Note that if C<keyslot> already contains a key, then this command will "
27860 "fail. You have to use L</luks-kill-slot> first to remove that key."
27865 #: ../fish/guestfish-actions.pod:2640 ../fish/guestfish-actions.pod:2662
27866 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:2689
27867 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2722
27869 "This command has one or more key or passphrase parameters. Guestfish will "
27870 "prompt for these separately."
27875 #: ../fish/guestfish-actions.pod:2643
27881 #: ../fish/guestfish-actions.pod:2645
27884 " luks-close device\n"
27890 #: ../fish/guestfish-actions.pod:2647
27892 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27893 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27894 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27900 #: ../fish/guestfish-actions.pod:2653
27901 msgid "luks-format"
27906 #: ../fish/guestfish-actions.pod:2655
27909 " luks-format device keyslot\n"
27915 #: ../fish/guestfish-actions.pod:2668
27916 msgid "luks-format-cipher"
27921 #: ../fish/guestfish-actions.pod:2670
27924 " luks-format-cipher device keyslot cipher\n"
27930 #: ../fish/guestfish-actions.pod:2672
27932 "This command is the same as L</luks-format> but it also allows you to set "
27933 "the C<cipher> used."
27938 #: ../fish/guestfish-actions.pod:2681
27939 msgid "luks-kill-slot"
27944 #: ../fish/guestfish-actions.pod:2683
27947 " luks-kill-slot device keyslot\n"
27953 #: ../fish/guestfish-actions.pod:2692
27959 #: ../fish/guestfish-actions.pod:2694
27962 " luks-open device mapname\n"
27968 #: ../fish/guestfish-actions.pod:2708
27970 "If this block device contains LVM volume groups, then calling L</vgscan> "
27971 "followed by L</vg-activate-all> will make them visible."
27976 #: ../fish/guestfish-actions.pod:2715
27977 msgid "luks-open-ro"
27982 #: ../fish/guestfish-actions.pod:2717
27985 " luks-open-ro device mapname\n"
27991 #: ../fish/guestfish-actions.pod:2719
27993 "This is the same as L</luks-open> except that a read-only mapping is created."
27998 #: ../fish/guestfish-actions.pod:2725
28004 #: ../fish/guestfish-actions.pod:2727
28007 " lvcreate logvol volgroup mbytes\n"
28013 #: ../fish/guestfish-actions.pod:2732
28014 msgid "lvm-canonical-lv-name"
28019 #: ../fish/guestfish-actions.pod:2734
28022 " lvm-canonical-lv-name lvname\n"
28028 #: ../fish/guestfish-actions.pod:2743
28029 msgid "See also L</is-lv>."
28034 #: ../fish/guestfish-actions.pod:2745
28035 msgid "lvm-clear-filter"
28040 #: ../fish/guestfish-actions.pod:2747
28043 " lvm-clear-filter\n"
28049 #: ../fish/guestfish-actions.pod:2749
28051 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
28057 #: ../fish/guestfish-actions.pod:2755
28058 msgid "lvm-remove-all"
28063 #: ../fish/guestfish-actions.pod:2757
28066 " lvm-remove-all\n"
28072 #: ../fish/guestfish-actions.pod:2765
28073 msgid "lvm-set-filter"
28078 #: ../fish/guestfish-actions.pod:2767
28081 " lvm-set-filter 'devices ...'\n"
28087 #: ../fish/guestfish-actions.pod:2792
28093 #: ../fish/guestfish-actions.pod:2794
28096 " lvremove device\n"
28102 #: ../fish/guestfish-actions.pod:2802
28108 #: ../fish/guestfish-actions.pod:2804
28111 " lvrename logvol newlogvol\n"
28117 #: ../fish/guestfish-actions.pod:2808
28123 #: ../fish/guestfish-actions.pod:2810
28126 " lvresize device mbytes\n"
28132 #: ../fish/guestfish-actions.pod:2816
28133 msgid "lvresize-free"
28138 #: ../fish/guestfish-actions.pod:2818
28141 " lvresize-free lv percent\n"
28147 #: ../fish/guestfish-actions.pod:2826
28153 #: ../fish/guestfish-actions.pod:2828
28162 #: ../fish/guestfish-actions.pod:2836
28163 msgid "See also L</lvs-full>, L</list-filesystems>."
28168 #: ../fish/guestfish-actions.pod:2838
28174 #: ../fish/guestfish-actions.pod:2840
28183 #: ../fish/guestfish-actions.pod:2845
28189 #: ../fish/guestfish-actions.pod:2847
28198 #: ../fish/guestfish-actions.pod:2851
28204 #: ../fish/guestfish-actions.pod:2853
28207 " lxattrlist path 'names ...'\n"
28213 #: ../fish/guestfish-actions.pod:2869
28215 "This call is intended for programs that want to efficiently list a directory "
28216 "contents without making many round-trips. See also L</lstatlist> for a "
28217 "similarly efficient call for getting standard stats. Very long directory "
28218 "listings might cause the protocol message size to be exceeded, causing this "
28219 "call to fail. The caller must split up such requests into smaller groups of "
28225 #: ../fish/guestfish-actions.pod:2877
28231 #: ../fish/guestfish-actions.pod:2879
28240 #: ../fish/guestfish-actions.pod:2883
28246 #: ../fish/guestfish-actions.pod:2885
28249 " mkdir-mode path mode\n"
28255 #: ../fish/guestfish-actions.pod:2894
28256 msgid "See also L</mkdir>, L</umask>"
28261 #: ../fish/guestfish-actions.pod:2896
28267 #: ../fish/guestfish-actions.pod:2898
28276 #: ../fish/guestfish-actions.pod:2903
28282 #: ../fish/guestfish-actions.pod:2905
28285 " mkdtemp template\n"
28291 #: ../fish/guestfish-actions.pod:2926
28297 #: ../fish/guestfish-actions.pod:2928
28300 " mke2fs-J fstype blocksize device journal\n"
28306 #: ../fish/guestfish-actions.pod:2936
28307 msgid "See also L</mke2journal>."
28312 #: ../fish/guestfish-actions.pod:2938
28318 #: ../fish/guestfish-actions.pod:2940
28321 " mke2fs-JL fstype blocksize device label\n"
28327 #: ../fish/guestfish-actions.pod:2945
28328 msgid "See also L</mke2journal-L>."
28333 #: ../fish/guestfish-actions.pod:2947
28339 #: ../fish/guestfish-actions.pod:2949
28342 " mke2fs-JU fstype blocksize device uuid\n"
28348 #: ../fish/guestfish-actions.pod:2954
28349 msgid "See also L</mke2journal-U>."
28354 #: ../fish/guestfish-actions.pod:2956
28355 msgid "mke2journal"
28360 #: ../fish/guestfish-actions.pod:2958
28363 " mke2journal blocksize device\n"
28369 #: ../fish/guestfish-actions.pod:2965
28370 msgid "mke2journal-L"
28375 #: ../fish/guestfish-actions.pod:2967
28378 " mke2journal-L blocksize label device\n"
28384 #: ../fish/guestfish-actions.pod:2971
28385 msgid "mke2journal-U"
28390 #: ../fish/guestfish-actions.pod:2973
28393 " mke2journal-U blocksize uuid device\n"
28399 #: ../fish/guestfish-actions.pod:2977
28405 #: ../fish/guestfish-actions.pod:2979
28408 " mkfifo mode path\n"
28414 #: ../fish/guestfish-actions.pod:2981
28416 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28417 "is just a convenient wrapper around L</mknod>."
28422 #: ../fish/guestfish-actions.pod:2987
28428 #: ../fish/guestfish-actions.pod:2989
28431 " mkfs fstype device\n"
28437 #: ../fish/guestfish-actions.pod:2995
28443 #: ../fish/guestfish-actions.pod:2997
28446 " mkfs-b fstype blocksize device\n"
28452 #: ../fish/guestfish-actions.pod:2999
28454 "This call is similar to L</mkfs>, but it allows you to control the block "
28455 "size of the resulting filesystem. Supported block sizes depend on the "
28456 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28460 #: ../fish/guestfish-actions.pod:3007
28462 "This function is deprecated. In new code, use the L</mkfs_opts> call "
28468 #: ../fish/guestfish-actions.pod:3014
28473 #: ../fish/guestfish-actions.pod:3016
28476 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28482 #: ../fish/guestfish-actions.pod:3051
28483 msgid "mkmountpoint"
28488 #: ../fish/guestfish-actions.pod:3053
28491 " mkmountpoint exemptpath\n"
28497 #: ../fish/guestfish-actions.pod:3055
28499 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28500 "to create extra mountpoints before mounting the first filesystem."
28505 #: ../fish/guestfish-actions.pod:3079
28507 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28508 "unexpected errors if you try to mix these calls. It is safest to manually "
28509 "unmount filesystems and remove mountpoints after use."
28514 #: ../fish/guestfish-actions.pod:3083
28516 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28517 "for this to work for manual mountpoints, you must ensure that the innermost "
28518 "mountpoints have the longest pathnames, as in the example code above."
28522 #: ../fish/guestfish-actions.pod:3090
28524 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28525 "L</umount-all> to be called when the handle is closed which can also trigger "
28531 #: ../fish/guestfish-actions.pod:3094
28537 #: ../fish/guestfish-actions.pod:3096
28540 " mknod mode devmajor devminor path\n"
28546 #: ../fish/guestfish-actions.pod:3106
28548 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28549 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28550 "regular file). These constants are available in the standard Linux header "
28551 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28552 "wrappers around this command which bitwise OR in the appropriate constant "
28558 #: ../fish/guestfish-actions.pod:3116
28564 #: ../fish/guestfish-actions.pod:3118
28567 " mknod-b mode devmajor devminor path\n"
28573 #: ../fish/guestfish-actions.pod:3120
28575 "This call creates a block device node called C<path> with mode C<mode> and "
28576 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28577 "wrapper around L</mknod>."
28582 #: ../fish/guestfish-actions.pod:3126
28588 #: ../fish/guestfish-actions.pod:3128
28591 " mknod-c mode devmajor devminor path\n"
28597 #: ../fish/guestfish-actions.pod:3130
28599 "This call creates a char device node called C<path> with mode C<mode> and "
28600 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28601 "wrapper around L</mknod>."
28606 #: ../fish/guestfish-actions.pod:3136
28612 #: ../fish/guestfish-actions.pod:3138
28621 #: ../fish/guestfish-actions.pod:3142
28627 #: ../fish/guestfish-actions.pod:3144
28630 " mkswap-L label device\n"
28636 #: ../fish/guestfish-actions.pod:3152
28642 #: ../fish/guestfish-actions.pod:3154
28645 " mkswap-U uuid device\n"
28651 #: ../fish/guestfish-actions.pod:3158
28652 msgid "mkswap-file"
28657 #: ../fish/guestfish-actions.pod:3160
28660 " mkswap-file path\n"
28666 #: ../fish/guestfish-actions.pod:3164
28668 "This command just writes a swap file signature to an existing file. To "
28669 "create the file itself, use something like L</fallocate>."
28674 #: ../fish/guestfish-actions.pod:3167
28680 #: ../fish/guestfish-actions.pod:3169
28683 " modprobe modulename\n"
28689 #: ../fish/guestfish-actions.pod:3176
28695 #: ../fish/guestfish-actions.pod:3178
28698 " mount device mountpoint\n"
28704 #: ../fish/guestfish-actions.pod:3194
28706 "B<Important note:> When you use this call, the filesystem options C<sync> "
28707 "and C<noatime> are set implicitly. This was originally done because we "
28708 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28709 "very large negative performance impact and negligible effect on "
28710 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28711 "code that needs performance, and instead use L</mount-options> (use an empty "
28712 "string for the first parameter if you don't want any options)."
28716 #: ../fish/guestfish-actions.pod:3204
28718 "This function is deprecated. In new code, use the L</mount_options> call "
28724 #: ../fish/guestfish-actions.pod:3211
28730 #: ../fish/guestfish-actions.pod:3213
28733 " mount-loop file mountpoint\n"
28739 #: ../fish/guestfish-actions.pod:3219
28740 msgid "mount-options"
28745 #: ../fish/guestfish-actions.pod:3221
28748 " mount-options options device mountpoint\n"
28754 #: ../fish/guestfish-actions.pod:3223
28756 "This is the same as the L</mount> command, but it allows you to set the "
28757 "mount options as for the L<mount(8)> I<-o> flag."
28762 #: ../fish/guestfish-actions.pod:3231
28768 #: ../fish/guestfish-actions.pod:3233
28771 " mount-ro device mountpoint\n"
28777 #: ../fish/guestfish-actions.pod:3235
28779 "This is the same as the L</mount> command, but it mounts the filesystem with "
28780 "the read-only (I<-o ro>) flag."
28785 #: ../fish/guestfish-actions.pod:3238
28791 #: ../fish/guestfish-actions.pod:3240
28794 " mount-vfs options vfstype device mountpoint\n"
28800 #: ../fish/guestfish-actions.pod:3242
28802 "This is the same as the L</mount> command, but it allows you to set both the "
28803 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28808 #: ../fish/guestfish-actions.pod:3246
28809 msgid "mountpoints"
28814 #: ../fish/guestfish-actions.pod:3248
28823 #: ../fish/guestfish-actions.pod:3250
28825 "This call is similar to L</mounts>. That call returns a list of devices. "
28826 "This one returns a hash table (map) of device name to directory where the "
28827 "device is mounted."
28832 #: ../fish/guestfish-actions.pod:3254
28838 #: ../fish/guestfish-actions.pod:3256
28847 #: ../fish/guestfish-actions.pod:3263
28848 msgid "See also: L</mountpoints>"
28853 #: ../fish/guestfish-actions.pod:3265
28859 #: ../fish/guestfish-actions.pod:3267
28868 #: ../fish/guestfish-actions.pod:3272
28869 msgid "ntfs-3g-probe"
28874 #: ../fish/guestfish-actions.pod:3274
28877 " ntfs-3g-probe true|false device\n"
28883 #: ../fish/guestfish-actions.pod:3288
28889 #: ../fish/guestfish-actions.pod:3290
28892 " ntfsresize device\n"
28898 #: ../fish/guestfish-actions.pod:3305
28899 msgid "ntfsresize-size"
28904 #: ../fish/guestfish-actions.pod:3307
28907 " ntfsresize-size device size\n"
28913 #: ../fish/guestfish-actions.pod:3309
28915 "This command is the same as L</ntfsresize> except that it allows you to "
28916 "specify the new size (in bytes) explicitly."
28921 #: ../fish/guestfish-actions.pod:3312
28927 #: ../fish/guestfish-actions.pod:3314
28930 " part-add device prlogex startsect endsect\n"
28936 #: ../fish/guestfish-actions.pod:3316
28938 "This command adds a partition to C<device>. If there is no partition table "
28939 "on the device, call L</part-init> first."
28944 #: ../fish/guestfish-actions.pod:3328
28946 "Creating a partition which covers the whole disk is not so easy. Use L</"
28947 "part-disk> to do that."
28952 #: ../fish/guestfish-actions.pod:3331
28958 #: ../fish/guestfish-actions.pod:3333
28961 " part-del device partnum\n"
28967 #: ../fish/guestfish-actions.pod:3341
28973 #: ../fish/guestfish-actions.pod:3343
28976 " part-disk device parttype\n"
28982 #: ../fish/guestfish-actions.pod:3345
28984 "This command is simply a combination of L</part-init> followed by L</part-"
28985 "add> to create a single primary partition covering the whole disk."
28990 #: ../fish/guestfish-actions.pod:3349
28992 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28993 "possible values are described in L</part-init>."
28998 #: ../fish/guestfish-actions.pod:3355
28999 msgid "part-get-bootable"
29004 #: ../fish/guestfish-actions.pod:3357
29007 " part-get-bootable device partnum\n"
29013 #: ../fish/guestfish-actions.pod:3362
29014 msgid "See also L</part-set-bootable>."
29019 #: ../fish/guestfish-actions.pod:3364
29020 msgid "part-get-mbr-id"
29025 #: ../fish/guestfish-actions.pod:3366
29028 " part-get-mbr-id device partnum\n"
29034 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3509
29036 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29037 "undefined results for other partition table types (see L</part-get-"
29043 #: ../fish/guestfish-actions.pod:3375
29044 msgid "part-get-parttype"
29049 #: ../fish/guestfish-actions.pod:3377
29052 " part-get-parttype device\n"
29058 #: ../fish/guestfish-actions.pod:3382
29060 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29061 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29062 "possible, although unusual. See L</part-init> for a full list."
29067 #: ../fish/guestfish-actions.pod:3387
29073 #: ../fish/guestfish-actions.pod:3389
29076 " part-init device parttype\n"
29082 #: ../fish/guestfish-actions.pod:3395
29084 "Initially there are no partitions. Following this, you should call L</part-"
29085 "add> for each partition required."
29090 #: ../fish/guestfish-actions.pod:3458
29096 #: ../fish/guestfish-actions.pod:3460
29099 " part-list device\n"
29105 #: ../fish/guestfish-actions.pod:3475
29107 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29108 "the device's sector size, see L</blockdev-getss>."
29113 #: ../fish/guestfish-actions.pod:3488
29114 msgid "part-set-bootable"
29119 #: ../fish/guestfish-actions.pod:3490
29122 " part-set-bootable device partnum true|false\n"
29128 #: ../fish/guestfish-actions.pod:3499
29129 msgid "part-set-mbr-id"
29134 #: ../fish/guestfish-actions.pod:3501
29137 " part-set-mbr-id device partnum idbyte\n"
29143 #: ../fish/guestfish-actions.pod:3513
29144 msgid "part-set-name"
29149 #: ../fish/guestfish-actions.pod:3515
29152 " part-set-name device partnum name\n"
29158 #: ../fish/guestfish-actions.pod:3523
29159 msgid "part-to-dev"
29164 #: ../fish/guestfish-actions.pod:3525
29167 " part-to-dev partition\n"
29173 #: ../fish/guestfish-actions.pod:3531
29175 "The named partition must exist, for example as a string returned from L</"
29176 "list-partitions>."
29181 #: ../fish/guestfish-actions.pod:3534
29182 msgid "ping-daemon"
29187 #: ../fish/guestfish-actions.pod:3536
29196 #: ../fish/guestfish-actions.pod:3543
29202 #: ../fish/guestfish-actions.pod:3545
29205 " pread path count offset\n"
29211 #: ../fish/guestfish-actions.pod:3553
29212 msgid "See also L</pwrite>, L</pread-device>."
29217 #: ../fish/guestfish-actions.pod:3558
29218 msgid "pread-device"
29223 #: ../fish/guestfish-actions.pod:3560
29226 " pread-device device count offset\n"
29232 #: ../fish/guestfish-actions.pod:3568
29233 msgid "See also L</pread>."
29238 #: ../fish/guestfish-actions.pod:3573
29244 #: ../fish/guestfish-actions.pod:3575
29247 " pvcreate device\n"
29253 #: ../fish/guestfish-actions.pod:3581
29259 #: ../fish/guestfish-actions.pod:3583
29262 " pvremove device\n"
29268 #: ../fish/guestfish-actions.pod:3592
29274 #: ../fish/guestfish-actions.pod:3594
29277 " pvresize device\n"
29283 #: ../fish/guestfish-actions.pod:3599
29284 msgid "pvresize-size"
29289 #: ../fish/guestfish-actions.pod:3601
29292 " pvresize-size device size\n"
29298 #: ../fish/guestfish-actions.pod:3603
29300 "This command is the same as L</pvresize> except that it allows you to "
29301 "specify the new size (in bytes) explicitly."
29306 #: ../fish/guestfish-actions.pod:3606
29312 #: ../fish/guestfish-actions.pod:3608
29321 #: ../fish/guestfish-actions.pod:3616
29322 msgid "See also L</pvs-full>."
29327 #: ../fish/guestfish-actions.pod:3618
29333 #: ../fish/guestfish-actions.pod:3620
29342 #: ../fish/guestfish-actions.pod:3625
29348 #: ../fish/guestfish-actions.pod:3627
29357 #: ../fish/guestfish-actions.pod:3631
29363 #: ../fish/guestfish-actions.pod:3633
29366 " pwrite path content offset\n"
29372 #: ../fish/guestfish-actions.pod:3644
29373 msgid "See also L</pread>, L</pwrite-device>."
29378 #: ../fish/guestfish-actions.pod:3649
29379 msgid "pwrite-device"
29384 #: ../fish/guestfish-actions.pod:3651
29387 " pwrite-device device content offset\n"
29393 #: ../fish/guestfish-actions.pod:3661
29394 msgid "See also L</pwrite>."
29399 #: ../fish/guestfish-actions.pod:3666
29405 #: ../fish/guestfish-actions.pod:3668
29408 " read-file path\n"
29414 #: ../fish/guestfish-actions.pod:3673
29416 "Unlike L</cat>, this function can correctly handle files that contain "
29417 "embedded ASCII NUL characters. However unlike L</download>, this function "
29418 "is limited in the total size of file that can be handled."
29423 #: ../fish/guestfish-actions.pod:3681
29429 #: ../fish/guestfish-actions.pod:3683
29432 " read-lines path\n"
29438 #: ../fish/guestfish-actions.pod:3690
29440 "Note that this function cannot correctly handle binary files (specifically, "
29441 "files containing C<\\0> character which is treated as end of line). For "
29442 "those you need to use the L</read-file> function which has a more complex "
29448 #: ../fish/guestfish-actions.pod:3695
29454 #: ../fish/guestfish-actions.pod:3697
29463 #: ../fish/guestfish-actions.pod:3749
29465 "This function is primarily intended for use by programs. To get a simple "
29466 "list of names, use L</ls>. To get a printable directory for human "
29467 "consumption, use L</ll>."
29472 #: ../fish/guestfish-actions.pod:3753
29478 #: ../fish/guestfish-actions.pod:3755
29487 #: ../fish/guestfish-actions.pod:3759
29488 msgid "readlinklist"
29493 #: ../fish/guestfish-actions.pod:3761
29496 " readlinklist path 'names ...'\n"
29502 #: ../fish/guestfish-actions.pod:3785
29508 #: ../fish/guestfish-actions.pod:3787
29517 #: ../fish/guestfish-actions.pod:3792
29518 msgid "removexattr"
29523 #: ../fish/guestfish-actions.pod:3794
29526 " removexattr xattr path\n"
29532 #: ../fish/guestfish-actions.pod:3799
29533 msgid "See also: L</lremovexattr>, L<attr(5)>."
29538 #: ../fish/guestfish-actions.pod:3801
29544 #: ../fish/guestfish-actions.pod:3803
29547 " resize2fs device\n"
29553 #: ../fish/guestfish-actions.pod:3808
29555 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29556 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29557 "gives an error about this and sometimes not. In any case, it is always safe "
29558 "to call L</e2fsck-f> before calling this function."
29562 #: ../fish/guestfish-actions.pod:3814
29563 msgid "resize2fs-M"
29567 #: ../fish/guestfish-actions.pod:3816
29570 " resize2fs-M device\n"
29575 #: ../fish/guestfish-actions.pod:3818
29577 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29578 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29583 #: ../fish/guestfish-actions.pod:3822
29585 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29586 "and read the C<Block size> and C<Block count> values. These two numbers, "
29587 "multiplied together, give the resulting size of the minimal filesystem in "
29593 #: ../fish/guestfish-actions.pod:3827
29594 msgid "resize2fs-size"
29599 #: ../fish/guestfish-actions.pod:3829
29602 " resize2fs-size device size\n"
29608 #: ../fish/guestfish-actions.pod:3831
29610 "This command is the same as L</resize2fs> except that it allows you to "
29611 "specify the new size (in bytes) explicitly."
29616 #: ../fish/guestfish-actions.pod:3834
29622 #: ../fish/guestfish-actions.pod:3836
29631 #: ../fish/guestfish-actions.pod:3840
29637 #: ../fish/guestfish-actions.pod:3842
29646 #: ../fish/guestfish-actions.pod:3848
29652 #: ../fish/guestfish-actions.pod:3850
29661 #: ../fish/guestfish-actions.pod:3854
29662 msgid "rmmountpoint"
29667 #: ../fish/guestfish-actions.pod:3856
29670 " rmmountpoint exemptpath\n"
29676 #: ../fish/guestfish-actions.pod:3858
29678 "This calls removes a mountpoint that was previously created with L</"
29679 "mkmountpoint>. See L</mkmountpoint> for full details."
29684 #: ../fish/guestfish-actions.pod:3862
29685 msgid "scrub-device"
29690 #: ../fish/guestfish-actions.pod:3864
29693 " scrub-device device\n"
29699 #: ../fish/guestfish-actions.pod:3875
29705 #: ../fish/guestfish-actions.pod:3877
29708 " scrub-file file\n"
29714 #: ../fish/guestfish-actions.pod:3887
29715 msgid "scrub-freespace"
29720 #: ../fish/guestfish-actions.pod:3889
29723 " scrub-freespace dir\n"
29729 #: ../fish/guestfish-actions.pod:3891
29731 "This command creates the directory C<dir> and then fills it with files until "
29732 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29733 "deletes them. The intention is to scrub any free space on the partition "
29734 "containing C<dir>."
29739 #: ../fish/guestfish-actions.pod:3900
29745 #: ../fish/guestfish-actions.pod:3902
29751 #: ../fish/guestfish-actions.pod:3904
29754 " set-append append\n"
29759 #: ../fish/guestfish-actions.pod:3915
29760 msgid "set-attach-method"
29764 #: ../fish/guestfish-actions.pod:3917
29765 msgid "attach-method"
29769 #: ../fish/guestfish-actions.pod:3919
29772 " set-attach-method attachmethod\n"
29778 #: ../fish/guestfish-actions.pod:3941
29779 msgid "set-autosync"
29784 #: ../fish/guestfish-actions.pod:3943
29790 #: ../fish/guestfish-actions.pod:3945
29793 " set-autosync true|false\n"
29799 #: ../fish/guestfish-actions.pod:3955
29805 #: ../fish/guestfish-actions.pod:3957
29811 #: ../fish/guestfish-actions.pod:3959
29814 " set-direct true|false\n"
29820 #: ../fish/guestfish-actions.pod:3965
29822 "One consequence of this is that log messages aren't caught by the library "
29823 "and handled by L</set-log-message-callback>, but go straight to stdout."
29828 #: ../fish/guestfish-actions.pod:3974
29829 msgid "set-e2label"
29834 #: ../fish/guestfish-actions.pod:3976
29837 " set-e2label device label\n"
29843 #: ../fish/guestfish-actions.pod:3982
29845 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29846 "label on a filesystem."
29851 #: ../fish/guestfish-actions.pod:3985
29857 #: ../fish/guestfish-actions.pod:3987
29860 " set-e2uuid device uuid\n"
29866 #: ../fish/guestfish-actions.pod:3994
29868 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29869 "UUID of a filesystem."
29874 #: ../fish/guestfish-actions.pod:3997
29875 msgid "set-memsize"
29880 #: ../fish/guestfish-actions.pod:3999
29886 #: ../fish/guestfish-actions.pod:4001
29889 " set-memsize memsize\n"
29895 #: ../fish/guestfish-actions.pod:4003
29897 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29898 "This only has any effect if called before L</launch>."
29903 #: ../fish/guestfish-actions.pod:4014
29904 msgid "set-network"
29909 #: ../fish/guestfish-actions.pod:4016
29915 #: ../fish/guestfish-actions.pod:4018
29918 " set-network true|false\n"
29924 #: ../fish/guestfish-actions.pod:4026
29926 "You must call this before calling L</launch>, otherwise it has no effect."
29931 #: ../fish/guestfish-actions.pod:4029
29937 #: ../fish/guestfish-actions.pod:4031
29943 #: ../fish/guestfish-actions.pod:4033
29946 " set-path searchpath\n"
29952 #: ../fish/guestfish-actions.pod:4042
29958 #: ../fish/guestfish-actions.pod:4044
29964 #: ../fish/guestfish-actions.pod:4046
29973 #: ../fish/guestfish-actions.pod:4066
29974 msgid "set-recovery-proc"
29979 #: ../fish/guestfish-actions.pod:4068
29980 msgid "recovery-proc"
29985 #: ../fish/guestfish-actions.pod:4070
29988 " set-recovery-proc true|false\n"
29994 #: ../fish/guestfish-actions.pod:4072
29996 "If this is called with the parameter C<false> then L</launch> does not "
29997 "create a recovery process. The purpose of the recovery process is to stop "
29998 "runaway qemu processes in the case where the main program aborts abruptly."
30003 #: ../fish/guestfish-actions.pod:4077
30005 "This only has any effect if called before L</launch>, and the default is "
30011 #: ../fish/guestfish-actions.pod:4086
30012 msgid "set-selinux"
30017 #: ../fish/guestfish-actions.pod:4088
30023 #: ../fish/guestfish-actions.pod:4090
30026 " set-selinux true|false\n"
30032 #: ../fish/guestfish-actions.pod:4101
30038 #: ../fish/guestfish-actions.pod:4103
30044 #: ../fish/guestfish-actions.pod:4105
30047 " set-trace true|false\n"
30052 #: ../fish/guestfish-actions.pod:4117
30054 "Trace messages are normally sent to C<stderr>, unless you register a "
30055 "callback to send them somewhere else (see L</set-event-callback>)."
30060 #: ../fish/guestfish-actions.pod:4121
30061 msgid "set-verbose"
30066 #: ../fish/guestfish-actions.pod:4123
30072 #: ../fish/guestfish-actions.pod:4125
30075 " set-verbose true|false\n"
30080 #: ../fish/guestfish-actions.pod:4132
30082 "Verbose messages are normally sent to C<stderr>, unless you register a "
30083 "callback to send them somewhere else (see L</set-event-callback>)."
30088 #: ../fish/guestfish-actions.pod:4136
30094 #: ../fish/guestfish-actions.pod:4138
30097 " setcon context\n"
30103 #: ../fish/guestfish-actions.pod:4145
30109 #: ../fish/guestfish-actions.pod:4147
30112 " setxattr xattr val vallen path\n"
30118 #: ../fish/guestfish-actions.pod:4153
30119 msgid "See also: L</lsetxattr>, L<attr(5)>."
30124 #: ../fish/guestfish-actions.pod:4155
30130 #: ../fish/guestfish-actions.pod:4157
30133 " sfdisk device cyls heads sectors 'lines ...'\n"
30139 #: ../fish/guestfish-actions.pod:4179
30140 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30144 #: ../fish/guestfish-actions.pod:4185 ../fish/guestfish-actions.pod:4208
30145 #: ../fish/guestfish-actions.pod:4230
30147 "This function is deprecated. In new code, use the L</part_add> call instead."
30152 #: ../fish/guestfish-actions.pod:4192
30158 #: ../fish/guestfish-actions.pod:4194
30161 " sfdiskM device 'lines ...'\n"
30167 #: ../fish/guestfish-actions.pod:4196
30169 "This is a simplified interface to the L</sfdisk> command, where partition "
30170 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30171 "you don't need to specify the cyls, heads and sectors parameters which were "
30172 "rarely if ever used anyway."
30177 #: ../fish/guestfish-actions.pod:4202
30178 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30183 #: ../fish/guestfish-actions.pod:4215
30189 #: ../fish/guestfish-actions.pod:4217
30192 " sfdisk-N device partnum cyls heads sectors line\n"
30198 #: ../fish/guestfish-actions.pod:4222
30200 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30201 "cyls/heads/sectors parameters."
30206 #: ../fish/guestfish-actions.pod:4225
30207 msgid "See also: L</part-add>"
30212 #: ../fish/guestfish-actions.pod:4237
30213 msgid "sfdisk-disk-geometry"
30218 #: ../fish/guestfish-actions.pod:4239
30221 " sfdisk-disk-geometry device\n"
30227 #: ../fish/guestfish-actions.pod:4241
30229 "This displays the disk geometry of C<device> read from the partition table. "
30230 "Especially in the case where the underlying block device has been resized, "
30231 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30232 "kernel-geometry>)."
30237 #: ../fish/guestfish-actions.pod:4249
30238 msgid "sfdisk-kernel-geometry"
30243 #: ../fish/guestfish-actions.pod:4251
30246 " sfdisk-kernel-geometry device\n"
30252 #: ../fish/guestfish-actions.pod:4258
30258 #: ../fish/guestfish-actions.pod:4260
30261 " sfdisk-l device\n"
30267 #: ../fish/guestfish-actions.pod:4266
30268 msgid "See also: L</part-list>"
30272 #: ../fish/guestfish-actions.pod:4268
30274 "This function is deprecated. In new code, use the L</part_list> call "
30280 #: ../fish/guestfish-actions.pod:4275
30286 #: ../fish/guestfish-actions.pod:4277
30295 #: ../fish/guestfish-actions.pod:4282
30296 msgid "This is like L</command>, but passes the command to:"
30301 #: ../fish/guestfish-actions.pod:4290
30302 msgid "All the provisos about L</command> apply to this call."
30307 #: ../fish/guestfish-actions.pod:4292
30313 #: ../fish/guestfish-actions.pod:4294
30316 " sh-lines command\n"
30322 #: ../fish/guestfish-actions.pod:4296
30323 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30328 #: ../fish/guestfish-actions.pod:4299
30329 msgid "See also: L</command-lines>"
30334 #: ../fish/guestfish-actions.pod:4301
30340 #: ../fish/guestfish-actions.pod:4303
30349 #: ../fish/guestfish-actions.pod:4307
30355 #: ../fish/guestfish-actions.pod:4309
30364 #: ../fish/guestfish-actions.pod:4315
30370 #: ../fish/guestfish-actions.pod:4317
30379 #: ../fish/guestfish-actions.pod:4325
30385 #: ../fish/guestfish-actions.pod:4327
30394 #: ../fish/guestfish-actions.pod:4335
30400 #: ../fish/guestfish-actions.pod:4337
30403 " strings-e encoding path\n"
30409 #: ../fish/guestfish-actions.pod:4339
30411 "This is like the L</strings> command, but allows you to specify the encoding "
30412 "of strings that are looked for in the source file C<path>."
30417 #: ../fish/guestfish-actions.pod:4349
30419 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30420 "ISO-8859-X (this is what L</strings> uses)."
30425 #: ../fish/guestfish-actions.pod:4381
30426 msgid "swapoff-device"
30431 #: ../fish/guestfish-actions.pod:4383
30434 " swapoff-device device\n"
30440 #: ../fish/guestfish-actions.pod:4385
30442 "This command disables the libguestfs appliance swap device or partition "
30443 "named C<device>. See L</swapon-device>."
30448 #: ../fish/guestfish-actions.pod:4389
30449 msgid "swapoff-file"
30454 #: ../fish/guestfish-actions.pod:4391
30457 " swapoff-file file\n"
30463 #: ../fish/guestfish-actions.pod:4395
30464 msgid "swapoff-label"
30469 #: ../fish/guestfish-actions.pod:4397
30472 " swapoff-label label\n"
30478 #: ../fish/guestfish-actions.pod:4402
30479 msgid "swapoff-uuid"
30484 #: ../fish/guestfish-actions.pod:4404
30487 " swapoff-uuid uuid\n"
30493 #: ../fish/guestfish-actions.pod:4409
30494 msgid "swapon-device"
30499 #: ../fish/guestfish-actions.pod:4411
30502 " swapon-device device\n"
30508 #: ../fish/guestfish-actions.pod:4413
30510 "This command enables the libguestfs appliance to use the swap device or "
30511 "partition named C<device>. The increased memory is made available for all "
30512 "commands, for example those run using L</command> or L</sh>."
30517 #: ../fish/guestfish-actions.pod:4425
30518 msgid "swapon-file"
30523 #: ../fish/guestfish-actions.pod:4427
30526 " swapon-file file\n"
30532 #: ../fish/guestfish-actions.pod:4429
30534 "This command enables swap to a file. See L</swapon-device> for other notes."
30539 #: ../fish/guestfish-actions.pod:4432
30540 msgid "swapon-label"
30545 #: ../fish/guestfish-actions.pod:4434
30548 " swapon-label label\n"
30554 #: ../fish/guestfish-actions.pod:4436
30556 "This command enables swap to a labeled swap partition. See L</swapon-"
30557 "device> for other notes."
30562 #: ../fish/guestfish-actions.pod:4439
30563 msgid "swapon-uuid"
30568 #: ../fish/guestfish-actions.pod:4441
30571 " swapon-uuid uuid\n"
30577 #: ../fish/guestfish-actions.pod:4443
30579 "This command enables swap to a swap partition with the given UUID. See L</"
30580 "swapon-device> for other notes."
30585 #: ../fish/guestfish-actions.pod:4446
30591 #: ../fish/guestfish-actions.pod:4448
30600 #: ../fish/guestfish-actions.pod:4456
30606 #: ../fish/guestfish-actions.pod:4458
30615 #: ../fish/guestfish-actions.pod:4466
30621 #: ../fish/guestfish-actions.pod:4468
30624 " tail-n nrlines path\n"
30630 #: ../fish/guestfish-actions.pod:4481
30636 #: ../fish/guestfish-actions.pod:4483
30639 " tar-in (tarfile|-) directory\n"
30645 #: ../fish/guestfish-actions.pod:4488
30646 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30651 #: ../fish/guestfish-actions.pod:4493
30657 #: ../fish/guestfish-actions.pod:4495
30660 " tar-out directory (tarfile|-)\n"
30666 #: ../fish/guestfish-actions.pod:4500
30667 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30672 #: ../fish/guestfish-actions.pod:4505
30678 #: ../fish/guestfish-actions.pod:4507
30681 " tgz-in (tarball|-) directory\n"
30687 #: ../fish/guestfish-actions.pod:4512
30688 msgid "To upload an uncompressed tarball, use L</tar-in>."
30693 #: ../fish/guestfish-actions.pod:4516
30699 #: ../fish/guestfish-actions.pod:4518
30702 " tgz-out directory (tarball|-)\n"
30708 #: ../fish/guestfish-actions.pod:4523
30709 msgid "To download an uncompressed tarball, use L</tar-out>."
30714 #: ../fish/guestfish-actions.pod:4527
30720 #: ../fish/guestfish-actions.pod:4529
30729 #: ../fish/guestfish-actions.pod:4538
30735 #: ../fish/guestfish-actions.pod:4540
30744 #: ../fish/guestfish-actions.pod:4545
30745 msgid "truncate-size"
30750 #: ../fish/guestfish-actions.pod:4547
30753 " truncate-size path size\n"
30759 #: ../fish/guestfish-actions.pod:4552
30761 "If the current file size is less than C<size> then the file is extended to "
30762 "the required size with zero bytes. This creates a sparse file (ie. disk "
30763 "blocks are not allocated for the file until you write to it). To create a "
30764 "non-sparse file of zeroes, use L</fallocate64> instead."
30769 #: ../fish/guestfish-actions.pod:4558
30775 #: ../fish/guestfish-actions.pod:4560
30778 " tune2fs-l device\n"
30784 #: ../fish/guestfish-actions.pod:4570
30790 #: ../fish/guestfish-actions.pod:4572
30793 " txz-in (tarball|-) directory\n"
30799 #: ../fish/guestfish-actions.pod:4579
30805 #: ../fish/guestfish-actions.pod:4581
30808 " txz-out directory (tarball|-)\n"
30814 #: ../fish/guestfish-actions.pod:4588
30820 #: ../fish/guestfish-actions.pod:4590
30829 #: ../fish/guestfish-actions.pod:4604
30830 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30835 #: ../fish/guestfish-actions.pod:4609
30841 #: ../fish/guestfish-actions.pod:4611
30847 #: ../fish/guestfish-actions.pod:4613
30850 " umount pathordevice\n"
30856 #: ../fish/guestfish-actions.pod:4619
30862 #: ../fish/guestfish-actions.pod:4621
30863 msgid "unmount-all"
30868 #: ../fish/guestfish-actions.pod:4623
30877 #: ../fish/guestfish-actions.pod:4629
30883 #: ../fish/guestfish-actions.pod:4631
30886 " upload (filename|-) remotefilename\n"
30892 #: ../fish/guestfish-actions.pod:4638
30893 msgid "See also L</download>."
30898 #: ../fish/guestfish-actions.pod:4642
30899 msgid "upload-offset"
30904 #: ../fish/guestfish-actions.pod:4644
30907 " upload-offset (filename|-) remotefilename offset\n"
30913 #: ../fish/guestfish-actions.pod:4656
30915 "Note that there is no limit on the amount of data that can be uploaded with "
30916 "this call, unlike with L</pwrite>, and this call always writes the full "
30917 "amount unless an error occurs."
30922 #: ../fish/guestfish-actions.pod:4661
30923 msgid "See also L</upload>, L</pwrite>."
30928 #: ../fish/guestfish-actions.pod:4665
30934 #: ../fish/guestfish-actions.pod:4667
30937 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30943 #: ../fish/guestfish-actions.pod:4686
30949 #: ../fish/guestfish-actions.pod:4688
30958 #: ../fish/guestfish-actions.pod:4715
30960 "I<Note:> Don't use this call to test for availability of features. In "
30961 "enterprise distributions we backport features from later versions into "
30962 "earlier versions, making this an unreliable way to test for features. Use "
30963 "L</available> instead."
30968 #: ../fish/guestfish-actions.pod:4721
30974 #: ../fish/guestfish-actions.pod:4723
30977 " vfs-label device\n"
30983 #: ../fish/guestfish-actions.pod:4730
30984 msgid "To find a filesystem from the label, use L</findfs-label>."
30989 #: ../fish/guestfish-actions.pod:4732
30995 #: ../fish/guestfish-actions.pod:4734
30998 " vfs-type device\n"
31004 #: ../fish/guestfish-actions.pod:4744
31010 #: ../fish/guestfish-actions.pod:4746
31013 " vfs-uuid device\n"
31019 #: ../fish/guestfish-actions.pod:4753
31020 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
31025 #: ../fish/guestfish-actions.pod:4755
31026 msgid "vg-activate"
31031 #: ../fish/guestfish-actions.pod:4757
31034 " vg-activate true|false 'volgroups ...'\n"
31040 #: ../fish/guestfish-actions.pod:4770
31041 msgid "vg-activate-all"
31046 #: ../fish/guestfish-actions.pod:4772
31049 " vg-activate-all true|false\n"
31055 #: ../fish/guestfish-actions.pod:4782
31061 #: ../fish/guestfish-actions.pod:4784
31064 " vgcreate volgroup 'physvols ...'\n"
31070 #: ../fish/guestfish-actions.pod:4789
31076 #: ../fish/guestfish-actions.pod:4791
31079 " vglvuuids vgname\n"
31085 #: ../fish/guestfish-actions.pod:4796
31087 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
31088 "logical volumes and volume groups."
31093 #: ../fish/guestfish-actions.pod:4799
31094 msgid "See also L</vgpvuuids>."
31099 #: ../fish/guestfish-actions.pod:4801
31105 #: ../fish/guestfish-actions.pod:4803
31108 " vgpvuuids vgname\n"
31114 #: ../fish/guestfish-actions.pod:4808
31116 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
31117 "physical volumes and volume groups."
31122 #: ../fish/guestfish-actions.pod:4811
31123 msgid "See also L</vglvuuids>."
31128 #: ../fish/guestfish-actions.pod:4813
31134 #: ../fish/guestfish-actions.pod:4815
31137 " vgremove vgname\n"
31143 #: ../fish/guestfish-actions.pod:4822
31149 #: ../fish/guestfish-actions.pod:4824
31152 " vgrename volgroup newvolgroup\n"
31158 #: ../fish/guestfish-actions.pod:4828
31164 #: ../fish/guestfish-actions.pod:4830
31173 #: ../fish/guestfish-actions.pod:4838
31174 msgid "See also L</vgs-full>."
31179 #: ../fish/guestfish-actions.pod:4840
31185 #: ../fish/guestfish-actions.pod:4842
31194 #: ../fish/guestfish-actions.pod:4847
31200 #: ../fish/guestfish-actions.pod:4849
31209 #: ../fish/guestfish-actions.pod:4854
31215 #: ../fish/guestfish-actions.pod:4856
31224 #: ../fish/guestfish-actions.pod:4860
31230 #: ../fish/guestfish-actions.pod:4862
31239 #: ../fish/guestfish-actions.pod:4867
31245 #: ../fish/guestfish-actions.pod:4869
31254 #: ../fish/guestfish-actions.pod:4874
31260 #: ../fish/guestfish-actions.pod:4876
31269 #: ../fish/guestfish-actions.pod:4881
31275 #: ../fish/guestfish-actions.pod:4883
31278 " write path content\n"
31284 #: ../fish/guestfish-actions.pod:4891
31290 #: ../fish/guestfish-actions.pod:4893
31293 " write-file path content size\n"
31298 #: ../fish/guestfish-actions.pod:4909
31300 "This function is deprecated. In new code, use the L</write> call instead."
31305 #: ../fish/guestfish-actions.pod:4916
31311 #: ../fish/guestfish-actions.pod:4918
31314 " zegrep regex path\n"
31320 #: ../fish/guestfish-actions.pod:4926
31326 #: ../fish/guestfish-actions.pod:4928
31329 " zegrepi regex path\n"
31335 #: ../fish/guestfish-actions.pod:4936
31341 #: ../fish/guestfish-actions.pod:4938
31350 #: ../fish/guestfish-actions.pod:4946
31351 msgid "See also: L</zero-device>, L</scrub-device>."
31356 #: ../fish/guestfish-actions.pod:4948
31357 msgid "zero-device"
31362 #: ../fish/guestfish-actions.pod:4950
31365 " zero-device device\n"
31371 #: ../fish/guestfish-actions.pod:4952
31373 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31374 "which just zeroes the first few blocks of a device."
31379 #: ../fish/guestfish-actions.pod:4959
31385 #: ../fish/guestfish-actions.pod:4961
31388 " zerofree device\n"
31394 #: ../fish/guestfish-actions.pod:4974
31400 #: ../fish/guestfish-actions.pod:4976
31403 " zfgrep pattern path\n"
31409 #: ../fish/guestfish-actions.pod:4984
31415 #: ../fish/guestfish-actions.pod:4986
31418 " zfgrepi pattern path\n"
31424 #: ../fish/guestfish-actions.pod:4994
31430 #: ../fish/guestfish-actions.pod:4996
31433 " zfile meth path\n"
31439 #: ../fish/guestfish-actions.pod:5003
31441 "Since 1.0.63, use L</file> instead which can now process compressed files."
31445 #: ../fish/guestfish-actions.pod:5006
31447 "This function is deprecated. In new code, use the L</file> call instead."
31452 #: ../fish/guestfish-actions.pod:5013
31458 #: ../fish/guestfish-actions.pod:5015
31461 " zgrep regex path\n"
31467 #: ../fish/guestfish-actions.pod:5023
31473 #: ../fish/guestfish-actions.pod:5025
31476 " zgrepi regex path\n"
31482 #: ../fish/guestfish-commands.pod:1
31488 #: ../fish/guestfish-commands.pod:3
31494 #: ../fish/guestfish-commands.pod:5
31497 " alloc filename size\n"
31503 #: ../fish/guestfish-commands.pod:7
31505 "This creates an empty (zeroed) file of the given size, and then adds so it "
31506 "can be further examined."
31511 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31512 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31517 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31518 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31523 #: ../fish/guestfish-commands.pod:14
31525 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31526 "image, see L</PREPARED DISK IMAGES>."
31531 #: ../fish/guestfish-commands.pod:17
31537 #: ../fish/guestfish-commands.pod:19
31540 " copy-in local [local ...] /remotedir\n"
31546 #: ../fish/guestfish-commands.pod:21
31548 "C<copy-in> copies local files or directories recursively into the disk "
31549 "image, placing them in the directory called C</remotedir> (which must "
31550 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31551 "other commands as necessary."
31556 #: ../fish/guestfish-commands.pod:26
31558 "Multiple local files and directories can be specified, but the last "
31559 "parameter must always be a remote directory. Wildcards cannot be used."
31564 #: ../fish/guestfish-commands.pod:30
31570 #: ../fish/guestfish-commands.pod:32
31573 " copy-out remote [remote ...] localdir\n"
31579 #: ../fish/guestfish-commands.pod:34
31581 "C<copy-out> copies remote files or directories recursively out of the disk "
31582 "image, placing them on the host disk in a local directory called C<localdir> "
31583 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31584 "download>, L</tar-out> and other commands as necessary."
31589 #: ../fish/guestfish-commands.pod:40
31591 "Multiple remote files and directories can be specified, but the last "
31592 "parameter must always be a local directory. To download to the current "
31593 "directory, use C<.> as in:"
31598 #: ../fish/guestfish-commands.pod:44
31601 " copy-out /home .\n"
31607 #: ../fish/guestfish-commands.pod:46
31609 "Wildcards cannot be used in the ordinary command, but you can use them with "
31610 "the help of L</glob> like this:"
31615 #: ../fish/guestfish-commands.pod:49
31618 " glob copy-out /home/* .\n"
31624 #: ../fish/guestfish-commands.pod:51
31630 #: ../fish/guestfish-commands.pod:53
31633 " echo [params ...]\n"
31639 #: ../fish/guestfish-commands.pod:55
31640 msgid "This echos the parameters to the terminal."
31645 #: ../fish/guestfish-commands.pod:57
31651 #: ../fish/guestfish-commands.pod:59
31657 #: ../fish/guestfish-commands.pod:61
31663 #: ../fish/guestfish-commands.pod:63
31672 #: ../fish/guestfish-commands.pod:65
31674 "This is used to edit a file. It downloads the file, edits it locally using "
31675 "your editor, then uploads the result."
31680 #: ../fish/guestfish-commands.pod:68
31682 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31683 "or C<emacs> you will get those corresponding editors."
31688 #: ../fish/guestfish-commands.pod:72
31694 #: ../fish/guestfish-commands.pod:74
31697 " glob command args...\n"
31703 #: ../fish/guestfish-commands.pod:76
31705 "Expand wildcards in any paths in the args list, and run C<command> "
31706 "repeatedly on each matching path."
31711 #: ../fish/guestfish-commands.pod:79
31712 msgid "See L</WILDCARDS AND GLOBBING>."
31717 #: ../fish/guestfish-commands.pod:81
31723 #: ../fish/guestfish-commands.pod:83
31726 " hexedit <filename|device>\n"
31727 " hexedit <filename|device> <max>\n"
31728 " hexedit <filename|device> <start> <max>\n"
31734 #: ../fish/guestfish-commands.pod:87
31736 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31742 #: ../fish/guestfish-commands.pod:90
31744 "This command works by downloading potentially the whole file or device, "
31745 "editing it locally, then uploading it. If the file or device is large, you "
31746 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31747 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31748 "usual modifiers allowed such as C<1M> (1 megabyte)."
31753 #: ../fish/guestfish-commands.pod:97
31754 msgid "For example to edit the first few sectors of a disk you might do:"
31759 #: ../fish/guestfish-commands.pod:100
31762 " hexedit /dev/sda 1M\n"
31768 #: ../fish/guestfish-commands.pod:102
31770 "which would allow you to edit anywhere within the first megabyte of the disk."
31775 #: ../fish/guestfish-commands.pod:105
31776 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31781 #: ../fish/guestfish-commands.pod:107
31784 " hexedit /dev/sda1 0x400 0x400\n"
31790 #: ../fish/guestfish-commands.pod:109
31791 msgid "(assuming the superblock is in the standard location)."
31796 #: ../fish/guestfish-commands.pod:111
31798 "This command requires the external L<hexedit(1)> program. You can specify "
31799 "another program to use by setting the C<HEXEDITOR> environment variable."
31804 #: ../fish/guestfish-commands.pod:115
31805 msgid "See also L</hexdump>."
31810 #: ../fish/guestfish-commands.pod:117
31816 #: ../fish/guestfish-commands.pod:119
31825 #: ../fish/guestfish-commands.pod:121
31827 "Change the local directory, ie. the current directory of guestfish itself."
31832 #: ../fish/guestfish-commands.pod:124
31833 msgid "Note that C<!cd> won't do what you might expect."
31838 #: ../fish/guestfish-commands.pod:126
31844 #: ../fish/guestfish-commands.pod:128
31850 #: ../fish/guestfish-commands.pod:130
31859 #: ../fish/guestfish-commands.pod:132
31860 msgid "Opens the manual page for guestfish."
31865 #: ../fish/guestfish-commands.pod:134
31871 #: ../fish/guestfish-commands.pod:136
31877 #: ../fish/guestfish-commands.pod:138
31886 #: ../fish/guestfish-commands.pod:140
31895 #: ../fish/guestfish-commands.pod:142
31896 msgid "This is used to view a file."
31901 #: ../fish/guestfish-commands.pod:144
31903 "The default viewer is C<$PAGER>. However if you use the alternate command "
31904 "C<less> you will get the C<less> command specifically."
31909 #: ../fish/guestfish-commands.pod:147
31915 #: ../fish/guestfish-commands.pod:149
31924 #: ../fish/guestfish-commands.pod:151
31926 "Close and reopen the libguestfs handle. It is not necessary to use this "
31927 "normally, because the handle is closed properly when guestfish exits. "
31928 "However this is occasionally useful for testing."
31933 #: ../fish/guestfish-commands.pod:155
31939 #: ../fish/guestfish-commands.pod:157
31942 " sparse filename size\n"
31948 #: ../fish/guestfish-commands.pod:159
31950 "This creates an empty sparse file of the given size, and then adds so it can "
31951 "be further examined."
31956 #: ../fish/guestfish-commands.pod:162
31958 "In all respects it works the same as the L</alloc> command, except that the "
31959 "image file is allocated sparsely, which means that disk blocks are not "
31960 "assigned to the file until they are needed. Sparse disk files only use "
31961 "space when written to, but they are slower and there is a danger you could "
31962 "run out of real disk space during a write operation."
31967 #: ../fish/guestfish-commands.pod:172
31973 #: ../fish/guestfish-commands.pod:174
31982 #: ../fish/guestfish-commands.pod:176
31984 "This command returns a list of the optional groups known to the daemon, and "
31985 "indicates which ones are supported by this build of the libguestfs appliance."
31990 #: ../fish/guestfish-commands.pod:180
31991 msgid "See also L<guestfs(3)/AVAILABILITY>."
31996 #: ../fish/guestfish-commands.pod:182
32002 #: ../fish/guestfish-commands.pod:184
32005 " time command args...\n"
32011 #: ../fish/guestfish-commands.pod:186
32013 "Run the command as usual, but print the elapsed time afterwards. This can "
32014 "be useful for benchmarking operations."
32019 #: ../test-tool/libguestfs-test-tool.pod:5
32020 msgid "libguestfs-test-tool - End user tests for libguestfs"
32025 #: ../test-tool/libguestfs-test-tool.pod:9
32028 " libguestfs-test-tool [--options]\n"
32034 #: ../test-tool/libguestfs-test-tool.pod:13
32036 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
32037 "and developers, to allow them to check basic libguestfs functionality is "
32038 "working. This is needed because libguestfs occasionally breaks for reasons "
32039 "beyond our control: usually because of changes in the underlying qemu or "
32040 "kernel packages, or the host environment."
32045 #: ../test-tool/libguestfs-test-tool.pod:20
32046 msgid "If you suspect a problem in libguestfs, then just run:"
32051 #: ../test-tool/libguestfs-test-tool.pod:22
32054 " libguestfs-test-tool\n"
32060 #: ../test-tool/libguestfs-test-tool.pod:24
32061 msgid "It will print lots of diagnostic messages."
32066 #: ../test-tool/libguestfs-test-tool.pod:26
32067 msgid "If it runs to completion successfully, you will see this near the end:"
32072 #: ../test-tool/libguestfs-test-tool.pod:28
32075 " ===== TEST FINISHED OK =====\n"
32081 #: ../test-tool/libguestfs-test-tool.pod:30
32082 msgid "and the test tool will exit with code 0."
32087 #: ../test-tool/libguestfs-test-tool.pod:32
32089 "If it fails (and/or exits with non-zero error code), please paste the "
32090 "B<complete, unedited> output of the test tool into a bug report. More "
32091 "information about reporting bugs can be found on the L<http://libguestfs.org/"
32097 #: ../test-tool/libguestfs-test-tool.pod:41
32103 #: ../test-tool/libguestfs-test-tool.pod:43
32104 msgid "Display short usage information and exit."
32109 #: ../test-tool/libguestfs-test-tool.pod:45
32110 msgid "I<--qemu qemu_binary>"
32115 #: ../test-tool/libguestfs-test-tool.pod:47
32117 "If you have downloaded another qemu binary, point this option at the full "
32118 "path of the binary to try it."
32123 #: ../test-tool/libguestfs-test-tool.pod:50
32124 msgid "I<--qemudir qemu_source_dir>"
32129 #: ../test-tool/libguestfs-test-tool.pod:52
32131 "If you have compiled qemu from source, point this option at the source "
32132 "directory to try it."
32137 #: ../test-tool/libguestfs-test-tool.pod:55
32138 msgid "I<--timeout N>"
32143 #: ../test-tool/libguestfs-test-tool.pod:57
32145 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
32146 "does not usually need to be adjusted unless your machine is very slow."
32151 #: ../test-tool/libguestfs-test-tool.pod:63
32152 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32157 #: ../test-tool/libguestfs-test-tool.pod:65
32159 "If you have compiled another version of qemu from source and would like to "
32160 "try that, then you can use the I<--qemudir> option to point to the qemu "
32161 "source directory."
32166 #: ../test-tool/libguestfs-test-tool.pod:69
32168 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32169 "option to point to the binary."
32174 #: ../test-tool/libguestfs-test-tool.pod:72
32176 "When using an alternate qemu with libguestfs, usually you would need to "
32177 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32178 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32179 "use either of the I<--qemudir> or I<--qemu> options."
32184 #: ../test-tool/libguestfs-test-tool.pod:79
32186 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32187 "I<1> if there was an error."
32192 #: ../test-tool/libguestfs-test-tool.pod:84
32194 "For the full list of environment variables which may affect libguestfs, "
32195 "please see the L<guestfs(3)> manual page."
32200 #: ../test-tool/libguestfs-test-tool.pod:89
32201 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32206 #: ../fuse/guestmount.pod:5
32208 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32213 #: ../fuse/guestmount.pod:9
32216 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32222 #: ../fuse/guestmount.pod:11
32225 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32231 #: ../fuse/guestmount.pod:13
32234 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32240 #: ../fuse/guestmount.pod:17
32242 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32243 "machines. If you do this, you risk disk corruption in the VM."
32248 #: ../fuse/guestmount.pod:22
32250 "The guestmount program can be used to mount virtual machine filesystems and "
32251 "other disk images on the host. It uses libguestfs for access to the guest "
32252 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32253 "a mountable device."
32258 #: ../fuse/guestmount.pod:27
32260 "Along with other options, you have to give at least one device (I<-a> "
32261 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32262 "option) or use the I<-i> inspection option. How this works is better "
32263 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32269 #: ../fuse/guestmount.pod:33
32271 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32272 "by you, and the filesystem will not be visible to any other users unless you "
32273 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32274 "the filesystem, use the C<fusermount -u> command."
32279 #: ../fuse/guestmount.pod:41
32281 "For a typical Windows guest which has its main filesystem on the first "
32287 #: ../fuse/guestmount.pod:44
32290 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32296 #: ../fuse/guestmount.pod:46
32298 "For a typical Linux guest which has a /boot filesystem on the first "
32299 "partition, and the root filesystem on a logical volume:"
32304 #: ../fuse/guestmount.pod:49
32307 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32313 #: ../fuse/guestmount.pod:51
32314 msgid "To get libguestfs to detect guest mountpoints for you:"
32319 #: ../fuse/guestmount.pod:53
32322 " guestmount -a guest.img -i --ro /mnt\n"
32328 #: ../fuse/guestmount.pod:55
32329 msgid "For a libvirt guest called \"Guest\" you could do:"
32334 #: ../fuse/guestmount.pod:57
32337 " guestmount -d Guest -i --ro /mnt\n"
32343 #: ../fuse/guestmount.pod:59
32345 "If you don't know what filesystems are contained in a guest or disk image, "
32346 "use L<virt-filesystems(1)> first:"
32351 #: ../fuse/guestmount.pod:62
32354 " virt-filesystems MyGuest\n"
32360 #: ../fuse/guestmount.pod:64
32362 "If you want to trace the libguestfs calls but without excessive debugging "
32363 "information, we recommend:"
32368 #: ../fuse/guestmount.pod:67
32371 " guestmount [...] --trace /mnt\n"
32377 #: ../fuse/guestmount.pod:69
32378 msgid "If you want to debug the program, we recommend:"
32383 #: ../fuse/guestmount.pod:71
32386 " guestmount [...] --trace --verbose /mnt\n"
32391 #: ../fuse/guestmount.pod:73
32396 #: ../fuse/guestmount.pod:75
32397 msgid "Other users cannot see the filesystem by default"
32401 #: ../fuse/guestmount.pod:77
32403 "If you mount a filesystem as one user (eg. root), then other users will not "
32404 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
32405 "option when mounting:"
32409 #: ../fuse/guestmount.pod:81
32412 " sudo guestmount [...] -o allow_other /mnt\n"
32418 #: ../fuse/guestmount.pod:87
32419 msgid "B<-a image> | B<--add image>"
32424 #: ../fuse/guestmount.pod:89
32425 msgid "Add a block device or virtual machine image."
32430 #: ../fuse/guestmount.pod:94
32431 msgid "B<-c URI> | B<--connect URI>"
32436 #: ../fuse/guestmount.pod:100
32437 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32442 #: ../fuse/guestmount.pod:106
32443 msgid "B<--dir-cache-timeout N>"
32448 #: ../fuse/guestmount.pod:108
32450 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32451 "seconds. The readdir cache [actually, there are several semi-independent "
32452 "caches] is populated after a readdir(2) call with the stat and extended "
32453 "attributes of the files in the directory, in anticipation that they will be "
32454 "requested soon after."
32459 #: ../fuse/guestmount.pod:114
32461 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32462 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32463 "requests, only cache existing ones."
32468 #: ../fuse/guestmount.pod:125
32469 msgid "B<--format=raw|qcow2|..> | B<--format>"
32474 #: ../fuse/guestmount.pod:132
32476 "If you have untrusted raw-format guest disk images, you should use this "
32477 "option to specify the disk format. This avoids a possible security problem "
32478 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32479 "guestfs_add_drive_opts>."
32484 #: ../fuse/guestmount.pod:137
32485 msgid "B<--fuse-help>"
32490 #: ../fuse/guestmount.pod:139
32491 msgid "Display help on special FUSE options (see I<-o> below)."
32496 #: ../fuse/guestmount.pod:143
32497 msgid "Display brief help and exit."
32502 #: ../fuse/guestmount.pod:145
32503 msgid "B<-i> | B<--inspector>"
32508 #: ../fuse/guestmount.pod:165
32510 "Mount the named partition or logical volume on the given mountpoint B<in the "
32511 "guest> (this has nothing to do with mountpoints in the host)."
32516 #: ../fuse/guestmount.pod:168
32518 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32519 "something on C</>."
32524 #: ../fuse/guestmount.pod:181
32525 msgid "B<-n> | B<--no-sync>"
32530 #: ../fuse/guestmount.pod:183
32532 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32533 "unmounted. If you specify this option, then we don't attempt to sync the "
32534 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32539 #: ../fuse/guestmount.pod:188
32540 msgid "B<-o option> | B<--option option>"
32545 #: ../fuse/guestmount.pod:190
32546 msgid "Pass extra options to FUSE."
32551 #: ../fuse/guestmount.pod:192
32553 "To get a list of all the extra options supported by FUSE, use the command "
32554 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32555 "of them are a good idea."
32560 #: ../fuse/guestmount.pod:196
32563 " guestmount --fuse-help\n"
32569 #: ../fuse/guestmount.pod:198
32570 msgid "Some potentially useful FUSE options:"
32575 #: ../fuse/guestmount.pod:202
32576 msgid "B<-o allow_other>"
32581 #: ../fuse/guestmount.pod:204
32582 msgid "Allow other users to see the filesystem."
32587 #: ../fuse/guestmount.pod:206
32588 msgid "B<-o attr_timeout=N>"
32593 #: ../fuse/guestmount.pod:208
32594 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32599 #: ../fuse/guestmount.pod:210
32600 msgid "B<-o kernel_cache>"
32605 #: ../fuse/guestmount.pod:212
32607 "Allow the kernel to cache files (reduces the number of reads that have to go "
32608 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32609 "afford the extra memory usage."
32614 #: ../fuse/guestmount.pod:216
32615 msgid "B<-o uid=N> B<-o gid=N>"
32620 #: ../fuse/guestmount.pod:218
32622 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32623 "the chosen values."
32628 #: ../fuse/guestmount.pod:223
32629 msgid "B<-r> | B<--ro>"
32634 #: ../fuse/guestmount.pod:225
32636 "Add devices and mount everything read-only. Also disallow writes and make "
32637 "the disk appear read-only to FUSE."
32642 #: ../fuse/guestmount.pod:228
32644 "This is highly recommended if you are not going to edit the guest disk. If "
32645 "the guest is running and this option is I<not> supplied, then there is a "
32646 "strong risk of disk corruption in the guest. We try to prevent this from "
32647 "happening, but it is not always possible."
32652 #: ../fuse/guestmount.pod:233
32653 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32658 #: ../fuse/guestmount.pod:237
32659 msgid "Enable SELinux support for the guest."
32664 #: ../fuse/guestmount.pod:239
32665 msgid "B<-v> | B<--verbose>"
32670 #: ../fuse/guestmount.pod:241
32671 msgid "Enable verbose messages from underlying libguestfs."
32676 #: ../fuse/guestmount.pod:243
32677 msgid "B<-V> | B<--version>"
32682 #: ../fuse/guestmount.pod:245
32683 msgid "Display the program version and exit."
32688 #: ../fuse/guestmount.pod:247
32689 msgid "B<-w> | B<--rw>"
32693 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
32694 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32699 #: ../fuse/guestmount.pod:254
32700 msgid "B<-x> | B<--trace>"
32705 #: ../fuse/guestmount.pod:256
32706 msgid "Trace libguestfs calls and entry into each FUSE function."
32711 #: ../fuse/guestmount.pod:258
32712 msgid "This also stops the daemon from forking into the background."
32717 #: ../fuse/guestmount.pod:279
32719 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32720 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32726 #: ../fuse/guestmount.pod:294
32727 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32732 #: ../tools/virt-edit.pl:34
32733 msgid "virt-edit - Edit a file in a virtual machine"
32738 #: ../tools/virt-edit.pl:38
32741 " virt-edit [--options] domname file\n"
32747 #: ../tools/virt-edit.pl:40
32750 " virt-edit [--options] disk.img [disk.img ...] file\n"
32756 #: ../tools/virt-edit.pl:42
32759 " virt-edit [domname|disk.img] file -e 'expr'\n"
32765 #: ../tools/virt-edit.pl:46
32767 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32768 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32769 "doing this, but doesn't catch all cases."
32774 #: ../tools/virt-edit.pl:52
32776 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32777 "the named virtual machine (or disk image)."
32781 #: ../tools/virt-edit.pl:55
32782 msgid "If you want to just view a file, use L<virt-cat(1)>."
32786 #: ../tools/virt-edit.pl:57
32788 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32789 "USING GUESTFISH> below)."
32793 #: ../tools/virt-edit.pl:60
32795 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32796 "files. L<guestfish(1)> can do that and much more."
32801 #: ../tools/virt-edit.pl:65
32802 msgid "Edit the named files interactively:"
32807 #: ../tools/virt-edit.pl:67
32810 " virt-edit mydomain /boot/grub/grub.conf\n"
32816 #: ../tools/virt-edit.pl:69
32819 " virt-edit mydomain /etc/passwd\n"
32824 #: ../tools/virt-edit.pl:71
32825 msgid "For Windows guests, some Windows paths are understood:"
32829 #: ../tools/virt-edit.pl:73
32832 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32838 #: ../tools/virt-edit.pl:75
32840 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32841 "below). To change the init default level to 5:"
32846 #: ../tools/virt-edit.pl:79
32849 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32855 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32856 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32857 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32858 msgid "Display brief help."
32863 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32864 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32865 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32866 msgid "Display version number and exit."
32871 #: ../tools/virt-edit.pl:105
32872 msgid "B<--backup extension> | B<-b extension>"
32877 #: ../tools/virt-edit.pl:107
32879 "Create a backup of the original file I<in the guest disk image>. The backup "
32880 "has the original filename with C<extension> added."
32885 #: ../tools/virt-edit.pl:110
32887 "Usually the first character of C<extension> would be a dot C<.> so you would "
32893 #: ../tools/virt-edit.pl:113
32896 " virt-edit -b .orig [etc]\n"
32902 #: ../tools/virt-edit.pl:115
32903 msgid "By default, no backup file is made."
32908 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32909 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32910 #: ../tools/virt-list-partitions.pl:78
32911 msgid "B<--connect URI> | B<-c URI>"
32916 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32917 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32918 #: ../tools/virt-list-partitions.pl:80
32920 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32921 "to the default libvirt hypervisor."
32926 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32927 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32928 #: ../tools/virt-list-partitions.pl:83
32930 "If you specify guest block devices directly, then libvirt is not used at all."
32935 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32936 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32937 #: ../tools/virt-list-partitions.pl:90
32938 msgid "B<--format> raw"
32943 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32944 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32945 #: ../tools/virt-list-partitions.pl:92
32947 "Specify the format of disk images given on the command line. If this is "
32948 "omitted then the format is autodetected from the content of the disk image."
32953 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32954 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32955 #: ../tools/virt-list-partitions.pl:96
32957 "If disk images are requested from libvirt, then this program asks libvirt "
32958 "for this information. In this case, the value of the format parameter is "
32964 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32965 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32966 #: ../tools/virt-list-partitions.pl:100
32968 "If working with untrusted raw-format guest disk images, you should ensure "
32969 "the format is always specified."
32974 #: ../tools/virt-edit.pl:150
32975 msgid "B<--expr EXPR> | B<-e EXPR>"
32980 #: ../tools/virt-edit.pl:152
32982 "Instead of launching the external editor, non-interactively apply the Perl "
32983 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32989 #: ../tools/virt-edit.pl:156
32991 "Be careful to properly quote the expression to prevent it from being altered "
32997 #: ../tools/virt-edit.pl:280
32998 msgid "NON-INTERACTIVE EDITING"
33003 #: ../tools/virt-edit.pl:282
33005 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
33006 "administrator can interactively edit the file."
33011 #: ../tools/virt-edit.pl:285
33013 "There are two ways also to use C<virt-edit> from scripts in order to make "
33014 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
33015 "like this, it's less error-prone to write scripts directly using the "
33016 "libguestfs API and Augeas for configuration file editing.)"
33021 #: ../tools/virt-edit.pl:291
33023 "The first method is to temporarily set C<$EDITOR> to any script or program "
33024 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
33025 "update C<tmpfile> in place however it likes."
33029 #: ../tools/virt-edit.pl:295
33031 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
33032 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
33033 "instances of C<foo> with C<bar> in a file:"
33038 #: ../tools/virt-edit.pl:299
33041 " virt-edit domname filename -e 's/foo/bar/'\n"
33047 #: ../tools/virt-edit.pl:301
33049 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
33050 "For example to delete root's password you could do:"
33055 #: ../tools/virt-edit.pl:304
33058 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
33064 #: ../tools/virt-edit.pl:306
33066 "What really happens is that the snippet is evaluated as a Perl expression "
33067 "for each line of the file. The line, including the final C<\\n>, is passed "
33068 "in C<$_> and the expression should update C<$_> or leave it unchanged."
33073 #: ../tools/virt-edit.pl:311
33075 "To delete a line, set C<$_> to the empty string. For example, to delete the "
33076 "C<apache> user account from the password file you can do:"
33081 #: ../tools/virt-edit.pl:314
33084 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
33090 #: ../tools/virt-edit.pl:316
33092 "To insert a line, prepend or append it to C<$_>. However appending lines to "
33093 "the end of the file is rather difficult this way since there is no concept "
33094 "of \"last line of the file\" - your expression just doesn't get called "
33095 "again. You might want to use the first method (setting C<$EDITOR>) if you "
33101 #: ../tools/virt-edit.pl:322
33103 "The variable C<$lineno> contains the current line number. As is "
33104 "traditional, the first line in the file is number C<1>."
33109 #: ../tools/virt-edit.pl:325
33111 "The return value from the expression is ignored, but the expression may call "
33112 "C<die> in order to abort the whole program, leaving the original file "
33118 #: ../tools/virt-edit.pl:329
33120 "Remember when matching the end of a line that C<$_> may contain the final C<"
33121 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
33122 "newline then neither of these. Thus to match or substitute some text at the "
33123 "end of a line, use this regular expression:"
33128 #: ../tools/virt-edit.pl:334
33131 " /some text(\\r?\\n)?$/\n"
33137 #: ../tools/virt-edit.pl:336
33139 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
33140 "$_> itself (since that would remove all newlines from the file):"
33145 #: ../tools/virt-edit.pl:340
33148 " my $m = $_; chomp $m; $m =~ /some text$/\n"
33153 #: ../tools/virt-edit.pl:344
33155 "C<virt-edit> has a limited ability to understand Windows drive letters and "
33156 "paths (eg. C<E:\\foo\\bar.txt>)."
33160 #: ../tools/virt-edit.pl:347
33161 msgid "If and only if the guest is running Windows then:"
33165 #: ../tools/virt-edit.pl:353
33167 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
33168 "to the correct filesystem."
33172 #: ../tools/virt-edit.pl:358
33174 "Any backslash (C<\\>) characters in the path are replaced with forward "
33175 "slashes so that libguestfs can process it."
33179 #: ../tools/virt-edit.pl:363
33181 "The path is resolved case insensitively to locate the file that should be "
33186 #: ../tools/virt-edit.pl:368
33187 msgid "There are some known shortcomings:"
33191 #: ../tools/virt-edit.pl:374
33192 msgid "Some NTFS symbolic links may not be followed correctly."
33196 #: ../tools/virt-edit.pl:378
33197 msgid "NTFS junction points that cross filesystems are not followed."
33201 #: ../tools/virt-edit.pl:435
33202 msgid "USING GUESTFISH"
33206 #: ../tools/virt-edit.pl:437
33208 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
33209 "C<virt-edit> doesn't work."
33213 #: ../tools/virt-edit.pl:440
33214 msgid "Using C<virt-edit> is approximately equivalent to doing:"
33218 #: ../tools/virt-edit.pl:442
33221 " guestfish --rw -i -d domname edit /file\n"
33226 #: ../tools/virt-edit.pl:444
33228 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
33229 "path to the file."
33233 #: ../tools/virt-edit.pl:447
33235 "The command above uses libguestfs's guest inspection feature and so does not "
33236 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
33237 "disk images that don't contain guests. To edit a file on a disk image "
33242 #: ../tools/virt-edit.pl:452
33245 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
33250 #: ../tools/virt-edit.pl:454
33252 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
33253 "the disk image to edit, and C</file> is the full path to the file."
33257 #: ../tools/virt-edit.pl:458
33259 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
33260 "C<write> or C<upload> instead:"
33264 #: ../tools/virt-edit.pl:461
33267 " guestfish --rw -i -d domname touch /newfile\n"
33272 #: ../tools/virt-edit.pl:463
33275 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
33280 #: ../tools/virt-edit.pl:465
33283 " guestfish --rw -i -d domname upload localfile /newfile\n"
33288 #: ../tools/virt-edit.pl:467
33290 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
33294 #: ../tools/virt-edit.pl:470
33297 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
33303 #: ../tools/virt-edit.pl:480
33309 #: ../tools/virt-edit.pl:482
33311 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33317 #: ../tools/virt-edit.pl:485
33318 msgid "If not set, C<vi> is used."
33323 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33324 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
33325 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
33326 msgid "SHELL QUOTING"
33331 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33332 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
33333 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
33335 "Libvirt guest names can contain arbitrary characters, some of which have "
33336 "meaning to the shell such as C<#> and space. You may need to quote or "
33337 "escape these characters on the command line. See the shell manual page L<sh"
33338 "(1)> for details."
33342 #: ../tools/virt-edit.pl:498
33344 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33345 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33346 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33351 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33352 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33353 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33359 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33360 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33361 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33362 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33366 #: ../tools/virt-edit.pl:516
33367 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33372 #: ../tools/virt-win-reg.pl:37
33374 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33379 #: ../tools/virt-win-reg.pl:41
33382 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33388 #: ../tools/virt-win-reg.pl:43
33391 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33397 #: ../tools/virt-win-reg.pl:45
33400 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33406 #: ../tools/virt-win-reg.pl:47
33409 " virt-win-reg --merge domname [input.reg ...]\n"
33415 #: ../tools/virt-win-reg.pl:49
33418 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33423 #: ../tools/virt-win-reg.pl:53
33425 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33426 "virtual machines. If you do this, you I<will> get irreversible disk "
33427 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33428 "but doesn't catch all cases."
33432 #: ../tools/virt-win-reg.pl:58
33434 "Modifying the Windows Registry is an inherently risky operation. The format "
33435 "is deliberately obscure and undocumented, and Registry changes can leave the "
33436 "system unbootable. Therefore when using the I<--merge> option, make sure "
33437 "you have a reliable backup first."
33442 #: ../tools/virt-win-reg.pl:65
33444 "This program can export and merge Windows Registry entries from a Windows "
33450 #: ../tools/virt-win-reg.pl:68
33452 "The first parameter is the libvirt guest name or the raw disk image of a "
33457 #: ../tools/virt-win-reg.pl:71
33459 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33460 "exported (recursively). For example:"
33465 #: ../tools/virt-win-reg.pl:74
33468 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33474 #: ../tools/virt-win-reg.pl:76
33476 "You can also display single values from within registry keys, for example:"
33481 #: ../tools/virt-win-reg.pl:79
33484 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33485 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33486 " Windows 7 Enterprise\n"
33491 #: ../tools/virt-win-reg.pl:83
33493 "With I<--merge>, you can merge a textual regedit file into the Windows "
33499 #: ../tools/virt-win-reg.pl:86
33502 " $ virt-win-reg --merge Windows7 changes.reg\n"
33508 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33514 #: ../tools/virt-win-reg.pl:90
33516 "This program is only meant for simple access to the registry. If you want "
33517 "to do complicated things with the registry, we suggest you download the "
33518 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33519 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33520 "L<hivexregedit(1)>."
33525 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33531 #: ../tools/virt-win-reg.pl:122
33532 msgid "Enable debugging messages."
33537 #: ../tools/virt-win-reg.pl:157
33543 #: ../tools/virt-win-reg.pl:159
33545 "In merge mode, this merges a textual regedit file into the Windows Registry "
33546 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33547 "displays or exports Registry entries instead."
33551 #: ../tools/virt-win-reg.pl:163
33553 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33554 "result in disk corruption. However exporting (without this flag) is always "
33560 #: ../tools/virt-win-reg.pl:171
33561 msgid "B<--encoding> UTF-16LE|ASCII"
33566 #: ../tools/virt-win-reg.pl:173
33568 "When merging (only), you may need to specify the encoding for strings to be "
33569 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33570 "(3)/ENCODING STRINGS>."
33575 #: ../tools/virt-win-reg.pl:177
33577 "The default is to use UTF-16LE, which should work with recent versions of "
33583 #: ../tools/virt-win-reg.pl:402
33584 msgid "SUPPORTED SYSTEMS"
33589 #: ../tools/virt-win-reg.pl:404
33591 "The program currently supports Windows NT-derived guests starting with "
33592 "Windows XP through to at least Windows 7."
33597 #: ../tools/virt-win-reg.pl:407
33599 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33600 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33601 "and C<HKEY_USERS\\.DEFAULT>."
33606 #: ../tools/virt-win-reg.pl:411
33608 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33614 #: ../tools/virt-win-reg.pl:414
33616 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33622 #: ../tools/virt-win-reg.pl:417
33628 #: ../tools/virt-win-reg.pl:419
33630 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33631 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33632 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33633 "Windows-style line endings, you may need to reencode the whole file before "
33634 "or after processing."
33638 #: ../tools/virt-win-reg.pl:425
33640 "To reencode a file from Windows format to Linux (before processing it with "
33641 "the I<--merge> option), you would do something like this:"
33646 #: ../tools/virt-win-reg.pl:428
33649 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33655 #: ../tools/virt-win-reg.pl:430
33657 "To go in the opposite direction, after exporting and before sending the file "
33658 "to a Windows user, do something like this:"
33663 #: ../tools/virt-win-reg.pl:433
33666 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33672 #: ../tools/virt-win-reg.pl:435
33673 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33678 #: ../tools/virt-win-reg.pl:437
33680 "If you are unsure about the current encoding, use the L<file(1)> command. "
33681 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33682 "style (CRLF) line endings, like this:"
33687 #: ../tools/virt-win-reg.pl:441
33690 " $ file software.reg\n"
33691 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33692 " with CRLF line terminators\n"
33697 #: ../tools/virt-win-reg.pl:445
33698 msgid "This file would need conversion before you could I<--merge> it."
33703 #: ../tools/virt-win-reg.pl:447
33704 msgid "CurrentControlSet etc."
33709 #: ../tools/virt-win-reg.pl:449
33711 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33712 "Registry at the level of the hive file, and therefore you cannot modify "
33718 #: ../tools/virt-win-reg.pl:453
33720 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33721 "circumstances it might refer to another control set. The way to find out is "
33722 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33727 #: ../tools/virt-win-reg.pl:457
33730 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33731 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33732 " \"Current\"=dword:00000001\n"
33733 " \"Default\"=dword:00000001\n"
33734 " \"Failed\"=dword:00000000\n"
33735 " \"LastKnownGood\"=dword:00000002\n"
33741 #: ../tools/virt-win-reg.pl:464
33742 msgid "\"Current\" is the one which Windows will choose when it boots."
33747 #: ../tools/virt-win-reg.pl:466
33749 "Similarly, other C<Current...> keys in the path may need to be replaced."
33754 #: ../tools/virt-win-reg.pl:469
33755 msgid "WINDOWS TIPS"
33760 #: ../tools/virt-win-reg.pl:471
33762 "Note that some of these tips modify the guest disk image. The guest I<must> "
33763 "be shut off, else you will get disk corruption."
33768 #: ../tools/virt-win-reg.pl:474
33769 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33774 #: ../tools/virt-win-reg.pl:476
33776 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33777 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33778 "is uploaded into C<C:\\>:"
33783 #: ../tools/virt-win-reg.pl:480
33786 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33792 #: ../tools/virt-win-reg.pl:482
33793 msgid "Prepare a regedit file containing the registry change:"
33798 #: ../tools/virt-win-reg.pl:484
33801 " cat > test.reg <<'EOF'\n"
33802 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33803 " \"Test\"=\"c:\\\\test.bat\"\n"
33810 #: ../tools/virt-win-reg.pl:489
33812 "In this example we use the key C<RunOnce> which means that the script will "
33813 "run precisely once when the first user logs in. If you want it to run every "
33814 "time a user logs in, replace C<RunOnce> with C<Run>."
33819 #: ../tools/virt-win-reg.pl:493
33820 msgid "Now update the registry:"
33825 #: ../tools/virt-win-reg.pl:495
33828 " virt-win-reg --merge WindowsGuest test.reg\n"
33834 #: ../tools/virt-win-reg.pl:497
33835 msgid "INSTALLING A SERVICE"
33840 #: ../tools/virt-win-reg.pl:499
33842 "This section assumes you are familiar with Windows services, and you either "
33843 "have a program which handles the Windows Service Control Protocol directly "
33844 "or you want to run any program using a service wrapper like SrvAny or the "
33850 #: ../tools/virt-win-reg.pl:504
33852 "First upload the program and optionally the service wrapper. In this case "
33853 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33858 #: ../tools/virt-win-reg.pl:508
33861 " guestfish -i -d WindowsGuest <<EOF\n"
33862 " upload rhsrvany.exe /rhsrvany.exe\n"
33863 " upload test.exe /test.exe\n"
33870 #: ../tools/virt-win-reg.pl:513
33872 "Prepare a regedit file containing the registry changes. In this example, "
33873 "the first registry change is needed for the service itself or the service "
33874 "wrapper (if used). The second registry change is only needed because I am "
33875 "using the RHSrvAny service wrapper."
33880 #: ../tools/virt-win-reg.pl:518
33883 " cat > service.reg <<'EOF'\n"
33884 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33885 " \"Type\"=dword:00000010\n"
33886 " \"Start\"=dword:00000002\n"
33887 " \"ErrorControl\"=dword:00000001\n"
33888 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33889 " \"DisplayName\"=\"RHSrvAny\"\n"
33890 " \"ObjectName\"=\"NetworkService\"\n"
33896 #: ../tools/virt-win-reg.pl:527
33899 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33900 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33901 " \"PWD\"=\"c:\\\\Temp\"\n"
33908 #: ../tools/virt-win-reg.pl:538
33910 "For use of C<ControlSet001> see the section above in this manual page. You "
33911 "may need to adjust this according to the control set that is in use by the "
33917 #: ../tools/virt-win-reg.pl:544
33919 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33920 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33921 "privileged account."
33926 #: ../tools/virt-win-reg.pl:550
33928 "For the meaning of the magic numbers, see this Microsoft KB article: "
33929 "L<http://support.microsoft.com/kb/103000>."
33934 #: ../tools/virt-win-reg.pl:555
33935 msgid "Update the registry:"
33940 #: ../tools/virt-win-reg.pl:557
33943 " virt-win-reg --merge WindowsGuest service.reg\n"
33949 #: ../tools/virt-win-reg.pl:561
33951 "Be careful when passing parameters containing C<\\> (backslash) in the "
33952 "shell. Usually you will have to use 'single quotes' or double backslashes "
33953 "(but not both) to protect them from the shell."
33958 #: ../tools/virt-win-reg.pl:565
33959 msgid "Paths and value names are case-insensitive."
33964 #: ../tools/virt-win-reg.pl:574
33966 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33967 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33968 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33973 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33975 "When reporting bugs, please enable debugging and capture the I<complete> "
33981 #: ../tools/virt-win-reg.pl:592
33984 " export LIBGUESTFS_DEBUG=1\n"
33985 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33991 #: ../tools/virt-win-reg.pl:595
33993 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33999 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
34000 msgid "Copyright (C) 2010 Red Hat Inc."
34005 #: ../tools/virt-list-filesystems.pl:32
34007 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34012 #: ../tools/virt-list-filesystems.pl:36
34015 " virt-list-filesystems [--options] domname\n"
34021 #: ../tools/virt-list-filesystems.pl:38
34024 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34030 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34032 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34038 #: ../tools/virt-list-filesystems.pl:45
34040 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34041 "are contained in a virtual machine or disk image."
34046 #: ../tools/virt-list-filesystems.pl:49
34048 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34049 "functionality. For more complex cases you should look at the L<guestfish(1)"
34055 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34056 msgid "B<-l> | B<--long>"
34061 #: ../tools/virt-list-filesystems.pl:108
34063 "With this option, C<virt-list-filesystems> displays the type of each "
34064 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34069 #: ../tools/virt-list-filesystems.pl:115
34070 msgid "B<-a> | B<--all>"
34075 #: ../tools/virt-list-filesystems.pl:117
34077 "Normally we only show mountable filesystems. If this option is given then "
34078 "swap devices are shown too."
34083 #: ../tools/virt-list-filesystems.pl:191
34085 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34086 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34087 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34092 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34093 msgid "Copyright (C) 2009 Red Hat Inc."
34098 #: ../tools/virt-tar.pl:33
34099 msgid "virt-tar - Extract or upload files to a virtual machine"
34104 #: ../tools/virt-tar.pl:37
34107 " virt-tar [--options] -x domname directory tarball\n"
34113 #: ../tools/virt-tar.pl:39
34116 " virt-tar [--options] -u domname tarball directory\n"
34122 #: ../tools/virt-tar.pl:41
34125 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34131 #: ../tools/virt-tar.pl:43
34134 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34139 #: ../tools/virt-tar.pl:47
34141 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34142 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34147 #: ../tools/virt-tar.pl:52
34148 msgid "Download C</home> from the VM into a local tarball:"
34153 #: ../tools/virt-tar.pl:54
34156 " virt-tar -x domname /home home.tar\n"
34162 #: ../tools/virt-tar.pl:56
34165 " virt-tar -zx domname /home home.tar.gz\n"
34171 #: ../tools/virt-tar.pl:58
34172 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34177 #: ../tools/virt-tar.pl:60
34180 " virt-tar -u domname uploadstuff.tar /tmp\n"
34186 #: ../tools/virt-tar.pl:62
34189 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34194 #: ../tools/virt-tar.pl:66
34196 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34197 "virtual machines. If you do this, you risk disk corruption in the VM. "
34198 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34202 #: ../tools/virt-tar.pl:71
34204 "You can use I<-x> (extract) on live virtual machines, but you might get "
34205 "inconsistent results or errors if there is filesystem activity inside the "
34206 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34207 "work, but the only way to guarantee consistent results is if the virtual "
34208 "machine is shut down."
34213 #: ../tools/virt-tar.pl:79
34215 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34216 "parts of a guest filesystem. There are many possibilities: making backups, "
34217 "uploading data files, snooping on guest activity, fixing or customizing "
34223 #: ../tools/virt-tar.pl:84
34225 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34226 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34227 "should look at the L<guestfish(1)> tool."
34231 #: ../tools/virt-tar.pl:88
34233 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34234 "its contents (recursively) from the virtual machine into a local tarball. "
34235 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34236 "virtual machine. You cannot use these two options together."
34240 #: ../tools/virt-tar.pl:94
34242 "In addition, you may need to use the I<-z> (gZip) option to enable "
34243 "compression. When uploading, you have to specify I<-z> if the upload file "
34244 "is compressed because virt-tar won't detect this on its own."
34249 #: ../tools/virt-tar.pl:98
34251 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34252 "example it cannot do PKZip files or bzip2 compression. If you want that "
34253 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34254 "the L<libguestfs(3)> API)."
34259 #: ../tools/virt-tar.pl:156
34260 msgid "B<-x> | B<--extract> | B<--download>"
34265 #: ../tools/virt-tar.pl:158
34266 msgid "B<-u> | B<--upload>"
34270 #: ../tools/virt-tar.pl:160
34272 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34277 #: ../tools/virt-tar.pl:163
34279 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34280 "Please read the L</WARNING> section above before using this option."
34285 #: ../tools/virt-tar.pl:167
34286 msgid "You must specify exactly one of these options."
34291 #: ../tools/virt-tar.pl:173
34292 msgid "B<-z> | B<--gzip>"
34297 #: ../tools/virt-tar.pl:175
34298 msgid "Specify that the input or output tarball is gzip-compressed."
34302 #: ../tools/virt-tar.pl:288
34304 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34305 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34306 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34312 #: ../tools/virt-make-fs.pl:37
34313 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34318 #: ../tools/virt-make-fs.pl:41
34321 " virt-make-fs [--options] input.tar output.img\n"
34327 #: ../tools/virt-make-fs.pl:43
34330 " virt-make-fs [--options] input.tar.gz output.img\n"
34336 #: ../tools/virt-make-fs.pl:45
34339 " virt-make-fs [--options] directory output.img\n"
34345 #: ../tools/virt-make-fs.pl:49
34347 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34348 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34349 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34350 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34351 "you want to attach these filesystems to existing virtual machines (eg. to "
34352 "import large amounts of read-only data to a VM)."
34357 #: ../tools/virt-make-fs.pl:57
34358 msgid "Basic usage is:"
34363 #: ../tools/virt-make-fs.pl:59
34366 " virt-make-fs input output\n"
34372 #: ../tools/virt-make-fs.pl:61
34374 "where C<input> is either a directory containing files that you want to add, "
34375 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34376 "C<output> is a disk image. The input type is detected automatically. The "
34377 "output disk image defaults to a raw ext2 image unless you specify extra "
34378 "flags (see L</OPTIONS> below)."
34383 #: ../tools/virt-make-fs.pl:67
34384 msgid "EXTRA SPACE"
34388 #: ../tools/virt-make-fs.pl:69
34390 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34391 "the files that it contains, but might have extra space. Depending on how "
34392 "you are going to use the output, you might think this extra space is wasted "
34393 "and want to minimize it, or you might want to leave space so that more files "
34394 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34395 "but you can use the I<--size> flag to leave space in the filesystem if you "
34400 #: ../tools/virt-make-fs.pl:77
34402 "An alternative way to leave extra space but not make the output image any "
34403 "bigger is to use an alternative disk image format (instead of the default "
34404 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34405 "image format (check your hypervisor supports this before using it). This "
34406 "allows you to choose a large I<--size> but the extra space won't actually be "
34407 "allocated in the image until you try to store something in it."
34411 #: ../tools/virt-make-fs.pl:85
34413 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34414 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34415 "to build another image from scratch."
34420 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34421 #: ../tools/virt-make-fs.pl:142
34427 #: ../tools/virt-make-fs.pl:91
34430 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34436 #: ../tools/virt-make-fs.pl:93
34437 msgid "FILESYSTEM TYPE"
34442 #: ../tools/virt-make-fs.pl:95
34444 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34445 "libguestfs supports can be used (but I<not> read-only formats like "
34446 "ISO9660). Here are some of the more common choices:"
34451 #: ../tools/virt-make-fs.pl:101
34457 #: ../tools/virt-make-fs.pl:103
34459 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34460 "you are not going to use the filesystem in a way that requires the journal, "
34461 "then this is just wasted overhead."
34466 #: ../tools/virt-make-fs.pl:107
34467 msgid "I<ntfs> or I<vfat>"
34472 #: ../tools/virt-make-fs.pl:109
34473 msgid "Useful if exporting data to a Windows guest."
34478 #: ../tools/virt-make-fs.pl:111
34480 "I<Note for vfat>: The tar archive or local directory must only contain files "
34481 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34482 "program running within libguestfs is unable to change the ownership of non-"
34483 "root files, since vfat itself does not support this."
34488 #: ../tools/virt-make-fs.pl:116
34494 #: ../tools/virt-make-fs.pl:118
34496 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34497 "total filesystem size."
34502 #: ../tools/virt-make-fs.pl:125
34505 " virt-make-fs --type=minix input minixfs.img\n"
34511 #: ../tools/virt-make-fs.pl:127
34512 msgid "TO PARTITION OR NOT TO PARTITION"
34517 #: ../tools/virt-make-fs.pl:129
34518 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34523 #: ../tools/virt-make-fs.pl:131
34525 "Adding a partition can make the disk image more compatible with certain "
34526 "virtualized operating systems which don't expect to see a filesystem "
34527 "directly located on a block device (Linux doesn't care and will happily "
34528 "handle both types)."
34533 #: ../tools/virt-make-fs.pl:136
34535 "On the other hand, if you have a partition table then the output image is no "
34536 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34537 "directly on a partitioned disk image. (However libguestfs tools such as "
34538 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34543 #: ../tools/virt-make-fs.pl:144
34544 msgid "Add an MBR partition:"
34549 #: ../tools/virt-make-fs.pl:146
34552 " virt-make-fs --partition -- input disk.img\n"
34558 #: ../tools/virt-make-fs.pl:148
34560 "If the output disk image could be terabyte-sized or larger, it's better to "
34561 "use an EFI/GPT-compatible partition table:"
34566 #: ../tools/virt-make-fs.pl:151
34569 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34575 #: ../tools/virt-make-fs.pl:179
34576 msgid "Enable debugging information."
34581 #: ../tools/virt-make-fs.pl:185
34582 msgid "B<--size=E<lt>NE<gt>>"
34587 #: ../tools/virt-make-fs.pl:187
34588 msgid "B<--size=+E<lt>NE<gt>>"
34593 #: ../tools/virt-make-fs.pl:189
34594 msgid "B<-s E<lt>NE<gt>>"
34599 #: ../tools/virt-make-fs.pl:191
34600 msgid "B<-s +E<lt>NE<gt>>"
34604 #: ../tools/virt-make-fs.pl:193
34606 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34611 #: ../tools/virt-make-fs.pl:196
34613 "If this option is I<not> given, then the output image will be just large "
34614 "enough to contain all the files, with not much wasted space."
34619 #: ../tools/virt-make-fs.pl:199
34621 "To choose a fixed size output disk, specify an absolute number followed by b/"
34622 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34623 "Petabytes or Exabytes. This must be large enough to contain all the input "
34624 "files, else you will get an error."
34628 #: ../tools/virt-make-fs.pl:204
34630 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34631 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34632 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34633 "the input files, and (approximately) an extra 200 MB free space."
34638 #: ../tools/virt-make-fs.pl:210
34640 "Note that virt-make-fs estimates free space, and therefore will not produce "
34641 "filesystems containing precisely the free space requested. (It is much more "
34642 "expensive and time-consuming to produce a filesystem which has precisely the "
34643 "desired free space)."
34648 #: ../tools/virt-make-fs.pl:219
34649 msgid "B<--format=E<lt>fmtE<gt>>"
34654 #: ../tools/virt-make-fs.pl:221
34655 msgid "B<-F E<lt>fmtE<gt>>"
34660 #: ../tools/virt-make-fs.pl:223
34661 msgid "Choose the output disk image format."
34666 #: ../tools/virt-make-fs.pl:225
34667 msgid "The default is C<raw> (raw disk image)."
34672 #: ../tools/virt-make-fs.pl:227
34674 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34675 "that would really make sense here is C<qcow2>."
34680 #: ../tools/virt-make-fs.pl:234
34681 msgid "B<--type=E<lt>fsE<gt>>"
34686 #: ../tools/virt-make-fs.pl:236
34687 msgid "B<-t E<lt>fsE<gt>>"
34692 #: ../tools/virt-make-fs.pl:238
34693 msgid "Choose the output filesystem type."
34698 #: ../tools/virt-make-fs.pl:240
34699 msgid "The default is C<ext2>."
34704 #: ../tools/virt-make-fs.pl:242
34706 "Any filesystem which is supported read-write by libguestfs can be used here."
34711 #: ../tools/virt-make-fs.pl:249
34712 msgid "B<--partition>"
34717 #: ../tools/virt-make-fs.pl:251
34718 msgid "B<--partition=E<lt>parttypeE<gt>>"
34723 #: ../tools/virt-make-fs.pl:253
34725 "If specified, this flag adds an MBR partition table to the output disk image."
34729 #: ../tools/virt-make-fs.pl:256
34731 "You can change the partition table type, eg. I<--partition=gpt> for large "
34736 #: ../tools/virt-make-fs.pl:259
34738 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34739 "might consider the next parameter to be the partition type. For example:"
34744 #: ../tools/virt-make-fs.pl:263
34747 " virt-make-fs --partition input.tar ...\n"
34752 #: ../tools/virt-make-fs.pl:265
34754 "would cause virt-make-fs to think you wanted to use a partition type of "
34755 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34756 "dash) between options and the input file argument:"
34761 #: ../tools/virt-make-fs.pl:269
34764 " virt-make-fs --partition -- input.tar ...\n"
34769 #: ../tools/virt-make-fs.pl:541
34771 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34772 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34773 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34778 #: ../tools/virt-make-fs.pl:558
34781 " export LIBGUESTFS_DEBUG=1\n"
34782 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34788 #: ../tools/virt-make-fs.pl:561
34790 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34796 #: ../tools/virt-list-partitions.pl:32
34798 "virt-list-partitions - List partitions in a virtual machine or disk image"
34803 #: ../tools/virt-list-partitions.pl:36
34806 " virt-list-partitions [--options] domname\n"
34812 #: ../tools/virt-list-partitions.pl:38
34815 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34821 #: ../tools/virt-list-partitions.pl:45
34823 "C<virt-list-partitions> is a command line tool to list the partitions that "
34824 "are contained in a virtual machine or disk image. It is mainly useful as a "
34825 "first step to using L<virt-resize(1)>."
34830 #: ../tools/virt-list-partitions.pl:50
34832 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34833 "functionality. For more complex cases you should look at the L<guestfish(1)"
34839 #: ../tools/virt-list-partitions.pl:107
34840 msgid "B<-h> | B<--human-readable>"
34845 #: ../tools/virt-list-partitions.pl:109
34846 msgid "Show sizes in human-readable form (eg. \"1G\")."
34851 #: ../tools/virt-list-partitions.pl:117
34853 "With this option, C<virt-list-partitions> displays the type and size of each "
34854 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34859 #: ../tools/virt-list-partitions.pl:124
34860 msgid "B<-t> | B<--total>"
34865 #: ../tools/virt-list-partitions.pl:126
34867 "Display the total size of each block device (as a separate row or rows)."
34872 #: ../tools/virt-list-partitions.pl:259
34874 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34875 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34876 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34881 #: ../tools/virt-list-partitions.pl:275
34882 msgid "Copyright (C) 2009-2010 Red Hat Inc."
git.annexia.org / libguestfs.git / blob