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-05-08 12:57+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:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
923 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
924 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
925 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
926 #: ../src/guestfs.pod:2963 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971
927 #: ../src/guestfs.pod:2975 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
929 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
930 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1606
931 #: ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614
932 #: ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1626
933 #: ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1634
934 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648
935 #: ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1790
936 #: ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1799
937 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1865
938 #: ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1874
939 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
940 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
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:1077 ../fish/guestfish-actions.pod:1081
945 #: ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089
946 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1101
947 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1115
948 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
949 #: ../fish/guestfish-actions.pod:1213 ../fish/guestfish-actions.pod:1217
950 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1227
951 #: ../fish/guestfish-actions.pod:1269 ../fish/guestfish-actions.pod:1273
952 #: ../fish/guestfish-actions.pod:1278 ../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:2426
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:2451
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:767
1233 msgid "ENCRYPTED DISKS"
1238 #: ../src/guestfs.pod:521
1240 "Libguestfs allows you to access Linux guests which have been encrypted using "
1241 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1242 "standard. This includes nearly all whole disk encryption systems used by "
1243 "modern Linux guests."
1248 #: ../src/guestfs.pod:527
1250 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1251 "returns the string C<crypto_LUKS>)."
1256 #: ../src/guestfs.pod:530
1258 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1259 "will require the passphrase!"
1264 #: ../src/guestfs.pod:533
1266 "Opening a LUKS device creates a new device mapper device called C</dev/"
1267 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1268 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1269 "from and encrypted to the underlying block device respectively."
1274 #: ../src/guestfs.pod:539
1276 "LVM volume groups on the device can be made visible by calling L</"
1277 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1278 "(s) can now be mounted in the usual way."
1283 #: ../src/guestfs.pod:543
1285 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1286 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1287 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1288 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1289 "underlying encrypted block device)."
1294 #: ../src/guestfs.pod:550
1299 #: ../src/guestfs.pod:552
1301 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1302 "contains operating systems, an install CD or a live CD. (These APIs used to "
1303 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1304 "version 1.5.3 the most frequently used part of this library has been "
1305 "rewritten in C and moved into the core code)."
1310 #: ../src/guestfs.pod:559
1312 "Add all disks belonging to the unknown virtual machine and call L</"
1313 "guestfs_launch> in the usual way."
1318 #: ../src/guestfs.pod:562
1320 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1321 "and certain heuristics, and returns a list of operating systems that were "
1322 "found. An empty list means none were found. A single element is the root "
1323 "filesystem of the operating system. For dual- or multi-boot guests, "
1324 "multiple roots can be returned, each one corresponding to a separate "
1325 "operating system. (Multi-boot virtual machines are extremely rare in the "
1326 "world of virtualization, but since this scenario can happen, we have built "
1327 "libguestfs to deal with it.)"
1332 #: ../src/guestfs.pod:571
1334 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1335 "to get additional details about that operating system. For example, call L</"
1336 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1337 "Windows and Linux-based operating systems respectively."
1342 #: ../src/guestfs.pod:577
1344 "Un*x-like and Linux-based operating systems usually consist of several "
1345 "filesystems which are mounted at boot time (for example, a separate boot "
1346 "partition mounted on C</boot>). The inspection rules are able to detect how "
1347 "filesystems correspond to mount points. Call "
1348 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1349 "hash table like this example:"
1354 #: ../src/guestfs.pod:584
1357 " /boot => /dev/sda1\n"
1358 " / => /dev/vg_guest/lv_root\n"
1359 " /usr => /dev/vg_guest/lv_usr\n"
1365 #: ../src/guestfs.pod:588
1367 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1368 "filesystems as suggested."
1373 #: ../src/guestfs.pod:591
1375 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1376 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1381 #: ../src/guestfs.pod:595
1383 "Inspection currently only works for some common operating systems. "
1384 "Contributors are welcome to send patches for other operating systems that we "
1385 "currently cannot detect."
1390 #: ../src/guestfs.pod:599
1392 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1393 "for more details. The L</guestfs_inspect_os> function just ignores any "
1394 "encrypted devices."
1399 #: ../src/guestfs.pod:603
1401 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1402 "inspection and caches the results in the guest handle. Subsequent calls to "
1403 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1404 "read the disks. If you change the content of the guest disks, you can redo "
1405 "inspection by calling L</guestfs_inspect_os> again. (L</"
1406 "guestfs_inspect_list_applications> works a little differently from the other "
1407 "calls and does read the disks. See documentation for that function for "
1412 #: ../src/guestfs.pod:612
1413 msgid "INSPECTING INSTALL DISKS"
1417 #: ../src/guestfs.pod:614
1419 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1424 #: ../src/guestfs.pod:617
1426 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1427 "system, which currently can be C<installed> (a regular operating system) or "
1428 "C<installer> (some sort of install disk)."
1432 #: ../src/guestfs.pod:621
1434 "Further information is available about the operating system that can be "
1435 "installed using the regular inspection APIs like L</"
1436 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1440 #: ../src/guestfs.pod:626
1442 "Some additional information specific to installer disks is also available "
1443 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1444 "guestfs_inspect_is_multipart> calls."
1449 #: ../src/guestfs.pod:631
1450 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1455 #: ../src/guestfs.pod:633
1457 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1458 "ntfs-3g.org/> driver."
1463 #: ../src/guestfs.pod:636
1464 msgid "DRIVE LETTERS AND PATHS"
1469 #: ../src/guestfs.pod:638
1471 "DOS and Windows still use drive letters, and the filesystems are always "
1472 "treated as case insensitive by Windows itself, and therefore you might find "
1473 "a Windows configuration file referring to a path like C<c:\\windows"
1474 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1475 "might be referred to as C</WINDOWS/System32>."
1479 #: ../src/guestfs.pod:644
1481 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1482 "L</guestfs_inspect_get_drive_mappings>)"
1486 #: ../src/guestfs.pod:647
1488 "Dealing with separator characters (backslash vs forward slash) is outside "
1489 "the scope of libguestfs, but usually a simple character replacement will "
1494 #: ../src/guestfs.pod:651
1496 "To resolve the case insensitivity of paths, call L</"
1497 "guestfs_case_sensitive_path>."
1502 #: ../src/guestfs.pod:654
1503 msgid "ACCESSING THE WINDOWS REGISTRY"
1508 #: ../src/guestfs.pod:656
1510 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1511 "files, through the library C<hivex> which is part of the libguestfs project "
1512 "although ships as a separate tarball. You have to locate and download the "
1513 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1514 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1515 "reg(1)> for more help on this issue."
1520 #: ../src/guestfs.pod:664
1521 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1526 #: ../src/guestfs.pod:666
1528 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1529 "provide something which looks like a Linux symlink. The way it tries to do "
1530 "the rewriting is described here:"
1535 #: ../src/guestfs.pod:670
1537 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1543 #: ../src/guestfs.pod:672
1545 "The essential problem is that ntfs-3g simply does not have enough "
1546 "information to do a correct job. NTFS links can contain drive letters and "
1547 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1548 "It is almost certainly the case that libguestfs callers should ignore what "
1549 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1554 #: ../src/guestfs.pod:679
1556 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1557 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1558 "attribute, and read the raw reparse data from that (you can find the format "
1559 "documented in various places around the web)."
1564 #: ../src/guestfs.pod:684
1565 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1570 #: ../src/guestfs.pod:686
1572 "There are other useful extended attributes that can be read from ntfs-3g "
1573 "filesystems (using L</guestfs_getxattr>). See:"
1578 #: ../src/guestfs.pod:689
1580 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1585 #: ../src/guestfs.pod:691
1586 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1591 #: ../src/guestfs.pod:693
1593 "Although we don't want to discourage you from using the C API, we will "
1594 "mention here that the same API is also available in other languages."
1598 #: ../src/guestfs.pod:696
1600 "The API is broadly identical in all supported languages. This means that "
1601 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1602 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1603 "OCaml. In other words, a straightforward, predictable isomorphism between "
1609 #: ../src/guestfs.pod:702
1611 "Error messages are automatically transformed into exceptions if the language "
1617 #: ../src/guestfs.pod:705
1619 "We don't try to \"object orientify\" parts of the API in OO languages, "
1620 "although contributors are welcome to write higher level APIs above what we "
1621 "provide in their favourite languages if they wish."
1626 #: ../src/guestfs.pod:711
1632 #: ../src/guestfs.pod:713
1634 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1635 "identical to the C API. C++ classes and exceptions are not used."
1640 #: ../src/guestfs.pod:717
1646 #: ../src/guestfs.pod:719
1648 "The C# bindings are highly experimental. Please read the warnings at the "
1649 "top of C<csharp/Libguestfs.cs>."
1654 #: ../src/guestfs.pod:722
1660 #: ../src/guestfs.pod:724
1662 "This is the only language binding that is working but incomplete. Only "
1663 "calls which return simple integers have been bound in Haskell, and we are "
1664 "looking for help to complete this binding."
1669 #: ../src/guestfs.pod:728
1675 #: ../src/guestfs.pod:730
1677 "Full documentation is contained in the Javadoc which is distributed with "
1683 #: ../src/guestfs.pod:733
1688 #: ../src/guestfs.pod:735
1689 msgid "See L<guestfs-ocaml(3)>."
1694 #: ../src/guestfs.pod:737
1699 #: ../src/guestfs.pod:739
1700 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1705 #: ../src/guestfs.pod:741
1711 #: ../src/guestfs.pod:743
1713 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1714 "the php-libguestfs package for your distribution."
1719 #: ../src/guestfs.pod:746
1720 msgid "The PHP binding only works correctly on 64 bit machines."
1725 #: ../src/guestfs.pod:748
1730 #: ../src/guestfs.pod:750
1731 msgid "See L<guestfs-python(3)>."
1736 #: ../src/guestfs.pod:752
1741 #: ../src/guestfs.pod:754
1742 msgid "See L<guestfs-ruby(3)>."
1747 #: ../src/guestfs.pod:756
1748 msgid "B<shell scripts>"
1752 #: ../src/guestfs.pod:758
1753 msgid "See L<guestfish(1)>."
1758 #: ../src/guestfs.pod:762
1759 msgid "LIBGUESTFS GOTCHAS"
1764 #: ../src/guestfs.pod:764
1766 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1767 "system [...] that works in the way it is documented but is counterintuitive "
1768 "and almost invites mistakes.\""
1773 #: ../src/guestfs.pod:768
1775 "Since we developed libguestfs and the associated tools, there are several "
1776 "things we would have designed differently, but are now stuck with for "
1777 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1778 "release, you can expect these to change. Beware of them."
1783 #: ../src/guestfs.pod:776
1784 msgid "Autosync / forgetting to sync."
1788 #: ../src/guestfs.pod:778
1790 "I<Update:> Autosync is enabled by default for all API users starting from "
1791 "libguestfs 1.5.24. This section only applies to older versions."
1796 #: ../src/guestfs.pod:781
1798 "When modifying a filesystem from C or another language, you B<must> unmount "
1799 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1800 "libguestfs handle. You can also call:"
1805 #: ../src/guestfs.pod:785
1808 " guestfs_set_autosync (g, 1);\n"
1814 #: ../src/guestfs.pod:787
1816 "to have the unmount/sync done automatically for you when the handle 'g' is "
1817 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1822 #: ../src/guestfs.pod:791
1824 "If you forget to do this, then it is entirely possible that your changes "
1825 "won't be written out, or will be partially written, or (very rarely) that "
1826 "you'll get disk corruption."
1831 #: ../src/guestfs.pod:795
1833 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1834 "guestfish scripts that forget to sync will work just fine, which can make "
1835 "this very puzzling if you are trying to debug a problem."
1840 #: ../src/guestfs.pod:799
1841 msgid "Mount option C<-o sync> should not be the default."
1846 #: ../src/guestfs.pod:801
1848 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1849 "However C<-o sync> does not add any reliability benefit, but does have a "
1850 "very large performance impact."
1855 #: ../src/guestfs.pod:805
1857 "The work around is to use L</guestfs_mount_options> and set the mount "
1858 "options that you actually want to use."
1863 #: ../src/guestfs.pod:808
1864 msgid "Read-only should be the default."
1869 #: ../src/guestfs.pod:810
1871 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1872 "specify I<--rw> if you want to make changes to the image."
1877 #: ../src/guestfs.pod:813
1878 msgid "This would reduce the potential to corrupt live VM images."
1883 #: ../src/guestfs.pod:815
1885 "Note that many filesystems change the disk when you just mount and unmount, "
1886 "even if you didn't perform any writes. You need to use L</"
1887 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1892 #: ../src/guestfs.pod:819
1893 msgid "guestfish command line is hard to use."
1898 #: ../src/guestfs.pod:821
1900 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1901 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1902 "exist, so it fails. In earlier versions of guestfish the error message was "
1903 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1904 "we should have used C<guestfish -c command> to run commands."
1909 #: ../src/guestfs.pod:828
1910 msgid "guestfish megabyte modifiers don't work right on all commands"
1915 #: ../src/guestfs.pod:830
1917 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1918 "other modifiers). What guestfish actually does is to multiply the number "
1919 "part by the modifier part and pass the result to the C API. However this "
1920 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1921 "expecting some other unit (eg. megabytes)."
1926 #: ../src/guestfs.pod:837
1927 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1932 #: ../src/guestfs.pod:839
1935 " lvcreate LV VG 100M\n"
1941 #: ../src/guestfs.pod:841
1943 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1944 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1945 "megabytes * megabytes) logical volume. The error message you get from this "
1946 "is also a little obscure."
1951 #: ../src/guestfs.pod:846
1953 "This could be fixed in the generator by specially marking parameters and "
1954 "return values which take bytes or other units."
1959 #: ../src/guestfs.pod:849
1960 msgid "Ambiguity between devices and paths"
1965 #: ../src/guestfs.pod:851
1967 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1968 "sdb2>) and a similar pathname. A file might just happen to be called "
1969 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1974 #: ../src/guestfs.pod:856
1976 "In the current API we usually resolve this ambiguity by having two separate "
1977 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1978 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1979 "detecting if the path supplied begins with C</dev/>."
1984 #: ../src/guestfs.pod:862
1986 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1987 "make paths/devices into structured names. One way to do this would be to "
1988 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1989 "aspect of grub. Another way would be to use a structured type, equivalent "
1990 "to this OCaml type:"
1995 #: ../src/guestfs.pod:868
1998 " type path = Path of string | Device of int | Partition of int * int\n"
2004 #: ../src/guestfs.pod:870
2005 msgid "which would allow you to pass arguments like:"
2010 #: ../src/guestfs.pod:872
2013 " Path \"/foo/bar\"\n"
2014 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2015 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2016 " Path \"/dev/sdb2\" (* not a device *)\n"
2022 #: ../src/guestfs.pod:877
2024 "As you can see there are still problems to resolve even with this "
2025 "representation. Also consider how it might work in guestfish."
2030 #: ../src/guestfs.pod:882
2031 msgid "KEYS AND PASSPHRASES"
2036 #: ../src/guestfs.pod:884
2038 "Certain libguestfs calls take a parameter that contains sensitive key "
2039 "material, passed in as a C string."
2044 #: ../src/guestfs.pod:887
2046 "In the future we would hope to change the libguestfs implementation so that "
2047 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2048 "swap. However this is I<not> done at the moment, because of the complexity "
2049 "of such an implementation."
2054 #: ../src/guestfs.pod:892
2056 "Therefore you should be aware that any key parameter you pass to libguestfs "
2057 "might end up being written out to the swap partition. If this is a concern, "
2058 "scrub the swap partition or don't use libguestfs on encrypted devices."
2063 #: ../src/guestfs.pod:897
2064 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2069 #: ../src/guestfs.pod:899
2071 "All high-level libguestfs actions are synchronous. If you want to use "
2072 "libguestfs asynchronously then you must create a thread."
2077 #: ../src/guestfs.pod:902
2079 "Only use the handle from a single thread. Either use the handle exclusively "
2080 "from one thread, or provide your own mutex so that two threads cannot issue "
2081 "calls on the same handle at the same time."
2086 #: ../src/guestfs.pod:906
2088 "See the graphical program guestfs-browser for one possible architecture for "
2089 "multithreaded programs using libvirt and libguestfs."
2094 #: ../src/guestfs.pod:909
2099 #: ../src/guestfs.pod:911
2101 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2107 #: ../src/guestfs.pod:914
2109 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2110 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2115 #: ../src/guestfs.pod:917
2117 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2118 "to change the directories that libguestfs will search in. The value is a "
2119 "colon-separated list of paths. The current directory is I<not> searched "
2120 "unless the path contains an empty element or C<.>. For example "
2121 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2122 "then C</usr/lib/guestfs>."
2127 #: ../src/guestfs.pod:924
2128 msgid "QEMU WRAPPERS"
2133 #: ../src/guestfs.pod:926
2135 "If you want to compile your own qemu, run qemu from a non-standard location, "
2136 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2142 #: ../src/guestfs.pod:930
2144 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2145 "last command in the shell script (so that qemu replaces the shell and "
2146 "becomes the direct child of the libguestfs-using program). If you don't do "
2147 "this, then the qemu process won't be cleaned up correctly."
2152 #: ../src/guestfs.pod:935
2154 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2160 #: ../src/guestfs.pod:938
2164 " qemudir=/home/rjones/d/qemu\n"
2165 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2171 #: ../src/guestfs.pod:942
2173 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2174 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2180 #: ../src/guestfs.pod:946
2183 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2189 #: ../src/guestfs.pod:948
2191 "Note that libguestfs also calls qemu with the -help and -version options in "
2192 "order to determine features."
2196 #: ../src/guestfs.pod:951
2197 msgid "ATTACHING TO RUNNING DAEMONS"
2201 #: ../src/guestfs.pod:953
2203 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2204 "babies. Use with caution."
2208 #: ../src/guestfs.pod:956
2210 "I<Note (2):> This section explains how to attach to a running daemon from a "
2211 "low level perspective. For most users, simply using virt tools such as "
2212 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2216 #: ../src/guestfs.pod:960
2217 msgid "Using guestfs_set_attach_method"
2221 #: ../src/guestfs.pod:962
2223 "By calling L</guestfs_set_attach_method> you can change how the library "
2224 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2225 "ARCHITECTURE> for some background)."
2229 #: ../src/guestfs.pod:966
2231 "The normal attach method is C<appliance>, where a small appliance is created "
2232 "containing the daemon, and then the library connects to this."
2236 #: ../src/guestfs.pod:969
2238 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2239 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2240 "daemon over the Unix domain socket."
2244 #: ../src/guestfs.pod:973
2246 "The normal use for this is to connect to a running virtual machine that "
2247 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2248 "files inside the live virtual machine."
2252 #: ../src/guestfs.pod:977
2253 msgid "Using guestfs_add_domain with live flag"
2257 #: ../src/guestfs.pod:979
2259 "L</guestfs_add_domain> provides some help for getting the correct attach "
2260 "method. If you pass the C<live> option to this function, then (if the "
2261 "virtual machine is running) it will examine the libvirt XML looking for a "
2262 "virtio-serial channel to connect to:"
2266 #: ../src/guestfs.pod:985
2273 " <channel type='unix'>\n"
2274 " <source mode='bind' path='/path/to/socket'/>\n"
2275 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2284 #: ../src/guestfs.pod:997
2286 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2287 "method to C<unix:/path/to/socket>."
2291 #: ../src/guestfs.pod:1000
2293 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2294 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2295 "to attach to and modify live virtual machines."
2299 #: ../src/guestfs.pod:1004
2301 "The virtual machine needs to have been set up beforehand so that it has the "
2302 "virtio-serial channel and so that guestfsd is running inside it."
2307 #: ../src/guestfs.pod:1008
2308 msgid "ABI GUARANTEE"
2313 #: ../src/guestfs.pod:1010
2315 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2316 "actions as outlined in this section. Although we will deprecate some "
2317 "actions, for example if they get replaced by newer calls, we will keep the "
2318 "old actions forever. This allows you the developer to program in confidence "
2319 "against the libguestfs API."
2324 #: ../src/guestfs.pod:1016
2325 msgid "BLOCK DEVICE NAMING"
2330 #: ../src/guestfs.pod:1018
2332 "In the kernel there is now quite a profusion of schemata for naming block "
2333 "devices (in this context, by I<block device> I mean a physical or virtual "
2334 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2335 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2336 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2337 "for the old IDE driver (particularly for SATA devices) those devices also "
2338 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2339 "paravirtualized drivers. This has created several different naming systems, "
2340 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2345 #: ../src/guestfs.pod:1030
2347 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2348 "Linux kernel to access block devices. We can run a variety of appliances "
2349 "based on a variety of Linux kernels."
2354 #: ../src/guestfs.pod:1034
2356 "This causes a problem for libguestfs because many API calls use device or "
2357 "partition names. Working scripts and the recipe (example) scripts that we "
2358 "make available over the internet could fail if the naming scheme changes."
2363 #: ../src/guestfs.pod:1039
2365 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2366 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2367 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2368 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2373 #: ../src/guestfs.pod:1045
2375 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2376 "L</guestfs_list_partitions> and similar calls return the true names of the "
2377 "devices and partitions as known to the appliance."
2382 #: ../src/guestfs.pod:1050
2383 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2388 #: ../src/guestfs.pod:1052
2390 "Usually this translation is transparent. However in some (very rare) cases "
2391 "you may need to know the exact algorithm. Such cases include where you use "
2392 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2393 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2398 #: ../src/guestfs.pod:1058
2400 "The algorithm is applied only to I<parameters> which are known to be either "
2401 "device or partition names. Return values from functions such as L</"
2402 "guestfs_list_devices> are never changed."
2407 #: ../src/guestfs.pod:1066
2408 msgid "Is the string a parameter which is a device or partition name?"
2413 #: ../src/guestfs.pod:1070
2414 msgid "Does the string begin with C</dev/sd>?"
2419 #: ../src/guestfs.pod:1074
2421 "Does the named device exist? If so, we use that device. However if I<not> "
2422 "then we continue with this algorithm."
2427 #: ../src/guestfs.pod:1079
2428 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2433 #: ../src/guestfs.pod:1081
2434 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2439 #: ../src/guestfs.pod:1083
2440 msgid "If that named device exists, use it. If not, continue."
2445 #: ../src/guestfs.pod:1087
2446 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2451 #: ../src/guestfs.pod:1089
2452 msgid "If that named device exists, use it. If not, return an error."
2457 #: ../src/guestfs.pod:1093
2458 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2463 #: ../src/guestfs.pod:1095
2465 "Although the standard naming scheme and automatic translation is useful for "
2466 "simple programs and guestfish scripts, for larger programs it is best not to "
2467 "rely on this mechanism."
2472 #: ../src/guestfs.pod:1099
2474 "Where possible for maximum future portability programs using libguestfs "
2475 "should use these future-proof techniques:"
2480 #: ../src/guestfs.pod:1106
2482 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2483 "device names, and then use those names directly."
2488 #: ../src/guestfs.pod:1109
2490 "Since those device names exist by definition, they will never be translated."
2495 #: ../src/guestfs.pod:1114
2497 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2498 "filesystem labels."
2503 #: ../src/guestfs.pod:1119
2509 #: ../src/guestfs.pod:1121
2511 "This section discusses security implications of using libguestfs, "
2512 "particularly with untrusted or malicious guests or disk images."
2517 #: ../src/guestfs.pod:1124
2518 msgid "GENERAL SECURITY CONSIDERATIONS"
2523 #: ../src/guestfs.pod:1126
2525 "Be careful with any files or data that you download from a guest (by "
2526 "\"download\" we mean not just the L</guestfs_download> command but any "
2527 "command that reads files, filenames, directories or anything else from a "
2528 "disk image). An attacker could manipulate the data to fool your program "
2529 "into doing the wrong thing. Consider cases such as:"
2534 #: ../src/guestfs.pod:1136
2535 msgid "the data (file etc) not being present"
2540 #: ../src/guestfs.pod:1140
2541 msgid "being present but empty"
2546 #: ../src/guestfs.pod:1144
2547 msgid "being much larger than normal"
2552 #: ../src/guestfs.pod:1148
2553 msgid "containing arbitrary 8 bit data"
2558 #: ../src/guestfs.pod:1152
2559 msgid "being in an unexpected character encoding"
2564 #: ../src/guestfs.pod:1156
2565 msgid "containing homoglyphs."
2570 #: ../src/guestfs.pod:1160
2571 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2576 #: ../src/guestfs.pod:1162
2578 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2579 "(VFS) module can sometimes be escalated into exploits by deliberately "
2580 "creating a malicious, malformed filesystem. These exploits are very severe "
2581 "for two reasons. Firstly there are very many filesystem drivers in the "
2582 "kernel, and many of them are infrequently used and not much developer "
2583 "attention has been paid to the code. Linux userspace helps potential "
2584 "crackers by detecting the filesystem type and automatically choosing the "
2585 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2586 "the administrator. Secondly, a kernel-level exploit is like a local root "
2587 "exploit (worse in some ways), giving immediate and total access to the "
2588 "system right down to the hardware level."
2593 #: ../src/guestfs.pod:1175
2595 "That explains why you should never mount a filesystem from an untrusted "
2596 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2597 "inside a qemu virtual machine, usually running as a non-root user. The "
2598 "attacker would need to write a filesystem which first exploited the kernel, "
2599 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2600 "the libguestfs protocol, and finally to be as serious as the host kernel "
2601 "exploit it would need to escalate its privileges to root. This multi-step "
2602 "escalation, performed by a static piece of data, is thought to be extremely "
2603 "hard to do, although we never say 'never' about security issues."
2608 #: ../src/guestfs.pod:1186
2610 "In any case callers can reduce the attack surface by forcing the filesystem "
2611 "type when mounting (use L</guestfs_mount_vfs>)."
2616 #: ../src/guestfs.pod:1189
2617 msgid "PROTOCOL SECURITY"
2622 #: ../src/guestfs.pod:1191
2624 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2625 "defined upper message size. However a program that uses libguestfs must "
2626 "also take care - for example you can write a program that downloads a binary "
2627 "from a disk image and executes it locally, and no amount of protocol "
2628 "security will save you from the consequences."
2633 #: ../src/guestfs.pod:1197
2634 msgid "INSPECTION SECURITY"
2639 #: ../src/guestfs.pod:1199
2641 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2642 "directly from the guest, and these could contain any 8 bit data. Callers "
2643 "should be careful to escape these before printing them to a structured file "
2644 "(for example, use HTML escaping if creating a web page)."
2649 #: ../src/guestfs.pod:1205
2651 "Guest configuration may be altered in unusual ways by the administrator of "
2652 "the virtual machine, and may not reflect reality (particularly for untrusted "
2653 "or actively malicious guests). For example we parse the hostname from "
2654 "configuration files like C</etc/sysconfig/network> that we find in the "
2655 "guest, but the guest administrator can easily manipulate these files to "
2656 "provide the wrong hostname."
2661 #: ../src/guestfs.pod:1213
2663 "The inspection API parses guest configuration using two external libraries: "
2664 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2665 "designed to be robust in the face of malicious data, although denial of "
2666 "service attacks are still possible, for example with oversized configuration "
2672 #: ../src/guestfs.pod:1219
2673 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2678 #: ../src/guestfs.pod:1221
2680 "Be very cautious about running commands from the guest. By running a "
2681 "command in the guest, you are giving CPU time to a binary that you do not "
2682 "control, under the same user account as the library, albeit wrapped in qemu "
2683 "virtualization. More information and alternatives can be found in the "
2684 "section L</RUNNING COMMANDS>."
2689 #: ../src/guestfs.pod:1227
2690 msgid "CVE-2010-3851"
2695 #: ../src/guestfs.pod:1229
2696 msgid "https://bugzilla.redhat.com/642934"
2701 #: ../src/guestfs.pod:1231
2703 "This security bug concerns the automatic disk format detection that qemu "
2704 "does on disk images."
2709 #: ../src/guestfs.pod:1234
2711 "A raw disk image is just the raw bytes, there is no header. Other disk "
2712 "images like qcow2 contain a special header. Qemu deals with this by looking "
2713 "for one of the known headers, and if none is found then assuming the disk "
2714 "image must be raw."
2719 #: ../src/guestfs.pod:1239
2721 "This allows a guest which has been given a raw disk image to write some "
2722 "other header. At next boot (or when the disk image is accessed by "
2723 "libguestfs) qemu would do autodetection and think the disk image format was, "
2724 "say, qcow2 based on the header written by the guest."
2729 #: ../src/guestfs.pod:1244
2731 "This in itself would not be a problem, but qcow2 offers many features, one "
2732 "of which is to allow a disk image to refer to another image (called the "
2733 "\"backing disk\"). It does this by placing the path to the backing disk "
2734 "into the qcow2 header. This path is not validated and could point to any "
2735 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2736 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2737 "control of the attacker."
2742 #: ../src/guestfs.pod:1252
2744 "In libguestfs this is rather hard to exploit except under two circumstances:"
2749 #: ../src/guestfs.pod:1259
2750 msgid "You have enabled the network or have opened the disk in write mode."
2755 #: ../src/guestfs.pod:1263
2757 "You are also running untrusted code from the guest (see L</RUNNING "
2763 #: ../src/guestfs.pod:1268
2765 "The way to avoid this is to specify the expected disk format when adding "
2766 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2767 "should always do this if the disk is raw format, and it's a good idea for "
2773 #: ../src/guestfs.pod:1273
2775 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2776 "format is fetched from libvirt and passed through."
2781 #: ../src/guestfs.pod:1276
2783 "For libguestfs tools, use the I<--format> command line parameter as "
2789 #: ../src/guestfs.pod:1279
2790 msgid "CONNECTION MANAGEMENT"
2795 #: ../src/guestfs.pod:1281
2801 #: ../src/guestfs.pod:1283
2803 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2804 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2805 "handle and release all resources used."
2809 #: ../src/guestfs.pod:1287
2811 "For information on using multiple handles and threads, see the section L</"
2812 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2817 #: ../src/guestfs.pod:1290
2818 msgid "guestfs_create"
2823 #: ../src/guestfs.pod:1292
2826 " guestfs_h *guestfs_create (void);\n"
2832 #: ../src/guestfs.pod:1294
2833 msgid "Create a connection handle."
2837 #: ../src/guestfs.pod:1296
2839 "On success this returns a non-NULL pointer to a handle. On error it returns "
2844 #: ../src/guestfs.pod:1299
2846 "You have to \"configure\" the handle after creating it. This includes "
2847 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2848 "handle at least once."
2853 #: ../src/guestfs.pod:1303
2854 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2858 #: ../src/guestfs.pod:1305
2860 "You may also want to configure error handling for the handle. See the L</"
2861 "ERROR HANDLING> section below."
2866 #: ../src/guestfs.pod:1308
2867 msgid "guestfs_close"
2872 #: ../src/guestfs.pod:1310
2875 " void guestfs_close (guestfs_h *g);\n"
2881 #: ../src/guestfs.pod:1312
2882 msgid "This closes the connection handle and frees up all resources used."
2886 #: ../src/guestfs.pod:1314
2888 "If autosync was set on the handle and the handle was launched, then this "
2889 "implicitly calls various functions to unmount filesystems and sync the "
2890 "disk. See L</guestfs_set_autosync> for more details."
2894 #: ../src/guestfs.pod:1318
2895 msgid "If a close callback was set on the handle, then it is called."
2900 #: ../src/guestfs.pod:1320
2901 msgid "ERROR HANDLING"
2906 #: ../src/guestfs.pod:1322
2908 "API functions can return errors. For example, almost all functions that "
2909 "return C<int> will return C<-1> to indicate an error."
2914 #: ../src/guestfs.pod:1325
2916 "Additional information is available for errors: an error message string and "
2917 "optionally an error number (errno) if the thing that failed was a system "
2923 #: ../src/guestfs.pod:1329
2925 "You can get at the additional information about the last error on the handle "
2926 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2927 "up an error handler with L</guestfs_set_error_handler>."
2932 #: ../src/guestfs.pod:1334
2934 "When the handle is created, a default error handler is installed which "
2935 "prints the error message string to C<stderr>. For small short-running "
2936 "command line programs it is sufficient to do:"
2941 #: ../src/guestfs.pod:1338
2944 " if (guestfs_launch (g) == -1)\n"
2945 " exit (EXIT_FAILURE);\n"
2951 #: ../src/guestfs.pod:1341
2953 "since the default error handler will ensure that an error message has been "
2954 "printed to C<stderr> before the program exits."
2959 #: ../src/guestfs.pod:1344
2961 "For other programs the caller will almost certainly want to install an "
2962 "alternate error handler or do error handling in-line like this:"
2967 #: ../src/guestfs.pod:1347
2970 " g = guestfs_create ();\n"
2976 #: ../src/guestfs.pod:1349
2979 " /* This disables the default behaviour of printing errors\n"
2981 " guestfs_set_error_handler (g, NULL, NULL);\n"
2987 #: ../src/guestfs.pod:1353
2990 " if (guestfs_launch (g) == -1) {\n"
2991 " /* Examine the error message and print it etc. */\n"
2992 " char *msg = guestfs_last_error (g);\n"
2993 " int errnum = guestfs_last_errno (g);\n"
2994 " fprintf (stderr, \"%s\\n\", msg);\n"
3002 #: ../src/guestfs.pod:1361
3004 "Out of memory errors are handled differently. The default action is to call "
3005 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3006 "guestfs_set_out_of_memory_handler>."
3011 #: ../src/guestfs.pod:1365
3013 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3014 "because there is no handle if this happens there is no way to get additional "
3015 "error information. However L</guestfs_create> is supposed to be a "
3016 "lightweight operation which can only fail because of insufficient memory (it "
3017 "returns NULL in this case)."
3022 #: ../src/guestfs.pod:1371
3023 msgid "guestfs_last_error"
3028 #: ../src/guestfs.pod:1373
3031 " const char *guestfs_last_error (guestfs_h *g);\n"
3037 #: ../src/guestfs.pod:1375
3039 "This returns the last error message that happened on C<g>. If there has not "
3040 "been an error since the handle was created, then this returns C<NULL>."
3045 #: ../src/guestfs.pod:1379
3047 "The lifetime of the returned string is until the next error occurs, or L</"
3048 "guestfs_close> is called."
3053 #: ../src/guestfs.pod:1382
3054 msgid "guestfs_last_errno"
3059 #: ../src/guestfs.pod:1384
3062 " int guestfs_last_errno (guestfs_h *g);\n"
3068 #: ../src/guestfs.pod:1386
3069 msgid "This returns the last error number (errno) that happened on C<g>."
3074 #: ../src/guestfs.pod:1388
3075 msgid "If successful, an errno integer not equal to zero is returned."
3080 #: ../src/guestfs.pod:1390
3082 "If no error, this returns 0. This call can return 0 in three situations:"
3087 #: ../src/guestfs.pod:1397
3088 msgid "There has not been any error on the handle."
3093 #: ../src/guestfs.pod:1401
3095 "There has been an error but the errno was meaningless. This corresponds to "
3096 "the case where the error did not come from a failed system call, but for "
3097 "some other reason."
3102 #: ../src/guestfs.pod:1407
3104 "There was an error from a failed system call, but for some reason the errno "
3105 "was not captured and returned. This usually indicates a bug in libguestfs."
3110 #: ../src/guestfs.pod:1413
3112 "Libguestfs tries to convert the errno from inside the applicance into a "
3113 "corresponding errno for the caller (not entirely trivial: the appliance "
3114 "might be running a completely different operating system from the library "
3115 "and error numbers are not standardized across Un*xen). If this could not be "
3116 "done, then the error is translated to C<EINVAL>. In practice this should "
3117 "only happen in very rare circumstances."
3122 #: ../src/guestfs.pod:1421
3123 msgid "guestfs_set_error_handler"
3128 #: ../src/guestfs.pod:1423
3131 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3133 " const char *msg);\n"
3134 " void guestfs_set_error_handler (guestfs_h *g,\n"
3135 " guestfs_error_handler_cb cb,\n"
3142 #: ../src/guestfs.pod:1430
3144 "The callback C<cb> will be called if there is an error. The parameters "
3145 "passed to the callback are an opaque data pointer and the error message "
3151 #: ../src/guestfs.pod:1434
3153 "C<errno> is not passed to the callback. To get that the callback must call "
3154 "L</guestfs_last_errno>."
3159 #: ../src/guestfs.pod:1437
3161 "Note that the message string C<msg> is freed as soon as the callback "
3162 "function returns, so if you want to stash it somewhere you must make your "
3168 #: ../src/guestfs.pod:1441
3169 msgid "The default handler prints messages on C<stderr>."
3174 #: ../src/guestfs.pod:1443
3175 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3180 #: ../src/guestfs.pod:1445
3181 msgid "guestfs_get_error_handler"
3186 #: ../src/guestfs.pod:1447
3189 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3190 " void **opaque_rtn);\n"
3196 #: ../src/guestfs.pod:1450
3197 msgid "Returns the current error handler callback."
3202 #: ../src/guestfs.pod:1452
3203 msgid "guestfs_set_out_of_memory_handler"
3208 #: ../src/guestfs.pod:1454
3211 " typedef void (*guestfs_abort_cb) (void);\n"
3212 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3213 " guestfs_abort_cb);\n"
3219 #: ../src/guestfs.pod:1458
3221 "The callback C<cb> will be called if there is an out of memory situation. "
3222 "I<Note this callback must not return>."
3227 #: ../src/guestfs.pod:1461
3228 msgid "The default is to call L<abort(3)>."
3233 #: ../src/guestfs.pod:1463
3235 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3240 #: ../src/guestfs.pod:1466
3241 msgid "guestfs_get_out_of_memory_handler"
3246 #: ../src/guestfs.pod:1468
3249 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3255 #: ../src/guestfs.pod:1470
3256 msgid "This returns the current out of memory handler."
3261 #: ../src/guestfs.pod:1472
3267 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
3273 #: ../src/guestfs.pod:1476
3279 #: ../src/guestfs.pod:1478
3285 #: ../src/guestfs.pod:1480
3286 msgid "AVAILABILITY"
3291 #: ../src/guestfs.pod:1482
3292 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3297 #: ../src/guestfs.pod:1484
3299 "Using L</guestfs_available> you can test availability of the following "
3300 "groups of functions. This test queries the appliance to see if the "
3301 "appliance you are currently using supports the functionality."
3306 #: ../src/guestfs.pod:1489
3307 msgid "@AVAILABILITY@"
3312 #: ../src/guestfs.pod:1491
3313 msgid "GUESTFISH supported COMMAND"
3318 #: ../src/guestfs.pod:1493
3320 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3321 "prints out the available groups and whether they are supported by this build "
3322 "of libguestfs. Note however that you have to do C<run> first."
3327 #: ../src/guestfs.pod:1498
3328 msgid "SINGLE CALLS AT COMPILE TIME"
3333 #: ../src/guestfs.pod:1500
3335 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3336 "function, such as:"
3341 #: ../src/guestfs.pod:1503
3344 " #define LIBGUESTFS_HAVE_DD 1\n"
3350 #: ../src/guestfs.pod:1505
3351 msgid "if L</guestfs_dd> is available."
3356 #: ../src/guestfs.pod:1507
3358 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3359 "function is available at compile time, we recommended using build tools such "
3360 "as autoconf or cmake. For example in autotools you could use:"
3365 #: ../src/guestfs.pod:1512
3368 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3369 " AC_CHECK_FUNCS([guestfs_dd])\n"
3375 #: ../src/guestfs.pod:1515
3377 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3383 #: ../src/guestfs.pod:1518
3384 msgid "SINGLE CALLS AT RUN TIME"
3389 #: ../src/guestfs.pod:1520
3391 "Testing at compile time doesn't guarantee that a function really exists in "
3392 "the library. The reason is that you might be dynamically linked against a "
3393 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3394 "This situation unfortunately results in a segmentation fault, which is a "
3395 "shortcoming of the C dynamic linking system itself."
3400 #: ../src/guestfs.pod:1527
3402 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3403 "in this example program (note that you still need the compile time check as "
3409 #: ../src/guestfs.pod:1531
3412 " #include <stdio.h>\n"
3413 " #include <stdlib.h>\n"
3414 " #include <unistd.h>\n"
3415 " #include <dlfcn.h>\n"
3416 " #include <guestfs.h>\n"
3422 #: ../src/guestfs.pod:1537
3427 " #ifdef LIBGUESTFS_HAVE_DD\n"
3429 " int has_function;\n"
3435 #: ../src/guestfs.pod:1543
3438 " /* Test if the function guestfs_dd is really available. */\n"
3439 " dl = dlopen (NULL, RTLD_LAZY);\n"
3441 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3442 " exit (EXIT_FAILURE);\n"
3444 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3451 #: ../src/guestfs.pod:1552
3454 " if (!has_function)\n"
3455 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3457 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3458 " /* Now it's safe to call\n"
3459 " guestfs_dd (g, \"foo\", \"bar\");\n"
3463 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3471 #: ../src/guestfs.pod:1565
3473 "You may think the above is an awful lot of hassle, and it is. There are "
3474 "other ways outside of the C linking system to ensure that this kind of "
3475 "incompatibility never arises, such as using package versioning:"
3480 #: ../src/guestfs.pod:1570
3483 " Requires: libguestfs >= 1.0.80\n"
3489 #: ../src/guestfs.pod:1572
3490 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3495 #: ../src/guestfs.pod:1574
3497 "A recent feature of the API is the introduction of calls which take optional "
3498 "arguments. In C these are declared 3 ways. The main way is as a call which "
3499 "takes variable arguments (ie. C<...>), as in this example:"
3504 #: ../src/guestfs.pod:1579
3507 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3513 #: ../src/guestfs.pod:1581
3515 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3516 "call with no optional arguments specified:"
3521 #: ../src/guestfs.pod:1584
3524 " guestfs_add_drive_opts (g, filename, -1);\n"
3530 #: ../src/guestfs.pod:1586
3531 msgid "With a single optional argument:"
3536 #: ../src/guestfs.pod:1588
3539 " guestfs_add_drive_opts (g, filename,\n"
3540 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3547 #: ../src/guestfs.pod:1592
3553 #: ../src/guestfs.pod:1594
3556 " guestfs_add_drive_opts (g, filename,\n"
3557 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3558 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3565 #: ../src/guestfs.pod:1599
3567 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3573 #: ../src/guestfs.pod:1602
3574 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3579 #: ../src/guestfs.pod:1604
3581 "The second variant has the same name with the suffix C<_va>, which works the "
3582 "same way but takes a C<va_list>. See the C manual for details. For the "
3583 "example function, this is declared:"
3588 #: ../src/guestfs.pod:1608
3591 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3598 #: ../src/guestfs.pod:1611
3599 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3604 #: ../src/guestfs.pod:1613
3606 "The third variant is useful where you need to construct these calls. You "
3607 "pass in a structure where you fill in the optional fields. The structure "
3608 "has a bitmask as the first element which you must set to indicate which "
3609 "fields you have filled in. For our example function the structure and call "
3615 #: ../src/guestfs.pod:1619
3618 " struct guestfs_add_drive_opts_argv {\n"
3619 " uint64_t bitmask;\n"
3621 " const char *format;\n"
3624 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3625 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3631 #: ../src/guestfs.pod:1628
3632 msgid "You could call it like this:"
3637 #: ../src/guestfs.pod:1630
3640 " struct guestfs_add_drive_opts_argv optargs = {\n"
3641 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3642 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3644 " .format = \"qcow2\"\n"
3651 #: ../src/guestfs.pod:1637
3654 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3660 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3661 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:9
3662 #: ../fish/guestfish-actions.pod:1265 ../tools/virt-win-reg.pl:532
3668 #: ../src/guestfs.pod:1645
3669 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3674 #: ../src/guestfs.pod:1650
3675 msgid "You do not need to fill in all fields of the structure."
3680 #: ../src/guestfs.pod:1654
3682 "There must be a one-to-one correspondence between fields of the structure "
3683 "that are filled in, and bits set in the bitmask."
3688 #: ../src/guestfs.pod:1659
3689 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3694 #: ../src/guestfs.pod:1661
3696 "In other languages, optional arguments are expressed in the way that is "
3697 "natural for that language. We refer you to the language-specific "
3698 "documentation for more details on that."
3703 #: ../src/guestfs.pod:1665
3704 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3709 #: ../src/guestfs.pod:1667
3710 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3714 #: ../src/guestfs.pod:1669
3716 "B<Note:> This section documents the generic event mechanism introduced in "
3717 "libguestfs 1.10, which you should use in new code if possible. The old "
3718 "functions C<guestfs_set_log_message_callback>, "
3719 "C<guestfs_set_subprocess_quit_callback>, "
3720 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3721 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3722 "page. Because of the ABI guarantee, the old functions continue to work."
3726 #: ../src/guestfs.pod:1678
3728 "Handles generate events when certain things happen, such as log messages "
3729 "being generated, progress messages during long-running operations, or the "
3730 "handle being closed. The API calls described below let you register a "
3731 "callback to be called when events happen. You can register multiple "
3732 "callbacks (for the same, different or overlapping sets of events), and "
3733 "individually remove callbacks. If callbacks are not removed, then they "
3734 "remain in force until the handle is closed."
3738 #: ../src/guestfs.pod:1686
3740 "In the current implementation, events are only generated synchronously: that "
3741 "means that events (and hence callbacks) can only happen while you are in the "
3742 "middle of making another libguestfs call. The callback is called in the "
3747 #: ../src/guestfs.pod:1691
3749 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3750 "unsigned integers, or a message buffer. Payloads are discussed later on."
3754 #: ../src/guestfs.pod:1695
3755 msgid "CLASSES OF EVENTS"
3759 #: ../src/guestfs.pod:1699
3760 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3764 #: ../src/guestfs.pod:1702
3766 "The callback function will be called while the handle is being closed "
3767 "(synchronously from L</guestfs_close>)."
3772 #: ../src/guestfs.pod:1705
3774 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3775 "handles that are open when the program exits. This means that this callback "
3776 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3777 "problems in higher-level languages (eg. if your HLL interpreter has already "
3778 "been cleaned up by the time this is called, and if your callback then jumps "
3779 "into some HLL function)."
3783 #: ../src/guestfs.pod:1712
3785 "If no callback is registered: the handle is closed without any callback "
3790 #: ../src/guestfs.pod:1715
3791 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3795 #: ../src/guestfs.pod:1718
3797 "The callback function will be called when the child process quits, either "
3798 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3799 "corresponds to a transition from any state to the CONFIG state)."
3803 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3804 msgid "If no callback is registered: the event is ignored."
3808 #: ../src/guestfs.pod:1724
3809 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3813 #: ../src/guestfs.pod:1727
3815 "The callback function will be called when the child process becomes ready "
3816 "first time after it has been launched. (This corresponds to a transition "
3817 "from LAUNCHING to the READY state)."
3821 #: ../src/guestfs.pod:1733
3822 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3827 #: ../src/guestfs.pod:1736
3829 "Some long-running operations can generate progress messages. If this "
3830 "callback is registered, then it will be called each time a progress message "
3831 "is generated (usually two seconds after the operation started, and three "
3832 "times per second thereafter until it completes, although the frequency may "
3833 "change in future versions)."
3837 #: ../src/guestfs.pod:1742
3839 "The callback receives in the payload four unsigned 64 bit numbers which are "
3840 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3844 #: ../src/guestfs.pod:1745
3846 "The units of C<total> are not defined, although for some operations C<total> "
3847 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3848 "or megabytes), and C<position> may be the portion which has been transferred."
3853 #: ../src/guestfs.pod:1750
3854 msgid "The only defined and stable parts of the API are:"
3859 #: ../src/guestfs.pod:1756
3861 "The callback can display to the user some type of progress bar or indicator "
3862 "which shows the ratio of C<position>:C<total>."
3867 #: ../src/guestfs.pod:1761
3868 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3872 #: ../src/guestfs.pod:1765
3874 "If any progress notification is sent during a call, then a final progress "
3875 "notification is always sent when C<position> = C<total> (I<unless> the call "
3876 "fails with an error)."
3881 #: ../src/guestfs.pod:1769
3883 "This is to simplify caller code, so callers can easily set the progress "
3884 "indicator to \"100%\" at the end of the operation, without requiring special "
3885 "code to detect this case."
3889 #: ../src/guestfs.pod:1775
3891 "For some calls we are unable to estimate the progress of the call, but we "
3892 "can still generate progress messages to indicate activity. This is known as "
3893 "\"pulse mode\", and is directly supported by certain progress bar "
3894 "implementations (eg. GtkProgressBar)."
3898 #: ../src/guestfs.pod:1780
3900 "For these calls, zero or more progress messages are generated with "
3901 "C<position = 0> and C<total = 1>, followed by a final message with "
3902 "C<position = total = 1>."
3906 #: ../src/guestfs.pod:1784
3908 "As noted above, if the call fails with an error then the final message may "
3913 #: ../src/guestfs.pod:1789
3915 "The callback also receives the procedure number (C<proc_nr>) and serial "
3916 "number (C<serial>) of the call. These are only useful for debugging "
3917 "protocol issues, and the callback can normally ignore them. The callback "
3918 "may want to print these numbers in error messages or debugging messages."
3922 #: ../src/guestfs.pod:1795
3923 msgid "If no callback is registered: progress messages are discarded."
3927 #: ../src/guestfs.pod:1797
3928 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3932 #: ../src/guestfs.pod:1800
3934 "The callback function is called whenever a log message is generated by qemu, "
3935 "the appliance kernel, guestfsd (daemon), or utility programs."
3939 #: ../src/guestfs.pod:1803
3941 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3942 "guestfs_launch>) then additional debug messages are generated."
3946 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3948 "If no callback is registered: the messages are discarded unless the verbose "
3949 "flag is set in which case they are sent to stderr. You can override the "
3950 "printing of verbose messages to stderr by setting up a callback."
3954 #: ../src/guestfs.pod:1811
3955 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3959 #: ../src/guestfs.pod:1814
3961 "The callback function is called whenever a log message is generated by the "
3962 "library part of libguestfs."
3966 #: ../src/guestfs.pod:1817
3968 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3969 "messages are generated."
3973 #: ../src/guestfs.pod:1825
3974 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3978 #: ../src/guestfs.pod:1828
3980 "The callback function is called whenever a trace message is generated. This "
3981 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3985 #: ../src/guestfs.pod:1831
3987 "If no callback is registered: the messages are sent to stderr. You can "
3988 "override the printing of trace messages to stderr by setting up a callback."
3992 #: ../src/guestfs.pod:1837
3993 msgid "guestfs_set_event_callback"
3997 #: ../src/guestfs.pod:1839
4000 " int guestfs_set_event_callback (guestfs_h *g,\n"
4001 " guestfs_event_callback cb,\n"
4002 " uint64_t event_bitmask,\n"
4009 #: ../src/guestfs.pod:1845
4011 "This function registers a callback (C<cb>) for all event classes in the "
4016 #: ../src/guestfs.pod:1848
4018 "For example, to register for all log message events, you could call this "
4019 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4020 "To register a single callback for all possible classes of events, use "
4021 "C<GUESTFS_EVENT_ALL>."
4025 #: ../src/guestfs.pod:1854
4026 msgid "C<flags> should always be passed as 0."
4030 #: ../src/guestfs.pod:1856
4032 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4033 "it for any purpose."
4037 #: ../src/guestfs.pod:1859
4039 "The return value is the event handle (an integer) which you can use to "
4040 "delete the callback (see below)."
4044 #: ../src/guestfs.pod:1862
4046 "If there is an error, this function returns C<-1>, and sets the error in the "
4047 "handle in the usual way (see L</guestfs_last_error> etc.)"
4051 #: ../src/guestfs.pod:1865
4053 "Callbacks remain in effect until they are deleted, or until the handle is "
4058 #: ../src/guestfs.pod:1868
4060 "In the case where multiple callbacks are registered for a particular event "
4061 "class, all of the callbacks are called. The order in which multiple "
4062 "callbacks are called is not defined."
4066 #: ../src/guestfs.pod:1872
4067 msgid "guestfs_delete_event_callback"
4071 #: ../src/guestfs.pod:1874
4074 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4079 #: ../src/guestfs.pod:1876
4081 "Delete a callback that was previously registered. C<event_handle> should be "
4082 "the integer that was returned by a previous call to "
4083 "C<guestfs_set_event_callback> on the same handle."
4087 #: ../src/guestfs.pod:1880
4088 msgid "guestfs_event_callback"
4092 #: ../src/guestfs.pod:1882
4095 " typedef void (*guestfs_event_callback) (\n"
4098 " uint64_t event,\n"
4099 " int event_handle,\n"
4101 " const char *buf, size_t buf_len,\n"
4102 " const uint64_t *array, size_t array_len);\n"
4107 #: ../src/guestfs.pod:1891
4109 "This is the type of the event callback function that you have to provide."
4113 #: ../src/guestfs.pod:1894
4115 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4116 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4117 "handle, and C<flags> which in the current API you should ignore."
4121 #: ../src/guestfs.pod:1898
4123 "The remaining parameters contain the event payload (if any). Each event may "
4124 "contain a payload, which usually relates to the event class, but for future "
4125 "proofing your code should be written to handle any payload for any event "
4130 #: ../src/guestfs.pod:1903
4132 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4133 "there is no message buffer). Note that this message buffer can contain "
4134 "arbitrary 8 bit data, including NUL bytes."
4138 #: ../src/guestfs.pod:1907
4140 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4141 "moment this is only used for progress messages."
4145 #: ../src/guestfs.pod:1910
4146 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4150 #: ../src/guestfs.pod:1912
4152 "One motivation for the generic event API was to allow GUI programs to "
4153 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4154 "unconditionally to C<stderr>."
4158 #: ../src/guestfs.pod:1916
4160 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4161 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4162 "messages are not events; you must capture error messages separately)."
4166 #: ../src/guestfs.pod:1921
4168 "Programs have to set up a callback to capture the classes of events of "
4173 #: ../src/guestfs.pod:1924
4177 " guestfs_set_event_callback\n"
4178 " (g, message_callback,\n"
4179 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4180 " GUESTFS_EVENT_TRACE,\n"
4181 " 0, NULL) == -1)\n"
4182 " if (eh == -1) {\n"
4183 " // handle error in the usual way\n"
4189 #: ../src/guestfs.pod:1934
4191 "The callback can then direct messages to the appropriate place. In this "
4192 "example, messages are directed to syslog:"
4196 #: ../src/guestfs.pod:1937
4200 " message_callback (\n"
4203 " uint64_t event,\n"
4204 " int event_handle,\n"
4206 " const char *buf, size_t buf_len,\n"
4207 " const uint64_t *array, size_t array_len)\n"
4209 " const int priority = LOG_USER|LOG_INFO;\n"
4210 " if (buf_len > 0)\n"
4211 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4218 #: ../src/guestfs.pod:1952
4219 msgid "PRIVATE DATA AREA"
4223 #: ../src/guestfs.pod:1954
4225 "You can attach named pieces of private data to the libguestfs handle, fetch "
4226 "them by name, and walk over them, for the lifetime of the handle. This is "
4227 "called the private data area and is only available from the C API."
4232 #: ../src/guestfs.pod:1959
4233 msgid "To attach a named piece of data, use the following call:"
4238 #: ../src/guestfs.pod:1961
4241 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4246 #: ../src/guestfs.pod:1963
4248 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4249 "pointer (which can be C<NULL>). Any previous item with the same key is "
4254 #: ../src/guestfs.pod:1967
4256 "You can use any C<key> you want, but your key should I<not> start with an "
4257 "underscore character. Keys beginning with an underscore character are "
4258 "reserved for internal libguestfs purposes (eg. for implementing language "
4259 "bindings). It is recommended that you prefix the key with some unique "
4260 "string to avoid collisions with other users."
4265 #: ../src/guestfs.pod:1973
4266 msgid "To retrieve the pointer, use:"
4271 #: ../src/guestfs.pod:1975
4274 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4280 #: ../src/guestfs.pod:1977
4282 "This function returns C<NULL> if either no data is found associated with "
4283 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4288 #: ../src/guestfs.pod:1981
4290 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4291 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4292 "all. In particular, libguestfs does I<not> try to free the data when the "
4293 "handle is closed. If the data must be freed, then the caller must either "
4294 "free it before calling L</guestfs_close> or must set up a close callback to "
4295 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4299 #: ../src/guestfs.pod:1988
4300 msgid "To walk over all entries, use these two functions:"
4304 #: ../src/guestfs.pod:1990
4307 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4312 #: ../src/guestfs.pod:1992
4315 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4320 #: ../src/guestfs.pod:1994
4322 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4323 "not have any particular meaning -- keys are not returned in any defined "
4324 "order). A pointer to the key is returned in C<*key_rtn> and the "
4325 "corresponding data pointer is returned from the function. C<NULL> is "
4326 "returned if there are no keys stored in the handle."
4330 #: ../src/guestfs.pod:2000
4332 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4333 "value of this function is also C<NULL> is there are no further entries to "
4338 #: ../src/guestfs.pod:2004
4339 msgid "Notes about walking over entries:"
4343 #: ../src/guestfs.pod:2010
4345 "You must not call C<guestfs_set_private> while walking over the entries."
4349 #: ../src/guestfs.pod:2015
4351 "The handle maintains an internal iterator which is reset when you call "
4352 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4353 "call C<guestfs_set_private>."
4357 #: ../src/guestfs.pod:2021
4358 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4362 #: ../src/guestfs.pod:2023
4365 " guestfs_set_private (g, key, NULL);\n"
4370 #: ../src/guestfs.pod:2025
4371 msgid "then that C<key> is not returned when walking."
4375 #: ../src/guestfs.pod:2029
4377 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4378 "C<guestfs_next_private> or C<guestfs_set_private>."
4382 #: ../src/guestfs.pod:2035
4384 "The following example code shows how to print all keys and data pointers "
4385 "that are associated with the handle C<g>:"
4389 #: ../src/guestfs.pod:2038
4392 " const char *key;\n"
4393 " void *data = guestfs_first_private (g, &key);\n"
4394 " while (data != NULL)\n"
4396 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4397 " data = guestfs_next_private (g, &key);\n"
4403 #: ../src/guestfs.pod:2046
4405 "More commonly you are only interested in keys that begin with an application-"
4406 "specific prefix C<foo_>. Modify the loop like so:"
4410 #: ../src/guestfs.pod:2049
4413 " const char *key;\n"
4414 " void *data = guestfs_first_private (g, &key);\n"
4415 " while (data != NULL)\n"
4417 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4418 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4419 " data = guestfs_next_private (g, &key);\n"
4425 #: ../src/guestfs.pod:2058
4427 "If you need to modify keys while walking, then you have to jump back to the "
4428 "beginning of the loop. For example, to delete all keys prefixed with "
4433 #: ../src/guestfs.pod:2062
4436 " const char *key;\n"
4439 " data = guestfs_first_private (g, &key);\n"
4440 " while (data != NULL)\n"
4442 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4444 " guestfs_set_private (g, key, NULL);\n"
4445 " /* note that 'key' pointer is now invalid, and so is\n"
4446 " the internal iterator */\n"
4449 " data = guestfs_next_private (g, &key);\n"
4455 #: ../src/guestfs.pod:2078
4457 "Note that the above loop is guaranteed to terminate because the keys are "
4458 "being deleted, but other manipulations of keys within the loop might not "
4459 "terminate unless you also maintain an indication of which keys have been "
4465 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4471 #: ../src/guestfs.pod:2085
4473 "<!-- old anchor for the next section --> <a name="
4474 "\"state_machine_and_low_level_event_api\"/>"
4479 #: ../src/guestfs.pod:2090
4480 msgid "ARCHITECTURE"
4485 #: ../src/guestfs.pod:2092
4487 "Internally, libguestfs is implemented by running an appliance (a special "
4488 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4489 "process of the main program."
4494 #: ../src/guestfs.pod:2096
4497 " ___________________\n"
4499 " | main program |\n"
4501 " | | child process / appliance\n"
4502 " | | __________________________\n"
4504 " +-------------------+ RPC | +-----------------+ |\n"
4505 " | libguestfs <--------------------> guestfsd | |\n"
4506 " | | | +-----------------+ |\n"
4507 " \\___________________/ | | Linux kernel | |\n"
4508 " | +--^--------------+ |\n"
4509 " \\_________|________________/\n"
4515 " \\______________/\n"
4521 #: ../src/guestfs.pod:2116
4523 "The library, linked to the main program, creates the child process and hence "
4524 "the appliance in the L</guestfs_launch> function."
4529 #: ../src/guestfs.pod:2119
4531 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4532 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4533 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4534 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4535 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4536 "attached to the qemu process which translates device access by the "
4537 "appliance's Linux kernel into accesses to the image."
4542 #: ../src/guestfs.pod:2128
4544 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4545 "Although the disk image you are attached to might also be used by some "
4546 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4547 "care if both libguestfs's qemu process and your virtual machine are trying "
4548 "to update the disk image at the same time, since these usually results in "
4549 "massive disk corruption)."
4554 #: ../src/guestfs.pod:2135
4555 msgid "STATE MACHINE"
4560 #: ../src/guestfs.pod:2137
4561 msgid "libguestfs uses a state machine to model the child process:"
4566 #: ../src/guestfs.pod:2139
4578 " / | \\ \\ guestfs_launch\n"
4579 " / | _\\__V______\n"
4581 " / | | LAUNCHING |\n"
4582 " / | \\___________/\n"
4584 " / | guestfs_launch\n"
4586 " ______ / __|____V\n"
4587 " / \\ ------> / \\\n"
4588 " | BUSY | | READY |\n"
4589 " \\______/ <------ \\________/\n"
4595 #: ../src/guestfs.pod:2161
4597 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4598 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4599 "(3) alternating between READY and BUSY as commands are issued to, and "
4600 "carried out by, the child process."
4605 #: ../src/guestfs.pod:2166
4607 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4608 "asynchronously at any time (eg. due to some internal error), and that causes "
4609 "the state to transition back to CONFIG."
4614 #: ../src/guestfs.pod:2170
4616 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4617 "issued when in the CONFIG state."
4622 #: ../src/guestfs.pod:2173
4624 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4625 "L</guestfs_launch> blocks until the child process is READY to accept "
4626 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4627 "moves the state from CONFIG to LAUNCHING while it is running."
4632 #: ../src/guestfs.pod:2179
4634 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4635 "state. These API calls block waiting for the command to be carried out (ie. "
4636 "the state to transition to BUSY and then back to READY). There are no non-"
4637 "blocking versions, and no way to issue more than one command per handle at "
4643 #: ../src/guestfs.pod:2185
4645 "Finally, the child process sends asynchronous messages back to the main "
4646 "program, such as kernel log messages. You can register a callback to "
4647 "receive these messages."
4652 #: ../src/guestfs.pod:2189
4658 #: ../src/guestfs.pod:2191
4659 msgid "COMMUNICATION PROTOCOL"
4664 #: ../src/guestfs.pod:2193
4666 "Don't rely on using this protocol directly. This section documents how it "
4667 "currently works, but it may change at any time."
4672 #: ../src/guestfs.pod:2196
4674 "The protocol used to talk between the library and the daemon running inside "
4675 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4676 "1014, RFC 1832, RFC 4506)."
4681 #: ../src/guestfs.pod:2200
4683 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4684 "this file is automatically generated)."
4689 #: ../src/guestfs.pod:2203
4691 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4692 "and C<FileOut> parameters, which are handled with very simple request/reply "
4693 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4694 "parameters, which use the same request and reply messages, but they may also "
4695 "be followed by files sent using a chunked encoding."
4700 #: ../src/guestfs.pod:2210
4701 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4706 #: ../src/guestfs.pod:2212
4707 msgid "For ordinary functions, the request message is:"
4712 #: ../src/guestfs.pod:2214
4715 " total length (header + arguments,\n"
4716 " but not including the length word itself)\n"
4717 " struct guestfs_message_header (encoded as XDR)\n"
4718 " struct guestfs_<foo>_args (encoded as XDR)\n"
4724 #: ../src/guestfs.pod:2219
4726 "The total length field allows the daemon to allocate a fixed size buffer "
4727 "into which it slurps the rest of the message. As a result, the total length "
4728 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4729 "effective size of any request is limited to somewhere under this size."
4734 #: ../src/guestfs.pod:2225
4736 "Note also that many functions don't take any arguments, in which case the "
4737 "C<guestfs_I<foo>_args> is completely omitted."
4742 #: ../src/guestfs.pod:2228
4744 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4745 "receiver knows what type of args structure to expect, or none at all."
4750 #: ../src/guestfs.pod:2232
4752 "For functions that take optional arguments, the optional arguments are "
4753 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4754 "arguments. A bitmask in the header indicates which optional arguments are "
4755 "meaningful. The bitmask is also checked to see if it contains bits set "
4756 "which the daemon does not know about (eg. if more optional arguments were "
4757 "added in a later version of the library), and this causes the call to be "
4763 #: ../src/guestfs.pod:2240
4764 msgid "The reply message for ordinary functions is:"
4769 #: ../src/guestfs.pod:2242
4772 " total length (header + ret,\n"
4773 " but not including the length word itself)\n"
4774 " struct guestfs_message_header (encoded as XDR)\n"
4775 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4781 #: ../src/guestfs.pod:2247
4783 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4784 "functions that return no formal return values."
4789 #: ../src/guestfs.pod:2250
4791 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4796 #: ../src/guestfs.pod:2253
4798 "In the case of an error, a flag is set in the header, and the reply message "
4799 "is slightly changed:"
4804 #: ../src/guestfs.pod:2256
4807 " total length (header + error,\n"
4808 " but not including the length word itself)\n"
4809 " struct guestfs_message_header (encoded as XDR)\n"
4810 " struct guestfs_message_error (encoded as XDR)\n"
4816 #: ../src/guestfs.pod:2261
4818 "The C<guestfs_message_error> structure contains the error message as a "
4824 #: ../src/guestfs.pod:2264
4825 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4830 #: ../src/guestfs.pod:2266
4832 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4833 "The normal request message is sent (see above). However this is followed by "
4834 "a sequence of file chunks."
4839 #: ../src/guestfs.pod:2270
4842 " total length (header + arguments,\n"
4843 " but not including the length word itself,\n"
4844 " and not including the chunks)\n"
4845 " struct guestfs_message_header (encoded as XDR)\n"
4846 " struct guestfs_<foo>_args (encoded as XDR)\n"
4847 " sequence of chunks for FileIn param #0\n"
4848 " sequence of chunks for FileIn param #1 etc.\n"
4854 #: ../src/guestfs.pod:2278
4855 msgid "The \"sequence of chunks\" is:"
4860 #: ../src/guestfs.pod:2280
4863 " length of chunk (not including length word itself)\n"
4864 " struct guestfs_chunk (encoded as XDR)\n"
4865 " length of chunk\n"
4866 " struct guestfs_chunk (encoded as XDR)\n"
4868 " length of chunk\n"
4869 " struct guestfs_chunk (with data.data_len == 0)\n"
4875 #: ../src/guestfs.pod:2288
4877 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4878 "is set in the final chunk to indicate either successful completion or early "
4884 #: ../src/guestfs.pod:2292
4886 "At time of writing there are no functions that have more than one FileIn "
4887 "parameter. However this is (theoretically) supported, by sending the "
4888 "sequence of chunks for each FileIn parameter one after another (from left to "
4894 #: ../src/guestfs.pod:2297
4896 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4897 "transfer. The library does this by sending a chunk with a special flag set "
4898 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4899 "RPC, does I<not> send any reply, and goes back to reading the next request."
4904 #: ../src/guestfs.pod:2303
4906 "The daemon may also cancel. It does this by writing a special word "
4907 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4908 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4909 "cancel chunk). The special word is chosen so that even if cancellation "
4910 "happens right at the end of the transfer (after the library has finished "
4911 "writing and has started listening for the reply), the \"spurious\" cancel "
4912 "flag will not be confused with the reply message."
4917 #: ../src/guestfs.pod:2312
4919 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4920 "limit), and also files where the size is not known in advance (eg. from "
4921 "pipes or sockets). However the chunks are rather small "
4922 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4923 "to keep much in memory."
4928 #: ../src/guestfs.pod:2318
4929 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4934 #: ../src/guestfs.pod:2320
4936 "The protocol for FileOut parameters is exactly the same as for FileIn "
4937 "parameters, but with the roles of daemon and library reversed."
4942 #: ../src/guestfs.pod:2323
4945 " total length (header + ret,\n"
4946 " but not including the length word itself,\n"
4947 " and not including the chunks)\n"
4948 " struct guestfs_message_header (encoded as XDR)\n"
4949 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4950 " sequence of chunks for FileOut param #0\n"
4951 " sequence of chunks for FileOut param #1 etc.\n"
4957 #: ../src/guestfs.pod:2331
4958 msgid "INITIAL MESSAGE"
4963 #: ../src/guestfs.pod:2333
4965 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4966 "which indicates that the guest and daemon is alive. This is what L</"
4967 "guestfs_launch> waits for."
4972 #: ../src/guestfs.pod:2337
4973 msgid "PROGRESS NOTIFICATION MESSAGES"
4978 #: ../src/guestfs.pod:2339
4980 "The daemon may send progress notification messages at any time. These are "
4981 "distinguished by the normal length word being replaced by "
4982 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4986 #: ../src/guestfs.pod:2343
4988 "The library turns them into progress callbacks (see L</"
4989 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4995 #: ../src/guestfs.pod:2347
4997 "The daemon self-limits the frequency of progress messages it sends (see "
4998 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5004 #: ../src/guestfs.pod:2351
5005 msgid "LIBGUESTFS VERSION NUMBERS"
5010 #: ../src/guestfs.pod:2353
5012 "Since April 2010, libguestfs has started to make separate development and "
5013 "stable releases, along with corresponding branches in our git repository. "
5014 "These separate releases can be identified by version number:"
5019 #: ../src/guestfs.pod:2358
5022 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5023 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5029 " | `-------- sub-version\n"
5031 " `------ always '1' because we don't change the ABI\n"
5037 #: ../src/guestfs.pod:2369
5038 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5043 #: ../src/guestfs.pod:2371
5045 "As time passes we cherry pick fixes from the development branch and backport "
5046 "those into the stable branch, the effect being that the stable branch should "
5047 "get more stable and less buggy over time. So the stable releases are ideal "
5048 "for people who don't need new features but would just like the software to "
5054 #: ../src/guestfs.pod:2377
5055 msgid "Our criteria for backporting changes are:"
5060 #: ../src/guestfs.pod:2383
5062 "Documentation changes which don't affect any code are backported unless the "
5063 "documentation refers to a future feature which is not in stable."
5068 #: ../src/guestfs.pod:2389
5070 "Bug fixes which are not controversial, fix obvious problems, and have been "
5071 "well tested are backported."
5076 #: ../src/guestfs.pod:2394
5078 "Simple rearrangements of code which shouldn't affect how it works get "
5079 "backported. This is so that the code in the two branches doesn't get too "
5080 "far out of step, allowing us to backport future fixes more easily."
5085 #: ../src/guestfs.pod:2400
5087 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5088 "exceptional case: the new feature is required in order to implement an "
5089 "important bug fix."
5094 #: ../src/guestfs.pod:2406
5096 "A new stable branch starts when we think the new features in development are "
5097 "substantial and compelling enough over the current stable branch to warrant "
5098 "it. When that happens we create new stable and development versions 1.N.0 "
5099 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5100 "stable at this point, but by backporting fixes from development, that branch "
5101 "will stabilize over time."
5105 #: ../src/guestfs.pod:2414
5106 msgid "EXTENDING LIBGUESTFS"
5110 #: ../src/guestfs.pod:2416
5111 msgid "ADDING A NEW API ACTION"
5115 #: ../src/guestfs.pod:2418
5117 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5118 "documentation) are generated, and this makes it easy to extend the "
5123 #: ../src/guestfs.pod:2422
5124 msgid "To add a new API action there are two changes:"
5128 #: ../src/guestfs.pod:2428
5130 "You need to add a description of the call (name, parameters, return type, "
5131 "tests, documentation) to C<generator/generator_actions.ml>."
5135 #: ../src/guestfs.pod:2431
5137 "There are two sorts of API action, depending on whether the call goes "
5138 "through to the daemon in the appliance, or is serviced entirely by the "
5139 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5140 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5141 "an example of the latter, since a trace flag is maintained in the handle and "
5142 "all tracing is done on the library side."
5146 #: ../src/guestfs.pod:2439
5148 "Most new actions are of the first type, and get added to the "
5149 "C<daemon_functions> list. Each function has a unique procedure number used "
5150 "in the RPC protocol which is assigned to that action when we publish "
5151 "libguestfs and cannot be reused. Take the latest procedure number and "
5156 #: ../src/guestfs.pod:2445
5158 "For library-only actions of the second type, add to the "
5159 "C<non_daemon_functions> list. Since these functions are serviced by the "
5160 "library and do not travel over the RPC mechanism to the daemon, these "
5161 "functions do not need a procedure number, and so the procedure number is set "
5166 #: ../src/guestfs.pod:2453
5167 msgid "Implement the action (in C):"
5171 #: ../src/guestfs.pod:2455
5173 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5174 "C<daemon/> directory."
5178 #: ../src/guestfs.pod:2458
5180 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5181 "(note: double underscore) in the C<src/> directory."
5185 #: ../src/guestfs.pod:2461
5186 msgid "In either case, use another function as an example of what to do."
5190 #: ../src/guestfs.pod:2465
5191 msgid "After making these changes, use C<make> to compile."
5195 #: ../src/guestfs.pod:2467
5197 "Note that you don't need to implement the RPC, language bindings, manual "
5198 "pages or anything else. It's all automatically generated from the OCaml "
5203 #: ../src/guestfs.pod:2471
5204 msgid "ADDING TESTS FOR AN API ACTION"
5208 #: ../src/guestfs.pod:2473
5210 "You can supply zero or as many tests as you want per API call. The tests "
5211 "can either be added as part of the API description (C<generator/"
5212 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5213 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5214 "slower, so if possible use the first method."
5218 #: ../src/guestfs.pod:2479
5220 "The following describes the test environment used when you add an API test "
5221 "in C<generator_actions.ml>."
5225 #: ../src/guestfs.pod:2482
5226 msgid "The test environment has 4 block devices:"
5230 #: ../src/guestfs.pod:2486
5231 msgid "C</dev/sda> 500MB"
5235 #: ../src/guestfs.pod:2488
5236 msgid "General block device for testing."
5240 #: ../src/guestfs.pod:2490
5241 msgid "C</dev/sdb> 50MB"
5245 #: ../src/guestfs.pod:2492
5247 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5252 #: ../src/guestfs.pod:2495
5253 msgid "C</dev/sdc> 10MB"
5257 #: ../src/guestfs.pod:2497
5258 msgid "Used in a few tests where two block devices are needed."
5262 #: ../src/guestfs.pod:2499
5267 #: ../src/guestfs.pod:2501
5268 msgid "ISO with fixed content (see C<images/test.iso>)."
5272 #: ../src/guestfs.pod:2505
5274 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5275 "appliance and block devices are reused between tests. So don't try testing "
5276 "L</guestfs_kill_subprocess> :-x"
5280 #: ../src/guestfs.pod:2509
5282 "Each test starts with an initial scenario, selected using one of the "
5283 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5284 "initialize the disks mentioned above in a particular way as documented in "
5285 "C<generator_types.ml>. You should not assume anything about the previous "
5286 "contents of other disks that are not initialized."
5290 #: ../src/guestfs.pod:2515
5292 "You can add a prerequisite clause to any individual test. This is a run-"
5293 "time check, which, if it fails, causes the test to be skipped. Useful if "
5294 "testing a command which might not work on all variations of libguestfs "
5295 "builds. A test that has prerequisite of C<Always> means to run "
5300 #: ../src/guestfs.pod:2521
5302 "In addition, packagers can skip individual tests by setting environment "
5303 "variables before running C<make check>."
5307 #: ../src/guestfs.pod:2524
5310 " SKIP_TEST_<CMD>_<NUM>=1\n"
5315 #: ../src/guestfs.pod:2526
5316 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5320 #: ../src/guestfs.pod:2528
5325 #: ../src/guestfs.pod:2530
5328 " SKIP_TEST_<CMD>=1\n"
5333 #: ../src/guestfs.pod:2532
5334 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5338 #: ../src/guestfs.pod:2534
5339 msgid "Packagers can run only certain tests by setting for example:"
5343 #: ../src/guestfs.pod:2536
5346 " TEST_ONLY=\"vfs_type zerofree\"\n"
5351 #: ../src/guestfs.pod:2538
5353 "See C<capitests/tests.c> for more details of how these environment variables "
5358 #: ../src/guestfs.pod:2541
5359 msgid "DEBUGGING NEW API ACTIONS"
5363 #: ../src/guestfs.pod:2543
5364 msgid "Test new actions work before submitting them."
5368 #: ../src/guestfs.pod:2545
5369 msgid "You can use guestfish to try out new commands."
5373 #: ../src/guestfs.pod:2547
5375 "Debugging the daemon is a problem because it runs inside a minimal "
5376 "environment. However you can fprintf messages in the daemon to stderr, and "
5377 "they will show up if you use C<guestfish -v>."
5381 #: ../src/guestfs.pod:2551
5382 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5386 #: ../src/guestfs.pod:2553
5388 "Our C source code generally adheres to some basic code-formatting "
5389 "conventions. The existing code base is not totally consistent on this "
5390 "front, but we do prefer that contributed code be formatted similarly. In "
5391 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5392 "indentation level, and other than that, follow the K&R style."
5396 #: ../src/guestfs.pod:2559
5398 "If you use Emacs, add the following to one of one of your start-up files (e."
5399 "g., ~/.emacs), to help ensure that you get indentation right:"
5403 #: ../src/guestfs.pod:2562
5406 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5407 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5408 " (add-hook 'find-file-hook\n"
5409 " '(lambda () (if (and buffer-file-name\n"
5410 " (string-match \"/libguestfs\\\\>\"\n"
5411 " (buffer-file-name))\n"
5412 " (not (string-equal mode-name \"Change Log\"))\n"
5413 " (not (string-equal mode-name \"Makefile\")))\n"
5414 " (setq indent-tabs-mode nil))))\n"
5419 #: ../src/guestfs.pod:2572
5422 " ;;; When editing C sources in libguestfs, use this style.\n"
5423 " (defun libguestfs-c-mode ()\n"
5424 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5426 " (c-set-style \"K&R\")\n"
5427 " (setq c-indent-level 2)\n"
5428 " (setq c-basic-offset 2))\n"
5429 " (add-hook 'c-mode-hook\n"
5430 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5431 " (buffer-file-name))\n"
5432 " (libguestfs-c-mode))))\n"
5437 #: ../src/guestfs.pod:2584
5438 msgid "Enable warnings when compiling (and fix any problems this finds):"
5442 #: ../src/guestfs.pod:2587
5445 " ./configure --enable-gcc-warnings\n"
5450 #: ../src/guestfs.pod:2589
5451 msgid "Useful targets are:"
5455 #: ../src/guestfs.pod:2591
5458 " make syntax-check # checks the syntax of the C code\n"
5459 " make check # runs the test suite\n"
5464 #: ../src/guestfs.pod:2594
5465 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5469 #: ../src/guestfs.pod:2596
5471 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5472 "which are used to do shell quoting."
5476 #: ../src/guestfs.pod:2601
5481 #: ../src/guestfs.pod:2603
5483 "Simple shell quoted string. Any spaces or other shell characters are "
5488 #: ../src/guestfs.pod:2606
5493 #: ../src/guestfs.pod:2608
5495 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5501 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5502 msgid "For example:"
5506 #: ../src/guestfs.pod:2615
5509 " asprintf (&cmd, \"cat %R\", path);\n"
5514 #: ../src/guestfs.pod:2617
5515 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5519 #: ../src/guestfs.pod:2619
5521 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5522 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5523 "they are not passed via the shell (instead, straight to exec). You probably "
5524 "want to use the C<sysroot_path()> function however."
5528 #: ../src/guestfs.pod:2625
5529 msgid "SUBMITTING YOUR NEW API ACTIONS"
5533 #: ../src/guestfs.pod:2627
5535 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5536 "libguestfs> and CC to L<rjones@redhat.com>."
5540 #: ../src/guestfs.pod:2631
5541 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5545 #: ../src/guestfs.pod:2633
5546 msgid "We support i18n (gettext anyhow) in the library."
5550 #: ../src/guestfs.pod:2635
5552 "However many messages come from the daemon, and we don't translate those at "
5553 "the moment. One reason is that the appliance generally has all locale files "
5554 "removed from it, because they take up a lot of space. So we'd have to readd "
5555 "some of those, as well as copying our PO files into the appliance."
5559 #: ../src/guestfs.pod:2641
5561 "Debugging messages are never translated, since they are intended for the "
5566 #: ../src/guestfs.pod:2644
5567 msgid "SOURCE CODE SUBDIRECTORIES"
5571 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5820
5572 #: ../fish/guestfish-actions.pod:3913
5573 msgid "C<appliance>"
5577 #: ../src/guestfs.pod:2650
5578 msgid "The libguestfs appliance, build scripts and so on."
5582 #: ../src/guestfs.pod:2652
5583 msgid "C<capitests>"
5587 #: ../src/guestfs.pod:2654
5588 msgid "Automated tests of the C API."
5592 #: ../src/guestfs.pod:2656
5597 #: ../src/guestfs.pod:2658
5599 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5604 #: ../src/guestfs.pod:2661
5609 #: ../src/guestfs.pod:2663
5610 msgid "Outside contributions, experimental parts."
5614 #: ../src/guestfs.pod:2665
5619 #: ../src/guestfs.pod:2667
5621 "The daemon that runs inside the libguestfs appliance and carries out actions."
5625 #: ../src/guestfs.pod:2670
5630 #: ../src/guestfs.pod:2672
5631 msgid "L<virt-df(1)> command and documentation."
5635 #: ../src/guestfs.pod:2674
5640 #: ../src/guestfs.pod:2676
5641 msgid "C API example code."
5645 #: ../src/guestfs.pod:2678
5650 #: ../src/guestfs.pod:2680
5652 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5653 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5654 "L<virt-tar-out(1)>."
5658 #: ../src/guestfs.pod:2684
5663 #: ../src/guestfs.pod:2686
5665 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5669 #: ../src/guestfs.pod:2688
5670 msgid "C<generator>"
5674 #: ../src/guestfs.pod:2690
5676 "The crucially important generator, used to automatically generate large "
5677 "amounts of boilerplate C code for things like RPC and bindings."
5681 #: ../src/guestfs.pod:2693
5686 #: ../src/guestfs.pod:2695
5687 msgid "Files used by the test suite."
5691 #: ../src/guestfs.pod:2697
5692 msgid "Some \"phony\" guest images which we test against."
5696 #: ../src/guestfs.pod:2699
5697 msgid "C<inspector>"
5701 #: ../src/guestfs.pod:2701
5702 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5706 #: ../src/guestfs.pod:2703
5711 #: ../src/guestfs.pod:2705
5712 msgid "Logo used on the website. The fish is called Arthur by the way."
5716 #: ../src/guestfs.pod:2707
5721 #: ../src/guestfs.pod:2709
5722 msgid "M4 macros used by autoconf."
5726 #: ../src/guestfs.pod:2711
5731 #: ../src/guestfs.pod:2713
5732 msgid "Translations of simple gettext strings."
5736 #: ../src/guestfs.pod:2715
5741 #: ../src/guestfs.pod:2717
5743 "The build infrastructure and PO files for translations of manpages and POD "
5744 "files. Eventually this will be combined with the C<po> directory, but that "
5745 "is rather complicated."
5749 #: ../src/guestfs.pod:2721
5750 msgid "C<regressions>"
5754 #: ../src/guestfs.pod:2723
5755 msgid "Regression tests."
5759 #: ../src/guestfs.pod:2725
5764 #: ../src/guestfs.pod:2727
5765 msgid "L<virt-rescue(1)> command and documentation."
5769 #: ../src/guestfs.pod:2729
5774 #: ../src/guestfs.pod:2731
5775 msgid "Source code to the C library."
5779 #: ../src/guestfs.pod:2733
5784 #: ../src/guestfs.pod:2735
5785 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5789 #: ../src/guestfs.pod:2737
5790 msgid "C<test-tool>"
5794 #: ../src/guestfs.pod:2739
5796 "Test tool for end users to test if their qemu/kernel combination will work "
5801 #: ../src/guestfs.pod:2742
5806 #: ../src/guestfs.pod:2744
5811 #: ../src/guestfs.pod:2746
5816 #: ../src/guestfs.pod:2748
5821 #: ../src/guestfs.pod:2750
5826 #: ../src/guestfs.pod:2752
5831 #: ../src/guestfs.pod:2754
5836 #: ../src/guestfs.pod:2756
5841 #: ../src/guestfs.pod:2758
5842 msgid "Language bindings."
5846 #: ../src/guestfs.pod:2762
5852 #: ../src/guestfs.pod:2764
5853 msgid "PROTOCOL LIMITS"
5858 #: ../src/guestfs.pod:2766
5860 "Internally libguestfs uses a message-based protocol to pass API calls and "
5861 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5862 "plenty more detail about this). The maximum message size used by the "
5863 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5864 "aware of this limit. The API calls which may be affected are individually "
5865 "documented, with a link back to this section of the documentation."
5870 #: ../src/guestfs.pod:2774
5872 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5873 "a simple string. Because this string is at some point internally encoded as "
5874 "a message, the maximum size that it can return is slightly under 4 MB. If "
5875 "the requested file is larger than this then you will get an error."
5880 #: ../src/guestfs.pod:2780
5882 "In order to transfer large files into and out of the guest filesystem, you "
5883 "need to use particular calls that support this. The sections L</UPLOADING> "
5884 "and L</DOWNLOADING> document how to do this."
5889 #: ../src/guestfs.pod:2784
5891 "You might also consider mounting the disk image using our FUSE filesystem "
5892 "support (L<guestmount(1)>)."
5896 #: ../src/guestfs.pod:2787
5897 msgid "MAXIMUM NUMBER OF DISKS"
5901 #: ../src/guestfs.pod:2789
5902 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5906 #: ../src/guestfs.pod:2792
5908 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5909 "slots. However febootstrap only understands disks with names C</dev/vda> "
5910 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5915 #: ../src/guestfs.pod:2797
5917 "We are working to substantially raise this limit in future versions but it "
5918 "requires complex changes to qemu."
5922 #: ../src/guestfs.pod:2800
5924 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5925 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5926 "requires changes to qemu."
5930 #: ../src/guestfs.pod:2804
5931 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5935 #: ../src/guestfs.pod:2806
5936 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5940 #: ../src/guestfs.pod:2808
5942 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5943 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5947 #: ../src/guestfs.pod:2811
5949 "If you attach a disk with more than 15 partitions, the extra partitions are "
5950 "ignored by libguestfs."
5954 #: ../src/guestfs.pod:2814
5955 msgid "MAXIMUM SIZE OF A DISK"
5959 #: ../src/guestfs.pod:2816
5960 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5964 #: ../src/guestfs.pod:2818
5966 "We have tested block devices up to 1 exabyte (2**60 or "
5967 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5972 #: ../src/guestfs.pod:2822
5974 "Although libguestfs probably does not impose any limit, the underlying host "
5975 "storage will. If you store disk images on a host ext4 filesystem, then the "
5976 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5977 "TB). If you store disk images as host logical volumes then you are limited "
5978 "by the maximum size of an LV."
5982 #: ../src/guestfs.pod:2828
5984 "For the hugest disk image files, we recommend using XFS on the host for "
5989 #: ../src/guestfs.pod:2831
5990 msgid "MAXIMUM SIZE OF A PARTITION"
5994 #: ../src/guestfs.pod:2833
5996 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5997 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5998 "address a partition located beyond 2 TB on the disk."
6002 #: ../src/guestfs.pod:2837
6004 "It is recommended that you use GPT partitions on disks which are larger than "
6005 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6006 "which are theoretically larger than the largest disk we could support."
6010 #: ../src/guestfs.pod:2842
6011 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6015 #: ../src/guestfs.pod:2844
6017 "This depends on the filesystem type. libguestfs itself does not impose any "
6018 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6019 "what these limits are."
6023 #: ../src/guestfs.pod:2848
6024 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6028 #: ../src/guestfs.pod:2850
6030 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6031 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6032 "uploads and downloads."
6036 #: ../src/guestfs.pod:2854
6037 msgid "INSPECTION LIMITS"
6041 #: ../src/guestfs.pod:2856
6043 "The inspection code has several arbitrary limits on things like the size of "
6044 "Windows Registry hive it will read, and the length of product name. These "
6045 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6046 "memory and disk space on the host, and should not be reached in practice. "
6047 "See the source code for more information."
6052 #: ../src/guestfs.pod:2862 ../fish/guestfish.pod:1017
6053 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
6054 msgid "ENVIRONMENT VARIABLES"
6059 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1043
6060 msgid "LIBGUESTFS_APPEND"
6065 #: ../src/guestfs.pod:2868 ../fish/guestfish.pod:1045
6066 msgid "Pass additional options to the guest kernel."
6071 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1047
6072 msgid "LIBGUESTFS_DEBUG"
6077 #: ../src/guestfs.pod:2872
6079 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6080 "effect as calling C<guestfs_set_verbose (g, 1)>."
6085 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1052
6086 msgid "LIBGUESTFS_MEMSIZE"
6091 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1054
6093 "Set the memory allocated to the qemu process, in megabytes. For example:"
6098 #: ../src/guestfs.pod:2880 ../fish/guestfish.pod:1057
6101 " LIBGUESTFS_MEMSIZE=700\n"
6107 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1059
6108 msgid "LIBGUESTFS_PATH"
6112 #: ../src/guestfs.pod:2884
6114 "Set the path that libguestfs uses to search for a supermin appliance. See "
6115 "the discussion of paths in section L</PATH> above."
6120 #: ../src/guestfs.pod:2887 ../fish/guestfish.pod:1064
6121 msgid "LIBGUESTFS_QEMU"
6126 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1066
6128 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6129 "which was found at compile time by the configure script is used."
6134 #: ../src/guestfs.pod:2893
6135 msgid "See also L</QEMU WRAPPERS> above."
6140 #: ../src/guestfs.pod:2895 ../fish/guestfish.pod:1070
6141 msgid "LIBGUESTFS_TRACE"
6146 #: ../src/guestfs.pod:2897
6148 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6149 "effect as calling C<guestfs_set_trace (g, 1)>."
6154 #: ../src/guestfs.pod:2900 ../fish/guestfish.pod:1079
6159 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1081
6161 "Location of temporary directory, defaults to C</tmp> except for the cached "
6162 "supermin appliance which defaults to C</var/tmp>."
6166 #: ../src/guestfs.pod:2905 ../fish/guestfish.pod:1084
6168 "If libguestfs was compiled to use the supermin appliance then the real "
6169 "appliance is cached in this directory, shared between all handles belonging "
6170 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6171 "use in case C</var/tmp> is not large enough."
6176 #: ../src/guestfs.pod:2913 ../fish/guestfish.pod:1151
6177 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:269
6178 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6179 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6180 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6185 #: ../src/guestfs.pod:2915
6187 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6188 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6189 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6190 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6191 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6192 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6193 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6198 #: ../src/guestfs.pod:2942
6200 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6201 "(8)>, L<disktype(1)>."
6206 #: ../src/guestfs.pod:2949 ../tools/virt-win-reg.pl:587
6207 #: ../tools/virt-make-fs.pl:553
6213 #: ../src/guestfs.pod:2951
6214 msgid "To get a list of bugs against libguestfs use this link:"
6219 #: ../src/guestfs.pod:2953
6221 "L<https://bugzilla.redhat.com/buglist.cgi?"
6222 "component=libguestfs&product=Virtualization+Tools>"
6227 #: ../src/guestfs.pod:2955
6228 msgid "To report a new bug against libguestfs use this link:"
6233 #: ../src/guestfs.pod:2957
6235 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6236 "component=libguestfs&product=Virtualization+Tools>"
6241 #: ../src/guestfs.pod:2959
6242 msgid "When reporting a bug, please check:"
6247 #: ../src/guestfs.pod:2965
6248 msgid "That the bug hasn't been reported already."
6253 #: ../src/guestfs.pod:2969
6254 msgid "That you are testing a recent version."
6259 #: ../src/guestfs.pod:2973
6260 msgid "Describe the bug accurately, and give a way to reproduce it."
6265 #: ../src/guestfs.pod:2977
6267 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6273 #: ../src/guestfs.pod:2982 ../fish/guestfish.pod:1174
6274 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:280
6280 #: ../src/guestfs.pod:2984 ../fish/guestfish.pod:1176
6281 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:282
6282 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6287 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1178
6288 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:284
6289 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6290 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6291 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6296 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1180
6297 #: ../test-tool/libguestfs-test-tool.pod:99
6298 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6303 #: ../src/guestfs.pod:2991
6305 "This library is free software; you can redistribute it and/or modify it "
6306 "under the terms of the GNU Lesser General Public License as published by the "
6307 "Free Software Foundation; either version 2 of the License, or (at your "
6308 "option) any later version."
6313 #: ../src/guestfs.pod:2996
6315 "This library is distributed in the hope that it will be useful, but WITHOUT "
6316 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6317 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6323 #: ../src/guestfs.pod:3001
6325 "You should have received a copy of the GNU Lesser General Public License "
6326 "along with this library; if not, write to the Free Software Foundation, "
6327 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6332 #: ../src/guestfs-actions.pod:1
6333 msgid "guestfs_add_cdrom"
6338 #: ../src/guestfs-actions.pod:3
6342 " guestfs_add_cdrom (guestfs_h *g,\n"
6343 " const char *filename);\n"
6349 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6350 msgid "This function adds a virtual CD-ROM disk image to the guest."
6354 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6355 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6360 #: ../src/guestfs-actions.pod:17
6362 "This call checks for the existence of C<filename>. This stops you from "
6363 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6364 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6370 #: ../src/guestfs-actions.pod:24
6372 "If you just want to add an ISO file (often you use this as an efficient way "
6373 "to transfer large files into the guest), then you should probably use "
6374 "C<guestfs_add_drive_ro> instead."
6379 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6380 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6381 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6382 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6383 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6384 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6385 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6386 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6387 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6388 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6389 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6390 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
6391 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
6392 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
6393 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
6394 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
6395 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
6396 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
6397 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1723
6398 #: ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:2272
6399 #: ../src/guestfs-actions.pod:2416 ../src/guestfs-actions.pod:2477
6400 #: ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:3465
6401 #: ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3505
6402 #: ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3674
6403 #: ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701
6404 #: ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3752
6405 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3844
6406 #: ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884
6407 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3939
6408 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977
6409 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4024
6410 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4076
6411 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
6412 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4214
6413 #: ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4247
6414 #: ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4316
6415 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4350
6416 #: ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4378
6417 #: ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4410
6418 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4488
6419 #: ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4592
6420 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4630
6421 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4659
6422 #: ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4687
6423 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4737
6424 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4772
6425 #: ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4803
6426 #: ../src/guestfs-actions.pod:4852 ../src/guestfs-actions.pod:4889
6427 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4931
6428 #: ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:4966
6429 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5157
6430 #: ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:5197
6431 #: ../src/guestfs-actions.pod:5229 ../src/guestfs-actions.pod:5295
6432 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5325
6433 #: ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5628
6434 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5666
6435 #: ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5690
6436 #: ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5716
6437 #: ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:5746
6438 #: ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5786
6439 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5835
6440 #: ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5874
6441 #: ../src/guestfs-actions.pod:5892 ../src/guestfs-actions.pod:5911
6442 #: ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5951
6443 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:5996
6444 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6039
6445 #: ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6082
6446 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6116
6447 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6176
6448 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6310
6449 #: ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6443
6450 #: ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6469
6451 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
6452 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6530
6453 #: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6604
6454 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:6637
6455 #: ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:6670
6456 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6703
6457 #: ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6753
6458 #: ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6807
6459 #: ../src/guestfs-actions.pod:6825 ../src/guestfs-actions.pod:6859
6460 #: ../src/guestfs-actions.pod:6895 ../src/guestfs-actions.pod:7014
6461 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7046
6462 #: ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7114
6463 #: ../src/guestfs-actions.pod:7159 ../src/guestfs-actions.pod:7192
6464 #: ../src/guestfs-actions.pod:7246 ../src/guestfs-actions.pod:7272
6465 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357
6466 #: ../src/guestfs-actions.pod:7386
6467 msgid "This function returns 0 on success or -1 on error."
6472 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6473 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6474 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6476 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6482 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6483 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6484 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
6485 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:7280
6486 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:31
6487 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6488 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1324
6489 #: ../fish/guestfish-actions.pod:1338 ../fish/guestfish-actions.pod:3013
6490 #: ../fish/guestfish-actions.pod:4871 ../fish/guestfish-actions.pod:4968
6492 "Deprecated functions will not be removed from the API, but the fact that "
6493 "they are deprecated indicates that there are problems with correct use of "
6499 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6500 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1922
6501 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:2123
6502 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3487
6503 #: ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:5853
6504 #: ../src/guestfs-actions.pod:5970 ../src/guestfs-actions.pod:6084
6505 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6672
6506 #: ../src/guestfs-actions.pod:7194
6507 msgid "(Added in 0.3)"
6512 #: ../src/guestfs-actions.pod:41
6513 msgid "guestfs_add_domain"
6518 #: ../src/guestfs-actions.pod:43
6522 " guestfs_add_domain (guestfs_h *g,\n"
6523 " const char *dom,\n"
6530 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6531 #: ../src/guestfs-actions.pod:4449
6533 "You may supply a list of optional arguments to this call. Use zero or more "
6534 "of the following pairs of parameters, and terminate the list with C<-1> on "
6535 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6539 #: ../src/guestfs-actions.pod:53
6542 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6543 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6544 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6545 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6546 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6552 #: ../src/guestfs-actions.pod:59
6554 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6555 "It works by connecting to libvirt, requesting the domain and domain XML from "
6556 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6562 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6564 "The number of disks added is returned. This operation is atomic: if an "
6565 "error is returned, then no disks are added."
6570 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6572 "This function does some minimal checks to make sure the libvirt domain is "
6573 "not running (unless C<readonly> is true). In a future version we will try "
6574 "to acquire the libvirt lock on each disk."
6579 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6581 "Disks must be accessible locally. This often means that adding disks from a "
6582 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6583 "unless those disks are accessible via the same device path locally too."
6587 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6589 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6590 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6591 "libvirt URI (or one set through an environment variable, see the libvirt "
6592 "documentation for full details)."
6596 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6598 "The optional C<live> flag controls whether this call will try to connect to "
6599 "a running virtual machine C<guestfsd> process if it sees a suitable "
6600 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6601 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6602 "DAEMONS> for more information."
6606 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6608 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6609 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6610 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6616 #: ../src/guestfs-actions.pod:94
6618 "The other optional parameters are passed directly through to "
6619 "C<guestfs_add_drive_opts>."
6624 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6625 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6626 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6627 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6628 #: ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1883
6629 #: ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2032
6630 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
6631 #: ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:2786
6632 #: ../src/guestfs-actions.pod:2807 ../src/guestfs-actions.pod:4875
6633 #: ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5409
6634 #: ../src/guestfs-actions.pod:5435 ../src/guestfs-actions.pod:6780
6635 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
6636 #: ../src/guestfs-actions.pod:7231
6637 msgid "On error this function returns -1."
6642 #: ../src/guestfs-actions.pod:99
6643 msgid "(Added in 1.7.4)"
6648 #: ../src/guestfs-actions.pod:101
6649 msgid "guestfs_add_domain_va"
6654 #: ../src/guestfs-actions.pod:103
6658 " guestfs_add_domain_va (guestfs_h *g,\n"
6659 " const char *dom,\n"
6666 #: ../src/guestfs-actions.pod:108
6667 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6672 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6673 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6674 #: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4514
6675 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6680 #: ../src/guestfs-actions.pod:112
6681 msgid "guestfs_add_domain_argv"
6686 #: ../src/guestfs-actions.pod:114
6690 " guestfs_add_domain_argv (guestfs_h *g,\n"
6691 " const char *dom,\n"
6692 " const struct guestfs_add_domain_argv *optargs);\n"
6698 #: ../src/guestfs-actions.pod:119
6699 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6704 #: ../src/guestfs-actions.pod:123
6705 msgid "guestfs_add_drive"
6710 #: ../src/guestfs-actions.pod:125
6714 " guestfs_add_drive (guestfs_h *g,\n"
6715 " const char *filename);\n"
6721 #: ../src/guestfs-actions.pod:129
6723 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6724 "optional parameters, so the disk is added writable, with the format being "
6725 "detected automatically."
6730 #: ../src/guestfs-actions.pod:133
6732 "Automatic detection of the format opens you up to a potential security hole "
6733 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6734 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6735 "you should think about replacing calls to this function with calls to "
6736 "C<guestfs_add_drive_opts>, and specifying the format."
6741 #: ../src/guestfs-actions.pod:144
6742 msgid "guestfs_add_drive_opts"
6747 #: ../src/guestfs-actions.pod:146
6751 " guestfs_add_drive_opts (guestfs_h *g,\n"
6752 " const char *filename,\n"
6759 #: ../src/guestfs-actions.pod:156
6762 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6763 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6764 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6770 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6772 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6773 "The first time you call this function, the disk appears as C</dev/sda>, the "
6774 "second time as C</dev/sdb>, and so on."
6779 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6781 "You don't necessarily need to be root when using libguestfs. However you "
6782 "obviously do need sufficient permissions to access the filename for whatever "
6783 "operations you want to perform (ie. read access if you just want to read the "
6784 "image or write access if you want to modify the image)."
6789 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6790 msgid "This call checks that C<filename> exists."
6795 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4460
6796 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3024
6797 msgid "The optional arguments are:"
6802 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6808 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6810 "If true then the image is treated as read-only. Writes are still allowed, "
6811 "but they are stored in a temporary snapshot overlay which is discarded at "
6812 "the end. The disk that you add is not modified."
6817 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6823 #: ../src/guestfs-actions.pod:185
6825 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6826 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6827 "Possible formats include C<raw> and C<qcow2>."
6832 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6834 "Automatic detection of the format opens you up to a potential security hole "
6835 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6836 "RHBZ#642934. Specifying the format closes this security hole."
6841 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6847 #: ../src/guestfs-actions.pod:196
6849 "This rarely-used option lets you emulate the behaviour of the deprecated "
6850 "C<guestfs_add_drive_with_if> call (q.v.)"
6855 #: ../src/guestfs-actions.pod:203
6856 msgid "(Added in 1.5.23)"
6861 #: ../src/guestfs-actions.pod:205
6862 msgid "guestfs_add_drive_opts_va"
6867 #: ../src/guestfs-actions.pod:207
6871 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6872 " const char *filename,\n"
6879 #: ../src/guestfs-actions.pod:212
6880 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6885 #: ../src/guestfs-actions.pod:216
6886 msgid "guestfs_add_drive_opts_argv"
6891 #: ../src/guestfs-actions.pod:218
6895 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6896 " const char *filename,\n"
6897 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6903 #: ../src/guestfs-actions.pod:223
6904 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6909 #: ../src/guestfs-actions.pod:227
6910 msgid "guestfs_add_drive_ro"
6915 #: ../src/guestfs-actions.pod:229
6919 " guestfs_add_drive_ro (guestfs_h *g,\n"
6920 " const char *filename);\n"
6926 #: ../src/guestfs-actions.pod:233
6928 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6929 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6930 "disk is added read-only, with the format being detected automatically."
6935 #: ../src/guestfs-actions.pod:240
6936 msgid "(Added in 1.0.38)"
6941 #: ../src/guestfs-actions.pod:242
6942 msgid "guestfs_add_drive_ro_with_if"
6947 #: ../src/guestfs-actions.pod:244
6951 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6952 " const char *filename,\n"
6953 " const char *iface);\n"
6959 #: ../src/guestfs-actions.pod:249
6961 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6962 "QEMU interface emulation to use at run time."
6967 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6968 #: ../src/guestfs-actions.pod:2362
6969 msgid "(Added in 1.0.84)"
6974 #: ../src/guestfs-actions.pod:263
6975 msgid "guestfs_add_drive_with_if"
6980 #: ../src/guestfs-actions.pod:265
6984 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6985 " const char *filename,\n"
6986 " const char *iface);\n"
6992 #: ../src/guestfs-actions.pod:270
6994 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6995 "QEMU interface emulation to use at run time."
7000 #: ../src/guestfs-actions.pod:284
7001 msgid "guestfs_aug_clear"
7006 #: ../src/guestfs-actions.pod:286
7010 " guestfs_aug_clear (guestfs_h *g,\n"
7011 " const char *augpath);\n"
7017 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
7019 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7020 "L<augtool(1)> C<clear> command."
7025 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2112
7026 msgid "(Added in 1.3.4)"
7031 #: ../src/guestfs-actions.pod:297
7032 msgid "guestfs_aug_close"
7037 #: ../src/guestfs-actions.pod:299
7041 " guestfs_aug_close (guestfs_h *g);\n"
7047 #: ../src/guestfs-actions.pod:302
7049 "Close the current Augeas handle and free up any resources used by it. After "
7050 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7051 "any other Augeas functions."
7056 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
7057 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
7058 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
7059 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
7060 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
7061 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
7062 #: ../src/guestfs-actions.pod:5486
7063 msgid "(Added in 0.7)"
7068 #: ../src/guestfs-actions.pod:311
7069 msgid "guestfs_aug_defnode"
7074 #: ../src/guestfs-actions.pod:313
7077 " struct guestfs_int_bool *\n"
7078 " guestfs_aug_defnode (guestfs_h *g,\n"
7079 " const char *name,\n"
7080 " const char *expr,\n"
7081 " const char *val);\n"
7087 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
7089 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7094 #: ../src/guestfs-actions.pod:322
7096 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7097 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7098 "containing that single node."
7103 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
7105 "On success this returns a pair containing the number of nodes in the "
7106 "nodeset, and a boolean flag if a node was created."
7111 #: ../src/guestfs-actions.pod:330
7113 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7114 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7119 #: ../src/guestfs-actions.pod:336
7120 msgid "guestfs_aug_defvar"
7125 #: ../src/guestfs-actions.pod:338
7129 " guestfs_aug_defvar (guestfs_h *g,\n"
7130 " const char *name,\n"
7131 " const char *expr);\n"
7137 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
7139 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7140 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7145 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
7147 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7148 "evaluates to something which is not a nodeset."
7153 #: ../src/guestfs-actions.pod:354
7154 msgid "guestfs_aug_get"
7159 #: ../src/guestfs-actions.pod:356
7163 " guestfs_aug_get (guestfs_h *g,\n"
7164 " const char *augpath);\n"
7170 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
7172 "Look up the value associated with C<path>. If C<path> matches exactly one "
7173 "node, the C<value> is returned."
7178 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
7179 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
7180 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
7181 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
7182 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
7183 #: ../src/guestfs-actions.pod:1551 ../src/guestfs-actions.pod:1663
7184 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843
7185 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:1944
7186 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2135
7187 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2534
7188 #: ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2738
7189 #: ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2878
7190 #: ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:2933
7191 #: ../src/guestfs-actions.pod:2970 ../src/guestfs-actions.pod:3030
7192 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
7193 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3996
7194 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4276
7195 #: ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5214
7196 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5562
7197 #: ../src/guestfs-actions.pod:5611 ../src/guestfs-actions.pod:6223
7198 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6256
7199 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6954
7200 #: ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:6991
7201 #: ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7443
7203 "This function returns a string, or NULL on error. I<The caller must free "
7204 "the returned string after use>."
7209 #: ../src/guestfs-actions.pod:368
7210 msgid "guestfs_aug_init"
7215 #: ../src/guestfs-actions.pod:370
7219 " guestfs_aug_init (guestfs_h *g,\n"
7220 " const char *root,\n"
7227 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
7229 "Create a new Augeas handle for editing configuration files. If there was "
7230 "any previous Augeas handle associated with this guestfs session, then it is "
7236 #: ../src/guestfs-actions.pod:379
7237 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7242 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
7244 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7249 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
7251 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7252 "logical I<or> of the following integers:"
7257 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
7258 msgid "C<AUG_SAVE_BACKUP> = 1"
7263 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
7264 msgid "Keep the original file with a C<.augsave> extension."
7269 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
7270 msgid "C<AUG_SAVE_NEWFILE> = 2"
7275 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
7277 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7278 "original. Overrides C<AUG_SAVE_BACKUP>."
7283 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
7284 msgid "C<AUG_TYPE_CHECK> = 4"
7289 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
7290 msgid "Typecheck lenses (can be expensive)."
7295 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
7296 msgid "C<AUG_NO_STDINC> = 8"
7301 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
7302 msgid "Do not use standard load path for modules."
7307 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
7308 msgid "C<AUG_SAVE_NOOP> = 16"
7313 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
7314 msgid "Make save a no-op, just record what would have been changed."
7319 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
7320 msgid "C<AUG_NO_LOAD> = 32"
7325 #: ../src/guestfs-actions.pod:414
7326 msgid "Do not load the tree in C<guestfs_aug_init>."
7331 #: ../src/guestfs-actions.pod:418
7332 msgid "To close the handle, you can call C<guestfs_aug_close>."
7337 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
7338 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7343 #: ../src/guestfs-actions.pod:426
7344 msgid "guestfs_aug_insert"
7349 #: ../src/guestfs-actions.pod:428
7353 " guestfs_aug_insert (guestfs_h *g,\n"
7354 " const char *augpath,\n"
7355 " const char *label,\n"
7362 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
7364 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7365 "or after C<path> (depending on the boolean flag C<before>)."
7370 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
7372 "C<path> must match exactly one existing node in the tree, and C<label> must "
7373 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7378 #: ../src/guestfs-actions.pod:446
7379 msgid "guestfs_aug_load"
7384 #: ../src/guestfs-actions.pod:448
7388 " guestfs_aug_load (guestfs_h *g);\n"
7394 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
7395 msgid "Load files into the tree."
7400 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
7401 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7406 #: ../src/guestfs-actions.pod:460
7407 msgid "guestfs_aug_ls"
7412 #: ../src/guestfs-actions.pod:462
7416 " guestfs_aug_ls (guestfs_h *g,\n"
7417 " const char *augpath);\n"
7423 #: ../src/guestfs-actions.pod:466
7425 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7426 "sorting the resulting nodes into alphabetical order."
7431 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
7432 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
7433 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
7434 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
7435 #: ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2207
7436 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
7437 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
7438 #: ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2429
7439 #: ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2987
7440 #: ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3566
7441 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3733
7442 #: ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4836
7443 #: ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5482
7444 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:6296
7445 #: ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6412
7446 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6582
7447 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7084
7448 #: ../src/guestfs-actions.pod:7131 ../src/guestfs-actions.pod:7296
7449 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7400
7450 #: ../src/guestfs-actions.pod:7419 ../src/guestfs-actions.pod:7465
7451 #: ../src/guestfs-actions.pod:7484
7453 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7454 ">), or NULL if there was an error. I<The caller must free the strings and "
7455 "the array after use>."
7460 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
7461 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
7462 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3385
7463 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4029
7464 #: ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4249
7465 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4840
7466 #: ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5692
7467 #: ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5718
7468 #: ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6796
7469 #: ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:7048
7470 #: ../src/guestfs-actions.pod:7284
7471 msgid "(Added in 0.8)"
7476 #: ../src/guestfs-actions.pod:475
7477 msgid "guestfs_aug_match"
7482 #: ../src/guestfs-actions.pod:477
7486 " guestfs_aug_match (guestfs_h *g,\n"
7487 " const char *augpath);\n"
7493 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7495 "Returns a list of paths which match the path expression C<path>. The "
7496 "returned paths are sufficiently qualified so that they match exactly one "
7497 "node in the current tree."
7502 #: ../src/guestfs-actions.pod:491
7503 msgid "guestfs_aug_mv"
7508 #: ../src/guestfs-actions.pod:493
7512 " guestfs_aug_mv (guestfs_h *g,\n"
7513 " const char *src,\n"
7514 " const char *dest);\n"
7520 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7522 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7523 "C<dest> is overwritten if it exists."
7528 #: ../src/guestfs-actions.pod:505
7529 msgid "guestfs_aug_rm"
7534 #: ../src/guestfs-actions.pod:507
7538 " guestfs_aug_rm (guestfs_h *g,\n"
7539 " const char *augpath);\n"
7545 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7546 msgid "Remove C<path> and all of its children."
7551 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7552 msgid "On success this returns the number of entries which were removed."
7557 #: ../src/guestfs-actions.pod:519
7558 msgid "guestfs_aug_save"
7563 #: ../src/guestfs-actions.pod:521
7567 " guestfs_aug_save (guestfs_h *g);\n"
7573 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7574 msgid "This writes all pending changes to disk."
7579 #: ../src/guestfs-actions.pod:526
7581 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7587 #: ../src/guestfs-actions.pod:533
7588 msgid "guestfs_aug_set"
7593 #: ../src/guestfs-actions.pod:535
7597 " guestfs_aug_set (guestfs_h *g,\n"
7598 " const char *augpath,\n"
7599 " const char *val);\n"
7605 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7606 msgid "Set the value associated with C<path> to C<val>."
7611 #: ../src/guestfs-actions.pod:542
7613 "In the Augeas API, it is possible to clear a node by setting the value to "
7614 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7615 "this call. Instead you must use the C<guestfs_aug_clear> call."
7620 #: ../src/guestfs-actions.pod:551
7621 msgid "guestfs_available"
7626 #: ../src/guestfs-actions.pod:553
7630 " guestfs_available (guestfs_h *g,\n"
7631 " char *const *groups);\n"
7637 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7639 "This command is used to check the availability of some groups of "
7640 "functionality in the appliance, which not all builds of the libguestfs "
7641 "appliance will be able to provide."
7646 #: ../src/guestfs-actions.pod:561
7648 "The libguestfs groups, and the functions that those groups correspond to, "
7649 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7650 "runtime by calling C<guestfs_available_all_groups>."
7655 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7657 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7658 "\"]> would check for the availability of the Linux inotify functions and "
7659 "Augeas (configuration file editing) functions."
7664 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7665 msgid "The command returns no error if I<all> requested groups are available."
7670 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7672 "It fails with an error if one or more of the requested groups is unavailable "
7678 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7680 "If an unknown group name is included in the list of groups then an error is "
7686 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7692 #: ../src/guestfs-actions.pod:585
7693 msgid "You must call C<guestfs_launch> before calling this function."
7698 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7700 "The reason is because we don't know what groups are supported by the "
7701 "appliance/daemon until it is running and can be queried."
7706 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7708 "If a group of functions is available, this does not necessarily mean that "
7709 "they will work. You still have to check for errors when calling individual "
7710 "API functions even if they are available."
7715 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7717 "It is usually the job of distro packagers to build complete functionality "
7718 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7719 "with all requirements satisfied, will support everything."
7724 #: ../src/guestfs-actions.pod:607
7726 "This call was added in version C<1.0.80>. In previous versions of "
7727 "libguestfs all you could do would be to speculatively execute a command to "
7728 "find out if the daemon implemented it. See also C<guestfs_version>."
7733 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7734 msgid "(Added in 1.0.80)"
7739 #: ../src/guestfs-actions.pod:618
7740 msgid "guestfs_available_all_groups"
7745 #: ../src/guestfs-actions.pod:620
7749 " guestfs_available_all_groups (guestfs_h *g);\n"
7755 #: ../src/guestfs-actions.pod:623
7757 "This command returns a list of all optional groups that this daemon knows "
7758 "about. Note this returns both supported and unsupported groups. To find "
7759 "out which ones the daemon can actually support you have to call "
7760 "C<guestfs_available> on each member of the returned list."
7765 #: ../src/guestfs-actions.pod:629
7766 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7771 #: ../src/guestfs-actions.pod:635
7772 msgid "(Added in 1.3.15)"
7777 #: ../src/guestfs-actions.pod:637
7778 msgid "guestfs_base64_in"
7783 #: ../src/guestfs-actions.pod:639
7787 " guestfs_base64_in (guestfs_h *g,\n"
7788 " const char *base64file,\n"
7789 " const char *filename);\n"
7795 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7797 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7802 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7803 msgid "(Added in 1.3.5)"
7808 #: ../src/guestfs-actions.pod:651
7809 msgid "guestfs_base64_out"
7814 #: ../src/guestfs-actions.pod:653
7818 " guestfs_base64_out (guestfs_h *g,\n"
7819 " const char *filename,\n"
7820 " const char *base64file);\n"
7826 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7828 "This command downloads the contents of C<filename>, writing it out to local "
7829 "file C<base64file> encoded as base64."
7834 #: ../src/guestfs-actions.pod:665
7835 msgid "guestfs_blockdev_flushbufs"
7840 #: ../src/guestfs-actions.pod:667
7844 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7845 " const char *device);\n"
7851 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7853 "This tells the kernel to flush internal buffers associated with C<device>."
7858 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7859 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7860 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7861 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7862 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7863 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7864 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7865 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7866 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7867 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7868 msgid "This uses the L<blockdev(8)> command."
7873 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7874 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7875 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7876 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7877 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7878 msgid "(Added in 0.9.3)"
7883 #: ../src/guestfs-actions.pod:680
7884 msgid "guestfs_blockdev_getbsz"
7889 #: ../src/guestfs-actions.pod:682
7893 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7894 " const char *device);\n"
7900 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7901 msgid "This returns the block size of a device."
7906 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7907 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7909 "(Note this is different from both I<size in blocks> and I<filesystem block "
7915 #: ../src/guestfs-actions.pod:697
7916 msgid "guestfs_blockdev_getro"
7921 #: ../src/guestfs-actions.pod:699
7925 " guestfs_blockdev_getro (guestfs_h *g,\n"
7926 " const char *device);\n"
7932 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7934 "Returns a boolean indicating if the block device is read-only (true if read-"
7935 "only, false if not)."
7940 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7941 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1920
7942 #: ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2003
7943 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2073
7944 #: ../src/guestfs-actions.pod:2098 ../src/guestfs-actions.pod:2121
7945 #: ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111
7946 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3293
7947 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3322
7948 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3352
7949 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3383
7950 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3410
7951 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3439
7952 #: ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4985
7953 msgid "This function returns a C truth value on success or -1 on error."
7958 #: ../src/guestfs-actions.pod:712
7959 msgid "guestfs_blockdev_getsize64"
7964 #: ../src/guestfs-actions.pod:714
7968 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7969 " const char *device);\n"
7975 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7976 msgid "This returns the size of the device in bytes."
7981 #: ../src/guestfs-actions.pod:720
7982 msgid "See also C<guestfs_blockdev_getsz>."
7987 #: ../src/guestfs-actions.pod:728
7988 msgid "guestfs_blockdev_getss"
7993 #: ../src/guestfs-actions.pod:730
7997 " guestfs_blockdev_getss (guestfs_h *g,\n"
7998 " const char *device);\n"
8004 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
8006 "This returns the size of sectors on a block device. Usually 512, but can be "
8007 "larger for modern devices."
8012 #: ../src/guestfs-actions.pod:737
8014 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8020 #: ../src/guestfs-actions.pod:746
8021 msgid "guestfs_blockdev_getsz"
8026 #: ../src/guestfs-actions.pod:748
8030 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8031 " const char *device);\n"
8037 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
8039 "This returns the size of the device in units of 512-byte sectors (even if "
8040 "the sectorsize isn't 512 bytes ... weird)."
8045 #: ../src/guestfs-actions.pod:755
8047 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8048 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8053 #: ../src/guestfs-actions.pod:765
8054 msgid "guestfs_blockdev_rereadpt"
8059 #: ../src/guestfs-actions.pod:767
8063 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8064 " const char *device);\n"
8070 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
8071 msgid "Reread the partition table on C<device>."
8076 #: ../src/guestfs-actions.pod:779
8077 msgid "guestfs_blockdev_setbsz"
8082 #: ../src/guestfs-actions.pod:781
8086 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8087 " const char *device,\n"
8088 " int blocksize);\n"
8094 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
8095 msgid "This sets the block size of a device."
8100 #: ../src/guestfs-actions.pod:797
8101 msgid "guestfs_blockdev_setro"
8106 #: ../src/guestfs-actions.pod:799
8110 " guestfs_blockdev_setro (guestfs_h *g,\n"
8111 " const char *device);\n"
8117 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
8118 msgid "Sets the block device named C<device> to read-only."
8123 #: ../src/guestfs-actions.pod:811
8124 msgid "guestfs_blockdev_setrw"
8129 #: ../src/guestfs-actions.pod:813
8133 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8134 " const char *device);\n"
8140 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
8141 msgid "Sets the block device named C<device> to read-write."
8146 #: ../src/guestfs-actions.pod:825
8147 msgid "guestfs_case_sensitive_path"
8152 #: ../src/guestfs-actions.pod:827
8156 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8157 " const char *path);\n"
8163 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
8165 "This can be used to resolve case insensitive paths on a filesystem which is "
8166 "case sensitive. The use case is to resolve paths which you have read from "
8167 "Windows configuration files or the Windows Registry, to the true path."
8172 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
8174 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8175 "(and probably others), which is that although the underlying filesystem is "
8176 "case-insensitive, the driver exports the filesystem to Linux as case-"
8182 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
8184 "One consequence of this is that special directories such as C<c:\\windows> "
8185 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8186 "precise details of how they were created. In Windows itself this would not "
8192 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
8194 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8200 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
8202 "This function resolves the true case of each element in the path and returns "
8203 "the case-sensitive path."
8208 #: ../src/guestfs-actions.pod:853
8210 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8211 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8212 "how the directories were originally created under Windows)."
8217 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
8218 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8223 #: ../src/guestfs-actions.pod:861
8224 msgid "See also C<guestfs_realpath>."
8229 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:6976
8230 msgid "(Added in 1.0.75)"
8235 #: ../src/guestfs-actions.pod:868
8241 #: ../src/guestfs-actions.pod:870
8245 " guestfs_cat (guestfs_h *g,\n"
8246 " const char *path);\n"
8252 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5472
8253 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3672
8254 msgid "Return the contents of the file named C<path>."
8259 #: ../src/guestfs-actions.pod:876
8261 "Note that this function cannot correctly handle binary files (specifically, "
8262 "files containing C<\\0> character which is treated as end of string). For "
8263 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8264 "functions which have a more complex interface."
8269 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
8270 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
8271 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
8272 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1769
8273 #: ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246
8274 #: ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313
8275 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2359
8276 #: ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5280
8277 #: ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5437
8278 #: ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:6361
8279 #: ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6562
8280 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:7248
8281 #: ../src/guestfs-actions.pod:7274 ../src/guestfs-actions.pod:7300
8282 #: ../src/guestfs-actions.pod:7319 ../src/guestfs-actions.pod:7404
8283 #: ../src/guestfs-actions.pod:7423 ../src/guestfs-actions.pod:7469
8284 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:592
8285 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
8286 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
8287 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
8288 #: ../fish/guestfish-actions.pod:1197 ../fish/guestfish-actions.pod:1498
8289 #: ../fish/guestfish-actions.pod:1508 ../fish/guestfish-actions.pod:1536
8290 #: ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1561
8291 #: ../fish/guestfish-actions.pod:1580 ../fish/guestfish-actions.pod:3542
8292 #: ../fish/guestfish-actions.pod:3557 ../fish/guestfish-actions.pod:3633
8293 #: ../fish/guestfish-actions.pod:3650 ../fish/guestfish-actions.pod:3665
8294 #: ../fish/guestfish-actions.pod:4291 ../fish/guestfish-actions.pod:4337
8295 #: ../fish/guestfish-actions.pod:4422 ../fish/guestfish-actions.pod:4437
8296 #: ../fish/guestfish-actions.pod:4847 ../fish/guestfish-actions.pod:4865
8297 #: ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4892
8298 #: ../fish/guestfish-actions.pod:4940 ../fish/guestfish-actions.pod:4950
8299 #: ../fish/guestfish-actions.pod:4979 ../fish/guestfish-actions.pod:4989
8301 "Because of the message protocol, there is a transfer limit of somewhere "
8302 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8307 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3570
8308 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3649
8309 #: ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:4142
8310 #: ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5360
8311 #: ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:7135
8312 #: ../src/guestfs-actions.pod:7149
8313 msgid "(Added in 0.4)"
8318 #: ../src/guestfs-actions.pod:889
8319 msgid "guestfs_checksum"
8324 #: ../src/guestfs-actions.pod:891
8328 " guestfs_checksum (guestfs_h *g,\n"
8329 " const char *csumtype,\n"
8330 " const char *path);\n"
8336 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
8338 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8343 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
8345 "The type of checksum to compute is given by the C<csumtype> parameter which "
8346 "must have one of the following values:"
8351 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
8357 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
8359 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8365 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
8371 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
8372 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8377 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
8383 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
8384 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8389 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
8395 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
8396 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8401 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
8407 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
8408 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8413 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
8419 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
8420 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8425 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
8431 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
8432 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8437 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
8438 msgid "The checksum is returned as a printable string."
8443 #: ../src/guestfs-actions.pod:937
8444 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8449 #: ../src/guestfs-actions.pod:939
8450 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8455 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
8456 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3309
8457 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3399
8458 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:6832
8459 msgid "(Added in 1.0.2)"
8464 #: ../src/guestfs-actions.pod:946
8465 msgid "guestfs_checksum_device"
8470 #: ../src/guestfs-actions.pod:948
8474 " guestfs_checksum_device (guestfs_h *g,\n"
8475 " const char *csumtype,\n"
8476 " const char *device);\n"
8482 #: ../src/guestfs-actions.pod:953
8484 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8485 "device named C<device>. For the types of checksums supported see the "
8486 "C<guestfs_checksum> command."
8491 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4891
8492 #: ../src/guestfs-actions.pod:4950 ../src/guestfs-actions.pod:4987
8493 #: ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5181
8494 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:6755
8495 #: ../src/guestfs-actions.pod:7161
8496 msgid "(Added in 1.3.2)"
8501 #: ../src/guestfs-actions.pod:962
8502 msgid "guestfs_checksums_out"
8507 #: ../src/guestfs-actions.pod:964
8511 " guestfs_checksums_out (guestfs_h *g,\n"
8512 " const char *csumtype,\n"
8513 " const char *directory,\n"
8514 " const char *sumsfile);\n"
8520 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
8522 "This command computes the checksums of all regular files in C<directory> and "
8523 "then emits a list of those checksums to the local output file C<sumsfile>."
8528 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
8530 "This can be used for verifying the integrity of a virtual machine. However "
8531 "to be properly secure you should pay attention to the output of the checksum "
8532 "command (it uses the ones from GNU coreutils). In particular when the "
8533 "filename is not printable, coreutils uses a special backslash syntax. For "
8534 "more information, see the GNU coreutils info file."
8539 #: ../src/guestfs-actions.pod:984
8540 msgid "(Added in 1.3.7)"
8545 #: ../src/guestfs-actions.pod:986
8546 msgid "guestfs_chmod"
8551 #: ../src/guestfs-actions.pod:988
8555 " guestfs_chmod (guestfs_h *g,\n"
8557 " const char *path);\n"
8563 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
8565 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8571 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
8573 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8574 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8580 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4393
8581 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
8582 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:681
8583 #: ../fish/guestfish-actions.pod:2988 ../fish/guestfish-actions.pod:3117
8584 #: ../fish/guestfish-actions.pod:3127 ../fish/guestfish-actions.pod:3137
8585 msgid "The mode actually set is affected by the umask."
8590 #: ../src/guestfs-actions.pod:1006
8591 msgid "guestfs_chown"
8596 #: ../src/guestfs-actions.pod:1008
8600 " guestfs_chown (guestfs_h *g,\n"
8603 " const char *path);\n"
8609 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
8610 msgid "Change the file owner to C<owner> and group to C<group>."
8615 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3501
8616 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2446
8618 "Only numeric uid and gid are supported. If you want to use names, you will "
8619 "need to locate and parse the password file yourself (Augeas support makes "
8620 "this relatively easy)."
8625 #: ../src/guestfs-actions.pod:1024
8626 msgid "guestfs_command"
8631 #: ../src/guestfs-actions.pod:1026
8635 " guestfs_command (guestfs_h *g,\n"
8636 " char *const *arguments);\n"
8642 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
8644 "This call runs a command from the guest filesystem. The filesystem must be "
8645 "mounted, and must contain a compatible operating system (ie. something "
8646 "Linux, with the same or compatible processor architecture)."
8651 #: ../src/guestfs-actions.pod:1035
8653 "The single parameter is an argv-style list of arguments. The first element "
8654 "is the name of the program to run. Subsequent elements are parameters. The "
8655 "list must be non-empty (ie. must contain a program name). Note that the "
8656 "command runs directly, and is I<not> invoked via the shell (see "
8662 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
8663 msgid "The return value is anything printed to I<stdout> by the command."
8668 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
8670 "If the command returns a non-zero exit status, then this function returns an "
8671 "error message. The error message string is the content of I<stderr> from "
8677 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
8679 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8680 "bin>. If you require a program from another location, you should provide "
8681 "the full path in the first parameter."
8686 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8688 "Shared libraries and data files required by the program must be available on "
8689 "filesystems which are mounted in the correct places. It is the caller's "
8690 "responsibility to ensure all filesystems that are needed are mounted at the "
8696 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8697 #: ../src/guestfs-actions.pod:1554
8698 msgid "(Added in 0.9.1)"
8703 #: ../src/guestfs-actions.pod:1068
8704 msgid "guestfs_command_lines"
8709 #: ../src/guestfs-actions.pod:1070
8713 " guestfs_command_lines (guestfs_h *g,\n"
8714 " char *const *arguments);\n"
8720 #: ../src/guestfs-actions.pod:1074
8722 "This is the same as C<guestfs_command>, but splits the result into a list of "
8728 #: ../src/guestfs-actions.pod:1077
8729 msgid "See also: C<guestfs_sh_lines>"
8734 #: ../src/guestfs-actions.pod:1088
8735 msgid "guestfs_config"
8740 #: ../src/guestfs-actions.pod:1090
8744 " guestfs_config (guestfs_h *g,\n"
8745 " const char *qemuparam,\n"
8746 " const char *qemuvalue);\n"
8751 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8753 "This can be used to add arbitrary qemu command line parameters of the form "
8754 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8755 "setting some parameters which would interfere with parameters that we use."
8760 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8761 msgid "The first character of C<param> string must be a C<-> (dash)."
8766 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8767 msgid "C<value> can be NULL."
8772 #: ../src/guestfs-actions.pod:1108
8773 msgid "guestfs_copy_size"
8778 #: ../src/guestfs-actions.pod:1110
8782 " guestfs_copy_size (guestfs_h *g,\n"
8783 " const char *src,\n"
8784 " const char *dest,\n"
8791 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8793 "This command copies exactly C<size> bytes from one source device or file "
8794 "C<src> to another destination device or file C<dest>."
8799 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8801 "Note this will fail if the source is too short or if the destination is not "
8806 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8807 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8808 #: ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:1725
8809 #: ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:6827
8810 #: ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:7340
8811 #: ../src/guestfs-actions.pod:7359
8813 "This long-running command can generate progress notification messages so "
8814 "that the caller can display a progress bar or indicator. To receive these "
8815 "messages, the caller must register a progress event callback. See L<guestfs"
8816 "(3)/GUESTFS_EVENT_PROGRESS>."
8821 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4169
8822 #: ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:7068
8823 #: ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7174
8824 msgid "(Added in 1.0.87)"
8829 #: ../src/guestfs-actions.pod:1131
8835 #: ../src/guestfs-actions.pod:1133
8839 " guestfs_cp (guestfs_h *g,\n"
8840 " const char *src,\n"
8841 " const char *dest);\n"
8847 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8849 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8850 "destination filename or destination directory."
8855 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8856 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8857 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4854
8858 #: ../src/guestfs-actions.pod:5231
8859 msgid "(Added in 1.0.18)"
8864 #: ../src/guestfs-actions.pod:1145
8865 msgid "guestfs_cp_a"
8870 #: ../src/guestfs-actions.pod:1147
8874 " guestfs_cp_a (guestfs_h *g,\n"
8875 " const char *src,\n"
8876 " const char *dest);\n"
8882 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8884 "This copies a file or directory from C<src> to C<dest> recursively using the "
8890 #: ../src/guestfs-actions.pod:1159
8896 #: ../src/guestfs-actions.pod:1161
8900 " guestfs_dd (guestfs_h *g,\n"
8901 " const char *src,\n"
8902 " const char *dest);\n"
8908 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8910 "This command copies from one source device or file C<src> to another "
8911 "destination device or file C<dest>. Normally you would use this to copy to "
8912 "or from a device or partition, for example to duplicate a filesystem."
8917 #: ../src/guestfs-actions.pod:1171
8919 "If the destination is a device, it must be as large or larger than the "
8920 "source file or device, otherwise the copy will fail. This command cannot do "
8921 "partial copies (see C<guestfs_copy_size>)."
8926 #: ../src/guestfs-actions.pod:1179
8932 #: ../src/guestfs-actions.pod:1181
8936 " guestfs_df (guestfs_h *g);\n"
8942 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8943 msgid "This command runs the C<df> command to report disk space used."
8948 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8950 "This command is mostly useful for interactive sessions. It is I<not> "
8951 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8957 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8958 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2292
8959 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2384
8960 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4754
8961 #: ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6589
8962 #: ../src/guestfs-actions.pod:7207 ../src/guestfs-actions.pod:7220
8963 #: ../src/guestfs-actions.pod:7233
8964 msgid "(Added in 1.0.54)"
8969 #: ../src/guestfs-actions.pod:1195
8970 msgid "guestfs_df_h"
8975 #: ../src/guestfs-actions.pod:1197
8979 " guestfs_df_h (guestfs_h *g);\n"
8985 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8987 "This command runs the C<df -h> command to report disk space used in human-"
8993 #: ../src/guestfs-actions.pod:1212
8994 msgid "guestfs_dmesg"
8999 #: ../src/guestfs-actions.pod:1214
9003 " guestfs_dmesg (guestfs_h *g);\n"
9009 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
9011 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9012 "This is sometimes useful for extended debugging of problems."
9017 #: ../src/guestfs-actions.pod:1221
9019 "Another way to get the same information is to enable verbose messages with "
9020 "C<guestfs_set_verbose> or by setting the environment variable "
9021 "C<LIBGUESTFS_DEBUG=1> before running the program."
9026 #: ../src/guestfs-actions.pod:1231
9027 msgid "guestfs_download"
9032 #: ../src/guestfs-actions.pod:1233
9036 " guestfs_download (guestfs_h *g,\n"
9037 " const char *remotefilename,\n"
9038 " const char *filename);\n"
9044 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
9045 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
9047 "Download file C<remotefilename> and save it as C<filename> on the local "
9053 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6821
9054 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4595
9055 msgid "C<filename> can also be a named pipe."
9060 #: ../src/guestfs-actions.pod:1243
9061 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9066 #: ../src/guestfs-actions.pod:1254
9067 msgid "guestfs_download_offset"
9072 #: ../src/guestfs-actions.pod:1256
9076 " guestfs_download_offset (guestfs_h *g,\n"
9077 " const char *remotefilename,\n"
9078 " const char *filename,\n"
9079 " int64_t offset,\n"
9086 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
9088 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9089 "region must be within the file or device)."
9094 #: ../src/guestfs-actions.pod:1269
9096 "Note that there is no limit on the amount of data that can be downloaded "
9097 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9098 "full amount unless an error occurs."
9103 #: ../src/guestfs-actions.pod:1274
9104 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9109 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6866
9110 msgid "(Added in 1.5.17)"
9115 #: ../src/guestfs-actions.pod:1285
9116 msgid "guestfs_drop_caches"
9121 #: ../src/guestfs-actions.pod:1287
9125 " guestfs_drop_caches (guestfs_h *g,\n"
9126 " int whattodrop);\n"
9132 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
9134 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9135 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9136 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9141 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
9142 msgid "Setting C<whattodrop> to 3 should drop everything."
9147 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
9149 "This automatically calls L<sync(2)> before the operation, so that the "
9150 "maximum guest memory is freed."
9155 #: ../src/guestfs-actions.pod:1305
9161 #: ../src/guestfs-actions.pod:1307
9165 " guestfs_du (guestfs_h *g,\n"
9166 " const char *path);\n"
9172 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
9174 "This command runs the C<du -s> command to estimate file space usage for "
9180 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
9182 "C<path> can be a file or a directory. If C<path> is a directory then the "
9183 "estimate includes the contents of the directory and all subdirectories "
9189 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
9191 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9196 #: ../src/guestfs-actions.pod:1330
9197 msgid "guestfs_e2fsck_f"
9202 #: ../src/guestfs-actions.pod:1332
9206 " guestfs_e2fsck_f (guestfs_h *g,\n"
9207 " const char *device);\n"
9212 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
9214 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9215 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9221 #: ../src/guestfs-actions.pod:1340
9223 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9224 "Normally you should use C<guestfs_fsck>."
9229 #: ../src/guestfs-actions.pod:1345
9230 msgid "(Added in 1.0.29)"
9235 #: ../src/guestfs-actions.pod:1347
9236 msgid "guestfs_echo_daemon"
9241 #: ../src/guestfs-actions.pod:1349
9245 " guestfs_echo_daemon (guestfs_h *g,\n"
9246 " char *const *words);\n"
9252 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
9254 "This command concatenates the list of C<words> passed with single spaces "
9255 "between them and returns the resulting string."
9260 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
9261 msgid "You can use this command to test the connection through to the daemon."
9266 #: ../src/guestfs-actions.pod:1358
9267 msgid "See also C<guestfs_ping_daemon>."
9272 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2100
9273 #: ../src/guestfs-actions.pod:6065
9274 msgid "(Added in 1.0.69)"
9279 #: ../src/guestfs-actions.pod:1365
9280 msgid "guestfs_egrep"
9285 #: ../src/guestfs-actions.pod:1367
9289 " guestfs_egrep (guestfs_h *g,\n"
9290 " const char *regex,\n"
9291 " const char *path);\n"
9297 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
9299 "This calls the external C<egrep> program and returns the matching lines."
9304 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
9305 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
9306 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2230
9307 #: ../src/guestfs-actions.pod:2249 ../src/guestfs-actions.pod:2405
9308 #: ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2433
9309 #: ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:2501
9310 #: ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:3662
9311 #: ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:3689
9312 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4689
9313 #: ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5614
9314 #: ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6445
9315 #: ../src/guestfs-actions.pod:6458 ../src/guestfs-actions.pod:6471
9316 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
9317 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6532
9318 #: ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7322
9319 #: ../src/guestfs-actions.pod:7407 ../src/guestfs-actions.pod:7426
9320 #: ../src/guestfs-actions.pod:7472 ../src/guestfs-actions.pod:7491
9321 msgid "(Added in 1.0.66)"
9326 #: ../src/guestfs-actions.pod:1384
9327 msgid "guestfs_egrepi"
9332 #: ../src/guestfs-actions.pod:1386
9336 " guestfs_egrepi (guestfs_h *g,\n"
9337 " const char *regex,\n"
9338 " const char *path);\n"
9344 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
9346 "This calls the external C<egrep -i> program and returns the matching lines."
9351 #: ../src/guestfs-actions.pod:1403
9352 msgid "guestfs_equal"
9357 #: ../src/guestfs-actions.pod:1405
9361 " guestfs_equal (guestfs_h *g,\n"
9362 " const char *file1,\n"
9363 " const char *file2);\n"
9369 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
9371 "This compares the two files C<file1> and C<file2> and returns true if their "
9372 "content is exactly equal, or false otherwise."
9377 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
9378 msgid "The external L<cmp(1)> program is used for the comparison."
9383 #: ../src/guestfs-actions.pod:1419
9384 msgid "guestfs_exists"
9389 #: ../src/guestfs-actions.pod:1421
9393 " guestfs_exists (guestfs_h *g,\n"
9394 " const char *path);\n"
9400 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
9402 "This returns C<true> if and only if there is a file, directory (or anything) "
9403 "with the given C<path> name."
9408 #: ../src/guestfs-actions.pod:1428
9409 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9414 #: ../src/guestfs-actions.pod:1434
9415 msgid "guestfs_fallocate"
9420 #: ../src/guestfs-actions.pod:1436
9424 " guestfs_fallocate (guestfs_h *g,\n"
9425 " const char *path,\n"
9432 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
9433 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
9435 "This command preallocates a file (containing zero bytes) named C<path> of "
9436 "size C<len> bytes. If the file exists already, it is overwritten."
9441 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
9443 "Do not confuse this with the guestfish-specific C<alloc> command which "
9444 "allocates a file in the host and attaches it as a device."
9449 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
9451 "This function is deprecated. In new code, use the C<fallocate64> call "
9457 #: ../src/guestfs-actions.pod:1460
9458 msgid "guestfs_fallocate64"
9463 #: ../src/guestfs-actions.pod:1462
9467 " guestfs_fallocate64 (guestfs_h *g,\n"
9468 " const char *path,\n"
9475 #: ../src/guestfs-actions.pod:1471
9477 "Note that this call allocates disk blocks for the file. To create a sparse "
9478 "file use C<guestfs_truncate_size> instead."
9483 #: ../src/guestfs-actions.pod:1474
9485 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9486 "oversight it only allowed 30 bit lengths to be specified, effectively "
9487 "limiting the maximum size of files created through that call to 1GB."
9492 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
9494 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9495 "commands which create a file in the host and attach it as a device."
9500 #: ../src/guestfs-actions.pod:1485
9501 msgid "(Added in 1.3.17)"
9506 #: ../src/guestfs-actions.pod:1487
9507 msgid "guestfs_fgrep"
9512 #: ../src/guestfs-actions.pod:1489
9516 " guestfs_fgrep (guestfs_h *g,\n"
9517 " const char *pattern,\n"
9518 " const char *path);\n"
9524 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
9526 "This calls the external C<fgrep> program and returns the matching lines."
9531 #: ../src/guestfs-actions.pod:1506
9532 msgid "guestfs_fgrepi"
9537 #: ../src/guestfs-actions.pod:1508
9541 " guestfs_fgrepi (guestfs_h *g,\n"
9542 " const char *pattern,\n"
9543 " const char *path);\n"
9549 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
9551 "This calls the external C<fgrep -i> program and returns the matching lines."
9556 #: ../src/guestfs-actions.pod:1525
9557 msgid "guestfs_file"
9562 #: ../src/guestfs-actions.pod:1527
9566 " guestfs_file (guestfs_h *g,\n"
9567 " const char *path);\n"
9573 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
9575 "This call uses the standard L<file(1)> command to determine the type or "
9576 "contents of the file."
9581 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
9583 "This call will also transparently look inside various types of compressed "
9588 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
9590 "The exact command which runs is C<file -zb path>. Note in particular that "
9591 "the filename is not prepended to the output (the I<-b> option)."
9596 #: ../src/guestfs-actions.pod:1541
9598 "This command can also be used on C</dev/> devices (and partitions, LV "
9599 "names). You can for example use this to determine if a device contains a "
9600 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9605 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
9607 "If the C<path> does not begin with C</dev/> then this command only works for "
9608 "the content of regular files. For other file types (directory, symbolic "
9609 "link etc) it will just return the string C<directory> etc."
9614 #: ../src/guestfs-actions.pod:1556
9615 msgid "guestfs_file_architecture"
9620 #: ../src/guestfs-actions.pod:1558
9624 " guestfs_file_architecture (guestfs_h *g,\n"
9625 " const char *filename);\n"
9631 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
9633 "This detects the architecture of the binary C<filename>, and returns it if "
9639 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1036
9640 msgid "Currently defined architectures are:"
9645 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1040
9651 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
9653 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9654 "irrespective of the precise processor requirements of the binary."
9659 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1045
9665 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1047
9666 msgid "64 bit x86-64."
9671 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1049
9677 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1051
9678 msgid "32 bit SPARC."
9683 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1053
9689 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1055
9690 msgid "64 bit SPARC V9 and above."
9695 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1057
9701 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1059
9702 msgid "Intel Itanium."
9707 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1061
9713 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1063
9714 msgid "32 bit Power PC."
9719 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1065
9725 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1067
9726 msgid "64 bit Power PC."
9731 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1071
9732 msgid "Libguestfs may return other architecture strings in future."
9737 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1073
9738 msgid "The function works on at least the following types of files:"
9743 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1079
9744 msgid "many types of Un*x and Linux binary"
9749 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1083
9750 msgid "many types of Un*x and Linux shared library"
9755 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1087
9756 msgid "Windows Win32 and Win64 binaries"
9761 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1091
9762 msgid "Windows Win32 and Win64 DLLs"
9767 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1093
9768 msgid "Win32 binaries and DLLs return C<i386>."
9773 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1095
9774 msgid "Win64 binaries and DLLs return C<x86_64>."
9779 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1099
9780 msgid "Linux kernel modules"
9785 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1103
9786 msgid "Linux new-style initrd images"
9791 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1107
9792 msgid "some non-x86 Linux vmlinuz kernels"
9797 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1111
9798 msgid "What it can't do currently:"
9803 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1117
9804 msgid "static libraries (libfoo.a)"
9809 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1121
9810 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9815 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1125
9816 msgid "x86 Linux vmlinuz kernels"
9821 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1127
9823 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9824 "compressed code, and are horribly hard to unpack. If you want to find the "
9825 "architecture of a kernel, use the architecture of the associated initrd or "
9826 "kernel module(s) instead."
9831 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1829
9832 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:2537
9833 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2700
9834 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2809
9835 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2936
9836 #: ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3280
9837 #: ../src/guestfs-actions.pod:3412
9838 msgid "(Added in 1.5.3)"
9843 #: ../src/guestfs-actions.pod:1668
9844 msgid "guestfs_filesize"
9849 #: ../src/guestfs-actions.pod:1670
9853 " guestfs_filesize (guestfs_h *g,\n"
9854 " const char *file);\n"
9860 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1138
9861 msgid "This command returns the size of C<file> in bytes."
9866 #: ../src/guestfs-actions.pod:1676
9868 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9869 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9870 "devices, use C<guestfs_blockdev_getsize64>."
9875 #: ../src/guestfs-actions.pod:1682
9876 msgid "(Added in 1.0.82)"
9881 #: ../src/guestfs-actions.pod:1684
9882 msgid "guestfs_fill"
9887 #: ../src/guestfs-actions.pod:1686
9891 " guestfs_fill (guestfs_h *g,\n"
9894 " const char *path);\n"
9900 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1148
9902 "This command creates a new file called C<path>. The initial content of the "
9903 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9909 #: ../src/guestfs-actions.pod:1696
9911 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9912 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9913 "bytes use C<guestfs_fill_pattern>."
9918 #: ../src/guestfs-actions.pod:1708
9919 msgid "(Added in 1.0.79)"
9924 #: ../src/guestfs-actions.pod:1710
9925 msgid "guestfs_fill_pattern"
9930 #: ../src/guestfs-actions.pod:1712
9934 " guestfs_fill_pattern (guestfs_h *g,\n"
9935 " const char *pattern,\n"
9937 " const char *path);\n"
9943 #: ../src/guestfs-actions.pod:1718
9945 "This function is like C<guestfs_fill> except that it creates a new file of "
9946 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9947 "pattern is truncated if necessary to ensure the length of the file is "
9948 "exactly C<len> bytes."
9953 #: ../src/guestfs-actions.pod:1730
9954 msgid "(Added in 1.3.12)"
9959 #: ../src/guestfs-actions.pod:1732
9960 msgid "guestfs_find"
9965 #: ../src/guestfs-actions.pod:1734
9969 " guestfs_find (guestfs_h *g,\n"
9970 " const char *directory);\n"
9976 #: ../src/guestfs-actions.pod:1738 ../fish/guestfish-actions.pod:1170
9978 "This command lists out all files and directories, recursively, starting at "
9979 "C<directory>. It is essentially equivalent to running the shell command "
9980 "C<find directory -print> but some post-processing happens on the output, "
9986 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9988 "This returns a list of strings I<without any prefix>. Thus if the directory "
9994 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1178
10005 #: ../src/guestfs-actions.pod:1750
10007 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10012 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1185
10024 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
10025 msgid "If C<directory> is not a directory, then this command returns an error."
10030 #: ../src/guestfs-actions.pod:1761 ../fish/guestfish-actions.pod:1193
10031 msgid "The returned list is sorted."
10036 #: ../src/guestfs-actions.pod:1763
10037 msgid "See also C<guestfs_find0>."
10042 #: ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:4106
10043 #: ../src/guestfs-actions.pod:5649
10044 msgid "(Added in 1.0.27)"
10049 #: ../src/guestfs-actions.pod:1774
10050 msgid "guestfs_find0"
10055 #: ../src/guestfs-actions.pod:1776
10059 " guestfs_find0 (guestfs_h *g,\n"
10060 " const char *directory,\n"
10061 " const char *files);\n"
10067 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1204
10069 "This command lists out all files and directories, recursively, starting at "
10070 "C<directory>, placing the resulting list in the external file called "
10076 #: ../src/guestfs-actions.pod:1785
10078 "This command works the same way as C<guestfs_find> with the following "
10084 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1215
10085 msgid "The resulting list is written to an external file."
10090 #: ../src/guestfs-actions.pod:1796 ../fish/guestfish-actions.pod:1219
10092 "Items (filenames) in the result are separated by C<\\0> characters. See "
10093 "L<find(1)> option I<-print0>."
10098 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1224
10099 msgid "This command is not limited in the number of names that it can return."
10104 #: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1229
10105 msgid "The result list is not sorted."
10110 #: ../src/guestfs-actions.pod:1812
10111 msgid "(Added in 1.0.74)"
10116 #: ../src/guestfs-actions.pod:1814
10117 msgid "guestfs_findfs_label"
10122 #: ../src/guestfs-actions.pod:1816
10126 " guestfs_findfs_label (guestfs_h *g,\n"
10127 " const char *label);\n"
10133 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
10135 "This command searches the filesystems and returns the one which has the "
10136 "given label. An error is returned if no such filesystem can be found."
10141 #: ../src/guestfs-actions.pod:1824
10142 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10147 #: ../src/guestfs-actions.pod:1831
10148 msgid "guestfs_findfs_uuid"
10153 #: ../src/guestfs-actions.pod:1833
10157 " guestfs_findfs_uuid (guestfs_h *g,\n"
10158 " const char *uuid);\n"
10164 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1249
10166 "This command searches the filesystems and returns the one which has the "
10167 "given UUID. An error is returned if no such filesystem can be found."
10172 #: ../src/guestfs-actions.pod:1841
10173 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10178 #: ../src/guestfs-actions.pod:1848
10179 msgid "guestfs_fsck"
10184 #: ../src/guestfs-actions.pod:1850
10188 " guestfs_fsck (guestfs_h *g,\n"
10189 " const char *fstype,\n"
10190 " const char *device);\n"
10196 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
10198 "This runs the filesystem checker (fsck) on C<device> which should have "
10199 "filesystem type C<fstype>."
10204 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1262
10206 "The returned integer is the status. See L<fsck(8)> for the list of status "
10207 "codes from C<fsck>."
10212 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1271
10213 msgid "Multiple status codes can be summed together."
10218 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1275
10220 "A non-zero return code can mean \"success\", for example if errors have been "
10221 "corrected on the filesystem."
10226 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1280
10227 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10232 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1285
10234 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10239 #: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:7345
10240 msgid "(Added in 1.0.16)"
10245 #: ../src/guestfs-actions.pod:1887
10246 msgid "guestfs_get_append"
10251 #: ../src/guestfs-actions.pod:1889
10255 " guestfs_get_append (guestfs_h *g);\n"
10261 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
10263 "Return the additional kernel options which are added to the guest kernel "
10269 #: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1294
10270 msgid "If C<NULL> then no options are added."
10275 #: ../src/guestfs-actions.pod:1897
10277 "This function returns a string which may be NULL. There is no way to return "
10278 "an error from this function. The string is owned by the guest handle and "
10279 "must I<not> be freed."
10284 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5327
10285 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:6207
10286 #: ../src/guestfs-actions.pod:6226 ../src/guestfs-actions.pod:6242
10287 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:7016
10288 #: ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7388
10289 msgid "(Added in 1.0.26)"
10293 #: ../src/guestfs-actions.pod:1903
10294 msgid "guestfs_get_attach_method"
10298 #: ../src/guestfs-actions.pod:1905
10302 " guestfs_get_attach_method (guestfs_h *g);\n"
10307 #: ../src/guestfs-actions.pod:1908
10308 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10313 #: ../src/guestfs-actions.pod:1913
10314 msgid "guestfs_get_autosync"
10319 #: ../src/guestfs-actions.pod:1915
10323 " guestfs_get_autosync (guestfs_h *g);\n"
10329 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1306
10330 msgid "Get the autosync flag."
10335 #: ../src/guestfs-actions.pod:1924
10336 msgid "guestfs_get_direct"
10341 #: ../src/guestfs-actions.pod:1926
10345 " guestfs_get_direct (guestfs_h *g);\n"
10351 #: ../src/guestfs-actions.pod:1929 ../fish/guestfish-actions.pod:1312
10352 msgid "Return the direct appliance mode flag."
10357 #: ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:5876
10358 msgid "(Added in 1.0.72)"
10363 #: ../src/guestfs-actions.pod:1935
10364 msgid "guestfs_get_e2label"
10369 #: ../src/guestfs-actions.pod:1937
10373 " guestfs_get_e2label (guestfs_h *g,\n"
10374 " const char *device);\n"
10380 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1318
10382 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10387 #: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1321
10389 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10394 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:1975
10395 #: ../src/guestfs-actions.pod:5894 ../src/guestfs-actions.pod:5913
10396 msgid "(Added in 1.0.15)"
10401 #: ../src/guestfs-actions.pod:1956
10402 msgid "guestfs_get_e2uuid"
10407 #: ../src/guestfs-actions.pod:1958
10411 " guestfs_get_e2uuid (guestfs_h *g,\n"
10412 " const char *device);\n"
10418 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1332
10420 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10425 #: ../src/guestfs-actions.pod:1968 ../fish/guestfish-actions.pod:1335
10427 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10432 #: ../src/guestfs-actions.pod:1977
10433 msgid "guestfs_get_memsize"
10438 #: ../src/guestfs-actions.pod:1979
10442 " guestfs_get_memsize (guestfs_h *g);\n"
10448 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1346
10450 "This gets the memory size in megabytes allocated to the qemu subprocess."
10455 #: ../src/guestfs-actions.pod:1985
10457 "If C<guestfs_set_memsize> was not called on this handle, and if "
10458 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10459 "value for memsize."
10464 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2070
10465 #: ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:6036
10466 #: ../fish/guestfish-actions.pod:1353 ../fish/guestfish-actions.pod:1404
10467 #: ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4085
10469 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10474 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:4397
10475 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4613
10476 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4644
10477 #: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4674
10478 #: ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5934
10479 #: ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6782
10480 msgid "(Added in 1.0.55)"
10485 #: ../src/guestfs-actions.pod:1996
10486 msgid "guestfs_get_network"
10491 #: ../src/guestfs-actions.pod:1998
10495 " guestfs_get_network (guestfs_h *g);\n"
10501 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1360
10502 msgid "This returns the enable network flag."
10507 #: ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:5953
10508 msgid "(Added in 1.5.4)"
10513 #: ../src/guestfs-actions.pod:2007
10514 msgid "guestfs_get_path"
10519 #: ../src/guestfs-actions.pod:2009
10523 " guestfs_get_path (guestfs_h *g);\n"
10529 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1366
10530 msgid "Return the current search path."
10535 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1368
10537 "This is always non-NULL. If it wasn't set already, then this will return "
10538 "the default path."
10543 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2046
10545 "This function returns a string, or NULL on error. The string is owned by "
10546 "the guest handle and must I<not> be freed."
10551 #: ../src/guestfs-actions.pod:2022
10552 msgid "guestfs_get_pid"
10557 #: ../src/guestfs-actions.pod:2024
10561 " guestfs_get_pid (guestfs_h *g);\n"
10567 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
10569 "Return the process ID of the qemu subprocess. If there is no qemu "
10570 "subprocess, then this will return an error."
10575 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1380
10576 msgid "This is an internal call used for debugging and testing."
10581 #: ../src/guestfs-actions.pod:2034
10582 msgid "(Added in 1.0.56)"
10587 #: ../src/guestfs-actions.pod:2036
10588 msgid "guestfs_get_qemu"
10593 #: ../src/guestfs-actions.pod:2038
10597 " guestfs_get_qemu (guestfs_h *g);\n"
10603 #: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1386
10604 msgid "Return the current qemu binary."
10609 #: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1388
10611 "This is always non-NULL. If it wasn't set already, then this will return "
10612 "the default qemu binary name."
10617 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:5998
10618 msgid "(Added in 1.0.6)"
10623 #: ../src/guestfs-actions.pod:2051
10624 msgid "guestfs_get_recovery_proc"
10629 #: ../src/guestfs-actions.pod:2053
10633 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10639 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1395
10640 msgid "Return the recovery process enabled flag."
10645 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3507
10646 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:4204
10647 #: ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:5257
10648 #: ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6022
10649 #: ../src/guestfs-actions.pod:6685 ../src/guestfs-actions.pod:6705
10650 #: ../src/guestfs-actions.pod:6897
10651 msgid "(Added in 1.0.77)"
10656 #: ../src/guestfs-actions.pod:2062
10657 msgid "guestfs_get_selinux"
10662 #: ../src/guestfs-actions.pod:2064
10666 " guestfs_get_selinux (guestfs_h *g);\n"
10672 #: ../src/guestfs-actions.pod:2067
10674 "This returns the current setting of the selinux flag which is passed to the "
10675 "appliance at boot time. See C<guestfs_set_selinux>."
10680 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2138
10681 #: ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6099
10682 msgid "(Added in 1.0.67)"
10687 #: ../src/guestfs-actions.pod:2077
10688 msgid "guestfs_get_state"
10693 #: ../src/guestfs-actions.pod:2079
10697 " guestfs_get_state (guestfs_h *g);\n"
10703 #: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1411
10705 "This returns the current state as an opaque integer. This is only useful "
10706 "for printing debug and internal error messages."
10711 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
10712 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
10713 #: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:1414
10714 #: ../fish/guestfish-actions.pod:2328 ../fish/guestfish-actions.pod:2346
10715 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2400
10716 msgid "For more information on states, see L<guestfs(3)>."
10721 #: ../src/guestfs-actions.pod:2091
10722 msgid "guestfs_get_trace"
10727 #: ../src/guestfs-actions.pod:2093
10731 " guestfs_get_trace (guestfs_h *g);\n"
10737 #: ../src/guestfs-actions.pod:2096 ../fish/guestfish-actions.pod:1420
10738 msgid "Return the command trace flag."
10743 #: ../src/guestfs-actions.pod:2102
10744 msgid "guestfs_get_umask"
10749 #: ../src/guestfs-actions.pod:2104
10753 " guestfs_get_umask (guestfs_h *g);\n"
10759 #: ../src/guestfs-actions.pod:2107
10761 "Return the current umask. By default the umask is C<022> unless it has been "
10762 "set by calling C<guestfs_umask>."
10767 #: ../src/guestfs-actions.pod:2114
10768 msgid "guestfs_get_verbose"
10773 #: ../src/guestfs-actions.pod:2116
10777 " guestfs_get_verbose (guestfs_h *g);\n"
10783 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1433
10784 msgid "This returns the verbose messages flag."
10789 #: ../src/guestfs-actions.pod:2125
10790 msgid "guestfs_getcon"
10795 #: ../src/guestfs-actions.pod:2127
10799 " guestfs_getcon (guestfs_h *g);\n"
10805 #: ../src/guestfs-actions.pod:2130 ../fish/guestfish-actions.pod:1439
10806 msgid "This gets the SELinux security context of the daemon."
10811 #: ../src/guestfs-actions.pod:2132
10813 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10818 #: ../src/guestfs-actions.pod:2140
10819 msgid "guestfs_getxattr"
10824 #: ../src/guestfs-actions.pod:2142
10828 " guestfs_getxattr (guestfs_h *g,\n"
10829 " const char *path,\n"
10830 " const char *name,\n"
10831 " size_t *size_r);\n"
10837 #: ../src/guestfs-actions.pod:2148
10839 "Get a single extended attribute from file C<path> named C<name>. This call "
10840 "follows symlinks. If you want to lookup an extended attribute for the "
10841 "symlink itself, use C<guestfs_lgetxattr>."
10846 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3521
10848 "Normally it is better to get all extended attributes from a file in one go "
10849 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10850 "implementations are buggy and do not provide a way to list out attributes. "
10851 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10852 "extended attributes you want in advance and call this function."
10857 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
10858 #: ../fish/guestfish-actions.pod:1459 ../fish/guestfish-actions.pod:2465
10860 "Extended attribute values are blobs of binary data. If there is no extended "
10861 "attribute named C<name>, this returns an error."
10866 #: ../src/guestfs-actions.pod:2162
10867 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10872 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2355
10873 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:5250
10874 #: ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5457
10876 "This function returns a buffer, or NULL on error. The size of the returned "
10877 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10882 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:3537
10883 msgid "(Added in 1.7.24)"
10888 #: ../src/guestfs-actions.pod:2170
10889 msgid "guestfs_getxattrs"
10894 #: ../src/guestfs-actions.pod:2172
10897 " struct guestfs_xattr_list *\n"
10898 " guestfs_getxattrs (guestfs_h *g,\n"
10899 " const char *path);\n"
10905 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
10907 "This call lists the extended attributes of the file or directory C<path>."
10912 #: ../src/guestfs-actions.pod:2179 ../fish/guestfish-actions.pod:1471
10914 "At the system call level, this is a combination of the L<listxattr(2)> and "
10915 "L<getxattr(2)> calls."
10920 #: ../src/guestfs-actions.pod:2182
10921 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10926 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
10927 #: ../src/guestfs-actions.pod:4200
10929 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10930 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10935 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3553
10936 #: ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754
10937 #: ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:6118
10938 #: ../src/guestfs-actions.pod:7453
10939 msgid "(Added in 1.0.59)"
10944 #: ../src/guestfs-actions.pod:2190
10945 msgid "guestfs_glob_expand"
10950 #: ../src/guestfs-actions.pod:2192
10954 " guestfs_glob_expand (guestfs_h *g,\n"
10955 " const char *pattern);\n"
10961 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1480
10963 "This command searches for all the pathnames matching C<pattern> according to "
10964 "the wildcard expansion rules used by the shell."
10969 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
10971 "If no paths match, then this returns an empty list (note: not an error)."
10976 #: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1487
10978 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10979 "GLOB_BRACE>. See that manual page for more details."
10984 #: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:6283
10985 #: ../src/guestfs-actions.pod:6300
10986 msgid "(Added in 1.0.50)"
10991 #: ../src/guestfs-actions.pod:2213
10992 msgid "guestfs_grep"
10997 #: ../src/guestfs-actions.pod:2215
11001 " guestfs_grep (guestfs_h *g,\n"
11002 " const char *regex,\n"
11003 " const char *path);\n"
11009 #: ../src/guestfs-actions.pod:2220 ../fish/guestfish-actions.pod:1495
11010 msgid "This calls the external C<grep> program and returns the matching lines."
11015 #: ../src/guestfs-actions.pod:2232
11016 msgid "guestfs_grepi"
11021 #: ../src/guestfs-actions.pod:2234
11025 " guestfs_grepi (guestfs_h *g,\n"
11026 " const char *regex,\n"
11027 " const char *path);\n"
11033 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1505
11035 "This calls the external C<grep -i> program and returns the matching lines."
11040 #: ../src/guestfs-actions.pod:2251
11041 msgid "guestfs_grub_install"
11046 #: ../src/guestfs-actions.pod:2253
11050 " guestfs_grub_install (guestfs_h *g,\n"
11051 " const char *root,\n"
11052 " const char *device);\n"
11058 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
11060 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11061 "the root directory being C<root>."
11066 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1518
11068 "Note: If grub-install reports the error \"No suitable drive was found in the "
11069 "generated device map.\" it may be that you need to create a C</boot/grub/"
11070 "device.map> file first that contains the mapping between grub device names "
11071 "and Linux device names. It is usually sufficient to create a file "
11077 #: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1525
11080 " (hd0) /dev/vda\n"
11086 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1527
11087 msgid "replacing C</dev/vda> with the name of the installation device."
11092 #: ../src/guestfs-actions.pod:2274
11093 msgid "(Added in 1.0.17)"
11098 #: ../src/guestfs-actions.pod:2276
11099 msgid "guestfs_head"
11104 #: ../src/guestfs-actions.pod:2278
11108 " guestfs_head (guestfs_h *g,\n"
11109 " const char *path);\n"
11115 #: ../src/guestfs-actions.pod:2282 ../fish/guestfish-actions.pod:1533
11117 "This command returns up to the first 10 lines of a file as a list of strings."
11122 #: ../src/guestfs-actions.pod:2294
11123 msgid "guestfs_head_n"
11128 #: ../src/guestfs-actions.pod:2296
11132 " guestfs_head_n (guestfs_h *g,\n"
11134 " const char *path);\n"
11140 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
11142 "If the parameter C<nrlines> is a positive number, this returns the first "
11143 "C<nrlines> lines of the file C<path>."
11148 #: ../src/guestfs-actions.pod:2304 ../fish/guestfish-actions.pod:1546
11150 "If the parameter C<nrlines> is a negative number, this returns lines from "
11151 "the file C<path>, excluding the last C<nrlines> lines."
11156 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:6580
11157 #: ../fish/guestfish-actions.pod:1549 ../fish/guestfish-actions.pod:4435
11158 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11163 #: ../src/guestfs-actions.pod:2318
11164 msgid "guestfs_hexdump"
11169 #: ../src/guestfs-actions.pod:2320
11173 " guestfs_hexdump (guestfs_h *g,\n"
11174 " const char *path);\n"
11180 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1558
11182 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11183 "readable, canonical hex dump of the file."
11188 #: ../src/guestfs-actions.pod:2333 ../src/guestfs-actions.pod:6364
11189 #: ../src/guestfs-actions.pod:6419
11190 msgid "(Added in 1.0.22)"
11195 #: ../src/guestfs-actions.pod:2335
11196 msgid "guestfs_initrd_cat"
11201 #: ../src/guestfs-actions.pod:2337
11205 " guestfs_initrd_cat (guestfs_h *g,\n"
11206 " const char *initrdpath,\n"
11207 " const char *filename,\n"
11208 " size_t *size_r);\n"
11214 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1568
11216 "This command unpacks the file C<filename> from the initrd file called "
11217 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11223 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1572
11225 "For example, in guestfish you could use the following command to examine the "
11226 "boot script (usually called C</init>) contained in a Linux initrd or "
11232 #: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1576
11235 " initrd-cat /boot/initrd-<version>.img init\n"
11241 #: ../src/guestfs-actions.pod:2353
11242 msgid "See also C<guestfs_initrd_list>."
11247 #: ../src/guestfs-actions.pod:2364
11248 msgid "guestfs_initrd_list"
11253 #: ../src/guestfs-actions.pod:2366
11257 " guestfs_initrd_list (guestfs_h *g,\n"
11258 " const char *path);\n"
11264 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1587
11265 msgid "This command lists out files contained in an initrd."
11270 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1589
11272 "The files are listed without any initial C</> character. The files are "
11273 "listed in the order they appear (not necessarily alphabetical). Directory "
11274 "names are listed as separate items."
11279 #: ../src/guestfs-actions.pod:2376 ../fish/guestfish-actions.pod:1593
11281 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11282 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11288 #: ../src/guestfs-actions.pod:2386
11289 msgid "guestfs_inotify_add_watch"
11294 #: ../src/guestfs-actions.pod:2388
11298 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11299 " const char *path,\n"
11306 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1601
11307 msgid "Watch C<path> for the events listed in C<mask>."
11312 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1603
11314 "Note that if C<path> is a directory then events within that directory are "
11315 "watched, but this does I<not> happen recursively (in subdirectories)."
11320 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1607
11322 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11323 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11328 #: ../src/guestfs-actions.pod:2407
11329 msgid "guestfs_inotify_close"
11334 #: ../src/guestfs-actions.pod:2409
11338 " guestfs_inotify_close (guestfs_h *g);\n"
11344 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1615
11346 "This closes the inotify handle which was previously opened by inotify_init. "
11347 "It removes all watches, throws away any pending events, and deallocates all "
11353 #: ../src/guestfs-actions.pod:2420
11354 msgid "guestfs_inotify_files"
11359 #: ../src/guestfs-actions.pod:2422
11363 " guestfs_inotify_files (guestfs_h *g);\n"
11369 #: ../src/guestfs-actions.pod:2425
11371 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11372 "returns a list of pathnames of objects that were touched. The returned "
11373 "pathnames are sorted and deduplicated."
11378 #: ../src/guestfs-actions.pod:2435
11379 msgid "guestfs_inotify_init"
11384 #: ../src/guestfs-actions.pod:2437
11388 " guestfs_inotify_init (guestfs_h *g,\n"
11389 " int maxevents);\n"
11395 #: ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1631
11397 "This command creates a new inotify handle. The inotify subsystem can be "
11398 "used to notify events which happen to objects in the guest filesystem."
11403 #: ../src/guestfs-actions.pod:2445
11405 "C<maxevents> is the maximum number of events which will be queued up between "
11406 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11407 "passed as C<0>, then the kernel (or previously set) default is used. For "
11408 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11409 "throws away events, but records the fact that it threw them away by setting "
11410 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11411 "C<guestfs_inotify_read>)."
11416 #: ../src/guestfs-actions.pod:2455
11418 "Before any events are generated, you have to add some watches to the "
11419 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11420 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11425 #: ../src/guestfs-actions.pod:2461
11427 "Queued up events should be read periodically by calling "
11428 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11429 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11430 "often enough then you risk the internal queue overflowing."
11435 #: ../src/guestfs-actions.pod:2468
11437 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11438 "This also removes any watches automatically."
11443 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1662
11445 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11446 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11447 "that there is one global inotify handle per libguestfs instance."
11452 #: ../src/guestfs-actions.pod:2481
11453 msgid "guestfs_inotify_read"
11458 #: ../src/guestfs-actions.pod:2483
11461 " struct guestfs_inotify_event_list *\n"
11462 " guestfs_inotify_read (guestfs_h *g);\n"
11468 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
11470 "Return the complete queue of events that have happened since the previous "
11476 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1674
11477 msgid "If no events have happened, this returns an empty list."
11482 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
11484 "I<Note>: In order to make sure that all events have been read, you must call "
11485 "this function repeatedly until it returns an empty list. The reason is that "
11486 "the call will read events up to the maximum appliance-to-host message size "
11487 "and leave remaining events in the queue."
11492 #: ../src/guestfs-actions.pod:2497
11494 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11495 "there was an error. I<The caller must call "
11496 "C<guestfs_free_inotify_event_list> after use>."
11501 #: ../src/guestfs-actions.pod:2503
11502 msgid "guestfs_inotify_rm_watch"
11507 #: ../src/guestfs-actions.pod:2505
11511 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11518 #: ../src/guestfs-actions.pod:2509
11520 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11525 #: ../src/guestfs-actions.pod:2516
11526 msgid "guestfs_inspect_get_arch"
11531 #: ../src/guestfs-actions.pod:2518
11535 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11536 " const char *root);\n"
11542 #: ../src/guestfs-actions.pod:2522 ../src/guestfs-actions.pod:2545
11543 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2682
11544 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2747
11545 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2796
11546 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860
11547 #: ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2920
11548 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2999
11549 #: ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3062
11550 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
11551 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3138
11553 "This function should only be called with a root device string as returned by "
11554 "C<guestfs_inspect_os>."
11559 #: ../src/guestfs-actions.pod:2525
11561 "This returns the architecture of the inspected operating system. The "
11562 "possible return values are listed under C<guestfs_file_architecture>."
11567 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1700
11569 "If the architecture could not be determined, then the string C<unknown> is "
11575 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2625
11576 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:2756
11577 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2876
11578 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2931
11579 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3028
11580 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
11581 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3109
11582 #: ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3231
11583 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:1703
11584 #: ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1877
11585 #: ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1913
11586 #: ../fish/guestfish-actions.pod:1983 ../fish/guestfish-actions.pod:2007
11587 #: ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2067
11588 #: ../fish/guestfish-actions.pod:2102 ../fish/guestfish-actions.pod:2118
11589 #: ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147
11590 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2175
11591 #: ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2308
11592 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11597 #: ../src/guestfs-actions.pod:2539
11598 msgid "guestfs_inspect_get_distro"
11603 #: ../src/guestfs-actions.pod:2541
11607 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11608 " const char *root);\n"
11614 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
11616 "This returns the distro (distribution) of the inspected operating system."
11621 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1715
11622 msgid "Currently defined distros are:"
11627 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1719
11628 msgid "\"archlinux\""
11633 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1721
11634 msgid "Arch Linux."
11638 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1723
11643 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1725
11649 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1727
11655 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1729
11661 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1731
11667 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1733
11673 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1735
11679 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1737
11685 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1739
11686 msgid "\"linuxmint\""
11691 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1741
11692 msgid "Linux Mint."
11697 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1743
11698 msgid "\"mandriva\""
11703 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1745
11709 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1747
11715 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1749
11721 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1751
11727 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1753
11733 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1755
11734 msgid "\"redhat-based\""
11739 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1757
11740 msgid "Some Red Hat-derived distro."
11745 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1759
11750 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1761
11751 msgid "Red Hat Enterprise Linux."
11755 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1763
11756 msgid "\"scientificlinux\""
11760 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1765
11761 msgid "Scientific Linux."
11765 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1767
11766 msgid "\"slackware\""
11770 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1769
11776 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1771
11782 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1773
11788 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2727
11789 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1775
11790 #: ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:2093
11791 msgid "\"unknown\""
11796 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1777
11797 msgid "The distro could not be determined."
11802 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3011
11803 #: ../fish/guestfish-actions.pod:1779 ../fish/guestfish-actions.pod:2085
11804 msgid "\"windows\""
11809 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1781
11811 "Windows does not have distributions. This string is returned if the OS type "
11817 #: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733
11818 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:1786
11819 #: ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:2099
11821 "Future versions of libguestfs may return other strings here. The caller "
11822 "should be prepared to handle any string."
11826 #: ../src/guestfs-actions.pod:2632
11827 msgid "guestfs_inspect_get_drive_mappings"
11831 #: ../src/guestfs-actions.pod:2634
11835 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11836 " const char *root);\n"
11841 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1798
11843 "This call is useful for Windows which uses a primitive system of assigning "
11844 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11845 "Windows Registry to find out how disks/partitions are mapped to drive "
11846 "letters, and returns a hash table as in the example below:"
11850 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
11853 " C => /dev/vda2\n"
11854 " E => /dev/vdb1\n"
11855 " F => /dev/vdc1\n"
11860 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
11862 "Note that keys are drive letters. For Windows, the key is case insensitive "
11863 "and just contains the drive letter, without the customary colon separator "
11868 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1812
11870 "In future we may support other operating systems that also used drive "
11871 "letters, but the keys for those might not be case insensitive and might be "
11872 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11877 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
11879 "For Windows guests, currently only hard drive mappings are returned. "
11880 "Removable disks (eg. DVD-ROMs) are ignored."
11884 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1820
11886 "For guests that do not use drive mappings, or if the drive mappings could "
11887 "not be determined, this returns an empty hash table."
11891 #: ../src/guestfs-actions.pod:2666
11893 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11894 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11899 #: ../src/guestfs-actions.pod:2670 ../src/guestfs-actions.pod:2846
11900 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:4816
11901 #: ../src/guestfs-actions.pod:6721
11903 "This function returns a NULL-terminated array of strings, or NULL if there "
11904 "was an error. The array of strings will always have length C<2n+1>, where "
11905 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11906 "caller must free the strings and the array after use>."
11911 #: ../src/guestfs-actions.pod:2676
11912 msgid "guestfs_inspect_get_filesystems"
11917 #: ../src/guestfs-actions.pod:2678
11921 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11922 " const char *root);\n"
11928 #: ../src/guestfs-actions.pod:2685 ../fish/guestfish-actions.pod:1834
11930 "This returns a list of all the filesystems that we think are associated with "
11931 "this operating system. This includes the root filesystem, other ordinary "
11932 "filesystems, and non-mounted devices like swap partitions."
11937 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1839
11939 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11940 "to be shared between operating systems."
11945 #: ../src/guestfs-actions.pod:2693
11947 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11948 "C<guestfs_inspect_get_mountpoints>."
11952 #: ../src/guestfs-actions.pod:2702
11953 msgid "guestfs_inspect_get_format"
11957 #: ../src/guestfs-actions.pod:2704
11961 " guestfs_inspect_get_format (guestfs_h *g,\n"
11962 " const char *root);\n"
11967 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
11969 "This returns the format of the inspected operating system. You can use it "
11970 "to detect install images, live CDs and similar."
11974 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1855
11975 msgid "Currently defined formats are:"
11979 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1859
11980 msgid "\"installed\""
11984 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
11985 msgid "This is an installed operating system."
11989 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1863
11990 msgid "\"installer\""
11994 #: ../src/guestfs-actions.pod:2724 ../fish/guestfish-actions.pod:1865
11996 "The disk image being inspected is not an installed operating system, but a "
11997 "I<bootable> install disk, live CD, or similar."
12001 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
12002 msgid "The format of this disk image is not known."
12007 #: ../src/guestfs-actions.pod:2741
12008 msgid "guestfs_inspect_get_hostname"
12013 #: ../src/guestfs-actions.pod:2743
12017 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12018 " const char *root);\n"
12024 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
12026 "This function returns the hostname of the operating system as found by "
12027 "inspection of the guest's configuration files."
12032 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1889
12034 "If the hostname could not be determined, then the string C<unknown> is "
12040 #: ../src/guestfs-actions.pod:2761
12041 msgid "(Added in 1.7.9)"
12046 #: ../src/guestfs-actions.pod:2763
12047 msgid "guestfs_inspect_get_major_version"
12052 #: ../src/guestfs-actions.pod:2765
12056 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12057 " const char *root);\n"
12063 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
12065 "This returns the major version number of the inspected operating system."
12070 #: ../src/guestfs-actions.pod:2775 ../fish/guestfish-actions.pod:1904
12072 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12073 "popular public names used by the operating system. Notably the operating "
12074 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12075 "1). You can find out the real versions corresponding to releases of Windows "
12076 "by consulting Wikipedia or MSDN."
12081 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2802
12082 #: ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1925
12083 msgid "If the version could not be determined, then C<0> is returned."
12088 #: ../src/guestfs-actions.pod:2790
12089 msgid "guestfs_inspect_get_minor_version"
12094 #: ../src/guestfs-actions.pod:2792
12098 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12099 " const char *root);\n"
12105 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1922
12107 "This returns the minor version number of the inspected operating system."
12112 #: ../src/guestfs-actions.pod:2804
12114 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12115 "C<guestfs_inspect_get_major_version>."
12120 #: ../src/guestfs-actions.pod:2811
12121 msgid "guestfs_inspect_get_mountpoints"
12126 #: ../src/guestfs-actions.pod:2813
12130 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12131 " const char *root);\n"
12136 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1937
12138 "This returns a hash of where we think the filesystems associated with this "
12139 "operating system should be mounted. Callers should note that this is at "
12140 "best an educated guess made by reading configuration files such as C</etc/"
12141 "fstab>. I<In particular note> that this may return filesystems which are "
12142 "non-existent or not mountable and callers should be prepared to handle or "
12143 "ignore failures if they try to mount them."
12148 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1946
12150 "Each element in the returned hashtable has a key which is the path of the "
12151 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12152 "mounted there (eg. C</dev/sda1>)."
12157 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1951
12159 "Non-mounted devices such as swap devices are I<not> returned in this list."
12163 #: ../src/guestfs-actions.pod:2837
12165 "For operating systems like Windows which still use drive letters, this call "
12166 "will only return an entry for the first drive \"mounted on\" C</>. For "
12167 "information about the mapping of drive letters to partitions, see "
12168 "C<guestfs_inspect_get_drive_mappings>."
12173 #: ../src/guestfs-actions.pod:2843
12175 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12176 "C<guestfs_inspect_get_filesystems>."
12181 #: ../src/guestfs-actions.pod:2854
12182 msgid "guestfs_inspect_get_package_format"
12187 #: ../src/guestfs-actions.pod:2856
12191 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12192 " const char *root);\n"
12198 #: ../src/guestfs-actions.pod:2863
12200 "This function and C<guestfs_inspect_get_package_management> return the "
12201 "package format and package management tool used by the inspected operating "
12202 "system. For example for Fedora these functions would return C<rpm> (package "
12203 "format) and C<yum> (package management)."
12208 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1976
12210 "This returns the string C<unknown> if we could not determine the package "
12211 "format I<or> if the operating system does not have a real packaging system "
12217 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1980
12219 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12220 "Future versions of libguestfs may return other strings."
12225 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:2912
12226 msgid "(Added in 1.7.5)"
12231 #: ../src/guestfs-actions.pod:2883
12232 msgid "guestfs_inspect_get_package_management"
12237 #: ../src/guestfs-actions.pod:2885
12241 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12242 " const char *root);\n"
12248 #: ../src/guestfs-actions.pod:2892
12250 "C<guestfs_inspect_get_package_format> and this function return the package "
12251 "format and package management tool used by the inspected operating system. "
12252 "For example for Fedora these functions would return C<rpm> (package format) "
12253 "and C<yum> (package management)."
12258 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1998
12260 "This returns the string C<unknown> if we could not determine the package "
12261 "management tool I<or> if the operating system does not have a real packaging "
12262 "system (eg. Windows)."
12267 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2002
12269 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12270 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12271 "libguestfs may return other strings."
12276 #: ../src/guestfs-actions.pod:2914
12277 msgid "guestfs_inspect_get_product_name"
12282 #: ../src/guestfs-actions.pod:2916
12286 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12287 " const char *root);\n"
12293 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2016
12295 "This returns the product name of the inspected operating system. The "
12296 "product name is generally some freeform string which can be displayed to the "
12297 "user, but should not be parsed by programs."
12302 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2021
12304 "If the product name could not be determined, then the string C<unknown> is "
12309 #: ../src/guestfs-actions.pod:2938
12310 msgid "guestfs_inspect_get_product_variant"
12314 #: ../src/guestfs-actions.pod:2940
12318 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12319 " const char *root);\n"
12324 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
12325 msgid "This returns the product variant of the inspected operating system."
12329 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2036
12331 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12332 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12333 "is usually a string such as C<Client> or C<Server> (other values are "
12334 "possible). This can be used to distinguish consumer and enterprise versions "
12335 "of Windows that have the same version number (for example, Windows 7 and "
12336 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12337 "the latter is C<Server>)."
12341 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2045
12343 "For enterprise Linux guests, in future we intend this to return the product "
12344 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12345 "implemented at present."
12349 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2049
12351 "If the product variant could not be determined, then the string C<unknown> "
12356 #: ../src/guestfs-actions.pod:2966
12358 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12359 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12364 #: ../src/guestfs-actions.pod:2973
12365 msgid "guestfs_inspect_get_roots"
12370 #: ../src/guestfs-actions.pod:2975
12374 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12380 #: ../src/guestfs-actions.pod:2978
12382 "This function is a convenient way to get the list of root devices, as "
12383 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12384 "the whole inspection process."
12389 #: ../src/guestfs-actions.pod:2982
12391 "This returns an empty list if either no root devices were found or the "
12392 "caller has not called C<guestfs_inspect_os>."
12397 #: ../src/guestfs-actions.pod:2991
12398 msgid "(Added in 1.7.3)"
12403 #: ../src/guestfs-actions.pod:2993
12404 msgid "guestfs_inspect_get_type"
12409 #: ../src/guestfs-actions.pod:2995
12413 " guestfs_inspect_get_type (guestfs_h *g,\n"
12414 " const char *root);\n"
12420 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2076
12422 "This returns the type of the inspected operating system. Currently defined "
12428 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2081
12434 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2083
12435 msgid "Any Linux-based operating system."
12440 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2087
12441 msgid "Any Microsoft Windows operating system."
12446 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2089
12447 msgid "\"freebsd\""
12452 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2091
12458 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2095
12459 msgid "The operating system type could not be determined."
12463 #: ../src/guestfs-actions.pod:3035
12464 msgid "guestfs_inspect_get_windows_current_control_set"
12468 #: ../src/guestfs-actions.pod:3037
12472 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12473 " const char *root);\n"
12478 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
12480 "This returns the Windows CurrentControlSet of the inspected guest. The "
12481 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12485 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2114
12487 "This call assumes that the guest is Windows and that the Registry could be "
12488 "examined by inspection. If this is not the case then an error is returned."
12493 #: ../src/guestfs-actions.pod:3056
12494 msgid "guestfs_inspect_get_windows_systemroot"
12499 #: ../src/guestfs-actions.pod:3058
12503 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12504 " const char *root);\n"
12510 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
12512 "This returns the Windows systemroot of the inspected guest. The systemroot "
12513 "is a directory path such as C</WINDOWS>."
12518 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
12520 "This call assumes that the guest is Windows and that the systemroot could be "
12521 "determined by inspection. If this is not the case then an error is returned."
12526 #: ../src/guestfs-actions.pod:3077
12527 msgid "(Added in 1.5.25)"
12531 #: ../src/guestfs-actions.pod:3079
12532 msgid "guestfs_inspect_is_live"
12536 #: ../src/guestfs-actions.pod:3081
12540 " guestfs_inspect_is_live (guestfs_h *g,\n"
12541 " const char *root);\n"
12546 #: ../src/guestfs-actions.pod:3088
12548 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12549 "disk), then this returns true if a live image was detected on the disk."
12553 #: ../src/guestfs-actions.pod:3096
12554 msgid "guestfs_inspect_is_multipart"
12558 #: ../src/guestfs-actions.pod:3098
12562 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12563 " const char *root);\n"
12568 #: ../src/guestfs-actions.pod:3105
12570 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12571 "disk), then this returns true if the disk is part of a set."
12575 #: ../src/guestfs-actions.pod:3113
12576 msgid "guestfs_inspect_is_netinst"
12580 #: ../src/guestfs-actions.pod:3115
12584 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12585 " const char *root);\n"
12590 #: ../src/guestfs-actions.pod:3122
12592 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12593 "disk), then this returns true if the disk is a network installer, ie. not a "
12594 "self-contained install CD but one which is likely to require network access "
12595 "to complete the install."
12600 #: ../src/guestfs-actions.pod:3132
12601 msgid "guestfs_inspect_list_applications"
12606 #: ../src/guestfs-actions.pod:3134
12609 " struct guestfs_application_list *\n"
12610 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12611 " const char *root);\n"
12617 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2184
12618 msgid "Return the list of applications installed in the operating system."
12623 #: ../src/guestfs-actions.pod:3143
12625 "I<Note:> This call works differently from other parts of the inspection "
12626 "API. You have to call C<guestfs_inspect_os>, then "
12627 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12628 "this. Listing applications is a significantly more difficult operation "
12629 "which requires access to the full filesystem. Also note that unlike the "
12630 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12631 "the libguestfs handle, this call actually reads parts of the mounted "
12632 "filesystems during the call."
12637 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
12639 "This returns an empty list if the inspection code was not able to determine "
12640 "the list of applications."
12645 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2199
12646 msgid "The application structure contains the following fields:"
12651 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2203
12652 msgid "C<app_name>"
12657 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
12659 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12660 "guests, this is the package name."
12665 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2208
12666 msgid "C<app_display_name>"
12671 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
12673 "The display name of the application, sometimes localized to the install "
12674 "language of the guest operating system."
12679 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
12681 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12682 "to display something can use C<app_name> instead."
12687 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2216
12688 msgid "C<app_epoch>"
12693 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
12695 "For package managers which use epochs, this contains the epoch of the "
12696 "package (an integer). If unavailable, this is returned as C<0>."
12701 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2221
12702 msgid "C<app_version>"
12707 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
12709 "The version string of the application or package. If unavailable this is "
12710 "returned as an empty string C<\"\">."
12715 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2226
12716 msgid "C<app_release>"
12721 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2228
12723 "The release string of the application or package, for package managers that "
12724 "use this. If unavailable this is returned as an empty string C<\"\">."
12729 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2232
12730 msgid "C<app_install_path>"
12735 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2234
12737 "The installation path of the application (on operating systems such as "
12738 "Windows which use installation paths). This path is in the format used by "
12739 "the guest operating system, it is not a libguestfs path."
12744 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2239
12745 msgid "If unavailable this is returned as an empty string C<\"\">."
12750 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2241
12751 msgid "C<app_trans_path>"
12756 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
12758 "The install path translated into a libguestfs path. If unavailable this is "
12759 "returned as an empty string C<\"\">."
12764 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2246
12765 msgid "C<app_publisher>"
12770 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2248
12772 "The name of the publisher of the application, for package managers that use "
12773 "this. If unavailable this is returned as an empty string C<\"\">."
12778 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2252
12784 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
12786 "The URL (eg. upstream URL) of the application. If unavailable this is "
12787 "returned as an empty string C<\"\">."
12792 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2257
12793 msgid "C<app_source_package>"
12798 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
12800 "For packaging systems which support this, the name of the source package. "
12801 "If unavailable this is returned as an empty string C<\"\">."
12806 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2262
12807 msgid "C<app_summary>"
12812 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
12814 "A short (usually one line) description of the application or package. If "
12815 "unavailable this is returned as an empty string C<\"\">."
12820 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2267
12821 msgid "C<app_description>"
12826 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2269
12828 "A longer description of the application or package. If unavailable this is "
12829 "returned as an empty string C<\"\">."
12834 #: ../src/guestfs-actions.pod:3233
12836 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12837 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12843 #: ../src/guestfs-actions.pod:3237
12844 msgid "(Added in 1.7.8)"
12849 #: ../src/guestfs-actions.pod:3239
12850 msgid "guestfs_inspect_os"
12855 #: ../src/guestfs-actions.pod:3241
12859 " guestfs_inspect_os (guestfs_h *g);\n"
12865 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2280
12867 "This function uses other libguestfs functions and certain heuristics to "
12868 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12869 "for operating systems."
12874 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2284
12875 msgid "The list returned is empty if no operating systems were found."
12880 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2286
12882 "If one operating system was found, then this returns a list with a single "
12883 "element, which is the name of the root filesystem of this operating system. "
12884 "It is also possible for this function to return a list containing more than "
12885 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12886 "element being the root filesystem of one of the operating systems."
12891 #: ../src/guestfs-actions.pod:3257
12893 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12894 "functions in order to query further information about each operating system, "
12895 "such as the name and version."
12900 #: ../src/guestfs-actions.pod:3262
12902 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12903 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12904 "the contents. This should be called with no disks currently mounted. The "
12905 "function may also use Augeas, so any existing Augeas handle will be closed."
12910 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2304
12912 "This function cannot decrypt encrypted disks. The caller must do that first "
12913 "(supplying the necessary keys) if the disk is encrypted."
12918 #: ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3564
12919 #: ../src/guestfs-actions.pod:3626
12920 msgid "See also C<guestfs_list_filesystems>."
12925 #: ../src/guestfs-actions.pod:3282
12926 msgid "guestfs_is_blockdev"
12931 #: ../src/guestfs-actions.pod:3284
12935 " guestfs_is_blockdev (guestfs_h *g,\n"
12936 " const char *path);\n"
12942 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2316
12944 "This returns C<true> if and only if there is a block device with the given "
12950 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
12951 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3365
12952 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3437
12953 #: ../src/guestfs-actions.pod:3452
12954 msgid "See also C<guestfs_stat>."
12959 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324
12960 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3441
12961 #: ../src/guestfs-actions.pod:3456
12962 msgid "(Added in 1.5.10)"
12967 #: ../src/guestfs-actions.pod:3297
12968 msgid "guestfs_is_busy"
12973 #: ../src/guestfs-actions.pod:3299
12977 " guestfs_is_busy (guestfs_h *g);\n"
12983 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2325
12985 "This returns true iff this handle is busy processing a command (in the "
12991 #: ../src/guestfs-actions.pod:3311
12992 msgid "guestfs_is_chardev"
12997 #: ../src/guestfs-actions.pod:3313
13001 " guestfs_is_chardev (guestfs_h *g,\n"
13002 " const char *path);\n"
13008 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2334
13010 "This returns C<true> if and only if there is a character device with the "
13011 "given C<path> name."
13016 #: ../src/guestfs-actions.pod:3326
13017 msgid "guestfs_is_config"
13022 #: ../src/guestfs-actions.pod:3328
13026 " guestfs_is_config (guestfs_h *g);\n"
13032 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2343
13034 "This returns true iff this handle is being configured (in the C<CONFIG> "
13040 #: ../src/guestfs-actions.pod:3340
13041 msgid "guestfs_is_dir"
13046 #: ../src/guestfs-actions.pod:3342
13050 " guestfs_is_dir (guestfs_h *g,\n"
13051 " const char *path);\n"
13057 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2352
13059 "This returns C<true> if and only if there is a directory with the given "
13060 "C<path> name. Note that it returns false for other objects like files."
13065 #: ../src/guestfs-actions.pod:3356
13066 msgid "guestfs_is_fifo"
13071 #: ../src/guestfs-actions.pod:3358
13075 " guestfs_is_fifo (guestfs_h *g,\n"
13076 " const char *path);\n"
13082 #: ../src/guestfs-actions.pod:3362 ../fish/guestfish-actions.pod:2362
13084 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13085 "given C<path> name."
13090 #: ../src/guestfs-actions.pod:3371
13091 msgid "guestfs_is_file"
13096 #: ../src/guestfs-actions.pod:3373
13100 " guestfs_is_file (guestfs_h *g,\n"
13101 " const char *path);\n"
13107 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2371
13109 "This returns C<true> if and only if there is a regular file with the given "
13110 "C<path> name. Note that it returns false for other objects like directories."
13115 #: ../src/guestfs-actions.pod:3387
13116 msgid "guestfs_is_launching"
13121 #: ../src/guestfs-actions.pod:3389
13125 " guestfs_is_launching (guestfs_h *g);\n"
13131 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2381
13133 "This returns true iff this handle is launching the subprocess (in the "
13134 "C<LAUNCHING> state)."
13139 #: ../src/guestfs-actions.pod:3401
13140 msgid "guestfs_is_lv"
13145 #: ../src/guestfs-actions.pod:3403
13149 " guestfs_is_lv (guestfs_h *g,\n"
13150 " const char *device);\n"
13156 #: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2390
13158 "This command tests whether C<device> is a logical volume, and returns true "
13159 "iff this is the case."
13164 #: ../src/guestfs-actions.pod:3414
13165 msgid "guestfs_is_ready"
13170 #: ../src/guestfs-actions.pod:3416
13174 " guestfs_is_ready (guestfs_h *g);\n"
13180 #: ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:2397
13182 "This returns true iff this handle is ready to accept commands (in the "
13188 #: ../src/guestfs-actions.pod:3428
13189 msgid "guestfs_is_socket"
13194 #: ../src/guestfs-actions.pod:3430
13198 " guestfs_is_socket (guestfs_h *g,\n"
13199 " const char *path);\n"
13205 #: ../src/guestfs-actions.pod:3434 ../fish/guestfish-actions.pod:2406
13207 "This returns C<true> if and only if there is a Unix domain socket with the "
13208 "given C<path> name."
13213 #: ../src/guestfs-actions.pod:3443
13214 msgid "guestfs_is_symlink"
13219 #: ../src/guestfs-actions.pod:3445
13223 " guestfs_is_symlink (guestfs_h *g,\n"
13224 " const char *path);\n"
13230 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2415
13232 "This returns C<true> if and only if there is a symbolic link with the given "
13238 #: ../src/guestfs-actions.pod:3458
13239 msgid "guestfs_kill_subprocess"
13244 #: ../src/guestfs-actions.pod:3460
13248 " guestfs_kill_subprocess (guestfs_h *g);\n"
13254 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2424
13255 msgid "This kills the qemu subprocess. You should never need to call this."
13260 #: ../src/guestfs-actions.pod:3469
13261 msgid "guestfs_launch"
13266 #: ../src/guestfs-actions.pod:3471
13270 " guestfs_launch (guestfs_h *g);\n"
13276 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2432
13278 "Internally libguestfs is implemented by running a virtual machine using "
13284 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2435
13286 "You should call this after configuring the handle (eg. adding drives) but "
13287 "before performing any actions."
13292 #: ../src/guestfs-actions.pod:3489
13293 msgid "guestfs_lchown"
13298 #: ../src/guestfs-actions.pod:3491
13302 " guestfs_lchown (guestfs_h *g,\n"
13305 " const char *path);\n"
13311 #: ../src/guestfs-actions.pod:3497
13313 "Change the file owner to C<owner> and group to C<group>. This is like "
13314 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13315 "changed, not the target."
13320 #: ../src/guestfs-actions.pod:3509
13321 msgid "guestfs_lgetxattr"
13326 #: ../src/guestfs-actions.pod:3511
13330 " guestfs_lgetxattr (guestfs_h *g,\n"
13331 " const char *path,\n"
13332 " const char *name,\n"
13333 " size_t *size_r);\n"
13339 #: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2454
13341 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13342 "is a symlink, then this call returns an extended attribute from the symlink."
13347 #: ../src/guestfs-actions.pod:3531
13348 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13353 #: ../src/guestfs-actions.pod:3539
13354 msgid "guestfs_lgetxattrs"
13359 #: ../src/guestfs-actions.pod:3541
13362 " struct guestfs_xattr_list *\n"
13363 " guestfs_lgetxattrs (guestfs_h *g,\n"
13364 " const char *path);\n"
13370 #: ../src/guestfs-actions.pod:3545
13372 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13373 "then it returns the extended attributes of the link itself."
13378 #: ../src/guestfs-actions.pod:3555
13379 msgid "guestfs_list_devices"
13384 #: ../src/guestfs-actions.pod:3557
13388 " guestfs_list_devices (guestfs_h *g);\n"
13394 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2482
13395 msgid "List all the block devices."
13400 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2484
13401 msgid "The full block device names are returned, eg. C</dev/sda>."
13406 #: ../src/guestfs-actions.pod:3572
13407 msgid "guestfs_list_filesystems"
13412 #: ../src/guestfs-actions.pod:3574
13416 " guestfs_list_filesystems (guestfs_h *g);\n"
13422 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2492
13424 "This inspection command looks for filesystems on partitions, block devices "
13425 "and logical volumes, returning a list of devices containing filesystems and "
13431 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2496
13433 "The return value is a hash, where the keys are the devices containing "
13434 "filesystems, and the values are the filesystem types. For example:"
13439 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2500
13442 " \"/dev/sda1\" => \"ntfs\"\n"
13443 " \"/dev/sda2\" => \"ext2\"\n"
13444 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13445 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13451 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2505
13453 "The value can have the special value \"unknown\", meaning the content of the "
13454 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13459 #: ../src/guestfs-actions.pod:3594
13461 "This command runs other libguestfs commands, which might include "
13462 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13463 "soon after launch and only when nothing is mounted."
13468 #: ../src/guestfs-actions.pod:3598
13470 "Not all of the filesystems returned will be mountable. In particular, swap "
13471 "partitions are returned in the list. Also this command does not check that "
13472 "each filesystem found is valid and mountable, and some filesystems might be "
13473 "mountable but require special options. Filesystems may not all belong to a "
13474 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13479 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:5217
13480 msgid "(Added in 1.5.15)"
13485 #: ../src/guestfs-actions.pod:3614
13486 msgid "guestfs_list_partitions"
13491 #: ../src/guestfs-actions.pod:3616
13495 " guestfs_list_partitions (guestfs_h *g);\n"
13501 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2525
13502 msgid "List all the partitions detected on all block devices."
13507 #: ../src/guestfs-actions.pod:3621 ../fish/guestfish-actions.pod:2527
13508 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13513 #: ../src/guestfs-actions.pod:3623
13515 "This does not return logical volumes. For that you will need to call "
13521 #: ../src/guestfs-actions.pod:3634
13527 #: ../src/guestfs-actions.pod:3636
13531 " guestfs_ll (guestfs_h *g,\n"
13532 " const char *directory);\n"
13538 #: ../src/guestfs-actions.pod:3640 ../fish/guestfish-actions.pod:2538
13540 "List the files in C<directory> (relative to the root directory, there is no "
13541 "cwd) in the format of 'ls -la'."
13546 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2541
13548 "This command is mostly useful for interactive sessions. It is I<not> "
13549 "intended that you try to parse the output string."
13554 #: ../src/guestfs-actions.pod:3651
13560 #: ../src/guestfs-actions.pod:3653
13564 " guestfs_ln (guestfs_h *g,\n"
13565 " const char *target,\n"
13566 " const char *linkname);\n"
13572 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2548
13573 msgid "This command creates a hard link using the C<ln> command."
13578 #: ../src/guestfs-actions.pod:3664
13579 msgid "guestfs_ln_f"
13584 #: ../src/guestfs-actions.pod:3666
13588 " guestfs_ln_f (guestfs_h *g,\n"
13589 " const char *target,\n"
13590 " const char *linkname);\n"
13595 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2554
13597 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13598 "option removes the link (C<linkname>) if it exists already."
13603 #: ../src/guestfs-actions.pod:3678
13604 msgid "guestfs_ln_s"
13609 #: ../src/guestfs-actions.pod:3680
13613 " guestfs_ln_s (guestfs_h *g,\n"
13614 " const char *target,\n"
13615 " const char *linkname);\n"
13621 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2561
13622 msgid "This command creates a symbolic link using the C<ln -s> command."
13627 #: ../src/guestfs-actions.pod:3691
13628 msgid "guestfs_ln_sf"
13633 #: ../src/guestfs-actions.pod:3693
13637 " guestfs_ln_sf (guestfs_h *g,\n"
13638 " const char *target,\n"
13639 " const char *linkname);\n"
13644 #: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2567
13646 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13647 "option removes the link (C<linkname>) if it exists already."
13652 #: ../src/guestfs-actions.pod:3705
13653 msgid "guestfs_lremovexattr"
13658 #: ../src/guestfs-actions.pod:3707
13662 " guestfs_lremovexattr (guestfs_h *g,\n"
13663 " const char *xattr,\n"
13664 " const char *path);\n"
13670 #: ../src/guestfs-actions.pod:3712
13672 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13673 "link, then it removes an extended attribute of the link itself."
13678 #: ../src/guestfs-actions.pod:3720
13684 #: ../src/guestfs-actions.pod:3722
13688 " guestfs_ls (guestfs_h *g,\n"
13689 " const char *directory);\n"
13695 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2582
13697 "List the files in C<directory> (relative to the root directory, there is no "
13698 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13703 #: ../src/guestfs-actions.pod:3730
13705 "This command is mostly useful for interactive sessions. Programs should "
13706 "probably use C<guestfs_readdir> instead."
13711 #: ../src/guestfs-actions.pod:3739
13712 msgid "guestfs_lsetxattr"
13717 #: ../src/guestfs-actions.pod:3741
13721 " guestfs_lsetxattr (guestfs_h *g,\n"
13722 " const char *xattr,\n"
13723 " const char *val,\n"
13725 " const char *path);\n"
13731 #: ../src/guestfs-actions.pod:3748
13733 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13734 "then it sets an extended attribute of the link itself."
13739 #: ../src/guestfs-actions.pod:3756
13740 msgid "guestfs_lstat"
13745 #: ../src/guestfs-actions.pod:3758
13748 " struct guestfs_stat *\n"
13749 " guestfs_lstat (guestfs_h *g,\n"
13750 " const char *path);\n"
13756 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:6320
13757 #: ../fish/guestfish-actions.pod:2601 ../fish/guestfish-actions.pod:4270
13758 msgid "Returns file information for the given C<path>."
13763 #: ../src/guestfs-actions.pod:3764
13765 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13766 "link, then the link is stat-ed, not the file it refers to."
13771 #: ../src/guestfs-actions.pod:3768 ../fish/guestfish-actions.pod:2607
13772 msgid "This is the same as the C<lstat(2)> system call."
13777 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6324
13779 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13780 "error. I<The caller must call C<guestfs_free_stat> after use>."
13785 #: ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:6328
13786 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6727
13787 msgid "(Added in 0.9.2)"
13792 #: ../src/guestfs-actions.pod:3776
13793 msgid "guestfs_lstatlist"
13798 #: ../src/guestfs-actions.pod:3778
13801 " struct guestfs_stat_list *\n"
13802 " guestfs_lstatlist (guestfs_h *g,\n"
13803 " const char *path,\n"
13804 " char *const *names);\n"
13810 #: ../src/guestfs-actions.pod:3783
13812 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13813 "files, where all files are in the directory C<path>. C<names> is the list "
13814 "of files from this directory."
13819 #: ../src/guestfs-actions.pod:3787 ../fish/guestfish-actions.pod:2617
13821 "On return you get a list of stat structs, with a one-to-one correspondence "
13822 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13823 "then the C<ino> field of that structure is set to C<-1>."
13828 #: ../src/guestfs-actions.pod:3792
13830 "This call is intended for programs that want to efficiently list a directory "
13831 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13832 "for a similarly efficient call for getting extended attributes. Very long "
13833 "directory listings might cause the protocol message size to be exceeded, "
13834 "causing this call to fail. The caller must split up such requests into "
13835 "smaller groups of names."
13840 #: ../src/guestfs-actions.pod:3800
13842 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13843 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13848 #: ../src/guestfs-actions.pod:3806
13849 msgid "guestfs_luks_add_key"
13854 #: ../src/guestfs-actions.pod:3808
13858 " guestfs_luks_add_key (guestfs_h *g,\n"
13859 " const char *device,\n"
13860 " const char *key,\n"
13861 " const char *newkey,\n"
13868 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2634
13870 "This command adds a new key on LUKS device C<device>. C<key> is any "
13871 "existing key, and is used to access the device. C<newkey> is the new key to "
13872 "add. C<keyslot> is the key slot that will be replaced."
13877 #: ../src/guestfs-actions.pod:3820
13879 "Note that if C<keyslot> already contains a key, then this command will "
13880 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13885 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
13886 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
13887 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960
13889 "This function takes a key or passphrase parameter which could contain "
13890 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13896 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3870
13897 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3913
13898 msgid "(Added in 1.5.2)"
13903 #: ../src/guestfs-actions.pod:3832
13904 msgid "guestfs_luks_close"
13909 #: ../src/guestfs-actions.pod:3834
13913 " guestfs_luks_close (guestfs_h *g,\n"
13914 " const char *device);\n"
13920 #: ../src/guestfs-actions.pod:3838
13922 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13923 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13924 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13925 "underlying block device."
13930 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3945
13931 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4014
13932 #: ../src/guestfs-actions.pod:4062
13933 msgid "(Added in 1.5.1)"
13938 #: ../src/guestfs-actions.pod:3848
13939 msgid "guestfs_luks_format"
13944 #: ../src/guestfs-actions.pod:3850
13948 " guestfs_luks_format (guestfs_h *g,\n"
13949 " const char *device,\n"
13950 " const char *key,\n"
13957 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2660
13959 "This command erases existing data on C<device> and formats the device as a "
13960 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13961 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13966 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3886
13967 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4968
13968 #: ../src/guestfs-actions.pod:5748 ../src/guestfs-actions.pod:6155
13969 #: ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6204
13970 #: ../src/guestfs-actions.pod:7364 ../fish/guestfish-actions.pod:2668
13971 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2765
13972 #: ../fish/guestfish-actions.pod:3339 ../fish/guestfish-actions.pod:3859
13973 #: ../fish/guestfish-actions.pod:4169 ../fish/guestfish-actions.pod:4185
13974 #: ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4915
13976 "B<This command is dangerous. Without careful use you can easily destroy all "
13982 #: ../src/guestfs-actions.pod:3872
13983 msgid "guestfs_luks_format_cipher"
13988 #: ../src/guestfs-actions.pod:3874
13992 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13993 " const char *device,\n"
13994 " const char *key,\n"
13996 " const char *cipher);\n"
14002 #: ../src/guestfs-actions.pod:3881
14004 "This command is the same as C<guestfs_luks_format> but it also allows you to "
14005 "set the C<cipher> used."
14010 #: ../src/guestfs-actions.pod:3895
14011 msgid "guestfs_luks_kill_slot"
14016 #: ../src/guestfs-actions.pod:3897
14020 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14021 " const char *device,\n"
14022 " const char *key,\n"
14029 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2688
14031 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14032 "device C<device>. C<key> must be one of the I<other> keys."
14037 #: ../src/guestfs-actions.pod:3915
14038 msgid "guestfs_luks_open"
14043 #: ../src/guestfs-actions.pod:3917
14047 " guestfs_luks_open (guestfs_h *g,\n"
14048 " const char *device,\n"
14049 " const char *key,\n"
14050 " const char *mapname);\n"
14056 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2699
14058 "This command opens a block device which has been encrypted according to the "
14059 "Linux Unified Key Setup (LUKS) standard."
14064 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2702
14065 msgid "C<device> is the encrypted block device or partition."
14070 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2704
14072 "The caller must supply one of the keys associated with the LUKS block "
14073 "device, in the C<key> parameter."
14078 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2707
14080 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14081 "writes to this block device are decrypted from and encrypted to the "
14082 "underlying C<device> respectively."
14087 #: ../src/guestfs-actions.pod:3935
14089 "If this block device contains LVM volume groups, then calling "
14090 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14096 #: ../src/guestfs-actions.pod:3947
14097 msgid "guestfs_luks_open_ro"
14102 #: ../src/guestfs-actions.pod:3949
14106 " guestfs_luks_open_ro (guestfs_h *g,\n"
14107 " const char *device,\n"
14108 " const char *key,\n"
14109 " const char *mapname);\n"
14115 #: ../src/guestfs-actions.pod:3955
14117 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14123 #: ../src/guestfs-actions.pod:3966
14124 msgid "guestfs_lvcreate"
14129 #: ../src/guestfs-actions.pod:3968
14133 " guestfs_lvcreate (guestfs_h *g,\n"
14134 " const char *logvol,\n"
14135 " const char *volgroup,\n"
14142 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2732
14144 "This creates an LVM logical volume called C<logvol> on the volume group "
14145 "C<volgroup>, with C<size> megabytes."
14150 #: ../src/guestfs-actions.pod:3981
14151 msgid "guestfs_lvm_canonical_lv_name"
14156 #: ../src/guestfs-actions.pod:3983
14160 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14161 " const char *lvname);\n"
14167 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2739
14169 "This converts alternative naming schemes for LVs that you might find to the "
14170 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14176 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:2743
14178 "This command returns an error if the C<lvname> parameter does not refer to a "
14184 #: ../src/guestfs-actions.pod:3994
14185 msgid "See also C<guestfs_is_lv>."
14190 #: ../src/guestfs-actions.pod:3999
14191 msgid "(Added in 1.5.24)"
14196 #: ../src/guestfs-actions.pod:4001
14197 msgid "guestfs_lvm_clear_filter"
14202 #: ../src/guestfs-actions.pod:4003
14206 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14212 #: ../src/guestfs-actions.pod:4006
14214 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14215 "see every block device."
14220 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4051
14221 #: ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2786
14223 "This command also clears the LVM cache and performs a volume group scan."
14228 #: ../src/guestfs-actions.pod:4016
14229 msgid "guestfs_lvm_remove_all"
14234 #: ../src/guestfs-actions.pod:4018
14238 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14244 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2762
14246 "This command removes all LVM logical volumes, volume groups and physical "
14252 #: ../src/guestfs-actions.pod:4031
14253 msgid "guestfs_lvm_set_filter"
14258 #: ../src/guestfs-actions.pod:4033
14262 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14263 " char *const *devices);\n"
14269 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2772
14271 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14272 "block devices in the list C<devices>, and will ignore all other attached "
14278 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2776
14280 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14281 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14282 "there are two types of duplication possible: either cloned PVs/VGs which "
14283 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14284 "same name. In normal operation you cannot create this situation, but you "
14285 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14286 "inside the LVM metadata."
14291 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2789
14292 msgid "You can filter whole block devices or individual partitions."
14297 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2791
14299 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14300 "filesystem), even if you are not filtering out that VG."
14305 #: ../src/guestfs-actions.pod:4064
14306 msgid "guestfs_lvremove"
14311 #: ../src/guestfs-actions.pod:4066
14315 " guestfs_lvremove (guestfs_h *g,\n"
14316 " const char *device);\n"
14322 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2799
14324 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14325 "LV, such as C</dev/VG/LV>."
14330 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2802
14332 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14338 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:5314
14339 #: ../src/guestfs-actions.pod:7103
14340 msgid "(Added in 1.0.13)"
14345 #: ../src/guestfs-actions.pod:4080
14346 msgid "guestfs_lvrename"
14351 #: ../src/guestfs-actions.pod:4082
14355 " guestfs_lvrename (guestfs_h *g,\n"
14356 " const char *logvol,\n"
14357 " const char *newlogvol);\n"
14363 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2809
14364 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14369 #: ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:7116
14370 msgid "(Added in 1.0.83)"
14375 #: ../src/guestfs-actions.pod:4093
14376 msgid "guestfs_lvresize"
14381 #: ../src/guestfs-actions.pod:4095
14385 " guestfs_lvresize (guestfs_h *g,\n"
14386 " const char *device,\n"
14393 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2815
14395 "This resizes (expands or shrinks) an existing LVM logical volume to "
14396 "C<mbytes>. When reducing, data in the reduced part is lost."
14401 #: ../src/guestfs-actions.pod:4108
14402 msgid "guestfs_lvresize_free"
14407 #: ../src/guestfs-actions.pod:4110
14411 " guestfs_lvresize_free (guestfs_h *g,\n"
14412 " const char *lv,\n"
14419 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2823
14421 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14422 "remaining free space in the volume group. Commonly you would call this with "
14423 "pc = 100 which expands the logical volume as much as possible, using all "
14424 "remaining free space in the volume group."
14429 #: ../src/guestfs-actions.pod:4123
14430 msgid "(Added in 1.3.3)"
14435 #: ../src/guestfs-actions.pod:4125
14436 msgid "guestfs_lvs"
14441 #: ../src/guestfs-actions.pod:4127
14445 " guestfs_lvs (guestfs_h *g);\n"
14451 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2833
14453 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14459 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2836
14461 "This returns a list of the logical volume device names (eg. C</dev/"
14462 "VolGroup00/LogVol00>)."
14467 #: ../src/guestfs-actions.pod:4136
14468 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14473 #: ../src/guestfs-actions.pod:4144
14474 msgid "guestfs_lvs_full"
14479 #: ../src/guestfs-actions.pod:4146
14482 " struct guestfs_lvm_lv_list *\n"
14483 " guestfs_lvs_full (guestfs_h *g);\n"
14489 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2845
14491 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14492 "(8)> command. The \"full\" version includes all fields."
14497 #: ../src/guestfs-actions.pod:4152
14499 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14500 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14505 #: ../src/guestfs-actions.pod:4158
14506 msgid "guestfs_lvuuid"
14511 #: ../src/guestfs-actions.pod:4160
14515 " guestfs_lvuuid (guestfs_h *g,\n"
14516 " const char *device);\n"
14522 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2852
14523 msgid "This command returns the UUID of the LVM LV C<device>."
14528 #: ../src/guestfs-actions.pod:4171
14529 msgid "guestfs_lxattrlist"
14534 #: ../src/guestfs-actions.pod:4173
14537 " struct guestfs_xattr_list *\n"
14538 " guestfs_lxattrlist (guestfs_h *g,\n"
14539 " const char *path,\n"
14540 " char *const *names);\n"
14546 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2858
14548 "This call allows you to get the extended attributes of multiple files, where "
14549 "all files are in the directory C<path>. C<names> is the list of files from "
14555 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2862
14557 "On return you get a flat list of xattr structs which must be interpreted "
14558 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14559 "C<attrval> in this struct is zero-length to indicate there was an error "
14560 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14561 "number (the number of following attributes for this file, which could be C<"
14562 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14563 "for the first named file. This repeats for the second and subsequent files."
14568 #: ../src/guestfs-actions.pod:4192
14570 "This call is intended for programs that want to efficiently list a directory "
14571 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14572 "a similarly efficient call for getting standard stats. Very long directory "
14573 "listings might cause the protocol message size to be exceeded, causing this "
14574 "call to fail. The caller must split up such requests into smaller groups of "
14580 #: ../src/guestfs-actions.pod:4206
14581 msgid "guestfs_mkdir"
14586 #: ../src/guestfs-actions.pod:4208
14590 " guestfs_mkdir (guestfs_h *g,\n"
14591 " const char *path);\n"
14597 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2884
14598 msgid "Create a directory named C<path>."
14603 #: ../src/guestfs-actions.pod:4218
14604 msgid "guestfs_mkdir_mode"
14609 #: ../src/guestfs-actions.pod:4220
14613 " guestfs_mkdir_mode (guestfs_h *g,\n"
14614 " const char *path,\n"
14621 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2890
14623 "This command creates a directory, setting the initial permissions of the "
14624 "directory to C<mode>."
14629 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2893
14631 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14632 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14638 #: ../src/guestfs-actions.pod:4232
14639 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14644 #: ../src/guestfs-actions.pod:4238
14645 msgid "guestfs_mkdir_p"
14650 #: ../src/guestfs-actions.pod:4240
14654 " guestfs_mkdir_p (guestfs_h *g,\n"
14655 " const char *path);\n"
14661 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2903
14663 "Create a directory named C<path>, creating any parent directories as "
14664 "necessary. This is like the C<mkdir -p> shell command."
14669 #: ../src/guestfs-actions.pod:4251
14670 msgid "guestfs_mkdtemp"
14675 #: ../src/guestfs-actions.pod:4253
14679 " guestfs_mkdtemp (guestfs_h *g,\n"
14680 " const char *template);\n"
14686 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2910
14688 "This command creates a temporary directory. The C<template> parameter "
14689 "should be a full pathname for the temporary directory name with the final "
14690 "six characters being \"XXXXXX\"."
14695 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2915
14697 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14698 "being suitable for Windows filesystems."
14703 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2918
14704 msgid "The name of the temporary directory that was created is returned."
14709 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2921
14710 msgid "The temporary directory is created with mode 0700 and is owned by root."
14715 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2924
14717 "The caller is responsible for deleting the temporary directory and its "
14718 "contents after use."
14723 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2927
14724 msgid "See also: L<mkdtemp(3)>"
14729 #: ../src/guestfs-actions.pod:4281
14730 msgid "guestfs_mke2fs_J"
14735 #: ../src/guestfs-actions.pod:4283
14739 " guestfs_mke2fs_J (guestfs_h *g,\n"
14740 " const char *fstype,\n"
14741 " int blocksize,\n"
14742 " const char *device,\n"
14743 " const char *journal);\n"
14749 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2933
14751 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14752 "C<journal>. It is equivalent to the command:"
14757 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2937
14760 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14766 #: ../src/guestfs-actions.pod:4296
14767 msgid "See also C<guestfs_mke2journal>."
14772 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4318
14773 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4352
14774 #: ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380
14775 #: ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4704
14776 msgid "(Added in 1.0.68)"
14781 #: ../src/guestfs-actions.pod:4302
14782 msgid "guestfs_mke2fs_JL"
14787 #: ../src/guestfs-actions.pod:4304
14791 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14792 " const char *fstype,\n"
14793 " int blocksize,\n"
14794 " const char *device,\n"
14795 " const char *label);\n"
14801 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2945
14803 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14804 "the journal labeled C<label>."
14809 #: ../src/guestfs-actions.pod:4314
14810 msgid "See also C<guestfs_mke2journal_L>."
14815 #: ../src/guestfs-actions.pod:4320
14816 msgid "guestfs_mke2fs_JU"
14821 #: ../src/guestfs-actions.pod:4322
14825 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14826 " const char *fstype,\n"
14827 " int blocksize,\n"
14828 " const char *device,\n"
14829 " const char *uuid);\n"
14835 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2954
14837 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14838 "the journal with UUID C<uuid>."
14843 #: ../src/guestfs-actions.pod:4332
14844 msgid "See also C<guestfs_mke2journal_U>."
14849 #: ../src/guestfs-actions.pod:4338
14850 msgid "guestfs_mke2journal"
14855 #: ../src/guestfs-actions.pod:4340
14859 " guestfs_mke2journal (guestfs_h *g,\n"
14860 " int blocksize,\n"
14861 " const char *device);\n"
14867 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2963
14869 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14875 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2966
14878 " mke2fs -O journal_dev -b blocksize device\n"
14884 #: ../src/guestfs-actions.pod:4354
14885 msgid "guestfs_mke2journal_L"
14890 #: ../src/guestfs-actions.pod:4356
14894 " guestfs_mke2journal_L (guestfs_h *g,\n"
14895 " int blocksize,\n"
14896 " const char *label,\n"
14897 " const char *device);\n"
14903 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2972
14904 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14909 #: ../src/guestfs-actions.pod:4368
14910 msgid "guestfs_mke2journal_U"
14915 #: ../src/guestfs-actions.pod:4370
14919 " guestfs_mke2journal_U (guestfs_h *g,\n"
14920 " int blocksize,\n"
14921 " const char *uuid,\n"
14922 " const char *device);\n"
14928 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2978
14929 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14934 #: ../src/guestfs-actions.pod:4382
14935 msgid "guestfs_mkfifo"
14940 #: ../src/guestfs-actions.pod:4384
14944 " guestfs_mkfifo (guestfs_h *g,\n"
14946 " const char *path);\n"
14952 #: ../src/guestfs-actions.pod:4389
14954 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14955 "is just a convenient wrapper around C<guestfs_mknod>."
14960 #: ../src/guestfs-actions.pod:4399
14961 msgid "guestfs_mkfs"
14966 #: ../src/guestfs-actions.pod:4401
14970 " guestfs_mkfs (guestfs_h *g,\n"
14971 " const char *fstype,\n"
14972 " const char *device);\n"
14978 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2994
14980 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14981 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14986 #: ../src/guestfs-actions.pod:4414
14987 msgid "guestfs_mkfs_b"
14992 #: ../src/guestfs-actions.pod:4416
14996 " guestfs_mkfs_b (guestfs_h *g,\n"
14997 " const char *fstype,\n"
14998 " int blocksize,\n"
14999 " const char *device);\n"
15005 #: ../src/guestfs-actions.pod:4422
15007 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
15008 "block size of the resulting filesystem. Supported block sizes depend on the "
15009 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15014 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4470
15015 #: ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3034
15017 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15023 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:3010
15025 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15030 #: ../src/guestfs-actions.pod:4441
15031 msgid "guestfs_mkfs_opts"
15036 #: ../src/guestfs-actions.pod:4443
15040 " guestfs_mkfs_opts (guestfs_h *g,\n"
15041 " const char *fstype,\n"
15042 " const char *device,\n"
15048 #: ../src/guestfs-actions.pod:4454
15051 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15052 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15058 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3021
15060 "This function creates a filesystem on C<device>. The filesystem type is "
15061 "C<fstype>, for example C<ext3>."
15066 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3028
15067 msgid "C<blocksize>"
15072 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3030
15074 "The filesystem block size. Supported block sizes depend on the filesystem "
15075 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15080 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3037
15081 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15085 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3039
15086 msgid "C<features>"
15090 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3041
15091 msgid "This passes the I<-O> parameter to the external mkfs program."
15095 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3043
15097 "For certain filesystem types, this allows extra filesystem features to be "
15098 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15102 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3047
15104 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15109 #: ../src/guestfs-actions.pod:4490
15110 msgid "(Added in 1.7.19)"
15115 #: ../src/guestfs-actions.pod:4492
15116 msgid "guestfs_mkfs_opts_va"
15121 #: ../src/guestfs-actions.pod:4494
15125 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15126 " const char *fstype,\n"
15127 " const char *device,\n"
15128 " va_list args);\n"
15134 #: ../src/guestfs-actions.pod:4500
15135 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15140 #: ../src/guestfs-actions.pod:4504
15141 msgid "guestfs_mkfs_opts_argv"
15146 #: ../src/guestfs-actions.pod:4506
15150 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15151 " const char *fstype,\n"
15152 " const char *device,\n"
15153 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15159 #: ../src/guestfs-actions.pod:4512
15160 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15165 #: ../src/guestfs-actions.pod:4516
15166 msgid "guestfs_mkmountpoint"
15171 #: ../src/guestfs-actions.pod:4518
15175 " guestfs_mkmountpoint (guestfs_h *g,\n"
15176 " const char *exemptpath);\n"
15182 #: ../src/guestfs-actions.pod:4522
15184 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15185 "that can be used to create extra mountpoints before mounting the first "
15191 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3062
15193 "These calls are I<only> necessary in some very limited circumstances, mainly "
15194 "the case where you want to mount a mix of unrelated and/or read-only "
15195 "filesystems together."
15200 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3066
15202 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15203 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15204 "inside that. You can unpack this as follows in guestfish:"
15209 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3071
15212 " add-ro Fedora-11-i686-Live.iso\n"
15214 " mkmountpoint /cd\n"
15215 " mkmountpoint /sqsh\n"
15216 " mkmountpoint /ext3fs\n"
15217 " mount /dev/sda /cd\n"
15218 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15219 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15225 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3080
15226 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15231 #: ../src/guestfs-actions.pod:4546
15233 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15234 "may get unexpected errors if you try to mix these calls. It is safest to "
15235 "manually unmount filesystems and remove mountpoints after use."
15240 #: ../src/guestfs-actions.pod:4550
15242 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15243 "first, so for this to work for manual mountpoints, you must ensure that the "
15244 "innermost mountpoints have the longest pathnames, as in the example code "
15250 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3091
15252 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15256 #: ../src/guestfs-actions.pod:4557
15258 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15259 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15260 "can also trigger these issues."
15265 #: ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4822
15266 #: ../src/guestfs-actions.pod:5732
15267 msgid "(Added in 1.0.62)"
15272 #: ../src/guestfs-actions.pod:4565
15273 msgid "guestfs_mknod"
15278 #: ../src/guestfs-actions.pod:4567
15282 " guestfs_mknod (guestfs_h *g,\n"
15286 " const char *path);\n"
15292 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3101
15294 "This call creates block or character special devices, or named pipes (FIFOs)."
15299 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3104
15301 "The C<mode> parameter should be the mode, using the standard constants. "
15302 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15303 "used when creating block and character special devices."
15308 #: ../src/guestfs-actions.pod:4582
15310 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15311 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15312 "regular file). These constants are available in the standard Linux header "
15313 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15314 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15315 "the appropriate constant for you."
15320 #: ../src/guestfs-actions.pod:4596
15321 msgid "guestfs_mknod_b"
15326 #: ../src/guestfs-actions.pod:4598
15330 " guestfs_mknod_b (guestfs_h *g,\n"
15334 " const char *path);\n"
15340 #: ../src/guestfs-actions.pod:4605
15342 "This call creates a block device node called C<path> with mode C<mode> and "
15343 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15344 "wrapper around C<guestfs_mknod>."
15349 #: ../src/guestfs-actions.pod:4615
15350 msgid "guestfs_mknod_c"
15355 #: ../src/guestfs-actions.pod:4617
15359 " guestfs_mknod_c (guestfs_h *g,\n"
15363 " const char *path);\n"
15369 #: ../src/guestfs-actions.pod:4624
15371 "This call creates a char device node called C<path> with mode C<mode> and "
15372 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15373 "wrapper around C<guestfs_mknod>."
15378 #: ../src/guestfs-actions.pod:4634
15379 msgid "guestfs_mkswap"
15384 #: ../src/guestfs-actions.pod:4636
15388 " guestfs_mkswap (guestfs_h *g,\n"
15389 " const char *device);\n"
15395 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3143
15396 msgid "Create a swap partition on C<device>."
15401 #: ../src/guestfs-actions.pod:4646
15402 msgid "guestfs_mkswap_L"
15407 #: ../src/guestfs-actions.pod:4648
15411 " guestfs_mkswap_L (guestfs_h *g,\n"
15412 " const char *label,\n"
15413 " const char *device);\n"
15419 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3149
15420 msgid "Create a swap partition on C<device> with label C<label>."
15425 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3151
15427 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15428 "sda>), just to a partition. This appears to be a limitation of the kernel "
15434 #: ../src/guestfs-actions.pod:4663
15435 msgid "guestfs_mkswap_U"
15440 #: ../src/guestfs-actions.pod:4665
15444 " guestfs_mkswap_U (guestfs_h *g,\n"
15445 " const char *uuid,\n"
15446 " const char *device);\n"
15452 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3159
15453 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15458 #: ../src/guestfs-actions.pod:4676
15459 msgid "guestfs_mkswap_file"
15464 #: ../src/guestfs-actions.pod:4678
15468 " guestfs_mkswap_file (guestfs_h *g,\n"
15469 " const char *path);\n"
15475 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3165
15476 msgid "Create a swap file."
15481 #: ../src/guestfs-actions.pod:4684
15483 "This command just writes a swap file signature to an existing file. To "
15484 "create the file itself, use something like C<guestfs_fallocate>."
15489 #: ../src/guestfs-actions.pod:4691
15490 msgid "guestfs_modprobe"
15495 #: ../src/guestfs-actions.pod:4693
15499 " guestfs_modprobe (guestfs_h *g,\n"
15500 " const char *modulename);\n"
15506 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3174
15507 msgid "This loads a kernel module in the appliance."
15512 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3176
15514 "The kernel module must have been whitelisted when libguestfs was built (see "
15515 "C<appliance/kmod.whitelist.in> in the source)."
15520 #: ../src/guestfs-actions.pod:4706
15521 msgid "guestfs_mount"
15526 #: ../src/guestfs-actions.pod:4708
15530 " guestfs_mount (guestfs_h *g,\n"
15531 " const char *device,\n"
15532 " const char *mountpoint);\n"
15538 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3183
15540 "Mount a guest disk at a position in the filesystem. Block devices are named "
15541 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15542 "those block devices contain partitions, they will have the usual names (eg. "
15543 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15548 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3189
15550 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15551 "mounted on C</> before others can be mounted. Other filesystems can only be "
15552 "mounted on directories which already exist."
15557 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3194
15559 "The mounted filesystem is writable, if we have sufficient permissions on the "
15560 "underlying device."
15565 #: ../src/guestfs-actions.pod:4727
15567 "B<Important note:> When you use this call, the filesystem options C<sync> "
15568 "and C<noatime> are set implicitly. This was originally done because we "
15569 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15570 "very large negative performance impact and negligible effect on "
15571 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15572 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15573 "(use an empty string for the first parameter if you don't want any options)."
15578 #: ../src/guestfs-actions.pod:4741
15579 msgid "guestfs_mount_loop"
15584 #: ../src/guestfs-actions.pod:4743
15588 " guestfs_mount_loop (guestfs_h *g,\n"
15589 " const char *file,\n"
15590 " const char *mountpoint);\n"
15596 #: ../src/guestfs-actions.pod:4748 ../fish/guestfish-actions.pod:3211
15598 "This command lets you mount C<file> (a filesystem image in a file) on a "
15599 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15605 #: ../src/guestfs-actions.pod:4756
15606 msgid "guestfs_mount_options"
15611 #: ../src/guestfs-actions.pod:4758
15615 " guestfs_mount_options (guestfs_h *g,\n"
15616 " const char *options,\n"
15617 " const char *device,\n"
15618 " const char *mountpoint);\n"
15624 #: ../src/guestfs-actions.pod:4764
15626 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15627 "the mount options as for the L<mount(8)> I<-o> flag."
15632 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3223
15634 "If the C<options> parameter is an empty string, then no options are passed "
15635 "(all options default to whatever the filesystem uses)."
15640 #: ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4788
15641 #: ../src/guestfs-actions.pod:4805
15642 msgid "(Added in 1.0.10)"
15647 #: ../src/guestfs-actions.pod:4776
15648 msgid "guestfs_mount_ro"
15653 #: ../src/guestfs-actions.pod:4778
15657 " guestfs_mount_ro (guestfs_h *g,\n"
15658 " const char *device,\n"
15659 " const char *mountpoint);\n"
15665 #: ../src/guestfs-actions.pod:4783
15667 "This is the same as the C<guestfs_mount> command, but it mounts the "
15668 "filesystem with the read-only (I<-o ro>) flag."
15673 #: ../src/guestfs-actions.pod:4790
15674 msgid "guestfs_mount_vfs"
15679 #: ../src/guestfs-actions.pod:4792
15683 " guestfs_mount_vfs (guestfs_h *g,\n"
15684 " const char *options,\n"
15685 " const char *vfstype,\n"
15686 " const char *device,\n"
15687 " const char *mountpoint);\n"
15693 #: ../src/guestfs-actions.pod:4799
15695 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15696 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15702 #: ../src/guestfs-actions.pod:4807
15703 msgid "guestfs_mountpoints"
15708 #: ../src/guestfs-actions.pod:4809
15712 " guestfs_mountpoints (guestfs_h *g);\n"
15718 #: ../src/guestfs-actions.pod:4812
15720 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15721 "devices. This one returns a hash table (map) of device name to directory "
15722 "where the device is mounted."
15727 #: ../src/guestfs-actions.pod:4824
15728 msgid "guestfs_mounts"
15733 #: ../src/guestfs-actions.pod:4826
15737 " guestfs_mounts (guestfs_h *g);\n"
15743 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3254
15745 "This returns the list of currently mounted filesystems. It returns the list "
15746 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15751 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3257
15752 msgid "Some internal mounts are not shown."
15757 #: ../src/guestfs-actions.pod:4834
15758 msgid "See also: C<guestfs_mountpoints>"
15763 #: ../src/guestfs-actions.pod:4842
15769 #: ../src/guestfs-actions.pod:4844
15773 " guestfs_mv (guestfs_h *g,\n"
15774 " const char *src,\n"
15775 " const char *dest);\n"
15781 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3265
15783 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15784 "destination filename or destination directory."
15789 #: ../src/guestfs-actions.pod:4856
15790 msgid "guestfs_ntfs_3g_probe"
15795 #: ../src/guestfs-actions.pod:4858
15799 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15801 " const char *device);\n"
15807 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3272
15809 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15810 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15811 "write, and some cannot be mounted at all)."
15816 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3276
15818 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15819 "can be mounted read-write. Set it to false if you want to test if the "
15820 "volume can be mounted read-only."
15825 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3280
15827 "The return value is an integer which C<0> if the operation would succeed, or "
15828 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15833 #: ../src/guestfs-actions.pod:4877
15834 msgid "(Added in 1.0.43)"
15839 #: ../src/guestfs-actions.pod:4879
15840 msgid "guestfs_ntfsresize"
15845 #: ../src/guestfs-actions.pod:4881
15849 " guestfs_ntfsresize (guestfs_h *g,\n"
15850 " const char *device);\n"
15856 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3288
15858 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15859 "size of the underlying device. See also L<ntfsresize(8)>."
15864 #: ../src/guestfs-actions.pod:4893
15865 msgid "guestfs_ntfsresize_size"
15870 #: ../src/guestfs-actions.pod:4895
15874 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15875 " const char *device,\n"
15876 " int64_t size);\n"
15882 #: ../src/guestfs-actions.pod:4900
15884 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15885 "to specify the new size (in bytes) explicitly."
15890 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:5341
15891 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5680
15892 #: ../src/guestfs-actions.pod:7251
15893 msgid "(Added in 1.3.14)"
15898 #: ../src/guestfs-actions.pod:4907
15899 msgid "guestfs_part_add"
15904 #: ../src/guestfs-actions.pod:4909
15908 " guestfs_part_add (guestfs_h *g,\n"
15909 " const char *device,\n"
15910 " const char *prlogex,\n"
15911 " int64_t startsect,\n"
15912 " int64_t endsect);\n"
15918 #: ../src/guestfs-actions.pod:4916
15920 "This command adds a partition to C<device>. If there is no partition table "
15921 "on the device, call C<guestfs_part_init> first."
15926 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3306
15928 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15929 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15930 "C<logical>) and C<e> (or C<extended>) partition types."
15935 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3311
15937 "C<startsect> and C<endsect> are the start and end of the partition in "
15938 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15939 "from the end of the disk (C<-1> is the last sector)."
15944 #: ../src/guestfs-actions.pod:4928
15946 "Creating a partition which covers the whole disk is not so easy. Use "
15947 "C<guestfs_part_disk> to do that."
15952 #: ../src/guestfs-actions.pod:4933 ../src/guestfs-actions.pod:4971
15953 #: ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5102
15954 #: ../src/guestfs-actions.pod:5140 ../src/guestfs-actions.pod:5159
15955 #: ../src/guestfs-actions.pod:5199
15956 msgid "(Added in 1.0.78)"
15961 #: ../src/guestfs-actions.pod:4935
15962 msgid "guestfs_part_del"
15967 #: ../src/guestfs-actions.pod:4937
15971 " guestfs_part_del (guestfs_h *g,\n"
15972 " const char *device,\n"
15979 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3322
15980 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15985 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3324
15987 "Note that in the case of MBR partitioning, deleting an extended partition "
15988 "also deletes any logical partitions it contains."
15993 #: ../src/guestfs-actions.pod:4952
15994 msgid "guestfs_part_disk"
15999 #: ../src/guestfs-actions.pod:4954
16003 " guestfs_part_disk (guestfs_h *g,\n"
16004 " const char *device,\n"
16005 " const char *parttype);\n"
16011 #: ../src/guestfs-actions.pod:4959
16013 "This command is simply a combination of C<guestfs_part_init> followed by "
16014 "C<guestfs_part_add> to create a single primary partition covering the whole "
16020 #: ../src/guestfs-actions.pod:4963
16022 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16023 "possible values are described in C<guestfs_part_init>."
16028 #: ../src/guestfs-actions.pod:4973
16029 msgid "guestfs_part_get_bootable"
16034 #: ../src/guestfs-actions.pod:4975
16038 " guestfs_part_get_bootable (guestfs_h *g,\n"
16039 " const char *device,\n"
16046 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3346
16048 "This command returns true if the partition C<partnum> on C<device> has the "
16049 "bootable flag set."
16054 #: ../src/guestfs-actions.pod:4983
16055 msgid "See also C<guestfs_part_set_bootable>."
16060 #: ../src/guestfs-actions.pod:4989
16061 msgid "guestfs_part_get_mbr_id"
16066 #: ../src/guestfs-actions.pod:4991
16070 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16071 " const char *device,\n"
16078 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3355
16080 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16081 "partition C<partnum>."
16086 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
16088 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16089 "undefined results for other partition table types (see "
16090 "C<guestfs_part_get_parttype>)."
16095 #: ../src/guestfs-actions.pod:5007
16096 msgid "guestfs_part_get_parttype"
16101 #: ../src/guestfs-actions.pod:5009
16105 " guestfs_part_get_parttype (guestfs_h *g,\n"
16106 " const char *device);\n"
16112 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3366
16114 "This command examines the partition table on C<device> and returns the "
16115 "partition table type (format) being used."
16120 #: ../src/guestfs-actions.pod:5016
16122 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16123 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16124 "possible, although unusual. See C<guestfs_part_init> for a full list."
16129 #: ../src/guestfs-actions.pod:5026
16130 msgid "guestfs_part_init"
16135 #: ../src/guestfs-actions.pod:5028
16139 " guestfs_part_init (guestfs_h *g,\n"
16140 " const char *device,\n"
16141 " const char *parttype);\n"
16147 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3378
16149 "This creates an empty partition table on C<device> of one of the partition "
16150 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16151 "(for large disks)."
16156 #: ../src/guestfs-actions.pod:5037
16158 "Initially there are no partitions. Following this, you should call "
16159 "C<guestfs_part_add> for each partition required."
16164 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
16165 msgid "Possible values for C<parttype> are:"
16170 #: ../src/guestfs-actions.pod:5044 ../fish/guestfish-actions.pod:3389
16171 msgid "B<efi> | B<gpt>"
16176 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3391
16177 msgid "Intel EFI / GPT partition table."
16182 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3393
16184 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16185 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16186 "the C<mbr> format."
16191 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3397
16192 msgid "B<mbr> | B<msdos>"
16197 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3399
16199 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16200 "Windows. This partition type will B<only> work for device sizes up to 2 "
16201 "TB. For large disks we recommend using C<gpt>."
16206 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3406
16208 "Other partition table types that may work but are not supported include:"
16213 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3411
16219 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3413
16220 msgid "AIX disk labels."
16225 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3415
16226 msgid "B<amiga> | B<rdb>"
16231 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3417
16232 msgid "Amiga \"Rigid Disk Block\" format."
16237 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3419
16243 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3421
16244 msgid "BSD disk labels."
16249 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3423
16255 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3425
16256 msgid "DASD, used on IBM mainframes."
16261 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3427
16267 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3429
16268 msgid "MIPS/SGI volumes."
16273 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3431
16279 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3433
16280 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16285 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3435
16291 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3437
16292 msgid "NEC PC-98 format, common in Japan apparently."
16297 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3439
16303 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3441
16304 msgid "Sun disk labels."
16309 #: ../src/guestfs-actions.pod:5104
16310 msgid "guestfs_part_list"
16315 #: ../src/guestfs-actions.pod:5106
16318 " struct guestfs_partition_list *\n"
16319 " guestfs_part_list (guestfs_h *g,\n"
16320 " const char *device);\n"
16326 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3449
16328 "This command parses the partition table on C<device> and returns the list of "
16329 "partitions found."
16334 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3452
16335 msgid "The fields in the returned structure are:"
16340 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3456
16341 msgid "B<part_num>"
16346 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3458
16347 msgid "Partition number, counting from 1."
16352 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3460
16353 msgid "B<part_start>"
16358 #: ../src/guestfs-actions.pod:5123
16360 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16361 "the device's sector size, see C<guestfs_blockdev_getss>."
16366 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3465
16367 msgid "B<part_end>"
16372 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3467
16373 msgid "End of the partition in bytes."
16378 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3469
16379 msgid "B<part_size>"
16384 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3471
16385 msgid "Size of the partition in bytes."
16390 #: ../src/guestfs-actions.pod:5136
16392 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16393 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16399 #: ../src/guestfs-actions.pod:5142
16400 msgid "guestfs_part_set_bootable"
16405 #: ../src/guestfs-actions.pod:5144
16409 " guestfs_part_set_bootable (guestfs_h *g,\n"
16410 " const char *device,\n"
16412 " int bootable);\n"
16418 #: ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:3479
16420 "This sets the bootable flag on partition numbered C<partnum> on device "
16421 "C<device>. Note that partitions are numbered from 1."
16426 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3482
16428 "The bootable flag is used by some operating systems (notably Windows) to "
16429 "determine which partition to boot from. It is by no means universally "
16435 #: ../src/guestfs-actions.pod:5161
16436 msgid "guestfs_part_set_mbr_id"
16441 #: ../src/guestfs-actions.pod:5163
16445 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16446 " const char *device,\n"
16454 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3490
16456 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16457 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16458 "documentation are in fact hexadecimal numbers, but usually documented "
16459 "without any leading \"0x\" which might be confusing."
16464 #: ../src/guestfs-actions.pod:5183
16465 msgid "guestfs_part_set_name"
16470 #: ../src/guestfs-actions.pod:5185
16474 " guestfs_part_set_name (guestfs_h *g,\n"
16475 " const char *device,\n"
16477 " const char *name);\n"
16483 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3504
16485 "This sets the partition name on partition numbered C<partnum> on device "
16486 "C<device>. Note that partitions are numbered from 1."
16491 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3507
16493 "The partition name can only be set on certain types of partition table. "
16494 "This works on C<gpt> but not on C<mbr> partitions."
16499 #: ../src/guestfs-actions.pod:5201
16500 msgid "guestfs_part_to_dev"
16505 #: ../src/guestfs-actions.pod:5203
16509 " guestfs_part_to_dev (guestfs_h *g,\n"
16510 " const char *partition);\n"
16516 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3514
16518 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16519 "partition number, returning the device name (eg. \"/dev/sdb\")."
16524 #: ../src/guestfs-actions.pod:5211
16526 "The named partition must exist, for example as a string returned from "
16527 "C<guestfs_list_partitions>."
16532 #: ../src/guestfs-actions.pod:5219
16533 msgid "guestfs_ping_daemon"
16538 #: ../src/guestfs-actions.pod:5221
16542 " guestfs_ping_daemon (guestfs_h *g);\n"
16548 #: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:3525
16550 "This is a test probe into the guestfs daemon running inside the qemu "
16551 "subprocess. Calling this function checks that the daemon responds to the "
16552 "ping message, without affecting the daemon or attached block device(s) in "
16558 #: ../src/guestfs-actions.pod:5233
16559 msgid "guestfs_pread"
16564 #: ../src/guestfs-actions.pod:5235
16568 " guestfs_pread (guestfs_h *g,\n"
16569 " const char *path,\n"
16571 " int64_t offset,\n"
16572 " size_t *size_r);\n"
16578 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3534
16580 "This command lets you read part of a file. It reads C<count> bytes of the "
16581 "file, starting at C<offset>, from file C<path>."
16586 #: ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5271
16587 #: ../fish/guestfish-actions.pod:3537 ../fish/guestfish-actions.pod:3552
16589 "This may read fewer bytes than requested. For further details see the "
16590 "L<pread(2)> system call."
16595 #: ../src/guestfs-actions.pod:5248
16596 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16601 #: ../src/guestfs-actions.pod:5259
16602 msgid "guestfs_pread_device"
16607 #: ../src/guestfs-actions.pod:5261
16611 " guestfs_pread_device (guestfs_h *g,\n"
16612 " const char *device,\n"
16614 " int64_t offset,\n"
16615 " size_t *size_r);\n"
16621 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3549
16623 "This command lets you read part of a file. It reads C<count> bytes of "
16624 "C<device>, starting at C<offset>."
16629 #: ../src/guestfs-actions.pod:5274
16630 msgid "See also C<guestfs_pread>."
16635 #: ../src/guestfs-actions.pod:5283
16636 msgid "(Added in 1.5.21)"
16641 #: ../src/guestfs-actions.pod:5285
16642 msgid "guestfs_pvcreate"
16647 #: ../src/guestfs-actions.pod:5287
16651 " guestfs_pvcreate (guestfs_h *g,\n"
16652 " const char *device);\n"
16658 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3564
16660 "This creates an LVM physical volume on the named C<device>, where C<device> "
16661 "should usually be a partition name such as C</dev/sda1>."
16666 #: ../src/guestfs-actions.pod:5299
16667 msgid "guestfs_pvremove"
16672 #: ../src/guestfs-actions.pod:5301
16676 " guestfs_pvremove (guestfs_h *g,\n"
16677 " const char *device);\n"
16683 #: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:3572
16685 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16691 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3575
16693 "The implementation uses the C<pvremove> command which refuses to wipe "
16694 "physical volumes that contain any volume groups, so you have to remove those "
16700 #: ../src/guestfs-actions.pod:5316
16701 msgid "guestfs_pvresize"
16706 #: ../src/guestfs-actions.pod:5318
16710 " guestfs_pvresize (guestfs_h *g,\n"
16711 " const char *device);\n"
16717 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3583
16719 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16720 "the new size of the underlying device."
16725 #: ../src/guestfs-actions.pod:5329
16726 msgid "guestfs_pvresize_size"
16731 #: ../src/guestfs-actions.pod:5331
16735 " guestfs_pvresize_size (guestfs_h *g,\n"
16736 " const char *device,\n"
16737 " int64_t size);\n"
16743 #: ../src/guestfs-actions.pod:5336
16745 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16746 "specify the new size (in bytes) explicitly."
16751 #: ../src/guestfs-actions.pod:5343
16752 msgid "guestfs_pvs"
16757 #: ../src/guestfs-actions.pod:5345
16761 " guestfs_pvs (guestfs_h *g);\n"
16767 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3597
16769 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16775 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3600
16777 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16783 #: ../src/guestfs-actions.pod:5354
16784 msgid "See also C<guestfs_pvs_full>."
16789 #: ../src/guestfs-actions.pod:5362
16790 msgid "guestfs_pvs_full"
16795 #: ../src/guestfs-actions.pod:5364
16798 " struct guestfs_lvm_pv_list *\n"
16799 " guestfs_pvs_full (guestfs_h *g);\n"
16805 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3609
16807 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16808 "(8)> command. The \"full\" version includes all fields."
16813 #: ../src/guestfs-actions.pod:5370
16815 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16816 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16821 #: ../src/guestfs-actions.pod:5376
16822 msgid "guestfs_pvuuid"
16827 #: ../src/guestfs-actions.pod:5378
16831 " guestfs_pvuuid (guestfs_h *g,\n"
16832 " const char *device);\n"
16838 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3616
16839 msgid "This command returns the UUID of the LVM PV C<device>."
16844 #: ../src/guestfs-actions.pod:5389
16845 msgid "guestfs_pwrite"
16850 #: ../src/guestfs-actions.pod:5391
16854 " guestfs_pwrite (guestfs_h *g,\n"
16855 " const char *path,\n"
16856 " const char *content,\n"
16857 " size_t content_size,\n"
16858 " int64_t offset);\n"
16864 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3622
16866 "This command writes to part of a file. It writes the data buffer C<content> "
16867 "to the file C<path> starting at offset C<offset>."
16872 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3625
16874 "This command implements the L<pwrite(2)> system call, and like that system "
16875 "call it may not write the full data requested. The return value is the "
16876 "number of bytes that were actually written to the file. This could even be "
16877 "0, although short writes are unlikely for regular files in ordinary "
16883 #: ../src/guestfs-actions.pod:5407
16884 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16889 #: ../src/guestfs-actions.pod:5416
16890 msgid "guestfs_pwrite_device"
16895 #: ../src/guestfs-actions.pod:5418
16899 " guestfs_pwrite_device (guestfs_h *g,\n"
16900 " const char *device,\n"
16901 " const char *content,\n"
16902 " size_t content_size,\n"
16903 " int64_t offset);\n"
16909 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3640
16911 "This command writes to part of a device. It writes the data buffer "
16912 "C<content> to C<device> starting at offset C<offset>."
16917 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3643
16919 "This command implements the L<pwrite(2)> system call, and like that system "
16920 "call it may not write the full data requested (although short writes to disk "
16921 "devices and partitions are probably impossible with standard Linux kernels)."
16926 #: ../src/guestfs-actions.pod:5433
16927 msgid "See also C<guestfs_pwrite>."
16932 #: ../src/guestfs-actions.pod:5440
16933 msgid "(Added in 1.5.20)"
16938 #: ../src/guestfs-actions.pod:5442
16939 msgid "guestfs_read_file"
16944 #: ../src/guestfs-actions.pod:5444
16948 " guestfs_read_file (guestfs_h *g,\n"
16949 " const char *path,\n"
16950 " size_t *size_r);\n"
16956 #: ../src/guestfs-actions.pod:5449 ../fish/guestfish-actions.pod:3657
16957 msgid "This calls returns the contents of the file C<path> as a buffer."
16962 #: ../src/guestfs-actions.pod:5452
16964 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16965 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16966 "function is limited in the total size of file that can be handled."
16971 #: ../src/guestfs-actions.pod:5464
16972 msgid "(Added in 1.0.63)"
16977 #: ../src/guestfs-actions.pod:5466
16978 msgid "guestfs_read_lines"
16983 #: ../src/guestfs-actions.pod:5468
16987 " guestfs_read_lines (guestfs_h *g,\n"
16988 " const char *path);\n"
16994 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3674
16996 "The file contents are returned as a list of lines. Trailing C<LF> and "
16997 "C<CRLF> character sequences are I<not> returned."
17002 #: ../src/guestfs-actions.pod:5477
17004 "Note that this function cannot correctly handle binary files (specifically, "
17005 "files containing C<\\0> character which is treated as end of line). For "
17006 "those you need to use the C<guestfs_read_file> function which has a more "
17007 "complex interface."
17012 #: ../src/guestfs-actions.pod:5488
17013 msgid "guestfs_readdir"
17018 #: ../src/guestfs-actions.pod:5490
17021 " struct guestfs_dirent_list *\n"
17022 " guestfs_readdir (guestfs_h *g,\n"
17023 " const char *dir);\n"
17029 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3686
17030 msgid "This returns the list of directory entries in directory C<dir>."
17035 #: ../src/guestfs-actions.pod:5496 ../fish/guestfish-actions.pod:3688
17037 "All entries in the directory are returned, including C<.> and C<..>. The "
17038 "entries are I<not> sorted, but returned in the same order as the underlying "
17044 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
17046 "Also this call returns basic file type information about each file. The "
17047 "C<ftyp> field will contain one of the following characters:"
17052 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3697
17058 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3699
17059 msgid "Block special"
17064 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3701
17070 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3703
17071 msgid "Char special"
17076 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3705
17082 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3707
17088 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3709
17094 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3711
17095 msgid "FIFO (named pipe)"
17100 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3713
17106 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3715
17107 msgid "Symbolic link"
17112 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3717
17118 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3719
17119 msgid "Regular file"
17124 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3721
17130 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3723
17136 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3725
17142 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3727
17143 msgid "Unknown file type"
17148 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3729
17154 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3731
17156 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17161 #: ../src/guestfs-actions.pod:5544
17163 "This function is primarily intended for use by programs. To get a simple "
17164 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17165 "consumption, use C<guestfs_ll>."
17170 #: ../src/guestfs-actions.pod:5548
17172 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17173 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17178 #: ../src/guestfs-actions.pod:5554
17179 msgid "guestfs_readlink"
17184 #: ../src/guestfs-actions.pod:5556
17188 " guestfs_readlink (guestfs_h *g,\n"
17189 " const char *path);\n"
17195 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3744
17196 msgid "This command reads the target of a symbolic link."
17201 #: ../src/guestfs-actions.pod:5567
17202 msgid "guestfs_readlinklist"
17207 #: ../src/guestfs-actions.pod:5569
17211 " guestfs_readlinklist (guestfs_h *g,\n"
17212 " const char *path,\n"
17213 " char *const *names);\n"
17219 #: ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3750
17221 "This call allows you to do a C<readlink> operation on multiple files, where "
17222 "all files are in the directory C<path>. C<names> is the list of files from "
17228 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3754
17230 "On return you get a list of strings, with a one-to-one correspondence to the "
17231 "C<names> list. Each string is the value of the symbolic link."
17236 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3758
17238 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17239 "result string is the empty string C<\"\">. However the whole operation is "
17240 "completed even if there were C<readlink(2)> errors, and so you can call this "
17241 "function with names where you don't know if they are symbolic links already "
17242 "(albeit slightly less efficient)."
17247 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3765
17249 "This call is intended for programs that want to efficiently list a directory "
17250 "contents without making many round-trips. Very long directory listings "
17251 "might cause the protocol message size to be exceeded, causing this call to "
17252 "fail. The caller must split up such requests into smaller groups of names."
17257 #: ../src/guestfs-actions.pod:5602
17258 msgid "guestfs_realpath"
17263 #: ../src/guestfs-actions.pod:5604
17267 " guestfs_realpath (guestfs_h *g,\n"
17268 " const char *path);\n"
17274 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3776
17276 "Return the canonicalized absolute pathname of C<path>. The returned path "
17277 "has no C<.>, C<..> or symbolic link path elements."
17282 #: ../src/guestfs-actions.pod:5616
17283 msgid "guestfs_removexattr"
17288 #: ../src/guestfs-actions.pod:5618
17292 " guestfs_removexattr (guestfs_h *g,\n"
17293 " const char *xattr,\n"
17294 " const char *path);\n"
17300 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
17302 "This call removes the extended attribute named C<xattr> of the file C<path>."
17307 #: ../src/guestfs-actions.pod:5626
17308 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17313 #: ../src/guestfs-actions.pod:5632
17314 msgid "guestfs_resize2fs"
17319 #: ../src/guestfs-actions.pod:5634
17323 " guestfs_resize2fs (guestfs_h *g,\n"
17324 " const char *device);\n"
17330 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3792
17332 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17333 "underlying device."
17338 #: ../src/guestfs-actions.pod:5641
17340 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17341 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17342 "sometimes gives an error about this and sometimes not. In any case, it is "
17343 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17347 #: ../src/guestfs-actions.pod:5651
17348 msgid "guestfs_resize2fs_M"
17352 #: ../src/guestfs-actions.pod:5653
17356 " guestfs_resize2fs_M (guestfs_h *g,\n"
17357 " const char *device);\n"
17362 #: ../src/guestfs-actions.pod:5657
17364 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17365 "resized to its minimum size. This works like the I<-M> option to the "
17366 "C<resize2fs> command."
17370 #: ../src/guestfs-actions.pod:5661
17372 "To get the resulting size of the filesystem you should call "
17373 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17374 "These two numbers, multiplied together, give the resulting size of the "
17375 "minimal filesystem in bytes."
17380 #: ../src/guestfs-actions.pod:5668
17381 msgid "guestfs_resize2fs_size"
17386 #: ../src/guestfs-actions.pod:5670
17390 " guestfs_resize2fs_size (guestfs_h *g,\n"
17391 " const char *device,\n"
17392 " int64_t size);\n"
17398 #: ../src/guestfs-actions.pod:5675
17400 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17401 "to specify the new size (in bytes) explicitly."
17406 #: ../src/guestfs-actions.pod:5682
17412 #: ../src/guestfs-actions.pod:5684
17416 " guestfs_rm (guestfs_h *g,\n"
17417 " const char *path);\n"
17423 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3825
17424 msgid "Remove the single file C<path>."
17429 #: ../src/guestfs-actions.pod:5694
17430 msgid "guestfs_rm_rf"
17435 #: ../src/guestfs-actions.pod:5696
17439 " guestfs_rm_rf (guestfs_h *g,\n"
17440 " const char *path);\n"
17446 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3831
17448 "Remove the file or directory C<path>, recursively removing the contents if "
17449 "its a directory. This is like the C<rm -rf> shell command."
17454 #: ../src/guestfs-actions.pod:5708
17455 msgid "guestfs_rmdir"
17460 #: ../src/guestfs-actions.pod:5710
17464 " guestfs_rmdir (guestfs_h *g,\n"
17465 " const char *path);\n"
17471 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3839
17472 msgid "Remove the single directory C<path>."
17477 #: ../src/guestfs-actions.pod:5720
17478 msgid "guestfs_rmmountpoint"
17483 #: ../src/guestfs-actions.pod:5722
17487 " guestfs_rmmountpoint (guestfs_h *g,\n"
17488 " const char *exemptpath);\n"
17494 #: ../src/guestfs-actions.pod:5726
17496 "This calls removes a mountpoint that was previously created with "
17497 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17502 #: ../src/guestfs-actions.pod:5734
17503 msgid "guestfs_scrub_device"
17508 #: ../src/guestfs-actions.pod:5736
17512 " guestfs_scrub_device (guestfs_h *g,\n"
17513 " const char *device);\n"
17519 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3853
17521 "This command writes patterns over C<device> to make data retrieval more "
17527 #: ../src/guestfs-actions.pod:5743 ../src/guestfs-actions.pod:5764
17528 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3856
17529 #: ../fish/guestfish-actions.pod:3871 ../fish/guestfish-actions.pod:3884
17531 "It is an interface to the L<scrub(1)> program. See that manual page for "
17537 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5769
17538 #: ../src/guestfs-actions.pod:5788
17539 msgid "(Added in 1.0.52)"
17544 #: ../src/guestfs-actions.pod:5753
17545 msgid "guestfs_scrub_file"
17550 #: ../src/guestfs-actions.pod:5755
17554 " guestfs_scrub_file (guestfs_h *g,\n"
17555 " const char *file);\n"
17561 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3866
17563 "This command writes patterns over a file to make data retrieval more "
17569 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3869
17570 msgid "The file is I<removed> after scrubbing."
17575 #: ../src/guestfs-actions.pod:5771
17576 msgid "guestfs_scrub_freespace"
17581 #: ../src/guestfs-actions.pod:5773
17585 " guestfs_scrub_freespace (guestfs_h *g,\n"
17586 " const char *dir);\n"
17592 #: ../src/guestfs-actions.pod:5777
17594 "This command creates the directory C<dir> and then fills it with files until "
17595 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17596 "and deletes them. The intention is to scrub any free space on the partition "
17597 "containing C<dir>."
17602 #: ../src/guestfs-actions.pod:5790
17603 msgid "guestfs_set_append"
17608 #: ../src/guestfs-actions.pod:5792
17612 " guestfs_set_append (guestfs_h *g,\n"
17613 " const char *append);\n"
17619 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3893
17621 "This function is used to add additional options to the guest kernel command "
17627 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3896
17629 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17630 "environment variable."
17635 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3899
17637 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17638 "(libguestfs always adds a few of its own)."
17642 #: ../src/guestfs-actions.pod:5809
17643 msgid "guestfs_set_attach_method"
17647 #: ../src/guestfs-actions.pod:5811
17651 " guestfs_set_attach_method (guestfs_h *g,\n"
17652 " const char *attachmethod);\n"
17657 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3908
17659 "Set the method that libguestfs uses to connect to the back end guestfsd "
17660 "daemon. Possible methods are:"
17664 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3915
17666 "Launch an appliance and connect to it. This is the ordinary method and the "
17671 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3918
17672 msgid "C<unix:I<path>>"
17676 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3920
17677 msgid "Connect to the Unix domain socket I<path>."
17681 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3922
17683 "This method lets you connect to an existing daemon or (using virtio-serial) "
17684 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17685 "RUNNING DAEMONS>."
17690 #: ../src/guestfs-actions.pod:5837
17691 msgid "guestfs_set_autosync"
17696 #: ../src/guestfs-actions.pod:5839
17700 " guestfs_set_autosync (guestfs_h *g,\n"
17701 " int autosync);\n"
17706 #: ../src/guestfs-actions.pod:5843 ../fish/guestfish-actions.pod:3934
17708 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17709 "effort attempt to make filesystems consistent and synchronized when the "
17710 "handle is closed (also if the program exits without closing handles)."
17715 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3939
17717 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17718 "disabled by default)."
17723 #: ../src/guestfs-actions.pod:5855
17724 msgid "guestfs_set_direct"
17729 #: ../src/guestfs-actions.pod:5857
17733 " guestfs_set_direct (guestfs_h *g,\n"
17740 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3948
17742 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17743 "passed directly through to the appliance once it is launched."
17748 #: ../src/guestfs-actions.pod:5865
17750 "One consequence of this is that log messages aren't caught by the library "
17751 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17757 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3956
17758 msgid "You probably don't want to use this unless you know what you are doing."
17763 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3959
17764 msgid "The default is disabled."
17769 #: ../src/guestfs-actions.pod:5878
17770 msgid "guestfs_set_e2label"
17775 #: ../src/guestfs-actions.pod:5880
17779 " guestfs_set_e2label (guestfs_h *g,\n"
17780 " const char *device,\n"
17781 " const char *label);\n"
17787 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3965
17789 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17790 "C<label>. Filesystem labels are limited to 16 characters."
17795 #: ../src/guestfs-actions.pod:5889
17797 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17798 "the existing label on a filesystem."
17803 #: ../src/guestfs-actions.pod:5896
17804 msgid "guestfs_set_e2uuid"
17809 #: ../src/guestfs-actions.pod:5898
17813 " guestfs_set_e2uuid (guestfs_h *g,\n"
17814 " const char *device,\n"
17815 " const char *uuid);\n"
17821 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3976
17823 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17824 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17825 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17830 #: ../src/guestfs-actions.pod:5908
17832 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17833 "the existing UUID of a filesystem."
17838 #: ../src/guestfs-actions.pod:5915
17839 msgid "guestfs_set_memsize"
17844 #: ../src/guestfs-actions.pod:5917
17848 " guestfs_set_memsize (guestfs_h *g,\n"
17855 #: ../src/guestfs-actions.pod:5921
17857 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17858 "This only has any effect if called before C<guestfs_launch>."
17863 #: ../src/guestfs-actions.pod:5925 ../fish/guestfish-actions.pod:3994
17865 "You can also change this by setting the environment variable "
17866 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17871 #: ../src/guestfs-actions.pod:5936
17872 msgid "guestfs_set_network"
17877 #: ../src/guestfs-actions.pod:5938
17881 " guestfs_set_network (guestfs_h *g,\n"
17888 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:4007
17890 "If C<network> is true, then the network is enabled in the libguestfs "
17891 "appliance. The default is false."
17896 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:4010
17898 "This affects whether commands are able to access the network (see L<guestfs"
17899 "(3)/RUNNING COMMANDS>)."
17904 #: ../src/guestfs-actions.pod:5948
17906 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17912 #: ../src/guestfs-actions.pod:5955
17913 msgid "guestfs_set_path"
17918 #: ../src/guestfs-actions.pod:5957
17922 " guestfs_set_path (guestfs_h *g,\n"
17923 " const char *searchpath);\n"
17929 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4022
17930 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17935 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4024
17937 "The default is C<$libdir/guestfs> unless overridden by setting "
17938 "C<LIBGUESTFS_PATH> environment variable."
17943 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4027
17944 msgid "Setting C<path> to C<NULL> restores the default path."
17949 #: ../src/guestfs-actions.pod:5972
17950 msgid "guestfs_set_qemu"
17955 #: ../src/guestfs-actions.pod:5974
17959 " guestfs_set_qemu (guestfs_h *g,\n"
17960 " const char *qemu);\n"
17966 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4035
17967 msgid "Set the qemu binary that we will use."
17972 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4037
17974 "The default is chosen when the library was compiled by the configure script."
17979 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:4040
17981 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17987 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:4043
17988 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17993 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4045
17995 "Note that you should call this function as early as possible after creating "
17996 "the handle. This is because some pre-launch operations depend on testing "
17997 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17998 "don't retest features, and so you might see inconsistent results. Using the "
17999 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
18000 "the qemu binary at the same time as the handle is created."
18005 #: ../src/guestfs-actions.pod:6000
18006 msgid "guestfs_set_recovery_proc"
18011 #: ../src/guestfs-actions.pod:6002
18015 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18016 " int recoveryproc);\n"
18022 #: ../src/guestfs-actions.pod:6006
18024 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18025 "not create a recovery process. The purpose of the recovery process is to "
18026 "stop runaway qemu processes in the case where the main program aborts "
18032 #: ../src/guestfs-actions.pod:6011
18034 "This only has any effect if called before C<guestfs_launch>, and the default "
18040 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4067
18042 "About the only time when you would want to disable this is if the main "
18043 "process will fork itself into the background (\"daemonize\" itself). In "
18044 "this case the recovery process thinks that the main program has disappeared "
18045 "and so kills qemu, which is not very helpful."
18050 #: ../src/guestfs-actions.pod:6024
18051 msgid "guestfs_set_selinux"
18056 #: ../src/guestfs-actions.pod:6026
18060 " guestfs_set_selinux (guestfs_h *g,\n"
18067 #: ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:4079
18069 "This sets the selinux flag that is passed to the appliance at boot time. "
18070 "The default is C<selinux=0> (disabled)."
18075 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4082
18077 "Note that if SELinux is enabled, it is always in Permissive mode "
18078 "(C<enforcing=0>)."
18083 #: ../src/guestfs-actions.pod:6043
18084 msgid "guestfs_set_trace"
18089 #: ../src/guestfs-actions.pod:6045
18093 " guestfs_set_trace (guestfs_h *g,\n"
18099 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4094
18101 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18102 "return values are traced."
18107 #: ../src/guestfs-actions.pod:6052 ../fish/guestfish-actions.pod:4097
18109 "If you want to trace C API calls into libguestfs (and other libraries) then "
18110 "possibly a better way is to use the external ltrace(1) command."
18115 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4101
18117 "Command traces are disabled unless the environment variable "
18118 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18122 #: ../src/guestfs-actions.pod:6059
18124 "Trace messages are normally sent to C<stderr>, unless you register a "
18125 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18130 #: ../src/guestfs-actions.pod:6067
18131 msgid "guestfs_set_verbose"
18136 #: ../src/guestfs-actions.pod:6069
18140 " guestfs_set_verbose (guestfs_h *g,\n"
18146 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4114
18147 msgid "If C<verbose> is true, this turns on verbose messages."
18152 #: ../src/guestfs-actions.pod:6075 ../fish/guestfish-actions.pod:4116
18154 "Verbose messages are disabled unless the environment variable "
18155 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18159 #: ../src/guestfs-actions.pod:6078
18161 "Verbose messages are normally sent to C<stderr>, unless you register a "
18162 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18167 #: ../src/guestfs-actions.pod:6086
18168 msgid "guestfs_setcon"
18173 #: ../src/guestfs-actions.pod:6088
18177 " guestfs_setcon (guestfs_h *g,\n"
18178 " const char *context);\n"
18184 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4127
18186 "This sets the SELinux security context of the daemon to the string "
18192 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4130
18193 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18198 #: ../src/guestfs-actions.pod:6101
18199 msgid "guestfs_setxattr"
18204 #: ../src/guestfs-actions.pod:6103
18208 " guestfs_setxattr (guestfs_h *g,\n"
18209 " const char *xattr,\n"
18210 " const char *val,\n"
18212 " const char *path);\n"
18218 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4136
18220 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18221 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18226 #: ../src/guestfs-actions.pod:6114
18227 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18232 #: ../src/guestfs-actions.pod:6120
18233 msgid "guestfs_sfdisk"
18238 #: ../src/guestfs-actions.pod:6122
18242 " guestfs_sfdisk (guestfs_h *g,\n"
18243 " const char *device,\n"
18247 " char *const *lines);\n"
18253 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4146
18255 "This is a direct interface to the L<sfdisk(8)> program for creating "
18256 "partitions on block devices."
18261 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4149
18262 msgid "C<device> should be a block device, for example C</dev/sda>."
18267 #: ../src/guestfs-actions.pod:6135 ../fish/guestfish-actions.pod:4151
18269 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18270 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18271 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18272 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18273 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18274 "the kernel) cannot work out the right geometry and you will need to tell it."
18279 #: ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:4159
18281 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18282 "refer to the L<sfdisk(8)> manpage."
18287 #: ../src/guestfs-actions.pod:6146 ../fish/guestfish-actions.pod:4162
18289 "To create a single partition occupying the whole disk, you would pass "
18290 "C<lines> as a single element list, when the single element being the string "
18296 #: ../src/guestfs-actions.pod:6150
18298 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18303 #: ../src/guestfs-actions.pod:6160
18304 msgid "guestfs_sfdiskM"
18309 #: ../src/guestfs-actions.pod:6162
18313 " guestfs_sfdiskM (guestfs_h *g,\n"
18314 " const char *device,\n"
18315 " char *const *lines);\n"
18321 #: ../src/guestfs-actions.pod:6167
18323 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18324 "partition sizes are specified in megabytes only (rounded to the nearest "
18325 "cylinder) and you don't need to specify the cyls, heads and sectors "
18326 "parameters which were rarely if ever used anyway."
18331 #: ../src/guestfs-actions.pod:6173
18333 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18334 "C<guestfs_part_disk>"
18339 #: ../src/guestfs-actions.pod:6183
18340 msgid "guestfs_sfdisk_N"
18345 #: ../src/guestfs-actions.pod:6185
18349 " guestfs_sfdisk_N (guestfs_h *g,\n"
18350 " const char *device,\n"
18355 " const char *line);\n"
18361 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4192
18363 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18364 "(note: C<n> counts from 1)."
18369 #: ../src/guestfs-actions.pod:6197
18371 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18372 "for the cyls/heads/sectors parameters."
18377 #: ../src/guestfs-actions.pod:6200
18378 msgid "See also: C<guestfs_part_add>"
18383 #: ../src/guestfs-actions.pod:6209
18384 msgid "guestfs_sfdisk_disk_geometry"
18389 #: ../src/guestfs-actions.pod:6211
18393 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18394 " const char *device);\n"
18400 #: ../src/guestfs-actions.pod:6215
18402 "This displays the disk geometry of C<device> read from the partition table. "
18403 "Especially in the case where the underlying block device has been resized, "
18404 "this can be different from the kernel's idea of the geometry (see "
18405 "C<guestfs_sfdisk_kernel_geometry>)."
18410 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
18411 #: ../fish/guestfish-actions.pod:4212 ../fish/guestfish-actions.pod:4221
18412 msgid "The result is in human-readable format, and not designed to be parsed."
18417 #: ../src/guestfs-actions.pod:6228
18418 msgid "guestfs_sfdisk_kernel_geometry"
18423 #: ../src/guestfs-actions.pod:6230
18427 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18428 " const char *device);\n"
18434 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4219
18435 msgid "This displays the kernel's idea of the geometry of C<device>."
18440 #: ../src/guestfs-actions.pod:6244
18441 msgid "guestfs_sfdisk_l"
18446 #: ../src/guestfs-actions.pod:6246
18450 " guestfs_sfdisk_l (guestfs_h *g,\n"
18451 " const char *device);\n"
18457 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4228
18459 "This displays the partition table on C<device>, in the human-readable output "
18460 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18465 #: ../src/guestfs-actions.pod:6254
18466 msgid "See also: C<guestfs_part_list>"
18471 #: ../src/guestfs-actions.pod:6261
18477 #: ../src/guestfs-actions.pod:6263
18481 " guestfs_sh (guestfs_h *g,\n"
18482 " const char *command);\n"
18488 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4238
18490 "This call runs a command from the guest filesystem via the guest's C</bin/"
18496 #: ../src/guestfs-actions.pod:6270
18497 msgid "This is like C<guestfs_command>, but passes the command to:"
18502 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4243
18505 " /bin/sh -c \"command\"\n"
18511 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4245
18513 "Depending on the guest's shell, this usually results in wildcards being "
18514 "expanded, shell expressions being interpolated and so on."
18519 #: ../src/guestfs-actions.pod:6278
18520 msgid "All the provisos about C<guestfs_command> apply to this call."
18525 #: ../src/guestfs-actions.pod:6285
18526 msgid "guestfs_sh_lines"
18531 #: ../src/guestfs-actions.pod:6287
18535 " guestfs_sh_lines (guestfs_h *g,\n"
18536 " const char *command);\n"
18542 #: ../src/guestfs-actions.pod:6291
18544 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18550 #: ../src/guestfs-actions.pod:6294
18551 msgid "See also: C<guestfs_command_lines>"
18556 #: ../src/guestfs-actions.pod:6302
18557 msgid "guestfs_sleep"
18562 #: ../src/guestfs-actions.pod:6304
18566 " guestfs_sleep (guestfs_h *g,\n"
18573 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4264
18574 msgid "Sleep for C<secs> seconds."
18579 #: ../src/guestfs-actions.pod:6312
18580 msgid "(Added in 1.0.41)"
18585 #: ../src/guestfs-actions.pod:6314 ../src/guestfs-structs.pod:109
18586 msgid "guestfs_stat"
18591 #: ../src/guestfs-actions.pod:6316
18594 " struct guestfs_stat *\n"
18595 " guestfs_stat (guestfs_h *g,\n"
18596 " const char *path);\n"
18602 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4272
18603 msgid "This is the same as the C<stat(2)> system call."
18608 #: ../src/guestfs-actions.pod:6330 ../src/guestfs-structs.pod:135
18609 msgid "guestfs_statvfs"
18614 #: ../src/guestfs-actions.pod:6332
18617 " struct guestfs_statvfs *\n"
18618 " guestfs_statvfs (guestfs_h *g,\n"
18619 " const char *path);\n"
18625 #: ../src/guestfs-actions.pod:6336 ../fish/guestfish-actions.pod:4278
18627 "Returns file system statistics for any mounted file system. C<path> should "
18628 "be a file or directory in the mounted file system (typically it is the mount "
18629 "point itself, but it doesn't need to be)."
18634 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4282
18635 msgid "This is the same as the C<statvfs(2)> system call."
18640 #: ../src/guestfs-actions.pod:6342
18642 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18643 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18648 #: ../src/guestfs-actions.pod:6348
18649 msgid "guestfs_strings"
18654 #: ../src/guestfs-actions.pod:6350
18658 " guestfs_strings (guestfs_h *g,\n"
18659 " const char *path);\n"
18665 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4288
18667 "This runs the L<strings(1)> command on a file and returns the list of "
18668 "printable strings found."
18673 #: ../src/guestfs-actions.pod:6366
18674 msgid "guestfs_strings_e"
18679 #: ../src/guestfs-actions.pod:6368
18683 " guestfs_strings_e (guestfs_h *g,\n"
18684 " const char *encoding,\n"
18685 " const char *path);\n"
18691 #: ../src/guestfs-actions.pod:6373
18693 "This is like the C<guestfs_strings> command, but allows you to specify the "
18694 "encoding of strings that are looked for in the source file C<path>."
18699 #: ../src/guestfs-actions.pod:6377 ../fish/guestfish-actions.pod:4302
18700 msgid "Allowed encodings are:"
18705 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4306
18711 #: ../src/guestfs-actions.pod:6383
18713 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18714 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18719 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4311
18725 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4313
18726 msgid "Single 8-bit-byte characters."
18731 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4315
18737 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4317
18738 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18743 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4320
18744 msgid "l (lower case letter L)"
18749 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4322
18751 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18752 "examining binaries in Windows guests."
18757 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4325
18763 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4327
18764 msgid "32-bit big endian such as UCS-4BE."
18769 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4329
18775 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4331
18776 msgid "32-bit little endian such as UCS-4LE."
18781 #: ../src/guestfs-actions.pod:6410 ../fish/guestfish-actions.pod:4335
18782 msgid "The returned strings are transcoded to UTF-8."
18787 #: ../src/guestfs-actions.pod:6421
18788 msgid "guestfs_swapoff_device"
18793 #: ../src/guestfs-actions.pod:6423
18797 " guestfs_swapoff_device (guestfs_h *g,\n"
18798 " const char *device);\n"
18804 #: ../src/guestfs-actions.pod:6427
18806 "This command disables the libguestfs appliance swap device or partition "
18807 "named C<device>. See C<guestfs_swapon_device>."
18812 #: ../src/guestfs-actions.pod:6435
18813 msgid "guestfs_swapoff_file"
18818 #: ../src/guestfs-actions.pod:6437
18822 " guestfs_swapoff_file (guestfs_h *g,\n"
18823 " const char *file);\n"
18829 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4352
18830 msgid "This command disables the libguestfs appliance swap on file."
18835 #: ../src/guestfs-actions.pod:6447
18836 msgid "guestfs_swapoff_label"
18841 #: ../src/guestfs-actions.pod:6449
18845 " guestfs_swapoff_label (guestfs_h *g,\n"
18846 " const char *label);\n"
18852 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4358
18854 "This command disables the libguestfs appliance swap on labeled swap "
18860 #: ../src/guestfs-actions.pod:6460
18861 msgid "guestfs_swapoff_uuid"
18866 #: ../src/guestfs-actions.pod:6462
18870 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18871 " const char *uuid);\n"
18877 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4365
18879 "This command disables the libguestfs appliance swap partition with the given "
18885 #: ../src/guestfs-actions.pod:6473
18886 msgid "guestfs_swapon_device"
18891 #: ../src/guestfs-actions.pod:6475
18895 " guestfs_swapon_device (guestfs_h *g,\n"
18896 " const char *device);\n"
18902 #: ../src/guestfs-actions.pod:6479
18904 "This command enables the libguestfs appliance to use the swap device or "
18905 "partition named C<device>. The increased memory is made available for all "
18906 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18911 #: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4377
18913 "Note that you should not swap to existing guest swap partitions unless you "
18914 "know what you are doing. They may contain hibernation information, or other "
18915 "information that the guest doesn't want you to trash. You also risk leaking "
18916 "information about the host to the guest this way. Instead, attach a new "
18917 "host device to the guest and swap on that."
18922 #: ../src/guestfs-actions.pod:6495
18923 msgid "guestfs_swapon_file"
18928 #: ../src/guestfs-actions.pod:6497
18932 " guestfs_swapon_file (guestfs_h *g,\n"
18933 " const char *file);\n"
18939 #: ../src/guestfs-actions.pod:6501
18941 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18947 #: ../src/guestfs-actions.pod:6508
18948 msgid "guestfs_swapon_label"
18953 #: ../src/guestfs-actions.pod:6510
18957 " guestfs_swapon_label (guestfs_h *g,\n"
18958 " const char *label);\n"
18964 #: ../src/guestfs-actions.pod:6514
18966 "This command enables swap to a labeled swap partition. See "
18967 "C<guestfs_swapon_device> for other notes."
18972 #: ../src/guestfs-actions.pod:6521
18973 msgid "guestfs_swapon_uuid"
18978 #: ../src/guestfs-actions.pod:6523
18982 " guestfs_swapon_uuid (guestfs_h *g,\n"
18983 " const char *uuid);\n"
18989 #: ../src/guestfs-actions.pod:6527
18991 "This command enables swap to a swap partition with the given UUID. See "
18992 "C<guestfs_swapon_device> for other notes."
18997 #: ../src/guestfs-actions.pod:6534
18998 msgid "guestfs_sync"
19003 #: ../src/guestfs-actions.pod:6536
19007 " guestfs_sync (guestfs_h *g);\n"
19013 #: ../src/guestfs-actions.pod:6539 ../fish/guestfish-actions.pod:4409
19015 "This syncs the disk, so that any writes are flushed through to the "
19016 "underlying disk image."
19021 #: ../src/guestfs-actions.pod:6542 ../fish/guestfish-actions.pod:4412
19023 "You should always call this if you have modified a disk image, before "
19024 "closing the handle."
19029 #: ../src/guestfs-actions.pod:6549
19030 msgid "guestfs_tail"
19035 #: ../src/guestfs-actions.pod:6551
19039 " guestfs_tail (guestfs_h *g,\n"
19040 " const char *path);\n"
19046 #: ../src/guestfs-actions.pod:6555 ../fish/guestfish-actions.pod:4419
19048 "This command returns up to the last 10 lines of a file as a list of strings."
19053 #: ../src/guestfs-actions.pod:6567
19054 msgid "guestfs_tail_n"
19059 #: ../src/guestfs-actions.pod:6569
19063 " guestfs_tail_n (guestfs_h *g,\n"
19065 " const char *path);\n"
19071 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4429
19073 "If the parameter C<nrlines> is a positive number, this returns the last "
19074 "C<nrlines> lines of the file C<path>."
19079 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4432
19081 "If the parameter C<nrlines> is a negative number, this returns lines from "
19082 "the file C<path>, starting with the C<-nrlines>th line."
19087 #: ../src/guestfs-actions.pod:6591
19088 msgid "guestfs_tar_in"
19093 #: ../src/guestfs-actions.pod:6593
19097 " guestfs_tar_in (guestfs_h *g,\n"
19098 " const char *tarfile,\n"
19099 " const char *directory);\n"
19105 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4444
19107 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19108 "tar file) into C<directory>."
19113 #: ../src/guestfs-actions.pod:6601
19115 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19120 #: ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:6623
19121 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6655
19122 msgid "(Added in 1.0.3)"
19127 #: ../src/guestfs-actions.pod:6608
19128 msgid "guestfs_tar_out"
19133 #: ../src/guestfs-actions.pod:6610
19137 " guestfs_tar_out (guestfs_h *g,\n"
19138 " const char *directory,\n"
19139 " const char *tarfile);\n"
19145 #: ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:4456
19147 "This command packs the contents of C<directory> and downloads it to local "
19153 #: ../src/guestfs-actions.pod:6618
19155 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19156 "C<guestfs_txz_out>."
19161 #: ../src/guestfs-actions.pod:6625
19162 msgid "guestfs_tgz_in"
19167 #: ../src/guestfs-actions.pod:6627
19171 " guestfs_tgz_in (guestfs_h *g,\n"
19172 " const char *tarball,\n"
19173 " const char *directory);\n"
19179 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4468
19181 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19182 "tar file) into C<directory>."
19187 #: ../src/guestfs-actions.pod:6635
19188 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19193 #: ../src/guestfs-actions.pod:6641
19194 msgid "guestfs_tgz_out"
19199 #: ../src/guestfs-actions.pod:6643
19203 " guestfs_tgz_out (guestfs_h *g,\n"
19204 " const char *directory,\n"
19205 " const char *tarball);\n"
19211 #: ../src/guestfs-actions.pod:6648 ../fish/guestfish-actions.pod:4479
19213 "This command packs the contents of C<directory> and downloads it to local "
19219 #: ../src/guestfs-actions.pod:6651
19220 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19225 #: ../src/guestfs-actions.pod:6657
19226 msgid "guestfs_touch"
19231 #: ../src/guestfs-actions.pod:6659
19235 " guestfs_touch (guestfs_h *g,\n"
19236 " const char *path);\n"
19242 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4490
19244 "Touch acts like the L<touch(1)> command. It can be used to update the "
19245 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19251 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4494
19253 "This command only works on regular files, and will fail on other file types "
19254 "such as directories, symbolic links, block special etc."
19259 #: ../src/guestfs-actions.pod:6674
19260 msgid "guestfs_truncate"
19265 #: ../src/guestfs-actions.pod:6676
19269 " guestfs_truncate (guestfs_h *g,\n"
19270 " const char *path);\n"
19276 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4501
19278 "This command truncates C<path> to a zero-length file. The file must exist "
19284 #: ../src/guestfs-actions.pod:6687
19285 msgid "guestfs_truncate_size"
19290 #: ../src/guestfs-actions.pod:6689
19294 " guestfs_truncate_size (guestfs_h *g,\n"
19295 " const char *path,\n"
19296 " int64_t size);\n"
19302 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4508
19304 "This command truncates C<path> to size C<size> bytes. The file must exist "
19310 #: ../src/guestfs-actions.pod:6697
19312 "If the current file size is less than C<size> then the file is extended to "
19313 "the required size with zero bytes. This creates a sparse file (ie. disk "
19314 "blocks are not allocated for the file until you write to it). To create a "
19315 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19320 #: ../src/guestfs-actions.pod:6707
19321 msgid "guestfs_tune2fs_l"
19326 #: ../src/guestfs-actions.pod:6709
19330 " guestfs_tune2fs_l (guestfs_h *g,\n"
19331 " const char *device);\n"
19337 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4521
19339 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19345 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4524
19347 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19348 "for more details. The list of fields returned isn't clearly defined, and "
19349 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19350 "and the filesystem itself."
19355 #: ../src/guestfs-actions.pod:6729
19356 msgid "guestfs_txz_in"
19361 #: ../src/guestfs-actions.pod:6731
19365 " guestfs_txz_in (guestfs_h *g,\n"
19366 " const char *tarball,\n"
19367 " const char *directory);\n"
19373 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4533
19375 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19376 "tar file) into C<directory>."
19381 #: ../src/guestfs-actions.pod:6743
19382 msgid "guestfs_txz_out"
19387 #: ../src/guestfs-actions.pod:6745
19391 " guestfs_txz_out (guestfs_h *g,\n"
19392 " const char *directory,\n"
19393 " const char *tarball);\n"
19399 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4542
19401 "This command packs the contents of C<directory> and downloads it to local "
19402 "file C<tarball> (as an xz compressed tar archive)."
19407 #: ../src/guestfs-actions.pod:6757
19408 msgid "guestfs_umask"
19413 #: ../src/guestfs-actions.pod:6759
19417 " guestfs_umask (guestfs_h *g,\n"
19424 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4551
19426 "This function sets the mask used for creating new files and device nodes to "
19432 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4554
19434 "Typical umask values would be C<022> which creates new files with "
19435 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19436 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19441 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4559
19443 "The default umask is C<022>. This is important because it means that "
19444 "directories and device nodes will be created with C<0644> or C<0755> mode "
19445 "even if you specify C<0777>."
19450 #: ../src/guestfs-actions.pod:6775
19452 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19453 "C<guestfs_mkdir>."
19458 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4566
19459 msgid "This call returns the previous umask."
19464 #: ../src/guestfs-actions.pod:6784
19465 msgid "guestfs_umount"
19470 #: ../src/guestfs-actions.pod:6786
19474 " guestfs_umount (guestfs_h *g,\n"
19475 " const char *pathordevice);\n"
19481 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4574
19483 "This unmounts the given filesystem. The filesystem may be specified either "
19484 "by its mountpoint (path) or the device which contains the filesystem."
19489 #: ../src/guestfs-actions.pod:6798
19490 msgid "guestfs_umount_all"
19495 #: ../src/guestfs-actions.pod:6800
19499 " guestfs_umount_all (guestfs_h *g);\n"
19505 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4584
19506 msgid "This unmounts all mounted filesystems."
19511 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4586
19512 msgid "Some internal mounts are not unmounted by this call."
19517 #: ../src/guestfs-actions.pod:6811
19518 msgid "guestfs_upload"
19523 #: ../src/guestfs-actions.pod:6813
19527 " guestfs_upload (guestfs_h *g,\n"
19528 " const char *filename,\n"
19529 " const char *remotefilename);\n"
19535 #: ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6842
19536 #: ../fish/guestfish-actions.pod:4592 ../fish/guestfish-actions.pod:4605
19537 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19542 #: ../src/guestfs-actions.pod:6823
19543 msgid "See also C<guestfs_download>."
19548 #: ../src/guestfs-actions.pod:6834
19549 msgid "guestfs_upload_offset"
19554 #: ../src/guestfs-actions.pod:6836
19558 " guestfs_upload_offset (guestfs_h *g,\n"
19559 " const char *filename,\n"
19560 " const char *remotefilename,\n"
19561 " int64_t offset);\n"
19567 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4608
19569 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19570 "The intention is to overwrite parts of existing files or devices, although "
19571 "if a non-existant file is specified then it is created with a \"hole\" "
19572 "before C<offset>. The size of the data written is implicit in the size of "
19573 "the source C<filename>."
19578 #: ../src/guestfs-actions.pod:6852
19580 "Note that there is no limit on the amount of data that can be uploaded with "
19581 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19582 "full amount unless an error occurs."
19587 #: ../src/guestfs-actions.pod:6857
19588 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19593 #: ../src/guestfs-actions.pod:6868
19594 msgid "guestfs_utimens"
19599 #: ../src/guestfs-actions.pod:6870
19603 " guestfs_utimens (guestfs_h *g,\n"
19604 " const char *path,\n"
19605 " int64_t atsecs,\n"
19606 " int64_t atnsecs,\n"
19607 " int64_t mtsecs,\n"
19608 " int64_t mtnsecs);\n"
19614 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4628
19615 msgid "This command sets the timestamps of a file with nanosecond precision."
19620 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4631
19622 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19628 #: ../src/guestfs-actions.pod:6884 ../fish/guestfish-actions.pod:4634
19630 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19631 "nanoseconds from the epoch."
19636 #: ../src/guestfs-actions.pod:6887 ../fish/guestfish-actions.pod:4637
19638 "If the C<*nsecs> field contains the special value C<-1> then the "
19639 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19640 "ignored in this case)."
19645 #: ../src/guestfs-actions.pod:6891 ../fish/guestfish-actions.pod:4641
19647 "If the C<*nsecs> field contains the special value C<-2> then the "
19648 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19654 #: ../src/guestfs-actions.pod:6899 ../src/guestfs-structs.pod:175
19655 msgid "guestfs_version"
19660 #: ../src/guestfs-actions.pod:6901
19663 " struct guestfs_version *\n"
19664 " guestfs_version (guestfs_h *g);\n"
19670 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4649
19672 "Return the libguestfs version number that the program is linked against."
19677 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4652
19679 "Note that because of dynamic linking this is not necessarily the version of "
19680 "libguestfs that you compiled against. You can compile the program, and then "
19681 "at runtime dynamically link against a completely different C<libguestfs.so> "
19687 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4657
19689 "This call was added in version C<1.0.58>. In previous versions of "
19690 "libguestfs there was no way to get the version number. From C code you can "
19691 "use dynamic linker functions to find out if this symbol exists (if it "
19692 "doesn't, then it's an earlier version)."
19697 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4663
19699 "The call returns a structure with four elements. The first three (C<major>, "
19700 "C<minor> and C<release>) are numbers and correspond to the usual version "
19701 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19702 "but may be used for distro-specific information."
19707 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4669
19709 "To construct the original version string: C<$major.$minor.$release$extra>"
19714 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4672
19715 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19720 #: ../src/guestfs-actions.pod:6929
19722 "I<Note:> Don't use this call to test for availability of features. In "
19723 "enterprise distributions we backport features from later versions into "
19724 "earlier versions, making this an unreliable way to test for features. Use "
19725 "C<guestfs_available> instead."
19730 #: ../src/guestfs-actions.pod:6935
19732 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19733 "error. I<The caller must call C<guestfs_free_version> after use>."
19738 #: ../src/guestfs-actions.pod:6939
19739 msgid "(Added in 1.0.58)"
19744 #: ../src/guestfs-actions.pod:6941
19745 msgid "guestfs_vfs_label"
19750 #: ../src/guestfs-actions.pod:6943
19754 " guestfs_vfs_label (guestfs_h *g,\n"
19755 " const char *device);\n"
19761 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4684
19762 msgid "This returns the filesystem label of the filesystem on C<device>."
19767 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4687
19768 msgid "If the filesystem is unlabeled, this returns the empty string."
19773 #: ../src/guestfs-actions.pod:6952
19774 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19779 #: ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:6994
19780 msgid "(Added in 1.3.18)"
19785 #: ../src/guestfs-actions.pod:6959
19786 msgid "guestfs_vfs_type"
19791 #: ../src/guestfs-actions.pod:6961
19795 " guestfs_vfs_type (guestfs_h *g,\n"
19796 " const char *device);\n"
19802 #: ../src/guestfs-actions.pod:6965 ../fish/guestfish-actions.pod:4695
19804 "This command gets the filesystem type corresponding to the filesystem on "
19810 #: ../src/guestfs-actions.pod:6968 ../fish/guestfish-actions.pod:4698
19812 "For most filesystems, the result is the name of the Linux VFS module which "
19813 "would be used to mount this filesystem if you mounted it without specifying "
19814 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19819 #: ../src/guestfs-actions.pod:6978
19820 msgid "guestfs_vfs_uuid"
19825 #: ../src/guestfs-actions.pod:6980
19829 " guestfs_vfs_uuid (guestfs_h *g,\n"
19830 " const char *device);\n"
19836 #: ../src/guestfs-actions.pod:6984 ../fish/guestfish-actions.pod:4707
19837 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19842 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4710
19843 msgid "If the filesystem does not have a UUID, this returns the empty string."
19848 #: ../src/guestfs-actions.pod:6989
19849 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19854 #: ../src/guestfs-actions.pod:6996
19855 msgid "guestfs_vg_activate"
19860 #: ../src/guestfs-actions.pod:6998
19864 " guestfs_vg_activate (guestfs_h *g,\n"
19866 " char *const *volgroups);\n"
19872 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4718
19874 "This command activates or (if C<activate> is false) deactivates all logical "
19875 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19876 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19877 "deactivated, then those devices disappear."
19882 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4724
19883 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19888 #: ../src/guestfs-actions.pod:7011 ../fish/guestfish-actions.pod:4726
19890 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19891 "activated or deactivated."
19896 #: ../src/guestfs-actions.pod:7018
19897 msgid "guestfs_vg_activate_all"
19902 #: ../src/guestfs-actions.pod:7020
19906 " guestfs_vg_activate_all (guestfs_h *g,\n"
19907 " int activate);\n"
19913 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4733
19915 "This command activates or (if C<activate> is false) deactivates all logical "
19916 "volumes in all volume groups. If activated, then they are made known to the "
19917 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19918 "those devices disappear."
19923 #: ../src/guestfs-actions.pod:7030 ../fish/guestfish-actions.pod:4739
19924 msgid "This command is the same as running C<vgchange -a y|n>"
19929 #: ../src/guestfs-actions.pod:7036
19930 msgid "guestfs_vgcreate"
19935 #: ../src/guestfs-actions.pod:7038
19939 " guestfs_vgcreate (guestfs_h *g,\n"
19940 " const char *volgroup,\n"
19941 " char *const *physvols);\n"
19947 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4745
19949 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19950 "of physical volumes C<physvols>."
19955 #: ../src/guestfs-actions.pod:7050
19956 msgid "guestfs_vglvuuids"
19961 #: ../src/guestfs-actions.pod:7052
19965 " guestfs_vglvuuids (guestfs_h *g,\n"
19966 " const char *vgname);\n"
19972 #: ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:4752
19974 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19975 "volumes created in this volume group."
19980 #: ../src/guestfs-actions.pod:7059
19982 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19983 "associate logical volumes and volume groups."
19988 #: ../src/guestfs-actions.pod:7062
19989 msgid "See also C<guestfs_vgpvuuids>."
19994 #: ../src/guestfs-actions.pod:7070
19995 msgid "guestfs_vgpvuuids"
20000 #: ../src/guestfs-actions.pod:7072
20004 " guestfs_vgpvuuids (guestfs_h *g,\n"
20005 " const char *vgname);\n"
20011 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4764
20013 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20014 "volumes that this volume group resides on."
20019 #: ../src/guestfs-actions.pod:7079
20021 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20022 "associate physical volumes and volume groups."
20027 #: ../src/guestfs-actions.pod:7082
20028 msgid "See also C<guestfs_vglvuuids>."
20033 #: ../src/guestfs-actions.pod:7090
20034 msgid "guestfs_vgremove"
20039 #: ../src/guestfs-actions.pod:7092
20043 " guestfs_vgremove (guestfs_h *g,\n"
20044 " const char *vgname);\n"
20050 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4776
20051 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20056 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4778
20058 "This also forcibly removes all logical volumes in the volume group (if any)."
20063 #: ../src/guestfs-actions.pod:7105
20064 msgid "guestfs_vgrename"
20069 #: ../src/guestfs-actions.pod:7107
20073 " guestfs_vgrename (guestfs_h *g,\n"
20074 " const char *volgroup,\n"
20075 " const char *newvolgroup);\n"
20081 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4785
20082 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20087 #: ../src/guestfs-actions.pod:7118
20088 msgid "guestfs_vgs"
20093 #: ../src/guestfs-actions.pod:7120
20097 " guestfs_vgs (guestfs_h *g);\n"
20103 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4791
20105 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20111 #: ../src/guestfs-actions.pod:7126 ../fish/guestfish-actions.pod:4794
20113 "This returns a list of just the volume group names that were detected (eg. "
20119 #: ../src/guestfs-actions.pod:7129
20120 msgid "See also C<guestfs_vgs_full>."
20125 #: ../src/guestfs-actions.pod:7137
20126 msgid "guestfs_vgs_full"
20131 #: ../src/guestfs-actions.pod:7139
20134 " struct guestfs_lvm_vg_list *\n"
20135 " guestfs_vgs_full (guestfs_h *g);\n"
20141 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4803
20143 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20144 "> command. The \"full\" version includes all fields."
20149 #: ../src/guestfs-actions.pod:7145
20151 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20152 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20157 #: ../src/guestfs-actions.pod:7151
20158 msgid "guestfs_vgscan"
20163 #: ../src/guestfs-actions.pod:7153
20167 " guestfs_vgscan (guestfs_h *g);\n"
20173 #: ../src/guestfs-actions.pod:7156 ../fish/guestfish-actions.pod:4810
20175 "This rescans all block devices and rebuilds the list of LVM physical "
20176 "volumes, volume groups and logical volumes."
20181 #: ../src/guestfs-actions.pod:7163
20182 msgid "guestfs_vguuid"
20187 #: ../src/guestfs-actions.pod:7165
20191 " guestfs_vguuid (guestfs_h *g,\n"
20192 " const char *vgname);\n"
20198 #: ../src/guestfs-actions.pod:7169 ../fish/guestfish-actions.pod:4817
20199 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20204 #: ../src/guestfs-actions.pod:7176
20205 msgid "guestfs_wait_ready"
20210 #: ../src/guestfs-actions.pod:7178
20214 " guestfs_wait_ready (guestfs_h *g);\n"
20220 #: ../src/guestfs-actions.pod:7181
20221 msgid "This function is a no op."
20226 #: ../src/guestfs-actions.pod:7183
20228 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20229 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20230 "is no longer necessary because C<guestfs_launch> now does the waiting."
20235 #: ../src/guestfs-actions.pod:7188
20237 "If you see any calls to this function in code then you can just remove them, "
20238 "unless you want to retain compatibility with older versions of the API."
20243 #: ../src/guestfs-actions.pod:7196
20244 msgid "guestfs_wc_c"
20249 #: ../src/guestfs-actions.pod:7198
20253 " guestfs_wc_c (guestfs_h *g,\n"
20254 " const char *path);\n"
20260 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4823
20262 "This command counts the characters in a file, using the C<wc -c> external "
20268 #: ../src/guestfs-actions.pod:7209
20269 msgid "guestfs_wc_l"
20274 #: ../src/guestfs-actions.pod:7211
20278 " guestfs_wc_l (guestfs_h *g,\n"
20279 " const char *path);\n"
20285 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4830
20287 "This command counts the lines in a file, using the C<wc -l> external command."
20292 #: ../src/guestfs-actions.pod:7222
20293 msgid "guestfs_wc_w"
20298 #: ../src/guestfs-actions.pod:7224
20302 " guestfs_wc_w (guestfs_h *g,\n"
20303 " const char *path);\n"
20309 #: ../src/guestfs-actions.pod:7228 ../fish/guestfish-actions.pod:4837
20311 "This command counts the words in a file, using the C<wc -w> external command."
20316 #: ../src/guestfs-actions.pod:7235
20317 msgid "guestfs_write"
20322 #: ../src/guestfs-actions.pod:7237
20326 " guestfs_write (guestfs_h *g,\n"
20327 " const char *path,\n"
20328 " const char *content,\n"
20329 " size_t content_size);\n"
20335 #: ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4844
20337 "This call creates a file called C<path>. The content of the file is the "
20338 "string C<content> (which can contain any 8 bit data)."
20343 #: ../src/guestfs-actions.pod:7253
20344 msgid "guestfs_write_file"
20349 #: ../src/guestfs-actions.pod:7255
20353 " guestfs_write_file (guestfs_h *g,\n"
20354 " const char *path,\n"
20355 " const char *content,\n"
20362 #: ../src/guestfs-actions.pod:7261 ../fish/guestfish-actions.pod:4854
20364 "This call creates a file called C<path>. The contents of the file is the "
20365 "string C<content> (which can contain any 8 bit data), with length C<size>."
20370 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:4858
20372 "As a special case, if C<size> is C<0> then the length is calculated using "
20373 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20378 #: ../src/guestfs-actions.pod:7269 ../fish/guestfish-actions.pod:4862
20380 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20381 "I<not> work, even if the length is specified."
20386 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4868
20388 "This function is deprecated. In new code, use the C<write> call instead."
20393 #: ../src/guestfs-actions.pod:7286
20394 msgid "guestfs_zegrep"
20399 #: ../src/guestfs-actions.pod:7288
20403 " guestfs_zegrep (guestfs_h *g,\n"
20404 " const char *regex,\n"
20405 " const char *path);\n"
20411 #: ../src/guestfs-actions.pod:7293 ../fish/guestfish-actions.pod:4879
20413 "This calls the external C<zegrep> program and returns the matching lines."
20418 #: ../src/guestfs-actions.pod:7305
20419 msgid "guestfs_zegrepi"
20424 #: ../src/guestfs-actions.pod:7307
20428 " guestfs_zegrepi (guestfs_h *g,\n"
20429 " const char *regex,\n"
20430 " const char *path);\n"
20436 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4889
20438 "This calls the external C<zegrep -i> program and returns the matching lines."
20443 #: ../src/guestfs-actions.pod:7324
20444 msgid "guestfs_zero"
20449 #: ../src/guestfs-actions.pod:7326
20453 " guestfs_zero (guestfs_h *g,\n"
20454 " const char *device);\n"
20460 #: ../src/guestfs-actions.pod:7330 ../fish/guestfish-actions.pod:4899
20461 msgid "This command writes zeroes over the first few blocks of C<device>."
20466 #: ../src/guestfs-actions.pod:7332 ../fish/guestfish-actions.pod:4901
20468 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20469 "securely wipe the device). It should be sufficient to remove any partition "
20470 "tables, filesystem superblocks and so on."
20475 #: ../src/guestfs-actions.pod:7336
20476 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20481 #: ../src/guestfs-actions.pod:7347
20482 msgid "guestfs_zero_device"
20487 #: ../src/guestfs-actions.pod:7349
20491 " guestfs_zero_device (guestfs_h *g,\n"
20492 " const char *device);\n"
20498 #: ../src/guestfs-actions.pod:7353
20500 "This command writes zeroes over the entire C<device>. Compare with "
20501 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20506 #: ../src/guestfs-actions.pod:7367
20507 msgid "(Added in 1.3.1)"
20512 #: ../src/guestfs-actions.pod:7369
20513 msgid "guestfs_zerofree"
20518 #: ../src/guestfs-actions.pod:7371
20522 " guestfs_zerofree (guestfs_h *g,\n"
20523 " const char *device);\n"
20529 #: ../src/guestfs-actions.pod:7375 ../fish/guestfish-actions.pod:4922
20531 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20532 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20533 "possible to compress the filesystem more effectively."
20538 #: ../src/guestfs-actions.pod:7380 ../fish/guestfish-actions.pod:4927
20539 msgid "You should B<not> run this program if the filesystem is mounted."
20544 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4930
20546 "It is possible that using this program can damage the filesystem or data on "
20552 #: ../src/guestfs-actions.pod:7390
20553 msgid "guestfs_zfgrep"
20558 #: ../src/guestfs-actions.pod:7392
20562 " guestfs_zfgrep (guestfs_h *g,\n"
20563 " const char *pattern,\n"
20564 " const char *path);\n"
20570 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4937
20572 "This calls the external C<zfgrep> program and returns the matching lines."
20577 #: ../src/guestfs-actions.pod:7409
20578 msgid "guestfs_zfgrepi"
20583 #: ../src/guestfs-actions.pod:7411
20587 " guestfs_zfgrepi (guestfs_h *g,\n"
20588 " const char *pattern,\n"
20589 " const char *path);\n"
20595 #: ../src/guestfs-actions.pod:7416 ../fish/guestfish-actions.pod:4947
20597 "This calls the external C<zfgrep -i> program and returns the matching lines."
20602 #: ../src/guestfs-actions.pod:7428
20603 msgid "guestfs_zfile"
20608 #: ../src/guestfs-actions.pod:7430
20612 " guestfs_zfile (guestfs_h *g,\n"
20613 " const char *meth,\n"
20614 " const char *path);\n"
20620 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4957
20622 "This command runs C<file> after first decompressing C<path> using C<method>."
20627 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4960
20628 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20633 #: ../src/guestfs-actions.pod:7440
20635 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20641 #: ../src/guestfs-actions.pod:7446 ../fish/guestfish-actions.pod:4965
20643 "This function is deprecated. In new code, use the C<file> call instead."
20648 #: ../src/guestfs-actions.pod:7455
20649 msgid "guestfs_zgrep"
20654 #: ../src/guestfs-actions.pod:7457
20658 " guestfs_zgrep (guestfs_h *g,\n"
20659 " const char *regex,\n"
20660 " const char *path);\n"
20666 #: ../src/guestfs-actions.pod:7462 ../fish/guestfish-actions.pod:4976
20668 "This calls the external C<zgrep> program and returns the matching lines."
20673 #: ../src/guestfs-actions.pod:7474
20674 msgid "guestfs_zgrepi"
20679 #: ../src/guestfs-actions.pod:7476
20683 " guestfs_zgrepi (guestfs_h *g,\n"
20684 " const char *regex,\n"
20685 " const char *path);\n"
20691 #: ../src/guestfs-actions.pod:7481 ../fish/guestfish-actions.pod:4986
20693 "This calls the external C<zgrep -i> program and returns the matching lines."
20698 #: ../src/guestfs-availability.pod:3
20704 #: ../src/guestfs-availability.pod:5
20706 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20707 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20708 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20709 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20710 "L</guestfs_aug_save> L</guestfs_aug_set>"
20715 #: ../src/guestfs-availability.pod:21
20721 #: ../src/guestfs-availability.pod:23
20723 "The following functions: L</guestfs_inotify_add_watch> L</"
20724 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20725 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20730 #: ../src/guestfs-availability.pod:31
20731 msgid "B<linuxfsuuid>"
20736 #: ../src/guestfs-availability.pod:33
20738 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20739 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20744 #: ../src/guestfs-availability.pod:40
20745 msgid "B<linuxmodules>"
20750 #: ../src/guestfs-availability.pod:42
20751 msgid "The following functions: L</guestfs_modprobe>"
20756 #: ../src/guestfs-availability.pod:45
20757 msgid "B<linuxxattrs>"
20762 #: ../src/guestfs-availability.pod:47
20764 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20765 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20766 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20767 "guestfs_setxattr>"
20772 #: ../src/guestfs-availability.pod:58
20778 #: ../src/guestfs-availability.pod:60
20780 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20781 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20782 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20787 #: ../src/guestfs-availability.pod:69
20793 #: ../src/guestfs-availability.pod:71
20795 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20796 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20797 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20798 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20799 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20800 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20801 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20806 #: ../src/guestfs-availability.pod:94
20812 #: ../src/guestfs-availability.pod:96
20814 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20815 "guestfs_mknod_b> L</guestfs_mknod_c>"
20820 #: ../src/guestfs-availability.pod:102
20826 #: ../src/guestfs-availability.pod:104
20827 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20832 #: ../src/guestfs-availability.pod:107
20833 msgid "B<ntfsprogs>"
20838 #: ../src/guestfs-availability.pod:109
20840 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20845 #: ../src/guestfs-availability.pod:113
20846 msgid "B<realpath>"
20851 #: ../src/guestfs-availability.pod:115
20852 msgid "The following functions: L</guestfs_realpath>"
20857 #: ../src/guestfs-availability.pod:118
20863 #: ../src/guestfs-availability.pod:120
20865 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20866 "guestfs_scrub_freespace>"
20871 #: ../src/guestfs-availability.pod:125
20877 #: ../src/guestfs-availability.pod:127
20878 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20883 #: ../src/guestfs-availability.pod:131
20889 #: ../src/guestfs-availability.pod:133
20890 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20895 #: ../src/guestfs-availability.pod:137
20896 msgid "B<zerofree>"
20901 #: ../src/guestfs-availability.pod:139
20902 msgid "The following functions: L</guestfs_zerofree>"
20907 #: ../src/guestfs-structs.pod:1
20908 msgid "guestfs_int_bool"
20913 #: ../src/guestfs-structs.pod:3
20916 " struct guestfs_int_bool {\n"
20925 #: ../src/guestfs-structs.pod:8
20928 " struct guestfs_int_bool_list {\n"
20929 " uint32_t len; /* Number of elements in list. */\n"
20930 " struct guestfs_int_bool *val; /* Elements. */\n"
20937 #: ../src/guestfs-structs.pod:13
20940 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20941 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20947 #: ../src/guestfs-structs.pod:16
20948 msgid "guestfs_lvm_pv"
20953 #: ../src/guestfs-structs.pod:18
20956 " struct guestfs_lvm_pv {\n"
20957 " char *pv_name;\n"
20958 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20959 " char pv_uuid[32];\n"
20961 " uint64_t pv_size;\n"
20962 " uint64_t dev_size;\n"
20963 " uint64_t pv_free;\n"
20964 " uint64_t pv_used;\n"
20965 " char *pv_attr;\n"
20966 " int64_t pv_pe_count;\n"
20967 " int64_t pv_pe_alloc_count;\n"
20968 " char *pv_tags;\n"
20969 " uint64_t pe_start;\n"
20970 " int64_t pv_mda_count;\n"
20971 " uint64_t pv_mda_free;\n"
20978 #: ../src/guestfs-structs.pod:36
20981 " struct guestfs_lvm_pv_list {\n"
20982 " uint32_t len; /* Number of elements in list. */\n"
20983 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20990 #: ../src/guestfs-structs.pod:41
20993 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20994 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
21000 #: ../src/guestfs-structs.pod:44
21001 msgid "guestfs_lvm_vg"
21006 #: ../src/guestfs-structs.pod:46
21009 " struct guestfs_lvm_vg {\n"
21010 " char *vg_name;\n"
21011 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21012 " char vg_uuid[32];\n"
21014 " char *vg_attr;\n"
21015 " uint64_t vg_size;\n"
21016 " uint64_t vg_free;\n"
21017 " char *vg_sysid;\n"
21018 " uint64_t vg_extent_size;\n"
21019 " int64_t vg_extent_count;\n"
21020 " int64_t vg_free_count;\n"
21021 " int64_t max_lv;\n"
21022 " int64_t max_pv;\n"
21023 " int64_t pv_count;\n"
21024 " int64_t lv_count;\n"
21025 " int64_t snap_count;\n"
21026 " int64_t vg_seqno;\n"
21027 " char *vg_tags;\n"
21028 " int64_t vg_mda_count;\n"
21029 " uint64_t vg_mda_free;\n"
21036 #: ../src/guestfs-structs.pod:69
21039 " struct guestfs_lvm_vg_list {\n"
21040 " uint32_t len; /* Number of elements in list. */\n"
21041 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21048 #: ../src/guestfs-structs.pod:74
21051 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21052 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21058 #: ../src/guestfs-structs.pod:77
21059 msgid "guestfs_lvm_lv"
21064 #: ../src/guestfs-structs.pod:79
21067 " struct guestfs_lvm_lv {\n"
21068 " char *lv_name;\n"
21069 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21070 " char lv_uuid[32];\n"
21071 " char *lv_attr;\n"
21072 " int64_t lv_major;\n"
21073 " int64_t lv_minor;\n"
21074 " int64_t lv_kernel_major;\n"
21075 " int64_t lv_kernel_minor;\n"
21076 " uint64_t lv_size;\n"
21077 " int64_t seg_count;\n"
21079 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21080 " float snap_percent;\n"
21081 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21082 " float copy_percent;\n"
21083 " char *move_pv;\n"
21084 " char *lv_tags;\n"
21085 " char *mirror_log;\n"
21086 " char *modules;\n"
21093 #: ../src/guestfs-structs.pod:101
21096 " struct guestfs_lvm_lv_list {\n"
21097 " uint32_t len; /* Number of elements in list. */\n"
21098 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21105 #: ../src/guestfs-structs.pod:106
21108 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21109 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21115 #: ../src/guestfs-structs.pod:111
21118 " struct guestfs_stat {\n"
21122 " int64_t nlink;\n"
21127 " int64_t blksize;\n"
21128 " int64_t blocks;\n"
21129 " int64_t atime;\n"
21130 " int64_t mtime;\n"
21131 " int64_t ctime;\n"
21138 #: ../src/guestfs-structs.pod:127
21141 " struct guestfs_stat_list {\n"
21142 " uint32_t len; /* Number of elements in list. */\n"
21143 " struct guestfs_stat *val; /* Elements. */\n"
21150 #: ../src/guestfs-structs.pod:132
21153 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21154 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21160 #: ../src/guestfs-structs.pod:137
21163 " struct guestfs_statvfs {\n"
21164 " int64_t bsize;\n"
21165 " int64_t frsize;\n"
21166 " int64_t blocks;\n"
21167 " int64_t bfree;\n"
21168 " int64_t bavail;\n"
21169 " int64_t files;\n"
21170 " int64_t ffree;\n"
21171 " int64_t favail;\n"
21174 " int64_t namemax;\n"
21181 #: ../src/guestfs-structs.pod:151
21184 " struct guestfs_statvfs_list {\n"
21185 " uint32_t len; /* Number of elements in list. */\n"
21186 " struct guestfs_statvfs *val; /* Elements. */\n"
21193 #: ../src/guestfs-structs.pod:156
21196 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21197 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21203 #: ../src/guestfs-structs.pod:159
21204 msgid "guestfs_dirent"
21209 #: ../src/guestfs-structs.pod:161
21212 " struct guestfs_dirent {\n"
21222 #: ../src/guestfs-structs.pod:167
21225 " struct guestfs_dirent_list {\n"
21226 " uint32_t len; /* Number of elements in list. */\n"
21227 " struct guestfs_dirent *val; /* Elements. */\n"
21234 #: ../src/guestfs-structs.pod:172
21237 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21238 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21244 #: ../src/guestfs-structs.pod:177
21247 " struct guestfs_version {\n"
21248 " int64_t major;\n"
21249 " int64_t minor;\n"
21250 " int64_t release;\n"
21258 #: ../src/guestfs-structs.pod:184
21261 " struct guestfs_version_list {\n"
21262 " uint32_t len; /* Number of elements in list. */\n"
21263 " struct guestfs_version *val; /* Elements. */\n"
21270 #: ../src/guestfs-structs.pod:189
21273 " void guestfs_free_version (struct guestfs_free_version *);\n"
21274 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21280 #: ../src/guestfs-structs.pod:192
21281 msgid "guestfs_xattr"
21286 #: ../src/guestfs-structs.pod:194
21289 " struct guestfs_xattr {\n"
21290 " char *attrname;\n"
21291 " /* The next two fields describe a byte array. */\n"
21292 " uint32_t attrval_len;\n"
21293 " char *attrval;\n"
21300 #: ../src/guestfs-structs.pod:201
21303 " struct guestfs_xattr_list {\n"
21304 " uint32_t len; /* Number of elements in list. */\n"
21305 " struct guestfs_xattr *val; /* Elements. */\n"
21312 #: ../src/guestfs-structs.pod:206
21315 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21316 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21322 #: ../src/guestfs-structs.pod:209
21323 msgid "guestfs_inotify_event"
21328 #: ../src/guestfs-structs.pod:211
21331 " struct guestfs_inotify_event {\n"
21332 " int64_t in_wd;\n"
21333 " uint32_t in_mask;\n"
21334 " uint32_t in_cookie;\n"
21335 " char *in_name;\n"
21342 #: ../src/guestfs-structs.pod:218
21345 " struct guestfs_inotify_event_list {\n"
21346 " uint32_t len; /* Number of elements in list. */\n"
21347 " struct guestfs_inotify_event *val; /* Elements. */\n"
21354 #: ../src/guestfs-structs.pod:223
21357 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21358 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21364 #: ../src/guestfs-structs.pod:226
21365 msgid "guestfs_partition"
21370 #: ../src/guestfs-structs.pod:228
21373 " struct guestfs_partition {\n"
21374 " int32_t part_num;\n"
21375 " uint64_t part_start;\n"
21376 " uint64_t part_end;\n"
21377 " uint64_t part_size;\n"
21384 #: ../src/guestfs-structs.pod:235
21387 " struct guestfs_partition_list {\n"
21388 " uint32_t len; /* Number of elements in list. */\n"
21389 " struct guestfs_partition *val; /* Elements. */\n"
21396 #: ../src/guestfs-structs.pod:240
21399 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21400 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21406 #: ../src/guestfs-structs.pod:243
21407 msgid "guestfs_application"
21412 #: ../src/guestfs-structs.pod:245
21415 " struct guestfs_application {\n"
21416 " char *app_name;\n"
21417 " char *app_display_name;\n"
21418 " int32_t app_epoch;\n"
21419 " char *app_version;\n"
21420 " char *app_release;\n"
21421 " char *app_install_path;\n"
21422 " char *app_trans_path;\n"
21423 " char *app_publisher;\n"
21424 " char *app_url;\n"
21425 " char *app_source_package;\n"
21426 " char *app_summary;\n"
21427 " char *app_description;\n"
21434 #: ../src/guestfs-structs.pod:260
21437 " struct guestfs_application_list {\n"
21438 " uint32_t len; /* Number of elements in list. */\n"
21439 " struct guestfs_application *val; /* Elements. */\n"
21446 #: ../src/guestfs-structs.pod:265
21449 " void guestfs_free_application (struct guestfs_free_application *);\n"
21450 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21456 #: ../fish/guestfish.pod:5
21457 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21462 #: ../fish/guestfish.pod:9
21465 " guestfish [--options] [commands]\n"
21471 #: ../fish/guestfish.pod:11
21480 #: ../fish/guestfish.pod:13
21483 " guestfish [--ro|--rw] -a disk.img\n"
21489 #: ../fish/guestfish.pod:15
21492 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21498 #: ../fish/guestfish.pod:17
21501 " guestfish -d libvirt-domain\n"
21507 #: ../fish/guestfish.pod:19
21510 " guestfish [--ro|--rw] -a disk.img -i\n"
21516 #: ../fish/guestfish.pod:21
21519 " guestfish -d libvirt-domain -i\n"
21525 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21526 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21532 #: ../fish/guestfish.pod:25
21534 "Using guestfish in read/write mode on live virtual machines can be "
21535 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21536 "option to use guestfish safely if the disk image or virtual machine might be "
21542 #: ../fish/guestfish.pod:32
21544 "Guestfish is a shell and command-line tool for examining and modifying "
21545 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21546 "functionality of the guestfs API, see L<guestfs(3)>."
21551 #: ../fish/guestfish.pod:36
21553 "Guestfish gives you structured access to the libguestfs API, from shell "
21554 "scripts or the command line or interactively. If you want to rescue a "
21555 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21561 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
21562 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21568 #: ../fish/guestfish.pod:43
21569 msgid "As an interactive shell"
21574 #: ../fish/guestfish.pod:45
21583 #: ../fish/guestfish.pod:47
21586 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21587 " editing virtual machine filesystems.\n"
21593 #: ../fish/guestfish.pod:50
21596 " Type: 'help' for a list of commands\n"
21597 " 'man' to read the manual\n"
21598 " 'quit' to quit the shell\n"
21604 #: ../fish/guestfish.pod:54
21607 " ><fs> add-ro disk.img\n"
21609 " ><fs> list-filesystems\n"
21610 " /dev/sda1: ext4\n"
21611 " /dev/vg_guest/lv_root: ext4\n"
21612 " /dev/vg_guest/lv_swap: swap\n"
21613 " ><fs> mount /dev/vg_guest/lv_root /\n"
21614 " ><fs> cat /etc/fstab\n"
21616 " # Created by anaconda\n"
21624 #: ../fish/guestfish.pod:67
21625 msgid "From shell scripts"
21630 #: ../fish/guestfish.pod:69
21631 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21636 #: ../fish/guestfish.pod:71
21639 " guestfish <<_EOF_\n"
21642 " mount /dev/vg_guest/lv_root /\n"
21643 " write /etc/motd \"Welcome, new users\"\n"
21650 #: ../fish/guestfish.pod:78
21651 msgid "List the LVM logical volumes in a disk image:"
21656 #: ../fish/guestfish.pod:80
21659 " guestfish -a disk.img --ro <<_EOF_\n"
21668 #: ../fish/guestfish.pod:85
21669 msgid "List all the filesystems in a disk image:"
21674 #: ../fish/guestfish.pod:87
21677 " guestfish -a disk.img --ro <<_EOF_\n"
21679 " list-filesystems\n"
21686 #: ../fish/guestfish.pod:92
21687 msgid "On one command line"
21692 #: ../fish/guestfish.pod:94
21693 msgid "Update C</etc/resolv.conf> in a guest:"
21698 #: ../fish/guestfish.pod:96
21702 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21703 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21709 #: ../fish/guestfish.pod:100
21710 msgid "Edit C</boot/grub/grub.conf> interactively:"
21715 #: ../fish/guestfish.pod:102
21718 " guestfish --rw --add disk.img \\\n"
21719 " --mount /dev/vg_guest/lv_root \\\n"
21720 " --mount /dev/sda1:/boot \\\n"
21721 " edit /boot/grub/grub.conf\n"
21727 #: ../fish/guestfish.pod:107
21728 msgid "Mount disks automatically"
21733 #: ../fish/guestfish.pod:109
21735 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21740 #: ../fish/guestfish.pod:112
21743 " guestfish --ro -a disk.img -i cat /etc/group\n"
21749 #: ../fish/guestfish.pod:114
21752 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21758 #: ../fish/guestfish.pod:116
21759 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21764 #: ../fish/guestfish.pod:118
21767 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21773 #: ../fish/guestfish.pod:120
21774 msgid "As a script interpreter"
21779 #: ../fish/guestfish.pod:122
21780 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21785 #: ../fish/guestfish.pod:124
21788 " #!/usr/bin/guestfish -f\n"
21789 " sparse test1.img 100M\n"
21791 " part-disk /dev/sda mbr\n"
21792 " mkfs ext2 /dev/sda1\n"
21798 #: ../fish/guestfish.pod:130
21799 msgid "Start with a prepared disk"
21804 #: ../fish/guestfish.pod:132
21806 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21807 "single ext2-formatted partition:"
21812 #: ../fish/guestfish.pod:135
21815 " guestfish -N fs\n"
21821 #: ../fish/guestfish.pod:137
21822 msgid "To list what is available do:"
21827 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
21830 " guestfish -N help | less\n"
21836 #: ../fish/guestfish.pod:141
21837 msgid "Remote control"
21842 #: ../fish/guestfish.pod:143
21845 " eval \"`guestfish --listen`\"\n"
21846 " guestfish --remote add-ro disk.img\n"
21847 " guestfish --remote run\n"
21848 " guestfish --remote lvs\n"
21854 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21855 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
21856 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21857 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21858 #: ../tools/virt-list-partitions.pl:54
21864 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:133
21865 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21866 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21867 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21873 #: ../fish/guestfish.pod:154
21874 msgid "Displays general help on options."
21879 #: ../fish/guestfish.pod:156
21885 #: ../fish/guestfish.pod:158
21886 msgid "B<--cmd-help>"
21891 #: ../fish/guestfish.pod:160
21892 msgid "Lists all available guestfish commands."
21897 #: ../fish/guestfish.pod:162
21903 #: ../fish/guestfish.pod:164
21904 msgid "B<--cmd-help cmd>"
21909 #: ../fish/guestfish.pod:166
21910 msgid "Displays detailed help on a single command C<cmd>."
21915 #: ../fish/guestfish.pod:168
21916 msgid "B<-a image>"
21921 #: ../fish/guestfish.pod:170
21922 msgid "B<--add image>"
21927 #: ../fish/guestfish.pod:172
21928 msgid "Add a block device or virtual machine image to the shell."
21933 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21935 "The format of the disk image is auto-detected. To override this and force a "
21936 "particular format use the I<--format=..> option."
21940 #: ../fish/guestfish.pod:177
21942 "Using this flag is mostly equivalent to using the C<add> command, with "
21943 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21944 "the I<--format=...> flag was given."
21949 #: ../fish/guestfish.pod:181
21955 #: ../fish/guestfish.pod:183
21956 msgid "B<--connect URI>"
21961 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21963 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21964 "URI to use. The default is to use the default libvirt connection."
21969 #: ../fish/guestfish.pod:189
21975 #: ../fish/guestfish.pod:191
21977 "If using the I<--listen> option and a csh-like shell, use this option. See "
21978 "section L</REMOTE CONTROL AND CSH> below."
21983 #: ../fish/guestfish.pod:194
21984 msgid "B<-d libvirt-domain>"
21989 #: ../fish/guestfish.pod:196
21990 msgid "B<--domain libvirt-domain>"
21995 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21997 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21998 "used, then any libvirt domain can be used. However in write mode, only "
21999 "libvirt domains which are shut down can be named here."
22003 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:96
22004 msgid "Domain UUIDs can be used instead of names."
22009 #: ../fish/guestfish.pod:204
22011 "Using this flag is mostly equivalent to using the C<add-domain> command, "
22012 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
22013 "if the I<--format:...> flag was given."
22018 #: ../fish/guestfish.pod:208
22024 #: ../fish/guestfish.pod:210
22025 msgid "B<--no-dest-paths>"
22030 #: ../fish/guestfish.pod:212
22032 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22033 "to hit the tab key to complete paths on the guest filesystem, but this "
22034 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22035 "allow this feature to be disabled."
22040 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
22041 msgid "B<--echo-keys>"
22046 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:112
22048 "When prompting for keys and passphrases, guestfish normally turns echoing "
22049 "off so you cannot see what you are typing. If you are not worried about "
22050 "Tempest attacks and there is no one else in the room you can specify this "
22051 "flag to see what you are typing."
22056 #: ../fish/guestfish.pod:224
22062 #: ../fish/guestfish.pod:226
22063 msgid "B<--file file>"
22068 #: ../fish/guestfish.pod:228
22069 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22074 #: ../fish/guestfish.pod:231
22077 " #!/usr/bin/guestfish -f\n"
22083 #: ../fish/guestfish.pod:233
22084 msgid "B<--format=raw|qcow2|..>"
22089 #: ../fish/guestfish.pod:235
22090 msgid "B<--format>"
22095 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:119
22097 "The default for the I<-a> option is to auto-detect the format of the disk "
22098 "image. Using this forces the disk format for I<-a> options which follow on "
22099 "the command line. Using I<--format> with no argument switches back to auto-"
22100 "detection for subsequent I<-a> options."
22105 #: ../fish/guestfish.pod:244
22108 " guestfish --format=raw -a disk.img\n"
22114 #: ../fish/guestfish.pod:246
22115 msgid "forces raw format (no auto-detection) for C<disk.img>."
22120 #: ../fish/guestfish.pod:248
22123 " guestfish --format=raw -a disk.img --format -a another.img\n"
22129 #: ../fish/guestfish.pod:250
22131 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22132 "detection for C<another.img>."
22137 #: ../fish/guestfish.pod:253
22139 "If you have untrusted raw-format guest disk images, you should use this "
22140 "option to specify the disk format. This avoids a possible security problem "
22141 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22146 #: ../fish/guestfish.pod:258
22152 #: ../fish/guestfish.pod:260
22153 msgid "B<--inspector>"
22158 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:139
22160 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22161 "system and mount filesystems as they would be mounted on the real virtual "
22167 #: ../fish/guestfish.pod:266
22168 msgid "Typical usage is either:"
22173 #: ../fish/guestfish.pod:268
22176 " guestfish -d myguest -i\n"
22182 #: ../fish/guestfish.pod:270
22183 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22188 #: ../fish/guestfish.pod:272
22191 " guestfish --ro -d myguest -i\n"
22197 #: ../fish/guestfish.pod:274
22198 msgid "(for active domains, readonly), or specify the block device directly:"
22203 #: ../fish/guestfish.pod:276
22206 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22212 #: ../fish/guestfish.pod:278
22214 "Note that the command line syntax changed slightly over older versions of "
22215 "guestfish. You can still use the old syntax:"
22220 #: ../fish/guestfish.pod:281
22223 " guestfish [--ro] -i disk.img\n"
22229 #: ../fish/guestfish.pod:283
22232 " guestfish [--ro] -i libvirt-domain\n"
22238 #: ../fish/guestfish.pod:285
22240 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22241 "then using other commands to mount the filesystems that were found."
22246 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22247 msgid "B<--keys-from-stdin>"
22252 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:145
22254 "Read key or passphrase parameters from stdin. The default is to try to read "
22255 "passphrases from the user by opening C</dev/tty>."
22260 #: ../fish/guestfish.pod:294
22261 msgid "B<--listen>"
22266 #: ../fish/guestfish.pod:296
22268 "Fork into the background and listen for remote commands. See section L</"
22269 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22273 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22278 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:150
22280 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22281 "ATTACHING TO RUNNING DAEMONS>)."
22285 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22286 msgid "B<-m dev[:mountpoint[:options]]>"
22290 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:155
22291 msgid "B<--mount dev[:mountpoint[:options]]>"
22296 #: ../fish/guestfish.pod:308
22297 msgid "Mount the named partition or logical volume on the given mountpoint."
22302 #: ../fish/guestfish.pod:310
22303 msgid "If the mountpoint is omitted, it defaults to C</>."
22308 #: ../fish/guestfish.pod:312
22309 msgid "You have to mount something on C</> before most commands will work."
22314 #: ../fish/guestfish.pod:314
22316 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22322 #: ../fish/guestfish.pod:317
22324 "If you don't know what filesystems a disk image contains, you can either run "
22325 "guestfish without this option, then list the partitions, filesystems and LVs "
22326 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22327 "commands), or you can use the L<virt-filesystems(1)> program."
22331 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:163
22333 "The third (and rarely used) part of the mount parameter is the list of mount "
22334 "options used to mount the underlying filesystem. If this is not given, then "
22335 "the mount options are either the empty string or C<ro> (the latter if the "
22336 "I<--ro> flag is used). By specifying the mount options, you override this "
22337 "default choice. Probably the only time you would use this is to enable ACLs "
22338 "and/or extended attributes if the filesystem can support them:"
22342 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:171
22345 " -m /dev/sda1:/:acl,user_xattr\n"
22350 #: ../fish/guestfish.pod:333
22351 msgid "Using this flag is equivalent to using the C<mount-options> command."
22356 #: ../fish/guestfish.pod:335
22362 #: ../fish/guestfish.pod:337
22363 msgid "B<--no-sync>"
22368 #: ../fish/guestfish.pod:339
22370 "Disable autosync. This is enabled by default. See the discussion of "
22371 "autosync in the L<guestfs(3)> manpage."
22376 #: ../fish/guestfish.pod:342
22382 #: ../fish/guestfish.pod:344
22383 msgid "B<--new type>"
22388 #: ../fish/guestfish.pod:346
22394 #: ../fish/guestfish.pod:348
22396 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22397 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22398 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22404 #: ../fish/guestfish.pod:353
22405 msgid "B<--progress-bars>"
22410 #: ../fish/guestfish.pod:355
22411 msgid "Enable progress bars, even when guestfish is used non-interactively."
22416 #: ../fish/guestfish.pod:357
22418 "Progress bars are enabled by default when guestfish is used as an "
22419 "interactive shell."
22424 #: ../fish/guestfish.pod:360
22425 msgid "B<--no-progress-bars>"
22430 #: ../fish/guestfish.pod:362
22431 msgid "Disable progress bars."
22436 #: ../fish/guestfish.pod:364
22437 msgid "B<--remote[=pid]>"
22442 #: ../fish/guestfish.pod:366
22444 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22445 "CONTROL GUESTFISH OVER A SOCKET> below."
22450 #: ../fish/guestfish.pod:369
22456 #: ../fish/guestfish.pod:371
22462 #: ../fish/guestfish.pod:373
22464 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22465 "mounts are done read-only."
22470 #: ../fish/guestfish.pod:376
22472 "The option must always be used if the disk image or virtual machine might be "
22473 "running, and is generally recommended in cases where you don't need write "
22474 "access to the disk."
22479 #: ../fish/guestfish.pod:380
22481 "Note that prepared disk images created with I<-N> are not affected by this "
22482 "option. Also commands like C<add> are not affected - you have to specify "
22483 "the C<readonly:true> option explicitly if you need it."
22488 #: ../fish/guestfish.pod:384
22489 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22494 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:227
22495 msgid "B<--selinux>"
22500 #: ../fish/guestfish.pod:388
22501 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22506 #: ../fish/guestfish.pod:390
22512 #: ../fish/guestfish.pod:392
22513 msgid "B<--verbose>"
22518 #: ../fish/guestfish.pod:394
22520 "Enable very verbose messages. This is particularly useful if you find a bug."
22525 #: ../fish/guestfish.pod:397
22531 #: ../fish/guestfish.pod:399 ../tools/virt-edit.pl:97
22532 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22533 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22534 #: ../tools/virt-list-partitions.pl:70
22535 msgid "B<--version>"
22540 #: ../fish/guestfish.pod:401
22541 msgid "Display the guestfish / libguestfs version number and exit."
22546 #: ../fish/guestfish.pod:403
22552 #: ../fish/guestfish.pod:405
22557 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:241
22559 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22560 "mounts are done read-write."
22564 #: ../fish/guestfish.pod:410
22565 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22570 #: ../fish/guestfish.pod:412
22576 #: ../fish/guestfish.pod:414
22577 msgid "Echo each command before executing it."
22582 #: ../fish/guestfish.pod:418
22583 msgid "COMMANDS ON COMMAND LINE"
22588 #: ../fish/guestfish.pod:420
22590 "Any additional (non-option) arguments are treated as commands to execute."
22595 #: ../fish/guestfish.pod:423
22597 "Commands to execute should be separated by a colon (C<:>), where the colon "
22598 "is a separate parameter. Thus:"
22603 #: ../fish/guestfish.pod:426
22606 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22612 #: ../fish/guestfish.pod:428
22614 "If there are no additional arguments, then we enter a shell, either an "
22615 "interactive shell with a prompt (if the input is a terminal) or a non-"
22616 "interactive shell."
22621 #: ../fish/guestfish.pod:432
22623 "In either command line mode or non-interactive shell, the first command that "
22624 "gives an error causes the whole shell to exit. In interactive mode (with a "
22625 "prompt) if a command fails, you can continue to enter commands."
22630 #: ../fish/guestfish.pod:437
22631 msgid "USING launch (OR run)"
22636 #: ../fish/guestfish.pod:439
22638 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22639 "then launch it, then mount any disks you need, and finally issue actions/"
22640 "commands. So the general order of the day is:"
22645 #: ../fish/guestfish.pod:447
22646 msgid "add or -a/--add"
22651 #: ../fish/guestfish.pod:451
22652 msgid "launch (aka run)"
22657 #: ../fish/guestfish.pod:455
22658 msgid "mount or -m/--mount"
22663 #: ../fish/guestfish.pod:459
22664 msgid "any other commands"
22669 #: ../fish/guestfish.pod:463
22671 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22672 "guest before mounting or performing any other commands."
22677 #: ../fish/guestfish.pod:466
22679 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22680 "I<--new> options were given then C<run> is done automatically, simply "
22681 "because guestfish can't perform the action you asked for without doing this."
22686 #: ../fish/guestfish.pod:471
22687 msgid "OPENING DISKS FOR READ AND WRITE"
22691 #: ../fish/guestfish.pod:473
22693 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22694 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22695 "I<-i> and I<-m> open disk images read-only or for writing."
22699 #: ../fish/guestfish.pod:478
22701 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22702 "opening disk images supplied on the command line for write. To open a disk "
22703 "image read-only you have to do I<-a image --ro>."
22708 #: ../fish/guestfish.pod:482
22710 "This matters: If you accidentally open a live VM disk image writable then "
22711 "you will cause irreversible disk corruption."
22715 #: ../fish/guestfish.pod:485
22717 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22718 "images will be opened read-only. You will have to either specify "
22719 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22720 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22721 "access for disk images specified by those other command line options."
22725 #: ../fish/guestfish.pod:492
22727 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22728 "which does nothing (it is already the default). However it is highly "
22729 "recommended that you use this option to indicate that you need write access, "
22730 "and prepare your scripts for the day when this option will be required for "
22736 #: ../fish/guestfish.pod:498
22738 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22739 "other libguestfs program apart from guestfish and guestmount."
22744 #: ../fish/guestfish.pod:501
22750 #: ../fish/guestfish.pod:503
22752 "You can quote ordinary parameters using either single or double quotes. For "
22758 #: ../fish/guestfish.pod:506
22761 " add \"file with a space.img\"\n"
22767 #: ../fish/guestfish.pod:508
22770 " rm '/file name'\n"
22776 #: ../fish/guestfish.pod:510
22785 #: ../fish/guestfish.pod:512
22787 "A few commands require a list of strings to be passed. For these, use a "
22788 "whitespace-separated list, enclosed in quotes. Strings containing "
22789 "whitespace to be passed through must be enclosed in single quotes. A "
22790 "literal single quote must be escaped with a backslash."
22795 #: ../fish/guestfish.pod:517
22798 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22799 " command \"/bin/echo 'foo bar'\"\n"
22800 " command \"/bin/echo \\'foo\\'\"\n"
22806 #: ../fish/guestfish.pod:521
22807 msgid "OPTIONAL ARGUMENTS"
22812 #: ../fish/guestfish.pod:523
22814 "Some commands take optional arguments. These arguments appear in this "
22815 "documentation as C<[argname:..]>. You can use them as in these examples:"
22820 #: ../fish/guestfish.pod:527
22823 " add-drive-opts filename\n"
22829 #: ../fish/guestfish.pod:529
22832 " add-drive-opts filename readonly:true\n"
22838 #: ../fish/guestfish.pod:531
22841 " add-drive-opts filename format:qcow2 readonly:false\n"
22847 #: ../fish/guestfish.pod:533
22849 "Each optional argument can appear at most once. All optional arguments must "
22850 "appear after the required ones."
22855 #: ../fish/guestfish.pod:536
22861 #: ../fish/guestfish.pod:538
22863 "This section applies to all commands which can take integers as parameters."
22868 #: ../fish/guestfish.pod:541
22869 msgid "SIZE SUFFIX"
22874 #: ../fish/guestfish.pod:543
22876 "When the command takes a parameter measured in bytes, you can use one of the "
22877 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22882 #: ../fish/guestfish.pod:549
22883 msgid "B<k> or B<K> or B<KiB>"
22888 #: ../fish/guestfish.pod:551
22889 msgid "The size in kilobytes (multiplied by 1024)."
22894 #: ../fish/guestfish.pod:553
22900 #: ../fish/guestfish.pod:555
22901 msgid "The size in SI 1000 byte units."
22906 #: ../fish/guestfish.pod:557
22907 msgid "B<M> or B<MiB>"
22912 #: ../fish/guestfish.pod:559
22913 msgid "The size in megabytes (multiplied by 1048576)."
22918 #: ../fish/guestfish.pod:561
22924 #: ../fish/guestfish.pod:563
22925 msgid "The size in SI 1000000 byte units."
22930 #: ../fish/guestfish.pod:565
22931 msgid "B<G> or B<GiB>"
22936 #: ../fish/guestfish.pod:567
22937 msgid "The size in gigabytes (multiplied by 2**30)."
22942 #: ../fish/guestfish.pod:569
22948 #: ../fish/guestfish.pod:571
22949 msgid "The size in SI 10**9 byte units."
22954 #: ../fish/guestfish.pod:573
22955 msgid "B<T> or B<TiB>"
22960 #: ../fish/guestfish.pod:575
22961 msgid "The size in terabytes (multiplied by 2**40)."
22966 #: ../fish/guestfish.pod:577
22972 #: ../fish/guestfish.pod:579
22973 msgid "The size in SI 10**12 byte units."
22978 #: ../fish/guestfish.pod:581
22979 msgid "B<P> or B<PiB>"
22984 #: ../fish/guestfish.pod:583
22985 msgid "The size in petabytes (multiplied by 2**50)."
22990 #: ../fish/guestfish.pod:585
22996 #: ../fish/guestfish.pod:587
22997 msgid "The size in SI 10**15 byte units."
23002 #: ../fish/guestfish.pod:589
23003 msgid "B<E> or B<EiB>"
23008 #: ../fish/guestfish.pod:591
23009 msgid "The size in exabytes (multiplied by 2**60)."
23014 #: ../fish/guestfish.pod:593
23020 #: ../fish/guestfish.pod:595
23021 msgid "The size in SI 10**18 byte units."
23026 #: ../fish/guestfish.pod:597
23027 msgid "B<Z> or B<ZiB>"
23032 #: ../fish/guestfish.pod:599
23033 msgid "The size in zettabytes (multiplied by 2**70)."
23038 #: ../fish/guestfish.pod:601
23044 #: ../fish/guestfish.pod:603
23045 msgid "The size in SI 10**21 byte units."
23050 #: ../fish/guestfish.pod:605
23051 msgid "B<Y> or B<YiB>"
23056 #: ../fish/guestfish.pod:607
23057 msgid "The size in yottabytes (multiplied by 2**80)."
23062 #: ../fish/guestfish.pod:609
23068 #: ../fish/guestfish.pod:611
23069 msgid "The size in SI 10**24 byte units."
23074 #: ../fish/guestfish.pod:617
23077 " truncate-size /file 1G\n"
23083 #: ../fish/guestfish.pod:619
23084 msgid "would truncate the file to 1 gigabyte."
23089 #: ../fish/guestfish.pod:621
23091 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23092 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23093 "suffix will probably not do what you expect."
23098 #: ../fish/guestfish.pod:625
23099 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23104 #: ../fish/guestfish.pod:627
23106 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23107 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23112 #: ../fish/guestfish.pod:630
23115 " 1234 decimal number 1234\n"
23116 " 02322 octal number, equivalent to decimal 1234\n"
23117 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23123 #: ../fish/guestfish.pod:634
23125 "When using the C<chmod> command, you almost always want to specify an octal "
23126 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23127 "L<chmod(1)> program):"
23132 #: ../fish/guestfish.pod:638
23135 " chmod 0777 /public # OK\n"
23136 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23142 #: ../fish/guestfish.pod:641
23144 "Commands that return numbers usually print them in decimal, but some "
23145 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23146 "octal, preceeded by C<0>)."
23151 #: ../fish/guestfish.pod:645
23152 msgid "WILDCARDS AND GLOBBING"
23157 #: ../fish/guestfish.pod:647
23159 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23160 "(globbing) by default. So for example the following will not do what you "
23166 #: ../fish/guestfish.pod:651
23175 #: ../fish/guestfish.pod:653
23177 "Assuming you don't have a directory called literally C</home/*> then the "
23178 "above command will return an error."
23183 #: ../fish/guestfish.pod:656
23184 msgid "To perform wildcard expansion, use the C<glob> command."
23189 #: ../fish/guestfish.pod:658
23192 " glob rm-rf /home/*\n"
23198 #: ../fish/guestfish.pod:660
23200 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23201 "many times), equivalent to:"
23206 #: ../fish/guestfish.pod:663
23209 " rm-rf /home/jim\n"
23210 " rm-rf /home/joe\n"
23211 " rm-rf /home/mary\n"
23217 #: ../fish/guestfish.pod:667
23218 msgid "C<glob> only works on simple guest paths and not on device names."
23223 #: ../fish/guestfish.pod:669
23225 "If you have several parameters, each containing a wildcard, then glob will "
23226 "perform a Cartesian product."
23231 #: ../fish/guestfish.pod:672
23237 #: ../fish/guestfish.pod:674
23239 "Any line which starts with a I<#> character is treated as a comment and "
23240 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23241 "a command. For example:"
23246 #: ../fish/guestfish.pod:678
23249 " # this is a comment\n"
23250 " # this is a comment\n"
23251 " foo # NOT a comment\n"
23257 #: ../fish/guestfish.pod:682
23258 msgid "Blank lines are also ignored."
23263 #: ../fish/guestfish.pod:684
23264 msgid "RUNNING COMMANDS LOCALLY"
23269 #: ../fish/guestfish.pod:686
23271 "Any line which starts with a I<!> character is treated as a command sent to "
23272 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23277 #: ../fish/guestfish.pod:690
23281 " tgz-out /remote local/remote-data.tar.gz\n"
23287 #: ../fish/guestfish.pod:693
23289 "will create a directory C<local> on the host, and then export the contents "
23290 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23291 "(See C<tgz-out>)."
23296 #: ../fish/guestfish.pod:697
23298 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23299 "effect, due to the way that subprocesses work in Unix."
23303 #: ../fish/guestfish.pod:700
23304 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23308 #: ../fish/guestfish.pod:702
23310 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23311 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23312 "and executed as guestfish commands."
23316 #: ../fish/guestfish.pod:706
23318 "Thus you can use shell script to construct arbitrary guestfish commands "
23319 "which are then parsed by guestfish."
23323 #: ../fish/guestfish.pod:709
23325 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23326 "through C</foo.100>) using guestfish commands alone. However this is simple "
23327 "if we use a shell script to create the guestfish commands for us:"
23331 #: ../fish/guestfish.pod:714
23334 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23339 #: ../fish/guestfish.pod:716
23340 msgid "or with names like C</foo.001>:"
23344 #: ../fish/guestfish.pod:718
23347 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23352 #: ../fish/guestfish.pod:720
23354 "When using guestfish interactively it can be helpful to just run the shell "
23355 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23356 "ordinary I<!> local command), see what guestfish commands it would run, and "
23357 "when you are happy with those prepend the C<E<lt>> character to run the "
23358 "guestfish commands for real."
23363 #: ../fish/guestfish.pod:726
23369 #: ../fish/guestfish.pod:728
23371 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23372 "command (a guestfish command) to the second command (any host command). For "
23378 #: ../fish/guestfish.pod:732
23381 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23387 #: ../fish/guestfish.pod:734
23389 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23390 "program). The above command would list all accounts in the guest filesystem "
23391 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23396 #: ../fish/guestfish.pod:739
23399 " hexdump /bin/ls | head\n"
23400 " list-devices | tail -1\n"
23401 " tgz-out / - | tar ztf -\n"
23407 #: ../fish/guestfish.pod:743
23409 "The space before the pipe symbol is required, any space after the pipe "
23410 "symbol is optional. Everything after the pipe symbol is just passed "
23411 "straight to the host shell, so it can contain redirections, globs and "
23412 "anything else that makes sense on the host side."
23417 #: ../fish/guestfish.pod:748
23419 "To use a literal argument which begins with a pipe symbol, you have to quote "
23425 #: ../fish/guestfish.pod:751
23434 #: ../fish/guestfish.pod:753
23435 msgid "HOME DIRECTORIES"
23440 #: ../fish/guestfish.pod:755
23442 "If a parameter starts with the character C<~> then the tilde may be expanded "
23443 "as a home directory path (either C<~> for the current user's home directory, "
23444 "or C<~user> for another user)."
23449 #: ../fish/guestfish.pod:759
23451 "Note that home directory expansion happens for users known I<on the host>, "
23452 "not in the guest filesystem."
23457 #: ../fish/guestfish.pod:762
23459 "To use a literal argument which begins with a tilde, you have to quote it, "
23465 #: ../fish/guestfish.pod:765
23474 #: ../fish/guestfish.pod:769
23476 "Libguestfs has some support for Linux guests encrypted according to the "
23477 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23478 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23479 "LUKS is supported."
23484 #: ../fish/guestfish.pod:774
23485 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23490 #: ../fish/guestfish.pod:776
23493 " ><fs> vfs-type /dev/sda2\n"
23500 #: ../fish/guestfish.pod:779
23502 "Then open those devices using L</luks-open>. This creates a device-mapper "
23503 "device called C</dev/mapper/luksdev>."
23508 #: ../fish/guestfish.pod:782
23511 " ><fs> luks-open /dev/sda2 luksdev\n"
23512 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23518 #: ../fish/guestfish.pod:785
23520 "Finally you have to tell LVM to scan for volume groups on the newly created "
23526 #: ../fish/guestfish.pod:788
23530 " vg-activate-all true\n"
23536 #: ../fish/guestfish.pod:791
23537 msgid "The logical volume(s) can now be mounted in the usual way."
23542 #: ../fish/guestfish.pod:793
23544 "Before closing a LUKS device you must unmount any logical volumes on it and "
23545 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23546 "one. Then you can close the mapper device:"
23551 #: ../fish/guestfish.pod:797
23554 " vg-activate false /dev/VG\n"
23555 " luks-close /dev/mapper/luksdev\n"
23561 #: ../fish/guestfish.pod:800 ../tools/virt-edit.pl:342
23562 msgid "WINDOWS PATHS"
23566 #: ../fish/guestfish.pod:802
23568 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23569 "letters and paths (with some limitations). The following commands are "
23575 #: ../fish/guestfish.pod:806
23578 " file /WINDOWS/system32/config/system.LOG\n"
23584 #: ../fish/guestfish.pod:808
23587 " file win:\\windows\\system32\\config\\system.log\n"
23592 #: ../fish/guestfish.pod:810
23595 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23600 #: ../fish/guestfish.pod:812
23602 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23603 "where the drive is mounted, prepending that to the path, changing all "
23604 "backslash characters to forward slash, then resolving the result using L</"
23605 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23606 "the parameter might be rewritten like this:"
23610 #: ../fish/guestfish.pod:818
23613 " win:e:\\foo\\bar => /e/FOO/bar\n"
23618 #: ../fish/guestfish.pod:820
23619 msgid "This only works in argument positions that expect a path."
23624 #: ../fish/guestfish.pod:822
23625 msgid "UPLOADING AND DOWNLOADING FILES"
23630 #: ../fish/guestfish.pod:824
23632 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23633 "others which upload from or download to a local file, you can use the "
23634 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23639 #: ../fish/guestfish.pod:828
23648 #: ../fish/guestfish.pod:830
23650 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23655 #: ../fish/guestfish.pod:833
23658 " tar-out /etc - | tar tf -\n"
23664 #: ../fish/guestfish.pod:835
23666 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23667 "command (see L</PIPES>)."
23672 #: ../fish/guestfish.pod:838
23674 "When using C<-> to read from stdin, the input is read up to the end of "
23675 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23676 "some arbitrary end marker:"
23681 #: ../fish/guestfish.pod:842
23684 " upload -<<END /foo\n"
23694 #: ../fish/guestfish.pod:848
23696 "Any string of characters can be used instead of C<END>. The end marker must "
23697 "appear on a line of its own, without any preceeding or following characters "
23698 "(not even spaces)."
23703 #: ../fish/guestfish.pod:852
23705 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23706 "upload local files (so-called \"FileIn\" parameters in the generator)."
23711 #: ../fish/guestfish.pod:855
23712 msgid "EXIT ON ERROR BEHAVIOUR"
23717 #: ../fish/guestfish.pod:857
23719 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23720 "taking commands from a human over a tty), and will exit on the first error "
23721 "in non-interactive mode (scripts, commands given on the command line)."
23726 #: ../fish/guestfish.pod:862
23728 "If you prefix a command with a I<-> character, then that command will not "
23729 "cause guestfish to exit, even if that (one) command returns an error."
23734 #: ../fish/guestfish.pod:866
23735 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23740 #: ../fish/guestfish.pod:868
23742 "Guestfish can be remote-controlled over a socket. This is useful "
23743 "particularly in shell scripts where you want to make several different "
23744 "changes to a filesystem, but you don't want the overhead of starting up a "
23745 "guestfish process each time."
23750 #: ../fish/guestfish.pod:873
23751 msgid "Start a guestfish server process using:"
23756 #: ../fish/guestfish.pod:875
23759 " eval \"`guestfish --listen`\"\n"
23765 #: ../fish/guestfish.pod:877
23766 msgid "and then send it commands by doing:"
23771 #: ../fish/guestfish.pod:879
23774 " guestfish --remote cmd [...]\n"
23780 #: ../fish/guestfish.pod:881
23781 msgid "To cause the server to exit, send it the exit command:"
23786 #: ../fish/guestfish.pod:883
23789 " guestfish --remote exit\n"
23795 #: ../fish/guestfish.pod:885
23797 "Note that the server will normally exit if there is an error in a command. "
23798 "You can change this in the usual way. See section L</EXIT ON ERROR "
23804 #: ../fish/guestfish.pod:889
23805 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23810 #: ../fish/guestfish.pod:891
23812 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23813 "is how the I<--remote> option knows where to send the commands. You can "
23814 "have several guestfish listener processes running using:"
23819 #: ../fish/guestfish.pod:895
23822 " eval \"`guestfish --listen`\"\n"
23823 " pid1=$GUESTFISH_PID\n"
23824 " eval \"`guestfish --listen`\"\n"
23825 " pid2=$GUESTFISH_PID\n"
23827 " guestfish --remote=$pid1 cmd\n"
23828 " guestfish --remote=$pid2 cmd\n"
23834 #: ../fish/guestfish.pod:903
23835 msgid "REMOTE CONTROL AND CSH"
23840 #: ../fish/guestfish.pod:905
23842 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23848 #: ../fish/guestfish.pod:908
23851 " eval \"`guestfish --listen --csh`\"\n"
23857 #: ../fish/guestfish.pod:910
23858 msgid "REMOTE CONTROL DETAILS"
23863 #: ../fish/guestfish.pod:912
23865 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23866 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23867 "and C<$PID> is the process ID of the server."
23872 #: ../fish/guestfish.pod:916
23873 msgid "Guestfish client and server versions must match exactly."
23878 #: ../fish/guestfish.pod:918
23879 msgid "PREPARED DISK IMAGES"
23884 #: ../fish/guestfish.pod:920
23886 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23887 "preformatted disk images that guestfish can make for you to save typing. "
23888 "This is particularly useful for testing purposes. This option is used "
23889 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23890 "can be mixed with I<-a>)."
23895 #: ../fish/guestfish.pod:926
23897 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23898 "the second and so on. Existing files in the current directory are "
23904 #: ../fish/guestfish.pod:930
23906 "The type briefly describes how the disk should be sized, partitioned, how "
23907 "filesystem(s) should be created, and how content should be added. "
23908 "Optionally the type can be followed by extra parameters, separated by C<:> "
23909 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23910 "allocated disk, containing a single partition, with the partition formatted "
23911 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23917 #: ../fish/guestfish.pod:938
23918 msgid "To list the available types and any extra parameters they take, run:"
23923 #: ../fish/guestfish.pod:942
23925 "Note that the prepared filesystem is not mounted. You would usually have to "
23926 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23931 #: ../fish/guestfish.pod:946
23933 "If any I<-N> or I<--new> options are given, the guest is automatically "
23939 #: ../fish/guestfish.pod:951
23940 msgid "Create a 100MB disk with an ext4-formatted partition:"
23945 #: ../fish/guestfish.pod:953
23948 " guestfish -N fs:ext4\n"
23954 #: ../fish/guestfish.pod:955
23955 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23960 #: ../fish/guestfish.pod:957
23963 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23969 #: ../fish/guestfish.pod:959
23970 msgid "Create a blank 200MB disk:"
23975 #: ../fish/guestfish.pod:961
23978 " guestfish -N disk:200M\n"
23984 #: ../fish/guestfish.pod:963
23985 msgid "PROGRESS BARS"
23990 #: ../fish/guestfish.pod:965
23992 "Some (not all) long-running commands send progress notification messages as "
23993 "they are running. Guestfish turns these messages into progress bars."
23998 #: ../fish/guestfish.pod:969
24000 "When a command that supports progress bars takes longer than two seconds to "
24001 "run, and if progress bars are enabled, then you will see one appearing below "
24007 #: ../fish/guestfish.pod:973
24010 " ><fs> copy-size /large-file /another-file 2048M\n"
24011 " / 10% [#####-----------------------------------------] 00:30\n"
24017 #: ../fish/guestfish.pod:976
24019 "The spinner on the left hand side moves round once for every progress "
24020 "notification received from the backend. This is a (reasonably) golden "
24021 "assurance that the command is \"doing something\" even if the progress bar "
24022 "is not moving, because the command is able to send the progress "
24023 "notifications. When the bar reaches 100% and the command finishes, the "
24024 "spinner disappears."
24029 #: ../fish/guestfish.pod:983
24031 "Progress bars are enabled by default when guestfish is used interactively. "
24032 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24033 "and you can disable them completely using I<--no-progress-bars>."
24038 #: ../fish/guestfish.pod:988
24039 msgid "GUESTFISH COMMANDS"
24044 #: ../fish/guestfish.pod:990
24046 "The commands in this section are guestfish convenience commands, in other "
24047 "words, they are not part of the L<guestfs(3)> API."
24052 #: ../fish/guestfish.pod:993
24058 #: ../fish/guestfish.pod:995
24068 #: ../fish/guestfish.pod:998
24069 msgid "Without any parameter, this provides general help."
24074 #: ../fish/guestfish.pod:1000
24075 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24080 #: ../fish/guestfish.pod:1002
24081 msgid "quit | exit"
24086 #: ../fish/guestfish.pod:1004
24087 msgid "This exits guestfish. You can also use C<^D> key."
24092 #: ../fish/guestfish.pod:1006
24093 msgid "@FISH_COMMANDS@"
24098 #: ../fish/guestfish.pod:1008
24104 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
24110 #: ../fish/guestfish.pod:1014
24112 "guestfish returns 0 if the commands completed without error, or 1 if there "
24118 #: ../fish/guestfish.pod:1021
24124 #: ../fish/guestfish.pod:1023
24126 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24132 #: ../fish/guestfish.pod:1026
24133 msgid "GUESTFISH_PID"
24138 #: ../fish/guestfish.pod:1028
24140 "Used with the I<--remote> option to specify the remote guestfish process to "
24141 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24146 #: ../fish/guestfish.pod:1032
24152 #: ../fish/guestfish.pod:1034
24154 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24155 "not specified, the external L<hexedit(1)> program is used."
24160 #: ../fish/guestfish.pod:1038
24166 #: ../fish/guestfish.pod:1040
24168 "If compiled with GNU readline support, various files in the home directory "
24169 "can be used. See L</FILES>."
24174 #: ../fish/guestfish.pod:1049
24176 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24177 "effect as using the B<-v> option."
24182 #: ../fish/guestfish.pod:1061
24184 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24185 "the discussion of paths in L<guestfs(3)>."
24190 #: ../fish/guestfish.pod:1072
24191 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24196 #: ../fish/guestfish.pod:1074
24202 #: ../fish/guestfish.pod:1076
24204 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24210 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:254
24215 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
24216 msgid "$HOME/.libguestfs-tools.rc"
24220 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
24221 msgid "/etc/libguestfs-tools.conf"
24225 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:262
24227 "This configuration file controls the default read-only or read-write mode "
24228 "(I<--ro> or I<--rw>)."
24232 #: ../fish/guestfish.pod:1103
24233 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24238 #: ../fish/guestfish.pod:1105
24239 msgid "$HOME/.guestfish"
24244 #: ../fish/guestfish.pod:1107
24246 "If compiled with GNU readline support, then the command history is saved in "
24252 #: ../fish/guestfish.pod:1110
24253 msgid "$HOME/.inputrc"
24258 #: ../fish/guestfish.pod:1112
24259 msgid "/etc/inputrc"
24264 #: ../fish/guestfish.pod:1114
24266 "If compiled with GNU readline support, then these files can be used to "
24267 "configure readline. For further information, please see L<readline(3)/"
24268 "INITIALIZATION FILE>."
24273 #: ../fish/guestfish.pod:1118
24274 msgid "To write rules which only apply to guestfish, use:"
24279 #: ../fish/guestfish.pod:1120
24290 #: ../fish/guestfish.pod:1124
24292 "Variables that you can set in inputrc that change the behaviour of guestfish "
24293 "in useful ways include:"
24298 #: ../fish/guestfish.pod:1129
24299 msgid "completion-ignore-case (default: on)"
24304 #: ../fish/guestfish.pod:1131
24306 "By default, guestfish will ignore case when tab-completing paths on the "
24312 #: ../fish/guestfish.pod:1134
24315 " set completion-ignore-case off\n"
24321 #: ../fish/guestfish.pod:1136
24322 msgid "to make guestfish case sensitive."
24327 #: ../fish/guestfish.pod:1140
24333 #: ../fish/guestfish.pod:1142
24334 msgid "test2.img (etc)"
24338 #: ../fish/guestfish.pod:1144
24340 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24341 "will be created in the file C<test1.img> in the current directory. The "
24342 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24343 "the same name will be overwritten."
24347 #: ../fish/guestfish.pod:1153
24349 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24350 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24351 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24352 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24353 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24354 ">, L<hexedit(1)>."
24359 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102
24360 #: ../fuse/guestmount.pod:289 ../tools/virt-edit.pl:518
24361 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24362 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24363 #: ../tools/virt-list-partitions.pl:277
24365 "This program is free software; you can redistribute it and/or modify it "
24366 "under the terms of the GNU General Public License as published by the Free "
24367 "Software Foundation; either version 2 of the License, or (at your option) "
24368 "any later version."
24373 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107
24374 #: ../fuse/guestmount.pod:294 ../tools/virt-edit.pl:523
24375 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24376 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24377 #: ../tools/virt-list-partitions.pl:282
24379 "This program is distributed in the hope that it will be useful, but WITHOUT "
24380 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24381 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24387 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112
24388 #: ../fuse/guestmount.pod:299 ../tools/virt-edit.pl:528
24389 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24390 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24391 #: ../tools/virt-list-partitions.pl:287
24393 "You should have received a copy of the GNU General Public License along with "
24394 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24395 "Ave, Cambridge, MA 02139, USA."
24400 #: ../fish/guestfish-actions.pod:1
24406 #: ../fish/guestfish-actions.pod:3
24409 " add-cdrom filename\n"
24415 #: ../fish/guestfish-actions.pod:15
24417 "This call checks for the existence of C<filename>. This stops you from "
24418 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24419 "and C<http:> URLs. To specify those, use the general L</config> call "
24425 #: ../fish/guestfish-actions.pod:22
24427 "If you just want to add an ISO file (often you use this as an efficient way "
24428 "to transfer large files into the guest), then you should probably use L</add-"
24429 "drive-ro> instead."
24434 #: ../fish/guestfish-actions.pod:35
24440 #: ../fish/guestfish-actions.pod:37
24445 #: ../fish/guestfish-actions.pod:39
24448 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
24454 #: ../fish/guestfish-actions.pod:41
24456 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24457 "It works by connecting to libvirt, requesting the domain and domain XML from "
24458 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24463 #: ../fish/guestfish-actions.pod:76
24465 "The other optional parameters are passed directly through to L</add-drive-"
24471 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
24472 #: ../fish/guestfish-actions.pod:3052
24474 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24479 #: ../fish/guestfish-actions.pod:81
24485 #: ../fish/guestfish-actions.pod:83
24488 " add-drive filename\n"
24494 #: ../fish/guestfish-actions.pod:85
24496 "This function is the equivalent of calling L</add-drive-opts> with no "
24497 "optional parameters, so the disk is added writable, with the format being "
24498 "detected automatically."
24503 #: ../fish/guestfish-actions.pod:89
24505 "Automatic detection of the format opens you up to a potential security hole "
24506 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24507 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24508 "you should think about replacing calls to this function with calls to L</add-"
24509 "drive-opts>, and specifying the format."
24514 #: ../fish/guestfish-actions.pod:96
24515 msgid "add-drive-opts"
24520 #: ../fish/guestfish-actions.pod:98
24526 #: ../fish/guestfish-actions.pod:100
24529 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24535 #: ../fish/guestfish-actions.pod:127
24537 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24538 "add-drive-ro>) then the format is automatically detected. Possible formats "
24539 "include C<raw> and C<qcow2>."
24544 #: ../fish/guestfish-actions.pod:138
24546 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24547 "add-drive-with-if> call (q.v.)"
24552 #: ../fish/guestfish-actions.pod:145
24553 msgid "add-drive-ro"
24558 #: ../fish/guestfish-actions.pod:147
24564 #: ../fish/guestfish-actions.pod:149
24567 " add-drive-ro filename\n"
24573 #: ../fish/guestfish-actions.pod:151
24575 "This function is the equivalent of calling L</add-drive-opts> with the "
24576 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24577 "is added read-only, with the format being detected automatically."
24582 #: ../fish/guestfish-actions.pod:156
24583 msgid "add-drive-ro-with-if"
24588 #: ../fish/guestfish-actions.pod:158
24591 " add-drive-ro-with-if filename iface\n"
24597 #: ../fish/guestfish-actions.pod:160
24599 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24600 "interface emulation to use at run time."
24605 #: ../fish/guestfish-actions.pod:170
24606 msgid "add-drive-with-if"
24611 #: ../fish/guestfish-actions.pod:172
24614 " add-drive-with-if filename iface\n"
24620 #: ../fish/guestfish-actions.pod:174
24622 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24623 "interface emulation to use at run time."
24628 #: ../fish/guestfish-actions.pod:184
24634 #: ../fish/guestfish-actions.pod:186
24637 " aug-clear augpath\n"
24643 #: ../fish/guestfish-actions.pod:191
24649 #: ../fish/guestfish-actions.pod:193
24658 #: ../fish/guestfish-actions.pod:195
24660 "Close the current Augeas handle and free up any resources used by it. After "
24661 "calling this, you have to call L</aug-init> again before you can use any "
24662 "other Augeas functions."
24667 #: ../fish/guestfish-actions.pod:200
24668 msgid "aug-defnode"
24673 #: ../fish/guestfish-actions.pod:202
24676 " aug-defnode name expr val\n"
24682 #: ../fish/guestfish-actions.pod:207
24684 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24685 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24686 "containing that single node."
24691 #: ../fish/guestfish-actions.pod:215
24697 #: ../fish/guestfish-actions.pod:217
24700 " aug-defvar name expr\n"
24706 #: ../fish/guestfish-actions.pod:226
24712 #: ../fish/guestfish-actions.pod:228
24715 " aug-get augpath\n"
24721 #: ../fish/guestfish-actions.pod:233
24727 #: ../fish/guestfish-actions.pod:235
24730 " aug-init root flags\n"
24736 #: ../fish/guestfish-actions.pod:241
24737 msgid "You must call this before using any other L</aug-*> commands."
24742 #: ../fish/guestfish-actions.pod:276
24743 msgid "Do not load the tree in L</aug-init>."
24748 #: ../fish/guestfish-actions.pod:280
24749 msgid "To close the handle, you can call L</aug-close>."
24754 #: ../fish/guestfish-actions.pod:284
24760 #: ../fish/guestfish-actions.pod:286
24763 " aug-insert augpath label true|false\n"
24769 #: ../fish/guestfish-actions.pod:296
24775 #: ../fish/guestfish-actions.pod:298
24784 #: ../fish/guestfish-actions.pod:305
24790 #: ../fish/guestfish-actions.pod:307
24793 " aug-ls augpath\n"
24799 #: ../fish/guestfish-actions.pod:309
24801 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24802 "resulting nodes into alphabetical order."
24807 #: ../fish/guestfish-actions.pod:312
24813 #: ../fish/guestfish-actions.pod:314
24816 " aug-match augpath\n"
24822 #: ../fish/guestfish-actions.pod:320
24828 #: ../fish/guestfish-actions.pod:322
24831 " aug-mv src dest\n"
24837 #: ../fish/guestfish-actions.pod:327
24843 #: ../fish/guestfish-actions.pod:329
24846 " aug-rm augpath\n"
24852 #: ../fish/guestfish-actions.pod:335
24858 #: ../fish/guestfish-actions.pod:337
24867 #: ../fish/guestfish-actions.pod:341
24869 "The flags which were passed to L</aug-init> affect exactly how files are "
24875 #: ../fish/guestfish-actions.pod:344
24881 #: ../fish/guestfish-actions.pod:346
24884 " aug-set augpath val\n"
24890 #: ../fish/guestfish-actions.pod:350
24892 "In the Augeas API, it is possible to clear a node by setting the value to "
24893 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24894 "this call. Instead you must use the L</aug-clear> call."
24899 #: ../fish/guestfish-actions.pod:355
24905 #: ../fish/guestfish-actions.pod:357
24908 " available 'groups ...'\n"
24914 #: ../fish/guestfish-actions.pod:363
24916 "The libguestfs groups, and the functions that those groups correspond to, "
24917 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24918 "runtime by calling L</available-all-groups>."
24923 #: ../fish/guestfish-actions.pod:387
24924 msgid "You must call L</launch> before calling this function."
24929 #: ../fish/guestfish-actions.pod:409
24931 "This call was added in version C<1.0.80>. In previous versions of "
24932 "libguestfs all you could do would be to speculatively execute a command to "
24933 "find out if the daemon implemented it. See also L</version>."
24938 #: ../fish/guestfish-actions.pod:416
24939 msgid "available-all-groups"
24944 #: ../fish/guestfish-actions.pod:418
24947 " available-all-groups\n"
24953 #: ../fish/guestfish-actions.pod:420
24955 "This command returns a list of all optional groups that this daemon knows "
24956 "about. Note this returns both supported and unsupported groups. To find "
24957 "out which ones the daemon can actually support you have to call L</"
24958 "available> on each member of the returned list."
24963 #: ../fish/guestfish-actions.pod:426
24964 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24969 #: ../fish/guestfish-actions.pod:428
24975 #: ../fish/guestfish-actions.pod:430
24978 " base64-in (base64file|-) filename\n"
24984 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
24985 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
24986 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1233
24987 #: ../fish/guestfish-actions.pod:4450 ../fish/guestfish-actions.pod:4462
24988 #: ../fish/guestfish-actions.pod:4473 ../fish/guestfish-actions.pod:4484
24989 #: ../fish/guestfish-actions.pod:4536 ../fish/guestfish-actions.pod:4545
24990 #: ../fish/guestfish-actions.pod:4599 ../fish/guestfish-actions.pod:4622
24991 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24996 #: ../fish/guestfish-actions.pod:437
25002 #: ../fish/guestfish-actions.pod:439
25005 " base64-out filename (base64file|-)\n"
25011 #: ../fish/guestfish-actions.pod:446
25012 msgid "blockdev-flushbufs"
25017 #: ../fish/guestfish-actions.pod:448
25020 " blockdev-flushbufs device\n"
25026 #: ../fish/guestfish-actions.pod:455
25027 msgid "blockdev-getbsz"
25032 #: ../fish/guestfish-actions.pod:457
25035 " blockdev-getbsz device\n"
25041 #: ../fish/guestfish-actions.pod:466
25042 msgid "blockdev-getro"
25047 #: ../fish/guestfish-actions.pod:468
25050 " blockdev-getro device\n"
25056 #: ../fish/guestfish-actions.pod:475
25057 msgid "blockdev-getsize64"
25062 #: ../fish/guestfish-actions.pod:477
25065 " blockdev-getsize64 device\n"
25071 #: ../fish/guestfish-actions.pod:481
25072 msgid "See also L</blockdev-getsz>."
25077 #: ../fish/guestfish-actions.pod:485
25078 msgid "blockdev-getss"
25083 #: ../fish/guestfish-actions.pod:487
25086 " blockdev-getss device\n"
25092 #: ../fish/guestfish-actions.pod:492
25094 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25099 #: ../fish/guestfish-actions.pod:497
25100 msgid "blockdev-getsz"
25105 #: ../fish/guestfish-actions.pod:499
25108 " blockdev-getsz device\n"
25114 #: ../fish/guestfish-actions.pod:504
25116 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25117 "blockdev-getsize64> for the more useful I<size in bytes>."
25122 #: ../fish/guestfish-actions.pod:510
25123 msgid "blockdev-rereadpt"
25128 #: ../fish/guestfish-actions.pod:512
25131 " blockdev-rereadpt device\n"
25137 #: ../fish/guestfish-actions.pod:518
25138 msgid "blockdev-setbsz"
25143 #: ../fish/guestfish-actions.pod:520
25146 " blockdev-setbsz device blocksize\n"
25152 #: ../fish/guestfish-actions.pod:529
25153 msgid "blockdev-setro"
25158 #: ../fish/guestfish-actions.pod:531
25161 " blockdev-setro device\n"
25167 #: ../fish/guestfish-actions.pod:537
25168 msgid "blockdev-setrw"
25173 #: ../fish/guestfish-actions.pod:539
25176 " blockdev-setrw device\n"
25182 #: ../fish/guestfish-actions.pod:545
25183 msgid "case-sensitive-path"
25188 #: ../fish/guestfish-actions.pod:547
25191 " case-sensitive-path path\n"
25197 #: ../fish/guestfish-actions.pod:571
25199 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25200 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25201 "the directories were originally created under Windows)."
25206 #: ../fish/guestfish-actions.pod:579
25207 msgid "See also L</realpath>."
25212 #: ../fish/guestfish-actions.pod:581
25218 #: ../fish/guestfish-actions.pod:583
25227 #: ../fish/guestfish-actions.pod:587
25229 "Note that this function cannot correctly handle binary files (specifically, "
25230 "files containing C<\\0> character which is treated as end of string). For "
25231 "those you need to use the L</read-file> or L</download> functions which have "
25232 "a more complex interface."
25237 #: ../fish/guestfish-actions.pod:595
25243 #: ../fish/guestfish-actions.pod:597
25246 " checksum csumtype path\n"
25252 #: ../fish/guestfish-actions.pod:640
25253 msgid "To get the checksum for a device, use L</checksum-device>."
25258 #: ../fish/guestfish-actions.pod:642
25259 msgid "To get the checksums for many files, use L</checksums-out>."
25264 #: ../fish/guestfish-actions.pod:644
25265 msgid "checksum-device"
25270 #: ../fish/guestfish-actions.pod:646
25273 " checksum-device csumtype device\n"
25279 #: ../fish/guestfish-actions.pod:648
25281 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25282 "device named C<device>. For the types of checksums supported see the L</"
25283 "checksum> command."
25288 #: ../fish/guestfish-actions.pod:652
25289 msgid "checksums-out"
25294 #: ../fish/guestfish-actions.pod:654
25297 " checksums-out csumtype directory (sumsfile|-)\n"
25303 #: ../fish/guestfish-actions.pod:670
25309 #: ../fish/guestfish-actions.pod:672
25312 " chmod mode path\n"
25318 #: ../fish/guestfish-actions.pod:683
25324 #: ../fish/guestfish-actions.pod:685
25327 " chown owner group path\n"
25333 #: ../fish/guestfish-actions.pod:693
25339 #: ../fish/guestfish-actions.pod:695
25342 " command 'arguments ...'\n"
25348 #: ../fish/guestfish-actions.pod:702
25350 "The single parameter is an argv-style list of arguments. The first element "
25351 "is the name of the program to run. Subsequent elements are parameters. The "
25352 "list must be non-empty (ie. must contain a program name). Note that the "
25353 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25358 #: ../fish/guestfish-actions.pod:730
25359 msgid "command-lines"
25364 #: ../fish/guestfish-actions.pod:732
25367 " command-lines 'arguments ...'\n"
25373 #: ../fish/guestfish-actions.pod:734
25375 "This is the same as L</command>, but splits the result into a list of lines."
25380 #: ../fish/guestfish-actions.pod:737
25381 msgid "See also: L</sh-lines>"
25386 #: ../fish/guestfish-actions.pod:742
25392 #: ../fish/guestfish-actions.pod:744
25395 " config qemuparam qemuvalue\n"
25401 #: ../fish/guestfish-actions.pod:755
25407 #: ../fish/guestfish-actions.pod:757
25410 " copy-size src dest size\n"
25416 #: ../fish/guestfish-actions.pod:765
25422 #: ../fish/guestfish-actions.pod:767
25431 #: ../fish/guestfish-actions.pod:772
25437 #: ../fish/guestfish-actions.pod:774
25446 #: ../fish/guestfish-actions.pod:779
25452 #: ../fish/guestfish-actions.pod:781
25461 #: ../fish/guestfish-actions.pod:788
25463 "If the destination is a device, it must be as large or larger than the "
25464 "source file or device, otherwise the copy will fail. This command cannot do "
25465 "partial copies (see L</copy-size>)."
25470 #: ../fish/guestfish-actions.pod:792
25476 #: ../fish/guestfish-actions.pod:794
25485 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
25487 "This command is mostly useful for interactive sessions. It is I<not> "
25488 "intended that you try to parse the output string. Use L</statvfs> from "
25494 #: ../fish/guestfish-actions.pod:802
25500 #: ../fish/guestfish-actions.pod:804
25509 #: ../fish/guestfish-actions.pod:813
25515 #: ../fish/guestfish-actions.pod:815
25524 #: ../fish/guestfish-actions.pod:821
25526 "Another way to get the same information is to enable verbose messages with "
25527 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25528 "before running the program."
25533 #: ../fish/guestfish-actions.pod:826
25539 #: ../fish/guestfish-actions.pod:828
25542 " download remotefilename (filename|-)\n"
25548 #: ../fish/guestfish-actions.pod:835
25549 msgid "See also L</upload>, L</cat>."
25554 #: ../fish/guestfish-actions.pod:839
25555 msgid "download-offset"
25560 #: ../fish/guestfish-actions.pod:841
25563 " download-offset remotefilename (filename|-) offset size\n"
25569 #: ../fish/guestfish-actions.pod:849
25571 "Note that there is no limit on the amount of data that can be downloaded "
25572 "with this call, unlike with L</pread>, and this call always reads the full "
25573 "amount unless an error occurs."
25578 #: ../fish/guestfish-actions.pod:854
25579 msgid "See also L</download>, L</pread>."
25584 #: ../fish/guestfish-actions.pod:858
25585 msgid "drop-caches"
25590 #: ../fish/guestfish-actions.pod:860
25593 " drop-caches whattodrop\n"
25599 #: ../fish/guestfish-actions.pod:872
25605 #: ../fish/guestfish-actions.pod:874
25614 #: ../fish/guestfish-actions.pod:886
25620 #: ../fish/guestfish-actions.pod:888
25623 " e2fsck-f device\n"
25629 #: ../fish/guestfish-actions.pod:894
25631 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25632 "should use L</fsck>."
25637 #: ../fish/guestfish-actions.pod:897
25638 msgid "echo-daemon"
25643 #: ../fish/guestfish-actions.pod:899
25646 " echo-daemon 'words ...'\n"
25652 #: ../fish/guestfish-actions.pod:906
25653 msgid "See also L</ping-daemon>."
25658 #: ../fish/guestfish-actions.pod:908
25664 #: ../fish/guestfish-actions.pod:910
25667 " egrep regex path\n"
25673 #: ../fish/guestfish-actions.pod:918
25679 #: ../fish/guestfish-actions.pod:920
25682 " egrepi regex path\n"
25688 #: ../fish/guestfish-actions.pod:928
25694 #: ../fish/guestfish-actions.pod:930
25697 " equal file1 file2\n"
25703 #: ../fish/guestfish-actions.pod:937
25709 #: ../fish/guestfish-actions.pod:939
25718 #: ../fish/guestfish-actions.pod:944
25719 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25724 #: ../fish/guestfish-actions.pod:946
25730 #: ../fish/guestfish-actions.pod:948
25733 " fallocate path len\n"
25739 #: ../fish/guestfish-actions.pod:965
25740 msgid "fallocate64"
25745 #: ../fish/guestfish-actions.pod:967
25748 " fallocate64 path len\n"
25754 #: ../fish/guestfish-actions.pod:973
25756 "Note that this call allocates disk blocks for the file. To create a sparse "
25757 "file use L</truncate-size> instead."
25762 #: ../fish/guestfish-actions.pod:976
25764 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25765 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25766 "maximum size of files created through that call to 1GB."
25771 #: ../fish/guestfish-actions.pod:985
25777 #: ../fish/guestfish-actions.pod:987
25780 " fgrep pattern path\n"
25786 #: ../fish/guestfish-actions.pod:995
25792 #: ../fish/guestfish-actions.pod:997
25795 " fgrepi pattern path\n"
25801 #: ../fish/guestfish-actions.pod:1005
25807 #: ../fish/guestfish-actions.pod:1007
25816 #: ../fish/guestfish-actions.pod:1019
25818 "This command can also be used on C</dev/> devices (and partitions, LV "
25819 "names). You can for example use this to determine if a device contains a "
25820 "filesystem, although it's usually better to use L</vfs-type>."
25825 #: ../fish/guestfish-actions.pod:1029
25826 msgid "file-architecture"
25831 #: ../fish/guestfish-actions.pod:1031
25834 " file-architecture filename\n"
25840 #: ../fish/guestfish-actions.pod:1134
25846 #: ../fish/guestfish-actions.pod:1136
25855 #: ../fish/guestfish-actions.pod:1140
25857 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25858 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25863 #: ../fish/guestfish-actions.pod:1144
25869 #: ../fish/guestfish-actions.pod:1146
25872 " fill c len path\n"
25878 #: ../fish/guestfish-actions.pod:1152
25880 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25881 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25882 "L</fill-pattern>."
25887 #: ../fish/guestfish-actions.pod:1157
25888 msgid "fill-pattern"
25893 #: ../fish/guestfish-actions.pod:1159
25896 " fill-pattern pattern len path\n"
25902 #: ../fish/guestfish-actions.pod:1161
25904 "This function is like L</fill> except that it creates a new file of length "
25905 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25906 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25912 #: ../fish/guestfish-actions.pod:1166
25918 #: ../fish/guestfish-actions.pod:1168
25921 " find directory\n"
25927 #: ../fish/guestfish-actions.pod:1182
25928 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25933 #: ../fish/guestfish-actions.pod:1195
25934 msgid "See also L</find0>."
25939 #: ../fish/guestfish-actions.pod:1200
25945 #: ../fish/guestfish-actions.pod:1202
25948 " find0 directory (files|-)\n"
25954 #: ../fish/guestfish-actions.pod:1208
25956 "This command works the same way as L</find> with the following exceptions:"
25961 #: ../fish/guestfish-actions.pod:1235
25962 msgid "findfs-label"
25967 #: ../fish/guestfish-actions.pod:1237
25970 " findfs-label label\n"
25976 #: ../fish/guestfish-actions.pod:1243
25977 msgid "To find the label of a filesystem, use L</vfs-label>."
25982 #: ../fish/guestfish-actions.pod:1245
25983 msgid "findfs-uuid"
25988 #: ../fish/guestfish-actions.pod:1247
25991 " findfs-uuid uuid\n"
25997 #: ../fish/guestfish-actions.pod:1253
25998 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
26003 #: ../fish/guestfish-actions.pod:1255
26009 #: ../fish/guestfish-actions.pod:1257
26012 " fsck fstype device\n"
26018 #: ../fish/guestfish-actions.pod:1287
26024 #: ../fish/guestfish-actions.pod:1289
26032 #: ../fish/guestfish-actions.pod:1296
26033 msgid "get-attach-method"
26037 #: ../fish/guestfish-actions.pod:1298
26040 " get-attach-method\n"
26045 #: ../fish/guestfish-actions.pod:1300
26046 msgid "Return the current attach method. See L</set-attach-method>."
26051 #: ../fish/guestfish-actions.pod:1302
26052 msgid "get-autosync"
26057 #: ../fish/guestfish-actions.pod:1304
26066 #: ../fish/guestfish-actions.pod:1308
26072 #: ../fish/guestfish-actions.pod:1310
26081 #: ../fish/guestfish-actions.pod:1314
26082 msgid "get-e2label"
26087 #: ../fish/guestfish-actions.pod:1316
26090 " get-e2label device\n"
26096 #: ../fish/guestfish-actions.pod:1328
26102 #: ../fish/guestfish-actions.pod:1330
26105 " get-e2uuid device\n"
26111 #: ../fish/guestfish-actions.pod:1342
26112 msgid "get-memsize"
26117 #: ../fish/guestfish-actions.pod:1344
26126 #: ../fish/guestfish-actions.pod:1349
26128 "If L</set-memsize> was not called on this handle, and if "
26129 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26130 "value for memsize."
26135 #: ../fish/guestfish-actions.pod:1356
26136 msgid "get-network"
26141 #: ../fish/guestfish-actions.pod:1358
26150 #: ../fish/guestfish-actions.pod:1362
26156 #: ../fish/guestfish-actions.pod:1364
26165 #: ../fish/guestfish-actions.pod:1371
26171 #: ../fish/guestfish-actions.pod:1373
26177 #: ../fish/guestfish-actions.pod:1375
26186 #: ../fish/guestfish-actions.pod:1382
26192 #: ../fish/guestfish-actions.pod:1384
26201 #: ../fish/guestfish-actions.pod:1391
26202 msgid "get-recovery-proc"
26207 #: ../fish/guestfish-actions.pod:1393
26210 " get-recovery-proc\n"
26216 #: ../fish/guestfish-actions.pod:1397
26217 msgid "get-selinux"
26222 #: ../fish/guestfish-actions.pod:1399
26231 #: ../fish/guestfish-actions.pod:1401
26233 "This returns the current setting of the selinux flag which is passed to the "
26234 "appliance at boot time. See L</set-selinux>."
26239 #: ../fish/guestfish-actions.pod:1407
26245 #: ../fish/guestfish-actions.pod:1409
26254 #: ../fish/guestfish-actions.pod:1416
26260 #: ../fish/guestfish-actions.pod:1418
26269 #: ../fish/guestfish-actions.pod:1422
26275 #: ../fish/guestfish-actions.pod:1424
26284 #: ../fish/guestfish-actions.pod:1426
26286 "Return the current umask. By default the umask is C<022> unless it has been "
26287 "set by calling L</umask>."
26292 #: ../fish/guestfish-actions.pod:1429
26293 msgid "get-verbose"
26298 #: ../fish/guestfish-actions.pod:1431
26307 #: ../fish/guestfish-actions.pod:1435
26313 #: ../fish/guestfish-actions.pod:1437
26322 #: ../fish/guestfish-actions.pod:1441
26323 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26328 #: ../fish/guestfish-actions.pod:1444
26334 #: ../fish/guestfish-actions.pod:1446
26337 " getxattr path name\n"
26343 #: ../fish/guestfish-actions.pod:1448
26345 "Get a single extended attribute from file C<path> named C<name>. This call "
26346 "follows symlinks. If you want to lookup an extended attribute for the "
26347 "symlink itself, use L</lgetxattr>."
26352 #: ../fish/guestfish-actions.pod:1452 ../fish/guestfish-actions.pod:2458
26354 "Normally it is better to get all extended attributes from a file in one go "
26355 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26356 "buggy and do not provide a way to list out attributes. For these "
26357 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26358 "attributes you want in advance and call this function."
26363 #: ../fish/guestfish-actions.pod:1462
26364 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26369 #: ../fish/guestfish-actions.pod:1464
26375 #: ../fish/guestfish-actions.pod:1466
26378 " getxattrs path\n"
26384 #: ../fish/guestfish-actions.pod:1474
26385 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26390 #: ../fish/guestfish-actions.pod:1476
26391 msgid "glob-expand"
26396 #: ../fish/guestfish-actions.pod:1478
26399 " glob-expand pattern\n"
26405 #: ../fish/guestfish-actions.pod:1491
26411 #: ../fish/guestfish-actions.pod:1493
26414 " grep regex path\n"
26420 #: ../fish/guestfish-actions.pod:1501
26426 #: ../fish/guestfish-actions.pod:1503
26429 " grepi regex path\n"
26435 #: ../fish/guestfish-actions.pod:1511
26436 msgid "grub-install"
26441 #: ../fish/guestfish-actions.pod:1513
26444 " grub-install root device\n"
26450 #: ../fish/guestfish-actions.pod:1529
26456 #: ../fish/guestfish-actions.pod:1531
26465 #: ../fish/guestfish-actions.pod:1539
26471 #: ../fish/guestfish-actions.pod:1541
26474 " head-n nrlines path\n"
26480 #: ../fish/guestfish-actions.pod:1554
26486 #: ../fish/guestfish-actions.pod:1556
26495 #: ../fish/guestfish-actions.pod:1564
26501 #: ../fish/guestfish-actions.pod:1566
26504 " initrd-cat initrdpath filename\n"
26510 #: ../fish/guestfish-actions.pod:1578
26511 msgid "See also L</initrd-list>."
26516 #: ../fish/guestfish-actions.pod:1583
26517 msgid "initrd-list"
26522 #: ../fish/guestfish-actions.pod:1585
26525 " initrd-list path\n"
26531 #: ../fish/guestfish-actions.pod:1597
26532 msgid "inotify-add-watch"
26537 #: ../fish/guestfish-actions.pod:1599
26540 " inotify-add-watch path mask\n"
26546 #: ../fish/guestfish-actions.pod:1611
26547 msgid "inotify-close"
26552 #: ../fish/guestfish-actions.pod:1613
26561 #: ../fish/guestfish-actions.pod:1619
26562 msgid "inotify-files"
26567 #: ../fish/guestfish-actions.pod:1621
26576 #: ../fish/guestfish-actions.pod:1623
26578 "This function is a helpful wrapper around L</inotify-read> which just "
26579 "returns a list of pathnames of objects that were touched. The returned "
26580 "pathnames are sorted and deduplicated."
26585 #: ../fish/guestfish-actions.pod:1627
26586 msgid "inotify-init"
26591 #: ../fish/guestfish-actions.pod:1629
26594 " inotify-init maxevents\n"
26600 #: ../fish/guestfish-actions.pod:1635
26602 "C<maxevents> is the maximum number of events which will be queued up between "
26603 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26604 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26605 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26606 "but records the fact that it threw them away by setting a flag "
26607 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26612 #: ../fish/guestfish-actions.pod:1645
26614 "Before any events are generated, you have to add some watches to the "
26615 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26616 "L</inotify-watch-all>."
26621 #: ../fish/guestfish-actions.pod:1651
26623 "Queued up events should be read periodically by calling L</inotify-read> (or "
26624 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26625 "If you don't read the events out often enough then you risk the internal "
26626 "queue overflowing."
26631 #: ../fish/guestfish-actions.pod:1658
26633 "The handle should be closed after use by calling L</inotify-close>. This "
26634 "also removes any watches automatically."
26639 #: ../fish/guestfish-actions.pod:1667
26640 msgid "inotify-read"
26645 #: ../fish/guestfish-actions.pod:1669
26654 #: ../fish/guestfish-actions.pod:1682
26655 msgid "inotify-rm-watch"
26660 #: ../fish/guestfish-actions.pod:1684
26663 " inotify-rm-watch wd\n"
26669 #: ../fish/guestfish-actions.pod:1686
26670 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26675 #: ../fish/guestfish-actions.pod:1689
26676 msgid "inspect-get-arch"
26681 #: ../fish/guestfish-actions.pod:1691
26684 " inspect-get-arch root\n"
26690 #: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1709
26691 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1831
26692 #: ../fish/guestfish-actions.pod:1849 ../fish/guestfish-actions.pod:1883
26693 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1919
26694 #: ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1967
26695 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2013
26696 #: ../fish/guestfish-actions.pod:2030 ../fish/guestfish-actions.pod:2073
26697 #: ../fish/guestfish-actions.pod:2108 ../fish/guestfish-actions.pod:2124
26698 #: ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153
26699 #: ../fish/guestfish-actions.pod:2166 ../fish/guestfish-actions.pod:2181
26701 "This function should only be called with a root device string as returned by "
26707 #: ../fish/guestfish-actions.pod:1696
26709 "This returns the architecture of the inspected operating system. The "
26710 "possible return values are listed under L</file-architecture>."
26715 #: ../fish/guestfish-actions.pod:1705
26716 msgid "inspect-get-distro"
26721 #: ../fish/guestfish-actions.pod:1707
26724 " inspect-get-distro root\n"
26729 #: ../fish/guestfish-actions.pod:1791
26730 msgid "inspect-get-drive-mappings"
26734 #: ../fish/guestfish-actions.pod:1793
26737 " inspect-get-drive-mappings root\n"
26742 #: ../fish/guestfish-actions.pod:1823
26744 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26745 "get-mountpoints>, L</inspect-get-filesystems>."
26750 #: ../fish/guestfish-actions.pod:1827
26751 msgid "inspect-get-filesystems"
26756 #: ../fish/guestfish-actions.pod:1829
26759 " inspect-get-filesystems root\n"
26765 #: ../fish/guestfish-actions.pod:1842
26767 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26768 "get-mountpoints>."
26772 #: ../fish/guestfish-actions.pod:1845
26773 msgid "inspect-get-format"
26777 #: ../fish/guestfish-actions.pod:1847
26780 " inspect-get-format root\n"
26786 #: ../fish/guestfish-actions.pod:1879
26787 msgid "inspect-get-hostname"
26792 #: ../fish/guestfish-actions.pod:1881
26795 " inspect-get-hostname root\n"
26801 #: ../fish/guestfish-actions.pod:1894
26802 msgid "inspect-get-major-version"
26807 #: ../fish/guestfish-actions.pod:1896
26810 " inspect-get-major-version root\n"
26816 #: ../fish/guestfish-actions.pod:1915
26817 msgid "inspect-get-minor-version"
26822 #: ../fish/guestfish-actions.pod:1917
26825 " inspect-get-minor-version root\n"
26831 #: ../fish/guestfish-actions.pod:1927
26833 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26834 "get-major-version>."
26839 #: ../fish/guestfish-actions.pod:1930
26840 msgid "inspect-get-mountpoints"
26845 #: ../fish/guestfish-actions.pod:1932
26848 " inspect-get-mountpoints root\n"
26853 #: ../fish/guestfish-actions.pod:1954
26855 "For operating systems like Windows which still use drive letters, this call "
26856 "will only return an entry for the first drive \"mounted on\" C</>. For "
26857 "information about the mapping of drive letters to partitions, see L</inspect-"
26858 "get-drive-mappings>."
26863 #: ../fish/guestfish-actions.pod:1960
26865 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26866 "get-filesystems>."
26871 #: ../fish/guestfish-actions.pod:1963
26872 msgid "inspect-get-package-format"
26877 #: ../fish/guestfish-actions.pod:1965
26880 " inspect-get-package-format root\n"
26886 #: ../fish/guestfish-actions.pod:1970
26888 "This function and L</inspect-get-package-management> return the package "
26889 "format and package management tool used by the inspected operating system. "
26890 "For example for Fedora these functions would return C<rpm> (package format) "
26891 "and C<yum> (package management)."
26896 #: ../fish/guestfish-actions.pod:1985
26897 msgid "inspect-get-package-management"
26902 #: ../fish/guestfish-actions.pod:1987
26905 " inspect-get-package-management root\n"
26911 #: ../fish/guestfish-actions.pod:1992
26913 "L</inspect-get-package-format> and this function return the package format "
26914 "and package management tool used by the inspected operating system. For "
26915 "example for Fedora these functions would return C<rpm> (package format) and "
26916 "C<yum> (package management)."
26921 #: ../fish/guestfish-actions.pod:2009
26922 msgid "inspect-get-product-name"
26927 #: ../fish/guestfish-actions.pod:2011
26930 " inspect-get-product-name root\n"
26935 #: ../fish/guestfish-actions.pod:2026
26936 msgid "inspect-get-product-variant"
26940 #: ../fish/guestfish-actions.pod:2028
26943 " inspect-get-product-variant root\n"
26948 #: ../fish/guestfish-actions.pod:2052
26950 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26951 "get-product-name>, L</inspect-get-major-version>."
26956 #: ../fish/guestfish-actions.pod:2056
26957 msgid "inspect-get-roots"
26962 #: ../fish/guestfish-actions.pod:2058
26965 " inspect-get-roots\n"
26971 #: ../fish/guestfish-actions.pod:2060
26973 "This function is a convenient way to get the list of root devices, as "
26974 "returned from a previous call to L</inspect-os>, but without redoing the "
26975 "whole inspection process."
26980 #: ../fish/guestfish-actions.pod:2064
26982 "This returns an empty list if either no root devices were found or the "
26983 "caller has not called L</inspect-os>."
26988 #: ../fish/guestfish-actions.pod:2069
26989 msgid "inspect-get-type"
26994 #: ../fish/guestfish-actions.pod:2071
26997 " inspect-get-type root\n"
27002 #: ../fish/guestfish-actions.pod:2104
27003 msgid "inspect-get-windows-current-control-set"
27007 #: ../fish/guestfish-actions.pod:2106
27010 " inspect-get-windows-current-control-set root\n"
27016 #: ../fish/guestfish-actions.pod:2120
27017 msgid "inspect-get-windows-systemroot"
27022 #: ../fish/guestfish-actions.pod:2122
27025 " inspect-get-windows-systemroot root\n"
27030 #: ../fish/guestfish-actions.pod:2136
27031 msgid "inspect-is-live"
27035 #: ../fish/guestfish-actions.pod:2138
27038 " inspect-is-live root\n"
27043 #: ../fish/guestfish-actions.pod:2143
27045 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27046 "then this returns true if a live image was detected on the disk."
27050 #: ../fish/guestfish-actions.pod:2149
27051 msgid "inspect-is-multipart"
27055 #: ../fish/guestfish-actions.pod:2151
27058 " inspect-is-multipart root\n"
27063 #: ../fish/guestfish-actions.pod:2156
27065 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27066 "then this returns true if the disk is part of a set."
27070 #: ../fish/guestfish-actions.pod:2162
27071 msgid "inspect-is-netinst"
27075 #: ../fish/guestfish-actions.pod:2164
27078 " inspect-is-netinst root\n"
27083 #: ../fish/guestfish-actions.pod:2169
27085 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27086 "then this returns true if the disk is a network installer, ie. not a self-"
27087 "contained install CD but one which is likely to require network access to "
27088 "complete the install."
27093 #: ../fish/guestfish-actions.pod:2177
27094 msgid "inspect-list-applications"
27099 #: ../fish/guestfish-actions.pod:2179
27102 " inspect-list-applications root\n"
27108 #: ../fish/guestfish-actions.pod:2186
27110 "I<Note:> This call works differently from other parts of the inspection "
27111 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27112 "then mount up the disks, before calling this. Listing applications is a "
27113 "significantly more difficult operation which requires access to the full "
27114 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27115 "are just returning data cached in the libguestfs handle, this call actually "
27116 "reads parts of the mounted filesystems during the call."
27121 #: ../fish/guestfish-actions.pod:2276
27127 #: ../fish/guestfish-actions.pod:2278
27136 #: ../fish/guestfish-actions.pod:2293
27138 "You can pass the root string(s) returned to other L</inspect-get-*> "
27139 "functions in order to query further information about each operating system, "
27140 "such as the name and version."
27145 #: ../fish/guestfish-actions.pod:2298
27147 "This function uses other libguestfs features such as L</mount-ro> and L</"
27148 "umount-all> in order to mount and unmount filesystems and look at the "
27149 "contents. This should be called with no disks currently mounted. The "
27150 "function may also use Augeas, so any existing Augeas handle will be closed."
27155 #: ../fish/guestfish-actions.pod:2310 ../fish/guestfish-actions.pod:2486
27156 #: ../fish/guestfish-actions.pod:2532
27157 msgid "See also L</list-filesystems>."
27162 #: ../fish/guestfish-actions.pod:2312
27163 msgid "is-blockdev"
27168 #: ../fish/guestfish-actions.pod:2314
27171 " is-blockdev path\n"
27177 #: ../fish/guestfish-actions.pod:2319 ../fish/guestfish-actions.pod:2337
27178 #: ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2365
27179 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2409
27180 #: ../fish/guestfish-actions.pod:2418
27181 msgid "See also L</stat>."
27186 #: ../fish/guestfish-actions.pod:2321
27192 #: ../fish/guestfish-actions.pod:2323
27201 #: ../fish/guestfish-actions.pod:2330
27207 #: ../fish/guestfish-actions.pod:2332
27210 " is-chardev path\n"
27216 #: ../fish/guestfish-actions.pod:2339
27222 #: ../fish/guestfish-actions.pod:2341
27231 #: ../fish/guestfish-actions.pod:2348
27237 #: ../fish/guestfish-actions.pod:2350
27246 #: ../fish/guestfish-actions.pod:2358
27252 #: ../fish/guestfish-actions.pod:2360
27261 #: ../fish/guestfish-actions.pod:2367
27267 #: ../fish/guestfish-actions.pod:2369
27276 #: ../fish/guestfish-actions.pod:2377
27277 msgid "is-launching"
27282 #: ../fish/guestfish-actions.pod:2379
27291 #: ../fish/guestfish-actions.pod:2386
27297 #: ../fish/guestfish-actions.pod:2388
27306 #: ../fish/guestfish-actions.pod:2393
27312 #: ../fish/guestfish-actions.pod:2395
27321 #: ../fish/guestfish-actions.pod:2402
27327 #: ../fish/guestfish-actions.pod:2404
27330 " is-socket path\n"
27336 #: ../fish/guestfish-actions.pod:2411
27342 #: ../fish/guestfish-actions.pod:2413
27345 " is-symlink path\n"
27351 #: ../fish/guestfish-actions.pod:2420
27352 msgid "kill-subprocess"
27357 #: ../fish/guestfish-actions.pod:2422
27360 " kill-subprocess\n"
27366 #: ../fish/guestfish-actions.pod:2426
27372 #: ../fish/guestfish-actions.pod:2428
27378 #: ../fish/guestfish-actions.pod:2430
27387 #: ../fish/guestfish-actions.pod:2438
27393 #: ../fish/guestfish-actions.pod:2440
27396 " lchown owner group path\n"
27402 #: ../fish/guestfish-actions.pod:2442
27404 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27405 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27411 #: ../fish/guestfish-actions.pod:2450
27417 #: ../fish/guestfish-actions.pod:2452
27420 " lgetxattr path name\n"
27426 #: ../fish/guestfish-actions.pod:2468
27427 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27432 #: ../fish/guestfish-actions.pod:2470
27438 #: ../fish/guestfish-actions.pod:2472
27441 " lgetxattrs path\n"
27447 #: ../fish/guestfish-actions.pod:2474
27449 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27450 "it returns the extended attributes of the link itself."
27455 #: ../fish/guestfish-actions.pod:2478
27456 msgid "list-devices"
27461 #: ../fish/guestfish-actions.pod:2480
27470 #: ../fish/guestfish-actions.pod:2488
27471 msgid "list-filesystems"
27476 #: ../fish/guestfish-actions.pod:2490
27479 " list-filesystems\n"
27485 #: ../fish/guestfish-actions.pod:2509
27487 "This command runs other libguestfs commands, which might include L</mount> "
27488 "and L</umount>, and therefore you should use this soon after launch and only "
27489 "when nothing is mounted."
27494 #: ../fish/guestfish-actions.pod:2513
27496 "Not all of the filesystems returned will be mountable. In particular, swap "
27497 "partitions are returned in the list. Also this command does not check that "
27498 "each filesystem found is valid and mountable, and some filesystems might be "
27499 "mountable but require special options. Filesystems may not all belong to a "
27500 "single logical operating system (use L</inspect-os> to look for OSes)."
27505 #: ../fish/guestfish-actions.pod:2521
27506 msgid "list-partitions"
27511 #: ../fish/guestfish-actions.pod:2523
27514 " list-partitions\n"
27520 #: ../fish/guestfish-actions.pod:2529
27522 "This does not return logical volumes. For that you will need to call L</"
27528 #: ../fish/guestfish-actions.pod:2534
27534 #: ../fish/guestfish-actions.pod:2536
27543 #: ../fish/guestfish-actions.pod:2544
27549 #: ../fish/guestfish-actions.pod:2546
27552 " ln target linkname\n"
27558 #: ../fish/guestfish-actions.pod:2550
27564 #: ../fish/guestfish-actions.pod:2552
27567 " ln-f target linkname\n"
27573 #: ../fish/guestfish-actions.pod:2557
27579 #: ../fish/guestfish-actions.pod:2559
27582 " ln-s target linkname\n"
27588 #: ../fish/guestfish-actions.pod:2563
27594 #: ../fish/guestfish-actions.pod:2565
27597 " ln-sf target linkname\n"
27603 #: ../fish/guestfish-actions.pod:2570
27604 msgid "lremovexattr"
27609 #: ../fish/guestfish-actions.pod:2572
27612 " lremovexattr xattr path\n"
27618 #: ../fish/guestfish-actions.pod:2574
27620 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27621 "it removes an extended attribute of the link itself."
27626 #: ../fish/guestfish-actions.pod:2578
27632 #: ../fish/guestfish-actions.pod:2580
27641 #: ../fish/guestfish-actions.pod:2586
27643 "This command is mostly useful for interactive sessions. Programs should "
27644 "probably use L</readdir> instead."
27649 #: ../fish/guestfish-actions.pod:2589
27655 #: ../fish/guestfish-actions.pod:2591
27658 " lsetxattr xattr val vallen path\n"
27664 #: ../fish/guestfish-actions.pod:2593
27666 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27667 "sets an extended attribute of the link itself."
27672 #: ../fish/guestfish-actions.pod:2597
27678 #: ../fish/guestfish-actions.pod:2599
27687 #: ../fish/guestfish-actions.pod:2603
27689 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27690 "the link is stat-ed, not the file it refers to."
27695 #: ../fish/guestfish-actions.pod:2609
27701 #: ../fish/guestfish-actions.pod:2611
27704 " lstatlist path 'names ...'\n"
27710 #: ../fish/guestfish-actions.pod:2613
27712 "This call allows you to perform the L</lstat> operation on multiple files, "
27713 "where all files are in the directory C<path>. C<names> is the list of files "
27714 "from this directory."
27719 #: ../fish/guestfish-actions.pod:2622
27721 "This call is intended for programs that want to efficiently list a directory "
27722 "contents without making many round-trips. See also L</lxattrlist> for a "
27723 "similarly efficient call for getting extended attributes. Very long "
27724 "directory listings might cause the protocol message size to be exceeded, "
27725 "causing this call to fail. The caller must split up such requests into "
27726 "smaller groups of names."
27731 #: ../fish/guestfish-actions.pod:2630
27732 msgid "luks-add-key"
27737 #: ../fish/guestfish-actions.pod:2632
27740 " luks-add-key device keyslot\n"
27746 #: ../fish/guestfish-actions.pod:2639
27748 "Note that if C<keyslot> already contains a key, then this command will "
27749 "fail. You have to use L</luks-kill-slot> first to remove that key."
27754 #: ../fish/guestfish-actions.pod:2643 ../fish/guestfish-actions.pod:2665
27755 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2692
27756 #: ../fish/guestfish-actions.pod:2715 ../fish/guestfish-actions.pod:2725
27758 "This command has one or more key or passphrase parameters. Guestfish will "
27759 "prompt for these separately."
27764 #: ../fish/guestfish-actions.pod:2646
27770 #: ../fish/guestfish-actions.pod:2648
27773 " luks-close device\n"
27779 #: ../fish/guestfish-actions.pod:2650
27781 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27782 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27783 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27789 #: ../fish/guestfish-actions.pod:2656
27790 msgid "luks-format"
27795 #: ../fish/guestfish-actions.pod:2658
27798 " luks-format device keyslot\n"
27804 #: ../fish/guestfish-actions.pod:2671
27805 msgid "luks-format-cipher"
27810 #: ../fish/guestfish-actions.pod:2673
27813 " luks-format-cipher device keyslot cipher\n"
27819 #: ../fish/guestfish-actions.pod:2675
27821 "This command is the same as L</luks-format> but it also allows you to set "
27822 "the C<cipher> used."
27827 #: ../fish/guestfish-actions.pod:2684
27828 msgid "luks-kill-slot"
27833 #: ../fish/guestfish-actions.pod:2686
27836 " luks-kill-slot device keyslot\n"
27842 #: ../fish/guestfish-actions.pod:2695
27848 #: ../fish/guestfish-actions.pod:2697
27851 " luks-open device mapname\n"
27857 #: ../fish/guestfish-actions.pod:2711
27859 "If this block device contains LVM volume groups, then calling L</vgscan> "
27860 "followed by L</vg-activate-all> will make them visible."
27865 #: ../fish/guestfish-actions.pod:2718
27866 msgid "luks-open-ro"
27871 #: ../fish/guestfish-actions.pod:2720
27874 " luks-open-ro device mapname\n"
27880 #: ../fish/guestfish-actions.pod:2722
27882 "This is the same as L</luks-open> except that a read-only mapping is created."
27887 #: ../fish/guestfish-actions.pod:2728
27893 #: ../fish/guestfish-actions.pod:2730
27896 " lvcreate logvol volgroup mbytes\n"
27902 #: ../fish/guestfish-actions.pod:2735
27903 msgid "lvm-canonical-lv-name"
27908 #: ../fish/guestfish-actions.pod:2737
27911 " lvm-canonical-lv-name lvname\n"
27917 #: ../fish/guestfish-actions.pod:2746
27918 msgid "See also L</is-lv>."
27923 #: ../fish/guestfish-actions.pod:2748
27924 msgid "lvm-clear-filter"
27929 #: ../fish/guestfish-actions.pod:2750
27932 " lvm-clear-filter\n"
27938 #: ../fish/guestfish-actions.pod:2752
27940 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27946 #: ../fish/guestfish-actions.pod:2758
27947 msgid "lvm-remove-all"
27952 #: ../fish/guestfish-actions.pod:2760
27955 " lvm-remove-all\n"
27961 #: ../fish/guestfish-actions.pod:2768
27962 msgid "lvm-set-filter"
27967 #: ../fish/guestfish-actions.pod:2770
27970 " lvm-set-filter 'devices ...'\n"
27976 #: ../fish/guestfish-actions.pod:2795
27982 #: ../fish/guestfish-actions.pod:2797
27985 " lvremove device\n"
27991 #: ../fish/guestfish-actions.pod:2805
27997 #: ../fish/guestfish-actions.pod:2807
28000 " lvrename logvol newlogvol\n"
28006 #: ../fish/guestfish-actions.pod:2811
28012 #: ../fish/guestfish-actions.pod:2813
28015 " lvresize device mbytes\n"
28021 #: ../fish/guestfish-actions.pod:2819
28022 msgid "lvresize-free"
28027 #: ../fish/guestfish-actions.pod:2821
28030 " lvresize-free lv percent\n"
28036 #: ../fish/guestfish-actions.pod:2829
28042 #: ../fish/guestfish-actions.pod:2831
28051 #: ../fish/guestfish-actions.pod:2839
28052 msgid "See also L</lvs-full>, L</list-filesystems>."
28057 #: ../fish/guestfish-actions.pod:2841
28063 #: ../fish/guestfish-actions.pod:2843
28072 #: ../fish/guestfish-actions.pod:2848
28078 #: ../fish/guestfish-actions.pod:2850
28087 #: ../fish/guestfish-actions.pod:2854
28093 #: ../fish/guestfish-actions.pod:2856
28096 " lxattrlist path 'names ...'\n"
28102 #: ../fish/guestfish-actions.pod:2872
28104 "This call is intended for programs that want to efficiently list a directory "
28105 "contents without making many round-trips. See also L</lstatlist> for a "
28106 "similarly efficient call for getting standard stats. Very long directory "
28107 "listings might cause the protocol message size to be exceeded, causing this "
28108 "call to fail. The caller must split up such requests into smaller groups of "
28114 #: ../fish/guestfish-actions.pod:2880
28120 #: ../fish/guestfish-actions.pod:2882
28129 #: ../fish/guestfish-actions.pod:2886
28135 #: ../fish/guestfish-actions.pod:2888
28138 " mkdir-mode path mode\n"
28144 #: ../fish/guestfish-actions.pod:2897
28145 msgid "See also L</mkdir>, L</umask>"
28150 #: ../fish/guestfish-actions.pod:2899
28156 #: ../fish/guestfish-actions.pod:2901
28165 #: ../fish/guestfish-actions.pod:2906
28171 #: ../fish/guestfish-actions.pod:2908
28174 " mkdtemp template\n"
28180 #: ../fish/guestfish-actions.pod:2929
28186 #: ../fish/guestfish-actions.pod:2931
28189 " mke2fs-J fstype blocksize device journal\n"
28195 #: ../fish/guestfish-actions.pod:2939
28196 msgid "See also L</mke2journal>."
28201 #: ../fish/guestfish-actions.pod:2941
28207 #: ../fish/guestfish-actions.pod:2943
28210 " mke2fs-JL fstype blocksize device label\n"
28216 #: ../fish/guestfish-actions.pod:2948
28217 msgid "See also L</mke2journal-L>."
28222 #: ../fish/guestfish-actions.pod:2950
28228 #: ../fish/guestfish-actions.pod:2952
28231 " mke2fs-JU fstype blocksize device uuid\n"
28237 #: ../fish/guestfish-actions.pod:2957
28238 msgid "See also L</mke2journal-U>."
28243 #: ../fish/guestfish-actions.pod:2959
28244 msgid "mke2journal"
28249 #: ../fish/guestfish-actions.pod:2961
28252 " mke2journal blocksize device\n"
28258 #: ../fish/guestfish-actions.pod:2968
28259 msgid "mke2journal-L"
28264 #: ../fish/guestfish-actions.pod:2970
28267 " mke2journal-L blocksize label device\n"
28273 #: ../fish/guestfish-actions.pod:2974
28274 msgid "mke2journal-U"
28279 #: ../fish/guestfish-actions.pod:2976
28282 " mke2journal-U blocksize uuid device\n"
28288 #: ../fish/guestfish-actions.pod:2980
28294 #: ../fish/guestfish-actions.pod:2982
28297 " mkfifo mode path\n"
28303 #: ../fish/guestfish-actions.pod:2984
28305 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28306 "is just a convenient wrapper around L</mknod>."
28311 #: ../fish/guestfish-actions.pod:2990
28317 #: ../fish/guestfish-actions.pod:2992
28320 " mkfs fstype device\n"
28326 #: ../fish/guestfish-actions.pod:2998
28332 #: ../fish/guestfish-actions.pod:3000
28335 " mkfs-b fstype blocksize device\n"
28341 #: ../fish/guestfish-actions.pod:3002
28343 "This call is similar to L</mkfs>, but it allows you to control the block "
28344 "size of the resulting filesystem. Supported block sizes depend on the "
28345 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28350 #: ../fish/guestfish-actions.pod:3017
28355 #: ../fish/guestfish-actions.pod:3019
28358 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28364 #: ../fish/guestfish-actions.pod:3054
28365 msgid "mkmountpoint"
28370 #: ../fish/guestfish-actions.pod:3056
28373 " mkmountpoint exemptpath\n"
28379 #: ../fish/guestfish-actions.pod:3058
28381 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28382 "to create extra mountpoints before mounting the first filesystem."
28387 #: ../fish/guestfish-actions.pod:3082
28389 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28390 "unexpected errors if you try to mix these calls. It is safest to manually "
28391 "unmount filesystems and remove mountpoints after use."
28396 #: ../fish/guestfish-actions.pod:3086
28398 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28399 "for this to work for manual mountpoints, you must ensure that the innermost "
28400 "mountpoints have the longest pathnames, as in the example code above."
28404 #: ../fish/guestfish-actions.pod:3093
28406 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28407 "L</umount-all> to be called when the handle is closed which can also trigger "
28413 #: ../fish/guestfish-actions.pod:3097
28419 #: ../fish/guestfish-actions.pod:3099
28422 " mknod mode devmajor devminor path\n"
28428 #: ../fish/guestfish-actions.pod:3109
28430 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28431 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28432 "regular file). These constants are available in the standard Linux header "
28433 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28434 "wrappers around this command which bitwise OR in the appropriate constant "
28440 #: ../fish/guestfish-actions.pod:3119
28446 #: ../fish/guestfish-actions.pod:3121
28449 " mknod-b mode devmajor devminor path\n"
28455 #: ../fish/guestfish-actions.pod:3123
28457 "This call creates a block device node called C<path> with mode C<mode> and "
28458 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28459 "wrapper around L</mknod>."
28464 #: ../fish/guestfish-actions.pod:3129
28470 #: ../fish/guestfish-actions.pod:3131
28473 " mknod-c mode devmajor devminor path\n"
28479 #: ../fish/guestfish-actions.pod:3133
28481 "This call creates a char device node called C<path> with mode C<mode> and "
28482 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28483 "wrapper around L</mknod>."
28488 #: ../fish/guestfish-actions.pod:3139
28494 #: ../fish/guestfish-actions.pod:3141
28503 #: ../fish/guestfish-actions.pod:3145
28509 #: ../fish/guestfish-actions.pod:3147
28512 " mkswap-L label device\n"
28518 #: ../fish/guestfish-actions.pod:3155
28524 #: ../fish/guestfish-actions.pod:3157
28527 " mkswap-U uuid device\n"
28533 #: ../fish/guestfish-actions.pod:3161
28534 msgid "mkswap-file"
28539 #: ../fish/guestfish-actions.pod:3163
28542 " mkswap-file path\n"
28548 #: ../fish/guestfish-actions.pod:3167
28550 "This command just writes a swap file signature to an existing file. To "
28551 "create the file itself, use something like L</fallocate>."
28556 #: ../fish/guestfish-actions.pod:3170
28562 #: ../fish/guestfish-actions.pod:3172
28565 " modprobe modulename\n"
28571 #: ../fish/guestfish-actions.pod:3179
28577 #: ../fish/guestfish-actions.pod:3181
28580 " mount device mountpoint\n"
28586 #: ../fish/guestfish-actions.pod:3197
28588 "B<Important note:> When you use this call, the filesystem options C<sync> "
28589 "and C<noatime> are set implicitly. This was originally done because we "
28590 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28591 "very large negative performance impact and negligible effect on "
28592 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28593 "code that needs performance, and instead use L</mount-options> (use an empty "
28594 "string for the first parameter if you don't want any options)."
28599 #: ../fish/guestfish-actions.pod:3207
28605 #: ../fish/guestfish-actions.pod:3209
28608 " mount-loop file mountpoint\n"
28614 #: ../fish/guestfish-actions.pod:3215
28615 msgid "mount-options"
28620 #: ../fish/guestfish-actions.pod:3217
28623 " mount-options options device mountpoint\n"
28629 #: ../fish/guestfish-actions.pod:3219
28631 "This is the same as the L</mount> command, but it allows you to set the "
28632 "mount options as for the L<mount(8)> I<-o> flag."
28637 #: ../fish/guestfish-actions.pod:3227
28643 #: ../fish/guestfish-actions.pod:3229
28646 " mount-ro device mountpoint\n"
28652 #: ../fish/guestfish-actions.pod:3231
28654 "This is the same as the L</mount> command, but it mounts the filesystem with "
28655 "the read-only (I<-o ro>) flag."
28660 #: ../fish/guestfish-actions.pod:3234
28666 #: ../fish/guestfish-actions.pod:3236
28669 " mount-vfs options vfstype device mountpoint\n"
28675 #: ../fish/guestfish-actions.pod:3238
28677 "This is the same as the L</mount> command, but it allows you to set both the "
28678 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28683 #: ../fish/guestfish-actions.pod:3242
28684 msgid "mountpoints"
28689 #: ../fish/guestfish-actions.pod:3244
28698 #: ../fish/guestfish-actions.pod:3246
28700 "This call is similar to L</mounts>. That call returns a list of devices. "
28701 "This one returns a hash table (map) of device name to directory where the "
28702 "device is mounted."
28707 #: ../fish/guestfish-actions.pod:3250
28713 #: ../fish/guestfish-actions.pod:3252
28722 #: ../fish/guestfish-actions.pod:3259
28723 msgid "See also: L</mountpoints>"
28728 #: ../fish/guestfish-actions.pod:3261
28734 #: ../fish/guestfish-actions.pod:3263
28743 #: ../fish/guestfish-actions.pod:3268
28744 msgid "ntfs-3g-probe"
28749 #: ../fish/guestfish-actions.pod:3270
28752 " ntfs-3g-probe true|false device\n"
28758 #: ../fish/guestfish-actions.pod:3284
28764 #: ../fish/guestfish-actions.pod:3286
28767 " ntfsresize device\n"
28773 #: ../fish/guestfish-actions.pod:3292
28774 msgid "ntfsresize-size"
28779 #: ../fish/guestfish-actions.pod:3294
28782 " ntfsresize-size device size\n"
28788 #: ../fish/guestfish-actions.pod:3296
28790 "This command is the same as L</ntfsresize> except that it allows you to "
28791 "specify the new size (in bytes) explicitly."
28796 #: ../fish/guestfish-actions.pod:3299
28802 #: ../fish/guestfish-actions.pod:3301
28805 " part-add device prlogex startsect endsect\n"
28811 #: ../fish/guestfish-actions.pod:3303
28813 "This command adds a partition to C<device>. If there is no partition table "
28814 "on the device, call L</part-init> first."
28819 #: ../fish/guestfish-actions.pod:3315
28821 "Creating a partition which covers the whole disk is not so easy. Use L</"
28822 "part-disk> to do that."
28827 #: ../fish/guestfish-actions.pod:3318
28833 #: ../fish/guestfish-actions.pod:3320
28836 " part-del device partnum\n"
28842 #: ../fish/guestfish-actions.pod:3328
28848 #: ../fish/guestfish-actions.pod:3330
28851 " part-disk device parttype\n"
28857 #: ../fish/guestfish-actions.pod:3332
28859 "This command is simply a combination of L</part-init> followed by L</part-"
28860 "add> to create a single primary partition covering the whole disk."
28865 #: ../fish/guestfish-actions.pod:3336
28867 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28868 "possible values are described in L</part-init>."
28873 #: ../fish/guestfish-actions.pod:3342
28874 msgid "part-get-bootable"
28879 #: ../fish/guestfish-actions.pod:3344
28882 " part-get-bootable device partnum\n"
28888 #: ../fish/guestfish-actions.pod:3349
28889 msgid "See also L</part-set-bootable>."
28894 #: ../fish/guestfish-actions.pod:3351
28895 msgid "part-get-mbr-id"
28900 #: ../fish/guestfish-actions.pod:3353
28903 " part-get-mbr-id device partnum\n"
28909 #: ../fish/guestfish-actions.pod:3358 ../fish/guestfish-actions.pod:3496
28911 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28912 "undefined results for other partition table types (see L</part-get-"
28918 #: ../fish/guestfish-actions.pod:3362
28919 msgid "part-get-parttype"
28924 #: ../fish/guestfish-actions.pod:3364
28927 " part-get-parttype device\n"
28933 #: ../fish/guestfish-actions.pod:3369
28935 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28936 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28937 "possible, although unusual. See L</part-init> for a full list."
28942 #: ../fish/guestfish-actions.pod:3374
28948 #: ../fish/guestfish-actions.pod:3376
28951 " part-init device parttype\n"
28957 #: ../fish/guestfish-actions.pod:3382
28959 "Initially there are no partitions. Following this, you should call L</part-"
28960 "add> for each partition required."
28965 #: ../fish/guestfish-actions.pod:3445
28971 #: ../fish/guestfish-actions.pod:3447
28974 " part-list device\n"
28980 #: ../fish/guestfish-actions.pod:3462
28982 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28983 "the device's sector size, see L</blockdev-getss>."
28988 #: ../fish/guestfish-actions.pod:3475
28989 msgid "part-set-bootable"
28994 #: ../fish/guestfish-actions.pod:3477
28997 " part-set-bootable device partnum true|false\n"
29003 #: ../fish/guestfish-actions.pod:3486
29004 msgid "part-set-mbr-id"
29009 #: ../fish/guestfish-actions.pod:3488
29012 " part-set-mbr-id device partnum idbyte\n"
29018 #: ../fish/guestfish-actions.pod:3500
29019 msgid "part-set-name"
29024 #: ../fish/guestfish-actions.pod:3502
29027 " part-set-name device partnum name\n"
29033 #: ../fish/guestfish-actions.pod:3510
29034 msgid "part-to-dev"
29039 #: ../fish/guestfish-actions.pod:3512
29042 " part-to-dev partition\n"
29048 #: ../fish/guestfish-actions.pod:3518
29050 "The named partition must exist, for example as a string returned from L</"
29051 "list-partitions>."
29056 #: ../fish/guestfish-actions.pod:3521
29057 msgid "ping-daemon"
29062 #: ../fish/guestfish-actions.pod:3523
29071 #: ../fish/guestfish-actions.pod:3530
29077 #: ../fish/guestfish-actions.pod:3532
29080 " pread path count offset\n"
29086 #: ../fish/guestfish-actions.pod:3540
29087 msgid "See also L</pwrite>, L</pread-device>."
29092 #: ../fish/guestfish-actions.pod:3545
29093 msgid "pread-device"
29098 #: ../fish/guestfish-actions.pod:3547
29101 " pread-device device count offset\n"
29107 #: ../fish/guestfish-actions.pod:3555
29108 msgid "See also L</pread>."
29113 #: ../fish/guestfish-actions.pod:3560
29119 #: ../fish/guestfish-actions.pod:3562
29122 " pvcreate device\n"
29128 #: ../fish/guestfish-actions.pod:3568
29134 #: ../fish/guestfish-actions.pod:3570
29137 " pvremove device\n"
29143 #: ../fish/guestfish-actions.pod:3579
29149 #: ../fish/guestfish-actions.pod:3581
29152 " pvresize device\n"
29158 #: ../fish/guestfish-actions.pod:3586
29159 msgid "pvresize-size"
29164 #: ../fish/guestfish-actions.pod:3588
29167 " pvresize-size device size\n"
29173 #: ../fish/guestfish-actions.pod:3590
29175 "This command is the same as L</pvresize> except that it allows you to "
29176 "specify the new size (in bytes) explicitly."
29181 #: ../fish/guestfish-actions.pod:3593
29187 #: ../fish/guestfish-actions.pod:3595
29196 #: ../fish/guestfish-actions.pod:3603
29197 msgid "See also L</pvs-full>."
29202 #: ../fish/guestfish-actions.pod:3605
29208 #: ../fish/guestfish-actions.pod:3607
29217 #: ../fish/guestfish-actions.pod:3612
29223 #: ../fish/guestfish-actions.pod:3614
29232 #: ../fish/guestfish-actions.pod:3618
29238 #: ../fish/guestfish-actions.pod:3620
29241 " pwrite path content offset\n"
29247 #: ../fish/guestfish-actions.pod:3631
29248 msgid "See also L</pread>, L</pwrite-device>."
29253 #: ../fish/guestfish-actions.pod:3636
29254 msgid "pwrite-device"
29259 #: ../fish/guestfish-actions.pod:3638
29262 " pwrite-device device content offset\n"
29268 #: ../fish/guestfish-actions.pod:3648
29269 msgid "See also L</pwrite>."
29274 #: ../fish/guestfish-actions.pod:3653
29280 #: ../fish/guestfish-actions.pod:3655
29283 " read-file path\n"
29289 #: ../fish/guestfish-actions.pod:3660
29291 "Unlike L</cat>, this function can correctly handle files that contain "
29292 "embedded ASCII NUL characters. However unlike L</download>, this function "
29293 "is limited in the total size of file that can be handled."
29298 #: ../fish/guestfish-actions.pod:3668
29304 #: ../fish/guestfish-actions.pod:3670
29307 " read-lines path\n"
29313 #: ../fish/guestfish-actions.pod:3677
29315 "Note that this function cannot correctly handle binary files (specifically, "
29316 "files containing C<\\0> character which is treated as end of line). For "
29317 "those you need to use the L</read-file> function which has a more complex "
29323 #: ../fish/guestfish-actions.pod:3682
29329 #: ../fish/guestfish-actions.pod:3684
29338 #: ../fish/guestfish-actions.pod:3736
29340 "This function is primarily intended for use by programs. To get a simple "
29341 "list of names, use L</ls>. To get a printable directory for human "
29342 "consumption, use L</ll>."
29347 #: ../fish/guestfish-actions.pod:3740
29353 #: ../fish/guestfish-actions.pod:3742
29362 #: ../fish/guestfish-actions.pod:3746
29363 msgid "readlinklist"
29368 #: ../fish/guestfish-actions.pod:3748
29371 " readlinklist path 'names ...'\n"
29377 #: ../fish/guestfish-actions.pod:3772
29383 #: ../fish/guestfish-actions.pod:3774
29392 #: ../fish/guestfish-actions.pod:3779
29393 msgid "removexattr"
29398 #: ../fish/guestfish-actions.pod:3781
29401 " removexattr xattr path\n"
29407 #: ../fish/guestfish-actions.pod:3786
29408 msgid "See also: L</lremovexattr>, L<attr(5)>."
29413 #: ../fish/guestfish-actions.pod:3788
29419 #: ../fish/guestfish-actions.pod:3790
29422 " resize2fs device\n"
29428 #: ../fish/guestfish-actions.pod:3795
29430 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29431 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29432 "gives an error about this and sometimes not. In any case, it is always safe "
29433 "to call L</e2fsck-f> before calling this function."
29437 #: ../fish/guestfish-actions.pod:3801
29438 msgid "resize2fs-M"
29442 #: ../fish/guestfish-actions.pod:3803
29445 " resize2fs-M device\n"
29450 #: ../fish/guestfish-actions.pod:3805
29452 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29453 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29458 #: ../fish/guestfish-actions.pod:3809
29460 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29461 "and read the C<Block size> and C<Block count> values. These two numbers, "
29462 "multiplied together, give the resulting size of the minimal filesystem in "
29468 #: ../fish/guestfish-actions.pod:3814
29469 msgid "resize2fs-size"
29474 #: ../fish/guestfish-actions.pod:3816
29477 " resize2fs-size device size\n"
29483 #: ../fish/guestfish-actions.pod:3818
29485 "This command is the same as L</resize2fs> except that it allows you to "
29486 "specify the new size (in bytes) explicitly."
29491 #: ../fish/guestfish-actions.pod:3821
29497 #: ../fish/guestfish-actions.pod:3823
29506 #: ../fish/guestfish-actions.pod:3827
29512 #: ../fish/guestfish-actions.pod:3829
29521 #: ../fish/guestfish-actions.pod:3835
29527 #: ../fish/guestfish-actions.pod:3837
29536 #: ../fish/guestfish-actions.pod:3841
29537 msgid "rmmountpoint"
29542 #: ../fish/guestfish-actions.pod:3843
29545 " rmmountpoint exemptpath\n"
29551 #: ../fish/guestfish-actions.pod:3845
29553 "This calls removes a mountpoint that was previously created with L</"
29554 "mkmountpoint>. See L</mkmountpoint> for full details."
29559 #: ../fish/guestfish-actions.pod:3849
29560 msgid "scrub-device"
29565 #: ../fish/guestfish-actions.pod:3851
29568 " scrub-device device\n"
29574 #: ../fish/guestfish-actions.pod:3862
29580 #: ../fish/guestfish-actions.pod:3864
29583 " scrub-file file\n"
29589 #: ../fish/guestfish-actions.pod:3874
29590 msgid "scrub-freespace"
29595 #: ../fish/guestfish-actions.pod:3876
29598 " scrub-freespace dir\n"
29604 #: ../fish/guestfish-actions.pod:3878
29606 "This command creates the directory C<dir> and then fills it with files until "
29607 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29608 "deletes them. The intention is to scrub any free space on the partition "
29609 "containing C<dir>."
29614 #: ../fish/guestfish-actions.pod:3887
29620 #: ../fish/guestfish-actions.pod:3889
29626 #: ../fish/guestfish-actions.pod:3891
29629 " set-append append\n"
29634 #: ../fish/guestfish-actions.pod:3902
29635 msgid "set-attach-method"
29639 #: ../fish/guestfish-actions.pod:3904
29640 msgid "attach-method"
29644 #: ../fish/guestfish-actions.pod:3906
29647 " set-attach-method attachmethod\n"
29653 #: ../fish/guestfish-actions.pod:3928
29654 msgid "set-autosync"
29659 #: ../fish/guestfish-actions.pod:3930
29665 #: ../fish/guestfish-actions.pod:3932
29668 " set-autosync true|false\n"
29674 #: ../fish/guestfish-actions.pod:3942
29680 #: ../fish/guestfish-actions.pod:3944
29686 #: ../fish/guestfish-actions.pod:3946
29689 " set-direct true|false\n"
29695 #: ../fish/guestfish-actions.pod:3952
29697 "One consequence of this is that log messages aren't caught by the library "
29698 "and handled by L</set-log-message-callback>, but go straight to stdout."
29703 #: ../fish/guestfish-actions.pod:3961
29704 msgid "set-e2label"
29709 #: ../fish/guestfish-actions.pod:3963
29712 " set-e2label device label\n"
29718 #: ../fish/guestfish-actions.pod:3969
29720 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29721 "label on a filesystem."
29726 #: ../fish/guestfish-actions.pod:3972
29732 #: ../fish/guestfish-actions.pod:3974
29735 " set-e2uuid device uuid\n"
29741 #: ../fish/guestfish-actions.pod:3981
29743 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29744 "UUID of a filesystem."
29749 #: ../fish/guestfish-actions.pod:3984
29750 msgid "set-memsize"
29755 #: ../fish/guestfish-actions.pod:3986
29761 #: ../fish/guestfish-actions.pod:3988
29764 " set-memsize memsize\n"
29770 #: ../fish/guestfish-actions.pod:3990
29772 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29773 "This only has any effect if called before L</launch>."
29778 #: ../fish/guestfish-actions.pod:4001
29779 msgid "set-network"
29784 #: ../fish/guestfish-actions.pod:4003
29790 #: ../fish/guestfish-actions.pod:4005
29793 " set-network true|false\n"
29799 #: ../fish/guestfish-actions.pod:4013
29801 "You must call this before calling L</launch>, otherwise it has no effect."
29806 #: ../fish/guestfish-actions.pod:4016
29812 #: ../fish/guestfish-actions.pod:4018
29818 #: ../fish/guestfish-actions.pod:4020
29821 " set-path searchpath\n"
29827 #: ../fish/guestfish-actions.pod:4029
29833 #: ../fish/guestfish-actions.pod:4031
29839 #: ../fish/guestfish-actions.pod:4033
29848 #: ../fish/guestfish-actions.pod:4053
29849 msgid "set-recovery-proc"
29854 #: ../fish/guestfish-actions.pod:4055
29855 msgid "recovery-proc"
29860 #: ../fish/guestfish-actions.pod:4057
29863 " set-recovery-proc true|false\n"
29869 #: ../fish/guestfish-actions.pod:4059
29871 "If this is called with the parameter C<false> then L</launch> does not "
29872 "create a recovery process. The purpose of the recovery process is to stop "
29873 "runaway qemu processes in the case where the main program aborts abruptly."
29878 #: ../fish/guestfish-actions.pod:4064
29880 "This only has any effect if called before L</launch>, and the default is "
29886 #: ../fish/guestfish-actions.pod:4073
29887 msgid "set-selinux"
29892 #: ../fish/guestfish-actions.pod:4075
29898 #: ../fish/guestfish-actions.pod:4077
29901 " set-selinux true|false\n"
29907 #: ../fish/guestfish-actions.pod:4088
29913 #: ../fish/guestfish-actions.pod:4090
29919 #: ../fish/guestfish-actions.pod:4092
29922 " set-trace true|false\n"
29927 #: ../fish/guestfish-actions.pod:4104
29929 "Trace messages are normally sent to C<stderr>, unless you register a "
29930 "callback to send them somewhere else (see L</set-event-callback>)."
29935 #: ../fish/guestfish-actions.pod:4108
29936 msgid "set-verbose"
29941 #: ../fish/guestfish-actions.pod:4110
29947 #: ../fish/guestfish-actions.pod:4112
29950 " set-verbose true|false\n"
29955 #: ../fish/guestfish-actions.pod:4119
29957 "Verbose messages are normally sent to C<stderr>, unless you register a "
29958 "callback to send them somewhere else (see L</set-event-callback>)."
29963 #: ../fish/guestfish-actions.pod:4123
29969 #: ../fish/guestfish-actions.pod:4125
29972 " setcon context\n"
29978 #: ../fish/guestfish-actions.pod:4132
29984 #: ../fish/guestfish-actions.pod:4134
29987 " setxattr xattr val vallen path\n"
29993 #: ../fish/guestfish-actions.pod:4140
29994 msgid "See also: L</lsetxattr>, L<attr(5)>."
29999 #: ../fish/guestfish-actions.pod:4142
30005 #: ../fish/guestfish-actions.pod:4144
30008 " sfdisk device cyls heads sectors 'lines ...'\n"
30014 #: ../fish/guestfish-actions.pod:4166
30015 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30020 #: ../fish/guestfish-actions.pod:4172
30026 #: ../fish/guestfish-actions.pod:4174
30029 " sfdiskM device 'lines ...'\n"
30035 #: ../fish/guestfish-actions.pod:4176
30037 "This is a simplified interface to the L</sfdisk> command, where partition "
30038 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30039 "you don't need to specify the cyls, heads and sectors parameters which were "
30040 "rarely if ever used anyway."
30045 #: ../fish/guestfish-actions.pod:4182
30046 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30051 #: ../fish/guestfish-actions.pod:4188
30057 #: ../fish/guestfish-actions.pod:4190
30060 " sfdisk-N device partnum cyls heads sectors line\n"
30066 #: ../fish/guestfish-actions.pod:4195
30068 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30069 "cyls/heads/sectors parameters."
30074 #: ../fish/guestfish-actions.pod:4198
30075 msgid "See also: L</part-add>"
30080 #: ../fish/guestfish-actions.pod:4203
30081 msgid "sfdisk-disk-geometry"
30086 #: ../fish/guestfish-actions.pod:4205
30089 " sfdisk-disk-geometry device\n"
30095 #: ../fish/guestfish-actions.pod:4207
30097 "This displays the disk geometry of C<device> read from the partition table. "
30098 "Especially in the case where the underlying block device has been resized, "
30099 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30100 "kernel-geometry>)."
30105 #: ../fish/guestfish-actions.pod:4215
30106 msgid "sfdisk-kernel-geometry"
30111 #: ../fish/guestfish-actions.pod:4217
30114 " sfdisk-kernel-geometry device\n"
30120 #: ../fish/guestfish-actions.pod:4224
30126 #: ../fish/guestfish-actions.pod:4226
30129 " sfdisk-l device\n"
30135 #: ../fish/guestfish-actions.pod:4232
30136 msgid "See also: L</part-list>"
30141 #: ../fish/guestfish-actions.pod:4234
30147 #: ../fish/guestfish-actions.pod:4236
30156 #: ../fish/guestfish-actions.pod:4241
30157 msgid "This is like L</command>, but passes the command to:"
30162 #: ../fish/guestfish-actions.pod:4249
30163 msgid "All the provisos about L</command> apply to this call."
30168 #: ../fish/guestfish-actions.pod:4251
30174 #: ../fish/guestfish-actions.pod:4253
30177 " sh-lines command\n"
30183 #: ../fish/guestfish-actions.pod:4255
30184 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30189 #: ../fish/guestfish-actions.pod:4258
30190 msgid "See also: L</command-lines>"
30195 #: ../fish/guestfish-actions.pod:4260
30201 #: ../fish/guestfish-actions.pod:4262
30210 #: ../fish/guestfish-actions.pod:4266
30216 #: ../fish/guestfish-actions.pod:4268
30225 #: ../fish/guestfish-actions.pod:4274
30231 #: ../fish/guestfish-actions.pod:4276
30240 #: ../fish/guestfish-actions.pod:4284
30246 #: ../fish/guestfish-actions.pod:4286
30255 #: ../fish/guestfish-actions.pod:4294
30261 #: ../fish/guestfish-actions.pod:4296
30264 " strings-e encoding path\n"
30270 #: ../fish/guestfish-actions.pod:4298
30272 "This is like the L</strings> command, but allows you to specify the encoding "
30273 "of strings that are looked for in the source file C<path>."
30278 #: ../fish/guestfish-actions.pod:4308
30280 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30281 "ISO-8859-X (this is what L</strings> uses)."
30286 #: ../fish/guestfish-actions.pod:4340
30287 msgid "swapoff-device"
30292 #: ../fish/guestfish-actions.pod:4342
30295 " swapoff-device device\n"
30301 #: ../fish/guestfish-actions.pod:4344
30303 "This command disables the libguestfs appliance swap device or partition "
30304 "named C<device>. See L</swapon-device>."
30309 #: ../fish/guestfish-actions.pod:4348
30310 msgid "swapoff-file"
30315 #: ../fish/guestfish-actions.pod:4350
30318 " swapoff-file file\n"
30324 #: ../fish/guestfish-actions.pod:4354
30325 msgid "swapoff-label"
30330 #: ../fish/guestfish-actions.pod:4356
30333 " swapoff-label label\n"
30339 #: ../fish/guestfish-actions.pod:4361
30340 msgid "swapoff-uuid"
30345 #: ../fish/guestfish-actions.pod:4363
30348 " swapoff-uuid uuid\n"
30354 #: ../fish/guestfish-actions.pod:4368
30355 msgid "swapon-device"
30360 #: ../fish/guestfish-actions.pod:4370
30363 " swapon-device device\n"
30369 #: ../fish/guestfish-actions.pod:4372
30371 "This command enables the libguestfs appliance to use the swap device or "
30372 "partition named C<device>. The increased memory is made available for all "
30373 "commands, for example those run using L</command> or L</sh>."
30378 #: ../fish/guestfish-actions.pod:4384
30379 msgid "swapon-file"
30384 #: ../fish/guestfish-actions.pod:4386
30387 " swapon-file file\n"
30393 #: ../fish/guestfish-actions.pod:4388
30395 "This command enables swap to a file. See L</swapon-device> for other notes."
30400 #: ../fish/guestfish-actions.pod:4391
30401 msgid "swapon-label"
30406 #: ../fish/guestfish-actions.pod:4393
30409 " swapon-label label\n"
30415 #: ../fish/guestfish-actions.pod:4395
30417 "This command enables swap to a labeled swap partition. See L</swapon-"
30418 "device> for other notes."
30423 #: ../fish/guestfish-actions.pod:4398
30424 msgid "swapon-uuid"
30429 #: ../fish/guestfish-actions.pod:4400
30432 " swapon-uuid uuid\n"
30438 #: ../fish/guestfish-actions.pod:4402
30440 "This command enables swap to a swap partition with the given UUID. See L</"
30441 "swapon-device> for other notes."
30446 #: ../fish/guestfish-actions.pod:4405
30452 #: ../fish/guestfish-actions.pod:4407
30461 #: ../fish/guestfish-actions.pod:4415
30467 #: ../fish/guestfish-actions.pod:4417
30476 #: ../fish/guestfish-actions.pod:4425
30482 #: ../fish/guestfish-actions.pod:4427
30485 " tail-n nrlines path\n"
30491 #: ../fish/guestfish-actions.pod:4440
30497 #: ../fish/guestfish-actions.pod:4442
30500 " tar-in (tarfile|-) directory\n"
30506 #: ../fish/guestfish-actions.pod:4447
30507 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30512 #: ../fish/guestfish-actions.pod:4452
30518 #: ../fish/guestfish-actions.pod:4454
30521 " tar-out directory (tarfile|-)\n"
30527 #: ../fish/guestfish-actions.pod:4459
30528 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30533 #: ../fish/guestfish-actions.pod:4464
30539 #: ../fish/guestfish-actions.pod:4466
30542 " tgz-in (tarball|-) directory\n"
30548 #: ../fish/guestfish-actions.pod:4471
30549 msgid "To upload an uncompressed tarball, use L</tar-in>."
30554 #: ../fish/guestfish-actions.pod:4475
30560 #: ../fish/guestfish-actions.pod:4477
30563 " tgz-out directory (tarball|-)\n"
30569 #: ../fish/guestfish-actions.pod:4482
30570 msgid "To download an uncompressed tarball, use L</tar-out>."
30575 #: ../fish/guestfish-actions.pod:4486
30581 #: ../fish/guestfish-actions.pod:4488
30590 #: ../fish/guestfish-actions.pod:4497
30596 #: ../fish/guestfish-actions.pod:4499
30605 #: ../fish/guestfish-actions.pod:4504
30606 msgid "truncate-size"
30611 #: ../fish/guestfish-actions.pod:4506
30614 " truncate-size path size\n"
30620 #: ../fish/guestfish-actions.pod:4511
30622 "If the current file size is less than C<size> then the file is extended to "
30623 "the required size with zero bytes. This creates a sparse file (ie. disk "
30624 "blocks are not allocated for the file until you write to it). To create a "
30625 "non-sparse file of zeroes, use L</fallocate64> instead."
30630 #: ../fish/guestfish-actions.pod:4517
30636 #: ../fish/guestfish-actions.pod:4519
30639 " tune2fs-l device\n"
30645 #: ../fish/guestfish-actions.pod:4529
30651 #: ../fish/guestfish-actions.pod:4531
30654 " txz-in (tarball|-) directory\n"
30660 #: ../fish/guestfish-actions.pod:4538
30666 #: ../fish/guestfish-actions.pod:4540
30669 " txz-out directory (tarball|-)\n"
30675 #: ../fish/guestfish-actions.pod:4547
30681 #: ../fish/guestfish-actions.pod:4549
30690 #: ../fish/guestfish-actions.pod:4563
30691 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30696 #: ../fish/guestfish-actions.pod:4568
30702 #: ../fish/guestfish-actions.pod:4570
30708 #: ../fish/guestfish-actions.pod:4572
30711 " umount pathordevice\n"
30717 #: ../fish/guestfish-actions.pod:4578
30723 #: ../fish/guestfish-actions.pod:4580
30724 msgid "unmount-all"
30729 #: ../fish/guestfish-actions.pod:4582
30738 #: ../fish/guestfish-actions.pod:4588
30744 #: ../fish/guestfish-actions.pod:4590
30747 " upload (filename|-) remotefilename\n"
30753 #: ../fish/guestfish-actions.pod:4597
30754 msgid "See also L</download>."
30759 #: ../fish/guestfish-actions.pod:4601
30760 msgid "upload-offset"
30765 #: ../fish/guestfish-actions.pod:4603
30768 " upload-offset (filename|-) remotefilename offset\n"
30774 #: ../fish/guestfish-actions.pod:4615
30776 "Note that there is no limit on the amount of data that can be uploaded with "
30777 "this call, unlike with L</pwrite>, and this call always writes the full "
30778 "amount unless an error occurs."
30783 #: ../fish/guestfish-actions.pod:4620
30784 msgid "See also L</upload>, L</pwrite>."
30789 #: ../fish/guestfish-actions.pod:4624
30795 #: ../fish/guestfish-actions.pod:4626
30798 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30804 #: ../fish/guestfish-actions.pod:4645
30810 #: ../fish/guestfish-actions.pod:4647
30819 #: ../fish/guestfish-actions.pod:4674
30821 "I<Note:> Don't use this call to test for availability of features. In "
30822 "enterprise distributions we backport features from later versions into "
30823 "earlier versions, making this an unreliable way to test for features. Use "
30824 "L</available> instead."
30829 #: ../fish/guestfish-actions.pod:4680
30835 #: ../fish/guestfish-actions.pod:4682
30838 " vfs-label device\n"
30844 #: ../fish/guestfish-actions.pod:4689
30845 msgid "To find a filesystem from the label, use L</findfs-label>."
30850 #: ../fish/guestfish-actions.pod:4691
30856 #: ../fish/guestfish-actions.pod:4693
30859 " vfs-type device\n"
30865 #: ../fish/guestfish-actions.pod:4703
30871 #: ../fish/guestfish-actions.pod:4705
30874 " vfs-uuid device\n"
30880 #: ../fish/guestfish-actions.pod:4712
30881 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30886 #: ../fish/guestfish-actions.pod:4714
30887 msgid "vg-activate"
30892 #: ../fish/guestfish-actions.pod:4716
30895 " vg-activate true|false 'volgroups ...'\n"
30901 #: ../fish/guestfish-actions.pod:4729
30902 msgid "vg-activate-all"
30907 #: ../fish/guestfish-actions.pod:4731
30910 " vg-activate-all true|false\n"
30916 #: ../fish/guestfish-actions.pod:4741
30922 #: ../fish/guestfish-actions.pod:4743
30925 " vgcreate volgroup 'physvols ...'\n"
30931 #: ../fish/guestfish-actions.pod:4748
30937 #: ../fish/guestfish-actions.pod:4750
30940 " vglvuuids vgname\n"
30946 #: ../fish/guestfish-actions.pod:4755
30948 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30949 "logical volumes and volume groups."
30954 #: ../fish/guestfish-actions.pod:4758
30955 msgid "See also L</vgpvuuids>."
30960 #: ../fish/guestfish-actions.pod:4760
30966 #: ../fish/guestfish-actions.pod:4762
30969 " vgpvuuids vgname\n"
30975 #: ../fish/guestfish-actions.pod:4767
30977 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30978 "physical volumes and volume groups."
30983 #: ../fish/guestfish-actions.pod:4770
30984 msgid "See also L</vglvuuids>."
30989 #: ../fish/guestfish-actions.pod:4772
30995 #: ../fish/guestfish-actions.pod:4774
30998 " vgremove vgname\n"
31004 #: ../fish/guestfish-actions.pod:4781
31010 #: ../fish/guestfish-actions.pod:4783
31013 " vgrename volgroup newvolgroup\n"
31019 #: ../fish/guestfish-actions.pod:4787
31025 #: ../fish/guestfish-actions.pod:4789
31034 #: ../fish/guestfish-actions.pod:4797
31035 msgid "See also L</vgs-full>."
31040 #: ../fish/guestfish-actions.pod:4799
31046 #: ../fish/guestfish-actions.pod:4801
31055 #: ../fish/guestfish-actions.pod:4806
31061 #: ../fish/guestfish-actions.pod:4808
31070 #: ../fish/guestfish-actions.pod:4813
31076 #: ../fish/guestfish-actions.pod:4815
31085 #: ../fish/guestfish-actions.pod:4819
31091 #: ../fish/guestfish-actions.pod:4821
31100 #: ../fish/guestfish-actions.pod:4826
31106 #: ../fish/guestfish-actions.pod:4828
31115 #: ../fish/guestfish-actions.pod:4833
31121 #: ../fish/guestfish-actions.pod:4835
31130 #: ../fish/guestfish-actions.pod:4840
31136 #: ../fish/guestfish-actions.pod:4842
31139 " write path content\n"
31145 #: ../fish/guestfish-actions.pod:4850
31151 #: ../fish/guestfish-actions.pod:4852
31154 " write-file path content size\n"
31160 #: ../fish/guestfish-actions.pod:4875
31166 #: ../fish/guestfish-actions.pod:4877
31169 " zegrep regex path\n"
31175 #: ../fish/guestfish-actions.pod:4885
31181 #: ../fish/guestfish-actions.pod:4887
31184 " zegrepi regex path\n"
31190 #: ../fish/guestfish-actions.pod:4895
31196 #: ../fish/guestfish-actions.pod:4897
31205 #: ../fish/guestfish-actions.pod:4905
31206 msgid "See also: L</zero-device>, L</scrub-device>."
31211 #: ../fish/guestfish-actions.pod:4907
31212 msgid "zero-device"
31217 #: ../fish/guestfish-actions.pod:4909
31220 " zero-device device\n"
31226 #: ../fish/guestfish-actions.pod:4911
31228 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31229 "which just zeroes the first few blocks of a device."
31234 #: ../fish/guestfish-actions.pod:4918
31240 #: ../fish/guestfish-actions.pod:4920
31243 " zerofree device\n"
31249 #: ../fish/guestfish-actions.pod:4933
31255 #: ../fish/guestfish-actions.pod:4935
31258 " zfgrep pattern path\n"
31264 #: ../fish/guestfish-actions.pod:4943
31270 #: ../fish/guestfish-actions.pod:4945
31273 " zfgrepi pattern path\n"
31279 #: ../fish/guestfish-actions.pod:4953
31285 #: ../fish/guestfish-actions.pod:4955
31288 " zfile meth path\n"
31294 #: ../fish/guestfish-actions.pod:4962
31296 "Since 1.0.63, use L</file> instead which can now process compressed files."
31301 #: ../fish/guestfish-actions.pod:4972
31307 #: ../fish/guestfish-actions.pod:4974
31310 " zgrep regex path\n"
31316 #: ../fish/guestfish-actions.pod:4982
31322 #: ../fish/guestfish-actions.pod:4984
31325 " zgrepi regex path\n"
31331 #: ../fish/guestfish-commands.pod:1
31337 #: ../fish/guestfish-commands.pod:3
31343 #: ../fish/guestfish-commands.pod:5
31346 " alloc filename size\n"
31352 #: ../fish/guestfish-commands.pod:7
31354 "This creates an empty (zeroed) file of the given size, and then adds so it "
31355 "can be further examined."
31360 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31361 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31366 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31367 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31372 #: ../fish/guestfish-commands.pod:14
31374 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31375 "image, see L</PREPARED DISK IMAGES>."
31380 #: ../fish/guestfish-commands.pod:17
31386 #: ../fish/guestfish-commands.pod:19
31389 " copy-in local [local ...] /remotedir\n"
31395 #: ../fish/guestfish-commands.pod:21
31397 "C<copy-in> copies local files or directories recursively into the disk "
31398 "image, placing them in the directory called C</remotedir> (which must "
31399 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31400 "other commands as necessary."
31405 #: ../fish/guestfish-commands.pod:26
31407 "Multiple local files and directories can be specified, but the last "
31408 "parameter must always be a remote directory. Wildcards cannot be used."
31413 #: ../fish/guestfish-commands.pod:30
31419 #: ../fish/guestfish-commands.pod:32
31422 " copy-out remote [remote ...] localdir\n"
31428 #: ../fish/guestfish-commands.pod:34
31430 "C<copy-out> copies remote files or directories recursively out of the disk "
31431 "image, placing them on the host disk in a local directory called C<localdir> "
31432 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31433 "download>, L</tar-out> and other commands as necessary."
31438 #: ../fish/guestfish-commands.pod:40
31440 "Multiple remote files and directories can be specified, but the last "
31441 "parameter must always be a local directory. To download to the current "
31442 "directory, use C<.> as in:"
31447 #: ../fish/guestfish-commands.pod:44
31450 " copy-out /home .\n"
31456 #: ../fish/guestfish-commands.pod:46
31458 "Wildcards cannot be used in the ordinary command, but you can use them with "
31459 "the help of L</glob> like this:"
31464 #: ../fish/guestfish-commands.pod:49
31467 " glob copy-out /home/* .\n"
31473 #: ../fish/guestfish-commands.pod:51
31479 #: ../fish/guestfish-commands.pod:53
31482 " echo [params ...]\n"
31488 #: ../fish/guestfish-commands.pod:55
31489 msgid "This echos the parameters to the terminal."
31494 #: ../fish/guestfish-commands.pod:57
31500 #: ../fish/guestfish-commands.pod:59
31506 #: ../fish/guestfish-commands.pod:61
31512 #: ../fish/guestfish-commands.pod:63
31521 #: ../fish/guestfish-commands.pod:65
31523 "This is used to edit a file. It downloads the file, edits it locally using "
31524 "your editor, then uploads the result."
31529 #: ../fish/guestfish-commands.pod:68
31531 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31532 "or C<emacs> you will get those corresponding editors."
31537 #: ../fish/guestfish-commands.pod:72
31543 #: ../fish/guestfish-commands.pod:74
31546 " glob command args...\n"
31552 #: ../fish/guestfish-commands.pod:76
31554 "Expand wildcards in any paths in the args list, and run C<command> "
31555 "repeatedly on each matching path."
31560 #: ../fish/guestfish-commands.pod:79
31561 msgid "See L</WILDCARDS AND GLOBBING>."
31566 #: ../fish/guestfish-commands.pod:81
31572 #: ../fish/guestfish-commands.pod:83
31575 " hexedit <filename|device>\n"
31576 " hexedit <filename|device> <max>\n"
31577 " hexedit <filename|device> <start> <max>\n"
31583 #: ../fish/guestfish-commands.pod:87
31585 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31591 #: ../fish/guestfish-commands.pod:90
31593 "This command works by downloading potentially the whole file or device, "
31594 "editing it locally, then uploading it. If the file or device is large, you "
31595 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31596 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31597 "usual modifiers allowed such as C<1M> (1 megabyte)."
31602 #: ../fish/guestfish-commands.pod:97
31603 msgid "For example to edit the first few sectors of a disk you might do:"
31608 #: ../fish/guestfish-commands.pod:100
31611 " hexedit /dev/sda 1M\n"
31617 #: ../fish/guestfish-commands.pod:102
31619 "which would allow you to edit anywhere within the first megabyte of the disk."
31624 #: ../fish/guestfish-commands.pod:105
31625 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31630 #: ../fish/guestfish-commands.pod:107
31633 " hexedit /dev/sda1 0x400 0x400\n"
31639 #: ../fish/guestfish-commands.pod:109
31640 msgid "(assuming the superblock is in the standard location)."
31645 #: ../fish/guestfish-commands.pod:111
31647 "This command requires the external L<hexedit(1)> program. You can specify "
31648 "another program to use by setting the C<HEXEDITOR> environment variable."
31653 #: ../fish/guestfish-commands.pod:115
31654 msgid "See also L</hexdump>."
31659 #: ../fish/guestfish-commands.pod:117
31665 #: ../fish/guestfish-commands.pod:119
31674 #: ../fish/guestfish-commands.pod:121
31676 "Change the local directory, ie. the current directory of guestfish itself."
31681 #: ../fish/guestfish-commands.pod:124
31682 msgid "Note that C<!cd> won't do what you might expect."
31687 #: ../fish/guestfish-commands.pod:126
31693 #: ../fish/guestfish-commands.pod:128
31699 #: ../fish/guestfish-commands.pod:130
31708 #: ../fish/guestfish-commands.pod:132
31709 msgid "Opens the manual page for guestfish."
31714 #: ../fish/guestfish-commands.pod:134
31720 #: ../fish/guestfish-commands.pod:136
31726 #: ../fish/guestfish-commands.pod:138
31735 #: ../fish/guestfish-commands.pod:140
31744 #: ../fish/guestfish-commands.pod:142
31745 msgid "This is used to view a file."
31750 #: ../fish/guestfish-commands.pod:144
31752 "The default viewer is C<$PAGER>. However if you use the alternate command "
31753 "C<less> you will get the C<less> command specifically."
31758 #: ../fish/guestfish-commands.pod:147
31764 #: ../fish/guestfish-commands.pod:149
31773 #: ../fish/guestfish-commands.pod:151
31775 "Close and reopen the libguestfs handle. It is not necessary to use this "
31776 "normally, because the handle is closed properly when guestfish exits. "
31777 "However this is occasionally useful for testing."
31782 #: ../fish/guestfish-commands.pod:155
31788 #: ../fish/guestfish-commands.pod:157
31791 " sparse filename size\n"
31797 #: ../fish/guestfish-commands.pod:159
31799 "This creates an empty sparse file of the given size, and then adds so it can "
31800 "be further examined."
31805 #: ../fish/guestfish-commands.pod:162
31807 "In all respects it works the same as the L</alloc> command, except that the "
31808 "image file is allocated sparsely, which means that disk blocks are not "
31809 "assigned to the file until they are needed. Sparse disk files only use "
31810 "space when written to, but they are slower and there is a danger you could "
31811 "run out of real disk space during a write operation."
31816 #: ../fish/guestfish-commands.pod:172
31822 #: ../fish/guestfish-commands.pod:174
31831 #: ../fish/guestfish-commands.pod:176
31833 "This command returns a list of the optional groups known to the daemon, and "
31834 "indicates which ones are supported by this build of the libguestfs appliance."
31839 #: ../fish/guestfish-commands.pod:180
31840 msgid "See also L<guestfs(3)/AVAILABILITY>."
31845 #: ../fish/guestfish-commands.pod:182
31851 #: ../fish/guestfish-commands.pod:184
31854 " time command args...\n"
31860 #: ../fish/guestfish-commands.pod:186
31862 "Run the command as usual, but print the elapsed time afterwards. This can "
31863 "be useful for benchmarking operations."
31868 #: ../test-tool/libguestfs-test-tool.pod:5
31869 msgid "libguestfs-test-tool - End user tests for libguestfs"
31874 #: ../test-tool/libguestfs-test-tool.pod:9
31877 " libguestfs-test-tool [--options]\n"
31883 #: ../test-tool/libguestfs-test-tool.pod:13
31885 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31886 "and developers, to allow them to check basic libguestfs functionality is "
31887 "working. This is needed because libguestfs occasionally breaks for reasons "
31888 "beyond our control: usually because of changes in the underlying qemu or "
31889 "kernel packages, or the host environment."
31894 #: ../test-tool/libguestfs-test-tool.pod:20
31895 msgid "If you suspect a problem in libguestfs, then just run:"
31900 #: ../test-tool/libguestfs-test-tool.pod:22
31903 " libguestfs-test-tool\n"
31909 #: ../test-tool/libguestfs-test-tool.pod:24
31910 msgid "It will print lots of diagnostic messages."
31915 #: ../test-tool/libguestfs-test-tool.pod:26
31916 msgid "If it runs to completion successfully, you will see this near the end:"
31921 #: ../test-tool/libguestfs-test-tool.pod:28
31924 " ===== TEST FINISHED OK =====\n"
31930 #: ../test-tool/libguestfs-test-tool.pod:30
31931 msgid "and the test tool will exit with code 0."
31936 #: ../test-tool/libguestfs-test-tool.pod:32
31938 "If it fails (and/or exits with non-zero error code), please paste the "
31939 "B<complete, unedited> output of the test tool into a bug report. More "
31940 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31946 #: ../test-tool/libguestfs-test-tool.pod:41
31952 #: ../test-tool/libguestfs-test-tool.pod:43
31953 msgid "Display short usage information and exit."
31958 #: ../test-tool/libguestfs-test-tool.pod:45
31959 msgid "I<--qemu qemu_binary>"
31964 #: ../test-tool/libguestfs-test-tool.pod:47
31966 "If you have downloaded another qemu binary, point this option at the full "
31967 "path of the binary to try it."
31972 #: ../test-tool/libguestfs-test-tool.pod:50
31973 msgid "I<--qemudir qemu_source_dir>"
31978 #: ../test-tool/libguestfs-test-tool.pod:52
31980 "If you have compiled qemu from source, point this option at the source "
31981 "directory to try it."
31986 #: ../test-tool/libguestfs-test-tool.pod:55
31987 msgid "I<--timeout N>"
31992 #: ../test-tool/libguestfs-test-tool.pod:57
31994 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31995 "does not usually need to be adjusted unless your machine is very slow."
32000 #: ../test-tool/libguestfs-test-tool.pod:63
32001 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
32006 #: ../test-tool/libguestfs-test-tool.pod:65
32008 "If you have compiled another version of qemu from source and would like to "
32009 "try that, then you can use the I<--qemudir> option to point to the qemu "
32010 "source directory."
32015 #: ../test-tool/libguestfs-test-tool.pod:69
32017 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32018 "option to point to the binary."
32023 #: ../test-tool/libguestfs-test-tool.pod:72
32025 "When using an alternate qemu with libguestfs, usually you would need to "
32026 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32027 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32028 "use either of the I<--qemudir> or I<--qemu> options."
32033 #: ../test-tool/libguestfs-test-tool.pod:79
32035 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32036 "I<1> if there was an error."
32041 #: ../test-tool/libguestfs-test-tool.pod:84
32043 "For the full list of environment variables which may affect libguestfs, "
32044 "please see the L<guestfs(3)> manual page."
32049 #: ../test-tool/libguestfs-test-tool.pod:89
32050 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32055 #: ../fuse/guestmount.pod:5
32057 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32062 #: ../fuse/guestmount.pod:9
32065 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32071 #: ../fuse/guestmount.pod:11
32074 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32080 #: ../fuse/guestmount.pod:13
32083 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32089 #: ../fuse/guestmount.pod:17
32091 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32092 "machines. If you do this, you risk disk corruption in the VM."
32097 #: ../fuse/guestmount.pod:22
32099 "The guestmount program can be used to mount virtual machine filesystems and "
32100 "other disk images on the host. It uses libguestfs for access to the guest "
32101 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32102 "a mountable device."
32107 #: ../fuse/guestmount.pod:27
32109 "Along with other options, you have to give at least one device (I<-a> "
32110 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32111 "option) or use the I<-i> inspection option. How this works is better "
32112 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32118 #: ../fuse/guestmount.pod:33
32120 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32121 "by you, and the filesystem will not be visible to any other users unless you "
32122 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32123 "the filesystem, use the C<fusermount -u> command."
32128 #: ../fuse/guestmount.pod:41
32130 "For a typical Windows guest which has its main filesystem on the first "
32136 #: ../fuse/guestmount.pod:44
32139 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32145 #: ../fuse/guestmount.pod:46
32147 "For a typical Linux guest which has a /boot filesystem on the first "
32148 "partition, and the root filesystem on a logical volume:"
32153 #: ../fuse/guestmount.pod:49
32156 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32162 #: ../fuse/guestmount.pod:51
32163 msgid "To get libguestfs to detect guest mountpoints for you:"
32168 #: ../fuse/guestmount.pod:53
32171 " guestmount -a guest.img -i --ro /mnt\n"
32177 #: ../fuse/guestmount.pod:55
32178 msgid "For a libvirt guest called \"Guest\" you could do:"
32183 #: ../fuse/guestmount.pod:57
32186 " guestmount -d Guest -i --ro /mnt\n"
32192 #: ../fuse/guestmount.pod:59
32194 "If you don't know what filesystems are contained in a guest or disk image, "
32195 "use L<virt-filesystems(1)> first:"
32200 #: ../fuse/guestmount.pod:62
32203 " virt-filesystems MyGuest\n"
32209 #: ../fuse/guestmount.pod:64
32211 "If you want to trace the libguestfs calls but without excessive debugging "
32212 "information, we recommend:"
32217 #: ../fuse/guestmount.pod:67
32220 " guestmount [...] --trace /mnt\n"
32226 #: ../fuse/guestmount.pod:69
32227 msgid "If you want to debug the program, we recommend:"
32232 #: ../fuse/guestmount.pod:71
32235 " guestmount [...] --trace --verbose /mnt\n"
32241 #: ../fuse/guestmount.pod:77
32242 msgid "B<-a image> | B<--add image>"
32247 #: ../fuse/guestmount.pod:79
32248 msgid "Add a block device or virtual machine image."
32253 #: ../fuse/guestmount.pod:84
32254 msgid "B<-c URI> | B<--connect URI>"
32259 #: ../fuse/guestmount.pod:90
32260 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32265 #: ../fuse/guestmount.pod:98
32266 msgid "B<--dir-cache-timeout N>"
32271 #: ../fuse/guestmount.pod:100
32273 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32274 "seconds. The readdir cache [actually, there are several semi-independent "
32275 "caches] is populated after a readdir(2) call with the stat and extended "
32276 "attributes of the files in the directory, in anticipation that they will be "
32277 "requested soon after."
32282 #: ../fuse/guestmount.pod:106
32284 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32285 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32286 "requests, only cache existing ones."
32291 #: ../fuse/guestmount.pod:117
32292 msgid "B<--format=raw|qcow2|..> | B<--format>"
32297 #: ../fuse/guestmount.pod:124
32299 "If you have untrusted raw-format guest disk images, you should use this "
32300 "option to specify the disk format. This avoids a possible security problem "
32301 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32302 "guestfs_add_drive_opts>."
32307 #: ../fuse/guestmount.pod:129
32308 msgid "B<--fuse-help>"
32313 #: ../fuse/guestmount.pod:131
32314 msgid "Display help on special FUSE options (see I<-o> below)."
32319 #: ../fuse/guestmount.pod:135
32320 msgid "Display brief help and exit."
32325 #: ../fuse/guestmount.pod:137
32326 msgid "B<-i> | B<--inspector>"
32331 #: ../fuse/guestmount.pod:157
32333 "Mount the named partition or logical volume on the given mountpoint B<in the "
32334 "guest> (this has nothing to do with mountpoints in the host)."
32339 #: ../fuse/guestmount.pod:160
32341 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32342 "something on C</>."
32347 #: ../fuse/guestmount.pod:173
32348 msgid "B<-n> | B<--no-sync>"
32353 #: ../fuse/guestmount.pod:175
32355 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32356 "unmounted. If you specify this option, then we don't attempt to sync the "
32357 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32362 #: ../fuse/guestmount.pod:180
32363 msgid "B<-o option> | B<--option option>"
32368 #: ../fuse/guestmount.pod:182
32369 msgid "Pass extra options to FUSE."
32374 #: ../fuse/guestmount.pod:184
32376 "To get a list of all the extra options supported by FUSE, use the command "
32377 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32378 "of them are a good idea."
32383 #: ../fuse/guestmount.pod:188
32386 " guestmount --fuse-help\n"
32392 #: ../fuse/guestmount.pod:190
32393 msgid "Some potentially useful FUSE options:"
32398 #: ../fuse/guestmount.pod:194
32399 msgid "B<-o allow_other>"
32404 #: ../fuse/guestmount.pod:196
32405 msgid "Allow other users to see the filesystem."
32410 #: ../fuse/guestmount.pod:198
32411 msgid "B<-o attr_timeout=N>"
32416 #: ../fuse/guestmount.pod:200
32417 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32422 #: ../fuse/guestmount.pod:202
32423 msgid "B<-o kernel_cache>"
32428 #: ../fuse/guestmount.pod:204
32430 "Allow the kernel to cache files (reduces the number of reads that have to go "
32431 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32432 "afford the extra memory usage."
32437 #: ../fuse/guestmount.pod:208
32438 msgid "B<-o uid=N> B<-o gid=N>"
32443 #: ../fuse/guestmount.pod:210
32445 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32446 "the chosen values."
32451 #: ../fuse/guestmount.pod:215
32452 msgid "B<-r> | B<--ro>"
32457 #: ../fuse/guestmount.pod:217
32459 "Add devices and mount everything read-only. Also disallow writes and make "
32460 "the disk appear read-only to FUSE."
32465 #: ../fuse/guestmount.pod:220
32467 "This is highly recommended if you are not going to edit the guest disk. If "
32468 "the guest is running and this option is I<not> supplied, then there is a "
32469 "strong risk of disk corruption in the guest. We try to prevent this from "
32470 "happening, but it is not always possible."
32475 #: ../fuse/guestmount.pod:225
32476 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32481 #: ../fuse/guestmount.pod:229
32482 msgid "Enable SELinux support for the guest."
32487 #: ../fuse/guestmount.pod:231
32488 msgid "B<-v> | B<--verbose>"
32493 #: ../fuse/guestmount.pod:233
32494 msgid "Enable verbose messages from underlying libguestfs."
32499 #: ../fuse/guestmount.pod:235
32500 msgid "B<-V> | B<--version>"
32505 #: ../fuse/guestmount.pod:237
32506 msgid "Display the program version and exit."
32511 #: ../fuse/guestmount.pod:239
32512 msgid "B<-w> | B<--rw>"
32516 #: ../fuse/guestmount.pod:244 ../fuse/guestmount.pod:265
32517 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32522 #: ../fuse/guestmount.pod:246
32523 msgid "B<-x> | B<--trace>"
32528 #: ../fuse/guestmount.pod:248
32529 msgid "Trace libguestfs calls and entry into each FUSE function."
32534 #: ../fuse/guestmount.pod:250
32535 msgid "This also stops the daemon from forking into the background."
32540 #: ../fuse/guestmount.pod:271
32542 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32543 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32549 #: ../fuse/guestmount.pod:286
32550 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32555 #: ../tools/virt-edit.pl:34
32556 msgid "virt-edit - Edit a file in a virtual machine"
32561 #: ../tools/virt-edit.pl:38
32564 " virt-edit [--options] domname file\n"
32570 #: ../tools/virt-edit.pl:40
32573 " virt-edit [--options] disk.img [disk.img ...] file\n"
32579 #: ../tools/virt-edit.pl:42
32582 " virt-edit [domname|disk.img] file -e 'expr'\n"
32588 #: ../tools/virt-edit.pl:46
32590 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32591 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32592 "doing this, but doesn't catch all cases."
32597 #: ../tools/virt-edit.pl:52
32599 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32600 "the named virtual machine (or disk image)."
32604 #: ../tools/virt-edit.pl:55
32605 msgid "If you want to just view a file, use L<virt-cat(1)>."
32609 #: ../tools/virt-edit.pl:57
32611 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32612 "USING GUESTFISH> below)."
32616 #: ../tools/virt-edit.pl:60
32618 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32619 "files. L<guestfish(1)> can do that and much more."
32624 #: ../tools/virt-edit.pl:65
32625 msgid "Edit the named files interactively:"
32630 #: ../tools/virt-edit.pl:67
32633 " virt-edit mydomain /boot/grub/grub.conf\n"
32639 #: ../tools/virt-edit.pl:69
32642 " virt-edit mydomain /etc/passwd\n"
32647 #: ../tools/virt-edit.pl:71
32648 msgid "For Windows guests, some Windows paths are understood:"
32652 #: ../tools/virt-edit.pl:73
32655 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32661 #: ../tools/virt-edit.pl:75
32663 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32664 "below). To change the init default level to 5:"
32669 #: ../tools/virt-edit.pl:79
32672 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32678 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32679 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32680 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32681 msgid "Display brief help."
32686 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32687 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32688 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32689 msgid "Display version number and exit."
32694 #: ../tools/virt-edit.pl:105
32695 msgid "B<--backup extension> | B<-b extension>"
32700 #: ../tools/virt-edit.pl:107
32702 "Create a backup of the original file I<in the guest disk image>. The backup "
32703 "has the original filename with C<extension> added."
32708 #: ../tools/virt-edit.pl:110
32710 "Usually the first character of C<extension> would be a dot C<.> so you would "
32716 #: ../tools/virt-edit.pl:113
32719 " virt-edit -b .orig [etc]\n"
32725 #: ../tools/virt-edit.pl:115
32726 msgid "By default, no backup file is made."
32731 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32732 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32733 #: ../tools/virt-list-partitions.pl:78
32734 msgid "B<--connect URI> | B<-c URI>"
32739 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32740 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32741 #: ../tools/virt-list-partitions.pl:80
32743 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32744 "to the default libvirt hypervisor."
32749 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32750 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32751 #: ../tools/virt-list-partitions.pl:83
32753 "If you specify guest block devices directly, then libvirt is not used at all."
32758 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32759 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32760 #: ../tools/virt-list-partitions.pl:90
32761 msgid "B<--format> raw"
32766 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32767 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32768 #: ../tools/virt-list-partitions.pl:92
32770 "Specify the format of disk images given on the command line. If this is "
32771 "omitted then the format is autodetected from the content of the disk image."
32776 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32777 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32778 #: ../tools/virt-list-partitions.pl:96
32780 "If disk images are requested from libvirt, then this program asks libvirt "
32781 "for this information. In this case, the value of the format parameter is "
32787 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32788 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32789 #: ../tools/virt-list-partitions.pl:100
32791 "If working with untrusted raw-format guest disk images, you should ensure "
32792 "the format is always specified."
32797 #: ../tools/virt-edit.pl:150
32798 msgid "B<--expr EXPR> | B<-e EXPR>"
32803 #: ../tools/virt-edit.pl:152
32805 "Instead of launching the external editor, non-interactively apply the Perl "
32806 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32812 #: ../tools/virt-edit.pl:156
32814 "Be careful to properly quote the expression to prevent it from being altered "
32820 #: ../tools/virt-edit.pl:280
32821 msgid "NON-INTERACTIVE EDITING"
32826 #: ../tools/virt-edit.pl:282
32828 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32829 "administrator can interactively edit the file."
32834 #: ../tools/virt-edit.pl:285
32836 "There are two ways also to use C<virt-edit> from scripts in order to make "
32837 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32838 "like this, it's less error-prone to write scripts directly using the "
32839 "libguestfs API and Augeas for configuration file editing.)"
32844 #: ../tools/virt-edit.pl:291
32846 "The first method is to temporarily set C<$EDITOR> to any script or program "
32847 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32848 "update C<tmpfile> in place however it likes."
32852 #: ../tools/virt-edit.pl:295
32854 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
32855 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32856 "instances of C<foo> with C<bar> in a file:"
32861 #: ../tools/virt-edit.pl:299
32864 " virt-edit domname filename -e 's/foo/bar/'\n"
32870 #: ../tools/virt-edit.pl:301
32872 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32873 "For example to delete root's password you could do:"
32878 #: ../tools/virt-edit.pl:304
32881 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32887 #: ../tools/virt-edit.pl:306
32889 "What really happens is that the snippet is evaluated as a Perl expression "
32890 "for each line of the file. The line, including the final C<\\n>, is passed "
32891 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32896 #: ../tools/virt-edit.pl:311
32898 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32899 "C<apache> user account from the password file you can do:"
32904 #: ../tools/virt-edit.pl:314
32907 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32913 #: ../tools/virt-edit.pl:316
32915 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32916 "the end of the file is rather difficult this way since there is no concept "
32917 "of \"last line of the file\" - your expression just doesn't get called "
32918 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32924 #: ../tools/virt-edit.pl:322
32926 "The variable C<$lineno> contains the current line number. As is "
32927 "traditional, the first line in the file is number C<1>."
32932 #: ../tools/virt-edit.pl:325
32934 "The return value from the expression is ignored, but the expression may call "
32935 "C<die> in order to abort the whole program, leaving the original file "
32941 #: ../tools/virt-edit.pl:329
32943 "Remember when matching the end of a line that C<$_> may contain the final C<"
32944 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32945 "newline then neither of these. Thus to match or substitute some text at the "
32946 "end of a line, use this regular expression:"
32951 #: ../tools/virt-edit.pl:334
32954 " /some text(\\r?\\n)?$/\n"
32960 #: ../tools/virt-edit.pl:336
32962 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32963 "$_> itself (since that would remove all newlines from the file):"
32968 #: ../tools/virt-edit.pl:340
32971 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32976 #: ../tools/virt-edit.pl:344
32978 "C<virt-edit> has a limited ability to understand Windows drive letters and "
32979 "paths (eg. C<E:\\foo\\bar.txt>)."
32983 #: ../tools/virt-edit.pl:347
32984 msgid "If and only if the guest is running Windows then:"
32988 #: ../tools/virt-edit.pl:353
32990 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
32991 "to the correct filesystem."
32995 #: ../tools/virt-edit.pl:358
32997 "Any backslash (C<\\>) characters in the path are replaced with forward "
32998 "slashes so that libguestfs can process it."
33002 #: ../tools/virt-edit.pl:363
33004 "The path is resolved case insensitively to locate the file that should be "
33009 #: ../tools/virt-edit.pl:368
33010 msgid "There are some known shortcomings:"
33014 #: ../tools/virt-edit.pl:374
33015 msgid "Some NTFS symbolic links may not be followed correctly."
33019 #: ../tools/virt-edit.pl:378
33020 msgid "NTFS junction points that cross filesystems are not followed."
33024 #: ../tools/virt-edit.pl:435
33025 msgid "USING GUESTFISH"
33029 #: ../tools/virt-edit.pl:437
33031 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
33032 "C<virt-edit> doesn't work."
33036 #: ../tools/virt-edit.pl:440
33037 msgid "Using C<virt-edit> is approximately equivalent to doing:"
33041 #: ../tools/virt-edit.pl:442
33044 " guestfish --rw -i -d domname edit /file\n"
33049 #: ../tools/virt-edit.pl:444
33051 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
33052 "path to the file."
33056 #: ../tools/virt-edit.pl:447
33058 "The command above uses libguestfs's guest inspection feature and so does not "
33059 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
33060 "disk images that don't contain guests. To edit a file on a disk image "
33065 #: ../tools/virt-edit.pl:452
33068 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
33073 #: ../tools/virt-edit.pl:454
33075 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
33076 "the disk image to edit, and C</file> is the full path to the file."
33080 #: ../tools/virt-edit.pl:458
33082 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
33083 "C<write> or C<upload> instead:"
33087 #: ../tools/virt-edit.pl:461
33090 " guestfish --rw -i -d domname touch /newfile\n"
33095 #: ../tools/virt-edit.pl:463
33098 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
33103 #: ../tools/virt-edit.pl:465
33106 " guestfish --rw -i -d domname upload localfile /newfile\n"
33111 #: ../tools/virt-edit.pl:467
33113 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
33117 #: ../tools/virt-edit.pl:470
33120 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
33126 #: ../tools/virt-edit.pl:480
33132 #: ../tools/virt-edit.pl:482
33134 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33140 #: ../tools/virt-edit.pl:485
33141 msgid "If not set, C<vi> is used."
33146 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33147 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
33148 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
33149 msgid "SHELL QUOTING"
33154 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33155 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
33156 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
33158 "Libvirt guest names can contain arbitrary characters, some of which have "
33159 "meaning to the shell such as C<#> and space. You may need to quote or "
33160 "escape these characters on the command line. See the shell manual page L<sh"
33161 "(1)> for details."
33165 #: ../tools/virt-edit.pl:498
33167 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33168 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33169 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33174 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33175 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33176 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33182 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33183 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33184 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33185 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33189 #: ../tools/virt-edit.pl:516
33190 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33195 #: ../tools/virt-win-reg.pl:37
33197 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33202 #: ../tools/virt-win-reg.pl:41
33205 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33211 #: ../tools/virt-win-reg.pl:43
33214 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33220 #: ../tools/virt-win-reg.pl:45
33223 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33229 #: ../tools/virt-win-reg.pl:47
33232 " virt-win-reg --merge domname [input.reg ...]\n"
33238 #: ../tools/virt-win-reg.pl:49
33241 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33246 #: ../tools/virt-win-reg.pl:53
33248 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33249 "virtual machines. If you do this, you I<will> get irreversible disk "
33250 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33251 "but doesn't catch all cases."
33255 #: ../tools/virt-win-reg.pl:58
33257 "Modifying the Windows Registry is an inherently risky operation. The format "
33258 "is deliberately obscure and undocumented, and Registry changes can leave the "
33259 "system unbootable. Therefore when using the I<--merge> option, make sure "
33260 "you have a reliable backup first."
33265 #: ../tools/virt-win-reg.pl:65
33267 "This program can export and merge Windows Registry entries from a Windows "
33273 #: ../tools/virt-win-reg.pl:68
33275 "The first parameter is the libvirt guest name or the raw disk image of a "
33280 #: ../tools/virt-win-reg.pl:71
33282 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33283 "exported (recursively). For example:"
33288 #: ../tools/virt-win-reg.pl:74
33291 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33297 #: ../tools/virt-win-reg.pl:76
33299 "You can also display single values from within registry keys, for example:"
33304 #: ../tools/virt-win-reg.pl:79
33307 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33308 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33309 " Windows 7 Enterprise\n"
33314 #: ../tools/virt-win-reg.pl:83
33316 "With I<--merge>, you can merge a textual regedit file into the Windows "
33322 #: ../tools/virt-win-reg.pl:86
33325 " $ virt-win-reg --merge Windows7 changes.reg\n"
33331 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33337 #: ../tools/virt-win-reg.pl:90
33339 "This program is only meant for simple access to the registry. If you want "
33340 "to do complicated things with the registry, we suggest you download the "
33341 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33342 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33343 "L<hivexregedit(1)>."
33348 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33354 #: ../tools/virt-win-reg.pl:122
33355 msgid "Enable debugging messages."
33360 #: ../tools/virt-win-reg.pl:157
33366 #: ../tools/virt-win-reg.pl:159
33368 "In merge mode, this merges a textual regedit file into the Windows Registry "
33369 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33370 "displays or exports Registry entries instead."
33374 #: ../tools/virt-win-reg.pl:163
33376 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33377 "result in disk corruption. However exporting (without this flag) is always "
33383 #: ../tools/virt-win-reg.pl:171
33384 msgid "B<--encoding> UTF-16LE|ASCII"
33389 #: ../tools/virt-win-reg.pl:173
33391 "When merging (only), you may need to specify the encoding for strings to be "
33392 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33393 "(3)/ENCODING STRINGS>."
33398 #: ../tools/virt-win-reg.pl:177
33400 "The default is to use UTF-16LE, which should work with recent versions of "
33406 #: ../tools/virt-win-reg.pl:402
33407 msgid "SUPPORTED SYSTEMS"
33412 #: ../tools/virt-win-reg.pl:404
33414 "The program currently supports Windows NT-derived guests starting with "
33415 "Windows XP through to at least Windows 7."
33420 #: ../tools/virt-win-reg.pl:407
33422 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33423 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33424 "and C<HKEY_USERS\\.DEFAULT>."
33429 #: ../tools/virt-win-reg.pl:411
33431 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33437 #: ../tools/virt-win-reg.pl:414
33439 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33445 #: ../tools/virt-win-reg.pl:417
33451 #: ../tools/virt-win-reg.pl:419
33453 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33454 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33455 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33456 "Windows-style line endings, you may need to reencode the whole file before "
33457 "or after processing."
33461 #: ../tools/virt-win-reg.pl:425
33463 "To reencode a file from Windows format to Linux (before processing it with "
33464 "the I<--merge> option), you would do something like this:"
33469 #: ../tools/virt-win-reg.pl:428
33472 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33478 #: ../tools/virt-win-reg.pl:430
33480 "To go in the opposite direction, after exporting and before sending the file "
33481 "to a Windows user, do something like this:"
33486 #: ../tools/virt-win-reg.pl:433
33489 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33495 #: ../tools/virt-win-reg.pl:435
33496 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33501 #: ../tools/virt-win-reg.pl:437
33503 "If you are unsure about the current encoding, use the L<file(1)> command. "
33504 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33505 "style (CRLF) line endings, like this:"
33510 #: ../tools/virt-win-reg.pl:441
33513 " $ file software.reg\n"
33514 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33515 " with CRLF line terminators\n"
33520 #: ../tools/virt-win-reg.pl:445
33521 msgid "This file would need conversion before you could I<--merge> it."
33526 #: ../tools/virt-win-reg.pl:447
33527 msgid "CurrentControlSet etc."
33532 #: ../tools/virt-win-reg.pl:449
33534 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33535 "Registry at the level of the hive file, and therefore you cannot modify "
33541 #: ../tools/virt-win-reg.pl:453
33543 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33544 "circumstances it might refer to another control set. The way to find out is "
33545 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33550 #: ../tools/virt-win-reg.pl:457
33553 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33554 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33555 " \"Current\"=dword:00000001\n"
33556 " \"Default\"=dword:00000001\n"
33557 " \"Failed\"=dword:00000000\n"
33558 " \"LastKnownGood\"=dword:00000002\n"
33564 #: ../tools/virt-win-reg.pl:464
33565 msgid "\"Current\" is the one which Windows will choose when it boots."
33570 #: ../tools/virt-win-reg.pl:466
33572 "Similarly, other C<Current...> keys in the path may need to be replaced."
33577 #: ../tools/virt-win-reg.pl:469
33578 msgid "WINDOWS TIPS"
33583 #: ../tools/virt-win-reg.pl:471
33585 "Note that some of these tips modify the guest disk image. The guest I<must> "
33586 "be shut off, else you will get disk corruption."
33591 #: ../tools/virt-win-reg.pl:474
33592 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33597 #: ../tools/virt-win-reg.pl:476
33599 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33600 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33601 "is uploaded into C<C:\\>:"
33606 #: ../tools/virt-win-reg.pl:480
33609 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33615 #: ../tools/virt-win-reg.pl:482
33616 msgid "Prepare a regedit file containing the registry change:"
33621 #: ../tools/virt-win-reg.pl:484
33624 " cat > test.reg <<'EOF'\n"
33625 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33626 " \"Test\"=\"c:\\\\test.bat\"\n"
33633 #: ../tools/virt-win-reg.pl:489
33635 "In this example we use the key C<RunOnce> which means that the script will "
33636 "run precisely once when the first user logs in. If you want it to run every "
33637 "time a user logs in, replace C<RunOnce> with C<Run>."
33642 #: ../tools/virt-win-reg.pl:493
33643 msgid "Now update the registry:"
33648 #: ../tools/virt-win-reg.pl:495
33651 " virt-win-reg --merge WindowsGuest test.reg\n"
33657 #: ../tools/virt-win-reg.pl:497
33658 msgid "INSTALLING A SERVICE"
33663 #: ../tools/virt-win-reg.pl:499
33665 "This section assumes you are familiar with Windows services, and you either "
33666 "have a program which handles the Windows Service Control Protocol directly "
33667 "or you want to run any program using a service wrapper like SrvAny or the "
33673 #: ../tools/virt-win-reg.pl:504
33675 "First upload the program and optionally the service wrapper. In this case "
33676 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33681 #: ../tools/virt-win-reg.pl:508
33684 " guestfish -i -d WindowsGuest <<EOF\n"
33685 " upload rhsrvany.exe /rhsrvany.exe\n"
33686 " upload test.exe /test.exe\n"
33693 #: ../tools/virt-win-reg.pl:513
33695 "Prepare a regedit file containing the registry changes. In this example, "
33696 "the first registry change is needed for the service itself or the service "
33697 "wrapper (if used). The second registry change is only needed because I am "
33698 "using the RHSrvAny service wrapper."
33703 #: ../tools/virt-win-reg.pl:518
33706 " cat > service.reg <<'EOF'\n"
33707 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33708 " \"Type\"=dword:00000010\n"
33709 " \"Start\"=dword:00000002\n"
33710 " \"ErrorControl\"=dword:00000001\n"
33711 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33712 " \"DisplayName\"=\"RHSrvAny\"\n"
33713 " \"ObjectName\"=\"NetworkService\"\n"
33719 #: ../tools/virt-win-reg.pl:527
33722 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33723 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33724 " \"PWD\"=\"c:\\\\Temp\"\n"
33731 #: ../tools/virt-win-reg.pl:538
33733 "For use of C<ControlSet001> see the section above in this manual page. You "
33734 "may need to adjust this according to the control set that is in use by the "
33740 #: ../tools/virt-win-reg.pl:544
33742 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33743 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33744 "privileged account."
33749 #: ../tools/virt-win-reg.pl:550
33751 "For the meaning of the magic numbers, see this Microsoft KB article: "
33752 "L<http://support.microsoft.com/kb/103000>."
33757 #: ../tools/virt-win-reg.pl:555
33758 msgid "Update the registry:"
33763 #: ../tools/virt-win-reg.pl:557
33766 " virt-win-reg --merge WindowsGuest service.reg\n"
33772 #: ../tools/virt-win-reg.pl:561
33774 "Be careful when passing parameters containing C<\\> (backslash) in the "
33775 "shell. Usually you will have to use 'single quotes' or double backslashes "
33776 "(but not both) to protect them from the shell."
33781 #: ../tools/virt-win-reg.pl:565
33782 msgid "Paths and value names are case-insensitive."
33787 #: ../tools/virt-win-reg.pl:574
33789 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33790 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33791 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33796 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33798 "When reporting bugs, please enable debugging and capture the I<complete> "
33804 #: ../tools/virt-win-reg.pl:592
33807 " export LIBGUESTFS_DEBUG=1\n"
33808 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33814 #: ../tools/virt-win-reg.pl:595
33816 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33822 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33823 msgid "Copyright (C) 2010 Red Hat Inc."
33828 #: ../tools/virt-list-filesystems.pl:32
33830 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33835 #: ../tools/virt-list-filesystems.pl:36
33838 " virt-list-filesystems [--options] domname\n"
33844 #: ../tools/virt-list-filesystems.pl:38
33847 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33853 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33855 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33861 #: ../tools/virt-list-filesystems.pl:45
33863 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33864 "are contained in a virtual machine or disk image."
33869 #: ../tools/virt-list-filesystems.pl:49
33871 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33872 "functionality. For more complex cases you should look at the L<guestfish(1)"
33878 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33879 msgid "B<-l> | B<--long>"
33884 #: ../tools/virt-list-filesystems.pl:108
33886 "With this option, C<virt-list-filesystems> displays the type of each "
33887 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33892 #: ../tools/virt-list-filesystems.pl:115
33893 msgid "B<-a> | B<--all>"
33898 #: ../tools/virt-list-filesystems.pl:117
33900 "Normally we only show mountable filesystems. If this option is given then "
33901 "swap devices are shown too."
33906 #: ../tools/virt-list-filesystems.pl:191
33908 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33909 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33910 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33915 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33916 msgid "Copyright (C) 2009 Red Hat Inc."
33921 #: ../tools/virt-tar.pl:33
33922 msgid "virt-tar - Extract or upload files to a virtual machine"
33927 #: ../tools/virt-tar.pl:37
33930 " virt-tar [--options] -x domname directory tarball\n"
33936 #: ../tools/virt-tar.pl:39
33939 " virt-tar [--options] -u domname tarball directory\n"
33945 #: ../tools/virt-tar.pl:41
33948 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33954 #: ../tools/virt-tar.pl:43
33957 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33962 #: ../tools/virt-tar.pl:47
33964 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33965 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33970 #: ../tools/virt-tar.pl:52
33971 msgid "Download C</home> from the VM into a local tarball:"
33976 #: ../tools/virt-tar.pl:54
33979 " virt-tar -x domname /home home.tar\n"
33985 #: ../tools/virt-tar.pl:56
33988 " virt-tar -zx domname /home home.tar.gz\n"
33994 #: ../tools/virt-tar.pl:58
33995 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34000 #: ../tools/virt-tar.pl:60
34003 " virt-tar -u domname uploadstuff.tar /tmp\n"
34009 #: ../tools/virt-tar.pl:62
34012 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34017 #: ../tools/virt-tar.pl:66
34019 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34020 "virtual machines. If you do this, you risk disk corruption in the VM. "
34021 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34025 #: ../tools/virt-tar.pl:71
34027 "You can use I<-x> (extract) on live virtual machines, but you might get "
34028 "inconsistent results or errors if there is filesystem activity inside the "
34029 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34030 "work, but the only way to guarantee consistent results is if the virtual "
34031 "machine is shut down."
34036 #: ../tools/virt-tar.pl:79
34038 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34039 "parts of a guest filesystem. There are many possibilities: making backups, "
34040 "uploading data files, snooping on guest activity, fixing or customizing "
34046 #: ../tools/virt-tar.pl:84
34048 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34049 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34050 "should look at the L<guestfish(1)> tool."
34054 #: ../tools/virt-tar.pl:88
34056 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34057 "its contents (recursively) from the virtual machine into a local tarball. "
34058 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34059 "virtual machine. You cannot use these two options together."
34063 #: ../tools/virt-tar.pl:94
34065 "In addition, you may need to use the I<-z> (gZip) option to enable "
34066 "compression. When uploading, you have to specify I<-z> if the upload file "
34067 "is compressed because virt-tar won't detect this on its own."
34072 #: ../tools/virt-tar.pl:98
34074 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34075 "example it cannot do PKZip files or bzip2 compression. If you want that "
34076 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34077 "the L<libguestfs(3)> API)."
34082 #: ../tools/virt-tar.pl:156
34083 msgid "B<-x> | B<--extract> | B<--download>"
34088 #: ../tools/virt-tar.pl:158
34089 msgid "B<-u> | B<--upload>"
34093 #: ../tools/virt-tar.pl:160
34095 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34100 #: ../tools/virt-tar.pl:163
34102 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34103 "Please read the L</WARNING> section above before using this option."
34108 #: ../tools/virt-tar.pl:167
34109 msgid "You must specify exactly one of these options."
34114 #: ../tools/virt-tar.pl:173
34115 msgid "B<-z> | B<--gzip>"
34120 #: ../tools/virt-tar.pl:175
34121 msgid "Specify that the input or output tarball is gzip-compressed."
34125 #: ../tools/virt-tar.pl:288
34127 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34128 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34129 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34135 #: ../tools/virt-make-fs.pl:37
34136 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34141 #: ../tools/virt-make-fs.pl:41
34144 " virt-make-fs [--options] input.tar output.img\n"
34150 #: ../tools/virt-make-fs.pl:43
34153 " virt-make-fs [--options] input.tar.gz output.img\n"
34159 #: ../tools/virt-make-fs.pl:45
34162 " virt-make-fs [--options] directory output.img\n"
34168 #: ../tools/virt-make-fs.pl:49
34170 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34171 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34172 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34173 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34174 "you want to attach these filesystems to existing virtual machines (eg. to "
34175 "import large amounts of read-only data to a VM)."
34180 #: ../tools/virt-make-fs.pl:57
34181 msgid "Basic usage is:"
34186 #: ../tools/virt-make-fs.pl:59
34189 " virt-make-fs input output\n"
34195 #: ../tools/virt-make-fs.pl:61
34197 "where C<input> is either a directory containing files that you want to add, "
34198 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34199 "C<output> is a disk image. The input type is detected automatically. The "
34200 "output disk image defaults to a raw ext2 image unless you specify extra "
34201 "flags (see L</OPTIONS> below)."
34206 #: ../tools/virt-make-fs.pl:67
34207 msgid "EXTRA SPACE"
34211 #: ../tools/virt-make-fs.pl:69
34213 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34214 "the files that it contains, but might have extra space. Depending on how "
34215 "you are going to use the output, you might think this extra space is wasted "
34216 "and want to minimize it, or you might want to leave space so that more files "
34217 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34218 "but you can use the I<--size> flag to leave space in the filesystem if you "
34223 #: ../tools/virt-make-fs.pl:77
34225 "An alternative way to leave extra space but not make the output image any "
34226 "bigger is to use an alternative disk image format (instead of the default "
34227 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34228 "image format (check your hypervisor supports this before using it). This "
34229 "allows you to choose a large I<--size> but the extra space won't actually be "
34230 "allocated in the image until you try to store something in it."
34234 #: ../tools/virt-make-fs.pl:85
34236 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34237 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34238 "to build another image from scratch."
34243 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34244 #: ../tools/virt-make-fs.pl:142
34250 #: ../tools/virt-make-fs.pl:91
34253 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34259 #: ../tools/virt-make-fs.pl:93
34260 msgid "FILESYSTEM TYPE"
34265 #: ../tools/virt-make-fs.pl:95
34267 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34268 "libguestfs supports can be used (but I<not> read-only formats like "
34269 "ISO9660). Here are some of the more common choices:"
34274 #: ../tools/virt-make-fs.pl:101
34280 #: ../tools/virt-make-fs.pl:103
34282 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34283 "you are not going to use the filesystem in a way that requires the journal, "
34284 "then this is just wasted overhead."
34289 #: ../tools/virt-make-fs.pl:107
34290 msgid "I<ntfs> or I<vfat>"
34295 #: ../tools/virt-make-fs.pl:109
34296 msgid "Useful if exporting data to a Windows guest."
34301 #: ../tools/virt-make-fs.pl:111
34303 "I<Note for vfat>: The tar archive or local directory must only contain files "
34304 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34305 "program running within libguestfs is unable to change the ownership of non-"
34306 "root files, since vfat itself does not support this."
34311 #: ../tools/virt-make-fs.pl:116
34317 #: ../tools/virt-make-fs.pl:118
34319 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34320 "total filesystem size."
34325 #: ../tools/virt-make-fs.pl:125
34328 " virt-make-fs --type=minix input minixfs.img\n"
34334 #: ../tools/virt-make-fs.pl:127
34335 msgid "TO PARTITION OR NOT TO PARTITION"
34340 #: ../tools/virt-make-fs.pl:129
34341 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34346 #: ../tools/virt-make-fs.pl:131
34348 "Adding a partition can make the disk image more compatible with certain "
34349 "virtualized operating systems which don't expect to see a filesystem "
34350 "directly located on a block device (Linux doesn't care and will happily "
34351 "handle both types)."
34356 #: ../tools/virt-make-fs.pl:136
34358 "On the other hand, if you have a partition table then the output image is no "
34359 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34360 "directly on a partitioned disk image. (However libguestfs tools such as "
34361 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34366 #: ../tools/virt-make-fs.pl:144
34367 msgid "Add an MBR partition:"
34372 #: ../tools/virt-make-fs.pl:146
34375 " virt-make-fs --partition -- input disk.img\n"
34381 #: ../tools/virt-make-fs.pl:148
34383 "If the output disk image could be terabyte-sized or larger, it's better to "
34384 "use an EFI/GPT-compatible partition table:"
34389 #: ../tools/virt-make-fs.pl:151
34392 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34398 #: ../tools/virt-make-fs.pl:179
34399 msgid "Enable debugging information."
34404 #: ../tools/virt-make-fs.pl:185
34405 msgid "B<--size=E<lt>NE<gt>>"
34410 #: ../tools/virt-make-fs.pl:187
34411 msgid "B<--size=+E<lt>NE<gt>>"
34416 #: ../tools/virt-make-fs.pl:189
34417 msgid "B<-s E<lt>NE<gt>>"
34422 #: ../tools/virt-make-fs.pl:191
34423 msgid "B<-s +E<lt>NE<gt>>"
34427 #: ../tools/virt-make-fs.pl:193
34429 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34434 #: ../tools/virt-make-fs.pl:196
34436 "If this option is I<not> given, then the output image will be just large "
34437 "enough to contain all the files, with not much wasted space."
34442 #: ../tools/virt-make-fs.pl:199
34444 "To choose a fixed size output disk, specify an absolute number followed by b/"
34445 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34446 "Petabytes or Exabytes. This must be large enough to contain all the input "
34447 "files, else you will get an error."
34451 #: ../tools/virt-make-fs.pl:204
34453 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34454 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34455 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34456 "the input files, and (approximately) an extra 200 MB free space."
34461 #: ../tools/virt-make-fs.pl:210
34463 "Note that virt-make-fs estimates free space, and therefore will not produce "
34464 "filesystems containing precisely the free space requested. (It is much more "
34465 "expensive and time-consuming to produce a filesystem which has precisely the "
34466 "desired free space)."
34471 #: ../tools/virt-make-fs.pl:219
34472 msgid "B<--format=E<lt>fmtE<gt>>"
34477 #: ../tools/virt-make-fs.pl:221
34478 msgid "B<-F E<lt>fmtE<gt>>"
34483 #: ../tools/virt-make-fs.pl:223
34484 msgid "Choose the output disk image format."
34489 #: ../tools/virt-make-fs.pl:225
34490 msgid "The default is C<raw> (raw disk image)."
34495 #: ../tools/virt-make-fs.pl:227
34497 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34498 "that would really make sense here is C<qcow2>."
34503 #: ../tools/virt-make-fs.pl:234
34504 msgid "B<--type=E<lt>fsE<gt>>"
34509 #: ../tools/virt-make-fs.pl:236
34510 msgid "B<-t E<lt>fsE<gt>>"
34515 #: ../tools/virt-make-fs.pl:238
34516 msgid "Choose the output filesystem type."
34521 #: ../tools/virt-make-fs.pl:240
34522 msgid "The default is C<ext2>."
34527 #: ../tools/virt-make-fs.pl:242
34529 "Any filesystem which is supported read-write by libguestfs can be used here."
34534 #: ../tools/virt-make-fs.pl:249
34535 msgid "B<--partition>"
34540 #: ../tools/virt-make-fs.pl:251
34541 msgid "B<--partition=E<lt>parttypeE<gt>>"
34546 #: ../tools/virt-make-fs.pl:253
34548 "If specified, this flag adds an MBR partition table to the output disk image."
34552 #: ../tools/virt-make-fs.pl:256
34554 "You can change the partition table type, eg. I<--partition=gpt> for large "
34559 #: ../tools/virt-make-fs.pl:259
34561 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34562 "might consider the next parameter to be the partition type. For example:"
34567 #: ../tools/virt-make-fs.pl:263
34570 " virt-make-fs --partition input.tar ...\n"
34575 #: ../tools/virt-make-fs.pl:265
34577 "would cause virt-make-fs to think you wanted to use a partition type of "
34578 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34579 "dash) between options and the input file argument:"
34584 #: ../tools/virt-make-fs.pl:269
34587 " virt-make-fs --partition -- input.tar ...\n"
34592 #: ../tools/virt-make-fs.pl:541
34594 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34595 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34596 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34601 #: ../tools/virt-make-fs.pl:558
34604 " export LIBGUESTFS_DEBUG=1\n"
34605 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34611 #: ../tools/virt-make-fs.pl:561
34613 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34619 #: ../tools/virt-list-partitions.pl:32
34621 "virt-list-partitions - List partitions in a virtual machine or disk image"
34626 #: ../tools/virt-list-partitions.pl:36
34629 " virt-list-partitions [--options] domname\n"
34635 #: ../tools/virt-list-partitions.pl:38
34638 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34644 #: ../tools/virt-list-partitions.pl:45
34646 "C<virt-list-partitions> is a command line tool to list the partitions that "
34647 "are contained in a virtual machine or disk image. It is mainly useful as a "
34648 "first step to using L<virt-resize(1)>."
34653 #: ../tools/virt-list-partitions.pl:50
34655 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34656 "functionality. For more complex cases you should look at the L<guestfish(1)"
34662 #: ../tools/virt-list-partitions.pl:107
34663 msgid "B<-h> | B<--human-readable>"
34668 #: ../tools/virt-list-partitions.pl:109
34669 msgid "Show sizes in human-readable form (eg. \"1G\")."
34674 #: ../tools/virt-list-partitions.pl:117
34676 "With this option, C<virt-list-partitions> displays the type and size of each "
34677 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34682 #: ../tools/virt-list-partitions.pl:124
34683 msgid "B<-t> | B<--total>"
34688 #: ../tools/virt-list-partitions.pl:126
34690 "Display the total size of each block device (as a separate row or rows)."
34695 #: ../tools/virt-list-partitions.pl:259
34697 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34698 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34699 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34704 #: ../tools/virt-list-partitions.pl:275
34705 msgid "Copyright (C) 2009-2010 Red Hat Inc."